ホーム > 機能と設定 > プラグインと API > LiveAgent の REST API > エージェントの「チーム」に関する API

エージェントの「チーム」に関する API

§ チームに所属する全てのエージェントのステータスを呼び出す

※ LiveAgent version 2.8.2.1 以降に対応します。

API 呼び出し例
GET
  http://example.com/api/departments/[departmentid]/agents?apikey=[value]

呼び出し時の必須パラメータ

パラメータ名形式内容
[departmentid]textエージェントのチーム ID
apikeytextAPI キー


出力データの内容

呼び出しフィールド

フィールド名形式内容
agentslistチームに所属する全てのエージェントのリスト
"agents" フィールドには 6 種類のカラムがあります
useridtextエージェントのユーザー ID
firstnametextエージェントの名
lastnametextエージェントの姓
emailtextエージェントのメールアドレス
onlinestatustextチームにおけるエージェントのオンラインステータス。次の値を組み合わせます T, P, M (T - チャット, P - 電話, M - 自動チケット解決)
presetstatustextチームにおけるエージェントの現在のステータス。 エージェントの有効ステータスが次の値を組み合わせて示されます。 T, P, M (T - チャット, P - 電話, M - 自動チケット解決)

データ出力例
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <agents>
  <agent>
   <userid>ag0h45s</userid>
   <firstname>John</firstname>
   <lastname>Doe</lastname>
   <email>john@agent.com</email>
   <onlinestatus>M</onlinestatus>
   <presetstatus>M</presetstatus>
  </agent>
  <agent>
   <userid>bc0s45s</userid>
   <firstname>Any</firstname>
   <lastname>Johnason</lastname>
   <email>any@agent.com</email>
   <onlinestatus>M</onlinestatus>
   <presetstatus>M</presetstatus>
  </agent>
 </agents>
</response>
JSON
{
  "response":{
    "agents":[
      {
        "userid":"ag0h45s",
        "firstname":"John",
        "lastname":"Doe",
        "email":"john@agent.com",
        "onlinestatus":"M",
        "presetstatus":"M"
      },
      {
        "userid":"bc0s45s",
        "firstname":"Any",
        "lastname":"Johnason",
        "email":"any@agent.com",
        "onlinestatus":"M",
        "presetstatus":"M"
      }
    ]
  }
}


§ チームのリストを呼び出す

※ LiveAgent version 2.8.2.1 以降に対応します。

API 呼び出し例
GET
  http://example.com/api/departments?apikey=[value]

呼び出し時の必須パラメータ

パラメータ名形式内容
apikeytextAPI キー


出力データの内容

呼び出しフィールド

フィールド名形式内容
departmentslistエージェントのチームのリスト
"departments" フィールドには 6 種類のカラムがあります
departmentidtextチーム ID
nametextチームの名称
descriptiontextチームの概要
onlinestatustextチームのオンラインステータス - チームレベルでのオンラインステータスを次の値を組み合わせて出力します。 T, P, M (T - チャット, P - 電話, M - 自動チケット解決)
presetstatustextチームの現在のステータス - チームがサービス提供可能かのステータスを、次の値を組み合わせて出力します。 T, P, M (T - チャット, P - 電話, M - 自動チケット解決)
deletedconstlistIf チームが削除されたかどうか (有効値： Y - 削除済, N - 未削除)

データ出力例
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <departments>
  <department>
   <departmentid>d1s58gs4</departmentid>
   <name>Department 1</name>
   <description>This is first deaprtment</description>
   <onlinestatus>M</onlinestatus>
   <presetstatus>M</presetstatus>
   <deleted>N</deleted>
  </department>
  <department>
   <departmentid>d2s58gs4</departmentid>
   <name>Department 2</name>
   <description>This is second deaprtment</description>
   <onlinestatus>R</onlinestatus>
   <presetstatus>MRT</presetstatus>
   <deleted>N</deleted>
  </department>
 </departments>
</response>
JSON
{
  "response":{
    "departments":[
      {
        "departmentid":"d1s58gs4",
        "name":"Department 1",
        "description":"This is first deaprtment",
        "onlinestatus":"M",
        "presetstatus":"M",
        "deleted":"N"
      },
      {
        "departmentid":"d2s58gs4",
        "name":"Department 2",
        "description":"This is second deaprtment",
        "onlinestatus":"R",
        "presetstatus":"MRT",
        "deleted":"N"
      }
    ]
  }
}


§ チームの詳細情報を呼び出す

※ LiveAgent version 2.8.2.1 以降に対応します。

API 呼び出し例
GET
  http://example.com/api/departments/[departmentid]?apikey=[value]

呼び出し時の必須パラメータ

パラメータ名形式内容
[departmentid]textエージェントのチーム ID
apikeytextAPI キー


出力データの内容

呼び出しフィールド

フィールド名形式内容
departmentidtextエージェントのチーム ID
nametextチームの名称
descriptiontextチームの概要
onlinestatustextチームのオンラインステータス- チームレベルでのオンラインステータスを、次の値を組み合わせて出力します。 T, P, M (T - チャット, P - 電話, M - 自動チケット解決)
presetstatustextチームの現在のステータス - チームレベルでのサービス稼働状況を、次の値を組み合わせて出力します。 T, P, M (T - チャット, P - 電話, M - 自動チケット解決)
deletedconstlistチームが削除されたかどうか (有効値： Y - 削除済, N - 未削除)

データ出力例
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <departmentid>e4y7g8s8</departmentid>
 <name>Support</name>
 <description>General support department</description>
 <onlinestatus>M</onlinestatus>
 <presetstatus>M</presetstatus>
 <deleted>N</deleted>
</response>
JSON
{
  "response":{
    "departmentid":"e4y7g8s8",
    "name":"Support",
    "description":"General support department",
    "onlinestatus":"M",
    "presetstatus":"M",
    "deleted":"N"
  }
}


更新: