PABX/APIuTech
De uTech Tecnologia
(Diferença entre revisões)
(→/call/get_record) |
(→/call/get_record) |
||
| Linha 146: | Linha 146: | ||
|- | |- | ||
! scope="row" style="width: 20%" align="right"| '''id''' | ! scope="row" style="width: 20%" align="right"| '''id''' | ||
| − | | | + | | Identificador da chamada que deseja realizar o download da gravação. |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| ''string'' | | ''string'' | ||
| Mandatório | | Mandatório | ||
| Linha 163: | Linha 158: | ||
! scope="row" style="width: 20%;" align="right"| '''status''' | ! scope="row" style="width: 20%;" align="right"| '''status''' | ||
| Estado da geração da chamada. | | Estado da geração da chamada. | ||
| − | |||
* '''error''': Erro na requisição. | * '''error''': Erro na requisição. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| ''string'' | | ''string'' | ||
|- | |- | ||
! scope="row" style="width: 20%" align="right"| '''cause''' | ! scope="row" style="width: 20%" align="right"| '''cause''' | ||
| − | | Em caso | + | | Em caso de erro na requisição, uma ''string'' de causa do erro será preenchida. |
| ''string'' | | ''string'' | ||
|} | |} | ||
| Linha 194: | Linha 184: | ||
|} | |} | ||
<pre> | <pre> | ||
| − | + | A gravação! | |
| − | + | ||
| − | + | ||
| − | + | ||
</pre> | </pre> | ||
| Linha 206: | Linha 193: | ||
{ | { | ||
"status": "error", | "status": "error", | ||
| − | "cause": " | + | "cause": "Invalid callid" |
} | } | ||
</pre> | </pre> | ||
Edição de 12h23min 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 chamadas, 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 chamadas, o PABX uTech irá iniciar o download da gravação. Caso contrário, será retornado erro 404 e um json com a csausa.
|
|
/utech/v1/call/get_record/?token=1234&id=1694435179.3
A gravação!
{
"status": "error",
"cause": "Invalid callid"
}
|
/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
