Recevez en temps réel les évènements d'appels de vos utilisateurs sur un service tiers, grâce à un webhook.
Prérequis : un point de réception capable de recevoir des requêtes JSON.
Étapes
- Dans le Selfcare, ouvrez la page Entreprise, bloc Webhooks.
- Renseignez l'URL de votre point de réception dans le champ Webhook call log event.
- Testez la réception, par exemple avec le site webhook.site.
Vous recevrez ensuite un évènement JSON à chaque étape d'un appel, de cette forme :
{
"type": "call_event",
"data": {
"answer_at": null,
"call_at": "2022-04-21T10:04:27.000Z",
"called_number": "4680",
"called_object_id": 6,
"called_object_type": "user",
"called_user_id": 6,
"caller_number": "+33183900900",
"caller_user_id": null,
"cti_context": [],
"id": 2548,
"original_called_number": "+33183909988",
"original_called_object_id": 6,
"original_called_object_type": "user",
"originate_action_id": null,
"state": "ringing",
"user_id": 6,
"xfer_call_id": null
}
}Principaux champs
| Champ | Description |
|---|---|
| state | État de l'appel : ringing, answered, hold ou completed. |
| id | Identifiant de l'appel. |
| caller_user_id | Identifiant de l'appelant, si c'est un utilisateur Ubefone. |
| called_user_id | Identifiant de l'appelé, si c'est un utilisateur Ubefone. |
| user_id | Identifiant de l'utilisateur concerné par cet évènement. |
Bon à savoir
- Les numéros peuvent être au format interne ou au format international E164.
- Pour un appel interne, vous recevrez un évènement distinct pour chaque utilisateur impliqué (un user_id différent à chaque fois).
- Vous pouvez recevoir plusieurs fois le même évènement pour un même appel : par exemple un évènement ringing par téléphone, si l'utilisateur en a plusieurs.