PABX/APIuTech
De uTech Tecnologia
(Diferença entre revisões)
(→/call/get_rec_uri) |
|||
| Linha 210: | Linha 210: | ||
{| style="width: 50%; background-color: #76b5c5;font-size:16px;padding: 12px;" | {| style="width: 50%; background-color: #76b5c5;font-size:16px;padding: 12px;" | ||
| − | | '''GET''' /v1/call/''' | + | | '''GET''' /v1/call/'''get_record_uri''' |
|} | |} | ||
<BR> | <BR> | ||
| Linha 238: | Linha 238: | ||
* '''error''': Erro na requisição. | * '''error''': Erro na requisição. | ||
| ''string'' | | ''string'' | ||
| + | |- | ||
| + | ! scope="row" style="width: 20%" align="right"| '''url''' | ||
| + | | Link para download da gravação. | ||
| + | | ''uri'' | ||
|- | |- | ||
! scope="row" style="width: 20%" align="right"| '''cause''' | ! scope="row" style="width: 20%" align="right"| '''cause''' | ||
| Linha 255: | Linha 259: | ||
|} | |} | ||
<pre style="width: 50%;> | <pre style="width: 50%;> | ||
| − | /utech/v1/call/ | + | /utech/v1/call/get_record_uri/?token=1234&id=1694435179.3 |
</pre> | </pre> | ||
<BR> | <BR> | ||
| Linha 262: | Linha 266: | ||
|} | |} | ||
<pre> | <pre> | ||
| − | + | { | |
| − | </pre> | + | "status": "ok", |
| + | "url": "https://pabx.dominio.com/storage/19092023/4001_6002_3200000a_7038_eb00000a_18750_003351.wav" | ||
| + | }</pre> | ||
{| style="width: 80%; font-size:18px;padding: 12px;" | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
Edição de 12h55min 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Ã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://pabx.dominio.com/storage/19092023/4001_6002_3200000a_7038_eb00000a_18750_003351.wav"
}
{
"status": "error",
"cause": "Invalid callid"
}
|
/call/summary
http://10.0.0.1/utech/v1/call/summary/?token=1234&id=1694435179.3
