Callback de SMS Enviado
A API Directcall envia ao sistema do cliente o status de um SMS enviado a um celular (esta funcionalidade é utilizada para saber se o celular recebeu o sms, operadora aguardando que o celular esteja ativo ou não recebeu).
Para receber este status de SMS em seu sistema, é necessário registrar uma URL de notificação.
Registrando um URL de notificação
| DESCRIÇÃO | Com este método podemos registrar um URL para recebimento de callback de SMS enviado | |||
| ESTRUTURA DA URL | https://api.directcallsoft.com/sms/add-callback-status | |||
| 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 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 esta 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 unico da URL registrada
|
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 | https://api.directcallsoft.com/sms/list-callback | |||
| 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 esta 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)
|
Para remover uma URL que esta 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 | https://api.directcallsoft.com/sms/remove-callback | |||
| 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 esta 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
|
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 JSON
Dados recebidos vindo do Callback
| DESCRIÇÃO | Dados vindo do callback |
| FORMATO | JSON |
| VERSÃO | 1 |
| MÉTODO | POST |
| PARÂMETROS | from - Numero 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 |
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.