---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference

 Release :

    - australia

ft:locale :

    - ja-JP

ft:publication_title :

    - オーストラリア API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

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

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

* リリースバージョン: Australia
* 
* 更新日 2026年03月12日
* 
* ![](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}

## エージェント:get(文字列 user_sys_id) {#ariaid-title2}

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

| 名前 | タイプ | 説明 |
|-|-|-|
| user_sys_id | 文字列 | テーブルにリストされているユーザーのsys_id sys_user。 |
[表 : 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();

## エージェント -- 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();

## エージェント -- setPresence(Object 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.channels | 名前/値ペア | オプション。 * 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
        }]
    });