Cancelar o componente pré-criado do pedido

O componente predefinido de cancelamento de pedidos verifica o nível de autenticação de um usuário. Depois que o usuário é autenticado, o componente fornece informações sobre os pedidos mais recentes ou anteriores do usuário. O usuário pode escolher cancelar um pedido inteiro ou itens específicos em um pedido. Esse componente usa o componente predefinido Autenticação de varejo para autenticar usuários. O componente também usa Geradores para resumo pós-chamada.

Limitações

Além das limitações comuns de componentes predefinidos, este componente predefinido tem as seguintes limitações:

  • Esse componente não criptografa dados.

Exemplos de diálogos

As caixas de diálogo de exemplo a seguir demonstram cenários comuns processados por esse componente pré-criado. As caixas de diálogo de exemplo demonstram o comportamento quando o componente é chamado usando telefonia, o que aciona a intent de boas-vindas padrão e a primeira resposta do agente no início da conversa.

Cancelar um único produto em um pedido recente

O usuário final foi autenticado anteriormente. O agente confirma quais itens do pedido mais recente devem ser cancelados. O agente verifica o método de pagamento original e confirma os detalhes do cancelamento com o usuário.

Entrada do usuário Resposta do agente
Você está ligando sobre o pedido mais recente, que termina em 12978 e contém cinco garrafas de água e uma camiseta, feito em 9 de novembro de 2023 às 20h?
sim
Encontramos alguns produtos qualificados no seu pedido. Informe qual produto você quer cancelar.
Produto 1: garrafa de água do Google, Produto 2: camiseta do Google.

Diga ou insira o número do produto do item que você quer selecionar ou diga "próximo" para mostrar mais produtos.
próxima
Não encontramos outros itens nos nossos registros. Escolha na lista compartilhada.
Produto 1: garrafa de água do Google, Produto 2: camiseta do Google.

Diga ou insira o número do produto do item que você quer selecionar ou diga "próximo" para mostrar mais produtos.
1
Para verificar, você tem interesse em cancelar a garrafa de água do Google. É isso mesmo?
sim
A quantidade disponível do produto selecionado é 5. Especifique a quantidade de produtos que você quer cancelar.
4
Especifique o motivo do cancelamento. Você pode dizer algo como: "Mudei de ideia", "Não preciso mais", "Quero comprar outro item", "Entrega atrasada", "Comprei por engano", "Quero mudar a forma de pagamento" ou outras opções.
Quero comprar outro item
Agradecemos por nos informar.

Quer cancelar outro produto?
não
Para compras feitas usando sua carteira, os reembolsos são creditados na carteira ou na conta de crédito da Google Store. O reembolso vai levar de três a cinco dias úteis para aparecer na sua conta. O valor do reembolso não inclui as taxas de frete e manuseio.

Cancelar o pedido inteiro

O usuário final foi autenticado anteriormente. O agente confirma que o usuário quer cancelar um pedido específico e coleta o motivo do cancelamento. O agente verifica o método de pagamento original e confirma os detalhes do cancelamento com o usuário.

Entrada do usuário Resposta do agente
Você está ligando sobre o pedido mais recente com o número 12345 e uma camisa, feito em 10/11/2023 às 18h?
não
Quer cancelar outro pedido?
sim
Poderia informar os últimos cinco dígitos do ID do pedido que você quer rastrear?
12346
Os últimos cinco dígitos do ID do pedido que recebemos são 12346, certo?
sim
Ótimo, já coletamos o código do pedido.

Você quer cancelar o pedido inteiro?
sim
Especifique o motivo do cancelamento. Você pode dizer algo como: "Mudei de ideia", "Não preciso mais", "Quero comprar outro item", "Entrega atrasada", "Comprei por engano", "Quero mudar a forma de pagamento" ou outras opções.
não é mais necessário
Agradecemos por nos informar.

Sua solicitação de cancelamento foi gerada.

Convenções de nomenclatura

Esse componente predefinido usa as seguintes convenções de nomenclatura:

Recurso Formato Exemplo
Fluxo [Nome do componente] Cancelar pedido
Tipo da entidade prebuilt_components_[component_name]_[entity_type] prebuilt_components_product_cancel_reason
Webhook prebuilt_components_[component_name]:[webhook_action] prebuilt_components_cancel_order:post_cancellation_details

Parâmetros de entrada

Os parâmetros de entrada são usados para configurar determinados comportamentos do componente. Os parâmetros serão usados por uma ou mais condições no fluxo para determinar como o componente vai se comportar. Os parâmetros no escopo do fluxo precisam ser definidos na página inicial do componente. Os parâmetros no escopo da sessão podem ser definidos por um fluxo de chamada ou na página inicial do componente.

Esse componente predefinido aceita os seguintes parâmetros de entrada:

Nome do parâmetro Descrição Formato da entrada
$session.params.phone_number (opcional) Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
$session.params.all_recent_order_id (opcional) Lista os IDs de pedidos associados ao usuário autenticado, classificados em ordem decrescente pela data de realização do pedido. O primeiro elemento da matriz representa o pedido mais recente. Se um usuário não tiver pedidos, o valor desse parâmetro será null. Lista (string)
$session.params.email (opcional) O e-mail registrado na conta. string
$session.params.user_first_name (opcional) O nome do usuário, usado para cumprimentar e confirmar a propriedade da conta. string

Esse componente predefinido permite que os parâmetros opcionais a seguir configurem o comportamento do componente, incluindo as novas tentativas.

Nome do parâmetro Descrição Formato
$flow.max_retry_another_account_counter Especifica o número de novas tentativas permitidas ao selecionar se você quer continuar com uma conta alternativa. O valor padrão é 2. integer
$flow.max_retry_order_number Especifica o número de novas tentativas permitidas ao informar os últimos cinco dígitos de um número de pedido. O valor padrão é 2. integer
$flow.max_retry_another_order Especifica o número de novas tentativas permitidas ao selecionar outro pedido nos casos em que o ID do pedido não é encontrado ou o pedido não está qualificado para cancelamento. O valor padrão é 2. integer
$flow.max_retry_select_order_number Especifica o número de novas tentativas permitidas ao fornecer o número completo do pedido em casos em que vários pedidos compartilham os mesmos cinco dígitos finais. O valor padrão é 2. integer
$flow.max_product_display_counter Especifica o número máximo de produtos a serem apresentados em uma única vez. O valor padrão é 2. integer
$flow.max_product_display Especifica o número máximo de produtos a serem apresentados durante toda a conversa. O valor padrão é 9. integer
$flow.max_retry_product_number_counter Especifica o número máximo de novas tentativas permitidas ao selecionar um produto para cancelamento. O valor padrão é 2. integer
$flow.max_product_cancel_confirm_counter Especifica o número máximo de novas tentativas permitidas ao confirmar o produto selecionado. O valor padrão é 2. integer
$flow.max_retry_select_quantity Especifica o número máximo de novas tentativas permitidas ao selecionar a quantidade de produto a ser cancelada. O valor padrão é 2. integer
$flow.order_product_cancel_reason_others Especifica o valor da entidade prebuilt_components_product_cancel_reason, indicando que o usuário selecionou "outros" como motivo do cancelamento. O valor padrão é "others". string
$flow.max_retry_cancel_reason Especifica o número de novas tentativas permitidas ao confirmar o motivo do cancelamento. O valor padrão é 2. integer
$flow.order_payment_mode_COD Especifica o valor do campo order_payment_mode retornado pelo webhook get_order_details, indicando uma forma de pagamento contra entrega (COD). O valor padrão é "COD". string
$flow.order_payment_mode_store_credit Especifica o valor do campo order_payment_mode retornado pelo webhook get_order_details, indicando uma forma de pagamento de crédito da Google Store. O valor padrão é "store_credit". string

Para configurar os parâmetros de entrada desse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Build.
  5. Clique no componente importado na seção Fluxos.
  6. Clique na página inicial na seção Páginas.
  7. Clique na rota true na página inicial.
  8. Na janela "Rota", edite os valores das configurações predefinidas de parâmetros conforme necessário.
  9. Clique em Salvar.

Parâmetros de saída

Os parâmetros de saída são parâmetros de sessão que permanecem ativos após a saída do componente. Esses parâmetros contêm informações importantes coletadas pelo componente. Esse componente predefinido fornece valores para os seguintes parâmetros de saída:

Nome do parâmetro Descrição Formato da saída
phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
all_recent_order_id Esse parâmetro lista os IDs de pedidos associados ao usuário autenticado, classificados pela data de realização do pedido em ordem decrescente. O primeiro elemento da matriz representa o pedido mais recente. Se um usuário não tiver pedidos, o valor desse parâmetro será null. Lista (string)
e-mail O e-mail registrado na conta. string
user_first_name O nome do usuário, usado para cumprimentar e confirmar a propriedade da conta. string
transfer_reason Esse parâmetro indica o motivo da saída do fluxo, se não foi bem-sucedido. O valor retornado é um destes:

agent: o usuário final solicitou um agente humano em algum momento durante a conversa.

denial_of_information: o usuário final recusou-se a compartilhar as informações solicitadas pelo componente.

max_no_input: a conversa atingiu o número máximo de novas tentativas para eventos sem entrada. Consulte Eventos integrados sem entrada.

max_no_match: a conversa atingiu o número máximo de novas tentativas para eventos sem correspondência. Consulte Eventos integrados sem correspondência.

webhook_error: ocorreu um erro de webhook. Consulte webhook.error built-in event.

webhook_not_found: um URL de webhook não pode ser acessado. Consulte Webhook.error.not-found.
string

Geradores

Esse componente usa Geradores para ativar partes específicas da conversa.

Resumo

O gerador Summarization é usado para gerar um resumo pós-chamada que descreve a conversa processada pelo componente.

Configuração básica

Para configurar esse componente pré-criado:

  1. Importe o componente pré-criado.
  2. Configure os webhooks flexíveis fornecidos com a configuração que descreve seus serviços externos. Consulte a configuração de webhook.

Configuração do webhook

Para usar esse componente, você precisa configurar os webhooks flexíveis incluídos para extrair as informações necessárias dos seus serviços externos.

Autenticação

Se você não tiver configurado os serviços externos necessários para a autenticação, será necessário fazer isso para ativar a autenticação de usuários para esse componente. Consulte Configuração do webhook de autenticação de varejo para ver instruções detalhadas.

Confira detalhes dos pedidos

O webhook prebuilt_components_cancel_order:get_order_details é usado pelo componente para recuperar detalhes de um pedido específico.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$flow.order_id O ID do pedido para extrair detalhes. string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
order_date Data em que o pedido foi feito, no formato YYYY-MM-DD. string
order_time Hora em que o pedido foi feito, no formato HH:MM. string
order_product_count O número de produtos únicos em um pedido. integer
order_payment_mode Indica o modo de pagamento usado ao fazer o pedido. string
cancelable_product_id Lista de IDs de produtos canceláveis no pedido. Lista (string)
cancelable_product_name Lista de nomes de produtos canceláveis no pedido. Lista (string)
cancelable_product_brand_name Lista de nomes de marcas de produtos canceláveis no pedido. Lista (string)
cancelable_product_quantity Lista de quantidades de produtos canceláveis no pedido. Lista (string)

Para configurar o webhook "Pegar detalhes do pedido" para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_cancel_order:get_order_details.
  7. Substitua o URL no campo URL do webhook dos agentes de conversação (Dialogflow CX) pelo endpoint do serviço que você quer integrar. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para formar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do seu webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de autenticação conforme necessário.
  11. Clique em Salvar.

Conferir detalhes de pedidos duplicados

O webhook prebuilt_components_retail_services:get_duplicate_order_details é usado pelo componente para extrair informações detalhadas e distinguir entre pedidos quando vários números de pedidos têm os mesmos cinco últimos dígitos.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$flow.duplicate_order_id Lista com os últimos cinco dígitos dos números de pedidos compartilhados entre um ou mais pedidos do usuário. Lista (string)

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
all_order_date Lista de datas de pedidos duplicados com os últimos cinco dígitos especificados no formato YYYY-MM-DD. Cada elemento dessa matriz corresponde ao mesmo elemento na matriz all_order_time. Lista (string)
all_order_time Lista de horários de pedidos para pedidos duplicados com os últimos cinco dígitos especificados no formato HH:MM. Cada elemento dessa matriz corresponde ao mesmo elemento na matriz all_order_date. Lista (string)

Para configurar o webhook "Pegar detalhes de pedidos duplicados" para este componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_retail_services:get_duplicate_order_details.
  7. Substitua o URL no campo URL do webhook dos agentes de conversação (Dialogflow CX) pelo endpoint do serviço que você quer integrar. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para formar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do seu webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de autenticação conforme necessário.
  11. Clique em Salvar.

Detalhes do cancelamento da postagem

O webhook prebuilt_components_cancel_order:post_cancellation_details é usado pelo componente para enviar uma solicitação de cancelamento.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$session.params.phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
$flow.order_id O código do pedido para enviar um tíquete. string
$flow.cancel_product_id_list Lista de IDs de produtos que o usuário quer cancelar. Lista (string)
$flow.cancel_product_quantity_list Lista de quantidades de produtos que o usuário quer cancelar, correspondendo a cada elemento em $flow.cancel_product_id_list. Lista (string)
$flow.cancel_reason_list Lista de motivos de cancelamento para cada produto cancelado, correspondente a cada elemento em $flow.cancel_product_id_list. Lista (string)
$flow.order_refund_mode A forma de pagamento do reembolso. Os valores válidos são definidos pela entidade prebuilt_components_cancel_mode_of_refund. string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
order_cancellation_ticket_id ID do ingresso do cancelamento enviado. string

Para configurar o webhook "Post cancellation details" para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_cancel_order:post_cancellation_details.
  7. Substitua o URL no campo URL do webhook dos agentes de conversação (Dialogflow CX) pelo endpoint do serviço que você quer integrar. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para formar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do seu webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de autenticação conforme necessário.
  11. Clique em Salvar.

Concluído

Seu agente e os webhooks dele estão configurados e prontos para testes.