API de Mensajería
POSThttps://api.getincloud.online/raven/v3/messages/batch

Enviar mensajes SMS por lote

Envía múltiples mensajes SMS de salida en una sola solicitud de lote.

API de Mensajería
Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.

Este endpoint permite enviar múltiples mensajes SMS de salida en una sola solicitud de lote.

POST https://api.getincloud.online/raven/v3/messages/batch

El tipo de caracteres de tu mensaje afecta cómo se codifica, cuántos caracteres caben en cada SMS y cómo se segmenta durante la entrega. Los símbolos especiales, letras acentuadas o caracteres no latinos pueden cambiar la codificación, reducir el máximo de caracteres por segmento y aumentar el costo.

Parámetros del cuerpo

CampoTipoObligatorioDescripción
messagesarray de objetosSíLista de objetos de mensaje para enviar.

Campos de cada objeto de `messages`

CampoTipoObligatorioDescripción
fromstringNoCó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 usado para originar y enviar el SMS. Aparecerá en el terminal como el origen del mensaje.
tostringSíNúmero de teléfono de destino en formato E.164 (signo '+' y código de país).
textstringSíCuerpo del mensaje. La longitud máxima de un mensaje corto es de 160 caracteres con el alfabeto estándar GSM 03.38. Si usas cualquier carácter fuera de ese alfabeto, el mensaje se codifica en Unicode y se divide en segmentos de máximo 70 caracteres. Se cobra por segmento, no por mensaje.
typestringNoTipo de mensaje. Opciones: "MT" (Mobile Terminated) o "MO" (Mobile Originated).
requestDRbooleanNoDebe ser true para notificar el estado de entrega mediante un callback.
externalIdstringNoIdentificador único de tu sistema para este mensaje. Se incluye en las notificaciones de estado de entrega (DLR).
callbackUrlstringNoURL a la que el sistema envía notificaciones sobre los cambios de estado del mensaje.
scheduledAtstringNoPrograma el envío para un momento futuro. Formato ISO 8601 (ej. 2023-12-31T23:59:59Z).
connectionstringNoIdentificador de la conexión o ruta específica por la que se debe enviar el mensaje.
callbacksarray de objetosNoLista de objetos de callback para recibir notificaciones en múltiples URLs.
clientIdstringNoIdentificador único del cliente asociado con la solicitud.
emailstringNoDirección de correo asociada con la transacción o con fines de registro.

Respuestas

202 Accepted

La solicitud de lote fue aceptada para su procesamiento.

CampoTipoDescripción
batch_idstringIdentificador único del lote de mensajes.
statusstringEstado de la solicitud de lote.
total_messagesintegerNúmero total de mensajes procesados en el lote.

Errores

CódigoDescripción
400 Bad RequestSolicitud inválida por errores de formato o parámetros requeridos faltantes.
401 UnauthorizedError de autenticación. El token Bearer es inválido o ha expirado.
413 Payload Too LargeEl lote excede el límite de tamaño permitido por solicitud.
500 Internal Server ErrorError inesperado en el servidor.

Ejemplo de solicitud

curl --request POST \
 --url https://api.getincloud.online/raven/v3/messages/batch \
 --header 'accept: application/json' \
 --header 'content-type: application/json' \
 --data '
{
 "messages": [
 {
 "from": "87070",
 "to": "+580000000001",
 "text": "Hola, este es el primer mensaje del lote.",
 "externalId": "batch-item-001"
 },
 {
 "from": "87070",
 "to": "+580000000002",
 "text": "Hola, este es el segundo mensaje del lote.",
 "externalId": "batch-item-002"
 }
 ]
}
'
AnteriorEnviar mensaje multimedia (sesión)SiguienteEnviar plantilla de autenticación
¿Te sirvió esta página?