POST
https://api.getincloud.online/raven/v3/messagesEnviar mensaje SMS
Envía un único mensaje SMS de salida a un número de destino.
API de Mensajería
Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.
Este punto de acceso permite enviar un único mensaje SMS de salida.
Al enviar mensajes SMS, el tipo de caracteres utilizados en tu mensaje afecta directamente cómo se codifica, cuántos caracteres caben en cada SMS y cómo se segmentan los mensajes durante la entrega. Los mensajes que incluyen símbolos especiales, letras acentuadas o caracteres no latinos pueden cambiar a un formato de codificación diferente, lo cual puede reducir el máximo de caracteres por segmento y aumentar el costo del mensaje.
POST https://api.getincloud.online/raven/v3/messagesParámetros del cuerpo (Body Params)
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| from | string | No | Código Corto (de 1 a 6 dígitos), Código Largo (de 7 dígitos en adelante), un código corto alfanumérico (ej. EMPRESA) o un número virtual que se utilizará para originar y enviar el mensaje SMS. Cualquiera de estos códigos aparecerá en el terminal como el origen del mensaje de texto. |
| to | string | Sí | Número de teléfono de destino. Los números se especifican en formato E.164 (signo '+' y código de país). |
| text | string | Sí | Cuerpo del mensaje de texto que se enviará. La longitud máxima de un texto de mensaje corto es de 160 caracteres utilizando el alfabeto estándar GSM 03.38. Si utilizas cualquier carácter que no esté en el alfabeto estándar, el mensaje se codificará en Unicode y se dividirá en segmentos de un máximo de 70 caracteres cada uno. Por ejemplo, si incluyes un emoji en tu mensaje y el mensaje tiene 150 caracteres de longitud, se dividirá en tres segmentos: el primero con 70 caracteres, el segundo con 70 caracteres y el tercero con solo 10 caracteres. Se cobra por segmento, no por mensaje. |
| type | string | No | Tipo de mensaje que deseas enviar. Opciones soportadas: "MT" (mensaje enviado desde el sistema del proveedor de SMS móvil al teléfono móvil del usuario final) y "MO" (mensaje enviado desde el teléfono móvil del usuario final al sistema del proveedor de SMS). |
| requestDR | boolean | No | Para notificar el estado de la entrega del mensaje a través de un callback, requestDR debe ser true. |
| externalId | string | No | Identificador único de tu sistema para este mensaje. Este ID se incluirá en las notificaciones de estado de entrega (DLR). |
| callbackUrl | string | No | URL a la que el sistema enviará notificaciones sobre los cambios de estado del mensaje. |
| scheduledAt | string | No | Permite programar el mensaje para ser enviado en un momento futuro. El formato debe ser una cadena de fecha ISO 8601 (ej. 2023-12-31T23:59:59Z). |
| connection | string | No | Identificador de la conexión o ruta específica a través de la cual se debe enviar el mensaje. |
| callbacks | array de objetos | No | Lista de objetos de callback para recibir notificaciones en múltiples URLs. |
| clientId | string | No | Identificador único del cliente asociado con la solicitud. |
| string | No | Dirección de correo electrónico asociada con la transacción o para propósitos de registro. |
Respuestas y códigos de estado (Responses)
202 Accepted
La solicitud ha sido aceptada exitosamente.
| Campo | Tipo | Descripción |
|---|---|---|
| id | string | Identificador único del mensaje generado por el sistema. |
| status | string | Estado actual de la solicitud (ej. "Accepted"). |
| to | string | Número de destino al que se envió el mensaje. |
| created_at | string | Marca de tiempo de la creación del mensaje. |
Otros códigos
| Código | Descripción |
|---|---|
| 400 Bad Request | La solicitud es inválida. Puede deberse a parámetros faltantes o formatos de número incorrectos. |
| 401 Unauthorized | Error de autenticación. El token Bearer es inválido, falta o ha expirado. |
| 500 Internal Server Error | Error interno del servidor al procesar la solicitud. |
Estados específicos de mensajería
- SEGMENTS_EXCEEDED: indica que se ha superado el número de segmentos permitidos. Ocurre cuando el mensaje excede el límite de 160 caracteres por segmento, por lo tanto el mensaje no se puede enviar. Para resolverlo, asegúrate de que tus mensajes SMS no excedan los 1600 caracteres para evitar alcanzar el límite de segmentos.
Ejemplo de solicitud (cURL)
curl --request POST \
--url https://api.getincloud.online/raven/v3/messages \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"from": "87070",
"to": "+580000000005",
"text": "¡Obtén un 20% de DESCUENTO en tu próxima compra!",
"type": "MT",
"externalId": "mi-id-personalizado-123",
"connection": "mi-conexion-01",
"clientId": "cliente_abc_789",
"email": "usuario@ejemplo.com"
}El manual no incluye un ejemplo de respuesta JSON para este endpoint.
¿Te sirvió esta página?