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. Esse componente usa o componente Autenticação do varejo pré-criado para autenticar usuários. O componente também usa geradores para gerar um resumo após a chamada.
Limitações
Além das limitações comuns dos componentes pré-criados, este componente pré-criado tem as seguintes limitações:
- Esse componente não criptografa nenhum dado.
Diálogos de exemplo
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 quer 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 pré-criado Autenticação do varejo | |
| Ok, John. Você está ligando sobre o pedido mais recente de John Doe, que contém lâmpada, camisa e outros 10 itens, feito em 10/11/2023 às 18h? | |
| Sim | |
| Seu pedido tem dois envios, que serão entregues até 15/01/2024. Quer saber mais sobre esses envios? |
|
| Sim | |
| O envio 1, que contém jeans, cinto e mais dois itens, está em trânsito e será entregue até 12/01/2024. O envio 2, que contém lâmpada, camisa e mais 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 todas as suas remessas. Agradecemos seu contato. |
Pedidos duplicados
O usuário final já foi autenticado. O usuário pede informações sobre um pedido e fornece os cinco últimos dígitos dele. O agente identifica que vários pedidos feitos por esse usuário compartilham os mesmos cinco últimos dígitos. Por isso, ele confirma qual pedido o usuário quer saber o status e fornece essa informação.
| Entrada do usuário | Resposta do agente |
|---|---|
| Ok, Amber. Você está ligando sobre o pedido mais recente de Amber Doe, que contém lâmpada, camisa e outros dois itens, feito em 10/11/2023 às 18h? | |
| Não | |
| Você pode informar os últimos cinco dígitos do ID do pedido que quer rastrear? | |
| 12355 | |
| Os últimos cinco dígitos do ID do pedido que recebemos são 12355. Isso está correto? | |
| Sim, isso mesmo | |
| Ótimo, terminamos de coletar 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 pedido número 1, feito em 10/11/2023 às 18h, ou o pedido número 2, feito em 09/11/2023 à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 dois envios, que serão entregues até 15/01/2024. Quer saber mais sobre esses envios? |
|
| Sim | |
| O envio 1, que contém calças jeans, está em trânsito e será entregue até 15/01/2024. O envio 2, que contém uma lâmpada, uma camisa e mais um item, foi cancelado. Você gostaria de receber um SMS com mais detalhes sobre seus itens? |
|
| Não, só isso. | |
| Agradecemos seu contato. |
Convenções de nomenclatura
Esse componente pré-criado 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 deve 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 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 IDs de pedidos associados ao usuário autenticado, classificados pela data de inclusã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) 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 pedido retornado. O valor padrão é "returned". |
string |
| $flow.tracking_status_partially_returned | Especifica o valor retornado pelo webhook indicando 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 tentativas permitidas depois de 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 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 em "Página inicial" na seção Páginas.
- Clique na rota true na página inicial.
- Na janela "Rota", edite os valores de Predefinições 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 depois de 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 IDs de pedidos associados ao usuário autenticado, classificados pela data de inclusã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, caso ele não tenha sido concluído. 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 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 de não correspondência.webhook_error: ocorreu um erro de webhook. Consulte evento integrado webhook.error. webhook_not_found: um URL de webhook estava inacessível. Consulte evento integrado webhook.error.not-found. |
string |
Configuração básica
Para configurar esse componente pré-criado:
- Importe o componente pré-criado.
- Configure os webhooks flexíveis fornecidos com uma configuração que descreve seus serviços externos. Consulte a configuração de webhook.
Configuração do webhook
Para usar esse componente, configure 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 tiver configurado os serviços externos necessários para autenticação, faça isso para ativar a autenticação de usuários para esse componente. Consulte Configuração do webhook de autenticação do varejo para 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 | ID do pedido para recuperar 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 | O horário 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 este pedido. | booleano |
| return_eligibility_date | Lista de datas até quando cada produto do pedido está qualificado para devolução, 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 entre todas as datas de entrega estimadas para os envios do 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 | O número total de produtos em cada envio do 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 "Get order details" (Receber 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 do 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 adequado para seu 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 necessários para que o componente acesse os valores dos campos 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 recuperar informações detalhadas e distinguir entre
pedidos quando vários números 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 cinco últimos 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 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 cinco últimos dígitos especificados no formato YYYY-MM-DD. Cada elemento nessa matriz corresponde ao mesmo elemento na matriz all_order_time. |
booleano |
| 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. |
número |
Para configurar o webhook "Get duplicate orders" 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_retail_services:get_duplicate_order.
- Substitua o URL no campo URL do webhook do 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 adequado para seu 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 necessários para que o componente acesse os valores dos campos 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, usado para identificar o usuário. | string |
| $flow.order_id | ID do pedido para enviar os detalhes. | string |
Para configurar o webhook "Enviar SMS" para esse componente, expanda para ver 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 do 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 adequado para seu 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 necessários para que o componente acesse os valores dos campos 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 no 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 devem ser ativadas para o usuário. | booleano |
Para configurar o webhook "Ativar notificações" deste componente, expanda para ver 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 do 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 adequado para seu 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 necessários para que o componente acesse os valores dos campos retornados.
- Revise e atualize as configurações de Autenticação conforme necessário.
- Clique em Salvar.
Concluído
Seu agente e os webhooks dele agora estão configurados e prontos para teste.