---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Agent - Global

# Agent - Global {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute de lecture

L'API Agent fournit des méthodes pour obtenir ou définir la présence de l'agent et la disponibilité des canaux.

L'API Agent est fournie dans l'espace de noms `sn_awa` .  
Nécessite les éléments suivants :

* Module d'extension Advanced Work Assignment (com.glide.awa)
* Rôle : awa_integration_user ou admin
{#c_AgentAPI__ul_cgv_mtc_2gb}

## Agent : obtenir (chaîne user_sys_id) {#ariaid-title2}

Obtient un agent par sys_id.
{#r_agent_get__table_t4k_y54_3gb__entry__3}

| Nom | Type | Description |
|-|-|-|
| user_sys_id | Chaîne | Le sys_id de l'utilisateur répertorié dans sys_user table. |
[Tableau 1. Paramètres]

{#r_agent_get__table_t4k_y54_3gb} {#r_agent_get__table_u4k_y54_3gb__entry__2}

| Type | Description |
|-|-|
| Booléen | Vrai si l'utilisateur existe, faux dans les autres cas. |
[Tableau 2. Renvoie]

{#r_agent_get__table_u4k_y54_3gb}  

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

## Agent : getPresence() {#ariaid-title3}

Obtient l'état de présence actuel et la disponibilité du canal d'un agent fourni.
{#r_getPresence__table_kt3_zrc_2gb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 3. Paramètres]

{#r_getPresence__table_kt3_zrc_2gb} {#r_getPresence__table_lt3_zrc_2gb__entry__2}

| Type | Description |
|-|-|
| Objet | sys_id de l'état de présence, nom de l'état de présence et informations sur le canal. Message d'erreur sinon. |
[Tableau 4. Renvoie]

{#r_getPresence__table_lt3_zrc_2gb}  

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

## Agent : setPresence(Object setRequest) {#ariaid-title4}

Définit l'état de la présence d'un agent fourni et définit la disponibilité du canal de l'agent pour cet état.
{#r_setPresence__table_hqw_pbm_yfb__entry__3}

| Nom | Type | Description |
|-|-|-|
| setRequest (en anglais seulement) | Objet | Le setRequest.sys_id et setRequest.channels. |
| setRequest.sys_id | Chaîne | Le presence_sys_id de la table État de présence AWA \[awa_presence_state\]. |
| setRequest.channels | Paire nom/valeur | Facultatif. * sys_id : Channel_sys_id à partir de la table awa_service_channel. * available : disponibilité de l'agent pour recevoir du travail pour ce canal (vrai ou faux). {#r_setPresence__ul_vsh_tqn_kgb} |
[Tableau 5. Paramètres]

{#r_setPresence__table_hqw_pbm_yfb} {#r_setPresence__table_iqw_pbm_yfb__entry__2}

| Type | Description |
|-|-|
| Booléen | Vrai en cas de succès, faux dans les autres cas. |
[Tableau 6. Renvoie]

{#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
        }]
    });