コールセンターオペレータグループ監視インターフェース

このインターフェースは、現在の企業の特定のオペレータグループに属する全メンバーのコールセンター監視情報を取得するために使用されます。

リクエストメソッド

GET /callcenter_analysis/agents_of_group

リクエストパラメータ

パラメータ名 必須 型 説明 制限
group_id いいえ 整数型 未入力の場合、すべてのオペレータの状態を返します
page いいえ 整数型 ページ番号、1から開始、デフォルトは1
perpage いいえ 整数型 1ページあたりの件数、デフォルト30、最大100

レスポンスデータ

属性名 型 説明
code 整数型 実行結果コード、1000は成功を表します
server_time DateTime 現在のサーバー時間
items 配列 詳細は以下を参照
meta オブジェクト ページネーション情報、詳細は以下

itemsの構造

パラメータ名 型 説明
id 整数型 オペレータID
name 文字列 オペレータ名
agent_work_state 文字列 オペレータ現在の状態1
agent_neaten_time 整数型 オペレータ整理時間
agent_work_way 文字列 オペレータ作業方式2
cc_custom_state_id 整数型 カスタム休憩状態ID
subaccount_state 文字列 デバイス状態3
agent_call_state 文字列 オペレータ通話状態4
callout_count 整数型 発信回数
callin_answer_count 整数型 着信応答回数
callin_noanswer_count 整数型 着信未応答回数
callout_answer_count 整数型 発信応答回数
category 文字列 直近の通話のタイプ5
answer_delay 整数型 直近の通話の応答遅延
talking_time 整数型 直近の通話の通話時間
conversation_id 整数型 直近の通話の通話記録ID
customer json 直近の通話の顧客情報
id 整数型 直近の通話の顧客ID
cellphone 文字列 直近の通話の顧客の電話番号
other_start_at 日付 オペレータが現在の状態に切り替わった開始時間
### 詳細説明
パラメータ名 値 説明　
1 agent_work_state offline オフライン
idle 空き状態
　　　　　　　　　　　　　　　　　　　 busy ビジー状態
resting 休憩中
neaten 整理中
2 agent_work_way voip_online ウェブ電話
fixed_voip_online IP電話機
　　　　　　　　　　　　　　　　　　　 phone_online 従来型電話(携帯電話/固定電話)
3 subaccount_state offline 電話機オフライン
unregister 未登録
　　　　　　　　　　　　　　　　　　　 expire　 期限切れ
idle 空き状態
busy 通話中
4 agent_call_state off 通話なし
ring 呼び出し中
　　　　　　　　　　　　　　　　　　　 in 通話中
5 category normal 通常通話
transfer 転送
transfer_outline 外線転送
consult 相談
consult_outline 相談（外線）
three_party 三者通話
three_party_outline 三者通話（外線）
listening モニタリング
barge_in リーダー強制割り込み
substitute リーダー強制切断
6 customer id 顧客ID
cellphone 顧客電話番号

ページネーション情報

リスト取得などのAPIでは、返されるデータに通常ページネーション情報（meta）が含まれます。その内容は以下の通りです：

属性名 型 説明
current_page 整数型 現在のページ番号
total_pages 整数型 総ページ数
count 整数型 データ総数

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/callcenter_analysis/agents_of_group?group_id=269&page=1&perpage=1&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,
  "server_time": "2018-05-08T20:09:47+08:00",
  "items": [{
    "id": 269,
    "name": "展示",
    "agent_work_state": "idle",
    "agent_neaten_time": 10,
    "agent_work_way": "fixed_voip_online",
    "cc_custom_state_id": null,
    "subaccount_state": "idle",
    "agent_call_state": "off",
    "callout_count": 2,
    "callin_answer_count": 0,
    "callin_noanswer_count": 0,
    "callout_answer_count": 2,
    "category": "normal",
    "answer_delay": 0,
    "talking_time": 0,
    "conversation_id": 100100100,
    "customer": {
      "id": 196001,
      "cellphone": "13261998838"
    },
    "other_start_at": "2018-05-08T16:56:05.000+08:00"
  }],
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "count": 1
  }
}

本日の通話データ

このAPIは、現在の会社の本日の通話データを取得するために使用されます。

リクエストURL

GET /callcenter_analysis/calls_info_of_today

リクエストパラメータ

フィールド名 タイプ 必須かどうか
group_id string いいえ、未入力の場合は全カスタマーサポートグループのデータを返します
page Integer いいえ、ページ番号、デフォルトは1から開始
perpage Integer いいえ、1ページあたりの件数、デフォルト30、最大100

レスポンスデータ

フィールド名 タイプ フィールド説明
code Integer 実行結果、成功は1000
server_time DateTime 現在のサーバー時間
items 配列 詳細は以下を参照
meta オブジェクト ページネーション情報

itemsの説明

フィールド名 タイプ フィールド説明
group_id Integer カスタマーサポートグループID、空の場合は全グループの集計データ
callin_count string 着信数
transfer_agent_count string 人工対応への転送数 / キュー入り数
queue_success_count string キュー待機成功数
queue_quit_count string キュー待機放棄数
callin_ringing_count string 着信呼び出し数
callin_answered_count string 着信応答数
callin_answered_rate string 着信応答率
survey_rated_ratio string 評価参加率
callout_count string 発信数
callout_no_answered_count string 発信未応答数
callout_answered_count string 発信応答数
callout_answered_rate string 発信応答率

リクエスト例

curl https://demo.udesk.cn/open_api_v1/callcenter_analysis/calls_info_of_today?
     group_id=1,2&page=1&perpage=1&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,
  server_time: "2018-05-08T20:09:47+08:00",
  items: [
    {
      group_id: ,
      callin_count: 10,
      transfer_agent_count: 4,
      queue_success_count: 5,
      queue_quit_count: 3,
      callin_ringing_count: 12,
      callin_answered_count: 13,
      callin_answered_rate: 0.43,
      survey_rated_ratio: 0.71,
      callout_count: 40,
      callout_no_answered_count: 20,
      callout_answered_count: 20,
      callout_answered_rate: 0.50
    },
    {
      group_id: 1,
      callin_count: 10,
      transfer_agent_count: 4,
      queue_success_count: 5,
      queue_quit_count: 3,
      callin_ringing_count: 12,
      callin_answered_count: 13,
      callin_answered_rate: 0.43,
      survey_rated_ratio: 0.71,
      callout_count: 40,
      callout_no_answered_count: 20,
      callout_answered_count: 20,
      callout_answered_rate: 0.50
    },
    {
      group_id: 2,
      callin_count: 10,
      transfer_agent_count: 4,
      queue_success_count: 5,
      queue_quit_count: 3,
      callin_ringing_count: 12,
      callin_answered_count: 13,
      callin_answered_rate: 0.43,
      survey_rated_ratio: 0.71,
      callout_count: 40,
      callout_no_answered_count: 20,
      callout_answered_count: 20,
      callout_answered_rate: 0.50
    }
  ]
  meta: {
    current_page: 1,
    total_pages: 1,
    count: 2
  }
}

現在の待機状況

このAPIは、現在の会社の現在の待機データを取得するために使用されます。

リクエストURL

GET /callcenter_analysis/calls_in_queue

リクエストパラメータ

フィールド名 タイプ 必須かどうか
group_id string いいえ、未入力の場合はすべてのカスタマーサポートグループのデータを返します
page Integer いいえ、ページ番号、デフォルトは1から開始
perpage Integer いいえ、1ページあたりの件数、デフォルト30、最大100

レスポンスデータ

フィールド名 タイプ フィールド説明
code Integer 実行結果、成功は1000
server_time DateTime 現在のサーバー時間
items 配列 詳細は以下を参照
meta オブジェクト ページネーション情報

itemsの説明

フィールド名 タイプ フィールド説明
group_id Integer カスタマーサポートグループID、空の場合はすべてのカスタマーサポートグループの全体データを表します
cellphone string 顧客の電話番号
name string 顧客名
queue string キュー名
start_at string 開始時間
queue_time string 待機時間

リクエスト例

curl https://demo.udesk.cn/open_api_v1/callcenter_analysis/calls_in_queue?
     group_id=1&page=1&perpage=1&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,
  server_time: "2018-05-08T20:09:47+08:00",
  items: [{
    group_id: 1,
    cellphone: '18710812345',
    name: 'udesk',
    queue: '待機放棄',
    start_at: '20180710',
    queue_time: '10'
  }]
  meta: {
    current_page: 1,
    total_pages: 1,
    count: 1
  }
}

待機放棄状況

このAPIは、現在の会社の現在の待機放棄データを取得するために使用されます。

リクエストURL

GET /callcenter_analysis/calls_quitted_queue

リクエストパラメータ

フィールド名 タイプ 必須かどうか
group_id string いいえ、未入力の場合はすべてのカスタマーサポートグループのデータを返します
page Integer いいえ、ページ番号、デフォルトは1から開始
perpage Integer いいえ、1ページあたりの件数、デフォルト30、最大100
### 返却データ
フィールド名 タイプ フィールド説明
code Integer 実行結果、成功は1000
server_time DateTime 現在のサーバー時間
items 配列 詳細は以下を参照
meta オブジェクト ページネーション情報

itemsの説明

フィールド名 タイプ フィールド説明
group_id Integer サポートグループID、空の場合は全サポートグループの全体データを表す
cellphone string 顧客電話番号
name string 顧客名
abort_at string 放棄時間
queue string キュー名
queue_time string 待ち時間
sub_call string 後続通話
task_name string アウトバウンドタスク名

リクエスト例

curl https://demo.udesk.cn/open_api_v1/callcenter_analysis/calls_quitted_queue?
     group_id=1&page=1&perpage=1&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,
  server_time: "2018-05-08T20:09:47+08:00",
  items: [{
    group_id: 1,
    cellphone: '18710812345',
    name: 'udesk',
    abort_at: '2018-03-14 10:14:01 +0800',
    queue: '待ち放棄',
    queue_time: 9,
    sub_call: 21,
    task_name: 'アウトバウンドタスク'
  }]
  meta: {
    current_page: 1,
    total_pages: 1,
    count: 1
  }
}

codeエラーコード説明

エラーコード message情報 exception:message情報 説明
11012 このグループは存在しないか、削除されました このグループは存在しないか、削除されました パラメータ{group_id}のサポートグループは存在しません