Componente pré-criado de troca de pedidos

O componente predefinido da ordem de troca 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 trocar vários itens de um pedido e selecionar opções, incluindo métodos de reembolso e envio. Esse componente usa o componente pré-criado Autenticação de varejo para autenticar usuários. O componente também usa Geradores para resumo pós-chamada e perguntas frequentes.

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.

Troca de item com defeito na loja

O usuário final foi autenticado anteriormente. O agente confirma quais itens do pedido mais recente precisam ser trocados e coleta o motivo da troca. O usuário escolhe trocar os itens em uma loja, e o agente fornece uma lista das lojas mais próximas. O usuário seleciona uma loja, e o agente gera um rótulo para envio que é enviado aos canais registrados do usuário.

Entrada do usuário Resposta do agente
Você está ligando sobre o número do pedido mais recente, que termina em 12375 e contém duas lâmpadas, dois Pixel e outros 10 produtos feitos em 10/11/2023?
sim
Encontramos alguns produtos qualificados no seu pedido. Informe qual produto você quer trocar. Produto 1: luminária Google, Produto 2: Google Pixel, Produto 3: luminária LED Google.

Diga ou insira o número do produto que você quer selecionar ou diga "Próxima" para mostrar mais produtos.
1
Para confirmar, você tem interesse em trocar a lâmpada do Google. É isso mesmo?
sim
A quantidade disponível do produto selecionado é 2. Especifique a quantidade de produtos que você quer trocar.
Dois
Especifique o motivo da troca. Você pode dizer algo como: "O item está com defeito ou não funciona", "Problema de tamanho ou ajuste", "Problema de pedido incompleto", "Problema de estilo", "Cor incorreta" ou "Outros".
Item com defeito
Agradecemos por nos informar.

Como última etapa, como você gostaria de trocar o produto? Você pode dizer algo como: "Troque na loja" ou "Agendamento para retirada".
Quero fazer a troca em uma loja
Vamos encontrar uma loja perto de você.
O agente coleta o CEP usando o componente predefinido Coletar CEP
Aqui está a lista de locais próximos ao CEP que você informou.
Endereço 1: Google Texas, 500 W 2nd St, Suite 2900 Austin, Texas 78701, EUA.
Endereço 2: Google California, 19510 Jamboree Road, Irvine, California 92612, EUA.

Diga ou insira o número do endereço que você quer selecionar ou diga "próximo" para mostrar mais endereços de lojas.
A primeira loja
Para confirmar, você selecionou Google Texas, 500 W 2nd St, Suite 2900 Austin, Texas 78701, EUA. É isso mesmo?
sim
Perfeito. Enviamos um rótulo para envio e um número de tíquete para seu número de telefone e e-mail registrados. Imprima, anexe ao pacote e entregue a troca em até 30 dias. Depois que recebermos o item no depósito, vai levar de 3 a 5 dias úteis para que a troca, se houver, apareça na sua conta. Observação: o valor do reembolso não inclui as taxas de frete e manuseio.

O produto de troca tem um valor maior. A diferença de preço é de US$ 20. Você vai receber o link de pagamento em breve no seu número de celular registrado. Faça o pagamento em até 24 horas para fazer a troca.

Quer trocar outro pedido?
não, tudo bem
Agradecemos sua ligação.

Reembolso por diferença de preço

O usuário final foi autenticado anteriormente. O agente coleta o número do pedido, o produto a ser trocado e o motivo da troca. O usuário opta por trocar os itens por um tamanho diferente e agenda uma retirada. O agente identifica que o item trocado tem um preço menor do que o novo item e confirma com o usuário o método de pagamento para um reembolso.

Entrada do usuário Resposta do agente
Você está ligando sobre o pedido mais recente com o número 12345 e duas lâmpadas, feito em 10/11/2023?
Não
Quer trocar outro pedido?
Sim
Poderia informar os últimos cinco dígitos do ID do pedido que você quer trocar?
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.

Encontramos alguns produtos qualificados no seu pedido. Informe qual produto você quer trocar. Produto 1: garrafa d'água do Google, produto 2: camiseta do Google.

Diga ou insira o número do produto que você quer selecionar ou diga "Próxima" para mostrar mais produtos.
Dois
Para verificar, você tem interesse em trocar a camiseta do Google por uma troca. É isso mesmo?
Sim
Especifique o motivo da troca. Você pode dizer algo como: "O item está com defeito ou não funciona", "Problema de tamanho ou ajuste", "Problema de pedido incompleto", "Problema de estilo", "Cor incorreta" ou "Outros".
Problema de tamanho ou encaixe
Agradecemos por nos informar o motivo da troca. Você pode informar o tamanho que gostaria de trocar? Temos os seguintes tamanhos disponíveis:
Diga 1 para pequeno.
Diga 2 para médio.
Diga 3 para grande.
Diga 4 para GG.
Diga 5 para tamanho duplo GG.
1
Como última etapa, como você quer trocar o produto? Você pode dizer algo como: "Troque na loja" ou "Agendamento para retirada".
Agendar retirada
Perfeito. Enviamos um rótulo para envio para seu número de telefone e e-mail registrados. Imprima e anexe ao pacote. Nossa equipe vai entrar em contato com você nas próximas 24 a 48 horas para agendar a retirada. Depois que recebermos o item no nosso depósito, vai levar de 3 a 5 dias úteis para que o reembolso da troca apareça na sua conta.

O produto trocado é de valor inferior, e você tem direito a um reembolso de US$ 5.
Informe onde você quer receber o reembolso. Você pode dizer algo como "crédito da loja" ou "conta de origem".
Crédito da Google Store
Agradecemos por confirmar que você quer que o reembolso seja devolvido à carteira.

Você quer trocar outro pedido?
não
Agradecemos sua ligação.

Pedido não qualificado

O usuário final foi autenticado anteriormente. O agente verifica o pedido mais recente e descobre que não há produtos qualificados para troca. O agente coleta um número de pedido do usuário e descobre que o pedido fornecido não tem produtos qualificados.

Entrada do usuário Resposta do agente
Não encontramos produtos no seu pedido mais recente que possam ser trocados.

Quer trocar outro pedido?
sim
Poderia informar os últimos cinco dígitos do ID do pedido que você quer trocar?
23487
Os últimos cinco dígitos do ID do pedido que recebemos são 23487, certo?
sim
Ótimo, já coletamos o ID do pedido.
Não há produtos no seu pedido que possam ser trocados com base nas nossas políticas. Confira mais informações sobre nossa política de trocas no nosso site.

Deseja trocar outro pedido?
não
Agradecemos sua ligação.

Convenções de nomenclatura

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

Recurso Formato Exemplo
Fluxo [Nome do componente] Status do pedido
Tipo da entidade prebuilt_components_[component_name]_[entity_type] prebuilt_components_exchange_order_location
Webhook prebuilt_components_[component_name]:[webhook_action] prebuilt_components_exchange_order:get_product_exchange_availability

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 Especifica o número de novas tentativas permitidas ao selecionar se você quer continuar com uma conta alternativa. O valor padrão é 3. 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 é 3. integer
$flow.max_retry_another_order Especifica o número de novas tentativas permitidas ao selecionar outro pedido para devolução nos casos em que o ID do pedido não é encontrado ou o pedido não está qualificado para a troca. 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 nos casos em que mais de um pedido compartilha os mesmos cinco últimos dígitos. O valor padrão é 2. integer
$flow.max_retry_exchange_reason Especifica o número de novas tentativas permitidas ao informar o motivo da troca. O valor padrão é 3. integer
$flow.max_retry_exchange_reason_counter Especifica o número de novas tentativas permitidas ao confirmar o motivo da troca. O valor padrão é 2. integer
$flow.order_product_exchange_reason_others Especifica o valor da entidade prebuilt_components_exchange_order_reason, indicando que o usuário selecionou "outros" como motivo da troca. O valor padrão é "others". string
$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_product_exchange_confirm Especifica o número máximo de novas tentativas permitidas ao confirmar o produto selecionado. O valor padrão é 2. integer
$flow.max_retry_product_number_counter Especifica o número máximo de novas tentativas permitidas ao selecionar um produto para troca. O valor padrão é 3. integer
$flow.max_retry_select_quantity Especifica o número máximo de novas tentativas permitidas ao selecionar a quantidade de produtos a serem trocados. O valor padrão é 2. integer
$flow.max_retry_size_number_counter Especifica o número máximo de novas tentativas permitidas ao selecionar o tamanho a ser trocado. O valor padrão é 2. integer
$flow.max_retry_another_zip_code Especifica o número máximo de novas tentativas permitidas ao informar um CEP. O valor padrão é 2. integer
$flow.max_store_display_counter Especifica o número máximo de lojas a serem apresentadas em uma única jogada. O valor padrão é 1. integer
$flow.max_store_display Especifica o número máximo de lojas a serem apresentadas durante toda a conversa. O valor padrão é 10. integer
$flow.max_retry_store_number_counter Especifica o número máximo de novas tentativas permitidas ao selecionar uma loja. O valor padrão é 2. integer
$flow.max_retry_store_selection Especifica o número de novas tentativas permitidas ao confirmar a seleção da loja. O valor padrão é 3. integer
$flow.max_available_address_reselection_counter Especifica o número de novas tentativas permitidas ao confirmar se o usuário quer selecionar um endereço de loja diferente. 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
$flow.order_refund_mode_source_account Especifica o valor da entidade prebuilt_components_exchange_order_refund_mode, indicando que o usuário selecionou o reembolso para a conta de origem. O valor padrão é source_account. string
$flow.order_exchange_location_scheduled_for_pickup Especifica o valor da entidade prebuilt_components_exchange_order_location, indicando que o usuário selecionou a opção de agendar uma retirada para a troca. O valor padrão é scheduled_for_pickup. 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 built-in event.
string

Geradores

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

Perguntas frequentes

O gerador de FAQ é usado para lidar com perguntas frequentes sobre devoluções e trocas, incluindo:

  • Existe um prazo para o processo de devolução?
  • Posso trocar um item de presente?
  • O preço do produto e o valor do reembolso são diferentes. Por quê?

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_exchange_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_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
exchangeable_product_id Lista de IDs de produtos para produtos trocáveis no pedido. Lista (string)
exchangeable_product_name Lista de nomes de produtos para troca no pedido. Lista (string)
exchangeable_product_brand_name Lista de nomes de marcas de produtos trocáveis no pedido. Lista (string)
exchangeable_product_quantity Lista de quantidades de produtos trocáveis no pedido. Lista (string)
exchangeable_product_price Lista de preços dos produtos que podem ser trocados 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_exchange_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.

Receber o tamanho da troca disponível

O webhook prebuilt_components_exchange_order:get_available_exchange_size é usado pelo componente para recuperar os tamanhos disponíveis para troca nos casos em que o usuário quer trocar um item devido a problemas de tamanho ou ajuste.

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.selected_order_product_id ID do produto que o usuário quer trocar. 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
product_available_sizes Lista de tamanhos disponíveis para o produto selecionado. Lista (string)

Para configurar o webhook "Pegar tamanhos de troca disponíveis" 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_exchange_order:get_available_exchange_size.
  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 a disponibilidade de troca de produtos

O webhook prebuilt_components_exchange_order:get_product_exchange_availability é usado pelo componente para verificar se o produto, a quantidade e o tamanho opcional selecionados pelo usuário estão disponíveis para troca.

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
$flow.selected_order_product_id ID do produto que o usuário quer trocar. string
$flow.order_product_quantity_exchange_count Quantidade do produto que o usuário quer trocar. integer
$flow.product_selected_size Tamanho do produto que o usuário quer trocar. 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
product_exchange_availability Indica se o produto, a quantidade e o tamanho selecionados estão disponíveis para troca. booleano
product_exchange_price Indica o preço de troca de um único item do produto e tamanho selecionados. number

Para configurar o webhook "Get product exchange availability" 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_exchange_order:get_product_exchange_availability.
  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.

Criar um tíquete de pedido incompleto

O webhook prebuilt_components_exchange_order:raise_incomplete_order_ticket é usado pelo componente para gerar um tíquete quando o usuário quer trocar um produto em um pedido por ele estar incompleto.

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 ID do pedido para o qual você quer enviar um tíquete. string
$flow.selected_order_product_id ID do produto que o usuário quer trocar. string
$flow.order_product_quantity_exchange_count Quantidade do produto que o usuário quer trocar. integer
$flow.order_product_exchange_reason O motivo pelo qual o usuário quer trocar o produto. string

Para configurar o webhook de ordem de solicitação incompleta do Raise 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_exchange_order:raise_incomplete_order_ticket.
  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 da loja

O webhook prebuilt_components_exchange_order:get_store_details é usado pelo componente para recuperar a lista de lojas perto do CEP fornecido pelo usuário.

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.zip_code CEP para pesquisar lojas nas proximidades. 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
store_id Lista de IDs de lojas. Lista (string)
store_address Lista de endereços de lojas correspondentes a cada elemento de store_id. Lista (string)

Para configurar o webhook "Pegar detalhes da loja" 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_exchange_order:get_store_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 da postagem da troca

O webhook prebuilt_components_exchange_order:post_exchange_details é usado pelo componente para enviar uma troca.

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 ID do pedido para o qual você quer enviar um tíquete. string
$flow.selected_order_product_id ID do produto que o usuário quer trocar. string
$flow.order_product_quantity_exchange_count Quantidade do produto que o usuário quer trocar. integer
$flow.product_selected_size Tamanho do produto que o usuário quer trocar. string
$flow.order_product_exchange_reason O motivo pelo qual o usuário quer trocar o produto. string
$flow.order_exchange_location O modo selecionado para a troca. Os valores válidos são definidos pela entidade prebuilt_components_exchange_order_location. string
$flow.order_exchange_store_id O ID da loja selecionada pelo usuário para uma troca. string
$flow.order_refund_mode O modo de pagamento do reembolso, se aplicável. Os valores válidos são definidos pela entidade prebuilt_components_exchange_order_refund_mode. Se nenhum reembolso for necessário, esse valor será null. string
$flow.total_refund_amount O valor a ser reembolsado, se o preço do produto a ser trocado for maior do que o do novo produto. Se nenhum reembolso for necessário, esse valor será null. integer

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_exchange_ticket_id ID do ingresso da troca enviada. string

Para configurar o webhook de detalhes da postagem de trocas 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_exchange_order:post_exchange_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.

Enviar informações de reembolso de pagamento na entrega

O webhook prebuilt_components_exchange_order:send_COD_refund_information é usado pelo componente para enviar informações de pagamento relacionadas à troca para um usuário.

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 ID do pedido para o qual você quer enviar um tíquete. string
$flow.channel O canal específico para enviar informações. Os valores válidos são definidos pela entidade prebuilt_components_channel_email_phone. Por padrão, phone e email são aceitos. string

Para configurar o webhook de envio de informações de reembolso de pagamento na entrega 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_exchange_order:send_COD_refund_information.
  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.