O componente pré-criado do histórico de transações verifica o nível de autenticação do cliente e, em seguida, coleta o período das transações e outros filtros que são aplicados ao recuperar o histórico de transações. Este componente é compatível com filtros para:
- Tipo da transação
- Nome do comerciante
- Valor da transação
Se o cliente tiver várias contas, o componente confirmará a conta específica para a qual o cliente gostaria de recuperar o histórico de transações. Esse componente usa o componente pré-criado Authentication para autenticar usuários e usa uma versão personalizada da coleta de data de nascimento para coletar datas de início e término para o histórico de transações.
Limitações
Além das limitações comuns de componentes pré-criados, esse componente pré-criado tem as seguintes limitações:
- Este componente não criptografa nenhum dado.
Exemplos de diálogos
As caixas de diálogo de exemplo abaixo 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.
Várias contas
O usuário final tem várias contas. O agente confirma para qual conta o usuário está solicitando o histórico de transações. O agente coleta as datas de início e término das transações, os filtros que o usuário quer aplicar às transações e se ele quer criptografar o histórico de transações. O agente envia o histórico de transações ao usuário.
| Entrada do usuário | Resposta do agente |
|---|---|
| O agente autentica o usuário usando o componente pré-criado Authentication | |
| Agradecemos sua autenticação. | |
| Aguarde enquanto buscamos os detalhes da sua conta. Identificamos 2 contas associadas ao seu número. Informe os últimos quatro dígitos da conta a que você está se referindo. |
|
| 1001 | |
| Os últimos quatro dígitos do número da conta que recebemos são 1001, correto? | |
| Sim | |
| Informe a data de início das transações, começando com o mês, seguida pelo dia e depois pelo ano. O histórico de transações dos últimos 90 dias é fornecido apenas. | |
| O agente coleta a data de início das transações usando o componente pré-criado Data de nascimento | |
| Ótimo! Coletamos a data de início das suas transações. Informe a data de término das transações, começando com o mês, seguida pelo dia e depois pelo ano. O histórico de transações dos últimos 90 dias é fornecido apenas. |
|
| O agente coleta a data de início das transações usando o componente pré-criado Data de nascimento | |
| Agradecemos a atenção. Confirme se você está procurando as transações entre 25/06/2023 e 21/07/2023. | |
| Sim | |
| Informe o nome do comerciante responsável pelas transações. | |
| O nome do comerciante que capturamos é "Google". Pode confirmar com um "sim" ou "não"? | |
| Sim | |
| Quer ver o histórico de transações dos seus cartões de débito ou crédito? | |
| Crédito | |
| Forneça um valor para recuperar transações igual ou superior a determinado valor. Por exemplo, se você quiser encontrar transações acima de US $100,30, diga "100". | |
| 500 | |
| Aguarde enquanto buscamos os detalhes da sua transação. Encontramos transações de 02/06/2023 a 21/07/2023. Quer receber por SMS ou WhatsApp? |
|
| SMS | |
| Quer criptografar o documento antes de compartilhá-lo com você? | |
| Sim | |
| Os detalhes da senha vão ser compartilhados no seu dispositivo móvel registrado. Você vai receber a fatura em até 15 minutos no dispositivo móvel registrado. |
Convenções de nomeação
Esse componente pré-criado usa as seguintes convenções de nomenclatura:
| Recurso | Formato | Exemplo |
|---|---|---|
| Fluxo | [Nome do componente] | Histórico de transações |
| Intent específica do componente | prebuilt_components_[component_name]_[intent_name] | prebuilt_components_transaction_history_transaction_collection |
| Tipo da entidade | prebuilt_components_[component_name]_[entity_type] | prebuilt_components_transaction_history_det_cred |
| Webhook | prebuilt_components_[component_name]:[webhook_action] | prebuilt_components_transaction_history:get_transactions |
Parâmetros de entrada
Os parâmetros de entrada são usados para configurar determinados comportamentos do componente. Os parâmetros são usados por uma ou mais condições no fluxo para determinar como o componente vai se comportar. Os parâmetros com escopo de 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 | (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 histórico de transações. 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 deve ser autenticado como proprietário 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. |
boolean |
| $session.params.card_auth_enabled | Indica se o usuário deve 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. |
boolean |
| $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) Últimos quatro dígitos do número da conta do cliente para o qual o histórico de transações precisa ser fornecido. Se o cliente tiver apenas uma conta, essas informações serão recuperadas automaticamente depois da autenticação. Se o cliente tiver várias contas, o número específico será coletado do cliente. | string |
| $session.params.transaction_history_max_days | Especifica o número máximo de dias antes da data atual permitido para uma data de início de transações. Por padrão, esse valor é -90, indicando que as datas de início das transações podem começar no máximo 90 dias antes da data atual. Esse parâmetro é definido no trajeto 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 forneça datas de início e término válidas para transações. O valor padrão é 3. |
integer |
Para configurar os parâmetros de entrada desse componente, abra para conferir 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 de Predefinições de parâmetros conforme necessário.
- Clique em Save.
Parâmetros de saída
Os parâmetros de saída são parâmetros de sessão que permanecerão 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 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, utilizado 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 aquelas em que o usuário tem procuração. | integer |
| last_four_digit_of_account_number | Se um usuário tiver apenas uma 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ão os quatro últimos dígitos do número da conta que o usuário selecionou para receber o histórico de transações. | string |
| transfer_reason | Esse parâmetro indica o motivo pelo qual o fluxo saiu, se não tiver sido bem-sucedido. O valor retornado é um dos seguintes: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 tentativas para eventos sem entrada. Veja os eventos integrados sem entrada.max_no_match: a conversa atingiu o número máximo de 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: não foi possível acessar um URL do webhook. Consulte o 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 a configuração que descreve os serviços externos do Dialogflow. Consulte "Configuração do webhook" abaixo.
Configuração do webhook
Para usar esse componente, é preciso configurar os webhooks flexíveis incluídos para recuperar as informações necessárias dos serviços externos.
Authentication
Se você não tiver configurado serviços externos necessários para autenticação, configure-os para ativar a autenticação de usuários nesse componente. Consulte Configuração do webhook de autenticação para 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 da 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, utilizado para identificar o usuário. | string |
| $session.params.last_four_digit_of_account_number | Os últimos quatro dígitos do número da conta que o usuário selecionou e confirmou receber as informações de extrato da conta. | string |
Parâmetros de resposta da API
Os parâmetros a seguir são extraídos da resposta da API a ser usado 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 da conta registrada do usuário. | boolean |
| saldo | O valor do saldo atual na conta, se houver. | number |
Para configurar o webhook de validação da conta para este 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 Webhook URL do Dialogflow 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 o 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 exigidos pelo componente para acessar os valores de campo retornados.
- Analise e atualize as configurações da Autenticação conforme necessário.
- Clique em Save.
Acessar transações
O webhook prebuilt_components_transaction_history:get_transactions é usado
pelo componente para recuperar o número de transações de uma conta, de acordo com o
número de telefone registrado do usuário, os últimos quatro dígitos do número da conta, o
período do histórico de transações e os filtros selecionados pelo usuário.
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 |
| $session.params.last_four_digit_of_account_number | Os últimos quatro dígitos do número da conta que o usuário selecionou e confirmou que recebe o histórico de transações. | string |
| $flow.statement_start_date | A data de início do extrato solicitado no formato "AAAA-MM-DD". | string |
| $flow.statement_end_date | (Opcional) A data de início do extrato solicitado no formato "AAAA-MM-DD". Se o usuário ou o autor da chamada não informar uma data de término, o valor padrão será a atual. | string |
| $flow.transaction_credit_débito | Tipo de transação solicitado pelo usuário. Os valores válidos são definidos pela entidade personalizada prebuilt_components_transaction_history_det_cred. Por padrão, "credit" e "debit" são compatíveis. Se o usuário se recusar a selecionar um tipo, esse valor será uma string vazia "", e transações de qualquer tipo precisam ser contadas. |
string |
| $flow.merchant_name | Nome do comerciante solicitado pelo usuário. Se o usuário se recusar a fornecer o nome de um comerciante, esse valor será uma string vazia "", e as transações de todos os comerciantes serão contabilizadas. |
string |
| $flow.high_amount_value | Valor mínimo da transação solicitado pelo usuário. Se o usuário não informar um valor, o valor padrão desse parâmetro será 0. |
integer |
Parâmetros de resposta da API
Os parâmetros a seguir são extraídos da resposta da API a ser usado pelo componente.
| Nome do parâmetro | Descrição | Formato da saída |
|---|---|---|
| transactions_count | Número de transações encontradas para a conta especificada no período do extrato com os filtros selecionados aplicados. | integer |
Para configurar o webhook de "Receber transações" desse componente, expanda para ver 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_transaction_historyt:get_transactions.
- Substitua o URL no campo Webhook URL do Dialogflow 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 o 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 exigidos pelo componente para acessar os valores de campo retornados.
- Analise e atualize as configurações da Autenticação conforme necessário.
- Clique em Save.
Enviar informações
O webhook prebuilt_components_transaction_history:send_info é usado
pelo componente para enviar um histórico de transações a um canal selecionado, de acordo com o
número de telefone registrado do usuário, os últimos quatro dígitos do número da conta, o
período do histórico de transações e os filtros selecionados pelo usuário.
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 |
| $session.params.last_four_digit_of_account_number | Os últimos quatro dígitos do número da conta que o usuário selecionou e confirmou que recebe o histórico de transações. | string |
| $flow.statement_start_date | A data de início do extrato solicitado no formato "AAAA-MM-DD". | string |
| $flow.statement_end_date | (Opcional) A data de início do extrato solicitado no formato "AAAA-MM-DD". | string |
| $flow.transaction_credit_débito | Tipo de transação solicitado pelo usuário. Os valores válidos são definidos pela entidade personalizada prebuilt_components_transaction_history_det_cred. Por padrão, "credit" e "debit" são compatíveis. Se o usuário se recusar a selecionar um tipo, esse valor será uma string vazia "", e transações de qualquer tipo precisarão ser enviadas. |
string |
| $flow.merchant_name | Nome do comerciante solicitado pelo usuário. Se o usuário se recusar a fornecer o nome de um comerciante, esse valor será uma string vazia "", e as transações de todos os comerciantes deverão ser enviadas. |
string |
| $flow.high_amount_value | Valor mínimo da transação solicitado pelo usuário. Se o usuário não informar um valor, o valor padrão desse parâmetro será 0. |
integer |
| $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_transaction_history_phone e prebuilt_components_transaction_history_channel, dependendo se o usuário tem um e-mail registrado. Por padrão, email, mobile e whatsapp são compatíveis. |
string |
| $flow.encryption_status | Indica se o usuário quer o documento criptografado antes de enviá-lo ao canal especificado. Se o usuário ou o autor da chamada não informar uma data de término, o valor padrão será true se não for informado. |
boolean |
Para configurar o webhook "Enviar informações" para este componente, abra para ver 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_transaction_history:send_info.
- Substitua o URL no campo Webhook URL do Dialogflow 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 o 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 exigidos pelo componente para acessar os valores de campo retornados.
- Analise e atualize as configurações da Autenticação conforme necessário.
- Clique em Save.
Concluído
Seu agente e os webhooks dele agora estão configurados e prontos para teste.