O componente pré-criado de autenticação de varejo coleta informações do usuário para autenticá-lo no nível necessário. Esse componente aborda requisitos de autenticação comuns, mas não exclusivos, do setor de varejo. Ele usa o componente pré-criado Coleta de número de telefone para coletar e validar os detalhes do usuário.
Níveis de autenticação
Há vários níveis de autenticação exigidos por diferentes componentes pré-criados, e os níveis mais altos exigem mais informações do usuário para autenticá-lo. O componente de autenticação de varejo permite que os usuários se autentiquem no nível 0 (correspondência de ANI) ou no nível 1 (básico), conforme descrito na tabela de níveis de autenticação.
| Nível de autenticação | Requisitos |
|---|---|
| Nível 0: correspondência de ANI | O usuário é autenticado ao ligar ou fornecer um número de telefone que corresponde a uma conta registrada. Um usuário pode ser autenticado no nível 0 usando o componente pré-criado de saudação. |
| Nível 1: básico | O usuário é autenticado ao verificar um código de senha única (OTP) enviado para o e-mail ou número de telefone dele. |
Tipos de usuários compatíveis
O componente de autenticação de varejo oferece suporte a usuários com um número de telefone e e-mail registrados.
Limitações
Além das limitações comuns dos componentes pré-criados, este componente pré-criado tem as seguintes limitações:
- Os OTPs só serão enviados para um número de celular ou endereço de e-mail registrado anteriormente para o usuário. O componente não usa OTP para autenticar clientes que ligam de um número de telefone alternativo não registrado na conta. Quando um usuário liga de um número de telefone alternativo, as perguntas de segurança são usadas para autenticar quem está ligando.
- 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.
Sucesso na autenticação de nível 0: correspondência de ANI
O usuário liga de um número de telefone registrado em uma conta existente, confirma a conta e é autenticado no nível 0.
| Entrada do usuário | Resposta do agente |
|---|---|
| Olá, o número discado está vinculado à conta de John. Você está perguntando sobre o pedido de outra pessoa? Diga "Sim" se for esse o caso, caso contrário, diga "Não". | |
| Não | |
| Obrigado, John. Sua identificação foi concluída. |
Sucesso na autenticação de nível 1: OTP
O usuário liga de um número de telefone desconhecido. O componente coleta o número de telefone registrado do usuário e envia e pede que ele confirme um OTP enviado ao canal de escolha do usuário. O usuário consegue fornecer um OTP válido e é autenticado no nível 1.
| Entrada do usuário | Resposta do agente |
|---|---|
| Não encontramos esse número de telefone associado a nós. Informe o número de telefone registrado. | |
| O agente coleta o número de telefone usando o componente pré-criado Coleta de número de telefone | |
| Pronto, terminamos de coletar o número de telefone. Por questões de segurança, precisamos validar sua identidade. Por isso, vamos enviar um código. Você prefere receber o código por telefone ou e-mail? |
|
| telefone | |
| Só para confirmar, você quer receber a OTP no seu smartphone? Diga sim ou não. | |
| sim | |
| Enviamos um código para seu número de telefone registrado terminado em 0000. Isso pode levar alguns segundos. Você pode confirmar o código? | |
| 123457 | |
| Obrigado, John. Sua identificação foi concluída. |
Convenções de nomenclatura
Esse componente pré-criado usa as seguintes convenções de nomenclatura:
| Recurso | Formato | Exemplo |
|---|---|---|
| Fluxo | [Nome do componente] | Autenticação no varejo |
| Intent específica do componente | prebuilt_components_[component_name]_[intent_name] | prebuilt_components_retail_authentication_incorrect_phone_number |
| Tipo da entidade | prebuilt_components_[component_name]_[entity_type] | prebuilt_components_channel_email_phone |
| Webhook | prebuilt_components_[component_name]:[webhook_action] | prebuilt_components_retail_authentication:verify_user_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, conforme descrito abaixo. 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.auth_level_req | Define o nível de autenticação do usuário final. Os valores válidos são 0 ou 1. |
integer |
| $session.params.auth_level | (opcional) Indica o nível de autenticação atual do usuário final. | integer |
| $session.params.phone_number | (opcional) Número de telefone do usuário final. Se esse parâmetro não for fornecido, o componente vai coletar o número de telefone do usuário final. | string |
| $flow.max_retry_phone_number | Especifica o número de novas tentativas permitidas ao coletar o número de telefone do usuário. O valor padrão é 3. |
integer |
| $flow.max_retry_otp | Especifica o número de novas tentativas permitidas ao coletar a senha única (OTP). O valor padrão é 3. |
integer |
| $flow.max_retry_otp_not_received | Especifica o número de tentativas permitidas quando a senha única (OTP) não é recebida. O valor padrão é 1. |
integer |
| $flow.max_retry_otp_confirm_channel | Especifica o número de novas tentativas permitidas ao coletar o canal para receber a senha única (OTP). 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 |
|---|---|---|
| auth_level | Indica o nível de autenticação atual do usuário final. | integer |
| 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) |
| phone_number | Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. | 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 o 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 abaixo.
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.
Verificar os detalhes do usuário
O webhook prebuilt_components_retail_authentication:verify_user_details é usado pelo componente para buscar detalhes da conta do usuário com base no número de telefone fornecido.
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 |
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 |
|---|---|---|
| O e-mail registrado na conta. | string | |
| all_recent_order_id | Lista de IDs 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) |
| user_first_name | O nome do usuário, usado para cumprimentar e confirmar a propriedade da conta. | string |
Para configurar o webhook "Verificar detalhes do usuário" 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_authentication:verify_user_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.
Enviar OTP
O webhook prebuilt_components_retail_authentication:send_otp é usado
pelo componente para enviar uma senha única (OTP) a um canal registrado
selecionado pelo usuário final.
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.channel | O canal que o usuário selecionou para receber o OTP. Os valores válidos são definidos pela entidade personalizada prebuilt_components_channel_email_phone. Por padrão, email e phone são compatíveis. |
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 |
|---|---|---|
| generated_otp | O valor do OTP gerado e enviado ao usuário usando o canal selecionado. | string |
Para configurar o webhook "Enviar OTP" 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_authentication:send_otp.
- 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.