PABX/APIuTech

De uTech Tecnologia
(Diferença entre revisões)
Ir para: navegação, pesquisa
(/call/makecall)
(/call/get_rec)
Linha 121: Linha 121:
 
|}
 
|}
 
<BR><BR>
 
<BR><BR>
 
== /call/get_rec ==
 
 
<nowiki>
 
http://10.0.0.1/utech/v1/call/get_record/?token=1234&id=1694435179.3
 
</nowiki>
 
 
  
 
== /call/get_record ==
 
== /call/get_record ==

Edição de 12h19min de 21 de setembro de 2023

Tabela de conteúdo


Introdução

  • A API do PABX uTech está disponível para a versão 1.0.1 - Qui 20 Sep 2023 ou superior.



Configuração do PABX

  • Para habilitar ou desabilitar o acesso a API, acesse a interface WEB do PABX, menu GESTÃOConfiguração. Depois clique na aba IntegraçõesGeral. Não opção API uTech'
  • Habilite ou desabilite a opção Habilitar API.
  • Configure um token de acesso no campo Token. É mandatório a configuração de um token. Se o campo ficar vazio, não será possível a utilização da API.


Nota: utilize um token forte, pois a API deixará seu PABX aberto para tentativas de uso da API!


Pabx-apiutech-config.png


Observações

  • A API retorna valores no formato JSON.
  • Utiliza protocolo HTTP.


Endpoints

/call/makecall


Endpoint utilizado para gerar uma chamada. Ao executar o endpoint, será gerada uma chamada para o numero origem (parâmetro source). Quando a origem atender a chamada, será gerado pelo PABX uma chamada para o numero destino (parâmetro destination). Quando o destino atender a chamadas, origem e destino estarão em conversação.


GET /v1/call/makecall


Parâmetros:
token Token definido na configuração do PABX uTech. string Mandatório
source Numero origem da chamadas. Ramal, fila, etc. string Mandatório
destination Número destino da chamada. string Mandatório


Resposta:
status Estado da geração da chamada.
  • ok: Chamada será realizada.
  • error: Erro na requisição.
string
id Identificador da chamadas (callid). Essa identificação será utilizada para requisições de status e gravação da chamada. string
cause Em caso se erro na requisição, uma string de causa do erro será preenchida.. string
Exemplo:
GET /utech/v1/call/makecall/?token=1234&source=2000&destination=04833334840


200 OK:
{
  "status": "ok",
  "id": "1695129954.462751335"
}
Erro 4XX/5XX:
{
  "status": "error",
  "cause": "Authentication error"
}



/call/get_record


Endpoint utilizado para fazer o download de uma gravação. Se o ID passado corresponder a uma chamada válida e houver gravação dessa chamadas, o PABX uTech irá iniciar o download da gravação. Caso contrário, será retornado erro 404 e um json com a csausa.


GET /v1/call/get_record


Parâmetros:
token Token definido na configuração do PABX uTech. string Mandatório
id Numero origem da chamadas. Ramal, fila, etc. string Mandatório
destination Número destino da chamada. string Mandatório


Resposta:
status Estado da geração da chamada.
  • ok: Chamada será realizada.
  • error: Erro na requisição.
string
id Identificador da chamadas (callid). Essa identificação será utilizada para requisições de status e gravação da chamada. string
cause Em caso se erro na requisição, uma string de causa do erro será preenchida.. string
Exemplo:
GET /utech/v1/call/makecall/?token=1234&sorce=2000&destination=04833334840


200 OK:
{
  "status": "ok",
  "id": "1695129954.462751335"
}
Erro 4XX/5XX:
{
  "status": "error",
  "cause": "Authentication error"
}



/call/get_rec_uri

http://10.0.0.1/utech/v1/call/get_record_uri/?token=1234&id=1694435179.3

/call/summary

http://10.0.0.1/utech/v1/call/summary/?token=1234&id=1694435179.3

Ferramentas pessoais
Espaços nominais

Variantes
Visualizações
Ações
Navegação
Ferramentas