Endpoint para envio de mensagens curtas SMS a um recipente (MT)
Request:
Endpoint: https://api.21mobile.com.br/v1/send
Request Method : POST
Accept : application/json
Importante:
- Você pode enviar de 1 até 200 SMS po requisição.
- Limite de 1 requisição por segundo.
Obs.: Com estes parâmetros é possível enviar até 200 SMS por segundo.
Isso lhe garante uma vazão de 12.000 SMS por minuto e 720.000 SMS por hora.
Caso precise de uma vazão maior que essa, contate nossa equipe.
Exemplo:
POST /v1/send HTTP/1.1
Host: api.21mobile.com.br
Authorization: Basic Zm9vOmJhcg==
Content-Type: application/json
{
"sms": [{
"messageText" : "Sua Mensagem aqui", //String(160)
"destination": "11987654321", //DDNNNNNNNNN (DDD + numero com ou sem nono digito)
"correlationId" : "YTS54", //Seu identificador para seu controle. String(50)
"scheduledDate": 1508933796 //UNIX Timestamp
},
{
"messageText" : "Outra Mensagem aqui",
"destination": "55345699", //Numero inválido
"correlationId" : "YTS55",
"scheduledDate": 1508933796
}]
}
Parâmetros da requisição:
| Chave | Nome do campo | Descrição | Tipo | Obrigatório |
|---|---|---|---|---|
| SMS | lista de mensagens | lista | sim | |
| messageText | texto a ser enviado | String (160) | sim | |
| destination | número telefone | String (11) | sim | |
| correlationId | identificador client | String (50) | não | |
| scheduledDate | data do envio (UNIX Timestamp) | Long | não |
Response:
Tabela de respostas:
| Status | Code | Message | Descrição |
|---|---|---|---|
| OK | 5 | x | mensagem postada |
| NOK | -5 | v | erro na chamada |
| NOK | 429 | v | Too many requests |
Exemplo
Connection : Keep-Alive
Content-Length : 83
Content-Type : application/json
Date : Tue, 28 Mar 2017 18:31:20 GMT
Keep-Alive : timeout=5, max=100
Server : Apache/2.4.7 (Ubuntu)
Status : 200
[
{
"status":"OK",
"code":5,
"id_sms":"1414",
"correlationId":"YTS54"
},
{
"status":"NOK",
"code":-5,
"message":"INVALID_NUMBER_FORMAT",
"correlationId":"YTS55"
}
]