API de mensajería SMS
Envía mensajes de texto a uno o varios destinatarios. Por favor, lee Referencia general de la API antes de leer este documento.
Envía códigos de verificación, mensajes transaccionales y promocionales sin esfuerzo a uno o varios destinatarios en cualquier país del mundo. La interfaz ofrece un método de entrada de parámetros conciso, flexible y completo para satisfacer varios escenarios de uso de SMS.
Si planeas enviar códigos de verificación SMS a los usuarios a través de Unimatrix, te recomendamos utilizar nuestra API de envío de OTP más integrada, que mejorará tu eficiencia en el desarrollo y la experiencia del usuario.
Definiciones
- Acción:
sms.message.send
- Método HTTP:
POST
- Content-Type:
application/json
Parámetros de la solicitud
Nombre | Tipo | Obligatorio | Descripción | Ejemplo |
---|---|---|---|---|
to | string | string[] | Sí | Número de teléfono del destinatario. Usando el formato E.164. | +12068800123 |
signature | string | No | Nombre del remitente del SMS. Debe tener entre 2-16 caracteres. | Unimatrix |
text | string | No | Texto completo del SMS. * Se requiere templateId , text o content | 701522 es tu código de verificación, válido por 10 minutos. |
content | string | No | Contenido principal del SMS, se combinará con la firma como el texto completo del SMS. * Se requiere templateId , text o content | 701522 es tu código de verificación, válido por 10 minutos. |
templateId | string | No | ID de plantilla de SMS o código de plantilla personalizada. * Se requiere templateId , text o content | pub_verif_en_ttl |
templateData | JSON | No | Variables de la plantilla, usadas con templateId . | {"code": "701522", "ttl": "10"} |
Ejemplo de solicitud
curl -X POST 'https://api.unimtx.com/?action=sms.message.send&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
"to": "+12068800xxx",
"text": "Tu código de verificación es 204806."
}'
Parámetros de respuesta
Nombre | Tipo | Descripción | Ejemplo |
---|---|---|---|
code | string | Código de retorno | 0 |
message | string | Mensaje de retorno | Success |
data | JSON | Resultados |
Resultados data
Nombre | Tipo | Descripción | Ejemplo |
---|---|---|---|
recipients | integer | Número de destinatarios | 1 |
messageCount | integer | Número total de mensajes facturados | 1 |
currency | string | Moneda | USD |
totalAmount | string | Monto total consumido | 0.018900 |
messages | JSON[] | Detalles de los mensajes enviados |
Mensajes data.messages
Nombre | Tipo | Descripción | Ejemplo |
---|---|---|---|
id | string | ID del mensaje | c9159d19f394833327e43c8e7285a6b3 |
to | string | Número de teléfono del destinatario (E.164) | +12068800123 |
iso | string | Código de país (iso2) | US |
cc | string | Código de país (prefijo de llamada internacional) | 1 |
parts | integer | Número de partes del mensaje | 1 |
price | string | Monto de consumo | 0.018900 |
Ejemplos de respuesta
Ejemplo de respuesta exitosa
Código de estado: 200
, Cuerpo de la respuesta:
{
"code": "0",
"message": "Success",
"data": {
"recipients": 1,
"messageCount": 1,
"totalAmount": "0.018900",
"messages": [
{
"id": "c9159d19f394833327e43c8e7285a6b3",
"to": "+12068800123",
"iso": "US",
"cc": "1",
"parts": 1,
"price": "0.018900"
}
]
}
}
Ejemplo de respuesta fallida
Código de estado: 400
, Cuerpo de la respuesta:
{
"code": "105400",
"message": "InsufficientFunds"
}