---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# エージェント - グローバル

# エージェント - グローバル {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：2分

エージェント API は、エージェントのプレゼンスとチャネルの可用性を取得または設定するためのメソッドを提供します。

エージェント API は、`sn_awa` 名前空間内で提供されます。  
以下が必要です。

* 高度な作業アサインプラグイン (com.glide.awa)
* ロール：awa_integration_user または admin
{#c_AgentAPI__ul_cgv_mtc_2gb}

## Agent - get(文字列 user_sys_id) {#ariaid-title2}

sys_id によってエージェントを取得します。
{#r_agent_get__table_t4k_y54_3gb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| user_sys_id | 文字列 | sys_user テーブルに記載されているユーザーの sys_id。 |
[表 : 1. パラメーター]

{#r_agent_get__table_t4k_y54_3gb} {#r_agent_get__table_u4k_y54_3gb__entry__2}

| タイプ | 説明 |
|-|-|
| ブーリアン | ユーザーが存在する場合は true、それ以外の場合は false。 |
[表 : 2. 返される内容]

{#r_agent_get__table_u4k_y54_3gb}  

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

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

指定されたエージェントの現在の在席状況とチャネルの可用性を取得します。
{#r_getPresence__table_kt3_zrc_2gb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 3. パラメーター]

{#r_getPresence__table_kt3_zrc_2gb} {#r_getPresence__table_lt3_zrc_2gb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | 在席状況 sys_id、在席状況名、チャネル情報。それ以外の場合はエラーメッセージ。 |
[表 : 4. 返される内容]

{#r_getPresence__table_lt3_zrc_2gb}  

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

## Agent -- setPresence(オブジェクト setRequest) {#ariaid-title4}

指定されたエージェントのプレゼンスのステータスを設定し、そのステータスに対するエージェントのチャネルの可用性を設定します。
{#r_setPresence__table_hqw_pbm_yfb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| setRequest | オブジェクト | setRequest.sys_id と setRequest.channels. |
| setRequest.sys_id | 文字列 | AWA 在席状況 \[awa_presence_state\] テーブルからのpresence_sys_id。 |
| setRequest.channel | 名前/値ペア | オプション。 * sys_id:awa_service_channelテーブルからChannel_sys_id。 * available:このチャネルの作業を受け取るエージェントの可用性 (true または false)。 {#r_setPresence__ul_vsh_tqn_kgb} |
[表 : 5. パラメーター]

{#r_setPresence__table_hqw_pbm_yfb} {#r_setPresence__table_iqw_pbm_yfb__entry__2}

| タイプ | 説明 |
|-|-|
| ブーリアン | 成功した場合は true、それ以外の場合は false。 |
[表 : 6. 返される内容]

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