API de Mensagens SMS

Envie mensagens de texto para um ou vários destinatários. Leia Referência Geral da API antes de ler este documento.

Envie sem esforço códigos de verificação, mensagens transacionais e promocionais para um ou vários destinatários em qualquer país do mundo. A interface oferece um método de entrada de parâmetros conciso, flexível, mas abrangente, para atender a vários cenários de uso de SMS.

Se você planeja enviar códigos de verificação de SMS para os usuários via Unimatrix, recomendamos usar nossa API Enviar OTP, mais integrada, que melhorará sua eficiência de desenvolvimento e experiência do usuário.

Definições

Ação: sms.message.send
Método HTTP: POST
Content-Type: application/json

Parâmetros de Solicitação

Nome	Tipo	Obrigatório	Descrição	Exemplo
to	string \| string[]	Sim	Número de telefone do destinatário. Usando o formato E.164.	+12068800123
signature	string	Não	Nome do remetente do SMS. Deve ter entre 2-16 caracteres.	Unimatrix
text	string	Não	Texto completo do SMS. * `templateId`, `text` ou `content` é necessário	701522 é seu código de verificação, válido por 10 minutos.
content	string	Não	Conteúdo principal do SMS, será combinado com a assinatura como o texto completo do SMS. * `templateId`, `text` ou `content` é necessário	701522 é seu código de verificação, válido por 10 minutos.
templateId	string	Não	ID do template de SMS ou código de template personalizado. * `templateId`, `text` ou `content` é necessário	pub_verif_en_ttl
templateData	JSON	Não	Variáveis do template, usadas com `templateId`.	`{"code": "701522", "ttl": "10"}`

Exemplo de Solicitação

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": "Seu código de verificação é 204806."
}'

Parâmetros de Resposta

Nome	Tipo	Descrição	Exemplo
code	string	Código de retorno	0
message	string	Mensagem de retorno	Sucesso
data	JSON	Resultados

Resultados `data`

Nome	Tipo	Descrição	Exemplo
recipients	integer	Número de destinatários	1
messageCount	integer	Número total de mensagens cobradas	1
currency	string	Moeda	USD
totalAmount	string	Montante total consumido	0.018900
messages	JSON[]	Detalhes das mensagens enviadas

Mensagens `data.messages`

Nome	Tipo	Descrição	Exemplo
id	string	ID da mensagem	c9159d19f394833327e43c8e7285a6b3
to	string	Número de telefone do destinatário (E.164)	+12068800123
iso	string	Código do país (iso2)	US
cc	string	Código do país (prefixo internacional)	1
parts	integer	Número de partes da mensagem	1
price	string	Montante do consumo	0.018900

Exemplos de Resposta

Exemplo de resposta bem-sucedida

Código de status: 200, Corpo da resposta:

{
  "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"
      }
    ]
  }
}

Exemplo de resposta falha

Código de status: 400, Corpo da resposta:

{
  "code": "105400",
  "message": "FundsInsufficient"
}