Gestion des appels

Etats des appels

Etat Signification
dialing Numérotation en cours (appels sortants ou locaux)
ringing Appel signalé ; le poste sonne (appels sortants ou entrants)
answered Appel décroché – les deux interlocuteurs sont en lignes
onhold Appel en attente
voicemail Appel sur messagerie (dépôt en cours)
hangup Appel terminé

Requête « call/dial » - initier un appel

Cette requête permet d'initier un appel entre un des téléphones enregistrés pour l'utilisateur teambox (poste d'entreprise, mobile, domicile, etc) et un numéro quelconque.

Paramètre Signification
calledNumber Numéro appelé, quelconque (numéro de poste, numéro externe, service téléphonique)
callerNumber Optionnel ; numéro du poste appelant ; ce doit être un des numéros enregistrés du user pour lequel on va effectuer l'appel automatique. Par défaut, c'est son numéro de poste.
calledName Optionnel ; associe le numéro appelé à un nom (ce nom est enregistré dans le contexte d'appel et le journal)
contactId Optionnel ; identifiant de la fiche contact associée à cet appel (enregistré dans le contexte d'appel et le journal)
autoAnswer Optionnel ; une valeur « yes » (ou 1) indique que le téléphone est autorisé à décrocher l'appel automatiquement du coté appelant (ne fonctionne que sur certains postes comme les équipements de marque SNOM)
callerIdNumber Optionnel ; indique le numéro d'appelant qui sera présenté à l'appelé. Par défaut, ce choix est effectué dans la configuration système. Une valeur « hide » permet d'appeler en masqué. Attention: le numéro appelant ne peut être qu'un des numéros autorisé pour cet utilisateur.

En retour, la requête retourne les données suivantes:

Champ Signification
callid Identifiant de l'appel (unique sur le système et dans le temps)

Requête « call/pickup » - prendre un appel

Cette requête permet de prendre un appel en état ringing ou onhold. Comme pour le « clicToCall » (action call/dial), le paramètre « callerNumber » indique le poste devant répondre à l'appel. Un appel est généré vers ce numéro, et lorsque l'appel est répondu, il est connecté à l'appel devant être intercepté.

Parametre Signification
callid Identifiant de l'appel entrant à intercepter
phoneNumber Optionnel: numéro du poste sur lequel on veut prendre l'appel ; ce doit être un des numéros autorisé pour l'utilisateur. Par défaut, son numéro de poste est utilisé.

En retour, la requête ne retourne aucune autre donnée qu'un diagnostique ok/erreur.

Requête « call/hold » - mettre un appel en attente

Cette requête permet de mettre en attente un appel qui est dans l'état « ringing » ou « established ». Dans le cas d'un appel établi, l'appel doit appartenir à l'utilisateur initiant la requête.

Parametre Signification
callid Identifiant de l'appel à mettre en attente
privacy Optionnel : Indique comment l'appel peut être récupéré :
  • private : (par défaut), seul l'utilisateur ayant mis l'appel en attente peut le récupérer ultérieurement

  • public : l'appel peut être récupéré par n'importe quel utilisateur du système (similaire au mode « parking »)

En retour, la requête ne retourne aucune autre donnée qu'un diagnostique ok/erreur.

Requête « call/hangup » - raccroche un appel

Cette requête permet de raccrocher un appel qui est dans l'état « ringing » ou « established ». Dans le cas d'un appel établi, l'appel doit appartenir à l'utilisateur initiant la requête.

Parametre Signification
callid Identifiant de l'appel devant être raccroché

En retour, la requête ne retourne aucune autre donnée qu'un diagnostique ok/erreur.

Requête « call/transfer » - transférer un appel

Cette requête permet d'initier un transfert d'appel accompagné ou aveugle vers un numéro externe ou un poste.

Parametre Signification
callid Identifiant de l'appel entrant à enregistrer
calledNumber Numéro du destinataire du transfert (poste ou numéro externe)
blind Optionnel : une valeur 1 (ou « yes ») sélectionne le mode aveugle (on attend pas la réponse de l'appelé) ; par défaut, le transfert est accompagné.

Requête « call/start_recording » - démarre l'enregistrement

Cette requête permet de démarrer l'enregistrement d'un appel en cours. Le fichier audio de l'enregistrement sera disponible en fin d'appel via le journal d'appel.

Parametre Signification
callid Identifiant de l'appel entrant à enregistrer

Requête « call/stop_recording » - arrête l'enregistrement

Cette requête permet de stopper l'enregistrement d'un appel en cours. Le fichier audio de l'enregistrement jusqu'à ce point sera disponible en fin d'appel via le journal d'appel.

Parametre Signification
callid Identifiant de l'appel entrant à enregistrer

Requête « call/list » – récupérer la liste des appels en cours

Cette requête permet de récupérer la liste des appels en cours. Chaque appel fait l'objet d'une structure contenant les informations de contexte.

Parametre Signification
n/a Cette méthode ne prend pas de paramètre

En retour, la requête retourne les données suivantes

Champ Signification
calls Tableau contenant l'ensemble des appels