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

NombreTipoObligatorioDescripciónEjemplo
tostring | string[]Número de teléfono del destinatario. Usando el formato E.164.+12068800123
signaturestringNoNombre del remitente del SMS. Debe tener entre 2-16 caracteres.Unimatrix
textstringNoTexto completo del SMS.
* Se requiere templateId, text o content
701522 es tu código de verificación, válido por 10 minutos.
contentstringNoContenido 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.
templateIdstringNoID de plantilla de SMS o código de plantilla personalizada.
* Se requiere templateId, text o content
pub_verif_en_ttl
templateDataJSONNoVariables 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

NombreTipoDescripciónEjemplo
codestringCódigo de retorno0
messagestringMensaje de retornoSuccess
dataJSONResultados

Resultados data

NombreTipoDescripciónEjemplo
recipientsintegerNúmero de destinatarios1
messageCountintegerNúmero total de mensajes facturados1
currencystringMonedaUSD
totalAmountstringMonto total consumido0.018900
messagesJSON[]Detalles de los mensajes enviados

Mensajes data.messages

NombreTipoDescripciónEjemplo
idstringID del mensajec9159d19f394833327e43c8e7285a6b3
tostringNúmero de teléfono del destinatario (E.164)+12068800123
isostringCódigo de país (iso2)US
ccstringCódigo de país (prefijo de llamada internacional)1
partsintegerNúmero de partes del mensaje1
pricestringMonto de consumo0.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"
}