PABX/APIuTech
De uTech Tecnologia
(Diferença entre revisões)
(→/call/makecall) |
(→/call/get_rec) |
||
| Linha 127: | Linha 127: | ||
http://10.0.0.1/utech/v1/call/get_record/?token=1234&id=1694435179.3 | http://10.0.0.1/utech/v1/call/get_record/?token=1234&id=1694435179.3 | ||
</nowiki> | </nowiki> | ||
| + | |||
| + | |||
| + | == /call/get_record == | ||
| + | <BR> | ||
| + | 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. | ||
| + | |||
| + | {| style="width: 100%;" | ||
| + | |- | ||
| + | | style="width: 50%"| | ||
| + | |||
| + | |||
| + | {| style="width: 50%; background-color: #76b5c5;font-size:16px;padding: 12px;" | ||
| + | | '''GET''' /v1/call/'''get_record''' | ||
| + | |} | ||
| + | <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''' | ||
| + | | Numero origem da chamadas. Ramal, fila, etc. | ||
| + | | ''string'' | ||
| + | | Mandatório | ||
| + | |- | ||
| + | ! scope="row" style="width: 20%" align="right"| '''destination''' | ||
| + | | Número destino da chamada. | ||
| + | | ''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. | ||
| + | * '''ok''': Chamada será realizada. | ||
| + | * '''error''': Erro na requisição. | ||
| + | | ''string'' | ||
| + | |- | ||
| + | ! scope="row" style="width: 20%" align="right"| '''id''' | ||
| + | | Identificador da chamadas (''callid''). Essa identificação será utilizada para requisições de status e gravação da chamada. | ||
| + | | ''string'' | ||
| + | |- | ||
| + | ! scope="row" style="width: 20%" align="right"| '''cause''' | ||
| + | | Em caso se 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%;> | ||
| + | GET /utech/v1/call/makecall/?token=1234&sorce=2000&destination=04833334840 | ||
| + | </pre> | ||
| + | <BR> | ||
| + | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
| + | | '''200 OK:''' | ||
| + | |} | ||
| + | <pre> | ||
| + | { | ||
| + | "status": "ok", | ||
| + | "id": "1695129954.462751335" | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
| + | | '''Erro 4XX/5XX:''' | ||
| + | |} | ||
| + | <pre> | ||
| + | { | ||
| + | "status": "error", | ||
| + | "cause": "Authentication error" | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |} | ||
| + | <BR><BR> | ||
== /call/get_rec_uri == | == /call/get_rec_uri == | ||
Edição de 12h18min 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&sorce=2000&destination=04833334840
{
"status": "ok",
"id": "1695129954.462751335"
}
{
"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_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.
|
|
GET /utech/v1/call/makecall/?token=1234&sorce=2000&destination=04833334840
{
"status": "ok",
"id": "1695129954.462751335"
}
{
"status": "error",
"cause": "Authentication error"
}
|
/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
