O extrato do cartão de crédito componente pré-criado verifica o nível de autenticação de um cliente e, em seguida, envia o extrato do cartão de crédito durante um período especificado a 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 obter um extrato do cartão de crédito. Este componente usa uma versão personalizada do componente pré-criado de autenticação para autenticar os titulares de cartões e usa uma versão personalizada da recolha da data de nascimento para recolher as datas de início e de 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.
Cartão de crédito único
O utilizador final tem um único cartão de crédito. O agente recolhe as datas de início e fim do extrato, se o utilizador quer encriptar o extrato e envia o extrato do cartão de crédito 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 do seu cartão. Encontrámos um número de cartão terminado em 1002 associado ao seu número. |
|
| Indique a data de início do extrato do cartão de crédito, começando pelo mês, seguido do dia e, depois, do ano. Tenha em atenção que o extrato do cartão de crédito só é fornecido para os últimos 180 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 do cartão de crédito. Indique a data de fim do extrato do cartão de crédito, começando pelo mês, seguido do dia e, depois, do ano. Tenha em atenção que o extrato do cartão de crédito só é fornecido para os últimos 180 dias. |
|
| O agente recolhe a data de fim do extrato através do componente pré-criado Data de nascimento | |
| Ótimo. Recolhemos a data de fim do extrato do cartão de crédito. Obrigado. Confirme se procura o extrato entre 01/06/2023 e 30/06/2023. |
|
| Sim | |
| Aguarde enquanto obtemos os detalhes do seu extrato. Encontrámos transações entre 01/06/2023 e 30/06/2023. Quer recebê-lo por email, SMS ou WhatsApp? |
|
| Envia-o para o meu email | |
| Quer encriptar o documento antes de o partilharmos consigo? | |
| Não | |
| Vai receber o extrato no seu email registado no prazo de 15 minutos. |
Vários cartões de crédito
O utilizador final tem vários cartões de crédito; o agente confirma para que cartão o utilizador está a pedir um extrato do cartão de crédito. O agente recolhe as datas de início e fim do extrato, se o utilizador quer encriptar o extrato e envia o extrato do cartão de crédito 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 do seu cartão. Constatámos que existem 2 cartões associados ao seu número. Pode indicar-nos os últimos 4 dígitos do cartão a que se refere? |
|
| 1122 | |
| Os últimos quatro dígitos do número do cartão que recebemos são 1122. Está correto? | |
| Sim | |
| Indique a data de início do extrato do cartão de crédito, começando pelo mês, seguido do dia e, depois, do ano. Tenha em atenção que o extrato do cartão de crédito só é fornecido para os últimos 180 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 do cartão de crédito. Indique a data de fim do extrato do cartão de crédito, começando pelo mês, seguido do dia e, depois, do ano. Tenha em atenção que o extrato do cartão de crédito só é fornecido para os últimos 180 dias. |
|
| O agente recolhe a data de fim do extrato através do componente pré-criado Data de nascimento | |
| Ótimo. Recolhemos a data de fim do extrato do cartão de crédito. Obrigado. Confirme se procura o extrato entre 13/07/2023 e 14/07/2023. |
|
| Sim | |
| Aguarde enquanto obtemos os detalhes do seu extrato. Encontrámos transações entre 13/07/2023 e 14/07/2023. Quer recebê-lo por email, SMS ou WhatsApp? |
|
| SMS | |
| Quer encriptar o documento antes de o partilharmos consigo? | |
| Sim | |
| Os detalhes da palavra-passe são partilhados no seu dispositivo móvel registado. Vai receber o extrato no seu dispositivo móvel registado no prazo de 15 minutos. |
Convenções de nomenclatura
Este componente pré-criado usa as seguintes convenções de nomenclatura:
| Funcionalidade | Formato | Exemplo |
|---|---|---|
| Flow | [Component Name] | Extrato do cartão de crédito |
| Tipo de 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 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 do cartão de crédito. 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 Níveis 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.card_auth_enabled | Indica se o utilizador deve ser autenticado como titular do cartão, conforme descrito em Níveis 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.phone_number | (Opcional) Número de telefone registado do cliente usado para autenticação. | de string |
| $session.params.credit_card_count | (opcional) Número de cartões de crédito associados ao utilizador autenticado. | número inteiro |
| $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 tem de ser facultado. Se o cliente tiver um único cartão, estas informações são obtidas automaticamente após a autenticação. Se o cliente tiver vários cartões, é recolhido o número do cartão específico. | de string |
| $session.params.credit_card_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 é -180, o que indica que as datas de início dos extratos podem começar, no máximo, 180 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 |
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 |
| credit_card_count | O número de cartões de crédito associados ao número de telefone registado. | número inteiro |
| last_four_digit_of_card_number | Se um utilizador tiver um único cartão, são devolvidos os últimos quatro dígitos do número do cartão. Se um utilizador tiver mais do que um cartão, o valor deste parâmetro são os últimos quatro dígitos do número do cartão que o utilizador selecionou para receber informações do extrato do cartão de crédito. | 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.
Obtenha detalhes do cartão de crédito
O webhook prebuilt_components_credit_card_statement:credit_card_details é usado pelo componente para obter detalhes do cartão de crédito de um número de telefone registado.
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 |
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 |
|---|---|---|
| credit_card_count | O número de cartões de crédito associados ao número de telefone registado. | número inteiro |
| 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, este valor é null. |
de string |
O email registado do utilizador. Se não existir um email registado no número de telefone, este valor é null. |
de string |
Para configurar o webhook Get credit card details 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_credit_card_statement:credit_card_details.
- 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.
Valide o cartão
O webhook prebuilt_components_credit_card_statement:validate_date é usado pelo componente para validar se existe um determinado cartão de crédito para um número de telefone registado.
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_card_number | Os últimos quatro dígitos do número do cartão de crédito fornecido pelo utilizador. | 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 |
|---|---|---|
| valid_card | Indica se o cartão indicado foi encontrado para o número de telefone registado. | booleano |
Para configurar o webhook de validação de cartã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_credit_card_statement:validate_card.
- 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_credit_card_statement:card_transaction_details é usado pelo componente para obter as transações de um cartão, dado o número de telefone registado do utilizador, os últimos quatro dígitos do número do cartão 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_card_number | Os últimos quatro dígitos do número do cartão que o utilizador selecionou e confirmou para receber informações do extrato do cartão de crédito. | 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 o cartão de crédito especificado 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_credit_card_statement:card_transaction_details.
- 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_credit_card_statement:request_statement é usado pelo componente para enviar um extrato de um cartão de crédito para um canal selecionado, tendo em conta o número de telefone registado do utilizador, os últimos quatro dígitos do número do cartão de crédito 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_card_number | Os últimos quatro dígitos do número do cartão que o utilizador selecionou e confirmou para receber informações do extrato do cartão de crédito. | 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_statement_channel_phone e prebuilt_components_statement_channel_all, 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_credit_card_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.