O extrato de conta componente pré-criado verifica o nível de autenticação de um cliente e, em seguida, envia o extrato de conta durante um período especificado a um cliente autenticado. Se o cliente tiver várias contas, o componente confirma a conta específica para a qual o cliente quer obter um extrato de conta. Este componente usa o componente pré-criado Authentication para autenticar utilizadores e usa uma versão personalizada de Date of birth collection para recolher as datas de início e fim do período do extrato.
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.
Uma só conta
O utilizador final tem uma única conta. O agente recolhe as datas de início e fim do extrato, se o utilizador quer encriptar o extrato e envia o extrato da conta ao utilizador.
| Introdução do utilizador | Resposta do agente |
|---|---|
| O agente autentica o utilizador através do componente pré-criado Autenticação | |
| Obrigado. A sua identidade foi validada com êxito. | |
| Aguarde enquanto obtemos os detalhes da sua conta. Encontrámos um número de conta que termina em 1001 associado ao seu número. Indique a data de início do extrato de conta, começando pelo mês, seguido do dia e, depois, do ano. Tenha em atenção que o período do extrato da conta só é fornecido para os últimos 90 dias. |
|
| O agente recolhe a data de início da declaração através do componente pré-criado Data de nascimento | |
| Ótimo, recolhemos a data de início do extrato. Indique a data de fim do extrato da conta, começando pelo mês, seguido do dia e, depois, do ano. Tenha em atenção que o período do extrato da conta só é fornecido para os últimos 90 dias. |
|
| O agente recolhe a data de fim do extrato através do componente pré-criado Data de nascimento | |
| Obrigado. Confirme se procura o extrato de conta entre 12/07/2023 e 24/07/2023. | |
| Sim | |
| Aguarde enquanto obtemos os detalhes do seu extrato. Encontrámos transações de 12/07/2023 a 24/07/2023. Gostaria de a receber por email, SMS ou WhatsApp? |
|
| SMS | |
| Quer encriptar o documento antes de o partilharmos consigo? | |
| Não | |
| Vai receber o extrato no seu dispositivo móvel registado no prazo de 15 minutos. |
Várias contas
O utilizador final tem várias contas; o agente confirma para que conta o utilizador está a pedir um extrato de conta. O agente recolhe as datas de início e fim do extrato, se o utilizador quer encriptar o extrato e envia o extrato da conta ao utilizador.
| Introdução do utilizador | Resposta do agente |
|---|---|
| O agente autentica o utilizador através do componente pré-criado Autenticação | |
| Obrigado. A sua identidade foi validada com êxito. | |
| Aguarde enquanto obtemos os detalhes da sua conta. Constatámos que existem 2 contas associadas ao seu número. Pode indicar os últimos 4 dígitos da conta à qual se refere? |
|
| 2002 | |
| Os últimos quatro dígitos do número de conta que recebemos são 2002. Está correto? | |
| sim | |
| Indique a data de início do extrato da conta, começando pelo mês, seguido do dia e, por fim, do ano. Tenha em atenção que o período do extrato da conta só é fornecido para os últimos 90 dias. | |
| O agente recolhe a data de início da declaração através do componente pré-criado Data de nascimento | |
| Ótimo, recolhemos a data de início do extrato. Indique a data de fim do extrato da conta, começando pelo mês, seguido do dia e, depois, do ano. Tenha em atenção que o período do extrato da conta só é fornecido para os últimos 90 dias. |
|
| O agente recolhe a data de fim do extrato através do componente pré-criado Data de nascimento | |
| Obrigado. Confirme se procura o extrato da conta entre 18/07/2023 e 22/07/2023. | |
| Sim | |
| Aguarde enquanto obtemos os detalhes do seu extrato. Encontrámos transações de 18/07/2023 a 22/07/2023. Gostaria de a receber por email, SMS ou WhatsApp? |
|
| Quer encriptar o documento antes de o partilharmos consigo? | |
| Sim | |
| Os detalhes da palavra-passe são partilhados no seu WhatsApp registado. Recebe o extrato no prazo de 15 minutos no seu WhatsApp registado. |
Convenções de nomenclatura
Este componente pré-criado usa as seguintes convenções de nomenclatura:
| Funcionalidade | Formato | Exemplo |
|---|---|---|
| Flow | [Component Name] | Extracto da conta |
| Intenção específica do componente | prebuilt_components_[component_name]_[intent_name] | prebuilt_components_account_number_collection_four_digit_account_number |
| Tipo de 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 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 inicial do componente, conforme descrito abaixo. 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.auth_level | (Opcional) Indica o nível de autenticação do autor da chamada. | número inteiro |
| $session.params.auth_level_req | Indica o nível de autenticação necessário antes de um utilizador poder aceder ao extrato da respetiva conta. Este valor é configurado nas predefinições de parâmetros do preenchimento de entradas de páginas na página check auth level. Por predefinição, este valor é 1. |
número inteiro |
| $session.params.account_auth_enabled | Indica se o utilizador deve ser autenticado como titular da conta, conforme descrito em Tipos de autenticação. Este valor é configurado nas predefinições de parâmetros do preenchimento de entradas de páginas na página check auth level. Por predefinição, este valor é true. |
booleano |
| $session.params.card_auth_enabled | Indica se o utilizador deve ser autenticado como titular do cartão, conforme descrito em Tipos de autenticação. Este valor é configurado nas predefinições de parâmetros do preenchimento de entradas de páginas na página check auth level. Por predefinição, este valor é false. |
booleano |
| $session.params.phone_number | (Opcional) Número de telefone registado do cliente usado para autenticação. | de string |
| $session.params.account_count | (opcional) Número de contas associadas ao utilizador autenticado. | número inteiro |
| $session.params.last_four_digit_of_account_number | (opcional) Os últimos quatro dígitos do número de conta do cliente para o qual o extrato tem de ser facultado. Se o cliente tiver uma única conta, estas informações são obtidas automaticamente após a autenticação. Se o cliente tiver várias contas, o número de conta específico é recolhido junto do cliente. | de string |
| $session.params.account_statement_max_days | Especifica o número máximo de dias antes da data atual permitidos para a data de início de um extrato. Por predefinição, este valor é -90, o que indica que as datas de início dos extratos podem começar, no máximo, 90 dias antes da data atual. Este parâmetro é configurado na rota da página inicial true. |
número inteiro |
| $flow.max_retry_count | Especifica o número de novas tentativas permitidas quando é pedido ao utilizador final que indique uma data de fim do extrato válida. O valor predefinido é 3. |
número inteiro |
| $flow.max_retry_confirm_period_counter | Especifica o número de novas tentativas permitidas ao confirmar o período do extrato com o utilizador final. O valor predefinido é 3. |
número inteiro |
| $flow.max_retry_statement_counter | Especifica o número de novas tentativas permitidas quando o período do extrato fornecido não obtém nenhuma transação. 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 |
|---|---|---|
| auth_level | Indica o nível de autenticação do autor da chamada. | número inteiro |
| phone_number | Número de telefone local do utilizador, sem o indicativo do país, usado para identificar o utilizador. | de string |
| account_count | O número de contas associadas ao número de telefone registado. Estas contas incluem contas próprias e contas para as quais o utilizador tem procuração. | número inteiro |
| last_four_digit_of_account_number | Se um utilizador tiver uma única conta, são devolvidos os últimos quatro dígitos do número de conta. Se um utilizador tiver mais do que uma conta, o valor deste parâmetro são os últimos quatro dígitos do número da conta que o utilizador selecionou para receber informações do extrato de 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 abaixo.
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 para ver instruções detalhadas.
Valide a conta
O webhook prebuilt_components_account_services:validate_account é usado pelo componente para verificar se existe uma conta com base no número de telefone registado do utilizador e nos últimos quatro dígitos do número de conta fornecido.
O webhook também devolve o saldo da conta, se existir uma conta.
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 |
| $session.params.last_four_digit_of_account_number | Os últimos quatro dígitos do número de conta que o utilizador selecionou e confirmou para receber informações do extrato de conta. | 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 |
|---|---|---|
| account_found | Indica se existe uma conta com os últimos quatro dígitos fornecidos para a conta registada do utilizador. | booleano |
| saldo | O valor do saldo atual na conta, se existir. | número |
Para configurar o webhook de validação da conta 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_account_services:validate_account.
- 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.
Obtenha transações
O webhook prebuilt_components_account_statement:get_transactions é usado pelo componente para obter as transações de uma conta, dado o número de telefone registado do utilizador, os últimos quatro dígitos do número da conta e o período do extrato.
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 |
| $session.params.last_four_digit_of_account_number | Os últimos quatro dígitos do número de conta que o utilizador selecionou e confirmou para receber informações do extrato de conta. | de string |
| $flow.statement_start_date | A data de início do extrato pedida no formato "AAAA-MM-DD". | de string |
| $flow.statement_end_date | (opcional) A data de início do extrato pedida no formato "AAAA-MM-DD". Se o utilizador não fornecer nenhum valor ou o autor da chamada recusar-se a fornecer uma data de conclusão, o valor é predefinido para a data atual. | 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 |
|---|---|---|
| transactions_count | O número de transações encontradas para a conta especificada no período do extrato indicado. | número inteiro |
Para configurar o webhook Get transactions 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_account_statement:get_transactions.
- 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.
Solicite um extrato
O webhook prebuilt_components_account_statement:request_statement é usado pelo componente para enviar um extrato de uma conta para um canal selecionado, dado o número de telefone registado do utilizador, os últimos quatro dígitos do número de conta e o período do extrato.
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 |
| $session.params.last_four_digit_of_account_number | Os últimos quatro dígitos do número de conta que o utilizador selecionou e confirmou para receber informações do extrato de conta. | de string |
| $flow.statement_start_date | A data de início do extrato pedida no formato "AAAA-MM-DD". | de string |
| $flow.statement_end_date | (opcional) A data de início do extrato pedida no formato "AAAA-MM-DD". Se o utilizador não fornecer nenhum valor ou o autor da chamada recusar-se a fornecer uma data de conclusão, o valor é predefinido para a data atual. | de string |
| $flow.channel_medium | O canal que o utilizador 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, consoante o utilizador tenha um email registado. Por predefinição, são suportados os formatos email, mobile e WhatsApp. |
de string |
| $flow.encryption_status | Indica se o utilizador quer que o documento seja encriptado antes de ser enviado para o canal especificado. Se o utilizador não indicar nenhum valor ou o autor da chamada recusar-se a indicar uma data de conclusão, o valor é predefinido como true. |
booleano |
Para configurar o webhook de declaração de solicitação 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_account_statement:request_statement.
- 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.