API de notification d'appels
Intégrez notre API pour être notifié de tous les événements d'une ligne directement dans votre applicatif métier.
Le paramétrage s’effectue depuis le Manager : onglet "Configurer" de la ligne, puis "Paramètres avancés", "CTI" et "API serveur".
Téléchargez le guide de mise en service CTI et API Keyyo
Pour être notifié des événements sur une ligne, il est nécessaire de fournir l’URL où doivent être envoyées les notifications.
Cette URL peut contenir des mot-clés qui seront remplacés lors de la notification par les informations propres à cette dernière :
Mot-clé | Type | Taille max | Description |
---|---|---|---|
_ACCOUNT_ | Numeric/Text | 64 | Numéro de la ligne Keyyo au format international. |
_CALLER_ | Numeric/Text | 64 | Numéro de l’appelant au format international. Si la valeur est égal au numéro de ligne Keyyo, il s’agit d’un appel sortant. |
_CALLEE_ | Numeric/Text | 64 | Numéro de l’appelé au format international. Si la valeur est égale au numéro de ligne Keyyo, il s’agit d’un appel entrant. |
_CALLREF_ | Text | 64 | Identifiant de l’appel. |
_N_TYPE_ | Text | 16 | Type de notification : SETUP : initiation de l’appel. CONNECT : connexion de l’appel. RELEASE : fin de l’appel. |
_N_VERSION_ | Integer | - | Version de l’API de notification : 1. |
_DREF_ | Text | 32 | Identifiant du dialogue, présent sur tous les appels et différent du CALLREF. |
_DREF_REPLACE_ | Text | 32 | Identifiant du dialogue remplacé. Présent dans le cas d'une interception ou d'un transfert accompagné et se réfère au _DREF_ de l'appel intercepté ou transféré. |
_SESSION_ID_ | Text | 40 | Identifiant de session commun à l'ensemble des appels générés par un appel entrant sur un numéro d’accueil. |
_IS_ACD_ | Boolean | - |
Egal à 1 si l'appel provient d’un numéro d’accueil. |
_REDIRECTING_NUMBER_ | Text | 64 | Lors d'un appel renvoyé, numéro de la ligne qui effectue le renvoi. |
Exemple d’URL :
http://www.exemple.tld/notification.php
account=_ACCOUNT_&caller=_CALLER_&callee=_CALLEE_&type=_N_TYPE_