Requisitos y conceptos clave de la API de SMS
Qué necesitas antes de integrar el envío de SMS por API y qué significa cada término.
Plataforma Omni
Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.
Introducción
Esta guía explica cómo integrar tu sistema con el servicio de mensajería SMS a través de la API HTTP de la plataforma. Está dirigida al equipo de desarrollo o integración de tu empresa: no requiere acceso a las herramientas internas ni conocimiento previo de la plataforma, solo la capacidad de hacer peticiones HTTP/JSON desde tu aplicación.
El servicio permite enviar SMS de dos formas:
- Con una plantilla de contenido previamente aprobada (recomendado para mensajes recurrentes y trazables).
- Con texto libre generado por tu propia aplicación.
Ambas formas usan el mismo endpoint y la misma autenticación.
Qué necesitas antes de empezar
- Un API Key activo, con el scope
omni-apiy con tu Sender ID autorizado. Normalmente te lo entrega tu ejecutivo de cuenta o el equipo de soporte por un canal seguro. - Tu Sender ID de SMS ya aprobado (el remitente con el que saldrán tus mensajes).
- Una herramienta para probar peticiones HTTP. Esta documentación usa Postman como referencia, pero cualquier cliente HTTP (código propio, Insomnia, cURL, etc.) funciona igual.
- Una URL de webhook a la que la plataforma enviará el estatus de entrega de cada mensaje. Puedes usar un endpoint de pruebas como webhook.site mientras integras, y sustituirlo antes de pasar a producción.
Conceptos clave
| Término | Qué significa |
|---|---|
| API Key | Credencial que identifica tu integración ante la plataforma. Viaja en cada petición. |
| Sender ID | El remitente con el que se ve tu SMS en el teléfono del destinatario. |
| Content Template | Plantilla de mensaje preregistrada y aprobada, reutilizable e identificada por un template.id numérico. |
| payload | Contenido de mensaje libre, generado por tu aplicación en tiempo real, en lugar de una plantilla. |
| Webhook | URL de tu sistema a la que la plataforma notifica el estatus de cada mensaje (entregado, fallido, etc.). |
| DLR | Delivery Receipt: la confirmación real de que el mensaje llegó al teléfono del destinatario. |
| channel | Identificador numérico del canal de envío. Para SMS siempre es 1. |
¿Te sirvió esta página?