2.5 登録者グループの API
2.5.1 グループの追加 (/api/v1/group)
概要
グループを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v1/group
リクエスト方法
POST: form-data
リクエストパラメーター
パラメーター名
型
必須
説明
name
string
Yes
グループ名。長さ制限は 45。
type
int
Yes
グループタイプ(1 : 従業員グループ、2 : ビジターグループ、5 : ブラックリストグループ)
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ(sign)の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
dataフィールドの説明
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
company_id
long
企業ID
create_at
string
作成時間
update_at
string
前回の変更時間
エラーレスポンスのフィールド
code
メッセージ
エラーの説明
30001
Param Invalid
無効なパラメーターです。登録者グループ名の長さが無効です。
30001
Param Invalid
無効なパラメーターです。登録者グループタイプは空にはできません。
30001
Param Invalid
無効なパラメーターです。登録者グループタイプが無効です。
30001
Param Invalid
無効なパラメーターです。登録者グループ名はすでに存在します。
50001
RPC FAILED
RPCに失敗しました。グループ作成に失敗しました。
50002
Internal Server Error
内部システムエラーです。グループ作成に失敗しました。
2.5.2 登録者グループリストの表示 list (/api/v1/group)
概要
登録者グループのリストを表示します。デフォルトの順序はID の降順です。
リクエストアドレスの例
https://HOST:PORT/api/v1/group
リクエスト方法
GET
リクエストパラメーター
パラメーター名
型
必須
説明
page
int
No
ページ番号 (デフォルトは 1 です)
size
int
No
1 ページあたりのデータ数 (デフォルトは 20 です)
type
int
No
登録者グループタイプ。1 : 従業員、2 : ビジター、5 : ブラックリスト
deviceId
long
No
デバイスの ID
groupIds
list<long>
No
グループID
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ(sign)の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
dataフィールドの説明
パラメーター名
型
説明
total
string
総計
pageNum
string
ページ数
size
string
サイズ
pageSize
string
ページサイズ
totalPage
string
ページ合計
data
object
データ
data.dataフィールドの説明
パラメーター名
型
説明
id
int
登録者グループの ID
name
string
登録者グループ名
company_id
int
企業 ID
create_at
string
作成時間
update_at
string
更新時間
type
int
登録者グループタイプ
user_number
int
グループ内の人数を示します
エラーレスポンスのフィールド
code
メッセージ
説明
30001
Param Invalid
無効なパラメーターです。登録者グループタイプが無効です。
30001
Param Invalid
無効なパラメーターです。デバイスが存在しません。
50001
RPC FAILED
RPCに失敗しました。デバイスグループリストの取得に失敗しました。
2.5.3 グループの登録者リストの取得 (/api/v1/group/user)
概要
グループ ID に基づいてグループ内のすべての登録者のID のリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v1/group/user
リクエスト方法
GET
リクエストパラメーター
パラメーター名
型
必須
説明
id
long
Yes
グループID
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ(sign)の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
list<long>
登録者ID
エラーレスポンスのフィールド
code
メッセージ
エラーの説明
620
Record non-existent Error
グループID が存在しません
30001
Param Invalid
無効なパラメーターです
2.5.4 登録者グループの更新 (/api/v3/group/update)
概要
登録者グループを更新します。
v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v3/group/update
リクエスト方法
POST application/json
リクエストパラメーター
パラメーター名
型
必須
説明
id
long
Yes
グループID
name
string
No
グループ名
device_ids
list<long>
No
デバイスID リスト
認証パラメーター
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ(sign)の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
object
データ
dataフィールドの説明
パラメーター名
型
説明
id
int
グループ ID
name
string
グループ名
type
int
グループタイプ
devices
list<device>
デバイス
is_default
int
デフォルトのグループかどうか
device フィールドの説明
パラメーター名
型
説明
id
int
デバイスの ID
name
string
デバイス名
type
int
デバイスタイプ
エラーレスポンスのフィールド
code
メッセージ
説明
498
Param Invalid
無効なグループ ID など
600
Sync Failed
リモートリクエストエラー
2.5.5 グループの削除 (/api/v1/group/delete/{id})
概要
グループを削除します。
リクエストアドレスの例
http://HOST:PORT/api/v1/group/delete/{id}
リクエスト方法
GET
リクエストパラメーター
パラメーター名
型
必須
説明
id
long
Yes
登録者グループの ID
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ(sign)の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード。200 はリクエストが成功したことを示します。
message
string
リターンメッセージ
エラーレスポンスのフィールド
code
メッセージ
説明
20002
Permission Denied
操作権限がないため、デフォルトのグループを削除できません。
30001
Param Invalid
無効なパラメーターです。グループID が存在しません。
30001
Param Invalid
無効なパラメーターです。変更グループは企業に属しておりません。
50001
RPC FAILED
RPCに失敗しました。グループの削除に失敗しました。
2.5.6 登録者のグループへの一括追加 (/api/v1/user/add/group)
概要
登録者を一括でグループに追加します。
リクエストアドレスの例
http://HOST:PORT/api/v1/user/add/group
リクエスト方法
POST: form-data
リクエストパラメーター
パラメーター名
型
必須
説明
groupId
long
Yes
登録者グループの ID
userIds
list<long>
Yes
一括で追加する登録者ID。一回の操作で最大2000 人を追加できます。
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ(sign)の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
通常のレスポンス
レスポンスフィールドの説明
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
エラーレスポンスのフィールド
code
メッセージ
説明
620
Record non-existent Error
グループID が存在しません
30001
param-invalid
無効なパラメーターです。2000 を超える数を一度にグループに追加することはできません。
30001
param-invalid
無効なパラメーターです。groupId が空です。
30001
param-invalid
無効なパラメーターです。登録者の userId array が空です。
30001
param-invalid
無効なパラメーターです。登録者とグループタイプが一致しません。
50001
RPC FAILED
RPCに失敗しました。一括登録者追加に失敗しました。
2.5.7 登録者のグループからの一括削除 (/api/v1/user/remove/group)
概要
グループから一括で登録者を削除します。
リクエストアドレスの例
http://HOST:PORT/api/v1/user/remove/group
リクエスト方法
POST: form-data
リクエストパラメーター
パラメーター名
型
必須
説明
groupId
long
Yes
従業員のグループID
userIds
list<long>
Yes
一括で削除する登録者のID。最大2000 まで一括で操作できます。
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ(sign)の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード。200 はリクエストが成功したことを示します。
message
string
リターンメッセージ
エラーレスポンスのフィールド
code
メッセージ
説明
620
Record non-existent Error
グループID が存在しません
30001
param-invalid
無効なパラメーターです。2000 を超える数を一度にグループから削除することはできません。
30001
param-invalid
無効なパラメーターです。groupId が空です。
30001
param-invalid
無効なパラメーターです。登録者の userId array が空です。
30001
param-invalid
無効なパラメーターです。登録者とグループタイプが一致しません。
50001
RPC FAILED
RPCに失敗しました。グループからの登録者の一括削除に失敗しました。
最終更新