LaunchCCXML méthode

Dernière mise à jour : Nov 09, 2023 |
Informations sur le prologue
Cette méthode démarre l'application CCXML spécifiée et, si elle est réussie, 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
Important :
L’application CCXML démarrée doit renvoyer l’état de ce démarrage à l’aide d’un événement personnalisé comme décrit dans Retour de l'état d'une LaunchCCXML demande. Pour plus d'informations sur les valeurs de retour, voir Valeurs de retour de l’état de l’application CCXML. Les valeurs de retour sont décrites dans les valeurs de retour .
Remarque :
Si une application CCXML démarre plusieurs applications VoiceXML, chacune de ces applications peut utiliser un serveur de voix 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 l'appelant préfère l'espagnol et que la deuxième boîte de dialogue est ouverte avec l'ASR ou le TTS espagnol.

Paramètres

Paramètre
Type
Description
toURI
Chaîne
Fournit un indice sur les ressources Application Interface web service dont cette application CCXML a besoin.
Les options sont les suivantes :
  • Vide (aucune entrée) : Indique qu’il n’y a aucune exigence.
  • 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.
applicationName
Chaîne
Nom de l’application CCXML à 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 CCXML 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.values.avaya.ParameterMap. Par conséquent, la variable doit être référencée dans votre application sous le nom session.values.avaya.ParameterMap.parametername .
Par exemple, si vous spécifiez UserCounter=0 dans le service Web, vous feriez référence à session.values.avaya.ParameterMap.UserCounter dans votre application.
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.
launchTimeout
Entier
La durée maximale, en secondes, pour attendre le démarrage de l’application CCXML avant de renvoyer un message d’erreur.
zone
Chaîne
Nom de la zone où la demande doit être acheminée. Il s’agit du nom de la zone. (Facultatif).

Données retournées

Paramètre
Type
Description
sessionID_returned
Chaîne
Si l'application CCXML 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, l'information sur la ressource retournée est l'information pour la zone spécifiée dans la demande ou pour la zone par défaut, si aucune zone n'a été spécifiée.

Valeurs de retour de l’état de l’application CCXML

État
Application Intf WS rc
Application
« succès » `
0
"déconnexion réseau"
0
« débranchement à proximité »
0
« farenddisconnect »
0
« appel transféré »
0
« erreur d’analyse »
0x22 (URL non valide)
« urin. introuvable »
0x22 (URL non valide)
« délai d’attente de l’extraction »
0x13 (Échec)
LancementCCXML seulement
« erreur du serveur Web »
0x13 (Échec)
LancementCCXML seulement
« erreur de récupération »
0x13 (Échec)
LancementCCXML seulement
« Erreur inconnue »
0x13 (Échec) v
LancementCCXML seulement
« aucune ressource »
0x2 (aucune ressource)
« occupé »
0x10 (occupé)
« réseau occupé »
0x10 (occupé)
« réponse »
0x11 (aucune réponse)
« pas d’itinéraire »
0x20 (URI non valide)
LancementVXML seulement
« inconnu »
0x12 (Refus du réseau)
LancementVXML seulement
« erreur interne »
0x12 (Refus du réseau)
LancementVXML seulement
« éblouissement »
0x12 (Refus de réseau)v
LancementVXML seulement
« état non valide »
0x12 (Refus du réseau)
LancementVXML seulement
« télécopie détectée »
0x16 (télécopieur détecté)
Remarque :
Toutes les valeurs de retour générées par LaunchVXML et LaunchCCXML peuvent ne pas avoir de mappage à l'état envoyé par l'application CCXML.