|
|
Linha 531: |
Linha 531: |
| ! 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. |
| + | * '''ok''': Requisição correta. |
| * '''error''': Erro na requisição. | | * '''error''': Erro na requisição. |
| | ''string'' | | | ''string'' |
Edição de 11h54min de 22 de setembro de 2023
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.
token
|
Token definido na configuração do PABX uTech.
|
string
|
Mandatório
|
source
|
Numero origem da chamada. Ramal, fila, etc.
|
string
|
Mandatório
|
destination
|
Número destino da chamada.
|
string
|
Mandatório
|
status
|
Estado da geração da chamada.
- ok: Chamada será realizada.
- error: Erro na requisição.
|
string
|
id
|
Identificador da chamada (callid). Essa identificação será utilizada para requisições de status e gravação, etc.
|
string
|
cause
|
Em caso de erro na requisição, uma string de causa do erro será preenchida.
|
string
|
|
|
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.
token
|
Token definido na configuração do PABX uTech.
|
string
|
Mandatório
|
id
|
Identificador da chamada que deseja realizar o download da gravação.
|
string
|
Mandatório
|
status
|
Estado da geração da chamada.
- error: Erro na requisição.
|
string
|
cause
|
Em caso de erro na requisição, uma string de causa do erro será preenchida.
|
string
|
|
|
/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.
GET /v1/call/get_record_uri
|
token
|
Token definido na configuração do PABX uTech.
|
string
|
Mandatório
|
id
|
Identificador da chamada que deseja realizar o download da gravação.
|
string
|
Mandatório
|
status
|
Estado da geração da chamada.
- ok: Requisição correta.
- error: Erro na requisição.
|
string
|
url
|
Link para download da gravação.
|
uri
|
cause
|
Em caso de erro na requisição, uma string de causa do erro será preenchida.
|
string
|
|
|
/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.
token
|
Token definido na configuração do PABX uTech.
|
string
|
Mandatório
|
id
|
Identificador da chamada que deseja buscar o sumário.
|
string
|
Mandatório
|
status
|
Estado da geração da chamada.
- ok: Requisição correta.
- error: Erro na requisição.
|
string
|
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
|
cause
|
Em caso de erro na requisição, uma string de causa do erro será preenchida.
|
string
|
|
|
/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.
token
|
Token definido na configuração do PABX uTech.
|
string
|
Mandatório
|
id
|
Identificador da chamada que deseja realizar o download da gravação.
|
string
|
Mandatório
|
status
|
Estado da geração da chamada.
- ok: Requisição correta.
- error: Erro na requisição.
|
string
|
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
|
cause
|
Em caso de erro na requisição, uma string de causa do erro será preenchida.
|
string
|
|
|
/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/endcall
Endpoint utilizado para derrubar/desligar uma chamada ativa..
token
|
Token definido na configuração do PABX uTech.
|
string
|
Mandatório
|
id
|
Identificador da chamada que deseja realizar desligar.
|
string
|
Mandatório
|
status
|
Estado da geração da chamada.
- ok: Requisição correta.
- error: Erro na requisição.
|
string
|
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
|
cause
|
Em caso de erro na requisição, uma string de causa do erro será preenchida.
|
string
|
|
|
/utech/v1/call/summary/?token=1234&id=1694435179.3
{
"status": "ok",
"callstate": "finished",
"callid": "1695383395.42"
}
{
"status": "error",
"cause": "Invalid callid"
}
|