Les API Keyyo sont disponibles pour toutes les sociétés souhaitant automatiser leurs relations avec Keyyo via un système d'interface.
Avec les API, vous pouvez utiliser nos services directement au cœur de votre système d'information.
Keyyo propose une API basée sur des requêtes HTTP de type GET afin de notifier une application cliente des appels entrants ou sortants.
Une autre interface est également disponible pour effectuer un appel sortant à partir d’une application tierce.
API de notification
Le paramétrage s’effectue depuis l’espace « Mon compte / Ma ligne » onglet « CTI Informatique » en cochant l’application « 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 mots clé qui seront remplacés lors de la notification par les informations propres à cette dernière :
Mot clé
Valeur de remplacement
_ACCOUNT_
Numéro de la ligne Keyyo au format international.
_CALLER_
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_
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_
Identifiant de l’appel
_N_TYPE_
Type de notification :
SETUP : Initiation de l’appel
CONNECT : Connexion de l’appel
RELEASE : Fin de l’appel
_N_VERSION_
Version de l’api de notification : 1
Exemple d’URL : http://www.exemple.tld/notification.php?account=_ACCOUNT_&caller=_CALLER_&callee=_CALLEE_&type=_N_TYPE_
API d’appel sortant (ou Click-To-Dial)
La demande s’effectue sur l’URL suivante : https://ssl.keyyo.com/makecall.html?ACCOUNT=<ligne keyyo>&CALLEE=<destination>&CALLEE_NAME=<nom appelé>
Où <ligne keyyo> doit être remplacé par le numéro de ligne au format international, <destination> correspond au numéro de destination de l’appel et <nom appelé> correspond au nom de la personne appelée.
API d’envoi de SMS
La demande s’effectue sur l’URL suivante : https://ssl.keyyo.com/sendsms.html?ACCOUNT=<ligne keyyo>&CALLEE=<destination>&MSG=<contenu du sms>
Où doit être remplacé par le numéro de ligne au format international, correspond au numéro de destination de l’appel et correspond au message à envoyer.
Pré requis : Il est nécessaire d'activer l'option d'envoi de SMS sur la ligne qui sera utilisée pour que l'API envoi de sms fonctionne.
L'activation de l'option SMS s'effectue depuis "MonCompte / Mes lignes" dans l'onglet "configuration / SMS".
L'envoi de SMS est limité à 1 SMS par seconde.
Autorisation des demandes d’appel sortant et d'envoi de sms
Deux options existent pour autoriser les demandes d’appel sortant et d'envoi de sms :
1) Vérification de l’IP source
L’IP du client doit être une de celles spécifiées dans le champ « Regexp d’autorisation sur l’ip source ». (Vérification de l’expression régulière) Si une seule IP doit être autorisée, il suffit d’entrer celle-ci.
2) Authentification de la ligne Keyyo
Dans le cas où le champ « Regexp d’autorisation sur l’IP source » n’est pas renseigné ou que l’IP source n’est pas vérifiée, il est possible de s’authentifier en utilisant une authentification HTTP DIGEST (par exemple en PHP avec une extension CURL).
Le nom d’utilisateur doit alors être égal au numéro de la ligne Keyyo au format international et le mot de passe doit être celui de la ligne (cf « Paramétrer mon terminal / Autre » dans « Mes services / Ma ligne »)
La ligne utilisée doit être la même que la valeur du paramètre ACCOUNT.
Témoignages
Espace développeur
