O componente predefinido da extrato da conta verifica o nível de autenticação de um cliente e envia o extrato da conta por um período especificado a um cliente autenticado. Se o cliente tiver várias contas, o componente vai confirmar a conta específica para a qual o cliente quer recuperar um extrato. Esse componente usa o componente predefinido Authentication para autenticar usuários e uma versão personalizada da coleta de data de nascimento para coletar as datas de início e término do período do extrato.
Limitações
Além das limitações comuns de componentes predefinidos, este componente predefinido tem as seguintes limitações:
- Esse componente não criptografa dados.
Exemplos de diálogos
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 por telefonia, o que aciona a intent de boas-vindas padrão e a primeira resposta do agente no início da conversa.
Conta única
O usuário final tem uma única conta. O agente coleta as datas de início e término da fatura, se o usuário quer criptografar a fatura e envia a fatura da conta ao usuário.
| Entrada do usuário | Resposta do agente |
|---|---|
| O agente autentica o usuário usando o componente predefinido Authentication | |
| Agradecemos. Sua autenticação foi concluída. | |
| Aguarde enquanto buscamos os detalhes da sua conta. Encontramos um número de conta que termina em 1001 associado ao seu número. Informe a data de início do extrato da conta, começando pelo mês, depois o dia e, por fim, o ano. O período do extrato da conta será fornecido apenas para os últimos 90 dias. |
|
| O agente coleta a data de início da declaração usando o componente predefinido Data de nascimento | |
| Ótimo, coletamos sua data de início do extrato. Informe a data de término do extrato, começando pelo mês, depois o dia e, por fim, o ano. O período do extrato da conta será fornecido apenas para os últimos 90 dias. |
|
| O agente coleta a data de término da declaração usando o componente predefinido Data de nascimento | |
| Obrigado. Confirme se você está procurando o extrato da conta entre 12/07/2023 e 24/07/2023. | |
| Sim | |
| Aguarde enquanto buscamos os detalhes do seu extrato. Encontramos transações de 12/07/2023 a 24/07/2023. Você quer receber por e-mail, SMS ou WhatsApp? |
|
| SMS | |
| Você quer criptografar o documento antes de compartilhar com você? | |
| Agora não | |
| Você vai receber o extrato em até 15 minutos no seu dispositivo móvel registrado. |
Várias contas
O usuário final tem várias contas. O agente confirma para qual conta o usuário está solicitando uma declaração. O agente coleta as datas de início e término da fatura, se o usuário quer criptografar a fatura e envia a fatura da conta ao usuário.
| Entrada do usuário | Resposta do agente |
|---|---|
| O agente autentica o usuário usando o componente predefinido Authentication | |
| Agradecemos. Sua autenticação foi concluída. | |
| Aguarde enquanto buscamos os detalhes da sua conta. Descobrimos que há duas contas associadas ao seu número. Poderia informar os últimos quatro dígitos da conta a que você se refere? |
|
| 2002 | |
| Os últimos quatro dígitos do número da conta que recebemos são 2002, certo? | |
| sim | |
| Informe a data de início do extrato da conta, começando pelo mês, seguido pelo dia e pelo ano. O período do extrato da conta será fornecido apenas para os últimos 90 dias. | |
| O agente coleta a data de início da declaração usando o componente predefinido Data de nascimento | |
| Ótimo, coletamos sua data de início do extrato. Informe a data de término do extrato, começando pelo mês, depois o dia e, por fim, o ano. O período do extrato da conta será fornecido apenas para os últimos 90 dias. |
|
| O agente coleta a data de término da declaração usando o componente predefinido Data de nascimento | |
| Obrigado. Confirme se você está procurando o extrato da conta entre 18-07-2023 e 22-07-2023. | |
| Sim | |
| Aguarde enquanto buscamos os detalhes do seu extrato. Encontramos transações de 18/07/2023 a 22/07/2023. Você quer receber por e-mail, SMS ou WhatsApp? |
|
| Você quer criptografar o documento antes de compartilhar com você? | |
| Sim | |
| Os detalhes da senha serão compartilhados no WhatsApp registrado. Você vai receber o extrato em até 15 minutos no WhatsApp registrado. |
Convenções de nomenclatura
Esse componente predefinido usa as seguintes convenções de nomenclatura:
| Recurso | Formato | Exemplo |
|---|---|---|
| Fluxo | [Nome do componente] | Demonstrativo da conta |
| Intent específica do componente | prebuilt_components_[component_name]_[intent_name] | prebuilt_components_account_number_collection_four_digit_account_number |
| Tipo da entidade | prebuilt_components_[component_name]_[entity_type] | prebuilt_components_account_statement_channelall |
| Webhook | prebuilt_components_[component_name]:[webhook_action] | prebuilt_components_account_statement:request_statement |
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 vai 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 predefinido aceita os seguintes parâmetros de entrada:
| Nome do parâmetro | Descrição | Formato da entrada |
|---|---|---|
| $session.params.auth_level | (opcional) Indica o nível de autenticação do autor da chamada. | integer |
| $session.params.auth_level_req | Indica o nível de autenticação necessário para que um usuário possa acessar o extrato da conta. Esse valor é configurado nas predefinições de parâmetros do fulfillment de entrada de página na página check auth level. Por padrão, esse valor é 1. |
integer |
| $session.params.account_auth_enabled | Indica se o usuário precisa ser autenticado como titular da conta, conforme descrito em Tipos de autenticação. Esse valor é configurado nas predefinições de parâmetros do fulfillment de entrada de página na página check auth level. Por padrão, esse valor é true. |
booleano |
| $session.params.card_auth_enabled | Indica se o usuário precisa ser autenticado como titular do cartão, conforme descrito em Tipos de autenticação. Esse valor é configurado nas predefinições de parâmetros do fulfillment de entrada de página na página check auth level. Por padrão, esse valor é false. |
booleano |
| $session.params.phone_number | (opcional) Número de telefone registrado do cliente usado para autenticação. | string |
| $session.params.account_count | (Opcional) Número de contas associadas ao usuário autenticado. | integer |
| $session.params.last_four_digit_of_account_number | (opcional) Os quatro últimos dígitos do número da conta do cliente para a qual o extrato precisa ser fornecido. Se o cliente tiver uma única conta, essas informações serão recuperadas automaticamente após a autenticação. Se o cliente tiver várias contas, o número específico da conta será coletado dele. | string |
| $session.params.account_statement_max_days | Especifica o número máximo de dias antes da data atual permitido para uma data de início de extrato. Por padrão, esse valor é -90, indicando que as datas de início das faturas podem começar no máximo 90 dias antes da data atual. Esse parâmetro é configurado na rota true da página inicial. |
integer |
| $flow.max_retry_count | Especifica o número de novas tentativas permitidas ao solicitar que o usuário final informe uma data de término de extrato válida. O valor padrão é 3. |
integer |
| $flow.max_retry_confirm_period_counter | Especifica o número de novas tentativas permitidas ao confirmar o período da fatura com o usuário final. O valor padrão é 3. |
integer |
| $flow.max_retry_statement_counter | Especifica o número de novas tentativas permitidas quando o período de extrato fornecido não recupera nenhuma transação. O valor padrão é 3. |
integer |
Para configurar os parâmetros de entrada desse componente, abra 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 das configurações predefinidas 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 predefinido 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 do autor da chamada. | integer |
| phone_number | Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. | string |
| account_count | O número de contas associadas ao número de telefone registrado. Isso inclui contas próprias e contas em que o usuário tem procuração. | integer |
| last_four_digit_of_account_number | Se um usuário tiver uma única conta, os últimos quatro dígitos do número da conta serão retornados. Se um usuário tiver mais de uma conta, o valor desse parâmetro será os últimos quatro dígitos do número da conta que o usuário selecionou para receber informações do extrato. | 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 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 sem correspondência.webhook_error: ocorreu um erro de webhook. Consulte webhook.error built-in event. webhook_not_found: um URL de webhook não pode ser acessado. 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 seus serviços externos. Consulte a configuração de webhook abaixo.
Configuração do webhook
Para usar esse componente, você precisa configurar os webhooks flexíveis incluídos para extrair as informações necessárias dos seus serviços externos.
Autenticação
Se você não tiver configurado os serviços externos necessários para a autenticação, será necessário fazer isso para ativar a autenticação de usuários para esse componente. Consulte Configuração de webhook de autenticação para ver instruções detalhadas.
Validar conta
O webhook prebuilt_components_account_services:validate_account é usado
pelo componente para verificar se uma conta existe com base no número de telefone
registrado do usuário e nos últimos quatro dígitos do número de conta fornecido.
O webhook também retorna o saldo da conta, se ela existir.
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 |
| $session.params.last_four_digit_of_account_number | Os quatro últimos dígitos do número da conta que o usuário selecionou e confirmou para receber informações do extrato. | 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 |
|---|---|---|
| account_found | Indica se existe uma conta com os últimos quatro dígitos informados para a conta registrada do usuário. | booleano |
| saldo | O valor do saldo atual da conta, se houver. | number |
Para configurar o webhook de validação de conta 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_account_services:validate_account.
- Substitua o URL no campo URL do webhook dos agentes de conversação (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 de solicitação adequado para seu webhook.
- Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do seu webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
- Revise e atualize as configurações de autenticação conforme necessário.
- Clique em Salvar.
Receber transações
O webhook prebuilt_components_account_statement:get_transactions é usado
pelo componente para recuperar as transações de uma conta com base no número de telefone
registrado do usuário, nos quatro últimos dígitos do número da conta e no
período do extrato.
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 |
| $session.params.last_four_digit_of_account_number | Os quatro últimos dígitos do número da conta que o usuário selecionou e confirmou para receber informações do extrato. | string |
| $flow.statement_start_date | A data de início da fatura solicitada no formato "AAAA-MM-DD". | string |
| $flow.statement_end_date | (opcional) A data de início da fatura solicitada no formato "AAAA-MM-DD". Se o usuário não fornecer um valor ou se o autor da chamada recusar fornecer uma data de término, o valor padrão será a data atual. | 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 |
|---|---|---|
| transactions_count | O número de transações encontradas para a conta especificada no período de extrato fornecido. | integer |
Para configurar o webhook "Pegar transações" 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_account_statement:get_transactions.
- Substitua o URL no campo URL do webhook dos agentes de conversação (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 de solicitação adequado para seu webhook.
- Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do seu webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
- Revise e atualize as configurações de autenticação conforme necessário.
- Clique em Salvar.
Solicitar extrato
O webhook prebuilt_components_account_statement:request_statement é usado
pelo componente para enviar uma declaração de uma conta para um canal selecionado, considerando
o número de telefone registrado do usuário, os quatro últimos dígitos do número da conta
e o período da declaração.
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 |
| $session.params.last_four_digit_of_account_number | Os quatro últimos dígitos do número da conta que o usuário selecionou e confirmou para receber informações do extrato. | string |
| $flow.statement_start_date | A data de início da fatura solicitada no formato "AAAA-MM-DD". | string |
| $flow.statement_end_date | (opcional) A data de início da fatura solicitada no formato "AAAA-MM-DD". Se o usuário não fornecer um valor ou se o autor da chamada recusar fornecer uma data de término, o valor padrão será a data atual. | string |
| $flow.channel_medium | O canal que o usuário selecionou para receber a mensagem. Os valores válidos são definidos pelas entidades personalizadas prebuilt_components_account_statement_channelphn e prebuilt_components_account_statement_channelall, dependendo se o usuário tem um e-mail registrado. Por padrão, email, mobile e WhatsApp são aceitos. |
string |
| $flow.encryption_status | Indica se o usuário quer que o documento seja criptografado antes do envio para o canal especificado. Se o usuário não fornecer um valor ou se o autor da chamada recusar fornecer uma data de término, o valor padrão será true. |
booleano |
Para configurar o webhook de declaração de solicitação 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_account_statement:request_statement.
- Substitua o URL no campo URL do webhook dos agentes de conversação (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 de solicitação adequado para seu webhook.
- Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do seu webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
- Revise e atualize as configurações de autenticação conforme necessário.
- Clique em Salvar.
Concluído
Seu agente e os webhooks dele estão configurados e prontos para testes.