O componente predefinido do histórico de transações verifica o nível de autenticação de um cliente e coleta o período de transações e outros filtros que são aplicados ao extrair o histórico de transações. Este componente oferece suporte a filtros para:
- Tipo da transação
- Nome do comerciante
- Valor da transação
Se o cliente tiver várias contas, o componente confirma a conta específica em que o cliente quer recuperar o histórico de transações. Esse componente usa o componente predefinido de autenticação 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 do histórico de transações.
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.
Várias contas
O usuário final tem várias contas. O agente confirma em 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, todos os filtros que o usuário quer aplicar às transações e se o usuário 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 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? |
|
| 1001 | |
| Os últimos quatro dígitos do número da conta que recebemos são 1001, certo? | |
| Sim | |
| Informe a data de início das transações, começando pelo mês, depois o dia e, por fim, o ano. O histórico de transações será fornecido apenas para os últimos 90 dias. | |
| O agente coleta a data de início das transações usando o componente predefinido Data de nascimento | |
| Ótimo, coletamos a data de início das suas transações. Informe a data de término das suas transações, começando pelo mês, depois o dia e, por fim, o ano. O histórico de transações será fornecido apenas para os últimos 90 dias. |
|
| O agente coleta a data de início das transações usando o componente predefinido Data de nascimento | |
| Obrigado. Confirme se você está procurando as transações entre 25/06/2023 e 21/07/2023. | |
| Sim | |
| Informe o nome do comerciante para quem você quer receber as transações. | |
| O nome do comerciante que capturamos é "Google". Você pode confirmar com um "sim" ou "não"? | |
| Sim | |
| Você quer conferir o histórico de transações dos seus cartões de débito ou crédito? | |
| Crédito | |
| Informe um valor para recuperar transações iguais ou maiores que o valor indicado. 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 2023-06-2 a 2023-07-21. Você quer receber por SMS ou WhatsApp? |
|
| SMS | |
| Você quer criptografar o documento antes de compartilhar com você? | |
| Sim | |
| Os detalhes da senha serão compartilhados no seu dispositivo móvel registrado. Você vai receber o extrato em até 15 minutos no seu dispositivo móvel registrado. |
Convenções de nomenclatura
Esse componente predefinido 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 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 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 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 o qual o histórico de transações 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.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 não podem ser mais de 90 dias antes da data atual. Esse parâmetro é definido 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 datas de início e término de transações válidas. 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 o histórico de transações. | 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_transaction_history:get_transactions é usado
pelo componente para extrair o número de transações de uma conta com base no
número de telefone registrado do usuário, nos últimos quatro dígitos do número da conta, no
período do histórico de transações e em todos 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, usado 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 para receber o histórico de transações. | 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.transaction_credit_debit | 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 aceitos. Se o usuário não selecionar um tipo, esse valor será uma string vazia "", e as transações de qualquer tipo serão contabilizadas. |
string |
| $flow.merchant_name | Nome do comerciante solicitado pelo usuário. Se o usuário não quiser informar o nome do 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, esse parâmetro terá um valor padrão de 0. |
integer |
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 com os filtros selecionados aplicados. | 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_transaction_historyt: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.
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 com base no
número de telefone registrado do usuário, nos últimos quatro dígitos do número da conta, no
período do histórico de transações e em todos 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, usado 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 para receber o histórico de transações. | 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". | string |
| $flow.transaction_credit_debit | 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 aceitos. Se o usuário não selecionar um tipo, esse valor será uma string vazia "", e transações de qualquer tipo serão enviadas. |
string |
| $flow.merchant_name | Nome do comerciante solicitado pelo usuário. Se o usuário não quiser informar o nome do comerciante, esse valor será uma string vazia "", e as transações de todos os comerciantes precisarã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, esse parâmetro terá um valor padrão de 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 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 "Enviar informaçõ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_transaction_history:send_info.
- 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.