PABX/APIuTech
(→/call/endcall) |
(→/call/call_status) |
||
Linha 392: | Linha 392: | ||
== /call/call_status == | == /call/call_status == | ||
<BR> | <BR> | ||
− | Endpoint utilizado para buscar | + | Endpoint utilizado para buscar o estado atual de uma chamada. |
{| style="width: 100%;" | {| style="width: 100%;" | ||
Linha 430: | Linha 430: | ||
| ''string'' | | ''string'' | ||
|- | |- | ||
− | ! scope="row" style="width: 20%" align="right"| ''' | + | ! scope="row" style="width: 20%" align="right"| '''state''' |
− | | | + | | Estado da chamada: |
− | * ''' | + | * '''answered''': Chamada atendida. |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
| ''array/json'' | | ''array/json'' | ||
|- | |- | ||
Linha 459: | Linha 452: | ||
|} | |} | ||
<pre style="width: 50%;> | <pre style="width: 50%;> | ||
− | /utech/v1/call/ | + | /utech/v1/call/call_status/?token=1234&id=1694435179.3 |
</pre> | </pre> | ||
<BR> | <BR> | ||
Linha 468: | Linha 461: | ||
{ | { | ||
"status": "ok", | "status": "ok", | ||
− | " | + | "id": "1695384025.44", |
− | + | "state": "answered" | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
} | } | ||
</pre> | </pre> |
Edição de 12h04min de 22 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ÃO ⇒ Configuração. Depois clique na aba Integrações ⇒ Geral. 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! |
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 chamada, origem e destino estarão em conversação.
|
GET /utech/v1/call/makecall/?token=1234&source=2000&destination=04833334840
{ "status": "ok", "id": "1695129954.462751335" }
{ "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 chamada, o PABX uTech irá iniciar o download da gravação. Caso contrário, será retornado erro 404 e um json com a causa.
|
/utech/v1/call/get_record/?token=1234&id=1694435179.3
A gravação!
{ "status": "error", "cause": "Invalid callid" } |
/call/get_rec_uri
Endpoint utilizado para buscar o link para de download de uma gravação. Se o ID passado corresponder a uma chamada válida e houver gravação dessa chamada, o PABX uTech retornar um json com o link da gravação. Caso contrário, será retornado erro 404 e um json com a causa.
|
/utech/v1/call/get_record_uri/?token=1234&id=1694435179.3
{ "status": "ok", "url": "https://dominio/storage/19092023/4001_6002_eb00000a_18750_003351.wav" }
{ "status": "error", "cause": "Invalid callid" } |
/call/summary
Endpoint utilizado para buscar informações de uma chamada, como NA, NB, duração entre outros.
|
/utech/v1/call/summary/?token=1234&id=1694435179.3
{ "status": "ok", "summary": { "callid": "1694435179.3", "url": "https://dominio/storage/19092023/4001_6002_eb00000a_18750_003351.wav", "start_date": "2023-09-19T00:33:51-03:00", "end_data": "2023-09-19T00:33:55-03:00", "talk_duration": "33", "total_duration": 42, "price": "0", "caller": "2000", "called": "4833334840" } }
{ "status": "error", "cause": "Invalid callid" } |
/call/call_status
Endpoint utilizado para buscar o estado atual de uma chamada.
|
/utech/v1/call/call_status/?token=1234&id=1694435179.3
{ "status": "ok", "id": "1695384025.44", "state": "answered" }
{ "status": "error", "cause": "Invalid callid" } |
/call/endcall
Endpoint utilizado para derrubar/desligar uma chamada ativa..
|
/utech/v1/call/endcall/?token=1234&id=1694435179.3
{ "status": "ok", "callstate": "finished", "id": "1695383395.42" }
{ "status": "error", "cause": "Invalid callid" } |