---
sourceDocument: Interfaces conversacionais de Yokohama
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/yokohama/conversational-interfaces
Release :
- yokohama
ft:locale :
- pt-BR
ft:publication_title :
- Interfaces conversacionais de Yokohama
ft:clusterId :
- convint
bundleId :
- convint
workflow :
- Platform
---
# Virtual Agent Recursos de API disponíveis na versão 2,0.x da Loja
# Virtual Agent Recursos de API disponíveis na versão 2,0.x da Loja {#ariaid-title1}
* Versão de lançamento: Yokohama
*
* Atualizado 30 de jan. de 2025
*
*  12 min. de leitura
Virtual AgentA API versão 2,0.x fornece acesso a mais dos mesmos recursos que estão disponíveis em Virtual Agente. Bate-papo do agente, incluindo suporte de controle avançado e notificações.
## Suporte para controles avançados adicionais {#va-api-features-v2__section_bcd_4k1_kqb}
Virtual Agent A API agora oferece suporte aos seguintes controles avançados.
Controles boolianos
: Os controles boolianos retornam respostas como cadeias de caracteres (qualquer uma delas Yesou No) para facilitar a localização.
Para obter mais informações sobre localização de tópicos, consulte [Localizando Virtual Agentconversas](https://servicenow-prod.fluidtopics.net/2Kmx27FzZrhdL~MgK_mpTg ". ServiceNowa plataforma fornece vários métodos para localização Virtual Agentdependendo das suas necessidades. Use o. Framework de localizaçãopara gerenciar todos os aspectos do processo de tradução, esteja você usando tradução automática, um provedor terceirizado ou ambos.").
Virtual Agent A API envia o seguinte JSON de exemplo para um controle booliano:
{
"requestId": "asd2423-wrr434-weruyt-1234567",
"clientSessionId": "",
"nowSessionId": "",
"message": {
"text": "7a36412253a13010ff59ddeeff7b12fb",
"typed": false,
"clientMessageId": "ABC-123"
},
"userId": "beth.anglin",
"body": [
{
"uiType": "Boolean",
"group": "DefaultPicker",
"required": true,
"nluTextEnabled": false,
"label": "Sample Response for boolean control",
"options": [
{
"label": "Yes"
},
{
"label": "No"
}
]
}
],
"score": 1
}
Controles personalizados
: Os tópicos que usam controles personalizados agora são compatíveis. Para obter mais informações sobre controles personalizados, consulte [Personalizando Virtual Agentcom controles personalizados](https://servicenow-prod.fluidtopics.net/pKlF_ciFq0WEdKD~KXbiBA "Os controles personalizados são componentes que ServiceNowos desenvolvedores podem criar para uso em Virtual Agentblocos de tópicos ou tópicos. Esses controles incluem controles deslizantes ou players de vídeo. Os controles personalizados complementam os controles fornecidos em Designer do Virtual Agent.").
Controles de resposta de bot de tabela
: Os tópicos que usam controles de resposta de bot de tabela agora são compatíveis. Para obter mais informações, consulte [Controle de resposta de bot de tabela](https://servicenow-prod.fluidtopics.net/Ugex3cthOH3oL3yfnuIuPQ "Use o controle de resposta do bot de tabela em A. Virtual Agenttópico para exibir uma resposta de bot como uma tabela.").
Todos os registros são retornados de Virtual AgentAPI de uma só vez. Virtual AgentAguardará uma resposta do cliente da API para enviar o próximo controle. Use o. paginationBreakpropriedade para exibir registros em blocos para o usuário. Por exemplo, se paginationBreakfor definido como 10, o usuário verá 10 registros de cada vez. Quando o cliente estiver pronto para passar para o próximo controle, ele deverá enviar DONE.
Virtual Agent A API envia o seguinte JSON de exemplo para um controle de resposta de bot de tabela:
{
"requestId": "asd2423-wrr434-weruyt-1234567",
"clientSessionId": "",
"nowSessionId": "",
"message": {
"text": "Yes",
"typed": false,
"clientMessageId": "ABC-123"
},
"userId": "beth.anglin",
"body": [
{
"uiType": "OutputTable",
"group": "DefaultOutputTable",
"label": "Sample Table Rich control",
"headers": [
"Number",
"Short description"
],
"data": [
[
"INC0000005",
"CPU load high for over 10 minutes"
],
[
"INC0000015",
"I can't launch my VPN client since the last software update"
],
[
"INC0000025",
"Need to add more memory to laptop"
],
[
"INC0000035",
"Reset my password"
],
[
"INC0000055",
"SAP Sales app is not accessible"
],
[
"INC0009005",
"Email server is down."
]
],
"paginationBreak": 10,
"totalSearchResultsCount": 6,
"navigationBtnLabel": "Click for more"
}
],
"score": 1
}
Controles de resposta de bot HTML
: Os tópicos que usam controles de resposta de bot HTML agora são compatíveis. Para obter mais informações, consulte [Controle de resposta de bot HTML](https://servicenow-prod.fluidtopics.net/lAehc_l~ofDLmNT23nH1ew "Use o controle de resposta de bot HTML para exibir texto HTML estático no Virtual Agentresposta do bot.").
Virtual Agent A API envia o seguinte JSON de exemplo para um controle de resposta de bot HTML:
{
"requestId": "asd2423-wrr434-weruyt-1234567",
"clientSessionId": "",
"nowSessionId": "",
"message": {
"text": "Yes",
"typed": false,
"clientMessageId": "ABC-123"
},
"userId": "beth.anglin",
"body": [
{
"uiType": "OutputHtml",
"group": "DefaultOutputHtml",
"style": "inline",
"height": 100,
"width": 100,
"value": " Sample Response for Html control ",
"imageUrl": null,
"imageHeight": 0,
"imageWidth": 0,
"links": null
},
{
"uiType": "InputText",
"group": "DefaultText",
"required": true,
"nluTextEnabled": false,
"label": "some text",
"maskType": "NONE"
}
],
"score": 1
}
Controles de resposta de bot de resposta múltipla
: Os tópicos que usam controles de resposta de bot de resposta múltipla agora são compatíveis. Para obter mais informações, consulte [Controle de resposta de bot de resposta múltipla](https://servicenow-prod.fluidtopics.net/o99scruGXAYTi52Lv5QCeQ "Use o controle de resposta de bot de resposta múltipla em um Virtual Agenttópico para exibir sequencialmente duas ou mais saídas. As saídas podem ser texto, imagem, link ou HTML. Os usuários podem mover de uma saída para a próxima por meio de um botão de navegação fornecido.").
Virtual Agent A API envia o seguinte JSON de exemplo para um controle de resposta de bot de resposta múltipla:
{
"requestId": "asd2423-wrr434-weruyt-1234567",
"clientSessionId": "",
"nowSessionId": "",
"message": {
"text": "Done",
"typed": false,
"clientMessageId": "ABC-123"
},
"userId": "beth.anglin",
"body": [
{
"uiType": "MultiPartOutput",
"group": "DefaultMultiPartOutput",
"navigationBtnLabel": "Click for more",
"content": {
"uiType": "OutputText",
"value": "Text response from multiflow control example",
"maskType": "NONE"
}
}
],
"score": 1
}
Suporte a rich text
: Os tópicos que usam rich text agora são compatíveis. O Rich text inclui texto em negrito ou itálico, hiperlinks, listas com marcadores e emojis.
## Adicional Bate-papo do agenterecursos {#va-api-features-v2__section_tbg_mg1_kqb}
. Virtual AgentA API agora oferece suporte aos seguintes recursos ao transferir para Bate-papo do agente.
Passe o nome e avatar do agente
: Quando o bot primário transfere um bate-papo para um atendente, Virtual Agentpode enviar o nome do agente e o avatar para o bot primário. Para habilitar isso, ative Nomes e avatares do agente Nas configurações de Bate-papo do agente.
Um exemplo de carga de mensagem pode ser semelhante a esta:
{
"requestId":"f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId":"U94CSJLEN",
"message":{
"text":"Live Agent support.",
"typed":true
},
"userId":"U94CSJLEN",
"body":[
{
"uiType":"OutputText",
"group":"DefaultText",
"agentInfo":{
"sentFromAgent":true,
"agentName":"Beth Anglin",
"agentAvatar":"ee4eebf30a0004d963b5c5ac0d734dc4.iix?t=small"
},
"value":"Thank you for contacting support. I am looking into your question now and will be with you shortly."
}
],
"agentChat":true,
"score":1
}
Para obter mais informações, consulte [Configure o Bate-papo do agente](https://servicenow-prod.fluidtopics.net/LyJ76DM0fwGFptN1BGH6Hw "Configurar Bate-papo do agentepara permitir que os atendentes conversem com os clientes e gerenciem vários recursos de conversa para agentes e usuários finais. Até Bate-papo do agente, os agentes interagem com usuários finais, criam registros de incidentes ou casos ou transferem bate-papos para outro agente ou fila.").
Tempo de espera do atendente
: Ao transferir para um atendente, o bot primário pode receber o tempo de espera e exibi-lo para o usuário. Para habilitar isso, selecione Tempo de espera em Status de espera do bate-papo ao vivo Campo nas configurações de Bate-papo do agente. . spinnerTypeo valor está definido como wait_time. . Status de espera do bate-papo ao vivo está definido como Nenhum . spinnerTypeo valor é none.
Virtual AgentA API envia o seguinte JSON de exemplo no bodyparâmetro da carga.
{
"uiType":"ActionMsg",
"actionType":"StartSpinner",
"spinnerType":"wait_time",
"message":"Routing you to a live agent...",
"waitTime":"8 Seconds"
}
Para obter mais informações, consulte [Configure o Bate-papo do agente](https://servicenow-prod.fluidtopics.net/LyJ76DM0fwGFptN1BGH6Hw "Configurar Bate-papo do agentepara permitir que os atendentes conversem com os clientes e gerenciem vários recursos de conversa para agentes e usuários finais. Até Bate-papo do agente, os agentes interagem com usuários finais, criam registros de incidentes ou casos ou transferem bate-papos para outro agente ou fila.").
Envie o histórico de bate-papo do bot primário para Virtual Agent
: O bot primário pode passar o histórico do bate-papo para um atendente para que o agente possa ver o contexto da conversa.
Virtual Agent Converte o histórico de mensagens em HTML e, em seguida, em uma imagem.
* A imagem convertida é enviada para o atendente como a primeira mensagem do bate-papo.
* O bot primário deve enviar o histórico de mensagens na primeira solicitação. Em qualquer outra solicitação após a primeira solicitação, a carga do histórico de mensagens será ignorada.
* Somente mensagens de texto são compatíveis.
* O bot primário pode passar qualquer URL como um valor na mensagem de texto, mas o atendente só pode exibi-lo como parte da imagem. O atendente não poderá clicar no link.
{#va-api-features-v2__ul_thk_p31_kqb}
Carga de mensagem de exemplo:
{
"value": "Help me with password reset",
"displayName": "able",
"type": "text"
"isBotMessage": false,
}
Nota:
No exemplo anterior, typediferencia maiúsculas de minúsculas e deve ter um valor de text.
## Solicitações aprimoradas do bot primário {#va-api-features-v2__section_xcn_f41_kqb}
. Virtual AgentA API agora oferece suporte às seguintes solicitações do bot primário.
Variáveis de contexto e parâmetros do sistema
: O bot primário pode passar parâmetros do sistema e variáveis de contexto como entrada, e. Virtual Agenthonrará esses parâmetros. Parâmetros do sistema, como liveagent_devicetype, liveagent_requester_session_language, liveagent_topic, topic, live_agent_onlye. liveagent_devicetimezonesão compatíveis. Variáveis de contexto personalizadas e. Bate-papo do agentevariáveis de contexto também são compatíveis.
Carga de mensagem de exemplo:
{
"requestId": "f42f3550-5b44-4cde-aa52-xxxxxxxxxx",
"clientSessionId": "xxxxxxxxxx",
"token": "abcd",
"message": {
"text": "Test",
"typed": true
},
"contextVariables": {
"requester_session_language": "es"
},
"userId": ""abel.tuter",
"emailId": "abel.tuter@example.com"
}
Para obter mais informações, consulte [Variáveis de contexto do bate-papo do atendente](https://servicenow-prod.fluidtopics.net/DjPm~H5WqO3EumyyMZAaJg "Use variáveis de contexto de bate-papo para passar determinadas informações do tópico para compartilhar com um atendente ou para controlar como as conversas de bot são roteadas para os atendentes. Virtual Agentinclui algumas variáveis padrão e você pode definir novas.") e [Configure variáveis de contexto para armazenar informações relacionadas ao bate-papo](https://servicenow-prod.fluidtopics.net/iy0Te9CvWKb14vIwpL8H4w "Especifique variáveis de contexto de bate-papo, também chamadas Atendentevariáveis de bate-papo, para armazenar informações relacionadas ao bate-papo, como respostas de pesquisa pré-bate-papo. Essas variáveis contêm informações contextuais que podem ser usadas para determinar a intenção do tópico ou controlar como os bate-papos são roteados para agentes ativos. Você também pode definir variáveis para capturar informações contextuais passadas Virtual Agentscripts de tópico para compartilhar com os atendentes em tempo real.").
Fuso horário do usuário
: Defina o fuso horário do usuário passando-o na carga da solicitação. Uma vez definida, essa configuração de fuso horário é mantida até que seja redefinida.
Carga de mensagem de exemplo:
{
"requestId": "xxxxxx-xxxxxx-xxxx-xxxx-xxxxxxxxxx",
"clientSessionId": "xxxxxxxx-xxxx",
"token": "xxxxx",
"action" : "SET_USER_TIMEZONE",
"userId": "able.tuter",
"emailId": "abel.tuter@example.com",
"timezone":"Asia/Kolkata"
}
Ao usar esta funcionalidade, considere o seguinte:
* A conversa deve estar aberta (atual) para converter data e hora para o fuso horário do usuário.
* O bot primário deve enviar data e hora em um dos seguintes formatos:
* Nome do fuso horário. Por exemplo, Asia/Kolkataou America/New_York.
* Formato de 24 horas de data e hora. Por exemplo: YYYY-MM-DD HH:MM:SS
{#va-api-features-v2__ul_wjl_qjb_kqb}
* . Virtual AgentA API usa o fuso horário especificado pelo bot primário, mesmo que o fuso horário definido seja diferente do valor armazenado na tabela \[sys_user\].
* Para definir o fuso horário do usuário, envie o. SET_TIMEZONEação. Se o nome do fuso horário não for válido, o valor do fuso horário será padronizado para o horário UTC. Por exemplo, 2021-02-16 20:13:13.
{#va-api-features-v2__ul_vjl_qjb_kqb}
## Suporte para ignorar nó {#va-api-features-v2__section_b13_zry_3qb}
Virtual Agent A API aceita ignorar um nó se ele for projetado para fazer isso no tópico. Por exemplo, em Designer do Virtual Agent, você pode designar um controle de entrada do usuário como ignorado no AvançadoOcultar ou ignorar este nó área da folha de propriedades.
Figura 1. Condição ou script que permite que o usuário ignore o nó
Para obter mais informações sobre como definir um nó como ignorado, consulte [Designer do Virtual Agent controles de entrada do usuário](https://servicenow-prod.fluidtopics.net/Rwp03gWqB~lzBK~VXQ3APg "Use a coleção de controles de entrada fornecida por Designer do Virtual Agentpara solicitar e capturar informações do usuário em uma conversa.").
Se um nó for marcado como ignorado, o bot apresentará essa opção ao usuário. Se o usuário ignorá-lo, o bot primário deverá passar o comando ignorar conforme ilustrado no exemplo a seguir.
{
"requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId": "835607",
"token": "snow",
"message": {
"text": "_skip_",
"typed": false
},
"emailId": "beth.anglin@example.com",
"userId": "beth.anglin"
}
## Suporte a handshake síncrono {#va-api-features-v2__synchronous_support}
Nota:
Esses requisitos se aplicam à versão 2,0.x do Virtual AgentAPI. Para obter maior funcionalidade de handshake síncrono, faça upgrade para a versão 3,0.x, que oferece suporte à transferência de atendente e outros aprimoramentos. Para obter detalhes, consulte [Aprimoramentos de handshake síncrono](https://servicenow-prod.fluidtopics.net/LqCvyOZlAe2s2wPfNhjq8Q#va-api-features-v3__synchronous_support_enhancements).
Quando habilitado, Virtual Agentfornece respostas ao bot primário de forma síncrona. Se você quiser habilitar a comunicação com Virtual Agentno modo síncrono, você deve desativar manualmente os seguintes recursos para que o handshake funcione:
* Bate-papo do agente
* Notificações
* Indicadores de digitação
{#va-api-features-v2__ul_p3g_33j_gqb}
Nota:
Os tópicos que usam os seguintes recursos não são compatíveis no modo síncrono: [carregamento de arquivo](https://servicenow-prod.fluidtopics.net/Rwp03gWqB~lzBK~VXQ3APg "Use a coleção de controles de entrada fornecida por Designer do Virtual Agentpara solicitar e capturar informações do usuário em uma conversa."). [Utilitário de ação](https://servicenow-prod.fluidtopics.net/mZARBJwOiJ9T1hAkfekh7g "Use o utilitário Ação em um Virtual Agenttópico para selecionar as propriedades da ação de fluxo que o nó deve criar. O utilitário Ação se integra Virtual Agentcom o. ServiceNow Workflow Studioproduto.")e o. [Pausar bloco de tópicos](https://servicenow-prod.fluidtopics.net/auOsQQoPvm3_w3ewte3CFQ "Virtual Agent fornece blocos de tópicos pré-criados que os autores ou administradores de tópicos podem usar para executar funções ou tarefas específicas relacionadas à plataforma em conversas de bot. Por exemplo, determinados blocos de tópicos permitem que você verifique a disponibilidade do agente ou gere Pesquisa com IAresultados.").
Para desabilitar esses recursos e habilitar o suporte síncrono, siga estas etapas:
1. Exclua o canal de bot para bot de Bate-papo do agente.
1. Navegue até Todos e, em seguida, insira sys_properties.list no filtro.
2. Selecione com.glide.cs.exclude.liveagent.supportpropriedade do sistema para abri-lo.
3. Adicionar Bot To Botpara Valor campo.
Figura 2. Exclua o canal de bot para bot de Bate-papo do agente
4. Clique em Atualizar.
{#va-api-features-v2__ol_fv2_jr4_kqb}
2. Navegue até Todos e, em seguida, insira sys_cs_channel.list no filtro de navegação.
3. Selecione o registro de bot para bot.
4. Limpe o. Habilitar notificações para desabilitá-la.
5. Limpe o. Indicador de digitação de suporte para desabilitá-la.
6. Selecione Síncrono caixa de seleção.
Figura 3. Canal de bot para bot com suporte síncrono habilitado
Nota:
. Síncrono o campo não está visível, você pode [configure o layout do formulário](https://www.servicenow.com/docs/access?context=configure-form-layout&version=yokohama&pubname=yokohama-platform-administration&ft:locale=en-US)para mostrá-lo.
7. Clique em Atualizar.
{#va-api-features-v2__ol_icm_x3j_gqb}
## Suporte a notificações {#va-api-features-v2__section_u3d_gcs_2qb}
Uso Virtual AgentAPI para enviar os seguintes tipos de notificações no canal de bot para bot quando ele está habilitado no modo assíncrono:
* Simples: Notificações somente de texto. As notificações simples são entregues assim que chegam.
* Cartão de imagem: Uma imagem carregada no servidor ou especificada com um URL.
* Cartão de registro: Colunas especificadas de um registro em uma tabela.
* Acionável: Fornece ao usuário a oportunidade de executar determinadas ações. As notificações acionáveis estão enfileiradas. O usuário pode recuperá-los sob demanda enviando o. Show Notificationcomando.
{#va-api-features-v2__ul_rrg_2ks_2qb}
Para obter mais informações, consulte [Configurando Virtual Agentnotificações](https://servicenow-prod.fluidtopics.net/KSAhJdiHykCHDwM5PMZ7kw "Enviar ServiceNownotificações diretamente aos usuários por meio do Virtual Agentchatbot em canais de mensagens compatíveis. As notificações podem ser mensagens informativas simples para revisão ou mensagens acionáveis com botões que os usuários podem selecionar para executar determinadas ações.").
Virtual Agent A API envia o seguinte JSON de exemplo para uma notificação simples:
{
"requestId": "asd2423-wrr434-weruyt-1234567",
"clientSessionId": "",
"nowSessionId": "",
"message": {
"text": "Done",
"typed": false,
"clientMessageId": "ABC-123"
},
"userId": "beth.anglin",
"body": [
{
"uiType": "OutputCard",
"group": "DefaultOutputCard",
"templateName": "Notification",
"data": "{\"sys_id\":null,\"recordDisplayValue\":null,\"messageHeading\":\"[Heading]A notification has arrived. You can continue the conversation after viewing the notification.\",\"imageUrl\":null,\"tableLabel\":null,\"enableLink\":false,\"message\":\"[message]A notification has arrived. You can continue the conversation after viewing the notification.\",\"fields\":[],\"table_name\":null,\"url\":\"http://192.168.1.9:8080/null.do?sys_id=null\"}"
}
],
"completed": true,
"score": 1
}
Virtual Agent A API envia o seguinte JSON de exemplo para uma notificação de cartão de imagem:
{
"requestId": "asd2423-wrr434-weruyt-1234567",
"clientSessionId": "",
"nowSessionId": "",
"message": {
"text": "Done",
"typed": false,
"clientMessageId": "ABC-123"
},
"userId": "beth.anglin",
"body": [
{
"uiType": "OutputCard",
"group": "DefaultOutputCard",
"templateName": "Notification",
"data": "{\"sys_id\":null,\"recordDisplayValue\":null,\"messageHeading\":\"[Heading]A notification has arrived. You can continue the conversation after viewing the notification.\",\"imageUrl\":\"http://xxxxxx.service-now.com/2b2d0d2653a13010ff59ddeeff7b120d.iix\",\"tableLabel\":null,\"enableLink\":false,\"message\":\"[message]A notification has arrived. You can continue the conversation after viewing the notification.\",\"fields\":[],\"table_name\":null,\"url\":\"http://192.168.1.9:8080/null.do?sys_id=null\"}"
}
],
"completed": true,
"score": 1
}
Virtual Agent A API envia o seguinte JSON de exemplo para uma notificação de cartão de registro:
{
"requestId": "asd2423-wrr434-weruyt-1234567",
"clientSessionId": "",
"nowSessionId": "",
"message": {
"text": "Done",
"typed": false,
"clientMessageId": "ABC-123"
},
"userId": "beth.anglin",
"body": [
{
"uiType": "OutputCard",
"group": "DefaultOutputCard",
"templateName": "Notification",
"data": "{\"sys_id\":\"552c48888c033300964f4932b03eb092\",\"recordDisplayValue\":\"INC0010112\",\"messageHeading\":\"[Heading]A notification has arrived. You can continue the conversation after viewing the notification.\",\"imageUrl\":null,\"tableLabel\":\"Incident\",\"enableLink\":true,\"message\":\"[message]A notification has arrived. You can continue the conversation after viewing the notification.\",\"fields\":[{\"fieldLabel\":\"Number\",\"fieldValue\":\"INC0010112\"},{\"fieldLabel\":\"Short description\",\"fieldValue\":\"Assessment : ATF Assessor\"}],\"table_name\":\"incident\",\"url\":\"http://192.168.1.9:8080/incident.do?sys_id=552c48888c033300964f4932b03eb092\"}"
}
],
"completed": true,
"score": 1
}
As notificações do canal Bot para Bot estão desabilitadas por padrão. Para habilitá-los, faça o seguinte:
1. Navegue até Todos e, em seguida, insira sys_cs_channel.list no filtro de navegação.
2. Abra o registro de bot para bot.Se solicitado, habilite a edição no registro.
3. Selecione Habilitar notificações caixa de seleção.
4. Clique em Atualizar.
{#va-api-features-v2__ol_mx2_5ps_2qb}
Os administradores podem limitar o número de destinatários por notificação modificando o. com.glide.cs.per_notification_user_limitpropriedade. O valor padrão é 1000.
## Alternância de tópico usando o nome do tópico {#va-api-features-v2__section_h3z_v2l_2qb}
Além de usar o ID do tópico ou o ID da intenção do tópico para alternar tópicos, você pode usar o nome da intenção do tópico ou do tópico. É recomendável que você envie somente o ID do tópico ou o nome do tópico. No momento, se um estiver incorreto ou se o bot já estiver no tópico especificado, Virtual Agentnão envia nenhuma resposta. O uso depende do modo que você está usando, da seguinte forma:
* Descoberta de tópico de NLU: Use o nome ou o ID da intenção do tópico.
* Descoberta de tópico de palavra-chave: Use o nome ou o ID do tópico.
{#va-api-features-v2__ul_j1k_pgl_2qb}
O bot primário pode enviar o. SWITCHjuntamente com o nome do tópico para alternar diretamente para um tópico específico.
Carga de mensagem de exemplo:
{
"requestId": "xxxx-xxxx-xxxx-xxxx",
"clientSessionId": "xxx-xxx-xxx-xxx",
"action":"SWITCH",
"topic":{
"name": "Topic Name"
},
"userId": "beth"
}
## Suporte a indicador de digitação {#va-api-features-v2__section_mfv_mrd_gqb}
Você pode habilitar indicadores de digitação para usuários e agentes ativos. Atualmente, os indicadores de digitação são exibidos da seguinte forma:
* Exibido ao agente quando o usuário está digitando
* Exibido ao usuário quando o bot está preparando uma resposta
{#va-api-features-v2__ul_zld_llb_kqb}
Quando o indicador de digitação estiver habilitado, Virtual AgentA API envia o. IndicatorTipoTipo de início e. EndTypingIndicator ações na carga de resposta. Por exemplo:
{
"uiType":"ActionMsg",
"actionType":"StartTypingIndicator"
}
Para enviar o indicador de digitação do usuário a um atendente, o cliente deve enviar o. TYPING ação. Quando o usuário terminar de digitar, o cliente deverá enviar o. VIEWING ação. Por exemplo:
{
"requestId": "xxxxxx-xxxxxx-xxxx-xxxx-xxxxxxxxxx",
"clientSessionId": "xxxxxxxx-xxxx",
"action": "TYPING/VIEWING",
"userId": "able.tuter",
"emailId": "abel.tuter@example.com",
"timezone":"Asia/Kolkata"
}
Para habilitar indicadores de digitação, siga estas etapas.
1. Navegue até Todos e, em seguida, insira sys_cs_channel.list no filtro de navegação.
2. Selecione o registro de bot para bot.
3. Selecione Indicador de digitação de suporte caixa de seleção.
4. Clique em Atualizar.
{#va-api-features-v2__ol_nrn_tsd_gqb}