/sms/status/callback
DESCRIÇÃO | Esta API facilita que a sua aplicação receba automático o status de cada SMS enviado com short number, cada vez que um SMS muda de status, ex.:
|
|
|
Para automatizar o recebimento de status de SMS no seu sistema, basta registrar uma URL de notificação por callback, conforme indicamos a seguir: | |
ESTRUTURA DA URL | |
VERSÃO | 1 |
MÉTODO | POST |
PARÂMETROS | access_token obrigatório Chave de acesso ao método, para saber como obter, clique aqui url obrigatório (String) URL para envio do SMS recebido |
início da URL usuário e senha: Por exemplo: https://usuario:senha@dominiodocliente.com.br |
format opcional Opção de retorno da API podendo ser JSON ou XML, se não informado JSON será o padrão | |
RETORNO | api Origem API que |
está sendo usada modulo Módulo que está sendo chamado status Mensagem de status codigo Código de retorno - Clique aqui para listar os códigos e suas descrições code Identificador |
único da URL registrada |
Exemplo de resposta em JSON
|
|
|
|
|
|
|
|
Caso você já tenha registrado uma ou mais URL de callback você pode consultar a(s) URL(s) através do seguiste método:
Consultar URL(s) registradas para callback
...
...
DESCRIÇÃO | Com este método podemos verificar todas as URL registradas |
ESTRUTURA DA URL | |
VERSÃO | 1 |
MÉTODO | POST | GET |
PARÂMETROS | access_token obrigatório Chave de acesso ao método, para saber como obter clique aqui format opcional Opção de retorno da API podendo ser JSON ou XML, se não informado JSON será o padrão |
RETORNO | api Origem API que |
está sendo usada modulo Módulo que está sendo chamado status Mensagem de status codigo Código de retorno - Clique aqui para listar os códigos e suas descrições total Total de |
URL's registradas rows Array com resultado, tendo a url e o code (identificador único) Exemplo de resposta em JSON
|
|
|
|
|
|
|
|
|
|
|
|
Para remover uma URL que esta está registrada para receber o callback de um SMS recebido, você vai precisar o code (Identificador único da URL).
Removendo URL registrada para callback
...
DESCRIÇÃO | Com este método podemos remover uma URL registrada para recebimento de callback de SMS enviado |
ESTRUTURA DA URL | |
VERSÃO | 1 |
MÉTODO | POST |
PARÂMETROS | access_token obrigatório Chave de acesso ao método, para saber como obter clique aqui code obrigatório (String) Identificador único da URL registrada a ser removida format opcional Opção de retorno da API podendo ser JSON ou XML, se não informado JSON será o padrão |
RETORNO | api Origem API que |
está sendo usada modulo Módulo que está sendo chamado status Mensagem de status codigo Código de retorno - Clique aqui para listar os códigos e suas descrições Exemplo de resposta em JSON
|
|
|
|
|
|
|
Como vou receber e quais dados vou receber pelo sistema de callback?
- Nosso sistema vai realizar um POST HTTP para a sua URL e os dados da mensagem serão encaminhados no formato "Form Data"
Dados recebidos vindo do Callback
DESCRIÇÃO | Dados vindo do callback |
VERSÃO | 1 |
MÉTODO | POST |
PARÂMETROS | to - |
Número origem do SMS recebido msg - Mensagem de texto recebida pelo sistema date - Data de recebimento do SMS : Formato dd-mm-YYYY code - Código identificador do SMS no sistema status - Mensagem de status do sistema |
| Informações |
|---|
...
Validade dos tokens: Os tokens de acesso têm uma validade limitada, por isso convém que o sistema criado tenha em conta estes timings para que possa desenvolver rotinas de requisação de novos tokens. |
...
Veja também:
HELPER para facilitar o envio de SMS na sua aplicação
Acelere a implantação com este miniaplicativo baseado em HTML e Javascript, com interfaces prontas para os usuários da sua aplicação utilizarem esta API.