WebHook, serve receber os avisos da plataforma num endereço(Url) indicado pelo utilizador com as notificações dos estados e informações.
Notificação dos estados
É enviado um pedido HTTP para o url indicado quando acontece alteração dos estados da mensagem ou avisos.
As mensagens são enviadas por http num pedido POST e formato JSON
Tipos de Notificação:
- Mensagem - Mensagens enviadas
- Chamada - Chamadas Recebidas
- Resposta - Mensagens Recebidas
Notificação Mensagem
Notifica os estados da mensagem enviada. Os parametros para este tipo de mensagem são:
type
sms - indica que é uma mensagem enviada.
id
Identifica o Id da mensagem criada.
status
estado da mensagem (ver abaixo os estados possíveis)
phone
número de telefone de destino
sizemessages
indica o número de mensagens necessárias para enviar o texto
Os estados que se podem receber são os seguintes:
- delivrd: Confirmado que o telemóvel de destino recebeu a mensagem.
- undeliv: Entre ao operador com sucesso.
- failed: Erro no envio da mensagem e não foi possível entregar.
Resposta
Se o pedido for processado correctamente depois a resposta é um código HTTP 200.
Exemplo
POST http://urlindicada/ HTTP/1.1
Host: urlindicada
Content-Length: 304
[{"type":"sms","id":"123434", "status":"delivrd", "phone":"+351960000000", "sizemessages":"1"}]
Resposta: Código HTTP 200
Notificação Chamada
Notifica que foi recebida uma chamada. Os parametros para este tipo de mensagem são:
type
call- indica que é uma chamada.
status
ok- chamada foi bem recebida
phone
número de telefone que fez a chamada
Exemplo
POST http://urlindicada/ HTTP/1.1
Host: urlindicada
Content-Length: 304
[{"type":"call","status":"ok", "phone":"+351920000000"}]
Resposta: Código HTTP 200
Notificação Mensagem Recebida
Notifica que foi recebida uma mensagem. Os parametros para este tipo de mensagem são:
type
response - indica que é uma mensagem recebida
id
Identifica o Id da mensagem recebida.
status
delivrd - mensagem foi bem recebida e confirmado
phone
número de telefone que enviou a mensagem
message
texto da mensagem recebida
Exemplo
POST http://urlindicada/ HTTP/1.1
Host: urlindicada
Content-Length: 304
[{"type":"response","id":"123434", "status":"delivrd", "phone":"+351910000000", "message":"Obrigada pelo contacto"}]
Resposta: Código HTTP 200