Référence d'intégration SMS

Ajoutez des commandes d'action à l'objet context du message pour gérer le flux de conversations avec les clients qui interagissent avec votre assistant en soumettant des messages SMS par téléphone.

Découvrez les commandes prises en charge et les variables de contexte réservées qui sont utilisées par l'intégration SMS.

Commandes prises en charge

Chaque action se compose d'une propriété command suivie d'une propriété parameter facultative pour définir des paramètres pour les commandes qui en ont besoin. Les commandes décrites dans le tableau suivant sont prises en charge par l'intégration SMS.

Actions que vous pouvez lancer à partir de l'action
Commande d'action	Description	Paramètres
`terminateSession`	Met fin à la session SMS en cours. Utilisez cette commande pour vous assurer que le message texte suivant démarre une nouvelle session de niveau assistant qui ne conserve aucune valeur de contexte de la session en cours.	Aucun
`smsActSendMedia`	Active la messagerie MMS.	`mediaURL` : spécifie un tableau JSON d'URL de support publiques envoyées à l'utilisateur.
`smsActSetDisambiguationConfig`	Configure la façon de gérer les choix qui sont affichés dans une liste de désambiguïsation.	`prefixText` : texte à inclure avant chaque option. Par exemple, `Press %s for`, où `%s` représente le nombre correspondant à un choix de la liste et est remplacé par le nombre réel lors de l'exécution.
`smsActSetOptionsConfig`	Configure la façon de traiter les types de réponse d'option.	`prefixText` : texte à inclure avant chaque option. Par exemple, `Press %s for`, où `%s` représente le nombre correspondant à un choix de la liste et est remplacé par le nombre réel lors de l'exécution.

Variables contextuelles réservées

Le tableau suivant décrit les variables de contexte qui ont une signification particulière dans le contexte de l'intégration SMS. Ces dernières ne doivent pas être utilisées à des fins autres que l'utilisation documentée.

Le tableau 2 décrit les variables de contexte définies par votre action. Le tableau 3 décrit les variables contextuelles que vous pouvez définir dans le cadre de l'intégration SMS.

Tableau 2. Variables de contexte définies par votre action

Variables de contexte SMS définies par l'action
Nom de la variable contextuelle	Valeur attendue	Description
`smsConversationResponseTimeout`	Temps en ms	Durée en millisecondes pendant laquelle l'intégration attend de recevoir une réponse de l'action. Si la limite de temps est dépassée, l'intégration tente de à nouveau de contacter l'action. Si le service n'est toujours pas joignable, la réponse SMS échoue.

Tableau 3. Variables de contexte définies par l'intégration

Variables de contexte SMS définies par l'intégration
Nom de la variable contextuelle	Description
`smsTenantPhoneNumber`	Le numéro de téléphone du titulaire d'intégration auquel l'utilisateur envoie des messages.
`smsUserPhoneNumber`	Numéro de téléphone de l'utilisateur qui échange des messages avec l'intégration.
`smsUserData`	Données au format JSON à transmettre mot à mot au moteur d'orchestration de services ou au service watsonx Assistant Cette variable est envoyée uniquement si la session est démarrée à partir du titulaire d'intégration et que les données sont envoyées via l'API REST.
`smsSessionTimeoutCount`	Valeur du délai d'attente de la session. Cette variable est envoyée uniquement si la valeur du délai d'attente est définie via l'API REST.
`smsError`	Lorsque l'intégration ne parvient pas à envoyer un message SMS, cette variable contient des détails sur l'erreur qui s'est produite.
`smsSessionID`	Identificateur global unique (GUID) de la session SMS Gateway connexe.
`smsMedia`	`arraylist` de `mediaURL` et `mediaContentType` correspondant. Cette variable contextuelle est effacée à la fin de chaque échange de conversation.