Envio de uma mensagem de texto pelo usuário final
Quando o usuário final escreve e envia uma mensagem “Olá, o que você pode fazer?”, você (o integrador) deve enviar o seguinte payload:
{
"end_user_token": "df6a0edc-b31d-461x-ydcx-f7d5f02cd3d0",
"message": {
"text": "Hello, what can you do?"
}
}Clique do usuário final em uma resposta rápida
Quando o usuário final clica na resposta rápida “Obter um reembolso por um pacote danificado”, você deve enviar o seguinte payload:
{
"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"
}
}O target_use_case_uuid, o target_node_uuid, o target_edge_uuid, o target_substep_name e os substep_parameters podem ser recuperados do payload anterior (aquele que mostra as respostas rápidas) enviado pelo bot.
Envio de um arquivo pelo usuário final
Quando o usuário final envia um arquivo, você deve primeiro fazer o upload do arquivo em nosso servidor e recuperar um uuid que identifique a imagem. Use uma solicitação POST multipart/form-data para a seguinte URL https://chatbot.laiye.com/uploads (abaixo, um exemplo com 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
# }Em seguida, envie o seguinte payload ao bot
{
"end_user_token": "df6a0edc-b31d-461x-ydcx-f7d5f02cd3d0",
"message": {
"file_info": {
"uuid": "1792c764-ff48-4eaa-8492-45dd0442fdea",
"name": "my_damaged_package.png"
}
},
}Envio de dados de CSAT pelo usuário final
Quando o usuário final concluir a pesquisa de CSAT (em nosso exemplo, clicando em “Ignorar” ou em “Enviar feedback”), você deve enviar o seguinte payload:
{
"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"
}
}Os seguintes campos são específicos do CSAT:
type: csat_event.
is_positive_rating: Se o usuário fornecer um feedback positivo, deve ser true; caso contrário, deve ser false
comment: o comentário enviado pelo usuário; ele pode estar vazio.
título: o título do evento de CSAT; ele pode estar vazio
meta_content: O meta_content pode ser recuperado da mensagem anterior enviada pelo bot.