Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

/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.:

  • se o SMS foi entregue na operadora móvel

  • se o SMS foi entregue no telefone móvel de destino

  • se o número do destino não era válido, etc

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

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 

IMPORTANTE: Você pode evitar que a sua URL fique exposta utilizando autenticação por HTTP Basic Auth, basta adicionar ao 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
Bloco de código
{

  "api":"sms",


  "modulo":"add-callback",


  "status":"ok",


  "codigo":"001",


  "msg":"URL de Callback cadastrada com sucesso.",


  "code":"7cfa08f1bdc011d524d8ec8bbceb7d06df237a14"


}

Caso você já tenha registrado uma ou mais URL de callback você pode consultar a(s) URL(s) através do seguiste método:

...

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 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
Bloco de código
{


"api":"sms",


"modulo":"list-callback",


"status":"ok",


"codigo":"001",


"msg":[],


"total":2,


"rows":


[


{"code":"aedd74c466f0dba65bc641f19355bf7a98d790c9","url":"http:\/\/www..com.br\/webservice\/test.php"}, {"code":"7cfa08f1bdc011d524d8ec8bbceb7d06df237a14","url":"http:\/\/www..com.br\/webservice\/test2.php"}


]


}

Para remover uma URL que está registrada para receber o callback de um SMS recebido, você vai precisar o code (Identificador único da URL).

...

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 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
Bloco de código
{

  "api":"sms",


  "modulo":"remove-callback",


  "status":"ok",


  "codigo":"001",


  "msg":"URL de Callback removida com sucesso."

}

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" 

...

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

...