PABX/APIuTech
De uTech Tecnologia
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.
- Trocar o endereço "pabx.exemplo.com" pelo domínio ou endereço IP do PABX uTech
Endpoints
Documentação:
- Acesse a documentação na API Dog: https://utechnet.apidog.io/
- Acesse a documentação no swagger: https://app.swaggerhub.com/apis-docs/uTechTecnologia/uTechPBX/1.0.3
Webhook
- Configuração dos webhooks para mensagem e eventos de mensagens recebidos do whatsapp.
- Para configurar, acesse o menu GESTÃO ⇒ Configuração. Depois acesse a aba Integrações.
- Depois, vá atá a aba da sua integração com whatsapp: Gupshup ou 360dialog e configure conforme abaixo:
| Parâmetros | |
|---|---|
| Url | Endereço da aplicação. Exemplo: https://meudominio.com.br/app. |
| Autenticação | Define o método de autenticação do seu servidor de aplicação.
|
| Usuário | Usuário para autenticação (Basic ou Digest) do seu servidor de aplicação. |
| Senha | Senha para autenticação (Basic ou Digest) do seu servidor de aplicação. |
| Cabeçalho | Campo utilizado para enviar cabeçalhos proprietários nos eventos enviados do PABX uTech para sua aplicação.
Exemplo: "X-uTech-AppID: 12345,X-uTech-ClientID: 67890 |
| Timeout | Timeout da requisição HTTP (em segundos). Tempo em que o PABX irá esperar resposta do servidor de aplicação antes de ocorrer timeout. Este tempo não deve ser elevado, pois as requisições são sincronas. |
| Eventos | Lista de eventos que que o PABX uTech irá enviar para sua aplicação.
|
Eventos
Evento de mensagem recebida - Mensagem
- Evento enviado quando uma mensagem do whatsapp for recebina do PABX uTech.
Content-Type: application/json { "event": "message", "message": { "id": 0, "source": "+554899999999", "destination": "999999", "account": "+554833334840", "text": "Olá mundo", "media": "", "url": "", "name": "Mario", "response_id": "", "forwarded": 0 } } |
|---|
Evento de envio - Enviado
- Evento informando que a mensagem de ID:4567890 foi enviada para a META/Whatsapp.
Content-Type: application/json { "event": "sent", "message": { "id": "4567890", "source": "5555", "destination": "+554884079082", "account": "+554833334852" } } |
|---|
Evento de entrega - Entregue
- Evento informando que a mensagem de ID:4567890 foi entregue ao destinatário.
Content-Type: application/json { "event": "delivered", "message": { "id": "4567890", "source": "5555", "destination": "+554899999999", "account": "+554833334840" } } |
|---|
Evento de leitura - Lida
- Evento informando que a mensagem de ID:4567890 foi lida.
Content-Type: application/json { "event": "read", "message": { "id": "4567890", "source": "5555", "destination": "+554899999999", "account": "+554833334840" } } |
|---|
Evento de falha no envio - Falha
- Evento informando que a mensagem de ID:4567890 não foi enviada..
Content-Type: application/json { "event": "failed", "message": { "id": "4567890", "source": " 5555", "destination": "+554899999999", "account": "+554833334840", "code": 470, "reason ": "Re-engagement message, (#470) Message failed to send because more than 24 hours have passed since the customer last replied to this.number." } } |
|---|
