Fragment Charge utile personnalisée

Les informations sur cette page d’aide concernent à la fois CXone Studio et Desktop Studio.

Utilisez ce snippet avec des actions qui comportent la propriété customPayload, comme Voicebot Exchange ou Textbot Conversation. Il est utilisé pour transmettre des données de CXone à votre fournisseur d’agent virtuel Une application logicielle qui gère les interactions avec les clients à la place d'un agent humain en direct.. Si vous devez recevoir des données personnalisées de votre agent virtuel, utilisez la variable customPayloadVarName (out).

Ce fragment est requis pour les agents virtuels suivants :

Amazon Lex V1 et Amazon Lex V2 : le snippet Charge utile personnalisée est requis pour Lex V1 et Lex V2, même si vous n’avez pas besoin de transmettre des données à l’agent virtuel. L’agent virtuel utilise les données transmises via la propriété customPayload pour remplir la propriété SessionAttributes côté Amazon.
Google Dialogflow ES : Custom Payload transmet les informations de contexte que l’Agent virtuel ES Dialogflow utilise pour déterminer l'intention La signification ou le but derrière ce qu'un contact dit/tape ; ce que le contact veut communiquer ou accomplir. Suivez les bonnes pratiques recommandées pour intégrer des données de charge utile personnalisées avec Google Dialogflow ES.

Pour tous les autres agents virtuels, vous ne devez inclure le fragment que si vous avez des données personnalisées à transmettre au robot. Si vous utilisez Dialogflow CX, suivez les meilleures pratiques pour inclure une charge utile personnalisée.

Transmission d’un espace réservé

Si vous utilisez Amazon Lex V1 ou Amazon Lex V2 et que vous n’avez pas besoin de transmettre des informations à l’agent virtuel, suivez cet exemple :

DYNAMIC customPayload 
 customPayload.placeholder=""

Si vous devez transmettre des informations à l’agent virtuel, reportez-vous à l’exemple présenté à la section suivante.

Transmission de données

Pour tous les fournisseurs d’agents virtuels, suivez cet exemple pour transmettre des informations à l’agent virtuel. Remplacez les paramètres de l'exemple par les informations que vous devez transmettre.


customPayload.context.id="information"
customPayload.context.lifespan=1
customPayload.context.parameters.name="Fenrir"
customPayload.context.parameters.age="19"
customPayload.context.parameters.date="20201020"

Meilleures pratiques pour Charge utile personnalisée Google Dialogflow CX

Dialogflow CX n'utilise pas de contextes pour transmettre des données aux Dialogflowintentions La signification ou le but derrière ce qu'un contact dit/tape ; ce que le contact veut communiquer ou accomplir commeDialogflowES.
Vous pouvez transmettre des données personnalisées à Dialogflow CX utilisant des paires clé-valeur JSON. Dans une action action Snippet de votre script, créez un objet customPayload dynamique et ajoutez-y les paires clé-valeur. Par exemple :
```
DYNAMIC customPayload
customPayload.ani = ani
customPayload.contactID = contactId
customPayload.masterContactId = masterId
customPayloadJSON = "{customPayload.asJSON()}"	
```
Dans l’action Exchange ou Conversation de votre script, configurez la propriété customPayload avec la variable incluant la fonction asJSON()comme valeur. Vous trouverez cette variable dans l’objet customPayload.
Transférez le code JSON customPayload à l’agent virtuel en utilisant la propriété Payload de QueryParameters. Reportez-vous à la documentation Google concernant QueryParameters pour Google Dialogflow CX.
Les données transférées via QueryParameters sont reçues par un webhook dans Dialogflow CX. Vous pouvez écrire du code dans la Dialogflow Console CX pour gérer les données transmises.
N’imbriquez pas d’objet dans l’objet customPayload. Les objets imbriqués sont envoyés sous forme de chaînes littérales.
Pour renvoyer des données personnalisées de votre agent virtuel Dialogflow CX dans votre script, utilisez le champ Charge utile personnalisée de la console Dialogflow CX. Vérifiez que vous vous trouvez dans la console de l’agent virtuel que vous utilisez avec CXone. Mappez ceci à votre script en utilisant la variable customPayloadVarName (out) dans l'action voix ou chat Studio de votre script. Par exemple, vous pouvez l'utiliser pour définir les comportements de l'invite suivante.
Les paramètres définis en utilisant customPayload peuvent uniquement être utilisés dans le webhook externe. Si vous souhaitez définir des paramètres à utiliser en dehors du webhook externe, faites-le dans une action Snippet avec le champ session_params. Par exemple :
```
{
	"session_params":
	{ 
		"name": "Winnie Le Pooh"
		"job": "Food critic"
		"location": "Hundred Acre Wood"
	}
}
```
Accédez aux paramètres de session dans l’intention de l’agent Dialogflow CX à l’aide de la syntaxe suivante :

$session.params.name = Winnie Le Pooh

$session.params.job = Food critic

$session.params.location = 100 Acre Wood

Les paramètres de session sont uniquement utilisés avec les agents virtuels Dialogflow CX. Pour obtenir un résultat similaire avec Dialogflow ES, utilisez les contextes.
Les conseils de contexte vocal peuvent être transmis avec la charge utile dans le paramètre speechContexts. La valeur de speechContexts.phrases doit être un jeton de classe Google correspondant au conseil à donner. Le jeton doit correspondre à la langue et aux paramètres régionaux de vos contacts. Par exemple :
```
DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10		
```
Lorsque vous utilisez VOICEBOT EXCHANGE : pour configurer la durée d’attente de l’agent virtuel lorsque le contact fait une pause dans son énoncé, ajoutez le paramètre maxPostEnergySilenceMS à l’action Next Prompt Behaviors ou Default Next Prompt Behaviors Snippet.

Meilleures pratiques pour Charge utile personnalisée Google Dialogflow ES

CustomPayload est utilisé pour transférer du contexte à une intention La signification ou le but derrière ce qu'un contact dit/tape ; ce que le contact veut communiquer ou accomplir. Le contexte aide l'agent virtuel à comprendre l'intention de l'utilisateur. Les contextes ne sont pas obligatoires, mais ils aident l'agent virtuel à faire correspondre un énoncé Ce qu'un contact dit ou tape. à une intention.
Dans une Snippet action de votre script, créez un objet customPayload qui suive le format défini dans la documentation de Google Dialogflow ES pour la ressource REST : projects.agent.sessions.context. L’aide en ligne Studiofournit des informations supplémentaires sur les objets de données dynamiques.
Vous pouvez également transmettre des données personnalisées avec customPayload sans contexte. Pour ce faire, incluez des paires clé-valeur JSON standard dans un objet de données dynamique.
Les contextes vocaux sont transmis dans la charge utile personnalisée avec le paramètre speech_contact. Vous pouvez afficher le contenu de ce paramètre dans les traces Studio et les journaux d’application.
L’objet dynamique customPayload est transféré en tant que paramètre d'agent virtuel au format JSON, comme indiqué dans l’exemple de script.
Les conseils de contexte vocal peuvent être transmis avec la charge utile dans le paramètre speechContexts. La valeur de speechContexts.phrases doit être un jeton de classe Google correspondant au conseil à donner. Le jeton doit correspondre à la langue et aux paramètres régionaux de vos contacts. Par exemple :
```
DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10		
```