---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Agente - Global

# Agente - Global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 min. de leitura

A API do agente fornece métodos para obter ou definir a presença do agente e a disponibilidade do canal.

A API do agente é fornecida no namespace `sn_awa`.  
Requer o seguinte:

* Plug-in Advanced Work Assignment (com.glide.awa)
* Função: awa_integration_user ou administrador
{#c_AgentAPI__ul_cgv_mtc_2gb}

## Agente - get(String user_sys_id) {#ariaid-title2}

Obtém um agente por sys_id.
{#r_agent_get__table_t4k_y54_3gb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| user_sys_id | Cadeia de caracteres | O sys_id do usuário listado na tabela sys_user. |
[Tabela 1. Parâmetros]

{#r_agent_get__table_t4k_y54_3gb} {#r_agent_get__table_u4k_y54_3gb__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Verdadeiro se o usuário existir, caso contrário, falso. |
[Tabela 2. Retorna]

{#r_agent_get__table_u4k_y54_3gb}  

    var agent = sn_awa.Agent.get("<user_sys_id>");
    var presence  = agent.getPresence();

## Agente -- getPresence() {#ariaid-title3}

Obtém o estado de presença atual e a disponibilidade de canal de um agente fornecido.
{#r_getPresence__table_kt3_zrc_2gb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 3. Parâmetros]

{#r_getPresence__table_kt3_zrc_2gb} {#r_getPresence__table_lt3_zrc_2gb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | sys_id do estado de presença, nome do estado de presença e informações do canal. Caso contrário, mensagem de erro. |
[Tabela 4. Retorna]

{#r_getPresence__table_lt3_zrc_2gb}  

    var agent = sn_awa.Agent.get("<user_sys_id>");
            var presence  = agent.getPresence();

## Agente -- setPresence(Object setRequest) {#ariaid-title4}

Define o estado de presença de um agente fornecido e define a disponibilidade do canal do agente para esse estado.
{#r_setPresence__table_hqw_pbm_yfb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| definirRequest | Objeto | O setRequest.sys_id e setRequest.channels. |
| setRequest.sys_id | Cadeia de caracteres | O presença_sys_id da tabela Estado de presença do AWA \[awa_presence_state\]. |
| setRequest.canais | par de nome/valor | Opcional. * sys_id: Channel_sys_id da tabela awa_service_channel. * disponível: disponibilidade do agente para receber trabalho para este canal (verdadeiro ou falso). {#r_setPresence__ul_vsh_tqn_kgb} |
[Tabela 5. Parâmetros]

{#r_setPresence__table_hqw_pbm_yfb} {#r_setPresence__table_iqw_pbm_yfb__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Verdadeiro se for bem-sucedido, falso caso contrário. |
[Tabela 6. Retorna]

{#r_setPresence__table_iqw_pbm_yfb}  

    var agent = sn_awa.Agent.get("<user_sys_id>");
    var presence = agent.setPresence({
        sys_id: <presence_sys_id>,
        channels: [{
            sys_id: "<channel_sys_id>",
            available: true // or false
        }]
    });