Versões comparadas

Chave

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

Callback de status de chamada

...

 
 
DESCRIÇÃOCom este método, podemos registrar uma URL para receber avisos de ligações recebidas e avisos de mudança no status de ligações realizadas
ESTRUTURA DA URLhttps://api.directcallsoft.com/voz/add-callback
VERSÃO1
MÉTODOPOST
PARÂMETROS

access_token obrigatório Chave de acesso ao método, para saber como obter clique aqui

url obrigatório (String) URL que recebera o status das chamadas 

IMPORTANTE:
Você pode evitar que a sua URL fique exposta utilizando autenticação por HTTP Basic Auth, basta adicionar ao inicio 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 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 único da URL registrada

 

Exemplo de resposta em JSON

{

"api":"sms",
"modulo":"add-callback-status-chamada",
"status":"ok",
"codigo":"001",
"msg":"URL de Callback cadastrada com sucesso.",
"code":"7cfa08f1bdc011d524d8ec8bbceb7d06df237a14"
}

...

 
 
DESCRIÇÃOCom este método podemos remover uma URL registrada para recebimento de callback de SMS enviado
ESTRUTURA DA URLhttps://api.directcallsoft.com/sms/remove-callback
VERSÃO1
MÉTODOPOST
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

Exemplo de resposta em JSON

{

"api":"sms",
"modulo":"remove-callback",
"status":"ok",
"codigo":"001",
"msg":"URL de Callback removida com sucesso."

}

 

...

 
 
DESCRIÇÃODados vindo do callback
FORMATOJSON
VERSÃO1
MÉTODOPOST
PARÂMETROS

data - Status no formato JSON

 
Bloco de código
themeEmacs
languagejs
titleExemplo de resposta JSON
{
	"origem": "554130160300",
	"destino": "554130160300",
	"uuid-origem": "0d87cc44-3142-11e5-ab4e-8326f25suj27519",
	"origem-status": "ANSWERED", // CREATED | ANSWERED | DESTROYED  
	"destino-status": "ANSWERED",
	"status-times":
		{
			"origem":{
				"chamada": "2015-01-01 00:00:00", // Data de chamada
				"atendida": "2015-01-01 00:00:00", // Data de atendida
				"finalizada": "2015-01-01 00:00:00", // Data de desligamento
			},
			"destino":{
				"chamada": "2015-01-01 00:00:00",
				"atendida": "2015-01-01 00:00:00",
				"finalizada": "2015-01-01 00:00:00",
			}
		}
}

...