O componente predefinido de status de pedido verifica o nível de autenticação de um cliente e fornece informações sobre os pedidos mais recentes ou anteriores do usuário a um cliente autenticado. 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.
Pedido recente
O usuário final liga de um número não registrado. O agente autentica o usuário e fornece informações detalhadas sobre os envios no pedido. O usuário confirma que gostaria de receber um SMS no número de telefone registrado com mais detalhes.
| Entrada do usuário | Resposta do agente |
|---|---|
| O agente autentica o usuário usando o componente predefinido de Autenticação de varejo | |
| Certo, John. Você está ligando sobre o pedido mais recente de João da Silva, que contém uma luminária, uma camisa e outros 10 itens feitos em 10/11/2023 às 18h? | |
| Sim | |
| Seu pedido tem 2 remessas, que serão entregues até 2024-01-15. Quer saber mais sobre essas remessas? |
|
| Sim | |
| O Envio 1, que contém jeans, cinto e outros dois itens, está em trânsito e será entregue até 12/01/2024. O Envio 2, que contém uma lâmpada, uma camisa e outros seis itens, foi entregue em 12/11/2023. Você quer receber um SMS com mais detalhes sobre seus itens? |
|
| Sim | |
| Enviamos um SMS com um link para acompanhar o status de todos os seus envios. Agradecemos sua ligação. |
Pedidos duplicados
O usuário final foi autenticado anteriormente. O usuário solicita informações sobre um pedido e fornece os últimos cinco dígitos dele. O agente identifica que vários pedidos feitos pelo usuário têm os mesmos cinco últimos dígitos. Por isso, ele confirma qual pedido o usuário quer saber o status e informa o status do pedido.
| Entrada do usuário | Resposta do agente |
|---|---|
| Certo, Amber. Você está ligando sobre o pedido mais recente de Amber Doe, que contém uma luminária, uma camisa e outros dois itens feitos em 10/11/2023 às 18h? | |
| Não | |
| Poderia informar os últimos cinco dígitos do ID do pedido que você quer rastrear? | |
| 12355 | |
| Os últimos cinco dígitos do ID do pedido que recebemos são 12355, certo? | |
| Sim, está correto | |
| Ótimo, já coletamos o ID do pedido. | |
| De acordo com nossos registros, encontramos dois pedidos que terminam com os mesmos cinco dígitos 12355. Qual pedido você está procurando? O número 1, feito em 2023-11-10 às 18h, ou o número 2, feito em 2023-11-09 às 20h? Para selecionar o pedido número 1, diga 1. Para selecionar o pedido número 2, diga 2. Caso contrário, diga "Não". |
|
| Pedir um | |
| Seu pedido tem 2 remessas, que serão entregues até 2024-01-15. Quer saber mais sobre essas remessas? |
|
| Sim | |
| O Frete 1, que contém jeans, está em trânsito e será entregue até 2024-01-15. O Frete 2, que contém uma lâmpada, uma camisa e mais um item, foi cancelado. Você quer receber um SMS com mais detalhes sobre seus itens? |
|
| Não, só isso. | |
| 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 |
| Webhook | prebuilt_components_[component_name]:[webhook_action] | prebuilt_components_order_status:get_order_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 |
| $flow.max_shipment | Especifica o número de envios mostrados ao usuário por vez. O valor padrão é 2. |
integer |
| $flow.tracking_status_delivered | Especifica o valor retornado pelo webhook indicando um status de pedido entregue. O valor padrão é "delivered". |
string |
| $flow.tracking_status_cancelled | Especifica o valor retornado pelo webhook indicando um status de pedido cancelado. O valor padrão é "cancelled". |
string |
| $flow.tracking_status_returned | Especifica o valor retornado pelo webhook indicando um status de devolução do pedido. O valor padrão é "returned". |
string |
| $flow.tracking_status_partially_returned | Especifica o valor retornado pelo webhook indicando um status de pedido parcialmente devolvido. O valor padrão é "partially returned". |
string |
| $flow.max_retry_alternate_profile | Especifica o número de novas tentativas permitidas ao solicitar o status do pedido de um número de telefone não registrado ou perfil alternativo. O valor padrão é 3. |
integer |
| $flow.max_retry_order_number | Especifica o número de novas tentativas permitidas ao fornecer um número de pedido. O valor padrão é 3. |
integer |
| $flow.max_retry_another_order_id | Especifica o número de novas tentativas permitidas após fornecer um número de pedido inválido. O valor padrão é 3. |
integer |
Para configurar os parâmetros de entrada desse componente, abra as instruções.
- Abra o console do Dialogflow CX.
- Escolha seu projeto do Google Cloud.
- Selecione seu agente.
- Selecione a guia Build.
- Clique no componente importado na seção Fluxos.
- Clique na página inicial na seção Páginas.
- Clique na rota true na página inicial.
- Na janela "Rota", edite os valores das configurações predefinidas de parâmetros conforme necessário.
- 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) |
| 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 |
Configuração básica
Para configurar esse componente pré-criado:
- Importe o componente pré-criado.
- 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_order_status: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_status | Indica o status do pedido. Exemplos de valores incluem "pending", "processing", "in-transit", "on-hold", "cancelled", "delivered", "returned", "partially returned". |
string |
| order_product_name | Lista de nomes de produtos no pedido. | Lista (string) |
| order_product_quantity | Contagem total do número de produtos encomendados para cada produto em um pedido. | integer |
| order_product_count | O número de produtos únicos em um pedido. | integer |
| order_status_notification | Indica se as notificações estão ativadas para esse pedido. | booleano |
| return_eligibility_date | Lista de datas até as quais cada produto no pedido pode ser devolvido, no formato YYYY-MM-DD. |
Lista (string) |
| order_customer_billing_name | Nome do cliente para faturamento do pedido. | string |
| order_latest_delivery_date | A data de entrega mais recente de todas as datas de entrega estimadas dos envios no pedido, no formato YYYY-MM-DD. |
string |
| order_shipment_multiple | Indica se o pedido contém vários envios. | booleano |
| order_shipment_count | O número de envios no pedido. | integer |
| order_shipment_product_count | Contagem total de produtos em cada envio no pedido. | Lista (número inteiro) |
| order_shipment_product_name | Lista dos nomes dos produtos em cada envio do pedido. | Lista (string) |
| order_estimated_delivery_date | Lista de datas de entrega estimadas para cada frete no pedido, no formato YYYY-MM-DD. |
Lista (string) |
| order_shipment_status | Lista que indica o status de cada envio no pedido. Exemplos de valores incluem "pending", "processing", "in-transit", "on-hold", "cancelled", "delivered", "returned", "partially returned". |
Lista (string) |
Para configurar o webhook "Pegar detalhes do pedido" para esse componente, abra as instruções.
- Abra o console do Dialogflow CX.
- Escolha seu projeto do Google Cloud.
- Selecione seu agente.
- Selecione a guia Gerenciar.
- Clique em Webhooks.
- Selecione o webhook prebuilt_components_order_status:get_order_details.
- 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.
- Revise e atualize o corpo da solicitação para formar o formato de solicitação adequado para seu webhook.
- 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.
- Revise e atualize as configurações de autenticação conforme necessário.
- Clique em Salvar.
Receber pedidos duplicados
O webhook prebuilt_components_retail_services:get_duplicate_order é 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. |
booleano |
| 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. |
number |
Para configurar o webhook "Pegar pedidos duplicados" para este componente, abra as instruções.
- Abra o console do Dialogflow CX.
- Escolha seu projeto do Google Cloud.
- Selecione seu agente.
- Selecione a guia Gerenciar.
- Clique em Webhooks.
- Selecione o webhook prebuilt_components_retail_services:get_duplicate_order.
- 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.
- Revise e atualize o corpo da solicitação para formar o formato de solicitação adequado para seu webhook.
- 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.
- Revise e atualize as configurações de autenticação conforme necessário.
- Clique em Salvar.
Enviar SMS
O webhook prebuilt_components_order_status:send_sms é usado
pelo componente para enviar detalhes do pedido para o número de telefone especificado usando SMS.
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 | ID do pedido para enviar detalhes. | string |
Para configurar o webhook de envio de SMS para esse componente, abra as instruções.
- Abra o console do Dialogflow CX.
- Escolha seu projeto do Google Cloud.
- Selecione seu agente.
- Selecione a guia Gerenciar.
- Clique em Webhooks.
- Selecione o webhook prebuilt_components_order_status:send_sms.
- 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.
- Revise e atualize o corpo da solicitação para formar o formato de solicitação adequado para seu webhook.
- 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.
- Revise e atualize as configurações de autenticação conforme necessário.
- Clique em Salvar.
Ativar notificações
O webhook prebuilt_components_order_status:enable_notification é usado
pelo componente para ativar as notificações do número de telefone registrado de 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_notification | Indica se as notificações precisam ser ativadas para o usuário. | booleano |
Para configurar o webhook "Ativar notificações" para este componente, abra as instruções.
- Abra o console do Dialogflow CX.
- Escolha seu projeto do Google Cloud.
- Selecione seu agente.
- Selecione a guia Gerenciar.
- Clique em Webhooks.
- Selecione o webhook prebuilt_components_order_status:enable_notification.
- 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.
- Revise e atualize o corpo da solicitação para formar o formato de solicitação adequado para seu webhook.
- 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.
- Revise e atualize as configurações de autenticação conforme necessário.
- Clique em Salvar.
Concluído
Seu agente e os webhooks dele estão configurados e prontos para testes.