--- title: "API SMS Cookbook" description: "Descubra cómo utilizar la API de SMS de OVHcloud: envío sobre la marcha y masivo, mailing, seguimiento de campañas, respuesta por SMS, gestión de usuarios y créditos" url: https://docs.ovhcloud.com/es/guides/web-cloud/messaging/sms/api-sms-cookbook lang: es lastUpdated: 2026-06-15 --- # API SMS Cookbook :::info Las ofertas de SMS de OVHcloud solo están disponibles en los siguientes países: Francia, Reino Unido, Irlanda, España, Italia y Polonia. ::: ## Objetivo **Descubra cómo utilizar las diferentes combinaciones posibles con la API para la plataforma SMS de OVHcloud.** ## Envío de SMS sobre la marcha El envío de SMS sobre la marcha corresponde a una llamada al servicio web para enviar regularmente SMS de uno en uno. Por lo tanto, para cada SMS que se vaya a enviar, realizamos una llamada al servicio web en POST al método siguiente: [🇪🇺POST/sms/{serviceName}/jobs](https://eu.api.ovh.com/console/?section=/sms&branch=v1#post-/sms/-serviceName-/jobs) ServiceName corresponde a su cuenta SMS. Puede obtenerlo desde su área de cliente o realizando una llamada GET al método siguiente: [🇪🇺GET/sms](https://eu.api.ovh.com/console/?section=/sms&branch=v1#get-/sms) Aquí tiene un ejemplo: /sms/sms-XXXXXX-1/jobs Parámetros obligatorios: - ServiceName - Message (su mensaje; preste atención a su longitud, así como a la adición del STOP, a la codificación y a los caracteres especiales, que pueden consumir más crédito SMS) Destinatarios: - Receivers (lista de números; para los SMS sobre la marcha, este es el parámetro recomendado con un único número) - receiversDocumentUrl (URL que apunta a un fichero CSV que contiene los números de los destinatarios) - receiversSlotId (ID que apunta a un fichero CSV precargado) Remitente - sender (selección del nombre de remitente para que se le identifique inmediatamente como remitente del SMS) - senderForResponse (uso de un número corto que permite la respuesta por SMS de 2 vías) Otros - charset - class (tipo de SMS enviado) - coding (codificación en 7 u 8 bits; esto afecta al número de caracteres disponibles por crédito SMS) - differedPeriod (programación del envío) - noStopClause (permite indicar que se trata de un SMS no comercial; la mención se elimina del mensaje) - priority (indicación de prioridad) - tag (etiquetado para categorizar el mensaje) - validityPeriod (tiempo de expiración del mensaje en caso de problema para entregarlo) ## Envío masivo Para enviar un mismo mensaje a un gran número de destinatarios, reutilizamos el mismo método POST, pero esta vez importando un fichero CSV a través de una URL: [🇪🇺POST/sms/{serviceName}/jobs](https://eu.api.ovh.com/console/?section=/sms&branch=v1#post-/sms/-serviceName-/jobs) Existen dos enfoques. El primero utiliza directamente el parámetro `receiversDocumentUrl` (URL que apunta a un fichero CSV que contiene los números de los destinatarios) con el método anterior. El segundo precarga el fichero CSV con el método siguiente, utilizando los parámetros `serviceName`, `csvUrl`, `description` y `slotId`: [🇪🇺POST/sms/{serviceName}/receivers](https://eu.api.ovh.com/console/?section=/sms&branch=v1#post-/sms/-serviceName-/receivers) Una vez cargado el fichero, basta con llamar de nuevo al método jobs con el parámetro `receiversSlotId`, indicando el SlotId correcto: [🇪🇺POST/sms/{serviceName}/jobs](https://eu.api.ovh.com/console/?section=/sms&branch=v1#post-/sms/-serviceName-/jobs) ## Mailing El envío masivo con mailing se basa en el envío masivo y en la creación de un fichero de contactos CSV específico vinculado a un mensaje. Los mensajes podrán incorporar campos variables. Llamando al nombre de una columna, aquí tiene un ejemplo para ilustrar este caso de uso: fichero contacts.csv ```csv number ;lastname ;firstname ;address 0662000000 ;Durant ;Pierre ;xx rue montaigne Paris 0662000001 ;Dupont ;Jean ;xx rue montaigne Paris ... ``` El mensaje: ```text Hello #firstname# #lastname#, your order will be delivered to the following address: #address#. Best regards. ``` ## Seguimiento de las campañas Al crear un envío mediante el método POST jobs, puede indicar un valor para el parámetro `tag`: [🇪🇺POST/sms/{serviceName}/jobs](https://eu.api.ovh.com/console/?section=/sms&branch=v1#post-/sms/-serviceName-/jobs) Este parámetro le permitirá a continuación rastrear los mensajes enviados con esta etiqueta. Para recuperar todos los identificadores de los mensajes salientes, utilice el método siguiente indicando el parámetro tag como filtro de la solicitud: [🇪🇺GET/sms/{serviceName}/outgoing](https://eu.api.ovh.com/console/?section=/sms&branch=v1#get-/sms/-serviceName-/outgoing) Para recuperar todos los detalles de cada mensaje, utilice: [🇪🇺GET/sms/{serviceName}/outgoing/{id}](https://eu.api.ovh.com/console/?section=/sms&branch=v1#get-/sms/-serviceName-/outgoing/-id-) Con esta información, puede elaborar informes de síntesis para cada campaña. Aquí tiene algunos ejemplos de información: tasa de mensajes entregados, tasa de errores, tiempo de difusión del mensaje, etc. Para seguir la evolución de sus STOP SMS y reaccionar así si una campaña SMS genera una alta tasa de baja, utilice: [🇪🇺GET/sms/{serviceName}/blacklists](https://eu.api.ovh.com/console/?section=/sms&branch=v1#get-/sms/-serviceName-/blacklists) ## Respuesta por SMS :::info La respuesta por SMS (número corto mediante `senderForResponse`) solo está disponible en Francia. ::: Para aprovechar las respuestas por SMS, deberá enviar sus SMS con un número corto utilizando el parámetro `senderForResponse`. Para configurar una llamada Callback en cada respuesta recibida, de modo que se le notifique en tiempo real de las respuestas, utilice el método siguiente: [🇪🇺PUT/sms/{serviceName}](https://eu.api.ovh.com/console/?section=/sms&branch=v1#put-/sms/-serviceName-) Con un enfoque `Pull`, puede optar por consultar las respuestas recibidas llamando al método siguiente: [🇪🇺GET/sms/{serviceName}/incoming](https://eu.api.ovh.com/console/?section=/sms&branch=v1#get-/sms/-serviceName-/incoming) ## Pedido de créditos SMS Para generar automáticamente pedidos de SMS, llame al método siguiente con la cuenta SMS que se va a acreditar y el importe de créditos que desea comprar como parámetros: [🇪🇺POST/order/sms/{serviceName}/credits](https://eu.api.ovh.com/console/?section=/order&branch=v1#post-/order/sms/-serviceName-/credits) A cambio, recibirá toda la información de precios, sin impuestos, con impuestos, los descuentos, así como los contratos y el enlace al pedido para realizar el pago. Previamente, puede obtener los precios en función de la cantidad deseada con el método siguiente: [🇪🇺GET/order/sms/{serviceName}/credits](https://eu.api.ovh.com/console/?section=/order&branch=v1#get-/order/sms/-serviceName-/credits) ## Gestión de los usuarios Para cada cuenta SMS, puede crear usuarios que podrán tener sus propios envíos, así como diferentes reglas de gestión que permiten, en particular, aplicar cuotas de envío. El primer paso es crear un usuario: [🇪🇺POST/sms/{serviceName}/users](https://eu.api.ovh.com/console/?section=/sms&branch=v1#post-/sms/-serviceName-/users) Luego, configurar sus ajustes (callback, cuota, IP, etc.): [🇪🇺PUT/sms/{serviceName}/users/{login}](https://eu.api.ovh.com/console/?section=/sms&branch=v1#put-/sms/-serviceName-/users/-login-) Por último, puede consultar el estado de consumo de un usuario: [🇪🇺GET/sms/{serviceName}/users/{login}](https://eu.api.ovh.com/console/?section=/sms&branch=v1#get-/sms/-serviceName-/users/-login-) También puede rastrear el consumo utilizando una etiqueta de campaña o la identidad de un sender mediante el método siguiente, y especificar un periodo, por ejemplo para refacturar el consumo mes a mes: [🇪🇺GET/sms/{serviceName}/outgoing](https://eu.api.ovh.com/console/?section=/sms&branch=v1#get-/sms/-serviceName-/outgoing) ## Transferencia de créditos Si gestiona varias cuentas SMS (serviceName: sms-XXXX-1, sms-XXXXX-2, etc.), puede transferir créditos entre sus diferentes cuentas. Para ello, utilice el método siguiente, indicando la cuenta SMS que se va a debitar, la que se va a acreditar y, por último, el importe de créditos que se va a transferir: [🇪🇺POST/sms/{serviceName}/transferCredits](https://eu.api.ovh.com/console/?section=/sms&branch=v1#post-/sms/-serviceName-/transferCredits) Este mecanismo es muy útil para gestionar varias cuentas SMS de forma independiente, en particular para la reventa a diferentes actores. Para aislar las cuentas, debe configurar Tokens distintos con el fin de aislar los derechos. Esta operación se realiza al crear sus Tokens de aplicación: en los derechos, deberá especificar explícitamente que una aplicación determinada solo tiene derechos sobre un ServiceName especificado en las URL autorizadas. ## Más información Interactúe con nuestra [comunidad de usuarios](https://community.ovhcloud.com/).