IP Office 4.0 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007)
2006 Avaya Inc. Tous droits réservés. Note Bien que tous les efforts nécessaires aient été mis en œuvre en vue de s assurer que les informations contenues dans ce document sont complètes et exactes au moment de l impression, Avaya Inc. ne peut assumer aucune responsabilité concernant toute erreur éventuelle. Les informations contenues dans ce document sont susceptibles d être amendées et modifiées lors de versions ultérieures. Avis de non responsabilité concernant la documentation Avaya Inc. ne peut être tenu responsable de toute modification, ajout ou suppression effectués dans la version publiée d origine de cette documentation, sauf si ces modifications, ajouts ou suppressions sont effectués par Avaya. Avis de non responsabilité concernant les liens Avaya Inc. n est pas responsable du contenu ou de la fiabilité des sites Web pour lesquels un lien apparaît dans la présente documentation et Avaya ne cautionne pas nécessairement les produits, les services ou les informations qui y sont décrits ou proposés. Nous ne pouvons garantir le fonctionnement permanent des liens et n'avons aucun contrôle sur la disponibilité des pages liées. Licence L UTILISATION OU L INSTALLATION DE CE PRODUIT INDIQUE QUE L UTILISATEUR FINAL ACCEPTE LES CONDITIONS DÉFINIES ICI ET LES CONDITIONS GÉNÉRALES DE LICENCE DISPONIBLES SUR LE SITE AVAYA http://support.avaya.com/licenseinfo/ («GENERAL LICENSE TERMS - CONDITIONS GÉNÉRALES DE LICENCE»). SI VOUS NE SOUHAITEZ PAS ÊTRE LIÉ PAR CES CONDITIONS, VOUS DEVEZ RETOURNER LE(S) PRODUIT(S) AU POINT DE VENTE DANS LES DIX (10) JOURS À COMPTER DE LA DATE DE LIVRAISON POUR OBTENIR UN REMBOURSEMENT OU UN AVOIR. Avaya accorde à l'utilisateur final une licence dans le cadre des types de licence décrits ci-dessous. Le nombre de licences et unités de capacité applicable pour lequel la licence est accordée est de un (1), à moins qu'un autre nombre de licences ou unités de capacité soit spécifié dans la documentation ou les autres documents à la disposition de l'utilisateur final. «Processeur désigné» désigne un dispositif informatique indépendant. «Serveur» désigne un processeur désigné qui héberge une application logicielle à laquelle de multiples utilisateurs peuvent accéder. Le terme «Logiciel» désigne des programmes informatiques en code exécutable, initialement mis sous licence par Avaya et utilisés par l Utilisateur final, qu il s agisse de produits autonomes ou pré installés sur le Matériel. Le terme «Matériel» désigne les produits matériels standard, initialement vendus par Avaya et utilisés par l Utilisateur final. Type(s) de licence : Licence de Système(s) désigné(s) (DS). L'utilisateur final peut installer et utiliser chaque copie du logiciel sur un seul processeur désigné, à moins qu'un autre nombre de processeurs désignés soit indiqué dans la documentation ou les autres documents à la disposition de l'utilisateur final. Avaya peut exiger que le processeur désigné (ou les processeurs désignés) soit identifié par type, numéro de série, touche de fonction, emplacement ou autre élément spécifique, ou qu'il soit fourni par l'utilisateur final à Avaya par un moyen électronique établi par Avaya dans ce but. Droit d auteur Sauf indication expresse contraire, le Produit est protégé par des droits d auteur et autres législations respectant les droits de propriété. La reproduction, l'utilisation ou le transfert non autorisé peut constituer un délit dans le cadre de la loi applicable. Composants tiers Certains programmes logiciels ou parties de ces programmes inclus dans le Produit peuvent contenir un logiciel distribué dans le cadre d accord avec des tiers («Third Party Components - Composants tiers»), qui peuvent contenir des conditions qui étendent ou limitent les droits d utilisation de certaines parties du Produit («Third Party Terms - Conditions relatives aux tiers»). Les informations identifiant les composants tiers et les conditions relatives aux tiers qui s y appliquent sont disponibles sur le site d Avaya à l adresse suivante : http://support.avaya.com/thirdpartylicense/ Intervention d Avaya en cas de fraude Si vous pensez être victime d une fraude téléphonique et avez besoin d assistance technique ou de support, appelez la ligne d intervention en cas de fraude téléphonique au centre de support technique au +1-800-643-2353 pour les États-Unis et le Canada. Tout point faible soupçonné en matière de sécurité des produits d'avaya doit être signalé à Avaya par courrier électronique à l adresse suivante : securityalerts@avaya.com. Pour obtenir d autres numéros de téléphone d assistance, consultez le site d assistance d Avaya (http://www.avaya.com/support).
Table des matières TAPI Link IP Office... 1 Présentation... 1 Pilote IP Office TAPI... 1 Avis de non-responsabilité... 1 Références... 2 Structure de ce document... 2 Installer les pilotes TAPILink et Wave... 3 Installer la licence CTI TAPI Linkpro et les licences Wave... 3 Configurer le pilote TAPI... 3 Configurer IP Office pour TAPI... 5 Présentation... 5 TAPI 2... 5 TAPI 3... 5 Référence TAPI 2.x... 7 Fonctions TAPI... 7 Fonctions TAPI... 7 lineaddtoconference... 8 lineanswer... 8 lineblindtransfer... 8 linecompletetransfer... 9 lineconfigdialog... 9 lineclose... 9 linedeallocatecall... 9 linedevspecific... 10 linedial... 13 linedrop... 13 linegeneratedigits... 14 linegeneratetone...14 linegetaddresscaps... 14 linegetaddressid... 15 linegetaddressstatus... 15 linegetapppriority...15 linegetcallinfo... 16 linegetcallstatus... 16 linegetdevcaps... 16 linegetid... 16 linegetlinedevstatus... 17 linehandoff... 19 linehold... 19 lineinitializeex... 20 linemakecall... 20 linemonitordigits... 20 linemonitortone... 21 linenegotiateapiversion... 21 lineopen... 22 linepark... 22 lineredirect... 23 lineremovefromconference... 23 linesetapppriority...23 linesetappspecific... 23 linesetcallprivilege... 24 linesetstatusmessages... 24 linesetuptransfer... 24 lineshutdown... 24 lineswaphold... 25 Manuel du développeur TAPI Link Page iii IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link lineunhold... 25 lineunpark... 25 Structures TAPI... 26 LINEADDRESSCAPS... 26 LINEADDRESSSTATUS... 32 LINECALLINFO... 33 LINECALLPARAMS... 34 LINECALLSTATUS... 35 LINEDEVCAPS... 36 Evénements TAPI (Messages)... 38 LINE_APPNEWCALL... 38 LINE_CALLINFO... 38 LINE_CALLSTATE... 38 LINE_LINEDEVSTATE... 38 LINE_DEVSPECIFIC... 38 LINE_ADDRESSSTATE... 38 Référence TAPI 3.0... 39 TAPI... 39 TAPI... 39 ITTAPI... 39 Address... 40 Adresse... 40 ITAddress... 40 IEnumAddress... 41 ITMediaSupport... 41 Terminal... 41 Call... 42 Appeler... 42 ITCallInfo... 42 ITBasicCallControl... 43 ITCallStateEvent... 45 ITCallNotificationEvent... 46 ITCallInfoChangeEvent... 46 Concentrateur d appel... 46 Types énumérés TAPI 3... 47 CALL_STATE... 47 CALLINFO_STRING...48 DISCONNECT_CODE... 48 CALL_STATE_EVENT_CAUSE... 49 Fournisseur de service média IP Office... 51 A propos du MSP... 51 Utiliser le MSP... 51 Utiliser les interfaces spécifiques aux périphériques... 51 ITACDAgent... 52 ITGroup... 52 ITDivert... 53 ITPlay... 54 IPOfficePrivateEvents... 54 Utiliser les capacités média continues du MSP... 55 Index... 57 Page iv Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
TAPI Link IP Office Présentation Le logiciel IP Office CTI Link est disponible dans les versions Lite et Pro, qui constituent des interfaces d exécution permettant l utilisation des applications. Le Kit de développement du logiciel (SDK) contient de la documentation relative aux interfaces Lite et Pro destinées aux développeurs de logiciel. Les versions Lite et Pro contiennent le même programme. La fonction supplémentaire offerte par la version IP Office CTI Link Pro s active après l installation de la clé de licence de CTI Link Pro. Pour plus d informations, consultez le manuel d installation de CTI Link IP Office. Ce document fournit des informations pour aider les développeurs à mettre en œuvre une application qui utilise le fournisseur de service TAPI IP Office. Il est supposé dans cette documentation que le développeur connaît déjà TAPI. Il est également recommandé que le lecteur de ce document ait accès à la bibliothèque MSDN qui fournit une documentation complète sur TAPI. Pilote IP Office TAPI L architecture de Windows permet aux développeurs de mettre en œuvre des applications en utilisant les interfaces de programmation d applications (API) standard, quel que soit le matériel de téléphonie utilisé. Les fabricants du matériel de téléphonie fournissent les pilotes de téléphonie, appelés fournisseurs de service de téléphonie (TSP), qui sont installés sur Windows. Ces TSP fournissent le lien entre TAPI et le matériel de téléphonie. Le pilote TAPI pour IP Office prend en charge toutes les versions TAPI de 2.0 à 3.0. Avis de non-responsabilité Veuillez noter que, en dépit des efforts d Avaya pour que le pilote TAPI IP Office soit compatible avec toutes les versions précédentes du pilote TAPI IP Office, en termes d ensemble de fonctionnalités offertes, Avaya ne peut garantir que le comportement d IP Office reste inchangé. En raison des améliorations d IP Office, la séquence, l heure et le contenu précis des événements TAPI sont susceptibles de changer. Il est recommandé aux développeurs d utiliser un modèle de programmation régi par les événements pour que les applications ne soient pas affectées par ces changements. Manuel du développeur TAPI Link Page 1 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link Références Il est recommandé de lire les documents suivants : MSDN / Plateforme SDK Programmation de téléphonie Windows (TAPI 1.x et 2.x) Manuel d installation CTI Link Structure de ce document Le reste de ce document est constitué des sections suivantes : Référence TAPI 2 Référence par ordre alphabétique des fonctions TAPI Référence par ordre alphabétique des structures TAPI Référence par ordre alphabétique des événements TAPI Référence TAPI 3 Types d énumération TAPI 3 MSP (fournisseur de service média) Perte et récupération de la communication Page 2 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
Installer les pilotes TAPILink et Wave TAPI Link IP Office Le fournisseur de service TAPI de IP Office et le pilote Wave sont installés à partir du CD-ROM de l utilisateur IP Office. Pour plus d informations, consultez le manuel d installation de CTI Link. Installer la licence CTI TAPI Linkpro et les licences Wave Vous n avez pas besoin de licence pour utiliser le pilote TAPI, mais la licence fournit les fonctions complémentaires suivantes : Mode utilisateur tiers. Surveillance des files d attente ACD Fonction linedevspecific activée Pour utiliser la fonctionnalité Wave, vous devez installer une licence utilisateur Wave pour chaque utilisateur Wave, en plus de la licence CTI Link Pro. Configurer le pilote TAPI Le fournisseur de services IP Office TAPI peut fonctionner en mode mono-utilisateur ou utilisateur tiers. Pour activer le mode utilisateur tiers, vous devez acheter une licence. Notez que les versions sans licence (Lite) ne vous empêchent pas de sélectionner cette option, mais elle ne sera pas activée. Le mode mono-utilisateur signifie que l application TAPI est susceptible de contrôler et/ou surveiller un seul dispositif téléphonique. Le mode utilisateur tiers signifie que l application TAPI est susceptible de contrôler et/ou surveiller les dispositifs téléphoniques d une unité IP Office particulière. Mode mono-utilisateur Saisissez l adresse IP de l unité IP Office dans la case intitulée Adresse IP du commutateur. Sélectionnez l option Mono-utilisateur. Saisissez le nom d utilisateur et le mot de passe du poste à surveiller et/ou contrôler à l aide de TAPI. Normalement, le nom d utilisateur correspond au nom de la personne associée à un poste téléphonique physique. Manuel du développeur TAPI Link Page 3 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link Mode Utilisateur tiers Saisissez l adresse IP de l unité IP Office dans la case intitulée Adresse IP du commutateur. Sélectionnez l option Utilisateur tiers. Saisissez le mot de passe du commutateur. Il s agit du mot de passe saisi dans Manager lors du chargement de la configuration du commutateur. Le mode utilisateur tiers fournit, par défaut, une ligne TAPI pour chaque poste physique relié à IP Office. Les cases à cocher associées au mode utilisateur tiers activent des entités supplémentaires à surveiller et/ou contrôler par TAPI. Files d attente ACD IP Office peut être configuré de manière à placer en file d attente les appels entrants présentés à un groupe d utilisateurs internes. Par exemple, si un groupe d agents du centre d appels a été configuré sur votre IP Office et que vous souhaitez placer tout appel entrant en attente jusqu à ce qu un agent soit disponible pour prendre cet appel. Si vous cochez la case Files d attente ACD, des lignes sont mises à disposition pour surveiller et/ou contrôler un appel par rapport à un groupe. Utilisateurs WAV Si un utilisateur possède un nom d utilisateur commençant par TAPI:, il s agit d un utilisateur WAV. Le commutateur IP Office tente de fournir un flux audio continu aux utilisateurs WAV lorsqu ils sont en ligne. Ce flux audio continu requiert que le pilote wave IP Office soit installé sur l ordinateur et que chaque utilisateur possède une instance de licence de pilote wave. Si le pilote wave n est pas installé, vous pourrez tout de même cocher la case Utilisateurs WAV et recevoir des événements utilisateur WAV sans la licence. Au cours de l utilisation, le flux audio continu TAPI WAV utilise un canal de données IP Office provenant du même groupe de canaux de données que celui utilisé pour les ports de messagerie vocale. Le nombre maximum de canaux de données disponibles simultanément pour la messagerie vocale et les appels TAPI WAV dépend du type d unité de contrôle IP Office ; IP401 = 2, IP403 et Small Office Edition = 10, IP406 = 20, IP412 = 30. Page 4 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
Configurer IP Office pour TAPI TAPI Link IP Office Cette section décrit la configuration de IP Office à l aide de l application Manager. Si votre application surveille des téléphones sans les contrôler, aucune configuration n?est requise. Il existe deux manières d utiliser TAPI avec IP Office : Si votre application contrôle des téléphones, il est recommandé de configurer tous les utilisateurs contrôlés en tant que station décrochée. Ainsi, le téléphone de l utilisateur passe à l état de veille lorsqu un appel est raccroché à l aide de TAPI. Si cette option n est pas définie, le téléphone reste déconnecté jusqu à ce que le téléphone soit raccroché manuellement. La case Station décrochée se situe dans l onglet Téléphonie des paramètres de l utilisateur dans Manager. Si vous avez besoin d un utilisateur spécial qui traite le flux continu de média (tel qu un standard automatique), créez un nouvel utilisateur avec un nom qui commence par TAPI:. Il s agira d un utilisateur WAV. Le numéro de l utilisateur ne doit pas être en conflit avec tout groupe ou numéro de téléphone existant. Présentation Il est recommandé de fermer les applications TAPI avant de reconfigurer le commutateur. Cela permet au fournisseur de service de téléphonie (TSP) de fermer toutes les lignes ouvertes et d assurer que le commutateur et tous les TSP connectés conservent un état consistant. En cas de perte de communication imprévue (le commutateur est accidentellement mis hors tension ou un câble réseau est accidentellement débranché), le TSP détecte qu il n est plus connecté au commutateur. Pendant ce temps, tous les appels vers les fonctions TAPI qui requièrent une communication entre le TSP et le commutateur sont rejetés. Le délai entre la perte de communication et la détection de cette perte par le TSP dépend des paramètres TCP de l ordinateur hôte et de l horloge interne du TSP. Le délai peut aller jusqu à 2 minutes. Une fois que le TSP a détecté la perte de communication avec le commutateur, il tente de rétablir une connexion. Lorsque la connexion est rétablie, le fournisseur de service peut généralement récupérer les lignes/adresses ouvertes, même lorsque la perte de communication a été causée par le redémarrage du commutateur. La façon dont la perte de communication apparaît dans l application TAPI dépend de la version de TAPI utilisée. Voir ci-dessous. TAPI 2 Lorsque le TSP perd sa connexion avec IP Office, un message LINEDEVSTATE_OUTOFSERVICE est envoyé sur toutes les lignes ouvertes. Lorsque la communication est rétablie, un message LINEDEVSTATE_INSERVICE est envoyé à chaque ligne TAPI récupérée. TAPI 3 Lorsque le TSP perd sa connexion avec IP Office, un ITAddressEvent est généré pour chaque adresse qui est inscrite pour de tels événements. Ces événements indiquent que l état de l adresse a changé. L état devient AS_OUTOFSERVICE. Lorsque le TSP rétablit sa connexion avec IP Office, aucun événement n est généré. Cependant, une fois la communication rétablie, toutes les adresses TAPI 3 ouvertes sont récupérées. Manuel du développeur TAPI Link Page 5 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Référence TAPI 2.x Fonctions TAPI Fonctions TAPI Cette section décrit chaque fonction TAPI2.x prise en charge par le pilote TAPI IP Office. Elle décrit les comportements ou limitations spécifiques de ces fonctions lorsqu elles sont utilisées avec IP Office. lineaddtoconference lineanswer lineblindtransfer linecompletetransfer lineconfigdialog lineclose linedeallocatecall linedevspecific linedial linedrop linegeneratedigits linegeneratetone linegetaddresscaps linegetaddressid linegetaddressstatus linegetapppriority linegetcallinfo linegetcallstatus linegetdevcaps linegetid linegetlinedevstatus linehandoff linehold lineinitializeex linemakecall linemonitordigits linemonitortone linenegotiateapiversion lineopen linepark lineredirect lineremovefromconference linesetapppriority linesetappspecific linesetcallprivilege linesetstatusmessages linesetuptransfer lineshutdown lineswaphold lineunhold lineunpark Manuel du développeur TAPI Link Page 7 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link lineaddtoconference Ajoute l appel à la conférence. lineaddtoconference( HCALL hconfcall, HCALL hconsultcall lineanswer Répond à un appel qui est présenté à l application. lineanswer( HCALL hcall, LPCSTR lpsuseruserinfo, DWORD dwsize Remarque UserUserInfo n est pas pris en charge et est ignoré. lineblindtransfer Cette fonction peut être utilisée pour transférer un appel en cours à un tiers. Le code du pays est ignoré. lineblindtransfer( HCALL hcall, LPCSTR lpszdestaddress, DWORD dwcountrycode Page 8 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
linecompletetransfer Référence TAPI 2.x Cette fonction peut être utilisée pour terminer un transfert ou la configuration d un appel de conférence. Cette fonction est supposée renvoyer une ID d appel à la conférence, mais elle renvoie toujours zéro. linecompletetransfer( HCALL hcall, HCALL hconsultcall, LPHCALL lphconfcall, DWORD dwtransfermode lineconfigdialog Affiche la même boîte de dialogue Configuration du fournisseur de service TAPI que celle qui apparaît dans le Panneau de configuration / options Téléphone et Modem (ou Téléphonie). Le paramètre lpszdeviceclass est ignoré. lineconfigdialog( DWORD dwdeviceid, HWND hwndowner, LPCSTR lpszdeviceclass lineclose Ferme une ligne. N utilisez cette fonction que lorsque vous ne voulez plus effectuer, recevoir ou contrôler des appels sur une ligne. lineclose( HLINE hline linedeallocatecall Supprime les ressources associées à un appel. Cette fonction ne doit être utilisée que lorsque l appel est en mode de veille. linedeallocatecall( HCALL hcall Manuel du développeur TAPI Link Page 9 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link linedevspecific linedevspecific Le TSPI offre une fonctionnalité étendue grâce à la fonction linedevspecific. Remarque : Elle n est disponible que dans la version sous licence du pilote TAPI. La fonction linedevspecific de TAPI prend une mémoire tampon et la transmet, intacte, au TSP où elle est interprétée comme des commandes spécifiques au périphérique. Les types de commandes sont décrits dans les paragraphes suivants : linedevspecific( HLINE hline, DWORD dwaddressid, HCALL hcall, LPVOID lpparams, DWORD dwsize Protocole de connexion Pour connecter un agent ACD à une ligne surveillée, définissez le premier octet de la mémoire tampon à 8. Les octets suivants doivent être une chaîne de caractères qui décrit le poste qui se connecte. Considérons donc la mémoire tampon suivante, utilisée pour connecter l agent 218 à la ligne que nous avons appelée linedevspecific : - unsigned char buf[6]; int len = 6; buf[0] = 8; // Constante signifiant Connexion buf[1] = 2 ; buf[2] = 1 ; buf[3] = 8 ; buf[4] = 0; // N oubliez pas la terminaison nulle. Se déconnecter Vous pouvez vous déconnecter en transmettant la mémoire tampon suivante à la fonction DevSpecific : unsigned char buf[3]; int len = 3; buf[0] = 9; // Constante signifiant Code de fonction buf[1] = 47; // Constante signifiant Déconnexion buf[2] = 0; // N oubliez pas la terminaison nulle. Page 10 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
Destination de renvoi Référence TAPI 2.x Pour définir la destination des appels renvoyés, envoyez 9 dans le premier octet, 6 dans le second et les octets suivants doivent être une chaîne de caractères représentant le poste de destination du renvoi. Par exemple, pour définir la destination de renvoi au poste 236, envoyez la mémoire tampon suivante : unsigned char buf[6]; int len = 6; buf[0] = 9; // Les deux premiers octets sont des constantes devspecific buf[1] = 6; buf[2] = 2 ; buf[3] = 3 ; buf[4] = 6 ; buf[5] = 0; // N oubliez pas la terminaison nulle. Voyant de message en attente Certains téléphones possèdent des voyants qui s allument lorsque la messagerie vocale de l utilisateur contient des nouveaux messages. Le nombre de messages en attente peut être contrôlé par une commande devspecific spécifique. S il n y a aucun nouveau message, le voyant s éteint. S il y a au moins un nouveau message, le voyant s allume. Envoyez la mémoire tampon suivante à linedevspecific : unsigned char buf[21]; int len = 21; buf[0] = 9; // Code de fonction buf[1] = 73; // Définir le voyant de message en attente sprintf(&(buffer[2]), ";Mailbox Msgs=%d", num // num correspond au nombre de messages Remarque Le serveur IP Office ou d autres applications IP Office peuvent également contrôler le voyant de messages en attente. Manuel du développeur TAPI Link Page 11 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link Paramètres de renvoi Les constantes suivantes aident à activer et désactiver les fonctions de renvoi. const unsigned char ForwardAllOn = 0; const unsigned char ForwardAllOff = 1; const unsigned char ForwardBusyOn = 2; const unsigned char ForwardBusyOff = 3; const unsigned char ForwardNoAnswerOn = 4; const unsigned char ForwardNoAnswerOff = 5; const unsigned char DoNotDisturbOn = 7; const unsigned char DoNotDisturbOff = 8; Une mémoire tampon qui utilise ces constantes doit être longue de trois octets et doit commencer par un 9. Par exemple, le code suivant active la ligne Ne pas déranger. unsigned char buf[3]; int len = 3; buf[0] = 9; buf[1] = DoNotDisturbOn; buf[2] = 0; Activer/Désactiver le groupe Envoyez la mémoire tampon suivante pour activer l appartenance de l utilisateur au groupe possédant le poste groupnum. unsigned char buf[10]; int len = 10; buf[0] = 9; buf[1] = 76; sprintf((char*)&buf[2], "%d", groupnum Envoyez la mémoire tampon suivante pour désactiver l appartenance de l utilisateur au groupe possédant le poste groupnum. unsigned char buf[10]; int len = 10; buf[0] = 9; buf[1] = 77; sprintf((char*)&buf[2], "%d", groupnum Dans les deux cas (activation ou désactivation de l appartenance au groupe), vous pouvez désactiver ou activer toutes les appartenances en omettant le numéro du numéro de groupe et en le remplaçant par zéro (soit, buf[2] = 0). Remarque Vous ne pouvez qu activer et désactiver un utilisateur que des groupes auxquels il appartient, comme configuré dans Manager. Page 12 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
Intrusion Référence TAPI 2.x Envoyez la mémoire tampon suivante pour intervenir dans les appels d autres appelants. Le destinataire de l appel dans lequel vous intervenez est identifié par la classe enveloppante extnnum. unsigned char buf[10]; int len = 10; buf[0] = 9; // Code de fonction buf[1] = 83; // Intervenir sprintf((char*)&buf[2], "%d", extnnum Écouter Envoyez la mémoire tampon suivante pour écouter les appels d autres appelants. Le destinataire de l appel que vous écoutez est identifié par la classe enveloppante extnnum. unsigned char buf[10]; int len = 10; buf[0] = 9; // Code de fonction buf[1] = 100; // Écouter sprintf((char*)&buf[2], "%d", extnnum linedial Cette fonction est utilisée pour appeler un numéro au cours d un appel existant. Elle peut être utilisée dans un transfert supervisé (voir linesetuptransfer). Le code du pays est ignoré. linedial( HCALL hcall, LPCSTR lpszdestaddress, DWORD dwcountrycode linedrop Met fin à un appel. UserUserInfo n est pas pris en charge et est ignoré. linedrop( HCALL hcall, LPCSTR lpsuseruserinfo, DWORD dwsize Manuel du développeur TAPI Link Page 13 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link linegeneratedigits Utilisez cette fonction pour générer des chiffres DTMF lors d un appel. Il n est pas nécessaire que l utilisateur soit un utilisateur WAV ni qu un pilote wave soit installé pour agir sur l appel. Un message LINE_GENERATE est envoyé à l application à la fin de la création de ces chiffres. Le seul dwdigitmode pris en charge est LINEDIGITMODE_DTMF. linegeneratedigits( HCALL hcall, DWORD dwdigitmode, LPCSTR lpszdigits, DWORD dwduration linegeneratetone Cette fonction peut être utilisée pour créer un bip sonore lors de l appel. La ligne doit appartenir à un utilisateur WAV et le pilote wave doit être installé pour agir sur l appel. La seule valeur prise en charge pour dwtonemode est LINETONEMODE_BEEP. Les sonneries personnalisées n étant pas prises en charge, dwnumtones doit être zéro. linegeneratetone( HCALL hcall, DWORD dwtonemode, DWORD dwduration, DWORD dwnumtones, LPLINEGENERATETONE const lptones linegetaddresscaps Récupère les capacités téléphoniques d une adresse particulière pour une ligne particulière. Les capacités sont renvoyées dans la structure LINEADDRESSCAPS. Voir LINEADDRESSCAPS dans la section sur les structures TAPI pour de plus amples informations. Les lignes IP Office ont toujours une adresse unique. linegetaddresscaps( HLINEAPP hlineapp, DWORD dwdeviceid, DWORD dwaddressid, DWORD dwapiversion, DWORD dwextversion, LPLINEADDRESSCAPS lpaddresscaps Page 14 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
linegetaddressid Référence TAPI 2.x Cette fonction est utilisée pour mapper un numéro de téléphone (adresse) attribué à un dispositif de ligne à son dwaddressid dans la plage comprise entre zéro et le numéro des adresses moins un renvoyé dans les capacités du dispositif de la ligne. (LINEDEVCAPS). Si dwnumaddresses est 1 dans LINEDEVCAPS, alors cette fonction renvoie toujours 0 dans DWORD indiqué par lpdwaddressid. linegetaddressid( HLINE hline, LPDWORD lpdwaddressid, DWORD dwaddressmode, LPCSTR lpsaddress, DWORD dwsize linegetaddressstatus Cette fonction permet à une application de demander l état actuel d une adresse spécifique. Voir LINEADDRESSSTATUS dans la section sur les structures TAPI pour de plus amples informations. linegetaddressstatus( HLINE hline, DWORD dwaddressid, LPLINEADDRESSSTATUS lpaddressstatus linegetapppriority Récupère la priorité de vos applications. linegetapppriority( LPCSTR lpszappfilename, DWORD dwmediamode, LPLINEEXTENSIONID lpextensionid, DWORD dwrequestmode, LPVARSTRING lpextensionname, LPDWORD lpdwpriority Manuel du développeur TAPI Link Page 15 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link linegetcallinfo Obtient les informations fixes sur l appel spécifié. Voir la structure LINECALLINFO pour de plus amples informations. linegetcallinfo( HCALL hcall, LPLINECALLINFO lpcallinfo linegetcallstatus Cette fonction récupère une structure LINECALLSTATUS relative à un appel existant. Voir LINECALLSTATUS dans la section sur les structures TAPI pour de plus amples informations. linegetcallstatus( HCALL hcall, LPLINECALLSTATUS lpcallstatus linegetdevcaps Utilisez cette fonction pour récupérer la structure LINEDEVCAPS. Voir LINEDEVCAPS dans la section sur les structures TAPI pour de plus amples informations. linegetdevcaps( HLINEAPP hlineapp, DWORD dwdeviceid, DWORD dwapiversion, DWORD dwextversion, LPLINEDEVCAPS lplinedevcaps linegetid Obtenez l ID d une ligne lorsque dwselect est LINECALLSELECT_LINE. linegetid( HLINE hline, DWORD dwaddressid, HCALL hcall, DWORD dwselect, LPVARSTRING lpdeviceid, LPCSTR lpszdeviceclass Page 16 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
linegetlinedevstatus Référence TAPI 2.x La fonction linegetlinedevstatus renvoie une mémoire tampon spécifique au périphérique. La mémoire tampon devspecific contient les informations suivantes : linegetlinedevstatus( HLINE hline, LPLINEDEVSTATUS lplinedevstatus Octet Contient Commentaire 0..n Poste téléphonique Il s agit du numéro de ligne surveillé, sous la forme d une chaîne de caractères (par exemple, 217 ). n+1 0 Terminaison nulle pour la chaîne ci-dessus. n+2 Renvoi sur occupation 1 si le téléphone est configuré pour le renvoi sur occupation, sinon 0. n+3 Renvoi sur non réponse 1 si le téléphone est configuré pour le renvoi sur non réponse, sinon 0. n+4 Renvoi inconditionnel 1 si le téléphone est configuré pour renvoyer tous les appels. n+5 Drapeau Renvoi des appels du groupe de recherche de ligne 1 si le téléphone est configuré pour renvoyer les appels du groupe de recherche de ligne. n+6 Ne pas déranger 1 si le téléphone est configuré sur Ne pas déranger. n+7 Drapeau Appel sortant interdit 1 si le téléphone est bloqué et ne peut effectuer d appels sortant. n+8 Drapeau Appel en attente 1 si l appel en attente est activé pour ce téléphone. n+9 Drapeau Messagerie vocale activée n+10 Drapeau Rappel de messagerie vocale n+11 Nombres de messages de messagerie vocale lus n+12 Nombre de messages de messagerie vocale non lus n+13 Numéro de séquence d appel externe n+14 Numéro de séquence d appel interne n+15 Numéro de séquence de rappel 1 si la messagerie vocale est activée pour ce téléphone. 1 si le rappel de la messagerie vocale est activé pour ce téléphone. Le nombre de messages lus. Le nombre de messages de messagerie vocale en attente pour l utilisateur. Type de sonnerie pour les appels externes. Type de sonnerie pour les appels internes. Type de sonnerie pour les rappels. Manuel du développeur TAPI Link Page 17 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link n+16 Temporisation d absence de réponse n+17 Durée de conclusion d appel n+18 Drapeau Intrusion autorisée n+19 Drapeau Intrusion non autorisée Nombre de secondes pendant lesquelles le téléphone sonne avant de suivre l action sans réponse, comme par exemple, renvoyer sur non réponse et transférer à la messagerie vocale. Nombre de secondes pendant lesquelles le téléphone ne peut accepter de nouvel appel, suite à un appel. 1 si le téléphone peut intervenir dans les appels. 1 si l on ne peut pas intervenir sur ce téléphone. n+20 Drapeau Répertoire X 1 si cet utilisateur n apparaît pas dans le répertoire interne. n+21 Drapeau Forcer la connexion À l état déconnecté lors de la mise sous tension, l utilisateur doit donc se connecter. n+22 Drapeau Code client forcé 1 si le téléphone est forcé de fournir un code client valide pour effectuer des appels externes. n+23 Drapeau Code de connexion n+24 Drapeau Téléphone système 1 si l utilisateur a un code de connexion configuré. 1 s il s agit d un téléphone système. n+25 ID du message d absence ID du message d absence. n+26 Drapeau Définir le message d absence n+27 Mode courrier électronique de la messagerie vocale 1 si le message d absence avec l ID dans le champ précédent s affichent sur le téléphone. 1 si le mode courrier électronique de la messagerie vocale est activé. n+28..m Poste Le poste de l utilisateur, qui peut être différent du poste téléphonique. m+1 0 Terminaison nulle pour la chaîne Poste ci-dessus. m+2..p Paramètres régionaux Les paramètres régionaux de l utilisateur. p+1 0 Terminaison nulle pour les paramètres régionaux. p+2..q Destination du transfert Le numéro vers lequel ce téléphone est configuré pour renvoyer les appels. q+1 0 Terminaison nulle pour la destination ci-dessus. q+2..r r+1 0 Numéro de renvoi temporaire Tous les appels sont redirigés vers ce numéro. r+2..s Texte d absence Le texte d absence défini pour ce téléphone. s+1 0 Page 18 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
s+2..t Liste d exceptions à Ne pas déranger Référence TAPI 2.x Une liste de numéros qui sont autorisés à sonner sur le téléphone pendant que celui-ci est en mode Ne pas déranger. Chaque numéro est une chaîne à terminaison nulle. Le dernier numéro de la liste se termine par deux valeurs nulles (le champ t+1 représente la seconde valeur nulle). Si la liste est vide, alors les donnés contiennent une seule valeur nulle (représentée par t+1). t+1 0 t+2..u Numéro de transfert sur occupation Le numéro auquel seront transférés les appels lorsque ce téléphone est occupé. u+1 0 u+2 Priorité de l utilisateur Cette priorité est associée à tous les appels effectués par cet utilisateur. u+3 Appartenance au groupe Cet octet contient le nombre de groupes dans lesquels l utilisateur est actuellement activé. u+4 Groupes en dehors des heures Nombre de groupes auxquels appartient l utilisateur actuellement en dehors de leur profil horaire. u+5 Groupes désactivés Nombre de groupes actuellement désactivés pour l utilisateur. u+6 Groupes hors service Nombre de groupes auxquels appartient l utilisateur actuellement hors service. u+7 Groupes service de nuit Nombre de groupes auxquels appartient l utilisateur actuellement en service de nuit. linehandoff La fonction linehandoff transmet l appel spécifié à une autre application qui en devient propriétaire. linehandoff( HCALL hcall, LPCSTR lpszfilename, DWORD dwmediamode linehold Cette fonction met en attente un appel en cours. linehold( HCALL hcall Manuel du développeur TAPI Link Page 19 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link lineinitializeex Il s agit de la première fonction TAPI qui doit être utilisée pour initialiser TAPI. Le paramètre lpdwapiversion doit être défini à au moins 0x00020000. lineinitializeex( LPHLINEAPP lphlineapp, HINSTANCE hinstance, LINECALLBACK lpfncallback, LPCSTR lpszfriendlyappname, LPDWORD lpdwnumdevs, LPDWORD lpdwapiversion, LPLINEINITIALIZEEXPARAMS lplineinitializeexparams linemakecall Cette fonction effectue un appel. Voir la section sur les paramètres d appel à la fin du chapitre sur les fonctions TAPI. linemakecall( HLINE hline, LPHCALL lphcall, LPCSTR lpszdestaddress, DWORD dwcountrycode, LPLINECALLPARAMS const lpcallparams linemonitordigits Utilisez cette fonction pour activer la détection des chiffres DTMF. Cette fonction est uniquement opérationnelle lorsque le pilote wave IP Office est impliqué dans l appel et que l utilisateur est un utilisateur WAV (Voir la section sur les Utilisateurs WAV ). La détection se fait en analysant les échantillons média dans le pilote WAV. Lorsqu une sonnerie DTMF est détectée, un message LINE_MONITORDIGITS est envoyé à l application. dwdigitmodes peut être LINEDIGITMODE_DTMF et/ou LINEDIGITMODE_DTMFEND. Utilisez linemonitordigits avec un dwdigitmode de zéro pour annuler la détection des chiffres DTMF. linemonitordigits( HCALL hcall, DWORD dwdigitmodes Page 20 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
linemonitortone Référence TAPI 2.x Cette fonction, comme la fonction ci-dessus, requiert l implication d un pilote wave dans l appel. De plus, elle peut être utilisée pour détecter un silence. Les fréquences de la structure LINEMONITORTONE indiquée par lptonelist doivent toutes être de zéro. Si un silence est détecté, un message LINE_MONITORTONE est envoyé à l application. Utilisez linemonitortone avec lptonelist défini sur NUL pour annuler la détection de silence. linemonitortone( HCALL hcall, LPLINEMONITORTONE const lptonelist, DWORD dwnumentries linenegotiateapiversion Cette fonction doit être utilisée immédiatement après lineinitializeex pour assurer que les notifications TAPI correctes sont envoyées à votre application. Elle doit être utilisée pour chaque ligne utilisée par votre application. linenegotiateapiversion( HLINEAPP hlineapp, DWORD dwdeviceid, DWORD dwapilowversion, DWORD dwapihighversion, LPDWORD lpdwapiversion, LPLINEEXTENSIONID lpextensionid Manuel du développeur TAPI Link Page 21 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link lineopen Cette fonction ouvre un dispositif de ligne. dwmediamodes doit être défini à LINEMEDIAMODE_INTERACTIVEVOICE pour ISDN / T1 et à LINEMEDIAMODE_UNKNOWN pour les lignes de réseau analogiques. Vous pouvez spécifier les deux pour traiter les appels des deux types de lignes de réseau. lineopen( HLINEAPP hlineapp, DWORD dwdeviceid, LPHLINE lphline, DWORD dwapiversion, DWORD dwextversion, DWORD dwcallbackinstance, DWORD dwprivileges, DWORD dwmediamodes, LPLINECALLPARAMS const lpcallparams Remarque Si vous essayez d ouvrir une ligne qui est associée à un utilisateur Wave et qu aucune licence utilisateur Wave n est installée dans IP Office, lineopen renvoie LINEERR_RESOURCEUNAVAIL. Pour de plus amples informations sur les utilisateurs Wave, consultez la section Utilisateurs WAV. linepark Cette fonction parque un appel. Seul le mode de parcage LINEPARKMODE_DIRECTED est pris en charge. L adresse de parcage peut être une chaîne alphanumérique. Toutefois, seuls des chiffres numériques peuvent être saisis sur le téléphone. Il est donc préférable de limiter vos adresses de parcage à des chaînes numériques. Les quatre adresses de parcage par défaut qui apparaissent dans Phone Manager et econsole sont 1, 2, 3 et 4. Vous devriez utiliser ces chiffres si vous voulez parquer des appels qui seront repris à l aide d applications qui utilisent cette configuration par défaut. linepark( HCALL hcall, DWORD dwparkmode, LPCSTR lpszdiraddress, LPVARSTRING lpnondiraddress Page 22 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
lineredirect Référence TAPI 2.x La fonction lineredirect redirige l appel spécifié vers l adresse de destination spécifiée. Le code du pays est ignoré. lineredirect( HCALL hcall, LPCSTR lpszdestaddress, DWORD dwcountrycode lineremovefromconference Supprime l appel de la conférence. lineremovefromconference( HCALL hcall linesetapppriority Utilisez cette fonction pour indiquer la priorité de vos applications. linesetapppriority( LPCSTR lpszappfilename, DWORD dwmediamode, LPLINEEXTENSIONID lpextensionid, DWORD dwrequestmode, LPCSTR lpszextensionname, DWORD dwpriority linesetappspecific Cette fonction permet à une application de définir le champ spécifique à l application de l entrée d informations sur l appel spécifié. linesetappspecific( HCALL hcall, DWORD dwappspecific Manuel du développeur TAPI Link Page 23 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link linesetcallprivilege Utilisez cette fonction pour modifier les droits de propriété de vos applications pour un appel particulier. linesetcallprivilege( HCALL hcall, DWORD dwcallprivilege linesetstatusmessages Cette fonction permet à l application d indiquer les messages de notification requis. En général, dwlinestates est défini à LINEDEVSTATE_ALL et dwaddressstates à LINEADDRESSSTATE_ALL. linesetstatusmessages( HLINE hline, DWORD dwlinestates, DWORD dwaddressstates linesetuptransfer Cette fonction est utilisée pour créer un appel de consultation afin d effectuer un transfert supervisé. L appel à transférer doit déjà exister. L appel peut être actif ou en attente lorsque cette fonction est utilisée. Si l appel est actif, il sera mis en attente par cette fonction. Utilisez linedial pour appeler le destinataire vers lequel l appel doit être transféré. Utilisez linecompletetransfer pour terminer le transfert. linesetuptransfer( HCALL hcall, LPHCALL lphconsultcall, LPLINECALLPARAMS const lpcallparams lineshutdown À la fin de l utilisation des fonctions de ligne TAPI. Cette fonction est généralement utilisée lorsque vous quittez votre application. lineshutdown( HLINEAPP hlineapp Page 24 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
Référence TAPI 2.x lineswaphold Cette fonction met l appel actif en attente et récupère l appel en attente. lineswaphold( HCALL hactivecall, HCALL hheldcall lineunhold Cette fonction récupère un appel en attente. Cette fonction est utilisée lorsque la ligne appelle un autre interlocuteur ou a un appel actif avec un interlocuteur. L appel qui sonne, ou qui est actif, est alors abandonné avant que l appel en attente soit récupéré. lineunhold( HCALL hcall lineunpark Cette fonction récupère les appels parqués. dwaddressid doit être 0 car les lignes IP Office ont une adresse unique. lpszdestaddress doit être le même identificateur que celui utilisé lors du parcage de l appel (voir linpark). lineunpark( HLINE hline, DWORD dwaddressid, LPHCALL lphcall, LPCSTR lpszdestaddress Manuel du développeur TAPI Link Page 25 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link Structures TAPI LINEADDRESSCAPS Cette structure est obtenue grâce à la fonction linegetaddresscaps. Le tableau suivant indique les valeurs obtenues pour les lignes qui se rapportent au pilote TAPI IP Office. Remarque Tous les membres de cette structure ne sont pas répertoriés. Pour de plus amples informations sur LINEADDRESSCAPS, consultez la documentation Microsoft TAPI. Membre dwlinedeviceid dwdevspecificsize Description / Valeur ID de la ligne à laquelle correspond cette adresse. Aucune information spécifique supplémentaire sur le dispositif n est transmise. dwdevspecificoffset 0 dwaddresssharing LINEADDRESSSHARING_PRIVATE dwaddressstates 0 dwcallinfostates dwcalleridflags Indique l état d informations possibles sur l appel qui peut être : LINECALLINFOSTATE_CALLID LINECALLINFOSTATE_RELATEDCALLID LINECALLINFOSTATE_NUMOWNERINCR LINECALLINFOSTATE_NUMOWNEDECR LINECALLINFOSTATE_NUMMONITORS LINECALLINFOSTATE_CALLERID LINECALLINFOSTATE_CALLEDID LINECALLINFOSTATE_REDIRECTIONID LINECALLINFOSTATE_REDIRECTINGID LINECALLINFOSTATE_DISPLAY LINECALLINFOSTATE_MONITORMODES LINECALLINFOSTATE_CALLDATA Indique les drapeaux de l ID de l appelant qui peuvent être : LINECALLPARTYID_BLOCKED LINECALLPARTYID_OUTOFAREA LINECALLPARTYID_NAME LINECALLPARTYID_ADDRESS LINECALLPARTYID_UNKNOWN LINECALLPARTYID_UNAVAIL Page 26 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
Référence TAPI 2.x dwcalledidflags dwconnectedidflags dwredirectionidflags dwredirectingidflags Indique les drapeaux de l ID du destinataire qui peuvent être : LINECALLPARTYID_BLOCKED LINECALLPARTYID_OUTOFAREA LINECALLPARTYID_NAME LINECALLPARTYID_ADDRESS LINECALLPARTYID_UNKNOWN LINECALLPARTYID_UNAVAIL Indique les drapeaux de l ID connectée qui peuvent être : LINECALLPARTYID_NAME LINECALLPARTYID_UNKNOWN LINECALLPARTYID_UNAVAIL Indique les drapeaux de l ID de réacheminement qui peuvent être : LINECALLPARTYID_BLOCKED LINECALLPARTYID_OUTOFAREA LINECALLPARTYID_NAME LINECALLPARTYID_ADDRESS LINECALLPARTYID_UNKNOWN LINECALLPARTYID_UNAVAIL Indique les drapeaux de l ID de transfert qui peuvent être : LINECALLPARTYID_BLOCKED LINECALLPARTYID_OUTOFAREA LINECALLPARTYID_NAME LINECALLPARTYID_ADDRESS LINECALLPARTYID_UNKNOWN LINECALLPARTYID_UNAVAIL Manuel du développeur TAPI Link Page 27 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link dwcallstates Indique l état de l appel qui peut être : LINECALLSTATE_IDLE (l appel n existe plus) LINECALLSTATE_OFFERING (un nouvel appel est arrivé) LINECALLSTATE_ACCEPTED (l appel a été pris par une application) LINECALLSTATE_DIALTONE (l appelant entend une tonalité de numérotation) LINECALLSTATE_DIALING (the switch is receiving dialling information) LINECALLSTATE_RINGBACK (l appelant entend une sonnerie) LINECALLSTATE_BUSY (l appelant entend la tonalité d occupation) LINECALLSTATE_CONNECTED (l appelant a été connecté de bout en bout) LINECALLSTATE_PROCEEDING (la numérotation est terminée, mais l appel n a pas encore été connecté) LINECALLSTATE_ONHOLD (l appel est en attente) LINECALLSTATE_CONFERENCED (l appel est en conférence) LINECALLSTATE_ONHOLDPENDCONF (l appel est en attente avant de rejoindre la conférence) LINECALLSTATE_ONHOLDPENDCONF (l appel est en attente avant d être transféré) LINECALLSTATE_DISCONNECTED (l interlocuteur a abandonné l appel) LINECALLSTATE_UNKNOWN (l état de l appel est inconnu) dwdialtonemodes dwbusymodes dwspecialinfo Indique le mode de tonalité de numérotation de LINEDIALTONEMODE_UNAVAIL Indique les modes d occupation de LINEBUSYMODE_UNAVAIL Indique les informations spéciales de LINESPECIALINFO_UNAVAIL Page 28 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
Référence TAPI 2.x dwdisconnectmodes Indique les modes de déconnexion qui peuvent être : LINEDISCONNECTMODE_NORMAL LINEDISCONNECTMODE_REJECT LINEDISCONNECTMODE_PICKUP LINEDISCONNECTMODE_FORWARDED LINEDISCONNECTMODE_BUSY LINEDISCONNECTMODE_NOANSWER LINEDISCONNECTMODE_BADADDRESS LINEDISCONNECTMODE_UNREACHABLE LINEDISCONNECTMODE_CONGESTION LINEDISCONNECTMODE_INCOMPATIBLE LINEDISCONNECTMODE_UNAVAIL LINEDISCONNECTMODE_NODIALTONE LINEDISCONNECTMODE_QOSUNAVAIL LINEDISCONNECTMODE_BLOCKED LINEDISCONNECTMODE_DONOTDISTURB dwmaxnumactivecalls Nombre maximum d appels en cours : 1 dwmaxnumonholdcalls Nombre maximum d appels en attente : 9 dwmaxnumonholdpendingcalls Nombre maximum d appels en attente à traiter : 9 dwmaxnumconference Nombre maximum d appels de conférence : 9 dwmaxnumtransconf Nombre maximum d appels de conférence transférés : 9 dwaddrcapflags Indique les drapeaux d adresse qui peuvent être : LINEADDRCAPFLAGS_FWDNUMRINGS LINEADDRCAPFLAGS_DIALED LINEADDRCAPFLAGS_TRANSFERHELD LINEADDRCAPFLAGS_TRANSFERMAKE LINEADDRCAPFLAGS_CONFERENCEHELD LINEADDRCAPFLAGS_CONFERENCEMAKE LINEADDRCAPFLAGS_FWDSTATUSVALID Manuel du développeur TAPI Link Page 29 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link dwcallfeatures Indique les fonctions d appel qui peuvent être : LINECALLFEATURE_ADDTOCONF LINECALLFEATURE_ANSWER LINECALLFEATURE_BLINDTRANSFER LINECALLFEATURE_COMPLETETRANSF LINECALLFEATURE_DIAL LINECALLFEATURE_DROP LINECALLFEATURE_GENERATEDIGITS LINECALLFEATURE_HOLD LINECALLFEATURE_PARK LINECALLFEATURE_REDIRECT LINECALLFEATURE_REMOVEFROMCONF LINECALLFEATURE_SETUPTRANSFER LINECALLFEATURE_SWAPHOLD LINECALLFEATURE_UNHOLD LINECALLFEATURE_SETCALLDATA dwremovefromconfcaps dwremovefromconfstate Indique le caps supprimer de la conférence qui est LINEREMOVEFROMCONF_ANY. Indique l état supprimer de la conférence qui est ALLSTATE_ONHOLD. dwtransfermodes Indique les modes de transfert qui peuvent être : LINETRANSFERMODE_TRANSFER LINETRANSFERMODE_CONFERENCE dwparkmodes Indique le mode de parcage de LINEPARKMODE_DIRECTED. dwforwardmodes Indique les modes de renvoi qui peuvent être : LINE FORWARDMODE_UNCOND LINE FORWARDMODE_UNCONDEXTERNAL LINE FORWARDMODE_UNCONDSPECIFIC LINE FORWARDMODE_BUSY LINE FORWARDMODE_BUSYINTERNAL LINE FORWARDMODE_BUSYEXTERNAL LINE FORWARDMODE_BUSYSPECIFIC LINE FORWARDMODE_NOANSW LINE FORWARDMODE_NOANSWINTERNAL LINE FORWARDMODE_NOANSWEXTERNAL LINE FORWARDMODE_NOANSWSPECIFIC LINE FORWARDMODE_BUSYNA LINE FORWARDMODE_BUSYNAINTERNAL LINE FORWARDMODE_BUSYNAEXTERNAL LINE FORWARDMODE_BUSYNASPECIFIC Page 30 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
Référence TAPI 2.x dwmaxforwardentries Nombre maximum d entrées renvoyées : 10 dwmaxspecificentries Nombre maximum d entrées spécifiques : 10 dwminfwdnumrings Nombre minimum de sonneries lors d un renvoi : 1 dwmaxfwdnumrings Nombre maximum de sonneries lors d un renvoi : 99 dwmaxcallcompletions 0 dwcallcompletionconds 0 dwcallcompletionmodes 0 dwnumcompletionmessages 0 dwcompletionmsgtextentrysize 0 dwcompletionmsgtextsize 0 dwcompletionmsgtextoffset 0 dwaddressfeatures Indique les fonctions d adresse qui peuvent être : LINEADDRFEATURE_FORWARD LINEADDRFEATURE_MAKECALL LINEADDRFEATURE_SETUPCONF LINEADDRFEATURE_UNPARK LINEADDRFEATURE_FORWARDFWD LINEADDRFEATURE_FORWARDDND dwpredictiveautotransferstates 0 dwnumcalltreatments 0 dwcalltreatmentlistsize 0 dwcalltreatmentlistoffset 0 dwdeviceclassessize 0 dwdeviceclassesoffset 0 dwmaxcalldatasize Taille maximum des données d appel : 127 dwcallfeatures2 0 dwmaxnoanswertimeout 0 dwconnectedmodes 0 dwofferingmodes 0 dwavailablemediamodes 0 Manuel du développeur TAPI Link Page 31 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link LINEADDRESSSTATUS Cette structure est obtenue par linegetaddressstatus. Remarque Tous les membres de cette structure ne sont pas répertoriés. Pour de plus amples informations sur LINEADDRESSSTATUS, consultez la documentation Microsoft TAPI. Membre Description / Valeur dwnuminuse; Toujours 1 dwnumactivecalls; dwnumonholdcalls; Toujours 0 dwnumonholdpendcalls; Toujours 0 Correspond au nombre d appels en cours. dwaddressfeatures; indique les fonctionnalités suivantes : dwnumringsnoanswer; 5 dwforwardnumentries; Toujours 0 dwforwardsize; / Toujours 0 dwforwardoffset; Toujours 0 dwterminalmodessize; Toujours 0 dwterminalmodesoffset; Toujours 0 dwdevspecificsize; Toujours 0 LINEADDRFEATURE_MAKECALL LINEADDRFEATURE_SETUPCONF LINEADDRFEATURE_UNPARK Page 32 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
LINECALLINFO Cette structure est obtenue par linegetcallinfo. Remarque Référence TAPI 2.x Tous les membres de cette structure ne sont pas répertoriés. Pour de plus amples informations sur LINECALLINFO, consultez la documentation Microsoft TAPI. Membre Description / Valeur dwaddressid Toujours 0 dwbearermode Indique le mode de support possible qui est : dwrate 64000 LINEBEARERMODE_VOICE dwmediamode Indique le mode de média qui est : dwappspecific dwcallid dwcallparamflags LINEMEDIAMODE_INTERACTIVEVOICE Défini par l application ID de l appel Indique le drapeau de paramètres de l appel qui est LINECALLPARAMFLAGS_IDLE. dwcallstates Indique l état de l appel qui peut être : dwmonitormediamodes 0 dwcountrycode 0 dwtrunk dwcommentsize 0 dwcommentoffset 0 dwuseruserinfosize 0 dwuseruserinfooffset 0 LINECALLSTATE_IDLE LINECALLSTATE_OFFERING LINECALLSTATE_DIALTONE LINECALLSTATE_DIALING LINECALLSTATE_RINGBACK LINECALLSTATE_BUSY LINECALLSTATE_CONNECTED LINECALLSTATE_PROCEEDING LINECALLSTATE_ONHOLD LINECALLSTATE_CONFERENCED LINECALLSTATE_ONHOLDPENDCONF LINECALLSTATE_ONHOLDPENDTRANSFER LINECALLSTATE_DISCONNECTED LINECALLSTATE_UNKNOWN 0xFFFFFFFF Manuel du développeur TAPI Link Page 33 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link dwhighlevelcompsize 0 dwhighlevelcompoffset 0 dwlowlevelcompsize 0 dwlowlevelcompoffset 0 dwcharginginfosize 0 dwcharginginfooffset 0 dwterminalmodessize 0 dwterminalmodesoffset 0 dwcalldataoffset 0 dwsendingflowspecsize 0 dwsendingflowspecoffset 0 dwreceivingflowspecsize 0 dwreceivingflowspecoffset 0 dwcalleridaddresstype 0 - uniquement valide pour la version TAPI 3.0 et toute version supérieure dwcalledidaddresstype 0 - uniquement valide pour la version TAPI 3.0 et toute version supérieure dwconnectedidaddresstype 0 - uniquement valide pour la version TAPI 3.0 et toute version supérieure dwredirectionidaddresstype 0 - uniquement valide pour la version TAPI 3.0 et toute version supérieure dwredirectingidaddresstype 0 - uniquement valide pour la version TAPI 3.0 et toute version supérieure LINECALLPARAMS Les paramètres suivants sont reconnus dans la structure LINECALLPARAMS qui peut être transmise à linemakecall et linesetuptransfer. Remarque Tous les membres de cette structure ne sont pas répertoriés. Pour de plus amples informations sur LINECALLPARAMS, consultez la documentation Microsoft TAPI. Membre dwcallparamflags dwcalledpartyoffset dwcallingpartyidoffset Description / Valeur Définissez-le à zéro pour une utilisation normale ou saisissez LINEBEARERMODE_VOICE si vous voulez masquer l identificateur de ligne de l appelant pour cet appel. Peut être utilisé pour définir l identificateur de la partie appelée. Peut être utilisé pour définir l identificateur de la partie appelante. Page 34 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
LINECALLSTATUS Cette structure est obtenue grâce à la fonction linegetcallstatus. Remarque Référence TAPI 2.x Tous les membres de cette structure ne sont pas répertoriés. Pour de plus amples informations sur LINECALLSTATUS, consultez la documentation Microsoft TAPI. Membre Description / Valeur dwcallstate Indique l un des états suivants : dwcallstatemode dwcallprivilege dwcallfeatures dwdevspecificsize 0 dwdevspecificoffset 0 dwcallfeatures2 0 tstateentrytime LINECALLSTATE_IDLE (l appel n existe plus) LINECALLSTATE_OFFERING (un nouvel appel est arrivé) LINECALLSTATE_ACCEPTED (l appel a été pris par une application) LINECALLSTATE_DIALTONE (l appelant entend une tonalité de numérotation) LINECALLSTATE_DIALING (the switch is receiving dialling information) LINECALLSTATE_RINGBACK (l appelant entend une sonnerie) LINECALLSTATE_BUSY (l appelant entend la tonalité d occupation) LINECALLSTATE_CONNECTED (l appel a été connecté de bout en bout) LINECALLSTATE_PROCEEDING (la numérotation est terminée, mais l appel n a pas encore été connecté) LINECALLSTATE_ONHOLD (l appel est en attente) LINECALLSTATE_CONFERENCED (l appel est en conférence) LINECALLSTATE_ONHOLDPENDCONF (l appel est en attente avant de rejoindre la conférence) LINECALLSTATE_ONHOLDPENDCONF (l appel est en attente avant d être transféré) LINECALLSTATE_DISCONNECTED (l interlocuteur a abandonné l appel) LINECALLSTATE_UNKNOWN (l état de l appel est inconnu) Toujours zéro Le privilège des applications pour cet appel. Les fonctions d appel disponibles pour l état de l appel indiqué par dwcallstate. TAPI spécifie toutes les fonctions possibles. Toutefois, seules celles apparaissant dans dwcallfeatures de la structure LINEADDRESSCAPS peuvent être utilisées. Zéro Manuel du développeur TAPI Link Page 35 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link LINEDEVCAPS Cette structure est obtenue grâce à la fonction linegetdevcaps. Les commentaires suivants indiquent les valeurs obtenues pour les lignes qui se rapportent au pilote TAPI IP Office. Remarque Tous les membres de cette structure ne sont pas répertoriés. Pour de plus amples informations sur LINEDEVCAPS, consultez la documentation Microsoft TAPI. Membre dwproviderinfosize dwswitchinfosize 0 dwpermanentlineid dwlinenamesize Description / Valeur Indique le nom du fournisseur, soit le nom du fournisseur de service TAPI (TSP). Identificateur unique attribué par Windows. Indique le nom de la ligne. dwstringformat Indique le format de la chaîne qui est : STRINGFORMAT_ASCII dwaddressmodes Indique le mode d adresse qui est : dwnumaddresses 1 LINEADDRESSMODE_ADDRESSID dwbearermodes Indique les modes de supports qui sont : dwmaxrate 0 LINEBEARERMODE_VOICE LINEBEARERMODE_SPEECH dwmediamodes Indique le mode de média qui est : LINEMEDIAMODE_INTERACTIVEVOICE dwgeneratetonemodes Indique le mode de génération de tonalité qui est : dwgeneratetonemaxnumfreq 0 dwmonitortonemaxnumfreq 1 dwmonitortonemaxnumentries 1 dwgatherdigitsmintimeout 0 dwgatherdigitsmaxtimeout 0 dwmedctldigitmaxlistsize 0 dwmedctlmediamaxlistsize 0 dwmedctltonemaxlistsize 0 dwmedctlcallstatemaxlistsize 0 LINETONEMODE_BEEP Page 36 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
dwdevcapflags Indique les drapeaux dev cap qui sont : dwmaxnumactivecalls 9 LINEDEVCAPFLAGS_CLOSEDROP LINEDEVCAPFLAGS_DIALBILLING LINEDEVCAPFLAGS_DIALQUIET LINEDEVCAPFLAGS_DIALDUALTONE dwanswermode Indique le mode de réponse qui est : dwringmodes 1 LINEANSWERMODE_NONE dwlinestates Indique l état de la ligne qui est : dwuuiacceptsize 0 dwuuianswersize 100 dwuuimakecallsize 100 dwuuidropsize 100 dwuuisenduseruserinfosize 100 dwuuicallinfosize dwnumterminals 0 dwterminalcapssize 0 dwterminalcapsoffset 0 dwterminaltextentrysize 0 dwterminaltextsize 0 dwterminaltextoffset 0 dwdevspecificsize 0 dwdevspecificoffset 0 LINEDEVSTATE_RINGING LINEDEVSTATE_CONNECTED LINEDEVSTATE_DISCONNECTED LINEDEVSTATE_INSERVICE LINEDEVSTATE_OUTOFSERVICE LINEDEVSTATE_OPEN LINEDEVSTATE_CLOSE LINEDEVSTATE_REINIT LINEDEVSTATE_TRANSLATECHNGE LINEDEVSTATE_REMOVED Taille des informations sur l appel d utilisateur à utilisateur : 100 dwlinefeatures Indique la fonction de la ligne qui est : LINEFEATURE_MAKECALL Référence TAPI 2.x Manuel du développeur TAPI Link Page 37 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link dwsettabledevstatus 0 dwdeviceclassessize PermanentLineGuide dwaddresstypes Guide des protocoles dwavailabletracking tapi\line S applique uniquement à la version 2,2 ou supérieure de TAPI. S applique uniquement à la version 3.0 ou supérieure de TAPI. S applique uniquement à la version 3.0 ou supérieure de TAPI. S applique uniquement à la version 3.0 ou supérieure de TAPI. Evénements TAPI (Messages) LINE_APPNEWCALL Un nouvel appel a été créé. LINE_CALLINFO Les informations ont changé dans la structure LINECALLINFO. LINE_CALLSTATE L état de l appel a changé. Consultez dwcallstates dans la structure LINEADDRESSCAPS pour voir la liste des états pris en charge. LINE_LINEDEVSTATE L état du dispositif de ligne a changé. Le second paramètre peut être l un des suivants : LINEDEVSTATE_DEVSPECIFIC - Les informations Devspecific ont changé. LINEDEVSTATE_CONNECTED, LINEDEVSTATE_DISCONNECTED - L état connecté de la ligne a changé. LINEDEVSTATE_OUTOFSERVICE - La communication entre le TSP et le commutateur a été perdue. La ligne est maintenant hors service. LINEDEVSTATE_INSERVICE - Le TSP a perdu sa connexion avec le commutateur mais l a maintenant récupérée et la ligne fonctionne à nouveau normalement. LINEDEVSTATE_RINGING - Le commutateur a détecté que le téléphone de l appelant sonne. LINE_DEVSPECIFIC Notifie l application des événements spécifiques au dispositif qui se produisent sur une ligne, une adresse ou un appel. Ce message invite l application à appeler linegetlinedevstatus et à analyser la mémoire tampon devspecific en recherchant toute modification. LINE_ADDRESSSTATE L état d une adresse a changé sur une ligne qui est actuellement ouverte par l application. Page 38 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
Référence TAPI 3.0 TAPI TAPI L objet TAPI est créé par CoCreateInstance. Tous les autres objets TAPI 3.0 sont créés par TAPI 3.0. ITTAPI L interface ITTAPI est l interface de base de l objet TAPI. Initialize Il s agit de la première fonction TAPI qui doit être utilisée pour initialiser TAPI. HRESULT Initialize( Shutdown Ferme une session TAPI. Cette fonction est généralement utilisée lorsque vous quittez vos applications. HRESULT Shutdown( EnumerateAddresses Cette méthode énumère les adresses actuellement disponibles. HRESULT EnumerateAddresses ( IEnumAddress **ppenumaddress RegisterCallNotifications Définit quelles notifications de nouvel appel une application recevra. L application doit appeler cette méthode pour chaque adresse, en indiquant le(s) type(s) de média pris en charge et en spécifiant les privilèges requis. HRESULT RegisterCallNotifications( ITAddress *paddress, VARIANT_BOOLfMonitor, VARIANT_BOOLfOwner, long lmediatypes, long lcallbackinstance, long *plregister put_eventfilter La méthode put_eventfilter définit le masque de filtre des événements. HRESULT put_eventfilter ( long lfiltermask Manuel du développeur TAPI Link Page 39 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link Address Adresse L objet Adresse représente une entité qui peut effectuer ou recevoir des appels. ITAddress L interface est l interface de base pour l objet Adresse. get_addressname Obtient le nom affichable de l adresse. HRESULT get_addressname (BSTR *ppname get_dialableaddress La méthode get_dialableaddress obtient le BSTR, qui peut être utilisé pour la connexion à cette adresse. HRESULT get_dialableaddress ( BSTR *pdialableaddress get_serviceprovidername La méthode get_serviceprovidername obtient le nom du fournisseur de service de téléphonie (TSP) qui prend en charge cette adresse : par exemple, Unimdm.tsp pour le fournisseur de service Unimodem ou H323.tsp pour le fournisseur de service H323. HRESULT get_serviceprovidername ( BSTR *ppname CreateCall La méthode CreateCall crée un nouvel objet Appel qui peut être utilisé pour effectuer un appel sortant et retourner un pointeur à l interface ITBasicCallControl de l objet. HRESULT CreateCall ( BSTR *pdialableaddress, Long 1AddressType, Long 1MediaTypes, ITBasicCallControl**ppCall Page 40 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
Référence TAPI 3.0 IEnumAddress Fournit des méthodes d énumération COM-standard pour l interface ITAddress. Suivant La méthode Suivant obtient le nombre spécifié suivant d éléments dans la séquence d énumération. HRESULT Next( U celt, ITAddress**ppElements, U *pceltfetched ITMediaSupport L interface ITMediaSupport fournit des méthodes qui permettent à une application de découvrir les capacités de support média pour un objet Adresse qui affiche cette interface. get_mediatypes La méthode get_mediatypes obtient le(s) type(s) de média pris en charge sur l adresse active. HRESULT get_mediatypes ( long *plmediatypes Terminal L objet Terminal représente la source ou le récepteur du flux continu de média associé à un appel ou à une session de communication. Manuel du développeur TAPI Link Page 41 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link Call Appeler L objet Appel représente la connexion d une adresse entre l adresse locale et une ou plusieurs autres adresses. ITCallInfo L interface ITCallInfo obtient et définit de nombreuses informations concernant les objets Appel. get_address La méthode get_address place un pointeur à l interface ITAddress de l objet Adresse. HRESULT get_address ( ITAddress **ppaddress get_callstate La méthode get_callstate place un pointeur à l état actuel de l appel, comme CS_IDLE. HRESULT get_callstate ( CALL_STATE *pcallstate get_callinfostring La méthode get_callinfostring obtient les informations sur un appel décrites par une chaîne, telle que l adresse affichable. HRESULT get_callinfostring( CALLINFO_STRING CallInfoString, BSTR *ppcallinfostring SetCallInfoBuffer Par accident, ou en raison de sa conception, TAPi 3.0 (Windows 2000) n autorise cette fonction que sur un appel qui est à l état de VEILLE (IDLE). Cela a été modifié dans TAPI 3.1 (Windows XP) qui permet aux données d appel d être définies pour des appels à l état connecté en transmettant CIB_CALLDATABUFFER comme paramètre CallInfoBuffer. HRESULT SetCallInfoBuffer ( CALLINFO_BUFFERCallInfoBuffer, DWORD dwsize BYTE* pcallinfobuffer Page 42 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
ITBasicCallControl Référence TAPI 3.0 L interface ITBasicCallControl est utilisée par l application pour connecter, répondre et effectuer des opérations téléphoniques de base sur un objet appel. Se connecter La méthode Connect tente d effectuer la connexion d un appel sortant. HRESULT Connect( VARIANT_BOOLfSync Répondre La méthode Answer répond à un appel entrant. Cette méthode ne réussit que si l état de l appel est CS_OFFERING. HRESULT Answer( Disconnect La méthode Disconnect déconnecte l appel. L état de l appel passe à CS_DISCONNECTED une fois que la méthode a réussi. HRESULT Disconnect( DISCONNECT_CODE code Mise en attente La méthode Hold place ou reprend l appel en attente. HRESULT Hold( VARIANT_BOOLfHold SwapHold La méthode SwapHold échange l appel (en cours) avec l appel spécifié en attente. HRESULT SwapHold( ITBasicCallControl *pcall Manuel du développeur TAPI Link Page 43 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link ParkDirect La méthode ParkDirect parque l appel à une adresse spécifiée. HRESULT ParkDirect( BSTR pparkaddress Reprendre La méthode Unpark récupère l appel parqué. HRESULT Unpark( BlindTransfer La méthode BlindTransfer permet d effectuer un transfert en aveugle ou en une seule étape de l appel spécifié vers l adresse de destination spécifiée. HRESULT BlindTransfer( BSTR pdestaddress Transférer La méthode Transfer transfère l appel en cours vers l adresse de destination. HRESULT Transfer( ITBasicCallControl*pCall, VARIANT_BOOLfSync Terminer La méthode Finish est utilisée pour un appel de consultation pour mettre fin à une conférence ou à un transfert. HRESULT Finish( FINISH_MODE finishmode Page 44 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
Conference Référence TAPI 3.0 La méthode Conference ajoute un appel de consultation à la conférence à laquelle participe l appel en cours. HRESULT Conference( ITBasicCallControl *pcall, VARIANT_BOOLfSync RemoveFromConference La méthode RemoveFromConference supprime l appel de la conférence, le cas échéant. HRESULT RemoveFromConference( ITCallStateEvent L interface ITCallStateEvent contient des méthodes qui récupèrent la description des événements d état d appel. get_cause La méthode get_cause obtient la cause associée à cet événement. HRESULT get_cause ( CALL_STATE_EVENT_CAUSE *pcec get_state La méthode get_state obtient les informations sur le nouvel état de l appel. HRESULT get_state ( CALL_STATE *pcallstate get_call La méthode get_call place le pointeur sur l interface d informations de l appel pour l appel sur lequel l événement s est produit. HRESULT get_call ITCallInfo**ppCallInfo Manuel du développeur TAPI Link Page 45 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link ITCallNotificationEvent L interface ITCallNotificationEvent contient des méthodes qui récupèrent la description des événements de notification d appel. get_call La méthode get_call renvoie l interface ITCallInfo dans laquelle un événement d appel s est produit. HRESULT get_call ITCallInfo**ppCall ITCallInfoChangeEvent L interface ITCallInfoChangeEvent contient des méthodes qui récupèrent la description des événements de modification des informations de l appel. get_call La méthode get_call renvoie l interface ITCallInfo dans laquelle les informations de l appel ont été modifiées. HRESULT get_call ITCallInfo**ppCall Concentrateur d appel L objet Concentrateur d appel expose les méthodes pour récupérer les informations concernant les participants à un appel de conférence. Les concentrateurs d appels ne sont pas pris en charge par IP Office. Les événements de concentrateur d appel peuvent être reçus, mais il est conseillé de les ignorer. Page 46 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
Types énumérés TAPI 3 CALL_STATE CALL_STATE enum est utilisé par les méthodes ITCallInfo::get_CallState et ITCallStateEvent::get_State. Membre Valeur Description CS_IDLE 0 L appel a été créé, mais Connect n a pas encore été appelée. Un appel ne peut jamais passer à l état de transition de veille. CS_INPROGRESS 1 Connect a été appelée et le fournisseur de service est en train d effectuer la connexion. Cet état n est valide que pour les appels sortants. Ce message est facultatif car un fournisseur de service peut faire passer l appel directement à l état connecté. CS_CONNECTED 2 L appel a été connecté à l extrêmité distante et une communication peut avoir lieu. CS_DISCONNECTED 3 L appel a été déconnecté. Une déconnexion peut se produire pour plusieurs raisons. Consultez le tableau des états valides de transition d appel ci-dessous. CS_OFFERING 4 Un nouvel appel est apparu et est offert à une application. Si l application possède des privilèges de propriétaire, elle peut appeler Answer ou Disconnect lorsque l appel est à l état d offre. CS_HOLD 5 L appel est en attente. CS_QUEUED 6 L appel est en file d attente. Manuel du développeur TAPI Link Page 47 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link CALLINFO_STRING CALLINFO_STRING est utilisé par les méthodes ITCallInfo qui définissent et obtiennent les informations de l appel en utilisant des chaînes. Membre Valeur Description CIS_CALLERIDNAME 0 Le nom de l appelant. CIS_CALLERIDNUMBER 1 Le numéro de l appelant. CIS_CALLEDIDNAME 2 Le nom de l emplacement appelé. CIS_CALLEDIDNUMBER 3 Le numéro de l emplacement appelé. CIS_CONNECTEDIDNAME 4 Le nom de l emplacement connecté. CIS_CONNECTEDIDNUMBER 5 Le numéro de l emplacement connecté. CIS_REDIRECTIONIDNAME 6 Le nom de l emplacement vers lequel un appel a été redirigé. CIS_REDIRECTIONIDNUMBER 7 Le numéro de l emplacement vers lequel un appel a été redirigé. CIS_REDIRECTINGIDNAME 8 Le nom de l emplacement qui a redirigé l appel. CIS_REDIRECTINGIDNUMBER 9 Le numéro de l emplacement qui a redirigé l appel. CIS_CALLEDPARTYFRIENDLYNAME 10 Le nom convivial de l appelé. CIS_COMMENT 11 Un commentaire sur l appel fourni par l application qui a émis l appel. CIS_DISPLAYABLEADDRESS 12 Une version affichable de l adresse appelée ou appelante. CIS_CALLINGPARTYID 13 L identificateur de l appelant. DISCONNECT_CODE DISCONNECT_CODE enum est utilisé par la méthode ITBasicCallControl::Disconnect. Membre Valeur Description DC_NORMAL 0 L appel est déconnecté au cours du cycle de vie normal de l appel. DC_NOANSWER 1 L appel est déconnecté car il est resté sans réponse. (Par exemple, une application peut définir une certaine durée pendant laquelle l utilisateur peut répondre à l appel. Si l utilisateur ne répond pas, l application peut appeler Disconnect avec le code NOANSWER.) DC_REJECTED 2 L utilisateur a rejeté l appel offert. Page 48 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
CALL_STATE_EVENT_CAUSE Types énumérés TAPI 3 CALL_STATE_EVENT_CAUSE enum est renvoyée par la méthode ITCallStateEvent::get_Cause. Membre Valeur Description CEC_NONE 0 Aucun événement d appel ne s est produit. CEC_DISCONNECT_NORMAL 1 L appel a été déconnecté au cours du cycle de vie normal de l appel (c est-à-dire, l appel est terminé, donc il est déconnecté). CEC_DISCONNECT_BUSY 2 La connexion d un appel sortant a échoué car l extrêmité distante était occupée. CEC_DISCONNECT_BADADDRESS 3 Un appel sortant a échoué car l adresse de destination était incorrecte. CEC_DISCONNECT_NOANSWER 4 Un appel sortant a échoué car l extrêmité distante n a pas répondu. CEC_DISCONNECT_CANCELLED 5 Un appel sortant a échoué car l appelant a été déconnecté. CEC_DISCONNECT_REJECTED 6 L appel sortant a été rejeté par l extrêmité distante. CEC_DISCONNECT_FAILED 7 La connexion de l appel a échoué pour une autre raison. Manuel du développeur TAPI Link Page 49 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Fournisseur de service média IP Office A propos du MSP Le fournisseur de service média IP Office a une double fonction. Il fournit la fonctionnalité de média en continu qui permet à une application TAPI 3 d envoyer et de recevoir des données de voix sur des appels qui sont présents sur des types spécifiques de lignes d utilisateurs. Il permet également à une application d accéder à la fonctionnalité spécifique au dispositif d IP Office. Utiliser le MSP Les interfaces du fournisseur de service média sont décrites dans les bibliothèques MSDN. L exemple DevSpice du CD SDK fournit un exemple de l utilisation du MSP pour le flux continu de média et la fonctionnalité spécifique au périphérique. Le MSP est disponible pour chaque adresse TAPI qui peut être consultée dans votre application TAPI 3. Les fonctionnalités de média en continu ne sont disponibles que pour les adresses qui sont spécifiées comme utilisateurs WAVE. Les utilisateurs WAVE sont les utilisateurs dont le nom commence par TAPI: (comme TAPI:201 ). Vous pouvez créer autant d utilisateurs WAVE que vous voulez, mais chaque utilisateur WAVE doit posséder une instance de licence de pilote wave pour activer le flux continu de média pour cet utilisateur. Utiliser les interfaces spécifiques aux périphériques Les interfaces spécifiques aux périphériques sont mises en œuvre sur les objets Adresse et Appel du fournisseur de service média. TAPI 3.0 délègue les requêtes pour les interfaces qu il ne reconnaît pas au fournisseur de service média. Par conséquent, si vous avez un pointeur sur une interface ITAddress, vous pouvez appeler QueryInterface pour récupérer le pointeur sur l interface ITDivert (par exemple). Le code suivant de l exemple DevSpice illustre : ITDivert* pdivert = NULL; if( SUCCEEDED( gpaddress->queryinterface( IID_ITDIVERT, (void**)&pdivert))) { DWORD dwdivertsettings = 0; if( FAILED( pdivert-> GetDivertSettings( &dwdivertsettings))) { Les interfaces disponibles à partir de l objet Adresse sont : ITACDAgent ITDivert ITGroup L interface disponible à partir de l objet Appel est : ITPlay De plus, l objet Adresse agit en tant que conteneur de point de connexion pour les événements privés IP Office. L interface de point de connexion est disponible dans le fichier interfaces.h de l exemple DevSpice et s intitule IPOfficePrivateEvent. Vous trouverez de plus amples informations sur ces interfaces dans les paragraphes suivants. Manuel du développeur TAPI Link Page 51 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link ITACDAgent IsLoggedIn(void) Renvoie S_TRUE si l utilisateur est connecté et S_FALSE si l utilisateur est déconnecté. LogOut(void) Login(BSTR extn) CallListen(BSTR extn) Intrude(BSTR extn) Déconnecte l utilisateur de cette ligne. L utilisateur doit avoir une connexion forcée définie dans Manager. Connecte l utilisateur au poste spécifié. Écoute l appel présent sur le poste spécifié. L utilisateur doit posséder un privilège Intervention autorisée définie dans Manager. Met l utilisateur en conférence avec l appel présent au poste spécifié. L utilisateur doit posséder un privilège Intervention autorisée définie dans Manager. SetAccountCode(BSTR extn) Définit le code client pour l appel en cours. ITGroup Cette interface contient des fonctions pour ajouter et supprimer l utilisateur dans des groupes, ainsi que pour intercepter les appels présentés sur d autres téléphones du groupe. PickupAny(void) PickupGroup(void) PickupExtn(BSTR extn) Revient à exécuter le code de fonction CallPickupAny sur le terminal de l utilisateur. Voir Manager pour de plus amples informations. Revient à exécuter le code de fonction CallPickupGroup sur le terminal de l utilisateur. Revient à exécuter le code de fonction CallPickupExtn sur le terminal de l utilisateur. PickupMembers(BSTR extn) Revient à exécuter le code de fonction CallPickupMembers sur le terminal de l utilisateur. Enable(BSTR groupextn) Disable(BSTR groupextn) Active l appartenance de l utilisateur au groupe spécifié. Si groupextn est une chaîne vide, l utilisateur est activé dans tous les groupes desquels il/elle est membre. Désactive l appartenance de l utilisateur au groupe spécifié. Si groupextn est une chaîne vide, l utilisateur est désactivé dans tous les groupes desquels il/elle est membre. Page 52 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
ITDivert Fournisseur de service média IP Office Cette interface contient des fonctions pour obtenir et définir les drapeaux de renvoi pour l adresse. GetDivertAllDestination(BSTR* pdestination) Obtient la destination du Renvoi de tous les appels et indique les résultats dans la valeur pdestination. SetDivertAllDestination(BSTR dest) GetDivertSettings(DWORD* pdwdivertsets) Cette fonction définit les composants du DWORD indiqué par pdwdivertsets pour indiquer les paramètres de renvoi actifs. Les composants sont définis par IP_OFFICE_DIVERT_SETTINGS enum (décrit ci-dessous). SetForwardAll(VARIANT_BOOL bon) SetForwardBusy(VARIANT_BOOL bon) Active/désactive le paramètre ForwardAll (renvoi de tous les appels) pour cet utilisateur. Active/désactive le paramètre ForwardBusy (renvoi sur occupation) pour cet utilisateur. SetForwardNoAnswer(VARIANT_BOOL bon) Active/désactive le paramètre ForwardNoAnswer (renvoi sur non réponse) pour cet utilisateur. SetDoNotDisturb(VARIANT_BOOL bon) Active/désactive le paramètre DND (Ne pas déranger) pour cet utilisateur. IP_OFFICE_DIVERT_SETTINGS enum est défini comme suit : typedef enum { IPOFF_FWDALL = 0x01, IPOFF_FWDBUSY = 0x02, IPOFF_NOANSWER = 0x04, IPOFF_DND = 0x08, IPOFF_DESTINATION = 0x10 } IP_OFFICE_DIVERT_SETTINGS; Par conséquent, si l on obtient un résultat de 14 (0xe) de GetDivertSettings, cela signifie que l utilisateur a défini ForwardBusy (renvoi sur occupation), ForwardNoAnswer (renvoi sur non réponse) et DoNotDisturb (ne pas déranger). La valeur IPOFF_DESTINATION n est pas utilisée par GetDivertSettings, mais uniquement par la fonction Fire_DivertSettingsChanged sur l interface IPOfficePrivateEvents. Manuel du développeur TAPI Link Page 53 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link ITPlay L interface ITPlay est mise en œuvre sur l objet Appel du fournisseur de service média. Elle permet d enregistrer et d écouter des fichiers wave. StartPlay(BSTR FileName) StopPlay() FileName doit correspondre au chemin complet du fichier wave à diffuser. StartRecord(BSTR FileName) FileName doit correspondre au chemin complet du fichier wave sur lequel enregistrer. StopRecord() Vous pouvez arrêter et commencer la diffusion et l enregistrement à tout moment de l appel. L enregistrement utilise uniquement un fichier unique par appel et effectuera un ajout au fichier si l enregistrement est arrêté et redémarré. Il n est pas recommandé d essayer d enregistrer et de diffuser en même temps. S il s agit de l un de vos critères, l enregistrement et la diffusion peuvent être effectués en sélectionnant les terminaux pour l appel qui fournissent des données audio à partir d un fichier ou enregistrent des données audio dans un fichier. TAPI 3.1 propose des terminaux de fichiers continu pour rendre cette tâche plus facile. IPOfficePrivateEvents Il s agit d une interface de point de connexion que le MSP utilise pour générer des rapports sur les événements. Consultez l exemple DevSpice pour savoir comment vous inscrire et gérer des événements privés. OnUserLogin(void) OnUserLogout(void) OnDivertSettingsChanged(DWORD dwdivertsettings) OnGroupChanged(DWORD dwgroupcount) OnVoiceMail(DWORD dwnummessages) Déclenché lorsqu un agent (un utilisateur avec une connexion forcée définie dans Manager) se connecte. Déclenché lorsqu un agent se déconnecte. Déclenché lorsqu un utilisateur modifie l un de ses drapeaux de configuration de renvoi (comme Ne pas déranger ou Renvoi sur occupation) ou la destination du Renvoi de tous les appels. Les composants de la variable dwdivertsettings sont définis à l aide de IP_OFFICE_DIVERT_SETTINGS enum décrit ci-dessus. Déclenché lorsque l utilisateur active ou désactive l appartenance à un groupe. La valeur dwgroupcount indique le nombre de groupes pour lesquels l utilisateur est un membre activé. Déclenché lorsque le nombre de nouveaux messages de messagerie vocale change. La nouvelle valeur est indiquée dans le paramètre dwnummessages. Page 54 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0
Utiliser les capacités média continues du MSP Fournisseur de service média IP Office Le fournisseur de service média IP Office prend en charge les média en continu pour tout utilisateur wave. Pour cela, vous devez sélectionner les terminaux sur les flux continus que le fournisseur de service média propose pour un appel. Vous trouverez de plus amples informations sur la façon de le faire dans le MSDN et un exemple dans l exemple DevSpice. Il faut noter que les flux continus IP Office sont bi-directionnels et qu il n y a qu un flux continu par appel. Cela signifie que les terminaux de capture et de diffusion sont acceptés sur le même flux continu (mais un seul d entre eux à la fois). Le fournisseur de service média encapsule la fonctionnalité du pilote wave IP Office. Le pilote wave IP Office doit être installé sur chaque appareil qui doit proposer les média en continu aux utilisateurs wave. Si vous ne souhaitez pas utiliser les média en continu, mais seulement surveiller les utilisateurs wave qui utilisent TAPI, vous devez vérifier que le pilote wave n est pas installé ou vous utiliserez les instances de licence wave pour chaque ligne d utilisateur wave ouverte. Manuel du développeur TAPI Link Page 55 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Index A Activation/Désactivation du groupe...12 adresse...40 appel...42 C callinfo...48 code de déconnexion...48 concentrateur d'appel...46 configuration ip office...5 pilote...3 D destination de renvoi...11 E écouter...13 état d'appel cause de l'événement...49 état d'appel...47 événements privés...54 F flux continu de média...55 I installer licences...3 pilotes...3 interfaces des périphériques...51 intrusion...13 M MSP (fournisseur de service média)...51 P paramètres de renvoi...12 protocole de connexion...10 R références...1 S se déconnecter...10 T TAPI fonctions...7 messages d'événements...38 TAPI 2...5 TAPI 3...5 terminal...41 U utilisation flux continu de média...55 interfaces des périphériques...51 msp...51 V voyant de message en attente...11 Manuel du développeur TAPI Link Page 57 IP Office 4.0 15-601035 Version 11 (22.01.2007)
Manuel du développeur TAPI Link Les chiffres et les données de performances cités dans ce document correspondent à des mesures habituelles ; leur application à une commande ou à un contrat particulier doit au préalable faire l objet d une confirmation écrite expresse de la part d Avaya. La société se réserve le droit de modifier ou de rectifier à sa convenance le contenu de ce guide. La publication des informations de ce document n implique pas de dérogation en matière de protection des brevets ou d autres droits de propriété d Avaya ou d autres sociétés. La propriété intellectuelle inhérente à ce produit ainsi qu aux marques préalablement déposées par Lucent Technologies a été transférée ou cédée à Avaya. Toutes les marques identifiées par ou sont respectivement des marques ou des marques déposées d Avaya Inc. Toutes les autres marques appartiennent à leurs propriétaires respectifs. Ce document contient des informations confidentielles d Avaya et ne doit pas être divulgué ou utilisé, excepté en respectant les accords applicables. Tout commentaire ou suggestion concernant ce document doit être adressé(e) à «wgctechpubs@avaya.com». 2006 Avaya Inc. Tous droits réservés. Avaya Unit 1, Sterling Court 15-21 Mundells Welwyn Garden City Hertfordshire AL7 1LZ Angleterre Tél. : +44 (0) 1707 392200 Fax : +44 (0) 1707 376933 Page 58 Manuel du développeur TAPI Link 15-601035 Version 11 (22.01.2007) IP Office 4.0