Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 18 Próxima »

/did/save

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

 
 
DESCRIÇÃOCom este método é possível inserir uma rota em um DID Directcall (Numero de Telefone Virtual).
ESTRUTURA DA URLhttps://api.directcallsoft.com/did/save
VERSÃO1
MÉTODOPOST
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

Exemplo de resposta em JSON
{
    "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:

  • sound - Toca um audio pré cadastrado
  • fwd - Encaminha a chamada para um numero de telefone real de qualquer operadora Fixa, Móvel ou IP, ou para um login SIP da Directcall
  • voicemail - Encaminha a chamada para o voicemail da Directcall.
    (Mensagens registradas pelo voicemail são encaminhadas para o email configurado neste recurso).
  • hup - Causa o desligamento da chamada

 

Ação sound
{
    "sound": "3" // ID do arquivo de som no servidor.
}
Ação voicemail
{
    "email": "[email protected]" // Endereço de e-mail para envio das mensagens registradas no voicemail da Directcall.
}
Ação fwd
{
    "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, // Gravar? booleano
    "wait": 10 // Tempo máximo de ring, em segundos
}
Ação hup
{
    "cause": "NORMAL_CLEARING" // causa do desligamento
}

Opções

Todas as ações podem ser opcionalmente limitadas à um periodo de tempo(Dia da semana e Horário), conforme exemplo:

Opções
// 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:

Exemplo de rota
[
    {
        "priority": "1", // PRIORIDADE da ação
        "action": "sound",
        "data": {
            "sound": "3"
        }
    }, {
        "priority": "2",
        "action": "fwd",
        "data": {
            "phone": "554130160300",
            "wait": 10,
			"weekTime":"1111111,00:00-23:59" // Dias da semana DSTQQSS e horarios
        }
    }, {
        "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]"
        }
    }
]

 

 

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.

 

  • Sem rótulos