OpenFrameAPI - Cliente

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 33 min. de leitura

    • . OpenFrameAPI Fornece métodos que interagem com o OpenFrame. OpenFrame é uma estrutura omnipresente que os parceiros de comunicação podem usar para integrar seus sistemas ao ServiceNow plataforma.

    Um dos principais requisitos é a capacidade de conectar e fornecer código de diferentes domínios que podem se conectar perfeitamente a subsistemas de parceiros. Esta conexão entre domínios é necessária para manter conexões e retornos de chamada registrados nos sistemas de comunicação sem problemas entre domínios.

    OpenFrame tem duas partes significativas. Um vive em ServiceNow(Conhecida como TopFrame) e esta API que é originada da aplicação do parceiro. Esta API tem os métodos necessários para se comunicar com o TopFrame e controlar os recursos visuais do OpenFrame .
    Nota:
    Para permanecer atualizado com referência à biblioteca OpenFrame, use o seguinte URI de recurso: https://[servicenow instance]/scripts/openframe/latest/openFrameAPI.min.js .

    OpenFrameAPI - getAWAAgentPresence(Cadeia de caracteres bem-sucedida, falha na cadeia de caracteres)

    Retorna o estado de presença atual do agente conectado.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    êxito Cadeia de caracteres Se o método for bem-sucedido, o nome da função de retorno de chamada a ser invocada.
    falha Cadeia de caracteres Se o método falhar, o nome da função de retorno de chamada a ser invocada.
    Tabela 2. Retornos
    Tipo Descrição
    presença Resultados passados para a função de retorno de chamada de sucesso pela infraestrutura openFrame.

    Tipo de dados: Objeto

    "presence": {  
  "available": Boolean, 
  "channels": [Array],
  "name": "String", 
  "sys_id": "String"
}
    presença.disponível Sinalizador que indica se o agente associado está disponível.
    Valores válidos:
    • Verdadeiro: O agente está disponível.
    • Falso: O agente não está disponível.

    Tipo de dados: Booliano
    presence.channels Lista de canais de comunicação disponíveis com o agente.

    Tipo de dados: Matriz de objetos

    "channels": [
  { 
    "available": Boolean,
    "name": "String",
    "restrict_update": Boolean,
    "service_channel_type": "String",
    "sys_id": "String"
  }
]
    presence.channels.available Sinalizador que indica se o canal está disponível.
    Valores válidos:
    • Verdadeiro: O canal está disponível.
    • Falso: O canal não está disponível.

    Tipo de dados booliano
    presence.channels.name Nome do canal, como Bate-papo ou Telefone.

    Tipo de dados: Cadeia de caracteres
    presence.channels.restrict_update Sinalizador que indica se o usuário pode restringir atualizações no canal.
    Valores válidos:
    • Verdadeiro: O usuário pode restringir atualizações para o canal.
    • Falso: O usuário não pode restringir atualizações para o canal.

    Tipo de dados booliano
    presence.channels.service_channel_type Tipo do canal de serviço.

    Tipo de dados: Cadeia de caracteres
    presence.channels.sys_id Sys_id do registro do canal.

    Tipo de dados: Cadeia de caracteres

    Tabela: Canais de serviço [awa_service_channel]
    presence.name Nome do estado de presença do agente.

    Tipo de dados: Cadeia de caracteres
    presence.sys_id Sys_id do registro do estado de presença.

    Tipo de dados: Cadeia de caracteres

    Tabela: Estados de presença [awa_presence_state]

    O exemplo de código a seguir mostra como chamar este método.

    function failure(data)
{
  console.log("failure: " + JSON.stringify(data));
}
 
function success(data)
{
  console.log("success: " + JSON.stringify(data));
}
 
openFrameAPI.getAWAAgentPresence(success, failure)

    Resposta à função de retorno de chamada de sucesso:

    success: { 
  "presence": { 
    "name": "Available", 
    "sys_id": "0b10223c57a313005baaaa65ef94f970", 
    "available": true, 
    "channels": [ 
      { 
        "name": "Chat", 
        "available": true, 
        "sys_id": "27f675e3739713004a905ee515f6a7c3", 
        "restrict_update": false, 
        "service_channel_type": "chat" 
      } 
    ] 
  } 
}

    OpenFrameAPI - hide()

    Oculta o OpenFrame no TopFrame.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 4. Retorna
    Tipo Descrição
    vazio 
    openFrameAPI.hide()

    OpenFrameAPI - init(Configuração de objeto, function successCallback, function failureCallback)

    Inicializa o OpenFrame. Este deve ser o primeiro método que você chama.

    Este método inicializa a comunicação com o TopFrame e inicializa todos os elementos visuais passados no configparâmetro.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    config Objeto Pares nome-valor a serem usados durante o processo de inicialização.
    Possíveis chaves:
    • altura
    • subTitle
    • título
    • TitleIcon
    • largura
    Todas as chaves são opcionais. Passe um objeto vazio se não quiser definir esses pares de chave-valor.
    Retorno de chamada bem-sucedido função Nome da função de retorno de chamada a ser usada se inic método bem-sucedido. . Configuração do OpenFrame armazenado no sistema é passado como um parâmetro para a função de retorno de chamada.
    FailureCallback função Nome da função de retorno de chamada a ser usada se inic o método falha.
    Tabela 6. Retornos
    Tipo Descrição
    vazio 
    var config = {
height: 300,
width: 200
}
function handleCommunicationEvent(context) {
console.log("Communication from Topframe", context);
}
function initSuccess(snConfig) {
console.log("openframe configuration", snConfig);
//register for communication event from TopFrame
openFrameAPI.subscribe(openFrameAPI.EVENTS.COMMUNICATION_EVENT,
handleCommunicationEvent);
}
function initFailure(error) {
console.log("OpenFrame init failed...", error);
}
openFrameAPI.init(config, initSuccess, initFailure);

    OpenFrameAPI - isVisible(retorno de chamada de função)

    Verifica se o OpenFrame está visível no TopFrame.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    retorno de chamada função A função de retorno de chamada recebe um parâmetro com um valor verdadeiro ou falso. Verdadeiro se OpenFrame estiver visível e falso se não estiver visível.
    Tabela 8. Retornos
    Tipo Descrição
    vazio 
    function callback(isVisible) {
console.log(isVisible)
}
openFrameAPI.isVisible(callback)

    OpenFrameAPI - openCustomURL (Detalhes da cadeia de caracteres)

    Abre uma URL personalizada na interface UI16.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    URL Cadeia de caracteres Texto da URL personalizada.

    Tamanho máximo: 2083 caracteres
    Tabela 10. Retornos
    Tipo Descrição
    vazio 
    openFrameAPI.openCustomURL('10_cool_things.do');

    OpenFrameAPI - openServiceNowForm(Detalhes do objeto)

    Abre uma URL de formulário.

    Quando um agente recebe uma chamada de entrada, a janela OpenFrame exibe informações como a conta, o contato ou o consumidor. Clicar em um link na janela OpenFrame exibe o registro correspondente.
    • Na interface da plataforma, esta API abre uma URL de formulário no TopFrame.
    • Para Espaço do agente, Esta API oferece suporte ao gerenciamento de guias de interação. Em Espaço do agente um registro de interação é aberto em uma guia primária e o registro de entidade especificada é aberto em uma guia secundária na guia interação.
    Tabela 11. Parâmetros
    Nome Tipo Descrição
    detalhes Objeto Pares de chave-valor que identificam o URL do formulário a ser aberto. 
    "details": {
  "entity": "String";
  "interaction_sys_id": "String";
  "query": "String"
}
    detalhes.entidade Cadeia de caracteres Nome da tabela ou entidade.
    details.interaction_sys_id Cadeia de caracteres Opcional. Sys_id do registro de interação a ser aberto como guia primária em Espaço do agente.
    Nota:
    Na interface da plataforma interaction_sys_idignorado.
    detalhes.consulta Cadeia de caracteres Consulta para identificar o registro a ser aberto, como: consulta:sys_id_id_<record_sys_id>' .
    Tabela 12. Retornos
    Tipo Descrição
    vazio

    O exemplo a seguir mostra o uso básico na plataforma:

    openFrameAPI.openServiceNowForm({entity:'customer_account', 
query:'sys_id=447832786f0331003b3c498f5d3ee452', 'interaction_sys_id':'3be092313b711300758ce9b534efc4dd'});

    O exemplo a seguir mostra como usar o. queryParâmetro para criar um novo registro com dados fornecidos no formulário usando sysparm_query e uma consulta codificada para preencher os campos de nome e sobrenome no espaço:

    openFrameAPI.openServiceNowForm({ entity: 'sys_user',
query: 'sys_id=-1&sysparm_query=first_name=Ivan^last_name=Greggor' });

    OpenFrameAPI - openServiceNowFormwithChildTab()

    Abre um ServiceNow Formulário com uma guia secundária se invocada em um espaço ou abre uma entidade se invocada na interface UI16.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    OpenServiceNowFormwitChildTab Objeto Define se a API abre um ServiceNow Formulário com uma guia secundária se invocada em um espaço ou abre uma entidade se invocada na interface UI16.
    openFrameAPI.openServiceNowFormwithChildTab({
  entity: "String",
  sys_id: String", 	
  parent_entity: "String",	
  parent_entity_sys_id: "String"
})
    OpenServiceNowFormwitChildTab.Entity Cadeia de caracteres Nome da tabela que contém o registro a ser aberto.
    OpenServiceNowFormwitChildTab.sys_id Cadeia de caracteres Sys_id do registro a ser aberto.
    OpenServiceNowFormwitChildTab.parent_entity Cadeia de caracteres Nome da tabela a ser aberta como uma guia primária.
    OpenServiceNowFormwitChildTab.parent_entity_sys_id Cadeia de caracteres Sys_id do registro primário a ser aberto.
    Tabela 14. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir abre a entidade primária como uma guia primária em um espaço configurado ou abre apenas a entidade se invocada no UI16.

    openFrameAPI.openServiceNowFormwithChildTab({
  entity: "customer_account", 
  sys_id: "447832786f0331003b3c498f5d3ee452", 	
  parent_entity: "interaction", 
  parent_entity_sys_id: "3be092313b711300758ce9b534efc4dd"
});

    OpenFrameAPI - openServiceNowList(Detalhes do objeto)

    Abre uma URL de lista na interface UI16.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    detalhes Objeto Pares de valor de chave que descrevem o conteúdo a ser usado ao abrir o URL da lista.

    Valores válidos:
    Tabela 16. Retornos
    Tipo Descrição
    vazio 
    openFrameAPI.openServiceNowList({entity:'case', query:'active=true'});

    OpenFrameAPI - setFrameMode(modo)

    Define o modo OpenFrame.

    O modo aprovado nesta API:
    • Define o ícone apropriado no cabeçalho: Recolher ou expandir
    • Gera o evento relevante para CTI:
      • OpenFrameAPI.EVENTS.COLLAPSE
      • OpenFrameAPI.EVENTS.EXPAND
    Tabela 17. Parâmetros
    Nome Tipo Descrição
    Modo Cadeia de caracteres Defina o Modo OpenFrame. Opções enumeradas:
    1. OPENFRAMEAPI.FRAME_MODE.COLLAPSE
    2. OPENFRAMEAPI.FRAME_MODE.EXPAND
    Tabela 18. Retornos
    Tipo Descrição
    vazio 
    openFrameAPI.setFrameMode(openFrameAPI.FRAME_MODE.COLLAPSE);

    OpenFrameAPI - setHeight(height)

    Define a altura do OpenFrame.

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    Altura Número Altura em pixels
    Tabela 20. Retornos
    Tipo Descrição
    vazio 
    openFrameAPI.setHeight(100);

    OpenFrameAPI - setICContext(Tipo de cadeia de caracteres, Object <Context>)

    Define os dados de contexto relacionados aos controles de interação no cliente. Use esses dados de contexto para determinar a IU do cliente a ser exibida no OpenFrame.

    Para obter informações adicionais sobre controles interativos, consulte Interaction Controls Component.

    Para obter informações adicionais sobre registros de interação, consulte CSM voice interaction record page.

    Tabela 21. Parâmetros
    Nome Tipo Descrição
    Tipo Cadeia de caracteres Tipo de dados de contexto a serem definidos.
    Valores válidos:
    • ActiveCall: Define o contexto do componente de chamada ativa em andamento. Ao passar este tipo de contexto, você também deve passar o. Chamada ativa[] JSON como Contextparâmetro.

      Componente de chamada ativo

    • IdleState: Define os recursos de estado ocioso para o usuário atual. Quando isso é definido, a IU de estado ocioso (teclado de discagem) aparece no OpenFrame. Ao passar este tipo de contexto, você também deve passar o. <idleState> JSON como Contextparâmetro.

      Componente do teclado

    • SearchTargetList: Define o contexto da lista telefônica. Quando esta opção é definida, ela é habilitada Transferir chamada No componente Chamada ativa. Ao passar este tipo de contexto, você também deve passar o. SearchTargetList[] JSON como Contextparâmetro.

      Componente de chamada de transferência
    <Context> Objeto Dados de contexto a serem definidos. Cada tipo de dados de contexto tem um conjunto diferente de dados de entrada possíveis.
    Válido Contextobjetos de dados:
    • Chamada ativa
    • <idleState>
    • SearchTargetList
    activeCall Matriz de objetivos Detalhes sobre uma chamada ativa. Cada objeto representa uma chamada ativa em andamento.
    "activeCall": [
  { 
    "currentParticipant": {Object},
    "customPayload: {Object},
    "direction": "String",
    "externalId": "String",
    "nowRecordId": "String",
    "nowRecordTable": "String",
    "participants": [Array],
    "type": "String"
  }
]
    AtivoCall.currentParticipante Objeto Obrigatório. Detalhes sobre os recursos de chamada do participante atual e o status da chamada.
    "currentParticipant": {
  "actor": "String",
  "callStartTime": "String",
  "capabilities": {Object},
  "connectedTime": "String",
  "custom-capability-state-1": Boolean,
  "flagged": Boolean,
  "held": Boolean,
  "id": "String",
  "muted": Boolean,
  "name": "String",
  "paused": Boolean,
  "recording": "String",
  "state": "String",
  "wrapUP": {Object}
}
    ActiveCall.currentParticipante.​Ator Cadeia de caracteres Tipo de participante na chamada.
    Valores válidos:
    • agente
    Nota:
    Outros tipos de participantes a serem adicionados no futuro.
    ActiveCall.currentParticipant.​CallStartTime Cadeia de caracteres Data e hora em que a chamada foi iniciada.

    Padrão de tempo: UTC

    Formato: RSS - " dd mmm aaaa hh:mm:ss GMT". Por exemplo: "Wed, 17 dez 2024 05:23:41 GMT"
    ActivCall.currentParticipante.​Capacidades Objeto Detalhes sobre os recursos que o participante atual (agente) pode executar durante uma chamada. Os ícones associados aparecem no componente Chamada ativa para os recursos habilitados.

    Captura de tela do componente de chamada ativa com ícones de capacidades
    "capabilities": {
  "dtmf": Boolean,
  "endCall": Boolean,
  "flag": Boolean,
  "hold": Boolean,
  "leaveAndTransfer": Boolean,
  "mergeCall": Boolean,
  "mute": Boolean,
  "resumeRecording": Boolean,
  "pauseRecording": Boolean,
  "startRecording": Boolean,
  "stopRecording": Boolean,
  "transfer": Boolean
}
    ActivCall.currentParticipante.​Capacidades. ​dtmf Booliano Sinalizador que indica se o agente tem o recurso DTMF (Dual Tone Multifrequency, multifrequência de tom duplo) para a chamada atual.
    Valores válidos:
    • Verdadeiro: O participante tem capacidade DTMF.
    • Falso: O participante não tem capacidade DTMF.

    Padrão: falso
    ActivCall.currentParticipante.​Capacidades. ​EndCall Booliano Sinalizador que indica se o participante associado pode encerrar a chamada.
    Valores válidos:
    • Verdadeiro: O participante pode encerrar a chamada. O botão Encerrar chamada está habilitado na IU.
    • Falso: O participante não pode encerrar a chamada. O botão Encerrar chamada está desabilitado na IU.

    Padrão: falso
    ActivCall.currentParticipante.​Capacidades. ​sinalizador Booliano Sinalizador que indica se o participante pode sinalizar a chamada para problemas de qualidade, como problemas de qualidade de voz.
    Valores válidos:
    • Verdadeiro: O participante pode sinalizar chamadas com problema.
    • Falso: O participante não pode sinalizar chamadas com problema.

    Padrão: falso
    ActivCall.currentParticipante.​Capacidades. ​em espera Booliano Sinalizador que indica se o participante pode colocar a chamada em espera.
    Valores válidos:
    • Verdadeiro: O participante pode colocar a chamada em espera. O botão Hold está habilitado na IU.
    • Falso: O participante não pode colocar a chamada em espera. O botão Hold está desabilitado na IU.

    Padrão: falso
    ActivCall.currentParticipante.​Capacidades. ​SaaveAndTransfer Booliano Sinalizador que indica se o participante pode transferir a chamada para outro agente e, em seguida, entregar a chamada. Habilite esse recurso para ações como transferências de consulta, em que o usuário consultado não é o proprietário da chamada.
    Valores válidos:
    • Verdadeiro: O participante pode transferir e entregar a chamada.
    • Falso: O participante não pode transferir e entregar a chamada.

    Padrão: falso
    ActivCall.currentParticipante.​Capacidades. ​MergeCall Booliano Sinalizador que indica se o participante pode mesclar a chamada. Use este recurso quando os segmentos de chamada do participante forem capazes de mesclar.
    Valores válidos:
    • Verdadeiro: O participante pode mesclar a chamada. O botão mesclar está habilitado na IU.
    • Falso: O participante não pode mesclar a chamada. O botão mesclar está desabilitado na IU.

    Padrão: falso
    ActivCall.currentParticipante.​Capacidades. ​mudo Booliano Sinalizador que indica se o participante pode silenciar a chamada.
    Valores válidos:
    • Verdadeiro: O participante pode silenciar a chamada. O botão Mudo está habilitado na IU.
    • Falso: O participante não pode silenciar a chamada. O botão Mudo está desabilitado na IU.

    Padrão: falso
    ActivCall.currentParticipante.​Capacidades. ​ResumeRecording Booliano Sinalizador que indica se o participante pode retomar a gravação da chamada.
    Valores válidos:
    • Verdadeiro: O participante pode retomar a gravação da chamada. O botão Pausar gravação está habilitado na IU.
    • Falso: O participante não pode retomar a gravação da chamada. O botão Pausar gravação está desabilitado na IU.

    Padrão: falso
    ActivCall.currentParticipante.​Capacidades. ​PauseRecording Booliano Sinalizador que indica se o participante pode pausar a gravação da chamada.
    Valores válidos:
    • Verdadeiro: O participante pode pausar a gravação da chamada. O botão Pausar gravação está habilitado na IU.
    • Falso: O participante não pode pausar a gravação da chamada. O botão Pausar gravação está desabilitado na IU.

    Padrão: falso
    ActivCall.currentParticipante.​Capacidades. ​StartRecording Booliano Sinalizador que indica se o participante pode começar a gravar a chamada.
    Valores válidos:
    • Verdadeiro: O participante pode começar a gravar a chamada. O botão de gravação está habilitado na IU.
    • Falso: O participante não pode começar a gravar a chamada. O botão de gravação está desabilitado na IU.

    Padrão: falso
    ActivCall.currentParticipante.​Capacidades. ​StopRecording Booliano Sinalizador que indica se o participante pode parar de gravar a chamada.
    Valores válidos:
    • Verdadeiro: O participante pode parar de gravar a chamada. O botão parar gravação está habilitado na IU.
    • Falso: O participante não pode parar de gravar a chamada. O botão parar gravação está desabilitado na IU.

    Padrão: falso
    ActivCall.currentParticipante.​Capacidades. ​transferência Booliano Sinalizador que indica se o participante pode transferir a chamada.
    Valores válidos:
    • Verdadeiro: O participante pode transferir a chamada. O botão de transferência está habilitado na IU.
    • Falso: O participante não pode transferir a chamada. O botão de transferência está desabilitado na IU.

    Padrão: falso
    AtivoCall.currentParticipante.​ConnectedTime Cadeia de caracteres Data e hora em que a chamada foi conectada inicialmente.

    Base de tempo: UTC

    Formato: RSS - " dd mmm aaaa hh:mm:ss GMT". Por exemplo: "Wed, 17 dez 2024 05:23:41 GMT"
    ActiveCall.currentParticipant.​Custom-capability-state-1 Booliano Sinalizador que indica se há participantes atuais na chamada.
    Valores válidos:
    • Verdadeiro: Participantes atuais na chamada.
    • Falso: Não há participantes atuais na chamada.

    Padrão: falso
    ActiveCall.currentParticipante.​Sinalizado Booliano Sinalizador que indica se a chamada está sinalizada para um problema, como um problema de qualidade de voz.
    Valores válidos:
    • Verdadeiro: A chamada foi sinalizada devido a um problema.
    • Falso: A chamada não foi sinalizada devido a um problema.

    Padrão: falso
    AtivoCall.currentParticipante.​Retido Booliano Sinalizador que indica o estado Em espera do participante.
    Valores válidos:
    • Verdadeiro: O participante está em espera.
    • Falso: O participante não está em espera.

    Padrão: falso
    ActiveCall.currentParticipante.​id Cadeia de caracteres Obrigatório. Sys_id do registro de participante associado, como o sys_id do agente.

    Tabela: Usuário [sys_user]
    ActiveCall.currentParticipante.​Mudo Booliano Sinalizador que indica o estado mudo do participante.
    Valores válidos:
    • Verdadeiro: O participante está mudo.
    • Falso: O participante não está mudo.

    Padrão: falso
    ActiveCall.currentParticipante.​Nome Cadeia de caracteres Nome do participante.
    AtivoCall.currentParticipante.​Pausado Booliano Sinalizador que indica o estado pausado do participante.
    Valores válidos:
    • Verdadeiro: O participante está pausado.
    • Falso: O participante não está pausado.

    Padrão: falso
    ActiveCall.currentParticipante.​Gravação Cadeia de caracteres Estado de gravação atual da chamada.
    Valores válidos:
    • in_progress
    • nenhum
    AtivoCall.currentParticipante.​Encerramento Objeto Uso futuro.
    ActivoCall.customPayload Objeto Carga personalizada a ser passada para o OpenFrame como parte dos eventos de Open Frame. Este é um objeto de forma livre e pode conter todos os dados necessários para personalizar o componente de chamada ativo, como adicionar botões ou texto.
    Call.direction ativo Cadeia de caracteres Direção da chamada para o participante associado.
    Valores válidos:
    • entrada
    • saída
    ActivoCall.externalId Obrigatório. Valor exclusivo que identifica a chamada ativa atual no sistema externo associado.
    Chamada ativa. ​NowRecordId Cadeia de caracteres Obrigatório. Sys_id do registro de chamada ativo.

    Tabela: Interação [interaction] Opção compatível somente com o sistema de base.
    Chamada ativa. ​NowRecordTable Cadeia de caracteres Obrigatório. Tabela à qual a chamada ativa pertence.

    Tabela: Interação [interaction] Opção compatível somente com o sistema de base.
    Chamada ativa. ​participantes Matriz de objetivos Obrigatório. Lista dos participantes adicionais na chamada. Um participante pode ser um agente, um cliente, uma pessoa externa que não seja um agente ou um cliente ou uma fila.
    "participants": [
  {
    "actor": "String",
    "ani": "String",
    "address": "String",
    "capabilities": {Object},
    "callStartTime" "String",
    "connectedTime": "String",
    "customPayload": {Object},
    "dnis": "String",
    "held": Boolean,
    "heldAtTime": "String",
    "id": "String",
    "muted": Boolean,
    "name": "String",
    "requestACW": Boolean,
    "requireWrapup": Boolean,
    "state": "String"
  }
]
    Chamada ativa. ​participantes. ​ator Cadeia de caracteres Tipo de ator para o participante associado.
    Por exemplo:
    • agente
    • cliente
    • externo
    • fila
    Chamada ativa. ​participantes. ​ani Identificação automática de números. Número de telefone a ser exibido para o destinatário da chamada telefônica.
    Chamada ativa. ​participantes. ​endereço Cadeia de caracteres Número de telefone do participante.
    Chamada ativa. ​participantes. ​. Objeto Detalhes sobre o tipo de recursos que o participante tem para a chamada associada.
    "capabilities": {
  "endCall": Boolean,
  "hold": Boolean,
  "mute": Boolean
}
    Chamada ativa. ​participantes. ​. ​EndCall Booliano Sinalizador que indica se o participante associado pode encerrar a chamada.
    Valores válidos:
    • Verdadeiro: O participante pode encerrar a chamada. O botão Encerrar chamada está habilitado na IU.
    • Falso: O participante não pode encerrar a chamada. O botão Encerrar chamada está desabilitado na IU.

    Padrão: falso
    Chamada ativa. ​participantes. ​. ​em espera Booliano Sinalizador que indica se o participante pode colocar a chamada em espera.
    Valores válidos:
    • Verdadeiro: O participante pode colocar a chamada em espera. O botão Hold está habilitado na IU.
    • Falso: O participante não pode colocar a chamada em espera. O botão Hold está desabilitado na IU.

    Padrão: falso
    Chamada ativa. ​participantes. ​. ​mudo Booliano Sinalizador que indica se o participante pode silenciar a chamada.
    Valores válidos:
    • Verdadeiro: O participante pode silenciar a chamada. O botão Mudo está habilitado na IU.
    • Falso: O participante não pode silenciar a chamada. O botão Mudo está desabilitado na IU.

    Padrão: falso
    Chamada ativa. ​participantes. ​ConnectedTime Cadeia de caracteres Obrigatório. Data e hora em que o participante se conectou inicialmente à chamada.

    Padrão de tempo: UTC

    Formato: RSS - " dd mmm aaaa hh:mm:ss GMT". Por exemplo: "Wed, 17 dez 2024 05:23:41 GMT"
    Chamada ativa. ​participantes. ​CustomPayload Objeto Carga personalizada a ser passada para o OpenFrame como parte dos eventos personalizados do Open Frame. Este é um objeto de forma livre e pode conter todos os dados necessários para personalizar o componente de chamada ativa, como adicionar botões ou texto.
    Chamada ativa. ​participantes. ​dnis Cadeia de caracteres Serviço de identificação de número discado. Número de telefone discado pelo participante.
    Chamada ativa. ​participantes. ​retido Booliano Sinalizador que indica o estado Em espera do participante.
    Valores válidos:
    • Verdadeiro: O participante está em espera.
    • Falso: O participante não está em espera.

    Padrão: falso
    Chamada ativa. ​participantes. ​HeldAtTime Cadeia de caracteres Data e hora em que a conexão do participante à chamada foi colocada em espera.

    Base de tempo: UTC

    Formato: RSS - " dd mmm aaaa hh:mm:ss GMT". Por exemplo: "Wed, 17 dez 2024 05:23:41 GMT"
    Chamada ativa. ​participantes. ​id Cadeia de caracteres Obrigatório. ID exclusivo do participante do sistema CCaaS (Contact Center as a Service, Central de contato como serviço).
    Chamada ativa. ​participantes. ​mudo Booliano Sinalizador que indica o estado mudo do participante.
    Valores válidos:
    • Verdadeiro: O participante está mudo.
    • Falso: O participante não está mudo.

    Padrão: falso
    Chamada ativa. ​participantes. ​nome Cadeia de caracteres Nome do participante.
    Chamada ativa. ​participantes. ​SolitaACW Booliano Somente para caso de uso do agente - válido somente quando activeCall.currentParticipant.actor"agente".

    Sinalizador que indica se o participante precisa fazer acompanhamento com o cliente.

    Valores válidos:
    • Verdadeiro: Acompanhamento necessário.
    • Falso: Nenhum acompanhamento necessário.

    Padrão: falso
    Chamada ativa. ​participantes. ​RequireWrapup Booliano Somente para caso de uso do agente - válido somente quando activeCall.currentParticipant.actor"agente".

    Sinalizador que indica se o deve ser exibido Encerramento quando a chamada for concluída.


    Captura de tela do componente de encerramento
    Valores válidos:
    • Verdadeiro: Exiba o. Encerramento componente na conclusão da chamada.
    • Falso: Não exiba Encerramento componente na conclusão da chamada.

    Padrão: falso
    Chamada ativa. ​participantes. ​estado Cadeia de caracteres Estado da perna da chamada do participante. Aparece abaixo do número de telefone em Chamada ativa componente.
    Janela de chamada ativa mostrando o estado
    Qualquer texto significativo, como:
    • Alertas
    • Conectado
    • Chamando
    ActivoCall.type Cadeia de caracteres Tipo de chamada.
    Valores válidos:
    • chamada
    • solicitação de retorno de chamada
    • correio de voz
    <idleState> Objeto Descreve o contexto de estado ocioso do agente. Esses dados de contexto determinam as informações que aparecem no teclado de discagem quando um agente está aguardando uma chamada e os recursos que ele tem por meio desse teclado de discagem.
    <idleState> {
 "capability": {Object},
 "currentInboundId": "String",
 "dialpadInfoMessage": {Object},
 "enableState": {Object}
}
    Capacidade.<idleState> Objeto Descrição dos recursos de estado ocioso do usuário atual.
    "capability": {
  "globalContactSearch": Boolean,
  "logOut": Boolean,
  "outBoundCall": Boolean
}
    Capacidade.<idleState>. ​GlobalContactSerarch Booliano Sinalizador que indica se a lista de contatos global deve ser exibida enquanto estiver no estado ocioso.
    Valores válidos:
    • Verdadeiro: Exiba a lista de contatos global.
    • Falso: Não exiba a lista de contatos global.

    Padrão: falso
    Capacidade.<idleState>. ​Logout Booliano Sinalizador que indica se o usuário pode fazer logout enquanto estiver no estado ocioso.
    Valores válidos:
    • Verdadeiro: O usuário pode fazer logout quando a chamada estiver ociosa. O botão de logout aparece no teclado de discagem.
    • Falso: O usuário não pode fazer logout quando a chamada está ociosa.

    Padrão: falso
    Capacidade.<idleState>. ​OutBoundCall Booliano Sinalizador que indica se o usuário pode fazer uma chamada de saída enquanto está no estado ocioso.
    Valores válidos:
    • Verdadeiro: O usuário pode fazer uma chamada de saída quando a chamada está ociosa.
    • Falso: O usuário não pode fazer uma chamada de saída quando a chamada está ociosa.

    Padrão: falso
    <idleState>. ​CurrentInboundId Cadeia de caracteres Identificador de entrada da aplicação do provedor usado para criar a interação de chamada de saída.

    Tabela: Localizada no campo ID da tabela Identidades de canal do provedor [sys_cs_provider_application].

    Padrão: Aplicação do provedor do sistema de base
    <idleState>. ​DialpadInfoMessage Objeto Detalhes sobre a mensagem informativa a ser exibida no teclado de discagem do usuário, como a fila selecionada no momento.
    "dialpadInfoMessage": {
   "label": "String",
   "value": "String"
 }

    No exemplo a seguir, label. Fila selecionada: e o. value. Consultas do cliente . Você também pode usar apenas qualquer um dos labelou valueparâmetro com Fila selecionada: Consultas do cliente .


    Captura de tela do teclado de discagem com mensagem informativa
    <idleState>. ​DialpadInfoMessage. ​rótulo Cadeia de caracteres Rótulo de forma livre a ser exibido no teclado de discagem.
    <idleState>. ​DialpadInfoMessage. ​valor Cadeia de caracteres Texto da mensagem de forma livre a ser exibido após o rótulo no teclado de discagem.
    <idleState>. ​EnableState Objeto Detalhes sobre o estado de ativação dos botões no teclado de discagem.
    "enableState": {
   "logOut": Boolean,
   "outBoundCall": Boolean
 }
    <idleState>. ​EnableState. ​Logout Booliano Sinalizador que indica se o botão de logout deve ser habilitado na IU enquanto estiver no estado ocioso.
    Valores válidos:
    • Verdadeiro: Exiba o botão de logout enquanto estiver no estado ocioso.
    • Falso: Não exiba o botão de logout enquanto estiver no estado ocioso.

    Padrão: falso
    <idleState>. ​EnableState. ​OutBoundCall Booliano Sinalizador que indica se o botão de chamada de saída deve ser habilitado na IU enquanto estiver no estado ocioso.
    Valores válidos:
    • Verdadeiro: Exiba o botão de chamada de saída enquanto estiver no estado ocioso.
    • Falso: Não exiba o botão de chamada de saída enquanto estiver no estado ocioso.

    Padrão: falso
    searchTargetList Matriz de objetivos Detalhes dos dados relacionados à transferência de um ServiceNow tabela.
    "searchTargetList": [
  {
    "externalId": "String",
    "nowRecordId": "String",
    "nowRecordTable": "String",
    "participantID": "String",
    "targets": [Array]
  }
]
    SearchTargetList. ​ExternalId Cadeia de caracteres Identificador exclusivo da chamada associada no sistema CCaaS.
    SearchTargetList. ​NowRecordId Cadeia de caracteres Obrigatório. Sys_id do registro ao qual a searchTargetList pertence.
    Nota:
    Atualmente, somente registros na tabela Interaction [interaction] são compatíveis.
    SearchTargetList. ​NowRecordTable Cadeia de caracteres Obrigatório. ServiceNow Tabela à qual a searchTargetList pertence.

    Tabela: Somente valor válido - "interação"

    SearchTargetList. ​Participante Cadeia de caracteres Identificador exclusivo do participante do sistema CCaaS.
    SearchTargetList. ​destinos Matriz de objetivos Detalhes sobre os agentes, usuários externos e/ou filas para os quais a chamada pode ser transferida.
    "targets": [
  {
    "payload": {Object},
    "transferSubtypes": [Array],
    "type": "String"
  }
]
    SearchTargetList. ​destinos. ​carga Objeto Detalhes sobre as informações a serem exibidas no controle de chamada de transferência.

    A seguir está um exemplo de um Transferir chamada controle que contém uma lista de agentes para os quais a chamada pode ser transferida. A captura de tela mostra quais elementos da IU estão presentes em cada parâmetro list.payloadcontroles.


    Captura de tela da janela de chamada de transferência mostrando associação de parâmetro
    "payload": {
  "list": [Array]
}

    Este exemplo mostra uma carga do agente ( SearchTargetList.targets.type" : "agente" ).

    "payload": {
  "list": [
    {
      "name": "Alice Anderson",
      "id": "agent1Id",
      "hasStats": "true",
      "presence": "available",
      "moreInfo": [
        {
          "label": "Skill",
          "value": "CRM certified"
        }
      ]
    }
  ]
}

    A seguir, é mostrado um exemplo de uma carga de fila ( SearchTargetList.targets.type" : "fila" ).

    "payload": {
  "list": [
    {
      "name": "Product Support Queue",
      "id": "queue1Id",
      "hasStats": "true",
      "moreInfo": [
        {
          "label": "Skill",
          "value": "10sec"
        },
        {
          "label": "Queue Skill",
          "value": "German"
        }
      ]
    },
    {
      "name": "Billing Queue",
      "id": "queue2Id",
      "hasStats": "true",
      "moreInfo": [
        {
           "label": "Skill",
           "value": "10sec"
        }
      ]
    }
  ]
}
    SearchTargetList. ​destinos. ​carga. ​lista Matriz de objetivos Detalhes sobre a carga para cada tipo de destino.
    "list": [
  {
    "hasStats": Boolean,
    "id": "String",
    "moreInfo": [Array],
    "name": "String",
    "presence": "String"
  }
]
    SearchTargetList. ​destinos. ​carga. ​lista. ​HasStats Booliano Sinalizador que indica se o destino associado tem estatísticas adicionais, como um tempo de espera para uma fila.
    Valores válidos:
    • Verdadeiro: O destino tem estatísticas adicionais. Um ícone de informações aparece ao lado do nome do agente ou da fila.
    • Falso: O destino não tem estatísticas adicionais.

    Padrão: falso
    SearchTargetList. ​destinos. ​carga. ​lista. ​id Cadeia de caracteres Identificador exclusivo do agente ou fila no sistema CCaaS.
    SearchTargetList. ​destinos. ​carga. ​lista. ​Mais informações Matriz de objetivos Necessário se searchTargetList.targets.payload.list.hasStatsestá definido como "verdadeiro" . Lista de habilidades que o agente ou a fila tem. Essas informações aparecem em uma janela pop-up quando o usuário seleciona o ícone de informações no final do nome das entidades.
    "moreInfo": [
  {
    "label": "String",
    "value": "String"
  }
]
    SearchTargetList. ​destinos. ​carga. ​lista. ​Mais informações. ​rótulo Cadeia de caracteres Rótulo de forma livre para as informações a serem exibidas na janela pop-up, como um Habilidade ou Idioma .
    SearchTargetList. ​destinos. ​carga. ​lista. ​Mais informações. ​valor Cadeia de caracteres Texto a ser exibido na janela pop-up após o rótulo, como CRM certificado ou Alemão .
    SearchTargetList. ​destinos. ​carga. ​lista. ​nome Cadeia de caracteres Nome do agente, usuário externo ou fila. Localizado no sistema CCaaS.
    SearchTargetList. ​destinos. ​carga. ​lista. ​presença Cadeia de caracteres Estado de presença do agente associado. Este parâmetro só é válido para um searchTargetList.targets.typede "agente" .
    Valores válidos:
    • disponível
    • ausente
    • ocupado
    • offline
    SearchTargetList. ​destinos. ​TransferênciSubtipos Matriz de objetivos Detalhes sobre o tipo de transferência compatível com o especificado searchTargetList.targets.type.

    Essas informações aparecem quando o usuário clica na elipse ao lado do nome do destino na IU.


    Componente de chamada de transferência mostrando os tipos de transferência

    Por exemplo, se somente um tipo de consulta for compatível com o tipo de destino atual, digamos, fila, esta matriz conterá um objeto para denotar o tipo de consulta de transferência.

    "transferSubtypes": [
  {
    "id": "String",
    "label": "String"
  }
]
    SearchTargetList. ​destinos. ​TransferênciSubtipos. ​id Cadeia de caracteres Identificador do subtipo de transferência.
    Valores válidos:
    • Cego: O agente transfere diretamente a chamada do cliente para outro agente ou fila sem primeiro falar com o agente.
    • Consulta: O agente entra em contato com o agente a quem deseja consultar e mescla o cliente na chamada com o agente consultor.

    Deve corresponder ao valor em searchTargetList.targets.transferSubtypes.label.
    SearchTargetList. ​destinos. ​TransferênciSubtipos. ​rótulo Cadeia de caracteres Rótulo do subtipo de transferência. Se você não aprovar um rótulo, nada aparecerá na IU para o subtipo de transferência.
    Valores válidos:
    • Cego
    • Consultar

    Deve corresponder ao valor em searchTargetList.targets.transferSubtypes.id.
    SearchTargetList. ​destinos. ​tipo Cadeia de caracteres Tipo de destino.
    Valores válidos:
    • agente
    • externo
    • fila
    Tabela 22. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo de código a seguir mostra como definir o contexto do estado ativo.

    openFrameAPI.setICContext("activeCall", {
  "activeCall": [
    { 
      "nowRecordTable": "interaction",
      "nowRecordId": "12345675678903456",
      "externalId": "1234567890",
      "type": "call",
      "direction": "inbound",
      "currentParticipant": {
        "id": "participant1",
        "name": "John 1",
        "actor": "agent",
        "state": "connected",
        "connectedTime": "Fri, 12 Jul 2024 05:23:41 GMT",
        "callStartTime": "Fri, 12 Jul 2024 04:20:22 GMT",
        "muted": false,
        "held": true,
        "paused": true,
        "flagged": true,
        "recording": "in_progress",
        "capabilities": {
          "hold": false,
          "mute": true,
          "endCall": true,
          "startRecording": true,
          "pauseRecording": true,
          "stopRecording": true,
          "resumeRecording": true,
          "transfer": true,
          "mergeCall": true,
          "leaveAndTransfer": true,
          "dtmf": true,
          "flag": true
        }
      },
      "participants": [
        {
          "id": "customer1",
          "name": "Gilly 1",
          "actor": "customer",
          "address": "+18582359874",
          "ani": "+16193287356", 
          "dnis": "+18004346258",
          "state": "connected",
          "connectedTime": "Fri, 12 Jul 2024 00:23:41 GMT",
          "callStartTime": "Fri, 12 Jul 2024 20:55:04 GMT",
          "muted": false,
          "held": false,
          "heldAtTime": "Fri, 12 Jul 2024 20:55:04 GMT", 
          "capabilities": {
            "mute": true,
            "hold": true,
            "endCall": true
          }
        },
        {
          "id": "agent2",
          "name": "Ned",
          "actor": "agent",
          "address": "+3134787324",
          "ani": "+13134787324", 
          "dnis": "+14773286943",
          "state": "Ringing...",
          "requireWrapup": true,
          "requestACW": true,
          "connectedTime": "Fri, 12 Jul 2024 20:24:41 GMT",
          "callStartTime": "Fri, 12 Jul 2024 20:56:34 GMT",
          "muted": true,
          "held": true,
          "heldAtTime": "Fri, 12 Jul 2024 20:55:41 GMT",
          "capabilities": {
            "mute": true,
            "endCall": true,
            "hold": true 
          }
        }
      ]
    },
    {
      "nowRecordTable": "interaction",
      "nowRecordId": "12345yhedfh534576u5",
      "externalId": "1234567890",
      "type": "call",
      "direction": "inbound",
      "currentParticipant": {
        "id": "participant1",
        "name": "John 1",
        "actor": "agent",
        "state": "connected",
        "muted": true,
        "held": false,
        "recording": "in_progress",
        "paused": true,
        "flagged": true,
        "capabilities": {
          "hold": false,
          "mute": true,
          "endCall": true,
          "record": true,
          "startRecording": true,
          "stopRecording": true,
          "transfer": true,
          },
          "mergeCall": false,
          "dtmf": true,
          "flag": true
        }
      },
      "participants": [
        {
          "id": "customer1",
          "name": "Gilly 2",
          "actor": "customer",
          "address": "+123456789",
          "state": "connected",
          "connectedTime": "Wed, 04 Dec 2024 00:23:41 GMT",
          "muted": true,
          "held": false,
          "heldAtTime": "Fri, 12 Jul 2024 20:24:41 GMT”,
          "capabilities": {
            "mute": true,
            "hold": true,
            "endCall": true
          }
        },
        {
          "id": "agent2",
          "name": "Ned 2",
          "actor": "agent",
          "address": "+123456789",
          "state": "Ringing...",
          "connectedTime": "Fri, 12 Jul 2024 20:24:41 GMT",
          "muted": true,
          "held": true,
          "heldaAtTime": "Fri, 12 Jul 2024 20:24:41 GMT”,
          "capabilities": {
            "mute": true,
            "endCall": true,
            "hold": true
          }
        }
      ]
     }
    ]
  }
);

    O exemplo a seguir mostra como definir o contexto de estado ocioso.

    openFrameAPI.setICContext("idleState", {
  "capability": {
    "outBoundCall": true,
    "logOut": true 
  },
  "enableState": {
    "outBoundCall": true,
    "logOut": true
  },
  "dialpadInfoMessage": {
    "label": "Info Message Label",
    "value": "Info Message Value"
  },
  "currentInboundId": "1234"
});

    O exemplo a seguir mostra como definir o contexto da lista de destino de pesquisa.

    openFrameAPI.setICContext("searchTargetList",
  {
    "searchTargetList": [
      {
        "nowRecordTable": "interaction",
        "nowRecordId": "1234",
        "externalId": "5678",
        "participantID": "participant1",
        "targets": [
          {
            "type": "agent",
            "transferSubtypes": [
              {
                "id": "consult",
                "label": "Consult"
              },
              {
                "id": "blind",
                "label": "Blind"
              }
            ],
            "payload": {
              "list": [
                {
                  "name": "John Jason",
                  "id": "agent1Id",
                  "hasStats": "true",
                  "presence": "away",
                  "moreInfo": [
                    {
                      "label": "Skill",
                      "value": "10sec"
                    }
                  ]
                }
              ]
            }
          },
          {
            "type": "queue",
            "transferSubtypes": [
              {
                "id": "consult",
                "label": "Consult"
              },
              {
                "id": "blind",
                "label": "Blind"
              }
            ],
            "payload": {
              "list": [
                {
                  "name": "Product Support Queue",
                  "id": "queue1Id",
                  "hasStats": "true",
                  "moreInfo": [
                    {
                      "label": "Skill",
                      "value": "10sec"
                    },
                    {
                      "label": "Queue Skill",
                      "value": "German"
                    }
                  ]
                },
                {
                  "name": "Billing Queue",
                  "id": "queue2Id",
                  "hasStats": "true",
                  "moreInfo": [
                    {
                      "label": "Skill",
                      "value": "10sec"
                    }
                  ]
                }
              ]
            }
          }
        ],
        "customPayload": {}
      }
    ],
    "customPayload": {}
  });

    OpenFrameAPI - setIcons(ícones de matriz)

    Define ícones no cabeçalho OpenFrame que são colocados ao lado do ícone Fechar.

    Tabela 23. Parâmetros
    Nome Tipo Descrição
    ícones Matriz de objetos Uma lista de configurações de ícone, em que cada configuração de ícone é um objeto com valores de chave imageURL, imageTitlee qualquer outro contexto necessário.

    Tamanho máximo: Os ícones podem ter no máximo 16x16 pixels. Imagens maiores são ajustadas automaticamente para este máximo.
    Tabela 24. Retornos
    Tipo Descrição
    vazio 
    openFrameAPI.setIcons([{imageURL:'https://mydomian.com/image/mute.png',
imageTitle:'mute', id:101}, {imageURL:'https://mydomian.com/image/hold.png',
imageTitle:'hold', id:102}]);

    OpenFrameAPI - setPresenceIndicator(presence)

    Define o indicador de presença para exibir a disponibilidade do agente em um espaço.

    Para obter mais informações sobre como configurar o OpenFrame, consulte Crie uma configuração OpenFrame

    Tabela 25. Parâmetros
    Nome Tipo Descrição
    Estado Cadeia de caracteres Estado de presença do agente.

    estados padrão:

    • Disponível
    • Ausente
    • Off-line

    Você também pode especificar estados personalizados.
    cor Cadeia de caracteres Cor do indicador de presença no espaço.

    Cores compatíveis:

    • vermelho
    • laranja
    • cinza
    • verde
    Tabela 26. Retornos
    Tipo Descrição
    vazio 
    openframeAPI.setPresenceIndicator('Available', 'green');

    OpenFrameAPI - setSize(largura numérica, altura do número)

    Define o tamanho do OpenFrame.

    Tabela 27. Parâmetros
    Nome Tipo Descrição
    largura Número Deve ser maior que zero.
    altura Número Deve ser maior que zero.
    Tabela 28. Retornos
    Tipo Descrição
    vazio 
    openFrameAPI.setSize(300, 370);

    OpenFrameAPI - setSubtitle(String subtitle)

    Define a legenda OpenFrame.

    Tabela 29. Parâmetros
    Nome Tipo Descrição
    subTitle Cadeia de caracteres Uma cadeia de caracteres de 256 caracteres ou menos.
    Tabela 30. Retornos
    Tipo Descrição
    vazio 
    openFrameAPI.setSubtitle('+18888888888');

    OpenFrameAPI - setTitle(título da cadeia de caracteres)

    Define o título do OpenFrame.

    Tabela 31. Parâmetros
    Nome Tipo Descrição
    título Cadeia de caracteres Uma cadeia de caracteres de 256 caracteres ou menos.
    Tabela 32. Retornos
    Tipo Descrição
    vazio 
    openFrameAPI.setTitle('Incoming Call');

    OpenFrameAPI - setTitleIcon(ícone de objeto)

    Define o ícone de título do OpenFrame.

    Tabela 33. Parâmetros
    Nome Tipo Descrição
    ícones Objeto Objeto de pares de chave-valor. As chaves incluem imageURL, imageTitlee qualquer outro contexto necessário.

    Tamanho máximo: Os ícones podem ter no máximo 16x16 pixels. Imagens maiores são ajustadas automaticamente para este máximo.
    Tabela 34. Retornos
    Tipo Descrição
    vazio 
    openFrameAPI.setTitleIcon({imageURL:'/my/image/path.png', imageTitle:'mute', id:101});
    openFrameAPI.setTitleIcon({imageURL:'https://mydomian.com/image/path.png',
imageTitle:'mute', id:101});

    OpenFrameAPI - setWidth(width)

    Define a largura do OpenFrame.

    Tabela 35. Parâmetros
    Nome Tipo Descrição
    Largura Número Largura em pixels
    Tabela 36. Retornos
    Tipo Descrição
    vazio 
    openFrameAPI.setWidth(100);

    OpenFrameAPI - show()

    Torna o OpenFrame visível no TopFrame.

    Tabela 37. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 38. Retorna
    Tipo Descrição
    vazio 
    openFrameAPI.show()

    OpenFrameAPI - subscribe(evento openFrameAPIEVENT, function eventCallback)

    Assina um evento especificado.

    Tabela 39. Parâmetros
    Nome Tipo Descrição
    evento OpenFrameAPIEVENT O evento para assinar:
    • Openframe_agent_off_interaction: Indica a presença de um agente no bate-papo como desativado ou disponível.
    • Openframe_awa_agent_presence: Em Atribuição avançada de trabalho( AWA), este evento ocorre quando há alguma mudança no estado de presença do agente. Os desenvolvedores de Integração de telefonia por computador (CTI) podem assinar este evento para receber mudanças de estado de presença.
    • Openframe_awa_workitem_accepted: Ocorre quando um item de trabalho é aceito por um agente.
    • Openframe_awa_workitem_offered: Ocorre quando um item de trabalho é oferecido a um agente.
    • Openframe_awa_workitem_rejected: Ocorre quando um item de trabalho é rejeitado por um agente.
    • Openframe_before_destroy: Ocorre antes que o TopFrame seja descarregado.
    • Openframe_collapse: Ocorre quando o ícone de recolher é selecionado no cabeçalho do OpenFrame.
    • Openframe_communication: Específico da aplicação e pode ser personalizado.
    • Openframe_communication_failure: Ocorre quando a comunicação com o TopFrame falha.
    • Openframe_expand: Ocorre quando o ícone expandir é selecionado no cabeçalho do OpenFrame.
    • Openframe_heart_beat: Ocorre quando a sessão do usuário é estendida ou desconectada.
    • Openframe_header_icon_clicked: Descontinuado. Em vez disso, use openframe_icon_clicked ou openframe_title_icon_clicked.
    • Openframe_hidden: Ocorre quando o OpenFrame está oculto.
    • Openframe_icon_clicked: Ocorre quando qualquer ícone diferente do ícone Fechar é selecionado no rodapé do OpenFrame. O retorno de chamada recebe o objeto ícone como um parâmetro.
    • Openframe_shown: Ocorre quando o OpenFrame é mostrado.
    • Openframe_title_icon_clicked: Ocorre quando o ícone de título é selecionado no OpenFrame. O retorno de chamada recebe o objeto titleIcon como um parâmetro.
    • Openframe_wrap_up_submitted: Ocorre quando os períodos de encerramento terminam em caixa de diálogo não modal de encerramento . O evento é acionado somente quando o encerramento é externo.
    Retorno de chamada do evento função Função a ser chamada quando ocorrer o evento especificado.
    Tabela 40. Retornos
    Tipo Descrição
    resultados A maioria das assinaturas de evento não tem valores de retorno. As assinaturas de evento que retornam valores são descritas nas entradas da tabela a seguir.
    openframe_awa_agent_presence Em AWA. openframe_awa_agent_presenceo evento retorna presença objeto:
    "presence":{
  "available": Boolean,
  "channels":[
    {
      "available": Boolean,
      "name": "String",
      "restrict_update": Boolean,
      "sys_id": "String"
    }
  ],
  "name": "String",
  "sys_id": "String"
}
    presence: Informações sobre o estado de presença atual e o canal de um agente.
    • presence.available: Sinalizador que indica se o agente está disponível.
    • presence.channels: Lista de objetos que descrevem os canais de comunicação disponíveis com o agente.
      • presence.channels.available: Sinalizador que indica se o canal está disponível.
      • presence.channels.name: Nome do canal, como Bate-papo ou Telefone.
      • presence.channels.restrict_update: Sinalizador que indica se o usuário pode restringir atualizações.
      • presence.channels.sys_id: Sys_id do canal.
    • presence.name: Nome do estado de presença do agente.
    • presence.sys_id: Sys_id do estado de presença.
    openframe_awa_workitem_accepted e openframe_awa_workitem_offered Em AWA. openframe_awa_workitem_acceptede. openframe_awa_workitem_offeredos eventos retornam o. WorkItem objeto:
    "workItem": {
  "document": {
    "sys_id": "String",
    "table": "String"
  },
  "isAutoAccepted": Boolean,
  "isQueueTransferred": Boolean,
  "previousWorkItem": "String",
  "serviceChannel": {
    "name": "String",
    "sys_id": "String"
  },
  "size": Number,
  "sys_id": "String"
}

    workItem: Informações sobre o item de trabalho associado ao evento.

    • workItem.document: Lista de documentos associados à tarefa de item de trabalho.
      • workItem.document.sys_idSys_id do documento atribuído à tarefa do item de trabalho.
      • workItem.document.tableNome da tabela de documentos atribuída à tarefa.
    • workItem.isAutoAcceptedSinalizador que indica se o item de trabalho foi aceito automaticamente pelo sistema. Defina como verdadeiro se o item de trabalho tiver sido aceito automaticamente.
    • workItem.isQueueTransferredSinalizador que indica se o item de trabalho é transferido na fila. Defina como verdadeiro se o item de trabalho for transferido para fila, falso se não for. Para obter mais informações sobre transferências de fila, consulte Transfer a chat to another queue.
    • workItem.previousWorkItemSys_id do item de trabalho anterior para o mesmo ID de documento. Para os itens de trabalho não transferidos, este valor está vazio.
    • workItem.serviceChannel: Lista de canais de serviço associados à tarefa de item de trabalho.
      • workItem.serviceChannel.nameNome do canal de serviço, como Bate-papo ou Telefone.
      • workItem.serviceChannel.sys_idSys_id do canal de serviço.
    • workItem.sizeCapacidade do agente usada quando este item de trabalho é atribuído ao agente.
    • workItem.sys_idSys_id do item de trabalho que foi aceito ou oferecido.
    openframe_awa_workitem_rejected Em AWA. openframe_awa_workitem_rejectedo evento retorna WorkItem objeto:
    "workItem": {
  "document": {
    "sys_id": "String",
    "table": "String"
  },
  "isQueueTransferred": Boolean,
  "previousWorkItem": "String",
  "rejection": {
    "reason": "String",
    "sys_id": "String"
  },
  "serviceChannel": {
    "name": "String",
    "sys_id": "String"
  },
  "size": Number,
  "sys_id": "String"
}

    workItem: Informações sobre o item de trabalho associado ao evento.

    • workItem.document: Lista de documentos associados à tarefa de item de trabalho.
      • workItem.document.sys_idSys_id do documento atribuído à tarefa do item de trabalho.
      • workItem.document.tableNome da tabela de documentos atribuída à tarefa.
    • workItem.isQueueTransferredSinalizador que indica se o item de trabalho é transferido na fila. Defina como verdadeiro se o item de trabalho for transferido para fila, falso se não for. Para obter mais informações sobre transferências de fila, consulte Transfer a chat to another queue.
    • workItem.previousWorkItemSys_id do item de trabalho anterior para o mesmo ID de documento. Para os itens de trabalho não transferidos, este valor está vazio.
    • workItem.rejectionLista de motivos para a rejeição do item de trabalho.
      • workItem.rejection.reasonNome do motivo para rejeitar os itens de trabalho.
      • workItem.rejection.sys_idSys_id do motivo da rejeição.

        Tabela: Motivos da rejeição [awa_reject_reason]

    • workItem.serviceChannel: Lista de canais de serviço associados à tarefa de item de trabalho.
      • workItem.serviceChannel.nameNome do canal de serviço, como Bate-papo ou Telefone.
      • workItem.serviceChannel.sys_idSys_id do canal de serviço.
    • workItem.sizeCapacidade do agente usada quando este item de trabalho é atribuído ao agente.
    • workItem.sys_idSys_id do item de trabalho que foi aceito ou oferecido.
    openframe_heart_beat . openframe_heart_beato evento retorna o seguinte objeto:
    {
  "lastUiActivity": "String",
  "sessionLoggedIn": Boolean
}
    • lastUiActivity: Opcional. Carimbo de data/hora da última atividade de IU que estendeu a sessão do usuário.
    • sessionLoggedIn Sinalizador que indica se o usuário está conectado.
      • Verdadeiro: O usuário está conectado.
      • Falso: O usuário não está conectado.
    openframe_wrap_up_submitted . openframe_wrap_up_submittedo evento retorna o seguinte objeto:
    { 
  "wrapUp": {
    "external": Boolean,
    "externalSegmentId": "String", 
    "recordId": "String",
    "recordTable": "String",
    "wrapUpCode": "String",
    "wrapUpNotes": "String",
    "wrapUpSegmentId": "String"
  }
}
    • externalSinalizador que indica se o encerramento é tratado internamente pelo ServiceNow instância ou gerenciada fora do ServiceNow instância por algum outro sistema de chamada.
      • Verdadeiro: O encerramento é tratado por um sistema de chamada externa.
      • Falso: O encerramento é tratado pelo ServiceNow instância.
    • externalSegmentIdIdentificador exclusivo do objeto de dados externo que acionou o encerramento externo.
    • recordIdSys_id do registro de interação que está passando por encerramento.
    • recordTableNome da tabela que contém o registro. Sempre definido como "Interação".
    • wrapUpCodeCódigo selecionado pelo usuário durante o encerramento que indica como a interação foi resolvida.
    • wrapUpNotesTexto de forma livre inserido pelo usuário durante o encerramento que descreve como a interação foi resolvida.
    • wrapUpSegmentIdSys_id do registro do segmento de encerramento da interação associado à interação. Localizado na tabela Segmento de encerramento [interaction_wrap_up_segment]. Contém os dados de encerramento.

    O exemplo de código a seguir mostra como chamar este método para um openframe_awa_agent_presence evento.

    function handleIconClick(context) {
console.log("Icon was clicked", context);
}
openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_agent_presence, handleIconClick);

    Saída:

    // Sample presence object output
// openframe_awa_agent_presence event only

{
  "result":{
    "presence":{
      "name":"Available",
      "sys_id":"27f675e3739713004a905ee515f6a7c3",
      "available":true,
      "channels":[
        {
          "name":"Chat",
          "available":true,
          "sys_id":"36f675e4239713124a905fe515f6a832",
          "restrict_update":false
        },
        {
          "name":"Phone",
          "available":true,
          "sys_id":"9378a530a1820610f809018efd9bc01e",
          "restrict_update":false
        }
      ]
    }
  }
}

    O exemplo de código a seguir mostra como chamar este método para um openframe_awa_workitem_accepted evento.

    function handleIconClick(context) {
console.log("Icon was clicked", context);
}
openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_workitem_accepted, handleIconClick);

    Saída:

    // Sample workItem object output
// openframe_awa_workitem_accepted event only
{
  "result": {
    "workItem": {
      "sys_id": "14c86c40a1650610f87701807d9bc0be",
      "size": 1,
      "serviceChannel": {
        "name": "Chat",
        "sys_id": "27f675e3739713004a905ee515f6a7c3"
      },
      "document": {
        "sys_id": "aa582040a1650610f87701807d9bc076",
        "table": "interaction"
      },
      "previousWorkItem": "7c78a440a1650610f87701807d9bc02b",
      "isQueueTransferred": true,
      "isAutoAccepted": true
    }
  }
}

    O exemplo de código a seguir mostra como chamar este método para um openframe_awa_workitem_rejected evento.

    function handleIconClick(context) {
console.log("Icon was clicked", context);
}
openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_workitem_rejected, handleIconClick);

    Saída:

    // Sample workItem object output
// openframe_awa_workitem_rejected event only
{
  "payload": {
    "workItem": {
      "sys_id": "2c3bdc4824250610f8775e73b116f8de",
      "size": "1",
      "serviceChannel": {
        "name": "Chat",
        "sysID": "27f675e3739713004a905ee515f6a7c3"
      },
      "document": {
        "sys_id": "cf0a180824250610f8775e73b116f80c",
        "table": "interaction"
      },
      "rejection": {
        "reason": "Busy",
        "sys_id": "4e93fa29b38023002e7b6e5f26a8dc20"
      },
      "previousWorkItem": "831b9c4824250610f8775e73b116f841",
      "isQueueTransferred": true
    }
  }
}

    OpenFrameAPI - version()

    Retorna a versão da API OpenFrame.

    Tabela 41. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 42. Retorna
    Tipo Descrição
    Cadeia de caracteres A versão da API OpenFrame 
    var version = openFrameAPI.version();

console.log("API version " + version);