Componente pré-criado de autenticação de varejo

A autenticação no varejo componente pré-criado coleta do usuário para autenticá-lo no nível de autenticação exigido. Este componente aborda os requisitos de autenticação comuns, mas não exclusivos, do setor de varejo. Esse componente usa a coleção de números de telefone pré-criada para coletar e validar os detalhes do usuário.

Níveis de autenticação

Diferentes níveis de autenticação exigidos por diferentes interfaces pré-criadas componentes, com níveis mais altos exigindo mais informações do usuário para autenticar o usuário. O componente de autenticação de varejo permite que os usuários se autentiquem Nível 0 (correspondência de ANI) ou nível 1 (básico), conforme descrito na tabela "Nível de autenticação".

Nível de autenticação	Requisitos
Nível 0: correspondência de ANI	O usuário é autenticado ao chamar ou fornecer um número de telefone que corresponda a uma conta registrada. Um usuário pode ser autenticado no nível 0 usando o componente pré-criado Saudação.
Nível 1: básico	Para autenticar o usuário, é preciso 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 uma conta número de telefone e e-mail.

Limitações

Além da seção limitações comuns de componentes pré-criados, esse 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 pelo usuário. O componente não usa OTP para autenticar clientes Ligar de um número de telefone alternativo que não está registrado na conta Quando um usuário ligar de um número de telefone alternativo, as perguntas de segurança serão usados para autenticar o autor da chamada.
• Este componente não criptografa dados.

Exemplos de diálogos

Os exemplos de caixas de diálogo a seguir demonstram cenários comuns tratados por este um componente pré-criado. As caixas de diálogo de exemplo demonstram o comportamento quando o componente é chamado usando a telefonia, o que aciona a intent de boas-vindas padrão e a primeira a resposta do agente no início da conversa.

Autenticação de nível 0: correspondência de ANI

O usuário liga de um número de telefone registrado para uma conta existente, confirma a conta de serviço e foi autenticada no nível 0.

Entrada do usuário	Resposta do agente
	Olá, o número discado está vinculado à conta de João. Você quer saber sobre o pedido de outra pessoa? Diga "sim" se for o caso ou "não".
Não
	Obrigado, John. Sua identidade foi confirmada.

Autenticação de nível 1 concluída: OTP

O usuário liga de um número de telefone não reconhecido. O componente coleta as informações um número de telefone registrado, envia e pede que o usuário confirme uma OTP enviada ao canal de escolha do usuário. O usuário pode fornecer uma OTP válida e tem autenticado no Nível 1.

Entrada do usuário	Resposta do agente
Não foi possível encontrar este 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úmeros de telefone.
	Ótimo, já coletamos o número de telefone. Por motivos de segurança, precisamos validar sua identidade. Por isso, vamos enviar um código para 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 que termina em 0000. Isso pode levar alguns segundos. Você pode confirmar o código?
123457
	Obrigado, John. Você foi identificado.

Convenções de nomenclatura

Esse componente pré-criado usa as seguintes convenções de nomenclatura:

Recurso	Formato	Exemplo
Fluxo	[Nome do componente]	Autenticação do Retail
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 dentro do 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 do 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 em que o usuário final será autenticado. 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 novas 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

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 a saída a seguir parâmetros:

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 códigos de pedido associados ao usuário autenticado, classificados por data de veiculação do pedido em ordem decrescente. O primeiro elemento da matriz representa a ordem 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, utilizado para identificar o usuário.	string
e-mail	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 tentativas para eventos sem entrada. Confira 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 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:

1. Importe o componente pré-criado.
2. Configure os webhooks flexíveis com que descreva os serviços externos, consulte Webhook configuração abaixo.

Configuração do webhook

Para usar este componente, você precisa configurar o webhooks flexíveis para recuperar informações necessárias dos serviços externos.

Verificar os detalhes do usuário

O webhook prebuilt_components_retail_authentication:verify_user_details é usada pelo componente para buscar detalhes da conta de usuário com base no telefone fornecido número

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 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
e-mail	O e-mail registrado na conta.	string
all_recent_order_id	Lista de IDs de pedidos associados ao usuário autenticado, classificada em ordem decrescente pela data de realização do pedido. O primeiro elemento da matriz representa a ordem 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

Enviar OTP

O webhook prebuilt_components_retail_authentication:send_otp é usado pelo componente enviar uma senha única (OTP) a um canal registrado selecionados 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, utilizado 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 da OTP gerada e enviada ao usuário por meio do canal selecionado.	string

Concluído

Seu agente e os webhooks dele estão configurados e prontos para testes.