Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
O Microsoft CIFramework fornece métodos para usar a API JavaScript para gerenciar o painel de comunicação (widget), notificação, guia do aplicativo, sessões, registros e formulários no aplicativo baseado em modelo do Dynamics 365.
Importante
- As APIs são compatíveis apenas com os provedores de canal ativos configurados em sua organização.
- O manipulador de eventos CIFInitDone deve ser invocado antes de chamar as outras APIs.
- O limite de tempo limite para as APIs é de 100 segundos. Se as APIs não forem executadas em 100 segundos, elas deverão ser executadas novamente com parâmetros ou escopo alterados.
APIs de gerenciamento do painel de comunicação
O painel de comunicação é onde você, como agente, interage com o cliente. Os widgets de parceiros criados usando o Channel Integration Framework 2.0 são carregados neste painel. O widget nesta versão é exibido à esquerda do painel da sessão e suporta os modos Encaixado, Minimizado e Oculto.
Use as APIs a seguir para gerenciar o estado do painel de comunicação (widget).
| Methods | Description |
|---|---|
| setWidth | Define a largura do painel para todas as sessões. |
| getWidth | Obtém a largura do painel em pixels. |
| Modo de conjunto | Define o estado do painel. |
| Modo de obtenção | Define o estado do painel. |
APIs de operações CRUD
Use as APIs a seguir para executar operações CRUD em registros de entidade.
| Methods | Description |
|---|---|
| criar registro | Cria um registro de entidade. |
| recuperar Registro | Recupera um registro de entidade. |
| updateRecord | Atualiza um registro de entidade. |
| Registro de exclusão | Exclui um registro de entidade. |
APIs de gerenciamento de notificação
Use as APIs a seguir para exibir ou cancelar notificações sobre conversas recebidas.
| Methods | Description |
|---|---|
| notifyEvent | Exibe uma notificação que pode ser usada para informar o agente sobre uma conversa recebida. |
| cancelEvento | Oculta ou cancela uma notificação com base no token de cancelamento, conforme especificado no notifyEvent método. |
APIs de gerenciamento de guias de aplicativos
Use as APIs a seguir para criar e gerenciar o estado de uma guia de aplicativo.
| Methods | Description |
|---|---|
| createTab | Cria uma guia em uma sessão focada e retorna o identificador exclusivo da guia criada. |
| getTabs | Retorna uma matriz de identificadores de guia associados ao nome do modelo ou às tags de modelo para guias na sessão em foco, se a sessão pertencer ao provedor de canal. |
| guia de foco | Define o foco em uma guia, se a sessão focada pertencer ao provedor de canal e se a guia pertencer à sessão em foco. |
| Guia Focada | Retorna o identificador de guia em uma sessão focada, se a sessão pertencer ao provedor. |
| guia de atualização | Atualiza a guia. |
| setTabTitle | Define o título da guia, se a sessão focada pertencer ao provedor de canal e se a guia pertencer à sessão em foco. |
| fecharAba | Fecha a guia especificada na sessão atual. |
APIs de gerenciamento de sessão
Use as APIs a seguir para gerenciar sessões em um ambiente de provedor de várias sessões.
| Methods | Description |
|---|---|
| canCreateSession | Permite verificar se uma nova sessão pode ser criada. |
| createSession | Cria uma sessão com base no modelo de sessão definido como parte do modelo e retorna o identificador exclusivo da sessão que foi criada. |
| getSession | Retorna um objeto que contém o identificador exclusivo da sessão, o contexto e o valor do parâmetro, se a sessão pertencer ao provedor de isFocused canais. |
| getFocusedSession | Retorna o identificador exclusivo da sessão que está em foco, se ele pertencer ao provedor de canal, caso contrário, retornará nulo. |
| getAllSessions | Retorna a matriz de identificadores de sessão para um provedor de canal. |
| setSessionTitle | Define o título da sessão, se a sessão pertencer ao provedor de canal. |
| requestFocusSession | Define o foco na sessão cujo identificador de sessão é passado como um parâmetro, se a sessão pertencer ao provedor de canal. |
APIs de análise de canal
Use as APIs a seguir para rastrear a análise de eventos.
| Methods | Description |
|---|---|
| logAnalyticsEvento | Invoque esse método para registrar o Analytics para eventos personalizados. |
APIs de indicador de sessão
Use as APIs a seguir para indicar uma violação de KPI (indicador chave de desempenho) e atualizar o número de novas atividades em uma sessão específica.
| Methods | Description |
|---|---|
| notifyKpiBreach | Esse método é usado para indicar uma violação de KPI. Quando esse método é usado, um círculo vermelho aparece na imagem de exibição do contato quando ocorre uma violação de KPI. |
| notifyNewActivity | Esse método é usado para atualizar o número de novas atividades em uma sessão específica. |
APIs de presença
Use essas APIs para definir e recuperar a presença do agente do Omnicanal programaticamente. Você pode usar esses métodos quando um agente combinado estiver trabalhando em um aplicativo que não seja da Microsoft com omnicanal e quiser sincronizar os estados de presença entre diferentes aplicativos para garantir que a capacidade do agente seja utilizada de maneira ideal.
| Methods | Description |
|---|---|
| setPresence | Permite que a presença seja definida programaticamente para o agente na sessão do cliente. |
| Presença GetPresence | Permite que a presença seja retornada programaticamente para o agente na sessão do cliente. |
Métodos diversos
| Methods | Description |
|---|---|
| getEntityMetadata | Retorna os metadados da entidade especificada. |
| setClickToAct | Define um valor booliano para habilitar ou desabilitar a comunicação de saída (ClickToAct). |
| getClickToAct | Retorna um valor booliano para indicar se a comunicação de saída (ClickToAct) está habilitada ou não. |
| searchAndOpenRecords | O método procura o registro do widget de comunicação durante a comunicação de entrada e abre o registro. |
| getEnvironment | Obtém o aplicativo atual da Interface Unificada e os detalhes da página. Os detalhes incluem ID do aplicativo (appid), pageType (pageType), ID do registro (id), geografia da organização (orgGeo) e tipo de navegação da sessão (navigationType). |
| openForm | Abre um formulário de entidade ou um formulário de criação rápida. |
| renderSearchPage | Permite pesquisar entre os registros de um determinado tipo de entidade. Essa API abre a página de entidade da Interface Unificada com o campo de pesquisa pré-preenchido com a cadeia de caracteres de pesquisa que é passada como um parâmetro. |
| addHandler | Adiciona o assinante aos eventos.
Observação Essa API pode ser usada no widget e na página da Interface Unificada. |
| removeHandler | Remove o assinante dos eventos.
Observação Essa API pode ser usada no widget e na página da Interface Unificada. |
| raiseEvent | Invoca o assinante associado para o evento.
Observação Se você criou eventos personalizados usando o método addHandler, poderá gerar esses eventos passando o nome do evento como parâmetro nesse método. |
| updateContext | Este método permite que você defina o dicionário de automação. |
| updateConversation | Esse método permite que você atualize um registro de conversa. |
Informações relacionadas
Novidades na Estrutura de Integração de Canais do Dynamics 365
Requisitos do sistema para o Dynamics 365 Channel Integration Framework 2.0