...
Este método permite a inserção ou a atualização de recursos em um DID Directcall (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 data obrigatório Dialplan em formato JSON. Clique aqui para ver como formatar seu dialplan access_token obrigatório Chave de acesso ao método. 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 | Bloco de código |
|---|
| title | Exemplo de resposta em JSON |
|---|
| linenumbers | 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 |
|---|
Lista de recursos disponíveis: |
| Bloco de código |
|---|
| title | Ação sound |
|---|
| linenumbers | true |
|---|
| {
"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, acesse Cadastrar áudio
| Bloco de código |
|---|
| title | Ação voicemail |
|---|
| linenumbers | true |
|---|
| {
"email": "[email protected]" // Endereço de e-mail para envio das mensagens registradas no voicemail da Directcall.
} |
| Bloco de código |
|---|
| title | Ação fwd |
|---|
| linenumbers | true |
|---|
| {
"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 |
|---|
| title | Ação hup |
|---|
| linenumbers | true |
|---|
| {
"cause": "NORMAL_CLEARING" // causa do desligamento
} |
OpçõesTodas as ações podem ser opcionalmente limitadas a um período de tempo (Dia da semana e Horário), conforme exemplo: | Bloco de código |
|---|
| title | Opções |
|---|
| linenumbers | 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, acesse Cadastrar áudio | Bloco de código |
|---|
| title | Exemplo de rota |
|---|
| linenumbers | true |
|---|
| [
{
"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": "[email protected]"
}
}
] |
|
| Informações |
|---|
| title | 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. |
|---|
| |
|