Espace développeurs

Les API Keyyo

Utilisez nos services grâce à nos API !

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.

Vous êtes éditeurs (ISV) de logiciels métiers ou d'applications CRM, SFA, ERP, PMS, QM, HRMS, POS, FAM, DMS,... et souhaitez intégrer des fonctions télécoms à vos solutions, rejoignez la communauté Keyyo, contactez-nous !

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é 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_

API d’appel sortant (ou Click-To-Call)

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.

Mot clé Obligatoire
Type
Taille max
Valeur par défaut
Description
ACCOUNT
Oui
Numeric
64
-
Numéro de la ligne Keyyo au format international
CALLEE
Oui
Numeric
64
-
Numéro de l’appelé au format international.
CALLEE_NAME
Non
Text
-
-
Nom affiché du numéro appelé

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ù <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
<contenu du sms> 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.

Mot clé Obligatoire
Type
Description
_ACCOUNT_ Oui
Numeric
Numéro de la ligne Keyyo (format international)
_CALLEE_ Oui
Numeric
Numéro du destinataire au format international.
MSG
Oui
Text
Contenu du SMS à envoyer

API de modification du profil actif de renvois et numéro de secours

La demande s’effectue sur l’URL suivante :

https://ssl.keyyo.com/setprofil.html?ACCOUNT=<ligne keyyo>&PROFIL=<nom du profil>

Où <ligne keyyo> doit être remplacé par le numéro de ligne au format international et <nom du profil> correspond au nom du profil à activer tel qu'il apparait ou "default" (sans les guillemets) pour revenir au profil par défaut.

La méthode dûment complétée active le profil demandé et renvoie le nom du profil. Si le paramètre PROFIL est laissé vide, seul le nom du profil est renvoyé (sans modification du profil en place).

Mot clef
Obligatoire
Type
Description
ACCOUNT
Oui
Numeric
Numéro de la ligne Keyyo (format international)
PROFIL
Oui
Text
Nom du profil souhaité

API de mise en relation

La demande s’effectue sur l’URL suivante :

https://ssl.keyyo.com/makecall.html?ACCOUNT=<lignekeyyo>&CALLEE=<destinataire>&CALLEE_NAME=<nom_appelé>&CALLER=<numéro mis en relation>

Où <ligne keyyo> doit être remplacé par le numéro de ligne Keyyo émettrice de la mise en relation au format international, <destinataire> correspond au numéro à appeler et <nom appelé> correspond au nom de la personne appelée. <numéro mis en relation> correspond au numéro que l’on désire mettre en relation avec <destinataire>.

ACCOUNT appelle CALLER en présentant le nom de CALLEE_NAME.
Lorsque CALLER décroche, il est transféré vers CALLEE. L’appel sonne chez CALLEE comme provenant de CALLER (numéro présenté chez CALLEE).
Lorsque CALLEE décroche il est mis en relation directement avec CALLER sans qu’aucun des deux correspondants n’ait été mis en relation avec la ligne ACCOUNT.

A noter :
- C'est la ligne saisie dans la variable ACCOUNT qui sera facturée.
- Les règles d'appels sortants simultanés relatives à la ligne s'appliquent."

Mot clef
Obligatoire
Type
Taille max
Valeur par défaut
Description
ACCOUNT
Oui
Numeric
64
-
Numéro de la ligne Keyyo au format international
CALLER
Non
Numeric
64
ACCOUNT
Numéro de l’appelant au format international
CALLEE
Oui
Numeric
64
-
Numéro de l’appelé au format international.
CALLEE_NAME
Non
Text
-
-
Nom affiché du numéro appelé

Autorisation des demandes d’appel sortant, d'envoi de sms et de modification du profil actif

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.
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éléchargez le guide de mise en service CTI et API Keyyo.

KEYYO TAPI

TAPI permet de contrôler les fonctions de téléphonie depuis vos PC sous Windows.

L'installation s'effectue via le Keyyo Store.

Plus d'informations.
Voir la procédure d'installation.