POST
/api/v1/messagesEnviar un SMS: endpoint y estructura del mensaje
Referencia del endpoint de envío de mensajes y de los campos del cuerpo de la petición.
Plataforma Omni
Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.
Endpoint
| Valor | |
|---|---|
| Método | POST |
| Endpoint | {URL_BASE} |
| Content-Type | application/json |
Autenticación: header X-API-Key: <su API key>.
Cuerpo de la petición
El cuerpo es un JSON con los siguientes campos:
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| contact | string | Sí | Número del destinatario en formato internacional, sin + y sin 00. |
| channel | int | Sí | Siempre 1 para SMS. |
| senderId | string | Sí | Tu Sender ID autorizado. Debe estar entre los senders asignados a tu API key. |
| template | object | Condicional | Obligatorio si envías con plantilla. Contiene id (entero, sin comillas) y params. |
| payload | object | Condicional | Obligatorio si envías contenido libre, en lugar de template. |
| webhook | string | No | URL que recibirá el estatus de este mensaje en particular. Si se omite, se usa el webhook configurado en el API access. |
Nota: template o payload, nunca ambos. Usa
templatepara contenido preaprobado y reutilizable, que es la forma recomendada y trazable. Usapayloadcuando el contenido lo genera tu aplicación en tiempo real. Si la plantilla no tiene variables, envía de todas formas el objeto vacío"params": {}: omitirlo produce un error de validación.
Variantes de envío
- Con plantilla: consulta la página "Enviar un SMS con plantilla".
- Con contenido libre: consulta la página "Enviar un SMS con contenido libre".
Respuestas
Consulta "Interpretar la respuesta de la API de SMS" y "Códigos de estado HTTP de la API de SMS".
Límite de destinatarios
Cada petición a /api/v1/messages envía a un único contact. Para enviar a varios destinatarios, realiza una petición por cada uno.
¿Te sirvió esta página?