PABX/APIuTech
De uTech Tecnologia
(Diferença entre revisões)
(→/call/makecall) |
(→/call/makecall) |
||
| Linha 35: | Linha 35: | ||
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. | 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. | ||
| − | {| style="width: | + | {| class="wikitable" style="width: 85%;" |
| + | |- | ||
| + | | style="width: 50%"| | ||
| + | |||
| + | |||
| + | {| style="width: 50%; background-color: #76b5c5;font-size:16px;padding: 12px;" | ||
| '''GET''' /v1/call/'''makecall''' | | '''GET''' /v1/call/'''makecall''' | ||
|} | |} | ||
| − | < | + | <pre> |
| − | {| style="width: | + | GET /utech/v1/call/makecall/?token=1234&sorce=2000&destination=04833334840 |
| + | </pre> | ||
| + | {| style="width: 80%; font-size:18px;padding: 12px;" | ||
| '''Parâmetros:''' | | '''Parâmetros:''' | ||
|} | |} | ||
| − | {| class="wikitable" width=" | + | {| class="wikitable" width="80%" |
|- | |- | ||
| − | ! scope="row" style="width: 20%;" align="right"| '''token''' | + | ! scope="row" style="width: 20%;vertical-align:top;" align="right"| '''token''' |
| Token definido na configuração do PABX uTech. | | Token definido na configuração do PABX uTech. | ||
| ''string'' | | ''string'' | ||
| Linha 60: | Linha 67: | ||
|} | |} | ||
<BR> | <BR> | ||
| − | {| style="width: | + | {| style="width: 80%; font-size:18px;padding: 12px;" |
| '''Resposta:''' | | '''Resposta:''' | ||
|} | |} | ||
| − | {| class="wikitable" width=" | + | {| class="wikitable" width="80%" |
|- | |- | ||
! scope="row" style="width: 20%;" align="right"| '''status''' | ! scope="row" style="width: 20%;" align="right"| '''status''' | ||
| Linha 78: | Linha 85: | ||
| Em caso se erro na requisição, uma ''string'' de causa do erro será preenchida.. | | Em caso se erro na requisição, uma ''string'' de causa do erro será preenchida.. | ||
| ''string'' | | ''string'' | ||
| + | |} | ||
| + | |||
| + | <!-- Tabela Lateral --> | ||
| + | <!-- Tabela Lateral --> | ||
| + | <!-- Tabela Lateral --> | ||
| + | <!-- Tabela Lateral --> | ||
| + | |||
| + | | style="width: 50%;margin-left: auto; margin-right: 0px;""| | ||
| + | |||
| + | |||
| + | <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> | ||
| + | |||
|} | |} | ||
Edição de 12h10min 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_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
