Versões comparadas

Versão Versão antiga 24 Nova versão Atual
Alterações feitas por

Former user

Leanderson Correia

Gravado em

Chave

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

/did/save

Este método permite a inserção ou a atualização de recursos em um DID Directcall (Numero Número de Telefone Virtual).

...

 

DESCRIÇÃO

Com este método, é possível inserir uma rota em um Número de telefone da Directcall (DID), indicar se a chamada recebida deve ser gravada, tocar um arquivo de áudio padrão para quem liga para um número de telefone da Directcall e/ou para quem atende uma ligação, encaminhar a chamada para correio de voz, etc.

ESTRUTURA DA URL

https://api.directcallsoft.com/did/save

VERSÃO

1

MÉTODO

POST

PARÂMETROS

did obrigatório

 ID do

DID que terá sua rota registrada ou atualizada (DDD + Número)

data obrigatório Dialplan em formato JSON

clique

. Clique aqui para ver como formatar seu dialplan

access_token obrigatório Chave de acesso ao método

, para

. Para saber como obter clique aqui

formato opcional Opção de retorno da API, podendo ser JSON ou XML

,

(se não informado, JSON será o padrão)

RETORNO

api Nome da 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

msg Array de resposta da API

paginas Quantidade de páginas

code

title

Exemplo de resposta em JSON
linenumbers
Bloco de código
true
{
    "api": "did",
    "modulo": "did-save",
    "status": "ok",
    "codigo": "000",
    "msg": "Seu Dial-plain foi salvo com sucesso."
}

 

 
Como formatar a rota do seu DID
 Âncora
route
route
Lista de recursos disponíveis:
sound 
  • Sound - Toca um áudio para quem liga para um número de telefone da Directcall
bPlayback 
  • Playback - Toca um áudio para quem atende uma ligação em um número de telefone da Directcall
fwd 
  • Fwd - Encaminha a chamada para um 
 numero 
  • número de telefone real de qualquer operadora Fixa, Móvel ou IP, ou para um login SIP da Directcall
voicemail 
  • Voicemail - Encaminha a chamada para o voicemail da Directcall. 
    (Mensagens registradas pelo voicemail são encaminhadas para o email configurado neste recurso).
hup 
  • Hup - 
 Causa 
  • Força o desligamento da chamada
 
code
titletrue
Ação sound
linenumbers
 Bloco de código
{
    "sound": "3" // (Opcional) // ID do arquivo de som que se deseja tocar para quem liga para um número de telefone da Directcall.
}
NOTA: Para cadastrar um áudio e obter um ID de arquivo de som
 e 
, acesse Cadastrar 
 audiotitle
áudio
 
 Bloco de código
Ação voicemail
linenumbers
 Bloco de código
truetitle
{
    "email": "seuemail@seudominio.com.br" // Endereço de e-mail para envio das mensagens registradas no voicemail da Directcall.
}
 Bloco de código
Ação fwd
linenumberstruetitle
 Bloco de código
{
    "phone": "551199998888", // Numero de telefone real ou login SIP fornecido pela Directcall onde o seu número de telefone virtual será atendido. O número deve conter cód. de país e cód. de área. O cód. de país do Brasil é 55. Aceita numero de telefone real de qualquer operadora Fixa, Móvel ou IP.
    "rec": true, // booleano // Indique true neste parâmetro se deseja gravar a ligação recebida.
    "wait": 10, // Tempo máximo de ring, em segundos
	"bPlayback": 000 // (Opcional) // ID do arquivo de som que se deseja tocar para quem atende uma ligação em um número de telefone da Directcall.
}
 Bloco de código
Ação hup
linenumberstrue
 Bloco de código
{
    "cause": "NORMAL_CLEARING" // causa do desligamento
}
Opções
Todas as ações podem ser opcionalmente limitadas 
 à 
a um 
 periodo 
período de tempo (Dia da semana e Horário), conforme exemplo:
 Bloco de códigotitle
Opções
linenumbers
 Bloco de código
true
// Ação hup com limitação de Horário
{
    "cause": "NORMAL_CLEARING", // causa do desligamento
    "weekTime":"1111111,00:00-23:59" // Dias da semana DSTQQSS e horarios
}
 
Exemplo de uso dos recursos, considerando a opção de tocar um áudio padrão para quem liga para um número de telefone da Directcall (prioridade 1) e em seguida, um áudio padrão para quem atende:
NOTA: Para cadastrar um áudio e obter um ID de arquivo de som
 e 
, acesse Cadastrar 
 audio
áudio 
 Bloco de códigotitle
Exemplo de rota
linenumberstrue
 Bloco de código
[
    {
        "priority": "1", // PRIORIDADE da ação
        "action": "sound",
        "data": {
            "sound": "3" // ID do arquivo de som que se deseja tocar para quem liga para um número de telefone da Directcall.
        }
    }, {
        "priority": "2",
        "action": "fwd",
        "data": {
            "phone": "554130160300",
            "wait": 10,
			"weekTime":"1111111,00:00-23:59", // Dias da semana DSTQQSS e horarios
			"bPlayback": 100 // ID do arquivo de som que se deseja tocar para quem atende uma ligação em um número de telefone da Directcall.
        }
    }, {
        "priority": "3",
        "action": "fwd",
        "data": {
            "phone": "TEDC2",
            "rec": true,
            "wait": 10
        }
    }, {
        "priority": "4",
        "action": "sound",
        "data": {
            "sound": "4"
        }
    }, {
        "priority": "5",
        "action": "voicemail",
        "data": {
            "email": "seunome@seudominio.com.br"
        }
    }
]
 
 
 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.
...