Transmitir parâmetros de dados

Nesta página, explicamos como capturar parâmetros de dados de cabeçalhos do protocolo de iniciação de sessão (SIP) de entrada e transmiti-los para agentes virtuais, assistentes virtuais de tarefas e cabeçalhos SIP de saída.

Parâmetros de dados por canal

A tabela a seguir é uma visão geral de alto nível que descreve a disponibilidade de parâmetros de dados por canal.

Tipo de parâmetro de dados Agente virtual de suporte ao cliente Assistente virtual de tarefas
Web Dispositivo móvel IVR SMS Web Dispositivo móvel IVR SMS
Corrigido
Dinâmica Metadados da plataforma Contact Center AI (CCAI)
Parâmetros assinados
Parâmetros não assinados
Cabeçalhos SIP
Formulário

Capturar parâmetros de dados dos cabeçalhos SIP de entrada

É possível capturar parâmetros de dados dos cabeçalhos SIP de entrada e transmiti-los para o seguinte:

Também é possível configurar a plataforma CCAI para incluir dados de cabeçalho SIP de entrada em registros do CRM e arquivos de metadados da sessão.

Para capturar parâmetros de dados dos cabeçalhos SIP de entrada, siga estas etapas:

  1. No portal da plataforma CCAI, clique em Configurações > Gerenciamento de operações. Se o menu Configurações não aparecer, clique em Menu.

  2. Acesse o painel Parâmetros de dados.

  3. Em Voz, selecione Capturar parâmetros de dados dos cabeçalhos SIP de entrada em sessões de URA.

  4. Para usar dados de cabeçalho SIP no identificador de chamadas, faça o seguinte:

    1. Selecione Usar dados de cabeçalho SIP para o identificador de chamadas.

    2. No campo Nome do campo, insira o nome do campo de cabeçalho SIP.

  5. Selecione Incluir dados de cabeçalho SIP nos registros de CRM da sessão para incluir dados de cabeçalho SIP como um comentário no registro de CRM.

  6. Selecione Incluir dados de cabeçalho SIP em arquivos de metadados da sessão para incluir dados de cabeçalho SIP no arquivo de metadados da sessão.

  7. Clique em Salvar parâmetros de dados.

Registro de CRM

O exemplo de código a seguir mostra como os parâmetros de dados de um cabeçalho SIP de entrada apareceriam em um registro de CRM:

Call redirected to external SIP.
SIP destination: <<SIP Destination URI>>
Data parameters passed:
{
   "<<destination_field_#1>>" : "<<destination_value_#1>>",
   "<<destination_field_#2>>" : "<<destination_value_#2>>"
 }

É possível incluir dados de cabeçalho SIP em registros dos seguintes CRMs:

Arquivo de metadados da sessão

O exemplo de código a seguir mostra como os parâmetros de dados de um cabeçalho SIP de entrada ficariam em um arquivo de metadados da sessão:

"sip_headers": {
  "header 1": "value 1",
  "header 2": "value 2"
}

Transmitir parâmetros de dados para cabeçalhos SIP de saída

Para informações sobre preços e implementação, entre em contato com o suporte.

Para enviar dados a um destino SIP externo, a configuração de SIP de saída para Pass Data Parameters usa o recurso de redirecionamento automático. Os parâmetros de dados definidos no cabeçalho SIP de entrada são coletados e transmitidos para o destino externo atribuído à fila de URA selecionada.

Com a opção "Transmitir parâmetros de dados para um SIP de saída", você pode:

  • Configure parâmetros de dados estáticos ou dinâmicos no nível da fila da URA. Um parâmetro fixo ajuda a transmitir um valor estático. Um parâmetro dinâmico permite recuperar e transmitir um valor (dinamicamente).

  • Transmita os parâmetros de configuração nos cabeçalhos SIP de saída durante redirecionamentos automáticos.

Configurações do administrador

  1. Acesse Configurações > Fila > URA e selecione a fila.

  2. Acesse a seção Redirecionamento automático e confira se o botão está definido como Mostrar.

  3. Clique no link Configurar transferência SIP.

  4. No painel de configuração de SIP de saída, insira o URI SIP de destino no formato +ccNumber@fqdn. Há um limite de 256 caracteres para esse valor.

  5. Acesse a seção Transmitir parâmetros de dados e verifique se o botão está definido como Ativado. Os parâmetros de transmissão de dados só podem ser ativados depois que o URI SIP de destino for inserido.

Adicionar um parâmetro fixo para um cabeçalho SIP

  1. Clique no botão Adicionar parâmetro.

  2. Em Tipo, selecione Fixo.

  3. Preencha os seguintes campos

    Campo de destino: o nome do campo em que o valor do parâmetro de dados será transmitido para o Dialogflow CX.

    Valor de destino: o valor que está sendo transmitido.

    Uma amostra do parâmetro é mostrada em Prévia.

  4. Clique em Salvar.

Adicionar um parâmetro dinâmico de um cabeçalho SIP

  1. Clique no botão Adicionar parâmetro.

  2. Em Tipo, selecione Dinâmico.

  3. Em Origem, selecione Cabeçalho SIP.

  4. Preencha os seguintes campos:

    Campo de entrada: o nome do campo no cabeçalho SIP de entrada cujo valor será transmitido ao Dialogflow CX. Esta é uma entrada de texto livre (string)

    Campo de destino: o nome do campo em que o valor do parâmetro de dados será transmitido para o Dialogflow CX.

    Uma amostra do parâmetro é mostrada em Prévia.

  5. Clique em Salvar.

Registros de dados

Use as caixas de seleção na seção Registros de dados para indicar se você quer que os parâmetros de dados transmitidos sejam incluídos nos arquivos de metadados da sessão ou nos registros de CRM.

Clique em Salvar e depois no link Voltar às configurações.

Transmitir parâmetros de dados para agentes virtuais e assistentes de tarefas virtuais

Os parâmetros de dados coletam informações de chamadas recebidas, retêm esses dados durante a ligação e os transmitem de volta aos serviços do Dialogflow CX quando a chamada é encaminhada para um agente virtual ou assistente virtual de tarefas. Os parâmetros de dados são retornados em um formato definido nas APIs do Dialogflow quando você invoca o agente do Dialogflow CX.

Você pode adicionar um parâmetro de dados para:

  • Colete configurações de dados estáticos ou dinâmicos no nível da fila da URA. Um parâmetro fixo ajuda você a transmitir um valor estático. Um parâmetro dinâmico permite recuperar e transmitir um valor (de forma dinâmica).

  • Coletar dados usando um parâmetro de formulário dinâmico: disponível apenas para o Assistente de tarefas virtuais quando os parâmetros de formulário estão configurados. Um formulário de captura de dados é fornecido ao agente no Adaptador de agente quando ele implanta o Assistente de tarefas virtuais. Um parâmetro de formulário define os campos que o agente precisa preencher. Por exemplo, se o valor do campo de formulário for booking_id, um campo de entrada manual correspondente vai aparecer no adaptador. Para que um agente envie um assistente de tarefas para receber o pagamento, o booking_id precisa ser fornecido.

Os seguintes parâmetros podem ser adicionados a um novo ou existente Agente virtual ou Assistente de tarefas virtuais:

  • Parâmetros fixos

  • Parâmetros de metadados da CCAI Platform

  • Parâmetros de cabeçalho SIP

  • Parâmetro "Formulário do agente" (disponível apenas para o Assistente de tarefas virtuais)

Adicionar um parâmetro fixo

Os parâmetros de dados fixos são campos que o sistema transmite automaticamente para o VA e o Assistente de tarefas.

  1. Clique no botão Adicionar parâmetro.
  2. Em Tipo, selecione Fixo.
  3. Preencha os seguintes campos:
    1. Campo de destino: o nome do campo em que o valor do parâmetro de dados será transmitido para o Dialogflow CX.
    2. Valor de destino: o valor transmitido.
  4. Uma amostra do parâmetro será mostrada na prévia.

Adicionar um parâmetro dinâmico dos metadados da plataforma CCAI

  1. Clique no botão Adicionar parâmetro.

  2. Em Tipo, selecione Dinâmico.

  3. Em Origem, selecione Metadados da CCAIP.

  4. No menu suspenso Campo de entrada, selecione o tipo de metadados da CCAIP que serão transmitidos para o Dialogflow CX. Os seguintes parâmetros de dados de metadados da CCAIP podem ser transmitidos:

    • ANI (número de telefone): o número de telefone de onde o usuário final está ligando.

    • ID do consumidor: o ID exclusivo do usuário final na plataforma.

    • ID da chamada: o ID exclusivo da chamada na plataforma.

    • ID do tíquete (CRM): o ID do tíquete do CRM vinculado à sessão.

    • ID da fila: o ID da fila da sessão de onde a conversa foi encaminhada.

    • DNIS/TFN: o DNIS (Serviço de identificação de número discado) ou TFN (Número sem custo financeiro) se refere ao número de telefone exclusivo que um usuário final disca para acessar seu sistema de suporte ao cliente.

    • ID do agente mais recente: um ID gerado pelo sistema e atribuído a cada agente que opera na plataforma CCAI Platform. Esse ID identifica de forma exclusiva o agente responsável por processar o segmento mais recente de uma chamada em andamento.

    • E-mail do agente mais recente: o endereço de e-mail associado ao agente que atendeu o último segmento de uma chamada ativa.

    • Idioma da fila: o código abreviado do idioma que identifica a fila ou o departamento designado para onde uma chamada está sendo transferida com base nos requisitos de idioma.

    • Pontuação de sentimento atual: a pontuação média de sentimento do segmento mais recente de uma chamada.

    • Pontuação geral de sentimento: uma avaliação cumulativa do sentimento ou nível de satisfação durante toda a ligação até o momento da transferência.

  5. No Campo de destino, insira o nome do campo em que o valor do parâmetro de dados será transmitido para o Dialogflow CX. Uma amostra do parâmetro será mostrada na prévia.

  6. Clique em Salvar.

Adicionar um parâmetro dinâmico de um cabeçalho SIP

  1. Clique no botão Adicionar parâmetro.

  2. Em Tipo, selecione Dinâmico.

  3. Em Origem, selecione Cabeçalho SIP. Preencha os seguintes campos:

    1. Campo de entrada: o nome do campo no cabeçalho SIP de entrada que será transmitido para a plataforma CCAI. Esta é uma entrada de texto livre (string).

    2. Campo de destino: o nome do campo em que o valor do parâmetro de dados será transmitido para a plataforma CCAI.

  4. Uma amostra do parâmetro vai aparecer na prévia.

Adicionar um parâmetro dinâmico de formulário personalizado

Quando os parâmetros do formulário do agente são configurados, um formulário de captura de dados é fornecido ao agente no Adaptador de agente quando ele implanta o Assistente de tarefas virtuais. Um parâmetro de formulário define os campos que o agente precisa preencher. Por exemplo, se o valor do campo de formulário for booking_id, um campo de entrada manual correspondente vai aparecer no adaptador. Para que um agente envie um Assistente de tarefas para coletar o pagamento, ele precisa inserir o booking_id.

  1. Clique em + Adicionar parâmetro.

  2. No menu suspenso Tipo, selecione Dinâmico.

  3. No menu suspenso Origem, selecione Formulário.

  4. Insira o nome do campo que vai aparecer no adaptador de agente.

  5. Marque a caixa de seleção Obrigatório para especificar que o parâmetro precisa ser preenchido antes de transferir a sessão para um assistente de tarefas virtual.

  6. Insira o parâmetro de destino. Revise o parâmetro na janela de visualização antes de enviar, porque todas as mudanças serão aceitas sem validação.

  7. Clique em Salvar.

Ativar a transmissão de parâmetros de dados no nível da fila

  1. No portal da plataforma de CCAI, acesse Configurações > Fila > URA e selecione a fila.

  2. Confirme se a fila tem agentes virtuais atribuídos a ela e clique no link Editar atribuições de agente virtual. Se a fila selecionada não tiver agentes virtuais atribuídos, clique no botão Adicionar agente virtual para configurar um novo agente virtual antes de continuar.

  3. Acesse a seção Transmitir parâmetros de dados e verifique se a opção está definida como Ativada.

Transmitir parâmetros de dados do SDK da Web para um agente virtual

Para transmitir parâmetros de dados do SDK da Web para um agente virtual por uma fila usando dados personalizados não assinados, siga estas etapas:

  1. No portal da plataforma CCAI, clique em Configurações > Fila. Se o menu Configurações não aparecer, clique em Menu.

  2. No painel Web, clique em Editar / Ver.

  3. Clique na fila a que você quer adicionar parâmetros.

  4. No SDK, adicione dados personalizados usando o seguinte exemplo de formatação:

var ujet = new UJET({
[...]
  customData: {
  "k1": {
    "label": "Version",
    "value": "1.2.3"
  },
  "k2": {
    "label": "Dashboard",
    "value": "<http://example.com>"
  }
  }

})

Em seguida, acesse-o no VA usando o seguinte comando:

$session.params.valuek1

Esse comando vai resultar em uma saída de 1.2.3.

Um comando de parâmetro de dados precisa ser adicionado para cada um. Portanto, para usar k2 como no exemplo anterior, outro precisa ser criado.

Configuração do administrador

  1. Acesse Configurações > Fila > URA e selecione a fila.

  2. Confirme se a fila tem agentes virtuais atribuídos a ela e clique no link Editar atribuições de agente virtual.

    OBSERVAÇÃO: se a fila selecionada não tiver agentes virtuais atribuídos, clique no botão Adicionar agente virtual para configurar um novo agente virtual antes de continuar.

  3. Acesse a seção Transmitir parâmetros de dados e verifique se a opção está definida como "Ativada".

Adicionar um parâmetro fixo

  1. Clique no botão Adicionar parâmetro.

  2. Em Tipo, selecione Fixo.

  3. Preencha os seguintes campos

    Campo de destino: o nome do campo em que o valor do parâmetro de dados será transmitido para o Dialogflow CX.

    Valor de destino: o valor que está sendo transmitido.

    Uma amostra do parâmetro é mostrada na prévia.

Adicionar um parâmetro dinâmico dos metadados da plataforma CCAI

  1. Clique no botão Adicionar parâmetro.

  2. Em Tipo, selecione Dinâmico.

  3. Em Origem, selecione Metadados da CCAI Platform.

  4. No menu suspenso Campo de entrada, selecione o tipo de metadados da plataforma de CCAI que precisa ser transmitido para o Dialogflow.

    Os seguintes parâmetros de dados de metadados da CCAI Platform podem ser transmitidos:

    ANI (número de telefone)

    ID do consumidor

    ID da chamada

    ID do tíquete (CRM)

    ID da fila

  5. Em Campo de destino, insira o nome do campo em que o valor do parâmetro de dados será transmitido para o Dialogflow CX.

    Uma amostra do parâmetro é mostrada na prévia.

  6. Clique em Salvar.

Adicionar um parâmetro dinâmico de um cabeçalho SIP

  1. Clique no botão Adicionar parâmetro.

  2. Em Tipo, selecione Dinâmico.

  3. Em Origem, selecione Cabeçalho SIP.

  4. Preencha os seguintes campos:

    Campo de entrada: o nome do campo no cabeçalho SIP de entrada cujo valor será transmitido ao Dialogflow CX. Essa é uma entrada de texto livre (string).

    Campo de destino: o nome do campo em que o valor do parâmetro de dados será transmitido para o Dialogflow CX.

    Uma amostra do parâmetro é mostrada na prévia.

Registros de dados

Use as caixas de seleção na seção Registros de dados para indicar se você quer que os parâmetros de dados transmitidos sejam incluídos nos arquivos de metadados da sessão ou nos registros de CRM.

Clique em Salvar e depois no link Voltar às configurações.

Transmitir parâmetros de dados para agentes virtuais no meio da sessão

Esse recurso permite a transmissão de parâmetros de dados no meio da sessão. Ele incentiva interações dinâmicas e oferece suporte a experiências melhores para o usuário ao permitir o compartilhamento de dados contextuais com agentes virtuais no meio da sessão. Essa atualização apresenta um novo endpoint de API que permite aos clientes receber parâmetros de dados do SDK durante sessões de chat e transmiti-los a um agente virtual se uma sessão correspondente estiver em andamento. Isso é útil para cenários como autenticação no meio da sessão.

Dados seguros (assinados) ou não seguros (não assinados) podem ser enviados pela API Apps. No entanto, todas as solicitações à API são protegidas por uma chave de API, ajudando a garantir que os dados sejam protegidos durante a transmissão.

Os dados personalizados passam pelo seguinte processo:

  1. Os dados personalizados chegam pelos endpoints do SDK ou da API Apps.

  2. Os dados personalizados são armazenados ou mesclados com os dados atuais da conversa.

  3. Os dados personalizados são anexados à chamada "detect_response" da resposta do usuário final junto com a mensagem dele.

  4. Os dados personalizados são transmitidos ao agente virtual.

  5. Todos os novos dados personalizados são postados no CRM.

endpoint de API

É necessário usar um endpoint de API do Google Apps para aceitar dados personalizados em uma chamada ou conversa no meio da sessão.

POST
/apps/api/v1/[chats|calls]/:id/custom_data

Ele recebe um payload de dois tipos possíveis: seguro (assinado) ou não seguro (não assinado).

Dados protegidos (assinados com JWT):

{
"signed": true,
"signed_data": "JWT_SIGNED_DATA"
}
{
  "custom_data": {
    "reserved_verified_customer": {
      "value": true
    },
    "reserved_bad_actor": {
      "value": false
    },
    "reserved_repeat_customer": {
      "value": true
    },
    "field1": {
      "value": "dummy1"
    },
    "field2": {
      "value": "dummy2"
    }
  },
  "exp": 1734567890,
  "iat": 1734560000
}

Dados não protegidos:

{
  "signed": false,
  "data": {
    "reserved_verified_customer": {
      "value": true
    },
    "reserved_bad_actor": {
      "value": false
    },
    "reserved_repeat_customer": {
      "value": true
    },
    "field1": {
      "value": "dummy1"
    },
    "field2": {
      "value": "dummy2"
    }
  }
}