L'utilisateur envoie un message texte
Lorsque l'utilisateur écrit et envoie le message « Hello, what can you do? », vous (l'intégrateur) devez envoyer le payload suivant :
{
"end_user_token": "df6a0edc-b31d-461x-ydcx-f7d5f02cd3d0",
"message": {
"text": "Hello, what can you do?"
}
}L'utilisateur clique sur une Quick Reply
Lorsque l'utilisateur clique sur la Quick Reply « Get a refund for a damaged package », vous devez envoyer le payload suivant :
{
"end_user_token": "df6a0edc-b31d-461x-ydcx-f7d5f02cd3d0",
"message": {
"quick_reply": {
"payload": "{\"target_use_case_uuid\": \"5f73118d-3672-4816-b196-858470a61e4d\", \"target_node_uuid\": \"7a462bfe-d2fa-4e76-b7e9-61843343406c\", \"target_edge_uuid\": \"4d58d113-e95b-4982-9ac0-663d16477563\", \"target_substep_name\": null, \"substep_parameters\": null, \"title\": \"Get a refund for a damaged package\"}"
},
"text": "Get a refund for a damaged package"
}
}Les champs target_use_case_uuid, target_node_uuid, target_edge_uuid, target_substep_name et substep_parameters se récupèrent dans le payload précédent envoyé par le bot (celui qui affiche les Quick Replies).
L'utilisateur envoie un fichier
Lorsque l'utilisateur envoie un fichier, vous devez d'abord téléverser ce fichier sur notre serveur et récupérer un uuid qui identifie l'image. Utilisez une requête POST multipart/form-data vers l'URL suivante : https://chatbot.laiye.com/uploads (exemple avec curl ci-dessous) :
curl -v -F file='@./Images/my_damaged_package.png' https://chatbot.laiye.com/uploads/?filename\=my_damaged_package.png
# Returns
# {
# "file_info":
# {
# "uuid": "1792c764-ff48-4eaa-8492-45dd0442fdea"
# },
# "message": "File successfully uploaded",
# "status": 200
# }Envoyez ensuite le payload suivant au bot
{
"end_user_token": "df6a0edc-b31d-461x-ydcx-f7d5f02cd3d0",
"message": {
"file_info": {
"uuid": "1792c764-ff48-4eaa-8492-45dd0442fdea",
"name": "my_damaged_package.png"
}
},
}L'utilisateur envoie des données CSAT
Lorsque l'utilisateur a terminé l'enquête CSAT (dans notre exemple, en cliquant sur « Skip » ou sur « Submit feedback »), vous devez envoyer le payload suivant :
{
"context": {
"first_name": "Eric"
},
"end_user_token": "df6a0edc-b31d-461x-ydcx-f7d5f02cd3d0",
"message": {
"quick_reply": {
"payload": "{\"type\": \"csat_event\", \"is_positive_rating\": true, \"comment\": \"Thank you for the help!\", \"title\": \"CSAT\", \"meta_content\": {\"message_id\":\"ecafc028-f92e-459b-a172-2bdffb13e867\",\"service_record_id\":17,\"case_statement_record_id\":11}}"
},
"text": "CSAT result"
}
}Les champs suivants sont propres au CSAT :
type : csat_event.
is_positive_rating : true si l'utilisateur donne un avis positif, false sinon
comment : le commentaire saisi par l'utilisateur ; peut être vide.
title : le titre de l'événement CSAT ; peut être vide
meta_content : se récupère dans le message précédent envoyé par le bot.