LaunchVXML méthode

Dernière mise à jour : Nov 09, 2023 |
Informations sur le prologue
Métadonnées
Mots-clés :
Cette méthode permet de faire un appel sortant sur un MPP disponible, puis de lancer l'application VoiceXML spécifiée. S’il réussit, il retourne :
  • Experience Portal ID de session pour la nouvelle session
  • Nombre total de ressources sortantes disponibles, utilisées et non utilisées
  • Nombre total de ressources sortantes SIP inutilisées
  • Nombre total de ressources sortantes inutilisées de H.323
Le lancement réel de l’application VoiceXML est géré par la page CCXML par défaut, qui est également responsable du retour de la réussite ou de l’échec au Application Interface web service.
Lorsque l'application VoiceXML est invoquée, la première page VoiceXML est préparée. Si cela réussit, l’appel sortant est effectué par le système. Si l'appel se connecte et que la boîte de dialogue démarre sans erreur, l'application VoiceXML renvoie un code de lancement réussi. Sinon, l'application renvoie un code d'erreur approprié.
Remarque :
Si la page initiale de VoiceXML ne peut être préparée pour quelque raison que ce soit, le Application Interface web service ne fait pas l'appel sortant. Par conséquent, un client ne sera jamais dérangé par un appel sortant qui ne peut pas commencer correctement.
Pour plus d'informations sur les codes d'état renvoyés par la page CCXML, voir Retour de l'état d'une LaunchCCXML demande.
Remarque :
Si une application CCXML lance plusieurs applications VoiceXML, chacune de ces applications peut utiliser un serveur vocal différent. Avant la version Experience Portal 7.0, plusieurs applications utilisaient un seul serveur de messagerie vocale. Cette fonction entre en jeu si différentes langues sont chargées sur différents serveurs de messagerie vocale.
Lorsqu’une application CCXML lance une boîte de dialogue VoiceXML par nom, l’ASR ou le TTS configuré est utilisé. Si l'ASR ou le TTS configuré change, les ressources actuelles de l'ASR ou du TTS sont libérées et les nouvelles ressources sont saisies avant le début de la boîte de dialogue.
Par exemple, une application CCXML peut lancer une boîte de dialogue avec ASR ou TTS en anglais. L'application peut déterminer que le demandeur préfère l'espagnol et que la deuxième boîte de dialogue est lancée avec l'ASR ou le TTS espagnol.
Important :
Les valeurs de retour sont décrites comme valeurs de retour .

Paramètres

Paramètre
Type
Description
toURI
Chaîne
Le numéro ou la destination à contacter par l'application de sortie.
Ce paramètre peut être préfixé avec l’une des chaînes suivantes :
  • tel : Utilisez ceci pour une connexion H.323 ou SIP, ou un mélange des deux.
  • Sip : Utilisez cette option pour une connexion SIP standard.
  • sips : Utilisez ceci pour une connexion SIP sécurisée.
fromURI
Chaîne
Les renseignements sur l’adresse d’appel à transmettre à l’appel sortant.
applicationName
Chaîne
Nom de l'application VoiceXML à exécuter une fois l'appel sortant connecté.
Important :
Le applicationName doit correspondre au nom spécifié lorsque l'application a été ajoutée à par le Avaya Experience Portal biais du EPM.
Pour une application qui est affectée à une zone non par défaut, incluez les informations de zone en utilisant le format : ID de zone :nomdeapplication
Vous pouvez afficher tous les noms d’applications sur la page Applications.
Vous pouvez récupérer les informations d'ID de zone en utilisant la méthode getZoneInfo du service Web de l'interface de gestion.
applicationURL
Chaîne
Paramètres qui doivent être ajoutés à l'URL spécifiée pour l'application dans le EPM.
Cela vous permet d’appeler l’application avec différents arguments au besoin.
Paramètres
Chaîne
Une ou plusieurs paires de variables de valeur de nom qui seront transmises à l'application VoiceXML lorsqu'elle sera invoquée. Chaque paire doit être au format parametername=value, et plusieurs paires doivent être séparées par un ; (semi-colon).
Remarque :
Lorsque le service Web transmet le paramètre à l'application, il ajoute l'espace de noms session.avaya.telephone. Par conséquent, la variable doit être référencée dans votre application sous le nom session.avaya.telephone.parametername .
Par exemple, si vous spécifiez UserCounter=0 dans le service Web, vous feriez référence à session.avaya.telephone.UserCounter dans votre application.
Astuce :
Si vous souhaitez activer la classification d'appel pour cet appel, reportez-vous à la section Classification des appels avec la méthode LaunchVXML.
uuiInfo
Chaîne
Le Application Interface web service transmet toute information contenue dans ce paramètre à la couche de téléphonie de la plateforme incluse dans l'appel sortant.
connectTimeoutSecs
Entier
La durée maximale, en secondes, pour attendre que l’appel sortant soit connecté.
Entrez une valeur comprise entre 0 et 59.
Si ce paramètre est réglé sur 0 (zéro) ou omis, Experience Portal utilise la valeur par défaut de 120 secondes.
zone
Chaîne
Il s’agit du nom de la zone où la demande doit être acheminée. (Facultatif).

Données retournées

Paramètre
Type
Description
sessionID_returned
Chaîne
Si l'application VoiceXML s'est connectée avec succès, le Application Interface web service définit cette valeur de retour sur l'ID de session Experience Portal attribué à la nouvelle session CCXML.
totalRes_returned
Entier
Nombre total de ressources sortantes disponibles, utilisées et non utilisées.
unusedSIP_returned
Entier
Nombre total de ressources sortantes SIP inutilisées.
unusedH323_returned
Entier
Nombre total de ressources sortantes inutilisées de H.323.
Remarque :
Si les zones sont activées, les informations sur les ressources retournées sont les informations pour la zone spécifiée dans la demande. Si aucune zone n'est spécifiée, l'information sur la ressource retournée est l'information pour la zone par défaut.