Envío de un mensaje de texto por el usuario final
Cuando el usuario final escribe y envía el mensaje «Hola, ¿qué puedes hacer?», tú (el integrador) debes enviar la siguiente carga útil:
{
"end_user_token": "df6a0edc-b31d-461x-ydcx-f7d5f02cd3d0",
"message": {
"text": "Hello, what can you do?"
}
}Clic del usuario final en una respuesta rápida
Cuando el usuario final hace clic en la respuesta rápida «Obtener un reembolso por un paquete dañado», debes enviar la siguiente carga útil:
{
"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"
}
}El target_use_case_uuid, el target_node_uuid, el target_edge_uuid, el target_substep_name y los substep_parameters se pueden recuperar de la carga útil anterior (la que muestra las respuestas rápidas) enviada por el bot.
Envío de un archivo por el usuario final
Cuando el usuario final envía un archivo, primero debes cargarlo en nuestro servidor y recuperar un uuid que identifique la imagen. Utiliza una solicitud POST multipart/form-data a la siguiente URL https://chatbot.laiye.com/uploads (a continuación, un ejemplo con curl):
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
# }A continuación, envía la siguiente carga útil al bot
{
"end_user_token": "df6a0edc-b31d-461x-ydcx-f7d5f02cd3d0",
"message": {
"file_info": {
"uuid": "1792c764-ff48-4eaa-8492-45dd0442fdea",
"name": "my_damaged_package.png"
}
},
}Envío de datos CSAT por el usuario final
Cuando el usuario final haya completado la encuesta CSAT (en nuestro ejemplo, al hacer clic en «Omitir» o en «Enviar comentarios»), debes enviar la siguiente carga útil:
{
"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"
}
}Los siguientes campos son propios de CSAT:
type: csat_event.
is_positive_rating: Si el usuario proporciona comentarios positivos, debe ser true; de lo contrario, debe ser false
comment: el comentario enviado por el usuario; puede estar vacío.
título: el título del evento CSAT; puede estar vacío
meta_content: El meta_content se puede recuperar del mensaje anterior enviado por el bot.