O componente pré-criado de fatura do cartão de crédito verifica o nível de autenticação de um cliente e envia a fatura do cartão de crédito de um período especificado para um cliente autenticado. Se o cliente tiver vários cartões de crédito, o componente confirmará o cartão específico para o qual o cliente quer recuperar uma fatura de cartão de crédito. Esse componente usa uma versão personalizada do componente pré-criado de Autenticação para autenticar os titulares do cartão e uma versão personalizada de 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 pré-criados, este componente tem as seguintes limitações:
- Esse componente não criptografa dados.
Diálogos de exemplo
Os exemplos de diálogos a seguir demonstram cenários comuns processados por esse componente pré-criado. As caixas de diálogo de amostra 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.
Cartão de crédito único
O usuário final tem um único cartão de crédito. O agente coleta as datas de início e término da fatura, pergunta se o usuário quer criptografar o documento e envia a fatura do cartão de crédito para o usuário.
| Entrada do usuário | Resposta do agente |
|---|---|
| O agente autentica o usuário usando o componente pré-criado de autenticação | |
| Agradecemos sua atenção. A autenticação foi concluída. | |
| Aguarde enquanto buscamos os detalhes do seu cartão. Encontramos um Número do cartão com final 1002 associado ao seu número. |
|
| Informe a data de início da fatura do cartão de crédito, começando pelo mês, seguido pelo dia e depois pelo ano. A fatura do cartão de crédito será fornecida apenas para os últimos 180 dias. | |
| O agente coleta a data de início do extrato usando o componente pré-criado Data de nascimento | |
| Ótimo, já temos a data de início da fatura do seu cartão de crédito. Agora, informe a data de término da fatura, começando pelo mês, seguido pelo dia e depois pelo ano. A fatura do cartão de crédito será fornecida apenas para os últimos 180 dias. |
|
| O agente coleta a data de término do extrato 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 o contato. 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 | |
| Você quer criptografar o documento antes de compartilharmos com você? | |
| Agora não | |
| Você vai receber o extrato em até 15 minutos no 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 para qual cartão o usuário está solicitando uma fatura do cartão. O agente coleta as datas de início e término da fatura, pergunta se o usuário quer criptografar o documento e envia a fatura do cartão de crédito para o usuário.
| Entrada do usuário | Resposta do agente |
|---|---|
| O agente autentica o usuário usando o componente pré-criado de autenticação | |
| Agradecemos sua participação. Você foi validado. | |
| Aguarde enquanto buscamos os detalhes do seu cartão. Encontramos 2 cartões associados ao seu número. Informe os últimos 4 dígitos do cartão em questão. |
|
| 1122 | |
| Os últimos quatro dígitos do número do cartão que recebemos são 1122, correto? | |
| Sim | |
| Informe a data de início da fatura do cartão de crédito, começando pelo mês, seguido pelo dia e depois pelo ano. A fatura do cartão de crédito será fornecida apenas para os últimos 180 dias. | |
| O agente coleta a data de início do extrato usando o componente pré-criado Data de nascimento | |
| Ótimo, já temos a data de início da fatura do seu cartão de crédito. Agora, informe a data de término da fatura, começando pelo mês, seguido pelo dia e depois pelo ano. A fatura do cartão de crédito será fornecida apenas para os últimos 180 dias. |
|
| O agente coleta a data de término do extrato 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 o contato. Confirme se você está procurando o extrato 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 compartilharmos com você? | |
| Sim | |
| Os detalhes da senha serão compartilhados no seu celular registrado. Você vai receber o extrato em até 15 minutos no seu celular registrado. |
Convenções de nomenclatura
Este componente pré-criado usa as seguintes convenções de nomenclatura:
| Recurso | Formatar | Exemplo |
|---|---|---|
| Flow | [Nome do componente] | 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 deve 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 a fatura do cartão de crédito. Esse valor é configurado nas predefinições de parâmetro do fulfillment de entrada da 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 Níveis de autenticação. Esse valor é configurado nas predefinições de parâmetro do fulfillment de entrada da 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âmetro do fulfillment de entrada da 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) Os últimos quatro dígitos do número do cartão do cliente para o qual o extrato precisa ser fornecido. Se o cliente tiver um único 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 permitidos para uma data de início do extrato. Por padrão, esse valor é -180, indicando que as datas de início do extrato 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 forneça uma data de término válida para o extrato. 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 de Predefinições 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 sair 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, 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 o usuário tiver um único 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á os últimos quatro dígitos do número do cartão selecionado para receber informações da fatura do cartão. | string |
| transfer_reason | Esse parâmetro indica o motivo da saída do fluxo, 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 da 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 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 do webhook estava inacessível. 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 seus serviços externos. Consulte a configuração do webhook abaixo.
Configuração do webhook
Para usar esse componente, você precisa configurar os webhooks flexíveis incluídos para recuperar as informações necessárias dos seus serviços externos.
Autenticação
Se você ainda não configurou os serviços externos necessários para autenticação, será preciso configurá-los para ativar a autenticação de usuários para esse componente. Consulte Configuração do webhook de autenticação para 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 número do cartão de crédito do cliente. Se o cliente tiver vários cartões, esse valor será null. |
string |
O e-mail registrado do usuário. Se não houver um e-mail registrado no número de telefone, esse valor será null. |
string |
Para configurar o webhook "Receber detalhes do cartão de crédito" 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_credit_card_statement:credit_card_details.
- Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
- Revise e atualize o corpo da solicitação para criar 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 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.
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 | Os ú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.
- 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_credit_card_statement:validate_card.
- Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
- Revise e atualize o corpo da solicitação para criar 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 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_credit_card_statement:card_transaction_details é usado
pelo componente para recuperar as transações de um cartão, considerando o número de telefone
registrado do usuário, 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 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 nenhum valor for fornecido pelo usuário ou se o autor da chamada se recusar a 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. | integer |
Para configurar o webhook de transações 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_credit_card_statement:card_transaction_details.
- Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
- Revise e atualize o corpo da solicitação para criar 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 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_credit_card_statement:request_statement é usado
pelo componente para enviar um extrato de um cartão de crédito para um canal selecionado, considerando
o número de telefone registrado do usuário, os últimos quatro dígitos do número do cartão de crédito
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 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 nenhum valor for fornecido pelo usuário ou se o autor da chamada se recusar a 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 aceitos. |
string |
| $flow.encryption_status | Indica se o usuário quer que o documento seja criptografado antes de ser enviado ao canal especificado. Se nenhum valor for fornecido pelo usuário ou se o autor da chamada se recusar a fornecer uma data de término, o valor padrão será true. |
booleano |
Para configurar o webhook de solicitação de extrato 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_credit_card_statement:request_statement.
- Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
- Revise e atualize o corpo da solicitação para criar 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 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 agora devem estar configurados e prontos para teste.