O componente pré-criado de status do 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 para um cliente autenticado. Ele usa o componente pré-criado autenticação do Retail para autenticar usuários. O componente também usa geradores para o resumo pós-chamada.
Limitações
Além das limitações comuns de componentes pré-criados, esse componente pré-criado tem as seguintes limitações:
- Este componente não criptografa nenhum dado.
Exemplos de diálogos
As caixas de diálogo de amostra abaixo 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, 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 as remessas no pedido. O usuário confirma que quer um SMS enviado para o número de telefone registrado com mais detalhes.
| Entrada do usuário | Resposta do agente |
|---|---|
| O agente autentica o usuário usando o componente pré-criado de autenticação do Retail | |
| Ok, John. Você está ligando para falar sobre seu pedido mais recente do João Silva contendo lâmpada, camisa e 10 outros itens feitos em 10/11/2023 às 18h? | |
| Sim | |
| Seu pedido tem duas remessas, que serão entregues até 15-01-2024. Você quer saber mais sobre essas remessas? |
|
| Sim | |
| A remessa 1 contendo jeans, cinto e dois outros itens está em trânsito e será entregue até 12/01/2024. A remessa 2 contendo lâmpada, camisa e outros seis itens foi entregue em 12/11/2023. Quer receber um SMS com mais detalhes sobre seus itens? |
|
| Sim | |
| Enviamos um SMS com um link para rastrear o status de todas as suas remessas. Agradecemos sua ligação. |
Pedidos duplicados
O usuário final já foi autenticado anteriormente. O usuário solicita informações sobre um pedido e informa os últimos cinco dígitos do pedido. O agente identifica que vários pedidos feitos por esse usuário compartilham os mesmos últimos cinco dígitos. Por isso, ele confirma em qual ordem o usuário quer ouvir o status e fornece o status do pedido ao usuário.
| Entrada do usuário | Resposta do agente |
|---|---|
| Ok, Amber. Você está ligando para falar sobre seu pedido mais recente de Amber Doe contendo lâmpada, camisa e outros dois itens feitos em 10/11/2023 às 18h? | |
| No | |
| Você poderia informar os últimos cinco dígitos do ID do pedido que gostaria de rastrear? | |
| 12355 | |
| Os últimos cinco dígitos do ID do pedido que recebemos são 12355, correto? | |
| Sim, é isso mesmo | |
| Ótimo, terminamos de coletar o ID do pedido. | |
| De acordo com nossos registros, encontramos dois pedidos com os mesmos cinco dígitos, 12355. Qual pedido você está procurando? O número do pedido 1, que foi feito em 10/11/2023 às 18h, ou o número 2, que foi feito em 09/11/2023 às 20h? Para selecionar o número um, diga 1, para selecionar o pedido número dois, diga 2. Caso contrário, diga "Não". |
|
| Pedido um | |
| Seu pedido tem duas remessas, que serão entregues até 15-01-2024. Você quer saber mais sobre essas remessas? |
|
| Sim | |
| A remessa 1 contendo jeans está em trânsito e será entregue até 15/01/2024. O envio 2 contendo lâmpada, camisa e mais 1 item foi cancelado. Você quer receber um SMS com mais detalhes sobre seus itens? |
|
| Não, isso é tudo | |
| Agradecemos sua ligação. |
Convenções de nomeação
Esse componente pré-criado usa as seguintes convenções de nomenclatura:
| Engenharia de | 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 são usados por uma ou mais condições no fluxo para determinar como o componente vai 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, utilizado para identificar o usuário. | string |
| $session.params.all_recent_order_id | (Opcional) Este parâmetro lista os IDs de pedido associados ao usuário autenticado, classificados pela data de posicionamento 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 dar as boas-vindas e confirmar a propriedade da conta. | string |
| $flow.max_shipment | Especifica o número de envios exibidos ao usuário por vez. O valor padrão é 2. |
integer |
| $flow.tracking_status_deliveryed | Especifica o valor retornado pelo webhook que indica um status de pedido entregue. O valor padrão é "delivered". |
string |
| $flow.tracking_status_cancelled | Especifica o valor retornado pelo webhook que indica um status de pedido cancelado. O valor padrão é "cancelled". |
string |
| $flow.tracking_status_returned | Especifica o valor retornado pelo webhook que indica um status de pedido retornado. O valor padrão é "returned". |
string |
| $flow.tracking_status_partially_returned | Especifica o valor retornado pelo webhook que indica um status de pedido parcialmente retornado. 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 um 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, expanda para conferir 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 de Presets 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 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, utilizado para identificá-lo. | string |
| all_recent_order_id | Esse parâmetro lista os IDs de pedido associados ao usuário autenticado, classificados pela data de posicionamento 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 | 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 destes:agent: o usuário final solicitou um agente humano em algum momento durante a conversa.denial_of_information: o usuário final se recusou a compartilhar informações solicitadas pelo componente.max_no_input: a conversa atingiu o número máximo de tentativas para eventos sem entrada. Consulte eventos integrados sem entrada.max_no_match: a conversa atingiu o número máximo de 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: não foi possível acessar um URL do webhook. 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 os serviços externos do Dialogflow. Consulte Configuração do Webhook.
Configuração do webhook
Para usar esse componente, configure os webhooks flexíveis incluídos para recuperar as informações necessárias dos serviços externos.
Autenticação
Se você ainda não tiver configurado serviços externos necessários para autenticação, configure-os 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.
Mais detalhes do pedido
O webhook prebuilt_components_order_status:get_order_details é usado
pelo componente para recuperar detalhes de um pedido especificado.
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 |
|---|---|---|
| ID do pedido | ID do pedido para o qual recuperar detalhes. | string |
Parâmetros de resposta da API
Os parâmetros a seguir são extraídos da resposta da API a ser usado 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 pedidos para cada produto em um pedido. | integer |
| order_product_count | O número de produtos exclusivos em um pedido. | integer |
| order_status_notification | Indica se as notificações estão ativadas para esse pedido. | boolean |
| return_eligibility_date | Lista de datas até as quais cada produto do pedido estará qualificado para devolução, no formato YYYY-MM-DD. |
Lista (string) |
| order_customer_billing_name | Nome do nome de faturamento do cliente para o pedido. | string |
| order_latest_delivery_date | A data de entrega mais recente entre todas as datas de entrega estimadas dos envios do pedido, no formato YYYY-MM-DD. |
string |
| order_shipment_multiple | Indica se o pedido contém várias remessas. | boolean |
| order_shipment_count | O número de remessas do pedido. | integer |
| order_shipment_product_count | Contagem total de produtos em cada envio do pedido. | Lista (número inteiro) |
| order_shipment_product_name | Lista dos nomes dos produtos em cada remessa do pedido. | Lista (string) |
| order_estimated_delivery_date | Lista de datas de entrega estimadas para cada envio do 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 "Ver detalhes do pedido" para este componente, expanda para ver 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 do Dialogflow 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 o webhook.
- 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 exigidos pelo componente para acessar 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
ordens 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 |
|---|---|---|
| ID do pedido $flow.duplicada | Lista contendo os últimos cinco dígitos dos números de pedido 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 a ser usado pelo componente.
| Nome do parâmetro | Descrição | Formato da saída |
|---|---|---|
| all_order_date | Lista de datas para 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. |
boolean |
| all_order_time | Lista de horários para 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. |
number |
Para configurar o webhook "Receber pedidos duplicados" para este componente, expanda para ver 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 pré-build_components_retail_services:get_duplicate_order.
- Substitua o URL no campo URL do webhook do Dialogflow 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 o webhook.
- 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 exigidos pelo componente para acessar 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 ao número de telefone especificado por 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, utilizado para identificá-lo. | string |
| ID do pedido | ID do pedido para o qual enviar os detalhes. | string |
Para configurar o webhook "Enviar SMS para este componente", expanda para ver 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 pré-build_components_order_status:send_sms.
- Substitua o URL no campo URL do webhook do Dialogflow 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 o webhook.
- 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 exigidos pelo componente para acessar 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 notificações sobre o 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, utilizado para identificá-lo. | string |
| $flow.order_notification | Indica se as notificações devem ser ativadas para o usuário. | boolean |
Para configurar o webhook "Ativar notificações" para este componente, expanda para ver 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 pré-build_components_order_status:enable_notification.
- Substitua o URL no campo URL do webhook do Dialogflow 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 o webhook.
- 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 exigidos pelo componente para acessar os valores de campo retornados.
- Revise e atualize as configurações de Autenticação conforme necessário.
- Clique em Salvar.
Completos
Seu agente e os webhooks dele agora precisam estar configurados e prontos para serem testados.