カスタマーサポートグループリストの取得
このAPIは、複数のカスタマーサポートグループ情報を一度に取得するために使用されます。
リクエストメソッド
GET /user_groups
リクエストパラメータ（Query String）
| パラメータ名 | 必須 | タイプ | 説明 | 制限 |
|---|---|---|---|---|
| page | いいえ | 整数 | ページ番号（1から開始、デフォルトは1） | |
| per_page | いいえ | 整数 | 1ページあたりの件数（デフォルト20、最大100） |
レスポンスデータ
| 属性名 | タイプ | 説明 |
|---|---|---|
| code | 整数 | 実行結果コード（1000は成功を表します） |
| meta | オブジェクト | ページネーション情報（詳細は共通データを参照） |
| user_groups | 配列 | カスタマーサポートグループリスト（各グループの詳細は以下を参照） |
カスタマーサポートグループデータ
| 属性名 | タイプ | 説明 |
|---|---|---|
| id | 整数 | 一意の識別子 |
| name | 文字列 | 名前 |
| agents | 配列 | 含まれるカスタマーサポート |
agents要素の構造
| 値 | 意味 |
|---|---|
| id | カスタマーサポートの一意の識別子 |
| nick_name | カスタマーサポートの名前 |
例
curl https://demo.udesk.cn/open_api_v1/user_groups?page=1&per_page=10&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
レスポンス
{
"code": 1000,
"user_groups": [
{
"id": 1,
"name": "カスタマーサポートグループ1",
"agents": [
{"id": 1, "nick_name": "テストカスタマーサポート1"}
]
}
],
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1
}
}
カスタマーサポートグループに所属するカスタマーサポートの取得
このAPIは、複数のカスタマーサポートグループ情報を一度に取得するために使用されます。
リクエストメソッド
GET /user_groups/:id/agents
リクエストパラメータ（クエリストリング）
| パラメータ名 | 必須 | タイプ | 説明 | 制限 |
|---|---|---|---|---|
| page | 否 | 整数型 | ページ番号。1から開始。デフォルトは1。 | |
| per_page | 否 | 整数型 | 1ページあたりの表示数。デフォルト20、最大100。 |
レスポンスデータ
| 属性名 | タイプ | 説明 |
|---|---|---|
| code | 整数型 | 実行結果コード。1000は成功を表します。 |
| user_group | オブジェクト | カスタマーサポートグループの詳細。 |
カスタマーサポートグループデータ
| 属性名 | タイプ | 説明 |
|---|---|---|
| id | 整数型 | 一意の識別子。 |
| name | 文字列型 | 名前。 |
| agents | 配列型 | 所属するカスタマーサポート。 |
agents要素の構造
| 値 | 意味 |
|---|---|
| id | カスタマーサポートの一意の識別子。 |
| nick_name | カスタマーサポートの名前。 |
| カスタマーサポートのメールアドレス。 | |
| cellphone | カスタマーサポートの携帯電話番号。 |
| work_id | 社員番号。 |
| im_ability_value | チャット対応スキル値。 |
| profile | 従業員タイプ。 |
| aliase | 表示用ニックネーム。 |
| role_name | アカウントタイプ。 |
| duty | 従業員の役職。 |
| user_group_ids | 所属するカスタマーサポートグループIDのリスト。 |
| disable_status | 状態 (enable: 有効, disable: 無効)。 |
| avatar | プロフィール画像。 |
| lang | 言語設定。 |
| availability | 自動チケット割り当てを受け入れるかどうか。 |
| im_welcomes | ウェルカムメッセージ。 |
| user_groups | 所属する従業員グループ。 |
| agent_roles | 従業員が所属するロール。 |
| departments | 所属する部門。 |
| agent_callout_display_number | 発信者番号表示。 |
| number | SIP情報。 |
| password | SIP情報。 |
例
curl http://demo.udesk.cn/open_api_v1/user_groups/1/agents?page=1&per_page=10&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
レスポンス
{
"code": 1000,
"user_groups": [
{
"id": 1,
"name": "カスタマーサポートグループ1",
"agents": [
{
"id": 1,
"nick_name": "テストカスタマーサポート1",
"cellphone": 12345678901,
"work_id": 1,
"profile": "all",
"aliase": "テストカスタマーサポート1",
"role_name": "agent",
"duty": null,
"user_group_ids": [1],
"im_ability_value": 10,
"disable_status": "enable",
"avatar": "http://attachments.gfan.com/forum/attachments2/201302/03/11281446n2st1its4152n5.jpg",
"lang": "en-us",
"availability": true,
"im_welcomes": "",
"user_groups": [
{"id":2,"name":"カスタマーサポートグループ1"}
],
"agent_roles": [
{"id": 1, "name": "ロール1", "description": ""}
],
"departments": [
{"id":1,"name":"部門1"},
{"id":3,"name":"部門3"}
],
"agent_callout_display_number": "",
"number": "",
"password": "",
}
]
}
]
}
カスタマーサポートグループの作成
このAPIはカスタマーサポートグループを作成するために使用されます。
リクエストメソッド
POST /user_groups
リクエストパラメータ (request body)
| パラメータ | 必須 | タイプ | 説明 | 制限 | デフォルト |
|---|---|---|---|---|---|
| name | はい | 文字列 | カスタマーサポートグループ名 | 255文字以内 |
レスポンスデータ
| 属性名 | タイプ | 説明 |
|---|---|---|
| code | 整数 | 実行結果コード、1000は成功を表します |
| id | 整数 | 作成されたカスタマーサポートグループのID |
例
リクエスト
curl https://demo.udesk.cn/open_api_v1/user_groups?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type:application/json' \
-d '{
"name":"カスタマーサポートグループ1"
}'
レスポンス
{
"id": 1,
"code": 1000
}
カスタマーサポートグループの編集
このAPIはカスタマーサポートグループを編集するために使用されます。
リクエストメソッド
PUT /user_groups/:id
リクエストパラメータ (request body)
| パラメータ | 必須 | タイプ | 説明 | 制限 | デフォルト |
|---|---|---|---|---|---|
| name | はい | 文字列 | カスタマーサポートグループ名 | 255文字以内 |
レスポンスデータ
| 属性名 | タイプ | 説明 |
|---|---|---|
| id | 整数 | 今回の操作で編集されたカスタマーサポートグループのID |
| code | 整数 | 実行結果コード、1000は成功を表します |
| user_group | オブジェクト | カスタマーサポートグループ情報、構造は以下の通り |
user_groupの構造
| 属性名 | タイプ | 説明 |
|---|---|---|
| id | 整数 | 一意の識別子 |
| name | 文字列 | 名前 |
| agents | 配列 | 含まれるカスタマーサポート |
例
リクエスト
curl https://demo.udesk.cn/open_api_v1/user_groups/1?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X PUT \
-H 'content-type:application/json' \
-d '{
"name":"カスタマーサポートグループ2"
}'
レスポンス
{
"code": 1000,
"user_group": {
"id": 1,
"name": "カスタマーサポートグループ2",
"agents": [
{"id": 1, "nick_name": "テストカスタマーサポート1"},
{"id": 2, "nick_name": "テストカスタマーサポート2"}
]
}
}
カスタマーサポートグループの削除
このAPIはカスタマーサポートグループを削除するために使用されます。
リクエストメソッド
DELETE /user_groups/:id
リクエストパラメータ（URL）
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| id | 整数 | はい | カスタマーサポートグループID |
リクエストパラメータ（リクエストボディ）
なし
レスポンスデータ
| 属性名 | タイプ | 説明 |
|---|---|---|
| code | 整数 | 実行結果コード、1000は成功を表します |
| message | 文字列 | 実行結果の説明 |
例
リクエスト
curl https://demo.udesk.cn/open_api_v1/user_groups/1?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
\
-X DELETE \
-H 'content-type: application/json' \
レスポンス
{
"message": "IDが1のカスタマーサポートグループの削除に成功しました",
"code": 1000
}
codeエラーコード説明
| エラーコード | message情報 | exception:message情報 | 説明 |
|---|---|---|---|
| 2000 | 不明なエラー | 検証失敗: グループ名は空文字にできません | 必須パラメータnameは空にできません |
| nameは空にできません | なし | パラメータnameの値は空にできません | |
| 2005 | 該当リソースが見つかりませんでした | Couldn't find UserGroup with id=xxx [WHERE user_groups.company_id= ? AND user_groups.category = '普通客服组'] |
パラメータidに一致する値が見つかりませんでした |