Click2dial

Api de realização de chamadas de um ramal para um número (pode ser outro ramal ou um número externo).

Formato

A partir da versão 1.82-1 do pacote itflex-asterisk18:

http://pabxflex.empresa.lan/api/originate?token=TOKEN&src=RAMAL&dst=NUMERO

ou, no formato antigo (será mantido por motivos de compatibilidade):

http://pabxflex.empresa.lan/originate.php?token=TOKEN&src=RAMAL&dst=NUMERO

Realizar uma requisição HTTP GET.

Parâmetros

  • token: token de autenticação do cliente da API
  • src: ramal que irá originar a chamada
  • dst: número de destino sem o 0 (ex.: 30293388)
  • record(opcional): se ‘yes’, retorna o código da chamada para busca da gravação
  • mode(opcional): ‘direct’, ‘sigma-ura’, ‘json’ ou ‘sigma’, ‘app’, se setado, os retornos são em formato json

No caso de o mode ser ‘direct’

  • O PABX não irá fazer tratamento no número de destino dst, será discado como foi passado
  • Usado para integração com Seventh Situator, e outras aplicações.

No caso de de o mode ser ‘sigma-ura’ os parâmetros passam a ser os seguintes, além de mode=sigma-ura:

  • token: token de autenticação do cliente da API
  • dst: número de destino sem o 0 (ex.: 30293388)
  • record(opcional): se ‘yes’, retorna o código da chamada para busca da gravação
  • eventid: ID do evento gerado pelo Sigma
  • password: Senha a ser utilizada na URA
  • coercion: Senha de coerção a ser utilizada também na URA
  • sigma-url: Endereço para efetuar o retorno da URA

Exemplo de código da chamada (id/código da chamada sempre terá 40 caracteres alfanuméricos):

5cafdebe4e78588628681c0fa5fda8a410ccd966

Funcionamento

Ao acessar a URL a API irá validar o token, conectar no banco e pegar o contexto do ramal em questão, disparando um “originate” para o ramal e depois para o número de destino utilizando o contexto do ramal.

Cod status HTTP Status Corpo resposta
200 ok [vazio, ou o id da chamada caso o parâmetro record seja ‘yes’]
403 falhou Contexto do ramal não encontrado. Este ramal existe?
404 falhou Chamada falhou
405 falhou Favor informar os parâmetros ‘token’, ‘src’ e ‘dst’ corretamente
405 falhou Token de autenticação incorreto
410 falhou API Desabilitada pelo administrador

Obs: Na versão 1.85-1 foi desabilitadas as seguintes respostas:

Cod status HTTP Status Corpo resposta
503 falhou Conexão com servidor falhou
500 falhou Erro na conexão com o banco
500 falhou Erro ao selecionar a database
500 falhou Falha no script SQL: <script>

Formato de resposta json, no lugar do corpo da resposta:

Ok:

{"status": "ok", "id": "[id da chamada]"}

Erro:

{"status": "error", "cause": "[mesagem de erro]"}