エージェント監視データの取得

このAPIはエージェントの監視データを取得するために使用されます。

リクエストメソッド

GET /agent_monitor_infos

リクエストパラメータ(Query String)

パラメータ名 タイプ 必須 説明 制限
user_group_id 整数型 いいえ エージェントグループID
module_type 文字列型 いいえ エージェントシステムモジュール

詳細パラメータ説明

user_group_id

指定しない場合、すべてのエージェント情報を返します。

module_type

指定しない場合、すべてのモジュールの状態を返します。

レスポンスデータ

属性名 タイプ 説明
code 整数型 実行結果コード、1000は成功を表します
data 配列 詳細は以下を参照

dataの構造

パラメータ名 タイプ 説明
id 整数型 エージェントID
nick_name 文字列型 エージェントのニックネーム
avatar 文字列型 エージェントのアバター画像リンク
duty 文字列型 エージェントの役職
ticket_receive_status ブール型 チケット受付状態
im_status 文字列型 IM状態
call_status 文字列型 コールセンター状態
mpv_status 文字列型 ビデオ状態

状態の意味

リクエスト

curl https://demo.udesk.cn/open_api_v1/agent_monitor_infos?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X GET \
-H 'content-type: appliacation/json' \

レスポンス

{
    "code": 1000,
    "data": [
        {
            "id": 1,
            "nick_name": "agent1",
            "avatar": "https://pro-cs.oss-cn-hangzhou.aliyuncs.com/agent_header/e_1579165834536_ua464.jpeg",
            "duty": null,
            "ticket_receive_status": true,
            "im_status": "busy",
            "call_status": "offline",
            "mpv_status": "idle"
        },
        {
            "id": 2,
            "nick_name": "agent2",
            "avatar": null,
            "duty": null,
            "ticket_receive_status": true,
            "im_status": "offline",
            "call_status": "offline",
            "mpv_status": "online"
        }
    ]
}