Componente pré-criado de troca de pedidos

O componente pré-criado de pedido 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 optar por trocar vários itens em um pedido e selecionar opções, incluindo métodos de reembolso e envio. Esse componente usa o componente pré-criado de autenticação de varejo para autenticar usuários. O componente também usa geradores para resumos pós-chamada e perguntas frequentes.

Limitações

Além das limitações comuns de componentes pré-criados, este componente tem as seguintes limitações:

• Esse componente não criptografa dados.

Diálogos de exemplo

Os exemplos de diálogos 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 na loja de item com defeito

O usuário final já foi autenticado. O agente confirma quais itens do pedido mais recente devem 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 pedido mais recente, que termina com 12375, contém 2 lâmpadas, 2 Pixels e 10 outros produtos e foi feito em 10/11/2023?
sim
	Encontramos alguns produtos qualificados no seu pedido. Informe qual produto você quer trocar. Produto 1: lâmpada do Google, Produto 2: Google Pixel, Produto 3: luz de LED do Google. Diga ou digite o número do item que você quer selecionar ou diga "próximo" para mostrar mais produtos.
1
	Para confirmar, você quer 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: item 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 o aviso. Como última etapa, como você quer trocar o produto? Você pode dizer algo como: "Trocar em uma loja" ou "Agendar para retirada".
Quero trocar em uma loja
	Vamos encontrar uma loja perto de você.
	O agente coleta o CEP usando o componente pré-criado Coleta de CEP
	Esta é a lista de locais perto do 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 digite 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 o número do tíquete para o telefone e o e-mail registrados. Imprima e anexe o rótulo ao pacote e entregue o item para troca em até 30 dias. Depois que recebermos o item no nosso 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 movimentação. 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 realizar a troca. Quer trocar outro pedido?
Não, é só isso.
	Agradecemos sua ligação.

Reembolso por diferença de preço

O usuário final já foi autenticado. 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 a forma de pagamento para um reembolso.

Entrada do usuário	Resposta do agente
	Você está ligando sobre o pedido mais recente com final 12345, que contém 2 lâmpadas e foi feito em 10/11/2023?
Não
	Quer trocar outro pedido?
Sim
	Informe os últimos 5 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, correto?
Sim
	Pronto, já coletamos o código do pedido. Encontramos alguns produtos qualificados no seu pedido. Informe qual produto você quer trocar. Produto 1: garrafa de água do Google, Produto 2: camiseta do Google. Diga ou digite o número do produto que você quer selecionar ou diga "próximo" para mostrar mais produtos.
Dois
	Para confirmar, você quer trocar a camiseta do Google. É isso mesmo?
Sim
	Especifique o motivo da troca. Você pode dizer algo como: item com defeito ou não funciona, problema de tamanho ou ajuste, problema de pedido incompleto, problema de estilo, cor incorreta ou outros.
Problema de encaixe ou tamanho
	Agradecemos por informar o motivo da troca. Informe o tamanho que você quer receber. 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 XG.
1
	Como última etapa, como você quer trocar o produto? Você pode dizer algo como: "Trocar em uma loja" ou "Agendar para retirada".
Programar para retirada
	Perfeito. Enviamos um rótulo para envio ao número de telefone e e-mail registrados. Imprima e anexe-a ao pacote. Nossa equipe vai entrar em contato com você nas próximas 24 a 48 horas para agendar uma 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 tem um valor menor, e você se qualifica para um reembolso de US$ 5. Informe onde você quer receber o reembolso. Você pode dizer algo como "crédito da Google Store" ou "conta de origem".
Crédito da Google Store
	Agradecemos por confirmar que você quer receber o reembolso na carteira. Quer trocar outro pedido?
não
	Agradecemos sua ligação.

Pedido não qualificado

O usuário final já foi autenticado. 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 nenhum produto no seu pedido mais recente que possa ser trocado. Quer trocar outro pedido?
sim
	Informe os últimos 5 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, correto?
sim
	Ótimo, já temos o ID do pedido.
	Infelizmente, nenhum produto do seu pedido está qualificado para troca com base nas nossas políticas. Você encontra mais informações sobre nossa política de troca no site. Quer trocar outro pedido?
não
	Agradecemos sua ligação.

Convenções de nomenclatura

Este componente pré-criado usa as seguintes convenções de nomenclatura:

Recurso	Formatar	Exemplo
Flow	[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 deve se comportar. Os parâmetros com escopo de 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 desse componente.

Esse componente pré-criado 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) Esse parâmetro lista os códigos de pedido 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)
$session.params.email	(Opcional) O e-mail registrado na conta.	string
$session.params.user_first_name	(Opcional) Nome do usuário, usado para cumprimentar e confirmar a propriedade da conta.	string

Esse componente pré-criado permite que os seguintes parâmetros opcionais configurem o comportamento do componente, incluindo novas tentativas.

Nome do parâmetro	Descrição	Formatar
$flow.max_retry_another_account	Especifica o número de novas tentativas permitidas ao selecionar se quer continuar com uma conta alternativa. O valor padrão é 3.	integer
$flow.max_retry_order_number	Especifica o número de tentativas permitidas ao fornecer 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 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 tentativas permitidas ao fornecer o número completo do pedido nos casos em que mais de um pedido tem 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 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 que indica 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 que podem ser 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 para troca. 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 para troca. O valor padrão é 2.	integer
$flow.max_retry_another_zip_code	Especifica o número máximo de tentativas permitidas ao fornecer 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 vez. 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 da 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 que indica uma forma de pagamento na entrega (COD, na sigla em inglês). 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 que indica uma forma de pagamento com 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 que indica 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 que indica que o usuário selecionou o agendamento de 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 de Predefinições 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 sair do componente. Esses parâmetros contêm informações importantes coletadas pelo componente. Esse componente pré-criado 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 códigos de pedido 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	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 tiver sido bem-sucedido. O valor retornado é um dos seguintes: agent: o usuário final solicitou um agente humano em algum momento da conversa. denial_of_information: o usuário final se recusou 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 o evento integrado webhook.error. webhook_not_found: um URL do webhook estava inacessível. Consulte o evento integrado webhook.error.not-found.	string

Geradores

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

Perguntas frequentes

O gerador 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 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 do webhook.

Configuração do webhook

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

Autenticação

Se você ainda não configurou os serviços externos necessários para autenticação, será preciso configurá-los para ativar a autenticação de usuários para esse componente. Consulte Configuração do webhook de autenticação do Retail para instruções detalhadas.

Confira detalhes dos pedidos

O webhook prebuilt_components_exchange_order:get_order_details é usado pelo componente para recuperar os 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	Código do pedido que terá os detalhes recuperados.	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 exclusivos em um pedido.	integer
order_payment_mode	Indica a forma de pagamento usada ao fazer o pedido.	string
exchangeable_product_id	Lista de IDs de produtos que podem ser trocados no pedido.	Lista (string)
exchangeable_product_name	Lista de nomes de produtos que podem ser trocados no pedido.	Lista (string)
exchangeable_product_brand_name	Lista de nomes de marcas de produtos que podem ser trocados no pedido.	Lista (string)
exchangeable_product_quantity	Lista de quantidades de produtos que podem ser trocados 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 "Receber 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 do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o corpo da solicitação para criar 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 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.

Ver detalhes de pedidos duplicados

O webhook prebuilt_components_retail_services:get_duplicate_order_details é usado pelo componente para recuperar informações detalhadas e distinguir pedidos quando vários números de pedido têm os mesmos últimos cinco 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 nessa matriz corresponde ao mesmo elemento na matriz all_order_time.	Lista (string)
all_order_time	Lista de horários de pedidos duplicados com os últimos cinco dígitos especificados no formato HH:MM. Cada elemento nessa matriz corresponde ao mesmo elemento na matriz all_order_date.	Lista (string)

Para configurar o webhook "Receber detalhes de pedidos duplicados" 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_retail_services:get_duplicate_order_details.
7. Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o corpo da solicitação para criar 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 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 disponível da troca

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 "Receber tamanho de troca disponível" 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 do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o corpo da solicitação para criar 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 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.

Verificar a disponibilidade de troca do produto

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	Código do pedido que terá os detalhes recuperados.	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.	número

Para configurar o webhook "Receber disponibilidade de troca de produtos" 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_product_exchange_availability.
7. Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o corpo da solicitação para criar 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 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 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 porque ele está 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	Código do pedido para 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 "Criar tíquete de pedido incompleto" 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 do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o corpo da solicitação para criar 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 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.

Acessar detalhes da loja

O webhook prebuilt_components_exchange_order:get_store_details é usado pelo componente para recuperar a lista de lojas próximas ao 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 próximas.	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 da loja correspondentes a cada elemento de store_id.	Lista (string)

Para configurar o webhook "Receber 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 do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o corpo da solicitação para criar 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 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 troca de postagens

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	Código do pedido para 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 para 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, o valor será null.	string
$flow.total_refund_amount	O valor a ser reembolsado, se o preço do produto trocado for maior que o do novo produto. Se nenhum reembolso for necessário, o 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 tíquete da troca enviada.	string

Para configurar o webhook de detalhes da troca de postagens 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 do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o corpo da solicitação para criar 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 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 COD

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	Código do pedido para 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 informações de reembolso de COD para esse componente, expanda para ver 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 do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o corpo da solicitação para criar 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 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 agora devem estar configurados e prontos para teste.