PABX/APIuTech
(→/call/summary) |
(→/call/summary) |
||
Linha 285: | Linha 285: | ||
== /call/summary == | == /call/summary == | ||
+ | <BR> | ||
+ | Endpoint utilizado para buscar informações de uma chamada, como NA, NB, duração entre outros. | ||
+ | |||
+ | {| style="width: 100%;" | ||
+ | |- | ||
+ | | style="width: 50%"| | ||
+ | |||
+ | |||
+ | {| style="width: 50%; background-color: #76b5c5;font-size:16px;padding: 12px;" | ||
+ | | '''GET''' /v1/call/'''summary''' | ||
+ | |} | ||
+ | <BR> | ||
+ | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
+ | | '''Parâmetros:''' | ||
+ | |} | ||
+ | {| class="wikitable" width="80%" | ||
+ | |- | ||
+ | ! scope="row" style="width: 20%;vertical-align:top;" align="right"| '''token''' | ||
+ | | Token definido na configuração do PABX uTech. | ||
+ | | ''string'' | ||
+ | | Mandatório | ||
+ | |- | ||
+ | ! scope="row" style="width: 20%" align="right"| '''id''' | ||
+ | | Identificador da chamada que deseja realizar o download da gravação. | ||
+ | | ''string'' | ||
+ | | Mandatório | ||
+ | |} | ||
+ | <BR> | ||
+ | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
+ | | '''Resposta:''' | ||
+ | |} | ||
+ | {| class="wikitable" width="80%" | ||
+ | |- | ||
+ | ! scope="row" style="width: 20%;" align="right"| '''status''' | ||
+ | | Estado da geração da chamada. | ||
+ | * '''error''': Erro na requisição. | ||
+ | | ''string'' | ||
+ | |- | ||
+ | ! scope="row" style="width: 20%" align="right"| '''summary''' | ||
+ | | Dados da chamada consultada: | ||
+ | * '''callid''': Identificação da chamada. | ||
+ | * '''url''': Link para download da gravação. | ||
+ | * ''''start_date''': Data/Hora de inicio da chamada. | ||
+ | * '''end_data''': Data/Hora de finalização da chamada. | ||
+ | * '''talk_duration''': Tempo, em segundos,de conversação. | ||
+ | * '''total_duration''': Tempo, em segundos,total da chamada. | ||
+ | * '''price''': Custo da chamada. | ||
+ | * '''caller''': Numero origem. | ||
+ | * '''called''': Numero destino. | ||
+ | | ''array/json'' | ||
+ | |- | ||
+ | ! scope="row" style="width: 20%" align="right"| '''cause''' | ||
+ | | Em caso de erro na requisição, uma ''string'' de causa do erro será preenchida. | ||
+ | | ''string'' | ||
+ | |} | ||
+ | |||
+ | <!-- Tabela Lateral --> | ||
+ | <!-- Tabela Lateral --> | ||
+ | <!-- Tabela Lateral --> | ||
+ | | style="width: 20%;margin-left: auto; margin-right: 0px;""| | ||
+ | <!-- Tabela Lateral --> | ||
+ | | style="width: 30%;margin-left: auto; margin-right: 0px;""| | ||
+ | |||
+ | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
+ | | '''Exemplo:''' | ||
+ | |} | ||
+ | <pre style="width: 50%;> | ||
+ | /utech/v1/call/summary/?token=1234&id=1694435179.3 | ||
+ | </pre> | ||
+ | <BR> | ||
+ | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
+ | | '''200 OK:''' | ||
+ | |} | ||
+ | <pre> | ||
+ | { | ||
+ | "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" | ||
+ | } | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
+ | | '''Erro 4XX/5XX:''' | ||
+ | |} | ||
+ | <pre> | ||
+ | { | ||
+ | "status": "error", | ||
+ | "cause": "Invalid callid" | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | |} | ||
+ | <BR><BR> | ||
+ | |||
+ | == /call/call_status == | ||
+ | <BR> | ||
+ | Endpoint utilizado para buscar informações de uma chamada, como NA, NB, duração entre outros. | ||
+ | |||
+ | {| style="width: 100%;" | ||
+ | |- | ||
+ | | style="width: 50%"| | ||
+ | |||
+ | |||
+ | {| style="width: 50%; background-color: #76b5c5;font-size:16px;padding: 12px;" | ||
+ | | '''GET''' /v1/call/'''summary''' | ||
+ | |} | ||
+ | <BR> | ||
+ | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
+ | | '''Parâmetros:''' | ||
+ | |} | ||
+ | {| class="wikitable" width="80%" | ||
+ | |- | ||
+ | ! scope="row" style="width: 20%;vertical-align:top;" align="right"| '''token''' | ||
+ | | Token definido na configuração do PABX uTech. | ||
+ | | ''string'' | ||
+ | | Mandatório | ||
+ | |- | ||
+ | ! scope="row" style="width: 20%" align="right"| '''id''' | ||
+ | | Identificador da chamada que deseja realizar o download da gravação. | ||
+ | | ''string'' | ||
+ | | Mandatório | ||
+ | |} | ||
+ | <BR> | ||
+ | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
+ | | '''Resposta:''' | ||
+ | |} | ||
+ | {| class="wikitable" width="80%" | ||
+ | |- | ||
+ | ! scope="row" style="width: 20%;" align="right"| '''status''' | ||
+ | | Estado da geração da chamada. | ||
+ | * '''error''': Erro na requisição. | ||
+ | | ''string'' | ||
+ | |- | ||
+ | ! scope="row" style="width: 20%" align="right"| '''summary''' | ||
+ | | Dados da chamada consultada: | ||
+ | * '''callid''': Identificação da chamada. | ||
+ | * '''url''': Link para download da gravação. | ||
+ | * ''''start_date''': Data/Hora de inicio da chamada. | ||
+ | * '''end_data''': Data/Hora de finalização da chamada. | ||
+ | * '''talk_duration''': Tempo, em segundos,de conversação. | ||
+ | * '''total_duration''': Tempo, em segundos,total da chamada. | ||
+ | * '''price''': Custo da chamada. | ||
+ | * '''caller''': Numero origem. | ||
+ | * '''called''': Numero destino. | ||
+ | | ''array/json'' | ||
+ | |- | ||
+ | ! scope="row" style="width: 20%" align="right"| '''cause''' | ||
+ | | Em caso de erro na requisição, uma ''string'' de causa do erro será preenchida. | ||
+ | | ''string'' | ||
+ | |} | ||
+ | |||
+ | <!-- Tabela Lateral --> | ||
+ | <!-- Tabela Lateral --> | ||
+ | <!-- Tabela Lateral --> | ||
+ | | style="width: 20%;margin-left: auto; margin-right: 0px;""| | ||
+ | <!-- Tabela Lateral --> | ||
+ | | style="width: 30%;margin-left: auto; margin-right: 0px;""| | ||
+ | |||
+ | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
+ | | '''Exemplo:''' | ||
+ | |} | ||
+ | <pre style="width: 50%;> | ||
+ | /utech/v1/call/summary/?token=1234&id=1694435179.3 | ||
+ | </pre> | ||
+ | <BR> | ||
+ | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
+ | | '''200 OK:''' | ||
+ | |} | ||
+ | <pre> | ||
+ | { | ||
+ | "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" | ||
+ | } | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
+ | | '''Erro 4XX/5XX:''' | ||
+ | |} | ||
+ | <pre> | ||
+ | { | ||
+ | "status": "error", | ||
+ | "cause": "Invalid callid" | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | |} | ||
+ | <BR><BR> | ||
+ | |||
+ | == /call/call_status == | ||
<BR> | <BR> | ||
Endpoint utilizado para buscar informações de uma chamada, como NA, NB, duração entre outros. | Endpoint utilizado para buscar informações de uma chamada, como NA, NB, duração entre outros. |
Edição de 11h44min 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 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 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" } |