Ações de estrutura de trabalho API

Ações de estrutura de trabalho API são ações do Studio que permitem que você use APIs do CXone nos seus scripts. Você pode usar a ação em vez de chamar o API usando métodos de integração tradicionais como um snippet ou a ação RestAPI. Todas as ações de API estão localizadas na guia Estrutura no Studio.

As ações API são diferentes das ações Studio padrão. No momento, elas não estão listadas na ajuda online. No entanto, os APIs que correspondem às ações API estão documentados no CXonePortal do Desenvolvedor Um quadrado com uma seta apontando do centro para o canto superior direito.. Você pode usar esta documentação ao trabalhar com ações API nos seus scripts.

Nem todo API do CXone possui uma ação de API correspondente no Studio.

Ações de API exigem um usuário de segurança. Você pode definir um usuário de segurança no seu script com a ação SETSECURITYUSER.

Versões de ação API

À medida que novas versões de APIs do CXone são lançadas, novas versões das ações correspondentes podem ser lançadas no Studio. Geralmente, é melhor usar a versão mais recente da ação. Versões mais antigas ainda funcionarão na maioria dos casos. Você pode experimentar versões diferentes para ver quais funcionam e fornecem a funcionalidade que você precisa.

Algumas ações API têm a versão no nome da ação. Você pode vê-la ao olhar para a estrutura em ramos das ações na guia Estrutura. Nem todas as ações API incluem o número da versão. Para estas ações, você pode encontrar a versão nas propriedades estendidas da ação. Você só pode ver as propriedades estendidas na guia Propriedades quando a ação está selecionada na guia Estrutura.

Nem toda versão de todo API possui uma ação correspondente no Studio.

Ver Propriedades estendidas de ação API

Uma ação é selecionada na guia Estrutura e suas propriedades estendidas são exibidas na guia Propriedades.

  1. No Studio, reordene as guias para que você possa ver as de Propriedades e Estrutura ao mesmo tempo.
  2. Na guia Estrutura, clique em uma ação API.
  3. Na guia Propriedades, você poderá ver agora as propriedades estendidas da ação. As seguinte propriedades em especial são úteis para saber mais sobre uma ação API:
    • Misc > Parâmetros > Verbo: Esta propriedade lhe mostra o método, ou verbo, associado à ação.
    • Misc > Parâmetros > Versão: Esta propriedade lhe mostra a versão do API.
    • Misc > Web > URI: Esta propriedade pode ser útil para localizar a documentação do API no portal do desenvolvedor.

    • Misc > Parâmetros: Na seção de Parâmetros, você pode expandir as propriedades para ver informações adicionais sobre cada uma das propriedades da ação.

Localizar documentação API

APIs do CXone são documentados no CXonePortal do desenvolvedor. Ações API no Studio não possuem um vínculo direto à documentação correspondente aos seus APIs. No entanto, você pode usar informações disponíveis nas propriedades estendidas da ação para ajudá-lo(a) a localizar a documentação.

Usar o URI requer familiaridade geral com o sistema CXone como um todo e com as diferentes APIs do CXone. Isto porque determinar qual API é compatível com qual ação no Studio não é sempre fácil. Conhecer o caminho geral de um contato pelo CXone o ajuda a interpretar corretamente o URI de uma ação e a aplicar as pistas ali encontradas à estrutura da documentação API no portal do desenvolvedor. Os exemplos nesta seção demonstram a interpretação que pode ser exigida.

A página Inicial da seção API no portal do desenvolvedor fornece uma visão geral sobre cada API do CXone.

Exemplo 1

Às vezes há uma correlação clara entre uma ação e seu API:

Com base no nome e URI da ação, os primeiros dois APIs a ser considerados são o API de Agente e o API Admin. Ao olhar para a lista de chamadas API para cada um, você pode eliminar o API de Agente. A sua descrição indica que ele é usado para gerenciar sessões de agentes e não parece haver nenhuma chamada relacionada a competências, conforme ilustrado na imagem a seguir.

A lista de chamadas de API para o API de Agente no Portal do Desenvolvedor.

O API Admin indica que ele é usado com objetos de sistema como competências. A lista de chamadas de API Disponível para este API inclui competências, conforme ilustrado na imagem a seguir.

A lista de chamadas disponível no API Admin na documentação do Portal do Desenvolvedor.

Ao expandir a seção Competências, um dos terminais é GET /skills/agents. A breve descrição para este terminal diz que ele "Retorna atribuições de competências."

O API correspondente à ação Atribuições de agente por competência.

Exemplo 2

Às vezes, a correlação não é óbvia, conforme mostrado no exemplo a seguir. Em casos como esse, você precisará aplicar o seu conhecimento de APIs do CXone e da própria plataforma para encontrar o terminal API correspondente. —

Com base neste nome e URI da ação, não fica imediatamente claro qual API analisar primeiro. Caso não tenha certeza sobre por onde deve começar, você pode consultar a documentação para cada API e examinar todas as seções relacionadas aos contatos. O API Admin é o único que possui uma seção para contatos de alto nível. Infelizmente, este API não contém terminais relacionados a contatos ativos.

A lista de chamadas disponível no API de Engajamento digital na documentação do Portal do Desenvolvedor.

A lista de terminais disponível na seção Contatos do API Admin.

A essa altura, você pode digitar a palavra ativo no nome e URI da ação. Aproveitando-se do seu conhecimento do CXone, você sabe que ativo indica contatos que estão atualmente sendo atendidos. Isso o leva a analisar com mais detalhes o API de Dados em Tempo Real. Este API tem apenas uma seção e, quando você a expande, vê que um dos terminais é GET /contacts/active. A breve descrição para este terminal diz que ele "Retorna contatos ativos."

A lista de terminais disponível na seção RealTime do API de Dados em Tempo Real.