Componente predefinido de extrato de cartão de crédito

Na fatura do cartão de crédito componente pré-criado Verifica o nível de autenticação de um cliente, depois envia a fatura do cartão de crédito por um período específico para uma de um cliente autenticado. Se o cliente tiver vários cartões de crédito, o componente confirma o cartão específico para o qual o cliente quer recuperar uma extrato de cartão de crédito. Esse componente usa uma versão personalizada do Autenticação pré-criado para autenticar titulares de cartões e usa uma versão personalizada do 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 a resposta do agente no início da conversa.

Cartão de crédito único

O usuário final tem apenas um cartão de crédito. O agente coleta o início da instrução e datas de término, se o usuário deseja criptografar a instrução e envia a fatura do cartão de crédito ao usuário.

Entrada do usuário Resposta do agente
O agente autentica o usuário com o componente pré-criado do Authentication
Agradecemos. Sua autenticação foi concluída.
Aguarde enquanto buscamos os detalhes do seu cartão.

Encontramos um número de cartão com final 1002 associado ao seu número.
Informe a data de início do extrato do cartão de crédito, começando pelo mês, depois o dia e, por fim, o ano. A fatura do cartão de crédito é referente apenas aos últimos 180 dias.
O agente coleta a data de início da declaração usando o componente predefinido Data de nascimento
Ótimo, coletamos a data de início da fatura do seu cartão de crédito.

Informe a data de término da fatura do cartão de crédito, começando pelo mês, seguido pelo dia e, por fim, pelo ano. A fatura do cartão de crédito é referente apenas aos últimos 180 dias.
O agente coleta a data de término da instrução usando o componente pré-criado Data de nascimento
Ótimo, coletamos a data de término da fatura do seu cartão de crédito.

Agradecemos. Confirme se você está procurando o extrato entre 01/06/2023 e 30/06/2023.
Sim
Aguarde enquanto buscamos os detalhes do seu extrato.

Encontramos transações entre 01/06/2023 e 30/06/2023. Você quer receber por e-mail, SMS ou WhatsApp?
Enviar para meu e-mail
Quer criptografar o documento antes de compartilharmos com você?
Agora não
Você vai receber o extrato em até 15 minutos no seu e-mail registrado.

Vários cartões de crédito

o usuário final tem vários cartões de crédito; o agente confirma qual cartão o usuário está solicitando um extrato do cartão de crédito. 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 do cartão de crédito ao usuário.

Entrada do usuário Resposta do agente
O agente autentica o usuário com o componente pré-criado do Authentication
Agradecemos. Sua conta foi validada.
Aguarde enquanto buscamos os detalhes do seu cartão.

Descobrimos que há dois cartões associados ao seu número. Informe os quatro últimos dígitos do cartão a que você se refere.
1122
Os últimos quatro dígitos do número do cartão que recebemos são 1122, certo?
Sim
Informe a data de início do extrato do cartão de crédito, começando pelo mês, depois pelo dia e depois pelo ano. O extrato do cartão de crédito será fornecido apenas para os últimos 180 dias.
O agente coleta a data de início da instrução usando o componente pré-criado Data de nascimento
Ótimo, coletamos a data de início da fatura do seu cartão de crédito.

Informe a data de término da fatura do cartão de crédito, começando pelo mês, seguido pelo dia e, por fim, pelo ano. A fatura do cartão de crédito é referente apenas aos últimos 180 dias.
O agente coleta a data de término da declaração usando o componente predefinido Data de nascimento
Ótimo, coletamos a data de término da fatura do seu cartão de crédito.

Obrigado. Confirme se você está procurando a declaração entre 13/07/2023 e 14/07/2023.
Sim
Aguarde enquanto buscamos os detalhes do seu extrato.

Encontramos transações entre 13/07/2023 e 14/07/2023. Você quer receber por e-mail, SMS ou WhatsApp?
SMS
Você quer criptografar o documento antes de compartilhar com você?
Sim
Os detalhes da senha vão ser compartilhados no seu dispositivo móvel registrado.

Você vai receber o extrato em até 15 minutos no dispositivo móvel registrado.

Convenções de nomenclatura

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

Recurso Formato Exemplo
Fluxo [Component Name] Fatura do cartão de crédito
Tipo da entidade prebuilt_components_[component_name]_[entity_type] prebuilt_components_statement_channel_all
Webhook prebuilt_components_[component_name]:[webhook_action] prebuilt_components_credit_card_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. No escopo da sessão podem ser definidos por um fluxo de chamada ou no início página desse 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 a fatura do cartão de crédito. Esse valor é configurado nas predefinições de parâmetro do fulfillment de entrada de página na check auth level página. 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 Níveis 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.card_auth_enabled Indica se o usuário precisa ser autenticado como titular do cartão, conforme descrito em Níveis 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.phone_number (opcional) Número de telefone registrado do cliente usado para autenticação. string
$session.params.credit_card_count (Opcional) Número de cartões de crédito associados ao usuário autenticado. integer
$session.params.last_four_digit_of_card_number (Opcional) Últimos quatro dígitos do cartão do cliente relacionado ao extrato. Se o cliente tiver apenas um cartão, essas informações serão recuperadas automaticamente após a autenticação. Se o cliente tiver vários cartões, o número do cartão específico será coletado do cliente. string
$session.params.credit_card_statement_max_days Especifica o número máximo de dias antes da data atual permitida para uma data de início de extrato. Por padrão, esse valor é -180, indicando que as datas de início da instrução podem começar no máximo 180 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

Para configurar os parâmetros de entrada desse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Build.
  5. Clique no componente importado na seção Fluxos.
  6. Clique na página inicial na seção Páginas.
  7. Clique na rota true na página inicial.
  8. Na janela "Rota", edite os valores das configurações predefinidas de parâmetros conforme necessário.
  9. 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 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 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
credit_card_count O número de cartões de crédito associados ao número de telefone registrado. integer
last_four_digit_of_card_number Se um usuário tiver apenas um cartão, os últimos quatro dígitos do número do cartão serão retornados. Se um usuário tiver mais de um cartão, o valor desse parâmetro serão os últimos quatro dígitos do número do cartão que o usuário selecionou para receber informações na fatura do cartão de crédito. string
transfer_reason Esse parâmetro indica o motivo da saída do fluxo, caso não tenha 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 recusou o compartilhamento de 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 o evento integrado webhook.error.

webhook_not_found: um URL de webhook estava inacessível. Consulte 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 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 configurou os serviços externos necessários para você precisará configurá-los para ativar a autenticação de usuários para esse componente. Consulte Configuração de webhook de autenticação para ver instruções detalhadas.

Receber detalhes do cartão de crédito

O webhook prebuilt_components_credit_card_statement:credit_card_details é usado pelo componente para recuperar detalhes do cartão de crédito de um número de telefone registrado.

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

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
credit_card_count O número de cartões de crédito associados ao número de telefone registrado. integer
credit_card Últimos quatro dígitos do cartão de crédito do cliente. Se o cliente tiver vários cartões, esse valor será null. string
e-mail O e-mail registrado do usuário. Se não houver e-mail registrado no número de telefone, esse valor será null. string

Para configurar o webhook "Get credit card details" para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_credit_card_statement:credit_card_details.
  7. Substitua o URL no campo Webhook URL dos Agentes de conversa (Dialogflow CX) pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o Corpo da solicitação para formar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos do objeto. resposta. Não modifique os nomes dos parâmetros, pois eles são exigidos pelo componente para acessar os valores de campo retornados.
  10. Analise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Validar cartão

O webhook prebuilt_components_credit_card_statement:validate_date é usado pelo componente para validar se um determinado cartão de crédito existe para um número de telefone registrado.

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_card_number Últimos quatro dígitos do número do cartão de crédito fornecido pelo 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
valid_card Indica se o cartão foi encontrado para o número de telefone registrado. booleano

Para configurar o webhook de validação de cartão para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_credit_card_statement:validate_card.
  7. 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.
  8. Revise e atualize o Corpo da solicitação para formar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos do objeto. resposta. Não modifique os nomes dos parâmetros, pois eles são exigidos pelo componente para acessar os valores de campo retornados.
  10. Analise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Receber transações

O webhook prebuilt_components_credit_card_statement:card_transaction_details é usado pelo componente para recuperar as transações de um cartão de acordo com o método número de telefone registrado, os últimos quatro dígitos do número do cartão e o 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_card_number Os últimos quatro dígitos do número do cartão que o usuário selecionou e confirmou para receber informações da fatura do cartão de crédito. 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 o cartão de crédito especificado no período do extrato em questão. integer

Para configurar o webhook "Pegar transações" para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_credit_card_statement:card_transaction_details.
  7. 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.
  8. Revise e atualize o Corpo da solicitação para formar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos do objeto. resposta. Não modifique os nomes dos parâmetros, pois eles são exigidos pelo componente para acessar os valores de campo retornados.
  10. Analise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Solicitar extrato

O webhook prebuilt_components_credit_card_statement:request_statement é usado pelo componente para enviar uma fatura de um cartão de crédito para um canal selecionado, considerando o número de telefone registrado do usuário, os quatro últimos dígitos do número do cartão de crédito e o período da fatura.

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_card_number Os últimos quatro dígitos do número do cartão que o usuário selecionou e confirmou para receber informações da fatura do cartão de crédito. 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_statement_channel_phone e prebuilt_components_statement_channel_all, 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 que o documento seja criptografado antes do envio para o canal especificado. Se nenhum valor for fornecido pelo usuário ou autor da chamada se recusar a informar uma data de término, o valor padrão será true. booleano

Para configurar o webhook de instrução de solicitação para este componente, expanda para ver instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_credit_card_statement:request_statement.
  7. Substitua o URL no campo Webhook URL dos Agentes de conversa (Dialogflow CX) pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o Corpo da solicitação para formar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos do objeto. resposta. Não modifique os nomes dos parâmetros, pois eles são exigidos pelo componente para acessar os valores de campo retornados.
  10. Analise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Concluído

Seu agente e os respectivos webhooks devem estar configurados e prontos para teste.