GETRICHMESSAGE

Passa uma mensagem JSON com mídia à ação digital AskCaller ou à ação TExtMsg.  Isto permite que você use modelos de mensagem com mídia criados na página Ponto de contato digital no ACD em seus scripts em vez de criar o JSON no script.

Dependências

• Esta ação exige o Digital Experience.
• Antes de trabalhar com scripts digitais, saiba quais são as diferenças entre os scripts ACD tradicionais e os scripts digitais.
• Deve ser usada com uma das seguintes ações: AskCaller ou TExtMsg.
• Coloque GETRICHMESSAGE antes de AskCaller ou TExtMsg no seu script.

• A compatibilidade com o tipo de conteúdo de mensagens interativas varia de acordo com o canal, conforme mostrado na lista suspensa a seguir.

  Saiba mais

• Crie modelos de mensagem com mídia para usar com esta ação na página Ponto de contato digital no CXone. Você pode criar modelos para selecionadores de lista, de hora, links com mídia e respostas rápidas. Caso precise usar outros tipos de mídia interativa, você não deve usar GETRICHMESSAGE. Em vez disso, será preciso criar o JSON em uma ação Snippet e passá-lo diretamente para AskCaller ou TExtMsg. Consulte a seção Dependências na ajuda online para estas ações para obter mais informações.

Tipos de script suportados

Digital

Comparação de ações similares

As ações a seguir têm funções semelhantes, mas com algumas diferença importantes.

• AskCaller: solicita informações de um contato em um canal de chat digital. Pode exibir conteúdo de mensagens interativas Elementos em mensagens digitais, como botões, imagens, menus e seletores de opções..
• GetRichMessage: recupera modelos de mensagens interativas das configurações do canal no CXone.
• Textmsg: envia uma mensagem de texto para o contato. Pode exibir conteúdo de mensagens interativas.

Propriedades de entrada

Estas propriedades definem dados que a ação usa durante a execução.

Propriedade	Descrição
legenda	Insira uma frase curta que identifica exclusivamente esta ação no script. A legenda aparece na tela do script no ícone da ação. The default is the action name.
channelId	Seleciona o canal digital que este script usa para enviar mensagens.

Propriedades de saída

Estas propriedades contêm variáveis que armazenam dados retornados da execução da ação. Elas estão disponíveis para referência e uso quando a ação é concluída.

Propriedade	Descrição
resultSet	Contém o JSON retornado do CXone. Passa o conteúdo desta variável a Askcaller ou TExtmsg como uma string JSON.

Condições de ramal resultante

Condições de ramal resultante permitem que você crie ramais no seu script para atender diferentes resultados quando uma ação é executada.

Condição	Descrição
Default	Caminho percorrido, a menos que o script atenda a uma condição que exige que ele percorra um dos outros ramais. Também é percorrido se os outros ramais da ação não estiverem definidos.
OnError	Caminho tomado quando a ação não é executada corretamente. Por exemplo, quando há um problema inesperado como conectividade ruim, erros de sintaxe e assim por diante. A variável _ERR, com o caractere sublinhado, deve ser preenchida com uma explicação condensada do problema.
OnSucess	Caminho seguido se a ação for concluída sem erros e quaisquer chamadas de API ou retornos de dados foram bem-sucedidos (códigos de resposta 2xx).

Código de ação SNIPPET exigido

Esta ação pode precisar de uma ação Snippet com código que lide com modelos de mídia interativa que a ação GETRICHMESSAGE retorna do ponto de contato digital. Se o ponto de contato possui apenas um modelo, não é preciso código snippet. Você pode usar a variável especificada na propriedade resultId. Para pontos de contato que têm mais de um modelo, será necessário código snippet.

1. Crie um modelo na página de Pontos de contato digitais no ACD aplicativo e atribua-o ao ponto de contato com o qual quer usá-lo. Pode ser que você precise de assistência de um administrador CXone para completar esta etapa.

2. Crie um script com o tipo de mídia digital.

3. Adicione uma ação GETRICHMESSAGE e uma ação ASKCALLER ou uma ação TeXTMSG. Se o ponto de contato tiver mais de um modelo, você também precisará de uma ação SNIPPET.
4. Configure a propriedade ChannelId em GETRICHMESSAGE com o ponto de contato ao qual você atribuiu o modelo.
5. Adicione o código apropriado à ação SNIPPET:

   • Se tiver apenas um modelo ou se quiser enviar apenas um modelo com este script, use código como:

     DYNAMIC json1 
     ASSIGN json1.data[1] = resultset.data[1]

   • Se tiver vários modelos e quiser enviar mais de um com este script, use código como:

     DYNAMIC json1
     DYNAMIC json2
     DYNAMIC json3
     				 
     ASSIGN json1.data[1] = resultset.data[1]
     ASSIGN json2.data[1] = resultset.data[2]
     ASSIGN json3.data[1] = resultset.data[3]

6. Altere o número índice que identifica o modelo que quer enviar. No código de exemplo da etapa anterior, você mudaria os números índice na variável resultset.data[x]. Não mude o índice na variável à qual está atribuindo o modelo. No código de exemplo, a variável é jsonY.data[Z] e você poderia mudar Y, mas não Z. Cada variável jsonY armazena um modelo.
7. Altere os nomes de variáveis se quiser. Se fizer isto, mude os nomes das variáveis conforme necessário nas outras ações do script. Por exemplo, resultSet é o nome padrão de variável na propriedade resultSet de GETRICHMESSAGe. As variáveis jsonY são usadas na propriedade Mensagem de AskCaller e Textmsg.
8. Configure AskCaller ou Textmsg: 
   1. Defina a propriedade MessageFormat como JSON.
   2. Configure Mensagem com o nome da variável que armazena o JSON do modelo que está enviando. Ele deve ser enviado como uma string JSON. Você pode usar substituição de variável neste campo. Se fizer isto, adicione código a um Snippet para escolher o modelo para envio e passe a variável correta.
   3. Configure outras propriedades das ações conforme necessário, incluindo a conexão com ramais. Consulte a ajuda online para a ação ASKCALLER ou para a ação TeXTMSG.

Exemplo de script

Este exemplo mostra a ação GETRICHMESSAGE conectada a uma ação SNIPPET, que é conectada a TeXTMSG. Ela também pode estar conectada a ASKCALLER. Quando o script é executado, GETRICHMESSAGE recupera os modelos de mensagem interativa disponíveis para o canal digital especificado no channelId. Eles ficam armazenados na variável especificada na propriedade resultId. Neste exemplo, a variável é resultId. O código snippet contém um objeto de dados dinâmicos que armazenará um determinado modelo de mensagem interativa JSON e o passará para TeXTMSG.

Baixe este script.