O componente pré-criado estado da encomenda verifica o nível de autenticação de um cliente e, em seguida, fornece informações sobre as encomendas mais recentes ou anteriores do utilizador a um cliente autenticado. Este componente usa o componente pré-criado Autenticação de retalho para autenticar utilizadores. O componente também usa geradores para o 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:
- Este componente não encripta dados.
Exemplos de caixas de diálogo
Os exemplos de caixas de diálogo seguintes demonstram cenários comuns processados por este componente pré-criado. Os diálogos de exemplo demonstram o comportamento quando o componente é chamado através da telefonia, o que aciona a intenção de boas-vindas predefinida e a primeira resposta do agente no início da conversa.
Encomenda recente
Chamadas de utilizadores finais a partir de um número não registado; o agente autentica o utilizador e, em seguida, fornece informações detalhadas sobre os envios na encomenda. O utilizador confirma que quer receber uma SMS no respetivo número de telefone registado com detalhes adicionais.
| Introdução do utilizador | Resposta do agente |
|---|---|
| O agente autentica o utilizador através do componente pré-criado Autenticação de retalho | |
| OK, João. Está a ligar relativamente à sua encomenda mais recente de João Pinto que contém uma lâmpada, uma camisa e outros 10 artigos feita a 10/11/2023 às 18:00? | |
| Sim | |
| A sua encomenda tem 2 envios, que vão ser entregues até 15/01/2024. Quer saber mais sobre estes envios? |
|
| Sim | |
| O envio 1, que contém calças de ganga, um cinto e 2 outros artigos, está em trânsito e vai ser entregue até 12/01/2024. O envio 2, que contém um candeeiro, uma camisa e 6 outros artigos, foi entregue a 12/11/2023. Quer receber um SMS com mais detalhes sobre os seus artigos? |
|
| Sim | |
| Enviámos-lhe uma SMS com um link para acompanhar o estado de todos os seus envios. Agradecemos o seu contacto. |
Encomendas duplicadas
O utilizador final foi autenticado anteriormente. O utilizador pede informações sobre uma encomenda e indica os últimos cinco dígitos da encomenda. O agente identifica que várias encomendas feitas por este utilizador partilham os mesmos últimos cinco dígitos, pelo que confirma de que encomenda o utilizador quer saber o estado e fornece o estado da encomenda ao utilizador.
| Introdução do utilizador | Resposta do agente |
|---|---|
| OK, Amber. Está a ligar relativamente à sua encomenda mais recente de Amber Doe que contém uma lâmpada, uma camisa e outros 2 artigos feita a 10/11/2023 às 18:00? | |
| Não | |
| Pode indicar os últimos 5 dígitos do ID da encomenda que quer acompanhar? | |
| 12355 | |
| Os últimos cinco dígitos do ID da encomenda que recebemos são 12355. Está correto? | |
| Sim, é isso mesmo | |
| Ótimo, terminámos a recolha do ID da encomenda. | |
| De acordo com os nossos registos, encontrámos 2 encomendas que terminam com os mesmos 5 dígitos: 12355. Que encomenda procura? Encomenda número 1 feita a 10/11/2023 às 18:00 ou encomenda número 2 feita a 09/11/2023 às 20:00? Para selecionar a encomenda número 1, diga 1. Para selecionar a encomenda número 2, diga 2. Caso contrário, diga Não. |
|
| Encomende um | |
| A sua encomenda tem 2 envios, que vão ser entregues até 15/01/2024. Quer saber mais sobre estes envios? |
|
| Sim | |
| O envio 1 com calças de ganga está em trânsito e vai ser entregue até 15/01/2024. O envio 2 com a lâmpada, a camisa e mais 1 artigo foi cancelado. Quer receber um SMS com mais detalhes sobre os seus artigos? |
|
| Não, é tudo | |
| Agradecemos o seu contacto. |
Convenções de nomenclatura
Este componente pré-criado usa as seguintes convenções de nomenclatura:
| Funcionalidade | Formato | Exemplo |
|---|---|---|
| Flow | [Component Name] | Estado da encomenda |
| 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 parâmetros usados para configurar determinados comportamentos do componente. Os parâmetros vão ser usados por uma ou mais condições no fluxo para determinar o comportamento do componente. Os parâmetros ao nível do fluxo têm de ser definidos na página de início do componente. Os parâmetros ao nível da sessão podem ser definidos por um fluxo de chamadas ou na página de início deste componente.
Este componente pré-criado aceita os seguintes parâmetros de entrada:
| Nome do parâmetro | Descrição | Formato de entrada |
|---|---|---|
| $session.params.phone_number | (opcional) Número de telefone local do utilizador, sem o indicativo do país, usado para identificar o utilizador. | de string |
| $session.params.all_recent_order_id | (opcional) Este parâmetro apresenta os IDs das encomendas associados ao utilizador autenticado, ordenados pela data de colocação da encomenda por ordem descendente. O primeiro elemento da matriz representa a encomenda mais recente. Se um utilizador não tiver encomendas, o valor deste parâmetro é null. |
Lista (string) |
| $session.params.email | (opcional) O email registado na conta. | de string |
| $session.params.user_first_name | (Opcional) Nome próprio do utilizador, usado para o cumprimentar e confirmar a propriedade da conta. | de string |
| $flow.max_shipment | Especifica o número de envios apresentados ao utilizador de cada vez. O valor predefinido é 2. |
número inteiro |
| $flow.tracking_status_delivered | Especifica o valor devolvido pelo webhook que indica um estado de encomenda entregue. O valor predefinido é "delivered". |
de string |
| $flow.tracking_status_cancelled | Especifica o valor devolvido pelo webhook que indica o estado de encomenda cancelada. O valor predefinido é "cancelled". |
de string |
| $flow.tracking_status_returned | Especifica o valor devolvido pelo webhook que indica um estado de encomenda devolvido. O valor predefinido é "returned". |
de string |
| $flow.tracking_status_partially_returned | Especifica o valor devolvido pelo webhook que indica um estado de encomenda parcialmente devolvido. O valor predefinido é "partially returned". |
de string |
| $flow.max_retry_alternate_profile | Especifica o número de novas tentativas permitidas quando pede o estado da encomenda a partir de um número de telefone não registado ou de um perfil alternativo. O valor predefinido é 3. |
número inteiro |
| $flow.max_retry_order_number | Especifica o número de novas tentativas permitidas ao fornecer um número de encomenda. O valor predefinido é 3. |
número inteiro |
| $flow.max_retry_another_order_id | Especifica o número de novas tentativas permitidas após a indicação de um número de encomenda inválido. O valor predefinido é 3. |
número inteiro |
Para configurar os parâmetros de entrada deste componente, expanda para ver as instruções.
- Abra a consola do Dialogflow CX.
- Escolha o seu projeto do Google Cloud.
- Selecione o seu agente.
- Selecione o separador Criar.
- Clique no componente importado na secção Fluxos.
- Clique na página inicial na secção Páginas.
- Clique no percurso verdadeiro na página inicial.
- Na janela Route, edite os valores de Predefinições de parâmetros conforme necessário.
- Clique em Guardar.
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. Estes parâmetros contêm informações importantes recolhidas pelo componente. Este componente pré-criado fornece valores para os seguintes parâmetros de saída:
| Nome do parâmetro | Descrição | Formato de saída |
|---|---|---|
| phone_number | Número de telefone local do utilizador, sem o indicativo do país, usado para identificar o utilizador. | de string |
| all_recent_order_id | Este parâmetro apresenta os IDs de encomendas associados ao utilizador autenticado, ordenados pela data de colocação da encomenda por ordem descendente. O primeiro elemento da matriz representa a encomenda mais recente. Se um utilizador não tiver encomendas, o valor deste parâmetro é null. |
Lista (string) |
| O email registado na conta. | de string | |
| user_first_name | Nome próprio do utilizador, usado para cumprimentar e confirmar a propriedade da conta. | de string |
| transfer_reason | Este parâmetro indica o motivo pelo qual o fluxo foi terminado, se não tiver sido bem-sucedido. O valor devolvido é um dos seguintes:agent: o utilizador final pediu um agente humano em algum momento durante a conversa.denial_of_information: o utilizador final recusou-se a partilhar informações pedidas pelo componente.max_no_input: a conversa atingiu o número máximo de novas tentativas para eventos sem introdução. Consulte os eventos incorporados sem entrada.max_no_match: a conversa atingiu o número máximo de novas tentativas para eventos sem correspondência. Consulte os eventos incorporados sem correspondência.webhook_error: ocorreu um erro de webhook. Veja o evento incorporado webhook.error. webhook_not_found: não foi possível aceder a um URL de webhook. Veja o evento incorporado webhook.error.not-found. |
de string |
Configuração básica
Para configurar este componente pré-criado:
- Importe o componente pré-criado.
- Configure os webhooks flexíveis fornecidos com a configuração que descreve os seus serviços externos. Consulte a configuração do webhook.
Configuração do webhook
Para usar este componente, tem de configurar os webhooks flexíveis incluídos para obter as informações necessárias dos seus serviços externos.
Autenticação
Se não tiver configurado anteriormente os serviços externos necessários para a autenticação, tem de configurá-los para ativar a autenticação de utilizadores para este componente. Consulte o artigo Configuração do webhook de autenticação de retalho para ver instruções detalhadas.
Ver detalhes da encomenda
O webhook prebuilt_components_order_status:get_order_details é usado pelo componente para obter detalhes da encomenda para uma encomenda especificada.
Parâmetros de pedidos de API
Os seguintes parâmetros são fornecidos pelo componente como entradas para o pedido da API.
| Nome do parâmetro | Descrição | Formato de entrada |
|---|---|---|
| $flow.order_id | ID da encomenda para obter detalhes. | de string |
Parâmetros de resposta da API
Os seguintes parâmetros são extraídos da resposta da API para serem usados pelo componente.
| Nome do parâmetro | Descrição | Formato de saída |
|---|---|---|
| order_date | Data em que a encomenda foi feita, no formato YYYY-MM-DD. |
de string |
| order_time | Hora em que a encomenda foi feita, no formato HH:MM. |
de string |
| order_status | Indica o estado da encomenda. Os valores de exemplo incluem "pending", "processing", "in-transit", "on-hold", "cancelled", "delivered", "returned" e "partially returned". |
de string |
| order_product_name | Lista dos nomes dos produtos na encomenda. | Lista (string) |
| order_product_quantity | Contagem total do número de produtos encomendados para cada produto numa encomenda. | número inteiro |
| order_product_count | O número de produtos únicos numa encomenda. | número inteiro |
| order_status_notification | Indica se as notificações estão ativadas para esta encomenda. | booleano |
| return_eligibility_date | Lista de datas até às quais cada produto na encomenda é elegível para devolução, no formato YYYY-MM-DD. |
Lista (string) |
| order_customer_billing_name | Nome próprio do nome de faturação do cliente para a encomenda. | de string |
| order_latest_delivery_date | A data de entrega mais recente em todas as datas de entrega previstas para os envios na encomenda, no formato YYYY-MM-DD. |
de string |
| order_shipment_multiple | Indica se a encomenda contém vários envios. | booleano |
| order_shipment_count | O número de envios na encomenda. | número inteiro |
| order_shipment_product_count | Número total de produtos em cada envio na encomenda. | Lista (número inteiro) |
| order_shipment_product_name | Lista dos nomes dos produtos em cada envio na encomenda. | Lista (string) |
| order_estimated_delivery_date | Lista de datas de entrega previstas para cada envio na encomenda, no formato YYYY-MM-DD. |
Lista (string) |
| order_shipment_status | Lista que indica o estado de cada envio na encomenda. Os valores de exemplo incluem "pending", "processing", "in-transit", "on-hold", "cancelled", "delivered", "returned" e "partially returned". |
Lista (string) |
Para configurar o webhook Get order details para este componente, expanda para ver as instruções.
- Abra a consola do Dialogflow CX.
- Escolha o seu projeto do Google Cloud.
- Selecione o seu agente.
- Selecione o separador Gerir.
- Clique em Webhooks.
- Selecione o webhook prebuilt_components_order_status:get_order_details.
- Substitua o URL no campo URL do webhook dos agentes conversacionais (Dialogflow CX) pelo ponto final do serviço com o qual quer fazer a integração. Selecione o Método adequado no menu pendente.
- Reveja e atualize o corpo do pedido para formar o formato de pedido adequado para o seu webhook.
- Reveja e atualize a configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, uma vez que são necessários para que o componente aceda aos valores dos campos devolvidos.
- Reveja e atualize as definições de autenticação, conforme necessário.
- Clique em Guardar.
Receba encomendas duplicadas
O webhook prebuilt_components_retail_services:get_duplicate_orderé usado
pelo componente para obter informações detalhadas de forma a distinguir entre
encomendas quando vários números de encomenda têm os mesmos últimos cinco dígitos.
Parâmetros de pedidos de API
Os seguintes parâmetros são fornecidos pelo componente como entradas para o pedido da API.
| Nome do parâmetro | Descrição | Formato de entrada |
|---|---|---|
| $flow.duplicate_order_id | Lista que contém os últimos cinco dígitos dos números de encomendas partilhados entre uma ou mais encomendas do utilizador. | Lista (string) |
Parâmetros de resposta da API
Os seguintes parâmetros são extraídos da resposta da API para serem usados pelo componente.
| Nome do parâmetro | Descrição | Formato de saída |
|---|---|---|
| all_order_date | Lista de datas de encomendas duplicadas com os últimos cinco dígitos especificados no formato YYYY-MM-DD. Cada elemento nesta matriz corresponde ao mesmo elemento na matriz all_order_time. |
booleano |
| all_order_time | Lista de horas de encomenda para encomendas duplicadas com os últimos cinco dígitos especificados no formato HH:MM. Cada elemento nesta matriz corresponde ao mesmo elemento na matriz all_order_date. |
número |
Para configurar o webhook Get duplicate orders para este componente, expanda para ver as instruções.
- Abra a consola do Dialogflow CX.
- Escolha o seu projeto do Google Cloud.
- Selecione o seu agente.
- Selecione o separador Gerir.
- Clique em Webhooks.
- Selecione o webhook prebuilt_components_retail_services:get_duplicate_order.
- Substitua o URL no campo URL do webhook dos agentes conversacionais (Dialogflow CX) pelo ponto final do serviço com o qual quer fazer a integração. Selecione o Método adequado no menu pendente.
- Reveja e atualize o corpo do pedido para formar o formato de pedido adequado para o seu webhook.
- Reveja e atualize a configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, uma vez que são necessários para que o componente aceda aos valores dos campos devolvidos.
- Reveja e atualize as definições de autenticação, conforme necessário.
- Clique em Guardar.
Enviar SMS
O webhook prebuilt_components_order_status:send_sms é usado pelo componente para enviar detalhes da encomenda para o número de telefone especificado através de SMS.
Parâmetros de pedidos de API
Os seguintes parâmetros são fornecidos pelo componente como entradas para o pedido da API.
| Nome do parâmetro | Descrição | Formato de entrada |
|---|---|---|
| $session.params.phone_number | Número de telefone local do utilizador, sem o indicativo do país, usado para identificar o utilizador. | de string |
| $flow.order_id | ID da encomenda para a qual quer enviar os detalhes. | de string |
Para configurar o webhook Enviar SMS para este componente, expanda para ver as instruções.
- Abra a consola do Dialogflow CX.
- Escolha o seu projeto do Google Cloud.
- Selecione o seu agente.
- Selecione o separador Gerir.
- Clique em Webhooks.
- Selecione o webhook prebuilt_components_order_status:send_sms.
- Substitua o URL no campo URL do webhook dos agentes conversacionais (Dialogflow CX) pelo ponto final do serviço com o qual quer fazer a integração. Selecione o Método adequado no menu pendente.
- Reveja e atualize o corpo do pedido para formar o formato de pedido adequado para o seu webhook.
- Reveja e atualize a configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, uma vez que são necessários para que o componente aceda aos valores dos campos devolvidos.
- Reveja e atualize as definições de autenticação, conforme necessário.
- Clique em Guardar.
Ativar notificações
O webhook prebuilt_components_order_status:enable_notification é usado pelo componente para ativar as notificações para o número de telefone registado de um utilizador.
Parâmetros de pedidos de API
Os seguintes parâmetros são fornecidos pelo componente como entradas para o pedido da API.
| Nome do parâmetro | Descrição | Formato de entrada |
|---|---|---|
| $session.params.phone_number | Número de telefone local do utilizador, sem o indicativo do país, usado para identificar o utilizador. | de string |
| $flow.order_notification | Indica se as notificações devem ser ativadas para o utilizador. | booleano |
Para configurar o webhook de ativação de notificações para este componente, expanda para ver as instruções.
- Abra a consola do Dialogflow CX.
- Escolha o seu projeto do Google Cloud.
- Selecione o seu agente.
- Selecione o separador Gerir.
- Clique em Webhooks.
- Selecione o webhook prebuilt_components_order_status:enable_notification.
- Substitua o URL no campo URL do webhook dos agentes conversacionais (Dialogflow CX) pelo ponto final do serviço com o qual quer fazer a integração. Selecione o Método adequado no menu pendente.
- Reveja e atualize o corpo do pedido para formar o formato de pedido adequado para o seu webhook.
- Reveja e atualize a configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, uma vez que são necessários para que o componente aceda aos valores dos campos devolvidos.
- Reveja e atualize as definições de autenticação, conforme necessário.
- Clique em Guardar.
Concluído
O seu agente e os respetivos webhooks já devem estar configurados e prontos para teste.