Endpoint para consulta da mensagem postada.
Retorna todos os status de mensagem ( enviadas com o identificador correlationId ) que ainda não foram consultadas.
A lista é retornada em blocos de cem (100) itens por requisição.
Request:
Endpoint: https://api.21mobile.com.br/v1/status
Request Method : GET
Accept : application/json
Exemplo:
GET /v1/status HTTP/1.1
Host: api.21mobile.com.br
Authorization: Basic Zm9vOmJhcg==
Endpoint: /v1/status/date
Endpoint para consulta da mensagem postada por data do envio
Retorna todos os status de mensagem ( enviadas com o identificador correlationId ) que foram enviadas em um data específica.
A lista é retornada em blocos de cem (100) itens por requisição.
Ao final da lista , caso haja mais status para serem consultados, um link é disponibilizado para consulta
das mensagens restantes
Também é possivel consultar pelo numero de controle do cliente (correlationId) e número do destinatário (destination).
Request:
Endpoint: https://api.21mobile.com.br/v1/status/date
Query: ?date=1490214928
Request Method : GET
Exemplo:
GET /v1/status/date?date=1490214928 HTTP/1.1
Host: api.21mobile.com.br
Authorization: Basic Zm9vOmJhcg==
Parâmetros da requisição:
| Nome do campo | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| date | Data para consulta de status | long (Unix Timestamp) | Sim |
| correlationid | Número de controle do cliente | Text | Não |
| destination | Número o destinatário do SMS | Long | Não |
Response:
Tabela de respostas da requisição:
| status | code | message | sent_status | Descrição |
|---|---|---|---|---|
| OK | 5 | v | ver lista | Status da mensagem |
| OK | 6 | v | N/A | Sem registro para esta consulta |
| NOK | -20 | v | N/A | Erro na chamada |
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,
"message":"REQUIRED_OK",
"sent_status": [{
"correlationId" : "9838ASl9",
"destination" : "1199999999",
"sentDate" : "2017-03-27 11:24:21-03",
"unixSentDate" : "1490214928",
"status" : "DELIVERED"
}]
}
Tabela de status das mensagens:
| Status | Descrição |
|---|---|
| SENT | Enviado para operadora |
| DELIVERED | Entregue no aparelho celular |
| NOT_DELIVERED | Mensagem não entregue |
| DUPLICATED | Envio duplicado |
| INVALID_DESTINATION_ADDRESS | Numero do destinatário inválido |
| BLACKLIST | Número bloqueado para envio |
| MESSAGE_CANCELLED | Mensagem cancelada pela operadora \ SMSC |
| INVALID_MESSAGE_FORMAT | Formato de mensagem inválida |
| GENERAL_ERROR | Erro interno |