APIでの登録者操作では顔写真品質チェッのレベル低実施されます。ご注意ください。
概要
従業員を追加します。
SenseLink Cloudをご利用の場合、ご利用のプランによって登録人数の上限が異なります。詳しくはお客様のご契約内容をご確認ください。
リクエストアドレスの例
https://HOST:PORT/api/v1/user
リクエスト方法
POST: form-data
リクエストパラメーター
※SenseLink Cloudのみ非必須で、SenseLink GE Enterpriseは必須です。
通常のレスポンス
類似登録者が存在する場合のレスポンス
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
概要
従業員情報を変更します。
バージョン v1 から、従業員ID、IC カード番号、および空の ID 番号の処理ロジックが改善されました。パラメーターが渡されなかった場合やパラメーターが null の場合、変更は行われません。空の string (””) が渡された場合、空として設定されます。バージョン v1 のインターフェースは、引き続きご利用いただくことができます。
リクエストアドレスの例
https://HOST:PORT/api/v2/user/update/{id}
リクエスト方法
POST: form-data
リクエストパラメーター
※SenseLink Cloudのみ非必須で、SenseLink GE Enterpriseは必須です。
group フィールドの説明
通常のレスポンス
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
概要
従業員を削除します。
リクエストアドレスの例
https://HOST:PORT/api/v1/user/delete/{id}
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
指定された日付(日)に追加、または更新された従業員アバターリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v2/staff/image_updated
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
ビジターを追加します。
SenseLink Cloudをご利用の場合、ご利用のプランによって登録人数の上限が異なります。詳しくはお客様のご契約内容をご確認ください。
リクエストアドレスの例
https://HOST:PORT/api/v1/guest
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
概要
ビジター情報を変更します。
(すでに登録済みの他者の写真を利用して更新する場合、ビジター情報の変更や顔認証が正常に登録や正常に行われません。ご注意ください。)
リクエストアドレスの例
https://HOST:PORT/api/v1/guest/update/{id}
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
概要
ビジターを削除します。
リクエストアドレスの例
https://HOST:PORT/api/v1/guest/delete/{id}
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
SenseLink Cloudをご利用の場合、ご利用のプランによって登録人数の上限が異なります。詳しくはお客様のご契約内容をご確認ください。
概要
拒否リストを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v2/black
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
概要
既存の従業員またはビジターを選択して拒否リストに移動(登録者タイプを変更)します。
拒否リストに移動した後、登録者タイプが拒否リスト(type = 5) に変更されます。元の登録者グループと部署情報はクリアされますが、他の情報は保持されます。
リクエストアドレスの例
https://HOST:PORT/api/v2/black/move/in
リクエスト方法
POST application/json
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
概要
拒否リストを削除します。 拒否リストから外されると、登録者タイプは元の識別子に戻ります(タイプ 1 または 2)。他の情報は保持されます。 拒否リストの登録者自体を削除するには、「拒否リストの削除」の章を参照してください。
リクエストアドレスの例
https://HOST:PORT/api/v2/black/move/out
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
概要
拒否リストの情報を変更します。
リクエストアドレスの例
https://HOST:PORT/api/v2/black/update
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
group フィールド
エラーレスポンスのフィールド
概要
拒否リストを削除します。
リクエストアドレスの例
https://HOST:PORT/api/v2/black/delete/{id}
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
概要
従業員、ビジター、および拒否リストのすべての登録者の情報を取得します。特定のフィールドのフィルター検索が可能です。
リクエストアドレスの例
https://HOST:PORT/api/v1/user/list
リクエスト方法
GET
リクエストパラメーター
※SenseLink Cloudのみ有効で、SenseLink GE Enterpriseは未対応
通常のレスポンス
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
パラメーター名
型
必須
説明
avatarFile
file
No
認証用顔写真。4MB以下の写真を利用してください
force
int
No
強制追加するかどうか。デフォルトで0:強制ではない、1:強制
groups
list<long>
No
従業員グループのリスト。デフォルト値はタイプで定義します。渡さない場合、または空の場合は、どのグループにも追加しないことを示します
icNumber
string
No※
IC カード番号。空の string も指定可能。長さ制限は 20
jobNumber
string
No※
従業員番号。空の string も指定可能。長さ制限は 45
mobile
string
No※
携帯電話番号。空の string も指定可能。長さ制限は 20
name
string
Yes
従業員名
remark
string
No※
特記事項。空の string も指定可能。長さ制限は 255
departmentId
long
No
部署ID
areaCode
string
No
電話番号の国別コードおよび市外局番
birthday
string
No
誕生日(日付形式:2019-06-15)
entryTime
string
No
入社日(日付形式:2019-06-15)
string
No
メールアドレス。長さ制限は 45
position
string
No
役職。長さ制限は 45
location
string
No
勤務地。長さ制限は 45
idNumber
string
No
ID 番号。長さ制限は 6~30(利用できません)
gender
int
No
性別。1 : 女性、2 : 男性
prompt
string
No
顔認証時に表示するカスタムメッセージ
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
id
long
従業員ID
name
string
従業員名
avatar
string
認証用顔写真
mobile
string
携帯電話番号
remark
string
特記事項
type
int
タイプ。1:従業員、2:ビジター
birthday
string
誕生日
string
メールアドレス
position
string
役職
location
string
勤務地
groupList
list<group>
従業員グループ情報
gender
string
性別
ic_number
string
IC カード番号
id_number
string
IDカード番号(利用できません)
job_number
string
従業員番号
company_id
long
企業ID
create_at
string
登録時間
update_at
string
更新時間
department_id
long
部署ID
area_code
string
携帯電話番号の国別コードおよび市外局番
entry_time
string
入社日
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
code
メッセージ
説明
610
Similar User Exist
類似する従業員がすでに存在します
709
The maximum number of persons in the tenant has been reached.
ご利用のプランの登録人数上限に達しました。
30001
Param Invalid
無効なパラメーターです。登録者名の長さが無効です
30001
Param Invalid
無効なパラメーターです。登録者名が空です。
30001
Param Invalid
無効なパラメーターです。登録者IC 番号の長さが無効です
30001
Param Invalid
無効なパラメーターです。登録者番号の長さが無効です
30001
Param Invalid
無効なパラメーターです。登録者の携帯電話番号の長さが無効です
30001
Param Invalid
無効なパラメーターです。特記事項の長さが無効です
30001
Param Invalid
無効なパラメーターです。登録者の認証用顔写真の形式が無効です
30001
Param Invalid
無効なパラメーターです。登録者グループのID が存在しません
30001
Param Invalid
無効なパラメーターです。登録者のICカード番号がすでに存在します
30001
Param Invalid
無効なパラメーターです。登録者のIDカード番号がすでに存在します
30001
Param Invalid
無効なパラメーターです。登録者の携帯電話番号がすでに存在します
30001
Param Invalid
無効なパラメーターです。従業員の認証用顔写真のファイルが大きすぎます
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。顔が検知されていません
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。複数の顔が検知されました
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。顔の検知に失敗しました
パラメーター名
型
必須
説明
id
int
Yes
変更する従業員ID の情報。タイプは path で、URL に記述されます
avatarFile
file
No
従業員の認証用顔写真
force
int
No
強制追加するかどうか。デフォルトで0:強制ではない、1:強制
groups
list<group>
No
従業員グループリスト。空のリストが渡される場合、従業員はどのグループにも属さないことを示します。情報が渡されない場合、変更は行われません。従業員はリスト内の有効なグループ(グループID が存在し、企業に属しており、かつグループタイプが従業員)にのみ追加されます。
icNumber
string
No
IC カード番号。長さ制限は 20
idNumber
string
No
ID 番号。長さ制限は 6~30(利用できません)
jobNumber
string
No
従業員番号。長さ制限は 45
mobile
string
No
携帯電話番号。空の string を指定できます
name
string
No※
名前。空の string は指定できません
remark
string
No
特記事項。空の string も指定可能。長さ制限は 255
gender
int
No
性別。1:女性、2:男性
departmentId
int
No
部署ID
areaCode
string
No
国別コードおよび市外局番
birthday
string
No
誕生日
entryTime
string
No
入社日
string
No
メールアドレス。長さ制限は 45
position
string
No
役職。長さ制限は 45
location
string
No
勤務地。長さ制限は 45
prompt
string
No
カスタマイズされたウェルカムプロンプト
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
パラメーター名
型
説明
id
long
従業員ID
name
string
従業員名
avatar
string
従業員の認証用顔写真
mobile
string
携帯電話番号
remark
string
特記事項
type
int
タイプ。1:従業員、2:ビジター
birthday
string
誕生日
string
メールアドレス
position
string
役職
location
string
勤務地
groupList
list<group>
従業員グループ情報
gender
string
性別
prompt
string
顔認証時に表示するカスタムメッセージ
ic_number
string
IC カード番号
id_number
string
IDカード番号(利用できません)
job_number
string
従業員ID
company_id
long
企業ID
create_at
string
作成時間
update_at
string
更新時間
department_id
long
部署ID
area_code
string
携帯電話番号の国別コードおよび市外局番
entry_time
string
入社日
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
code
メッセージ
説明
610
Similar User Exist
類似する従業員がすでに存在します
30001
Param Invalid
無効なパラメーターです
50001
RPC FAILED
RPCに失敗しました(顔の検知に失敗したなど)
50002
Internal Server Error
内部エラーです。従業員をグループに連携できませんでした
パラメーター名
型
必須
説明
id
long
Yes
従業員のID。タイプは path で、URL に記述されます
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
code
メッセージ
説明
30001
Param Invalid
無効なパラメーターです
パラメーター名
型
必須
説明
date
string
Yes
指定された日付
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
employee_id
string
従業員ID
image_URL
string
従業員アバターのリンク
remark
int
従業員アバターの新規または更新の識別子。0:新規追加、1:更新
code
メッセージ
説明
30001
Param Invalid
無効なパラメーターです
パラメーター名
型
必須
説明
name
string
Yes
ビジター名。長さ制限は 45
avatarFile
file
Yes
認証用顔写真
mobile
string
Yes
携帯電話番号。長さ制限は20。空の値で登録しないでください
remark
string
Yes
特記事項。空の string も指定可能。長さ制限は 255
groups
list<long>
Yes
ビジターグループのリスト。デフォルト値はタイプで定義します。渡さない場合、または空の場合は、どのグループにも追加しないことを示します
force
int
No
強制追加するかどうか。デフォルトで0:強制ではない、1:強制
idNumber
string
No
ID 番号。長さ制限は 6~30(利用できません)
receptionUserId
long
Yes
受付担当者 ID
dateTimeFrom
datetime
Yes
来訪時間(開始)。例 : 2018-07-20 12:30:45
dateTimeTo
datetime
Yes
来訪時間(終了)。例 : 2019-07-20 12:30:45
gender
int
No
性別。1:女性、2:男性
guestCompany
string
No
ビジターの企業。長さ制限は 45
position
string
No
役職。長さ制限は 45
guestPurpose
string
No
ビジターの来訪目的。長さ制限は 45
string
No
メールアドレス。長さ制限は 45
icNumber
string
No
IC カード番号。長さ制限は 20
birthday
string
No
誕生日
level
string
No
ビジターのレベル。長さ制限は 20
prompt
string
No
カスタマイズプロンプト。長さ制限は 45
areaCode
string
No
携帯電話番号の国別コードおよび市外局番
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
id
long
ビジターID
name
string
ビジター名
avatar
string
ビジターの認証用顔写真
mobile
string
電話番号
remark
string
特記事項
groups
list<group>
ビジターのグループ情報
ic_number
string
IC カード番号
id_number
string
IDカード番号(利用できません)
company_id
long
企業ID
create_at
string
作成時間
update_at
string
更新時間
reception_user_id
long
受付担当者ID
reception_user_name
string
受付担当者名
date_time_from
string
来訪時間(開始)
date_time_to
string
来訪時間(終了)
areaCode
string
電場番号の国別コードおよび市外局番。例 : 86
guestCompany
string
ビジターの企業名
position
string
役職
guestPurpose
string
ビジターの来訪目的
level
string
ビジターのレベル
string
ビジターのメールアドレス
birthday
string
ビジターの誕生日。例 : 2019-06-17
prompt
string
カスタマイズプロンプト
gender
int
ビジターの性別。1:女性、2:男性
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
code
メッセージ
説明
610
Similar User Exist
類似する従業員がすでに存在します
709
The maximum number of persons in the tenant has been reached.
ご利用のプランの登録人数上限に達しました。
30001
Param Invalid
無効なパラメーターです。ビジター名の長さが無効です
30001
Param Invalid
無効なパラメーターです。ビジター名が空です
30001
Param Invalid
無効なパラメーターです。ビジターのID 番号の長さが無効です
30001
Param Invalid
無効なパラメーターです。ビジターの携帯電話番号は空にはできません
30001
Param Invalid
無効なパラメーターです。ビジターの携帯電話番号の長さが空です
30001
Param Invalid
無効なパラメーターです。ビジターのコメントは空にはできません
30001
Param Invalid
無効なパラメーターです。ビジターのコメントの長さが無効です
30001
Param Invalid
無効なパラメーターです。ビジターの応対者は空にはできません
30001
Param Invalid
無効なパラメーターです。来訪時間(開始)の形式が無効です
30001
Param Invalid
無効なパラメーターです。来訪時間(終了)の形式が無効です
30001
Param Invalid
無効なパラメーターです。終了時間の形式が無効です
30001
Param Invalid
無効なパラメーターです。ビジターの認証用顔写真の形式が無効です
30001
Param Invalid
無効なパラメーターです。ビジターのグループID が存在しません
30001
Param Invalid
無効なパラメーターです。ビジターの認証用顔写真ファイルが大きすぎます
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。顔が検知されていません
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。複数の顔が検知されました
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。顔の検知に失敗しました
パラメーター名
型
必須
説明
id
long
Yes
ビジターID
name
string
Yes
ビジター名。長さ制限は 45
avatarFile
file
No
ビジターの認証用顔写真
mobile
string
No
携帯電話番号。長さ制限は 20
remark
string
No
特記事項。空の string も指定可能。長さ制限は 255
groups
list<long>
Yes
ビジターグループのリスト。デフォルト値はタイプで定義します。渡さない場合、または空の場合は、どのグループにも追加しないことを示します
force
int
No
強制追加するかどうか。デフォルトで0:強制ではない、1:強制
idNumber
string
No
ID 番号。長さ制限は 6~30(利用できません)
receptionUserId
long
Yes
受付担当者ID
dateTimeFrom
datetime
Yes
来訪時間(開始)。例 : 2018-07-20 12:30:45
dateTimeTo
datetime
Yes
来訪時間(開始)。例 : 2019-07-20 12:30:45
areaCode
string
No
携帯電話番号の国別コードおよび市外局番。
guestCompany
string
No
ビジターの企業名。長さ制限は 45
position
string
No
役職。長さ制限は 45
guestPurpose
string
No
ビジターの来訪目的。長さ制限は 45
level
string
No
ビジターのレベル。長さ制限は 20
string
No
ビジターのメールアドレス。長さ制限は 45
birthday
string
No
ビジターの誕生日。例 : 2019-06-17
prompt
string
No
個別化されたプロンプト。長さ制限は 45
gender
int
No
ビジターの性別。1:女性、2:男性
icNumber
string
No
IC カード番号。長さ制限は 20
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
id
long
ビジターID
name
string
ビジター名
avatar
string
ビジターの認証用顔写真
mobile
string
電話番号
remark
string
特記事項
groups
list<group>
ビジターグループ情報
position
string
役職
level
string
ビジターのレベル
string
メールアドレス
birthday
string
誕生日
prompt
string
カスタマイズプロンプト
gender
int
ビジターの性別。1:女性、2:男性
ic_number
string
IC カード番号
id_number
string
IDカード番号(利用できません)
company_id
long
企業ID
create_at
string
作成時間
update_at
string
更新時間
reception_user_id
long
受付担当者ID
reception_user_name
string
受付担当者名
group_count
int
ビジターグループ数
date_time_from
string
来訪時間(開始)
date_time_to
string
来訪時間(終了)
date_time
string
来訪時間。
area_code
string
携帯電話番号の国別コードおよび市外局番です。例 :86
guest_company
string
ビジターの企業
guest_purpose
string
ビジターの来訪目的
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
long
グループタイプ
code
メッセージ
説明
610
Similar User Exist
類似する従業員がすでに存在します
30001
Param Invalid
ビジターが存在しません
30001
Param Invalid
ビジターが企業に属していません
30001
Param Invalid
無効なパラメーターです。ビジター名の長さが無効です
30001
Param Invalid
無効なパラメーターです。ビジター名が空です
30001
Param Invalid
無効なパラメーターです。ビジターのID 番号の長さが無効です
30001
Param Invalid
無効なパラメーターです。ビジターの携帯電話番号は空にはできません
30001
Param Invalid
無効なパラメーターです。ビジターの携帯電話番号の長さが空です
30001
Param Invalid
無効なパラメーターです。ビジターのコメントは空にはできません
30001
Param Invalid
無効なパラメーターです。ビジターのコメントの長さが無効です
30001
Param Invalid
無効なパラメーターです。ビジターの応対者は空にはできません
30001
Param Invalid
無効なパラメーターです。来訪時間(開始)の形式が無効です
30001
Param Invalid
無効なパラメーターです。来訪時間(開始)の形式が無効です
30001
Param Invalid
無効なパラメーターです。終了時間の形式が無効です
30001
Param Invalid
無効なパラメーターです。ビジターの認証用顔写真の形式が無効です
30001
Param Invalid
無効なパラメーターです。ビジターのグループID が存在しません
30001
Param Invalid
無効なパラメーターです。ビジターの認証用顔写真ファイルが大きすぎます
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。顔が検知されていません
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。複数の顔が検知されました
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。顔の検知に失敗しました
パラメーター名
型
必須
説明
id
long
Yes
ビジターID。タイプは path で、URL に記述されます
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
code
メッセージ
説明
30001
Param Invalid
ビジターが存在しません
30001
Param Invalid
ビジターが企業に属していません
50001
RPC FAILED
ビジターを削除するためのRPCに失敗しました
パラメーター名
型
必須
説明
avatarFile
file
No
認証用顔写真
name
string
Yes
名前。長さ制限は 45
force
int
No
強制追加するかどうか。デフォルトで0:強制ではない、1:強制
groups
list<long>
No
拒否リストグループのID リストです。渡さない場合、または空は、どのグループにも追加しないことを示します
areaCode
string
No
国別コードおよび市外局番。長さ制限は 8
mobile
string
No
携帯電話番号。長さ制限は 20
gender
int
No
性別。1:女性、2:男性
birthday
string
No
誕生日(日付形式 : 2019-06-15)
string
No
メールアドレス。長さ制限は 45
icNumber
string
No
IC カード番号。長さ制限は 20
idNumber
string
No
ID カード番号。長さ制限は 6~30(利用できません)
prompt
string
No
カスタマイズプロンプト。長さ制限は 255
remark
string
No
特記事項。長さ制限は 255
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
id
int
拒否リスト ID
name
string
拒否リスト名
avatar
string
認証用顔写真 ID
mobile
string
携帯電話番号
string
メールアドレス
birthday
string
誕生日
remark
string
追加情報
groups
list<group>
グループ情報
prompt
string
カスタマイズプロンプト
gender
int
性別。0:不明、1:女性、2:男性
avatar_show
string
表示用写真
ic_number
string
IC カード番号
id_number
string
ID カード番号
area_code
string
国別コードおよび市外局番です。数字のみを指定できます。何も入力されなかった場合のデフォルトは 86 です
last_type
int
型
create_at
string
作成時間
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
code
メッセージ
エラーの説明
709
The maximum number of persons in the tenant has been reached.
ご利用のプランの登録人数上限に達しました。
30001
Param Invalid
電話番号はシステム内に存在しています
30001
Param Invalid
ID カード番号はシステム内に存在しています
30001
Param Invalid
IC カード番号はシステム内に存在しています
30001
Param Invalid
従業員IDはシステム内に存在しています
30001
Param Invalid
グループID は企業に属していません
600
Sync Failed
認証用顔写真内で顔を検出できません
600
Sync Failed
認証用顔写真内で複数の顔が検出されました
600
Sync Failed
顔の数が最大数の制限を超えています
600
Sync Failed
認証用顔写真が小さすぎます
600
Sync Failed
検知スコアが低すぎます
600
Sync Failed
顔フレームのピクセルが少なすぎます
600
Sync Failed
ピッチ角が大きすぎます
600
Sync Failed
転向角が大きすぎます
600
Sync Failed
ロール角が大きすぎます
600
Sync Failed
対面距離が基準を満たしていません
600
Sync Failed
顔サイズ比が低すぎます (顔の長方形部分/画像領域)
600
Sync Failed
顔が遮られすぎています
600
Sync Failed
明るさが基準を満たしていません
600
Sync Failed
あいまいさが基準を満たしていません
600
Sync Failed
口が開き過ぎています
600
Sync Failed
欠けた顔が多すぎます
600
Sync Failed
RPCに失敗しました
610
Similar User Exist
類似する登録者がすでに存在します
700
Multi Request Error
一括処理に失敗しました
700
Multi Request Error
拒否リストとグループの連携に失敗しました
30001
Param Invalid
拒否リスト名は空にはできません
30001
Param Invalid
拒否リスト名が長すぎます
30001
Param Invalid
拒否リストの電話番号が無効です
30001
Param Invalid
拒否リストのメールアドレスが長すぎます
30001
Param Invalid
拒否リストのメールアドレスが無効です
30001
Param Invalid
拒否リストの誕生日の形式が無効です
30001
Param Invalid
拒否リストの電話番号が長すぎます
30001
Param Invalid
拒否リストのカスタマイズメッセージが長すぎます
30001
Param Invalid
拒否リストの特記事項が長すぎます
30001
Param Invalid
拒否リストのIC カード番号が長すぎます
30001
Param Invalid
拒否リストのID カード番号の長さが無効です
30001
Param Invalid
拒否リストの領域の長さが無効です
30001
Param Invalid
拒否リストの領域の形式が無効です
30001
Param Invalid
拒否リストの認証用顔写真ファイルが無効です
30001
Param Invalid
拒否リストの認証用顔写真ファイルが大きすぎます
パラメーター名
型
必須
説明
userId
long
Yes
従業員またはビジターのID
groupIds
list<long>
Yes
拒否リストのグループID リスト。空の場合は拒否リストグループには追加されません
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
code
メッセージ
エラーの説明
498
Param Invalid
拒否リストが存在しません
498
Param Invalid
無効な登録者タイプです(拒否リストに移動中で、従業員でもビジターでもありません)
30001
Param Invalid
グループが空になっています
700
Multi Request Error
拒否リストとグループの連携に失敗しました
700
Multi Request Error
拒否リストとグループの連携解除に失敗しました
パラメーター名
型
必須
説明
id
long
Yes
拒否リストのID
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
code
メッセージ
エラーの説明
30001
Param Invalid
登録者タイプが正しくありません。拒否リストの元の識別子が従業員またはビジターではないため、拒否リストから外すことができません
30001
Param Invalid
登録者タイプが正しくありません。拒否リストには元の識別子が無いため、拒否リストから外すことができません
パラメーター名
型
必須
説明
id
long
Yes
拒否リストのID
name
string
Yes
名前
force
int
No
強制追加するかどうか。デフォルトで0:強制ではない、1:強制
areaCode
string
No
国別コードおよび市外局番
avatarFile
file
No
認証用顔写真
birthday
string
No
誕生日(日付形式 : 2019-06-15)
gender
int
No
性別。1:女性、2:男性
groups
list
No
拒否リストグループのID リスト。渡さない場合、または空の場合は、どのグループにも追加しないことを示します
icNumber
string
No
IC カード番号。長さ制限は 20
idNumber
string
No
ID カード番号。長さ制限は 6~30(利用できません)
string
No
メールアドレス
mobile
string
No
携帯電話番号
prompt
string
No
カスタマイズプロンプト
remark
string
No
特記事項
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
id
int
拒否リスト ID
name
string
従業員名
avatar
string
認証用顔写真 ID
mobile
string
携帯電話番号
string
メールアドレス
birthday
string
誕生日
remark
string
追加情報
groups
list<group>
グループ情報
prompt
string
カスタマイズプロンプト
gender
int
性別。0:不明、1:女性、2:男性
avatar_show
string
表示用写真
ic_number
string
IC カード番号
id_number
string
ID カード番号
area_code
string
国別コードおよび市外局番。数字のみを指定できます。何も入力されなかった場合のデフォルトは 86
last_type
int
タイプ
create_at
string
作成時間
create_by
string
作成者
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
code
メッセージ
エラーの説明
30001
Param Invalid
拒否リストID が存在しません
30001
Param Invalid
電話番号はシステム内に存在しています
30001
Param Invalid
ID カード番号はシステム内に存在しています
30001
Param Invalid
IC カード番号はシステム内に存在しています
30001
Param Invalid
従業員IDはシステム内に存在しています
30001
Param Invalid
グループID は企業に属していません
600
Sync Failed
認証用顔写真内で顔を検出できません
600
Sync Failed
認証用顔写真内で複数の顔が検出されました
600
Sync Failed
顔の数が最大数の制限を超えています
600
Sync Failed
認証用顔写真が小さすぎます
600
Sync Failed
検知スコアが低すぎます
600
Sync Failed
顔フレームのピクセルが少なすぎます
600
Sync Failed
ピッチ角が大きすぎます
600
Sync Failed
転向角が大きすぎます
600
Sync Failed
ロール角が大きすぎます
600
Sync Failed
対面距離が基準を満たしていません
600
Sync Failed
顔サイズ比が低すぎます(顔の長方形の領域 / 画像領域)
600
Sync Failed
顔が遮られすぎています
600
Sync Failed
明るさが基準を満たしていません
600
Sync Failed
あいまいさが基準を満たしていません
600
Sync Failed
口が開き過ぎています
600
Sync Failed
欠けた顔が多すぎます
600
Sync Failed
RPCに失敗しました
610
Similar User Exist
類似する登録者がすでに存在します
700
Multi Request Error
一括処理に失敗しました
700
Multi Request Error
拒否リストとグループの連携に失敗しました
30001
Param Invalid
拒否リスト名は空にはできません
30001
Param Invalid
拒否リスト名が長すぎます
30001
Param Invalid
拒否リストの電話番号が無効です
30001
Param Invalid
拒否リストのメールアドレスが長すぎます
30001
Param Invalid
拒否リストのメールアドレスが無効です
30001
Param Invalid
拒否リストの誕生日の形式が無効です
30001
Param Invalid
拒否リストの電話番号が長すぎます
30001
Param Invalid
拒否リストのカスタマイズメッセージが長すぎます
30001
Param Invalid
拒否リストの特記事項が長すぎます
30001
Param Invalid
拒否リストのIC カード番号が長すぎます
30001
Param Invalid
拒否リストのID カード番号の長さが無効です
30001
Param Invalid
拒否リストの領域の長さが無効です
30001
Param Invalid
拒否リスト領域の形式が無効です
30001
Param Invalid
拒否リストの認証用顔写真ファイルが無効です
30001
Param Invalid
拒否リストの認証用顔写真ファイルが大きすぎます
パラメーター名
型
必須
説明
id
long
Yes
拒否リストのID
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
code
メッセージ
エラーの説明
30001
Param Invalid
拒否リストID が存在しません
600
Sync Failed
リモート削除に失敗しました
700
Multi Request Error
拒否リストとグループの連携解除に失敗しました
50001
RPC FAILED
削除に失敗しました
パラメーター名
型
必須
説明
type
int
No
登録者の識別子タイプ。1:従業員、2:ビジター、5:拒否リストです。情報が渡されなかった場合、すべてのリストが返されます
name
string
No
登録者名
jobNumber
string
No
従業員ID
mobile
string
No
携帯電話番号
string
No
メールアドレス
icNumber
string
No
IC カード番号
idNumber
string
No
ID カード番号(利用できません)
id
long
No
登録者ID
departmentId※
long
No
部署ID
groups※
array
No
グループのリスト
page
int
No
ページ番号(デフォルトは 1 )
size
int
No
1 ページあたりのデータの数(デフォルトは 20)。最大値は 100
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください。
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
id
long
登録者ID
type
int
識別子タイプ。1:従業員、2:ビジター、3:不明、4: 非生体、5:拒否リスト
last_type
int
元の識別子。拒否リストの登録者にのみ適用されます。1:従業員、2:ビジター
groupList
list<group>
グループ情報。インターフェースから返された登録者数が 1 人のみの場合、グループ情報が含まれます。複数の登録者が返された場合、グループ情報は含まれません
name
string
登録者名
avatar
string
登録者の認証用顔写真
mobile
string
携帯電話番号
ic_number
string
IC カード番号
id_number
string
IDカード番号(利用できません)
job_number
string
従業員ID
birthday
string
誕生日
string
メールアドレス
gender
string
性別。1:女性、2:男性
prompt
string
顔認証時に表示するカスタムメッセージ
remark
string
特記事項
position
string
役職
location
string
場所
company_id
long
企業ID
department_id
long
部署ID
area_code
string
携帯電話番号の国別コードおよび市外局番
entry_time
string
入社日
receptionUserId
long
ビジター応対者の登録者ID
dateTimeFrom
datetime
来訪開始時間(秒単位)。例:2018-07-20 12:30:45
dateTimeTo
datetime
来訪終了時間(秒単位)。例:2018-07-20 12:30:45
guest_company
string
ビジターの企業
guest_purpose
string
ビジターの来訪目的
guest_level
string
ビジターのレベル
create_at
string
作成時間
update_at
string
更新時間
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
code
メッセージ
エラーの説明
30001
Param Invalid
無効なパラメーターです