PABX/APIuTech

De uTech Tecnologia
(Diferença entre revisões)
Ir para: navegação, pesquisa
(/call/makecall)
(/call/makecall)
Linha 35: Linha 35:
 
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.  
 
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.  
  
{| class="wikitable" style="width: 85%;"
+
{| style="width: 100%;"
 
|-
 
|-
 
| style="width: 50%"|
 
| style="width: 50%"|
Linha 43: Linha 43:
 
| '''GET''' /v1/call/'''makecall'''
 
| '''GET''' /v1/call/'''makecall'''
 
|}
 
|}
<pre>
+
<BR>
GET /utech/v1/call/makecall/?token=1234&sorce=2000&destination=04833334840
+
</pre>
+
 
{| style="width: 80%; font-size:18px;padding: 12px;"  
 
{| style="width: 80%; font-size:18px;padding: 12px;"  
 
| '''Parâmetros:'''
 
| '''Parâmetros:'''
Linha 90: Linha 88:
 
<!-- Tabela Lateral -->
 
<!-- Tabela Lateral -->
 
<!-- Tabela Lateral -->
 
<!-- Tabela Lateral -->
 +
| style="width: 20%;margin-left: auto; margin-right: 0px;""|
 
<!-- Tabela Lateral -->
 
<!-- Tabela Lateral -->
 +
| style="width: 30%;margin-left: auto; margin-right: 0px;""|
  
| style="width: 50%;margin-left: auto; margin-right: 0px;""|
+
{| style="width: 80%; font-size:18px;padding: 12px;"  
 
+
| '''Exemplo:'''
 
+
|}
 +
<pre style="width: 50%;>
 +
GET /utech/v1/call/makecall/?token=1234&sorce=2000&destination=04833334840
 +
</pre>
 
<BR>
 
<BR>
 
{| style="width: 80%; font-size:18px;padding: 12px;"  
 
{| style="width: 80%; font-size:18px;padding: 12px;"  
Linha 117: Linha 120:
  
 
|}
 
|}
 +
<BR><BR>
  
 
== /call/get_rec ==
 
== /call/get_rec ==

Edição de 12h15min 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
souce 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

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

/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