Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
APIの利用方法について記載されています。
本マニュアルはIT部門に所属するお客様、HTTP/HTTPSベース、JSON形式のWeb APIを利用したアプリケーションの開発・運用経験があるお客様を対象にしています。
概要
デバイスアラートのリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v2/device/alarm/list
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
オンラインデバイスにアラート解除コマンドを送信します。
リクエストアドレスの例
https://HOST:PORT/api/v2/device/alarm/disarm
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
パラメーター名
型
必須
説明
dateFrom
string
No
yyyy-MM-dd 形式の開始時間
dateTo
string
No
yyyy-MM-dd 形式の終了時間
deviceId
long
No
デバイスのID
code
int
No
アラートのタイプ。10001:デバイスの盗難アラート、10002 :ドア・ゲート強制突破アラート、10003:ドアセンサータイムアウト、10004:パスワードクラッキング、10005 :(サポートされないアラートです。現在利用できません)、10006:サーモカメラ接続異常、20001:カメラの汚れ、20002:Non-Living アタック(非生体による認証)、20003:消防アラート、30001:デバイスオフラインアラート、40001:特徴量抽出エラー
status
int
No
アラートのステータス。0:すべて、1:アラート作動中、2:解除中、3:解除済み
page
int
No
ページ番号(デフォルトは 1)
size
int
No
ページサイズ(デフォルトは 20、最大 1000)
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1シグネチャ(sign)の計算の章を参照してください。
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
total
int
総計
size
int
サイズ
data
object
データ
page_num
int
現在のページ番号
page_size
int
ページサイズ
total_page
int
ページ合計
パラメーター名
型
説明
id
long
アラートレコードのID
level
int
アラートのレベル。1 は通常のアラートを示し、2 は異常を示します
code
int
アラートのタイプ。10001:デバイスの盗難アラート、10002:ドア・ゲート強制突破アラート、10003:ドアセンサータイムアウト、10004:パスワードクラッキング、10005:(サポートされないアラートです。現在利用できません)、10006:サーモカメラ接続異常、20001:カメラの汚れ、20002:Non-Living アタック(非生体による認証)、20003:消防アラート、30001:デバイスオフラインアラート、40001:特徴量抽出エラー
description
string
アラートの説明
status
int
アラートのステータス。0:解除する必要がありません、1:アラート作動中、2:解除中、3:解除済み
traceId
string
デバイスが生成するアラートのシリアル番号であり、アラートの固有の識別番号です。
deviceId
long
デバイスID
deviceName
string
デバイス名
deviceSn
string
デバイスの LDID 番号
deviceLocation
string
デバイスの設置場所
alarmTime
string
アラート時間
alarmTimeL
long
アラートのタイムスタンプ(ミリ秒単位)
releaseTime
string
アラートのリリース時間
alarmPhoto
string
アラート写真
resolveOption
int
アラートの解除オプション。0:解除不要、1:デバイスエンドでの解除のみをサポート、2:リモート解除のみをサポート、3:デバイスエンドまたはリモートでの解除
0:解除不要 : 10004:パスワードクラッキング、20002:Non-Living アタック(非生体による認証)、30001:デバイスオフラインアラート、40001:特徴量抽出エラー
1:デバイスエンドでの解除のみをサポート : 10003:ドアセンサータイムアウト、10005:(サポートされないアラートです。現在利用できません)、10006:サーモカメラ接続異常、20001:カメラの汚れ、
3:デバイスエンドまたはリモートでの解除、10001:デバイスの盗難アラート、10002:ドア・ゲート強制突破アラート、20003:消防アラート
userId
long
登録者ID 。コード内でパスされます。40001
userName
string
登録者名。コード内でパスされます。40001
userType
int
登録者のタイプ。1:従業員、2:ビジター、3:拒否リストコード内でパスされます。40001
code
メッセージ
説明
30001
Param Invalid
無効なパラメーターです
パラメーター名
型
必須
説明
traceId
string
Yes
アラートのシリアル番号
description
string
No
イベントの説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1シグネチャ(sign)の計算の章を参照してください。
timestamp
string
Yes
タイムスタンプ
code
メッセージ
エラーの説明
498
Param Invalid
リモートで解除できないアラートです(以下のアラートタイプのみ:10004:パスワードクラッキング、20002:Non-Living アタック(非生体による認証)、30001:デバイスオフラインアラート、40001:特徴量抽出エラー、10003:ドアセンサータイムアウト、10006:サーモカメラ接続異常、20001:カメラの汚れ)
620
Record non-existent Error
アラートは解除されています
620
Record non-existent Error
アラートのシリアル番号が存在しません
30001
Param Invalid
イベント説明が長すぎます
50001
RPC FAILED
リモートサービスの呼び出しに失敗しました
各APIの利用方法の詳細について記載されています。
当製品の概要と利用方法について記載されています。
本ドキュメントは、主に開発者の方々に利用いただくSenseLink GE Enterprise、SenseLink GE Enterprise Pro、SenseLink CloudのAPIマニュアルです 。
SenseLink GE Open Platformは、SenseLink に基づくオープンサービスプラットフォームです。 サードパーティのシステムはSenseLinkからデバイス、登録者、レコードなどの情報を取得し、SenseLinkが持つ管理機能をすばやく統合できます。
SenseLink GE Enterprise/Enterprise ProにあるOpenAPIはドメイン名またはIPアクセスを制限せず、サーバーにアクセス可能なリクエストの全ては合法であると見なされます。
SenseLinkにログインし、ナビゲーションメニューの[システム管理] → [Open Platform] を選択してください。AppキーとAppシークレットを管理するOpen Platform画面が表示されます。
Open Platform画面の[App Keyを作る]ボタンをクリックしてください。確認のためにパスワードを入力する必要があります。表示される入力画面に現在ログイン中のアカウントのパスワードを入力して、確認ボタンをクリックしてください。
「AppキーとAppシークレットを作成しました。ダウンロードされたCSV内にAppキーとAppシークレットの情報が含まれます。安全に管理してください。」というメッセージが表示され、ご利用中のPCにAppキーとAppシークレットが記載されたCSVファイルがダウンロードされます。ダウンロードされたCSVファイルを開くと、AppキーとAppシークレットを確認することができます。 なお、入力したパスワードが誤っている場合、AppキーとAppシークレットは作成されず、CSVファイルもダウンロードされません。
またWeb画面上の一覧から、作成したAppキーとAppシークレットを確認することができます。Appシークレットはデフォルトで非表示になっています。表示ボタンをクリックすると、パスワード入力を求められます。現在ログイン中のアカウントのパスワードを入力すると、Appシークレットが表示されます。
登録したドメインからのみAPIを利用することができます。APIキーの作成後、Open Platform画面の[ドメインを追加]ボタンがアクティブになります。[ドメインを追加]ボタンをクリックし、必要なドメインを入力し、適用ボタンをクリックしてください。登録したドメインからAPIを利用できます。
Appキーは5つまで作成および利用いただくことができ、また無効化および削除することもできます。Appキーを一覧の設定ボタンを利用して適宜管理してください。 無効化中はAppキーとAppシークレットが利用できませんが、有効化するともう一度同じAppキーとAppシークレットを利用することができます。一度削除するとAppキーとAppシークレットを復元することはできませんので、ご注意ください。
計算方法は、
により計算されます。タイムスタンプおよびAppシークレットを利用してください。
例:
timestamp:Unix 時間 (ミリ秒を含む13桁)
sign、timestamp、および Appキー(app_key)の 3 つのパラメーターを、オプションパラメーターと共に次のようにリクエストしてください。
http://host:port/api/v1/device?typeId=10&size=100&sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng×tamp=1477881215000
TypeId および size はオプションパラメーターです。サーバーは現在の timestamp をクライアント側からのリクエスト内の timestamp と比較し、その差が30 分以上の場合はエラーを返します。
sign、timestamp、およびAppキー(app_key) の 3 つのパラメーターを、次のようにリクエストしてください。
http://host:port/api/v3/device/update?sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng×tamp=1477881215000
オプションパラメーターはリクエスト本体に配置され、form-data またはインターフェースドキュメントで指定された application/json に従って呼び出され、リクエストがサーバーへ送信されます。サーバーは現在の timestamp をクライアント側からのリクエスト内の timestamp と比較し、その差が30 分以上の場合はエラーを返します。
一部のインターフェースでは id をリクエストに配置する必要があります。詳細については、APIの利用方法をご参照ください。
概要
現在のシステムのバージョン番号を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/server/version
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
概要
企業情報を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v1/company
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
開発中のため当APIは現在利用できません
概要
ゲートウェイデバイスを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v3/gateway/add
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
開発中のため当APIは現在利用できません。
概要
カメラを追加します。事前にゲートウェイデバイスを追加する必要があります。
リクエストアドレスの例
https://HOST:PORT/api/v3/camera/add
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
デバイス情報を更新します(ゲートウェイデバイスはグループに連携できません) 。
v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v3/device/update
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
group フィールドの説明
エラーレスポンスのフィールド
概要
デバイス(ゲートウェイまたはカメラデバイス)を削除します。
v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v3/device/delete
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
開発中のため、当APIは現在利用できません
概要
カメラのリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/gateway/cameraList
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
開発中のため、当APIは現在利用できません。
概要
関連する親デバイスを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/camera/gatewayList
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
cameraフィールドの説明
エラーレスポンスのフィールド
概要
デバイスリストを表示します。デフォルトの順序は ID の降順です。
リクエストアドレスの例
https://HOST:PORT/api/v1/device
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
data.dataフィールドの説明
device_type フィールドの説明
device フィールドの説明
group フィールドの説明
エラーレスポンスのフィールド
概要
同じタイプのオンラインデバイスに対してリモート構成コマンドを送信します。一括送信に対応しています。
現在、下記のデバイスをサポートしています。SensePass、SenseThunder GE、SenseThunder Mini GE。
この機能をサポートするデバイスの最低バージョンは、SensePass(v1.2.3)、SenseThunder GE (v1.0.3)、SenseThunder Mini GE (v1.0.1)。
リクエストアドレスの例
https://HOST:PORT/api/v2/device/update/config/batch
リクエスト方法
POST application/json
リクエストパラメーター
デバイス型番識別子
構成項目とパラメーターの説明
リクエスト例
通常のレスポンス
エラーレスポンスのフィールド
概要
オンラインデバイスにドアオープンコマンドを送信します。
リクエストアドレスの例
https://HOST:PORT/api/v2/device/open
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
開発中のため当APIは現在利用できません
概要
オンラインデバイスに通知メッセージを送信します。カスタマイズコマンドに対応しています。
リクエストアドレスの例
https://HOST:PORT/api/v3/device/notify
リクエスト方法
POST application/json
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
リクエスト例
概要
デバイスのシリアル番号でデバイスのLDIDを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/device/ldid
リクエスト方法
GET
リクエストパラメーター
デバイス型番識別子
レスポンスのフィールド
通常のレスポンス
概要
グループを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v1/group
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
登録者グループのリストを表示します。デフォルトの順序はID の降順です。
リクエストアドレスの例
https://HOST:PORT/api/v1/group
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
data.dataフィールドの説明
エラーレスポンスのフィールド
概要
グループ ID に基づいてグループ内のすべての登録者のID のリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v1/group/user
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
登録者グループを更新します。
v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v3/group/update
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
device フィールドの説明
エラーレスポンスのフィールド
概要
グループを削除します。
リクエストアドレスの例
http://HOST:PORT/api/v1/group/delete/{id}
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
登録者を一括でグループに追加します。
リクエストアドレスの例
http://HOST:PORT/api/v1/user/add/group
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスフィールドの説明
エラーレスポンスのフィールド
概要
グループから一括で登録者を削除します。
リクエストアドレスの例
http://HOST:PORT/api/v1/user/remove/group
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
日付
改訂内容
2020/06/12
初版
2020/06/26
2.11節 イベントサブスクリプションAPI に補足や注意点を追記
2020/07/04
2.2.8項 ThunderMiniの設定項目を追加、デバイス側の設定項目に合わせてThunder及びThunderMiniの設定項目を追加
2.4.13項 pageとsizeフィールドを追加
2.11.10項 補足を追加
2020/07/13
2.2.8項 設定項目の名称とコメントを訂正
2020/07/29
SenseLink SaaSの製品名をSenseLink Cloudに変更
SenseLink GE Enterprise、SenseLink GE Enterprise ProでのAppキーの管理方法を修正
2020/08/20
2.7.6項 passRuleフィールドの説明を修正
2020/10/08
2.4.13項 登録者の参照のパラメータを追加 2.8.1項 認証レコードの表示の新規バージョンを追加
2.11.7項 サブスクリプション更新の新規バージョンを追加
2.11.9項サブスクリプション詳細表示の新規バージョンを追加
一部デリケートな文言を修正
ブラックリスト→拒否リスト
ホワイトリスト→許可リスト
2020/10/12
2.4.1項 登録者の追加のパラメータの記載を修正
2.4.13項 モデル別の登録者の参照のパラメータの記載を修正
2020/10/16
2.9 節 認証用顔写真の記載を修正
2.4.9項 バージョン号の修正
2020/11/18
2.4.1項 登録者のエラーレスポンスの記載を修正
2020/11/25
2.3節 デバイスアラートの記載を修正
2020/12/03
2.3.1項 デバイスアラートの取得のステータス説明項目を修正
2.4.9項 拒否リストへの移動のエラーレスポンスの記載を修正
2.10.5項 部署更新のエラーレスポンスの記載を修正
2020/12/14
2.11.4項 イベントの再Pushの記載を修正
2020/12/24
2.2.7項 デバイスリストのレスポンスコードを修正
2.4節 各人員タイプ追加・更新時の ・ICとID番号の説明を修正 ・類似する登録者が存在する場合のレスポンスコードを修正
・強制追加フラグを追加
・グループの説明を修正
2.8.1項 認証レコードの表示の新規バージョンを追加
コード
メッセージ
原因
10001
App Key Not Exist
キーがありません
10002
App Expired
キーが期限切れです
10003
Request Expired
リクエストが期限切れです
10004
IP Invalid
IPアドレスが許可リストにありません
10005
Signature Failed
無効なシグネチャ(sign)です
20001
Company Out Of Date
企業の利用期間の期限が切れました
20002
Permission Denied
権限がありません
30001
Param Invalid
無効なパラメーターです
30002
Similar User Exist
追加された登録者は既存の登録者と非常に類似しています
30003
No Face Detected In The Image
写真内で顔を検出できません
30004
Missing Param
パラメーターが不足しています
30005
Avatar File Invalid
不正な写真形式です
50001
RPC Failed
サーバー同期エラー
50002
Internal Server Error
内部サーバーエラー
50003
Multi Request Error
一括リクエストエラー
50004
Request Method Not Allowed
不正なリクエストメソッドです
60005
Request_rate_too_high
リクエスト頻度が高すぎます
60006
Daily_quota_exceeded
1 日あたりのリクエスト上限に達しました
99999
Unknown Error
不明なエラーです
620
Record non-existent Error
不正なパラメーターです。対応するレコードが見つかりません
610
Similar record Exist
類似するレコードが存在します(同じ名前の部署が同じレベルに存在するなど)
650
Cannot delete unless include nothing
部署または従業員が配下にあるため削除できません
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1シグネチャ(sign)の計算の章を参照してください
timestamp
string
必須
タイムスタンプ
パラメーター名
型
説明
edition
string
バージョン番号
date
string
バージョンのリリース日
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の章を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
パラメーター名
型
説明
id
int
企業ID
name
string
企業名
logo
string
ロゴ ID
background
string
背景 ID
welcome
string
Welcomeメッセージ
introduction
string
企業プロフィール
threshold
float
顔認証の閾値
language
string
利用中の言語
serviceConfig
string
サービス構成
createBy
int
作成者 ID
contact
string
担当者
createAt
string
作成時間
updateAt
string
更新時間
validFrom
string
ライセンス有効開始時間
validTo
string
ライセンス有効終了時間
コード
メッセージ
説明
30001
Param Invalid
無効なパラメーターです
パラメーター名 | 型 | 必須 | 説明 |
identifier | string | Yes | SNB など、デバイスタイプの識別子 |
name | string | Yes | デバイス名 |
location | string | 必須 | デバイスの設置場所 |
ip | string | Yes | ゲートウェイ IP |
port | int | Yes | ゲートウェイポート |
account | string | Yes | ゲートウェイのログインアカウント |
password | string | Yes | ゲートウェイのログインパスワード |
パラメーター名 | 型 | Yes | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1シグネチャ(sign)の計算の章を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
data | object | データ |
パラメーター名 | 型 | 説明 |
id | long | デバイスの ID |
name | string | 名前 |
location | string | 設置場所 |
description | string | デバイスの説明 |
direction | int | デバイスのアクセス方向 |
ldid | string | デバイスの LDID 番号 |
type_id | int | デバイスタイプID(4:SensePass、19:SenseThunder-Mini、20:SenseThunder-E) |
type_name | string | デバイスタイプ名 |
update_at | long | 更新時間 |
create_at | long | 作成時間 |
コード | メッセージ | 説明 |
30001 | Param Invalid | パラメーターエラー |
パラメーター名 | 型 | Yes | 説明 |
channel | int | Yes | チャンネル |
identifier | string | Yes | CAM など、デバイスタイプの識別子 |
gateway_id | string | Yes | ゲートウェイID |
protocol | int | Yes | プロトコルタイプ。1 = RTSP、2 = ONVIF、3 = GB28181 を示します |
camera_name | string | Yes | カメラ名 |
location | string | Yes | カメラの設置場所 |
snap_mode | int | Yes | スナップモード。1 = 精密、2 = 時間制、3 = リアルタイムを示します |
url | string | 条件による | RTSP モードはパスする必要があります |
ip | string | 条件による | カメラ ip、ONVIF GB28181 モードはパスする必要があります |
port | int | 条件による | カメラポート、ONVIF GB28181 モードはパスする必要があります |
account | string | 条件による | カメラのログインアカウント、ONVIF モードはパスする必要があります |
password | string | 条件による | カメラのログインパスワード、ONVIF モードはパスする必要があります |
server_id | string | 条件による | SIP サーバーの SIP ID、GB28181 モードはパスする必要があります |
camera_id | string | 条件による | カメラの SIP ID、GB28181 モードはパスする必要があります |
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1シグネチャ(sign)の計算の章を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
desc | string | リターンの説明 |
data | object | データ |
パラメーター名 | 型 | 説明 |
id | long | デバイスのID |
name | string | 名前 |
location | string | 設置場所 |
description | string | 説明 |
direction | int | デバイスのアクセス方向 |
ldid | string | デバイスの LDID 番号 |
type_id | int | デバイスタイプID(4:SensePass、19:SenseThunder-Mini、20:SenseThunder-E) |
type_name | string | デバイスタイプ名 |
update_at | long | 更新時間 |
create_at | long | 作成時間 |
コード | メッセージ | 説明 |
30001 | Param Invalid | パラメーターエラー |
パラメーター名 | 型 | 必須 | 説明 |
id | long | Yes | デバイスのID |
name | string | No | 名前 |
location | string | No | 設置場所 |
description | string | No | 説明 |
direction | int | No | デバイスのアクセス方向。1 = In、2 = Out |
group_staff | list<long> | No | 従業員グループ(id のグループ) |
group_visitor | list<long> | No | ビジターグループ(id のグループ) |
group_blacklist | list<long> | No | 拒否リストグループ (id のグループ) |
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1シグネチャ(sign)の計算の章を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
desc | string | リターンの説明 |
data | object | データ |
パラメーター名 | 型 | 説明 |
id | int | デバイスの ID |
name | string | デバイス名 |
location | string | デバイスの設置場所 |
state | string | デバイスのステータス |
description | string | 説明 |
direction | int | デバイスのアクセス方向。0 - デフォルト(Null)、1 - In、2 - Out |
ip | string | IP アドレス |
ldid | string | デバイスの sn 番号 |
type_id | int | デバイスタイプ |
type_name | string | デバイスタイプ名 |
user_group | list<group> | 従業員グループ |
guest_group | list<group> | ビジターグループ |
blacklist_group | list<group> | 拒否リストグループ |
update_at | long | デバイスの最新の更新タイムスタンプ |
create_at | long | デバイスの最初のオンラインタイムスタンプ |
last_offline_time | long | デバイスの最新のオフラインタイムスタンプ |
パラメーター名 | 型 | 説明 |
id | long | グループ ID |
name | string | グループ名 |
type | int | グループタイプ |
is_default | int | デフォルトのグループかどうかを示します |
person_count | int | グループ内の人数を示します |
コード | メッセージ | 説明 |
30001 | Param Invalid | パラメーターエラー |
パラメーター名 | 型 | 必須 | 説明 |
id | long | Yes | デバイスのID |
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の章を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
desc | string | リターンの説明 |
data | object | データ |
code | メッセージ | 説明 |
30001 | Param Invalid | パラメーターエラー |
600 | Sync Failed | RPC が失敗しました |
パラメーター名 | 型 | 必須 | 説明 |
gateway_id | long | Yes | ゲートウェイデバイスのID |
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の章を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
desc | string | リターンの説明 |
data | object | データ |
パラメーター名 | 型 | 説明 |
id | long | カメラデバイスのID |
sn | string | Nebula デバイスの sn 番号 |
channel | string | チャンネル番号 |
position | string | 設置場所 |
url | string | Nebula デバイスの IP アドレス |
camera_sn | string | カメラの sn 番号 |
camera_name | string | カメラ名 |
state | int | 1 = オンライン、2 = オフライン |
code | メッセージ | 説明 |
30001 | Param Invalid | パラメーターエラー |
パラメーター名 | 型 | 必須 | 説明 |
id | long | Yes | デバイスのID |
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の章を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
desc | string | リターンの説明 |
data | object | データ |
パラメーター名 | 型 | 説明 |
id | long | Nebula デバイスのID |
sn | string | Nebula デバイスの sn 番号 |
name | string | 名前 |
location | string | 設置場所 |
host | string | IP |
port | int | ポート番号 |
state | int | オンライン状態。 1 = オンライン、2 = オフライン |
cameras | list<camera> | カメラリスト |
パラメーター名 | 型 | 説明 |
id | long | カメラデバイスのID |
sn | string | Nebula デバイスの sn 番号 |
channel | string | チャンネル番号 |
position | string | カメラの設置場所 |
url | string | Nebula デバイスの IP アドレス |
camera_sn | string | カメラの sn 番号 |
camera_name | string | カメラ名 |
code | メッセージ | 説明 |
30001 | Param Invalid | パラメーターエラー |
パラメーター名 | 型 | 必須 | 説明 |
page | int | No | ページ番号(デフォルトは 1 ) |
size | int | No | 1 ページあたりのデータ数(デフォルトは 20 ) |
ids | list<long> | No | デバイスID の配列 |
typeId | int | No | デバイスタイプID(4:SensePass、19:SenseThunder-Mini、20:SenseThunder-E) |
location | string | No | デバイスの設置場所 |
name | string | No | デバイス名 |
description | string | No | デバイスの説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の章を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
data | object | データ |
パラメーター名 | 型 | 説明 |
total | int | 総計 |
size | int | サイズ |
data | object | データ |
pageNum | int | 現在のページ番号 |
pageSize | int | ページサイズ |
totalPage | int | ページ合計 |
パラメーター名 | 型 | 説明 |
device_type | object | デバイスタイプ |
device | object | デバイス情報 |
パラメーター名 | 型 | 説明 |
id | long | デバイスタイプID(4:SensePass、19:SenseThunder-Mini、20:SenseThunder-E) |
name | string | デバイスタイプ名 |
identifier | string | デバイスタイプの識別子(略称) |
description | string | デバイスタイプの説明 |
create_at | string | 作成時間 |
update_at | string | 更新時間 |
node_type | int | ノードのタイプ。0 = 共通のデバイス、1 = ゲートウェイデバイス |
パラメーター名 | 型 | 説明 |
id | long | デバイスのID |
sn | string | デバイスのシリアル番号 |
name | string | デバイス名 |
direction | string | デバイスの向き |
location | string | デバイスの設置場所 |
ip | string | デバイスの IP |
status | int | デバイスのオンライン状態 |
groups | list<group> | デバイスが連携されたグループ |
active | int | 偽削除フラグ |
type_id | long | デバイスタイプID(4:SensePass、19:SenseThunder-Mini、20:SenseThunder-E) |
description | string | デバイスの説明 |
software_version | string | ソフトウェアのバージョン番号(使用できません) |
info | string | デバイス情報(使用できません) |
company_id | long | 企業ID |
group_count | int | デバイスに連携されているグループの数 |
create_at | string | 作成時間 |
update_at | string | 更新時間 |
last_offline_time | long | 最後のオフラインタイムスタンプ |
パラメーター名 | 型 | 説明 |
id | long | グループID |
name | string | グループ名 |
type | int | グループタイプ |
code | メッセージ | 説明 |
30001 | Param Invalid | 無効なデバイスの sn 番号 |
30001 | Param Invalid | 無効なデバイスのステータス |
パラメーター名 | 型 | 必須 | 説明 |
device_ids | list<long> | Yes | ID リスト。デバイスID のタイプは同じである必要があります |
key | json | Yes | デバイス識別子、詳細については次のデバイス型番識別子をご参照ください |
app_key | string | Yes | Appキー。 URL に記述されます |
sign | string | Yes | シグネチャ。URL に記述されます |
timestamp | string | Yes | タイムスタンプです。URL に記述されます |
デバイス名称 | デバイス型番識別子 |
SensePass | SPS |
SenseThunder-E | SPSPE |
SenseThunder-E Mini | SPSE |
構成項目 | 型 | 値の範囲 / オプション | Pass | Thunder | Thunder Mini |
実行ステータス device_run_type | int |
| ✓ | ✓ | ✓ |
利用モード use_mode | int | デバイスによって異なります | ✓ (1 :ゲートモード、2:ドアモード) | ✓ (1:一人モード、2 :複数人モード) | ✓ (1:ゲートモード、2:ドアモード) |
認証モード mode | int |
serverFRの場合、[9:顔認証]のみ利用可能 | ✓ | ✓ | ✓ |
音声ブロードキャスト voice_broadcast | bool |
| × | ✓ | × |
プロンプト strong_hint | bool |
| × | ✓ | × |
温度検知 temperature_detect | bool |
| × | ✓ | ✓ |
温度アラームしきい値 fever_temperature | float | [34.5、42.5]、小数点以下 1 桁です。37.5を推奨 | × | ✓ | ✓ |
温度異常時にアクセス拒否 no_access_to_fevers | bool |
| × | ✓ | ✓ |
サーモグラフィ表示 show_thermal_screen | bool |
| × | ✓ | ✓ |
屋内温度 indoor_temperature | float | [5.0、40.0]、小数点以下 1桁です | × | ✓ | ✓ |
温度単位 temperature_unit | int |
| × | ✓ | ✓ |
温度検知距離 temperature_detect_distance | float | デバイスによって異なります | × | [1.0、1.5]. 小数点第1位まで、1.0を推奨 | [0.5、1.2]. 小数点第1位まで、1.2を推奨 |
温度異常ブザー temperature_warn_volume | int | デバイスによって異なります | × | [0、100] |
|
高速検知モード quick_detect_mode | bool |
| × | ✓ | ✓ |
温度正常時ドアオープン quick_detect_mode_open_door | bool |
| × | ✓ | ✓ |
マスク検知 mask_detect | bool |
| × | ✓ | ✓ |
マスク未着用アクセス不可 no_access_without_mask | bool |
| × | ✓ | ✓ |
マスク未着用ブザー mask_warn_volume | int | デバイスによって異なります | × | [0、100] |
|
ログ save_and_upload_record | bool |
| × | × | ✓ |
タッチして認証 touch_recognition | bool |
| × | ✓ | ✓ |
省ネットワーク通信 save_elec_mode | bool |
| × | ✓ | ✓ |
未登録者ログ need_stranger_record | bool |
| × | ✓ | ✓ |
顔写真 show_custom_avatar | bool |
| × | ✓ | ✓ |
デバイスのメインメッセージ welcome_tip | string | 長さ制限:50 | ✓ | ✓ | ✓ |
認証メッセージverify_success_tip | string | 長さ制限:50 | ✓ | ✓ | ✓ |
認証エラーメッセージverify_fault_tip | string | 長さ制限:50 | ✓ | ✓ | ✓ |
認証従業員情報show_user_info | string |
| ✓ | ✓ | ✓ |
認証成功後に写真を表示する use_show_avatar | bool |
| ✓ | ✓ | ✓ |
認証成功後に名前を表示する show_user_name | bool |
| ✓ | ✓ | ✓ |
拒否リストメッセージblack_list_tip | string | 長さ制限:50 | ✓ | ✓ | ✓ |
拒否リストドアオープンblack_list_open | bool |
| ✓ | ✓ | ✓ |
生体認識 liveness | bool |
| ✓ | ✓ | ✓ |
生体認識閾値liveness_threshold | float | [0、1]、小数点以下 2 桁です。推奨値は 0.98 です | ✓ | ✓ | ✓ |
顔認証閾値 verify_threshold | float | [0、1]、小数点以下 2 桁です。推奨値は 0.9 です | ✓ | ✓ | ✓ |
IDカード比較閾値certificate_threshold | float | 当機能はご利用いただけません。[0、1]、小数点以下 2 桁です。0.60 で仮の値をリクエストしてください | ✓ | ✓ | ✓ |
顔認識距離(メートル) verification_distance | float | [0.5、2.0]、小数点以下 1 桁です | ✓ | ✓ | ✓ |
ドアオープンモード open_door_type | int |
| ✓ | ✓ | ✓ |
ネットワークリレー IP アドレス network_relay_address | string |
| ✓ | ✓ | ✓ |
ドアオープンタイム (秒) keep_door_open_duration | int | [1、255]、整数 | ✓ | ✓ | ✓ |
ドアセンサータイムアウト door_sensor_timeout | int | [1、255]、整数 | ✓ | ✓ | ✓ |
認証インターバル (秒) open_interval | int | [1、30]、整数 | ✓ | ✓ | ✓ |
GPIO A - 出力 gpio_a | int |
| ✓ | ✓ | ✓ |
GPIO B - 入力 gpio_b | int |
| ✓ | ✓ | ✓ |
GPIO C - 入力 gpio_c | int |
| ✓ | ✓ | ✓ |
Wiegand入力 wigan_input | int |
| ✓ | ✓ | ✓ |
アラート音スイッチ buzzer_status | bool |
| ✓ | ✓ | ✓ |
フリッカー低減 short_exposure | int |
| × | ✓ | ✓ |
インストール環境 setup_env | int |
| × | ✓ | × |
システム言語 language_type | int |
| ✓ | ✓ | ✓ |
自動スタンバイ standby_open | bool |
| ✓ | ✓ | ✓ |
スタンバイ時間 (分) wait_time | int | [3、30]、整数 | ✓ | ✓ | ✓ |
スリープ解除距離 wake_distance | int | [50、200]、整数 | × | ✓ | ✓ |
自動再起動 auto_reboot | bool | true:オン false:オフ | ✓ | ✓ | ✓ |
再起動時間 reboot_time | string | hh:mm:ss (時間、分、秒) | ✓ | ✓ | ✓ |
code | メッセージ | エラーの説明 |
50001 | RPC FAILED | RPCに失敗しました |
30001 | Param Invalid | 無効なパラメーターです |
30001 | Param Invalid | 無効なパラメーターです。デバイスID リストが空です |
30001 | Param Invalid | 無効なパラメーターです。デバイスタイプが存在しません |
パラメーター名 | 型 | 必須 | 説明 |
id | long | Yes | デバイスの ID |
remark | string | No | ドアオープンの特記事項。長さ制限は 255 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の章を参照してください |
timestamp | string | Yes | タイムスタンプ |
code | メッセージ | エラーの説明 |
30001 | Param Invalid | 無効なパラメーターです。デバイスが存在しません |
603 | Device Offline | デバイスがオンラインではありません |
30001 | Param Invalid | 無効なパラメーターです。デバイスID は空にはできません |
パラメーター名 | 型 | 必須 | 説明 |
payload | object[] | Yes | 通知メッセージの対象。複数の送信が可能です |
payload.ldid | string | Yes | メッセージを受信するデバイスの LDIDです |
payload.type | string | Yes | 通知タイプ。0000 はカスタマイズ通知を示します。メッセージは payload.content を通してカスタマイズします |
payload.content | object | No | メッセージの内容は透過的にデバイスに送信されます。 |
trace_id | string | Yes | リクエストされるイベントのシリアル番号です。記号列は UUID と類似しています |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1シグネチャ(sign)の計算の章を参照してください |
timestamp | string | Yes | タイムスタンプ |
code | メッセージ | エラーの説明 |
10003 | Request Expired | タイムスタンプが期限切れになりました |
10005 | Signature Failed | 無効な署名です |
60001 | grpc fail | 通知の送信に失敗しました |
60001 | Device Not Exist | デバイスが存在しません |
30001 | the Device is out line | デバイスがオンラインではありません |
パラメーター | 説明 | 例 |
type:“0000” | サードパーティーがカスタマイズした内容です | { "trace_id":"75d836b4-4a71-4b32-bb16-d215d208195a", "payload":[ { "type": "0000", "ldid":"SPS-8366d77b20689ca0cd0dbfadbea85a2e", "content": "instruction1" //これはオブジェクトです。必ずしも string である必要はなく、他の値も利用可能です。以下に例を示します。値は透過的にデバイスエンドに送信されます }, { "type": "0000", "ldid":"SPSP-8366d77b20689ca0cd0dbfadbea85a2e", "content": "instruction2" // これはオブジェクトです。必ずしも string である必要はなく、他の値も利用可能です。以下に例を示します。値は透過的にデバイスエンドに送信されます } ] } |
パラメータ名 | 型 | 必須 | 説明 |
duid | string | Yes | デバイスシリア番号 |
Identifier | string | Yes | デバイス識別子、詳細について、次のデバイス型番識別子をご参照ください |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。計算ルールについては、ドキュメントをご参照ください |
timestamp | string | Yes | タイムスタンプ |
デバイス名称 | デバイス型番識別子 |
SensePass | SPS |
SensePass Pro | SPSP |
SenseThunder-E | SPSPE |
SenseThunder-E Mini | SPSE |
パラメータ | 型 | 説明 |
code | int | コード |
message | string | メッセージ |
data | string | デバイスLDID |
パラメーター名 | 型 | 必須 | 説明 |
user_id | long | Yes | 登録者ID |
time_valid_from | long | No | 認証開始時間 |
valid_time | long | No | 有効期間 |
entry_times | int | No | 入室時間 |
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
desc | string | リターンの説明 |
data | string | QR コードのコンテンツ |
code | メッセージ | 説明 |
30001 | Param Invalid | 無効なパラメーターです。登録者が存在しません |
パラメーター名 | 型 | 必須 | 説明 |
name | string | Yes | グループ名。長さ制限は 45 |
type | int | Yes | グループタイプ(1 : 従業員グループ、2 : ビジターグループ、5 : 拒否リストグループ) |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
data | object | データ |
パラメーター名 | 型 | 説明 |
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 | 内部システムエラーです。グループ作成に失敗しました |
パラメーター名 | 型 | 必須 | 説明 |
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 | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
data | object | データ |
パラメーター名 | 型 | 説明 |
total | string | 総計 |
pageNum | string | ページ数 |
size | string | サイズ |
pageSize | string | ページサイズ |
totalPage | string | ページ合計 |
data | object | データ |
パラメーター名 | 型 | 説明 |
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に失敗しました。デバイスグループリストの取得に失敗しました |
パラメーター名 | 型 | 必須 | 説明 |
id | long | Yes | グループID |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
data | list<long> | 登録者ID |
code | メッセージ | エラーの説明 |
620 | Record non-existent Error | グループID が存在しません |
30001 | Param Invalid | 無効なパラメーターです |
パラメーター名 | 型 | 必須 | 説明 |
id | long | Yes | グループID |
name | string | No | グループ名 |
device_ids | list<long> | No | デバイスID リスト |
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
desc | string | リターンの説明 |
data | object | データ |
パラメーター名 | 型 | 説明 |
id | int | グループ ID |
name | string | グループ名 |
type | int | グループタイプ |
devices | list<device> | デバイス |
is_default | int | デフォルトのグループかどうかの識別 |
パラメーター名 | 型 | 説明 |
id | int | デバイスの ID |
name | string | デバイス名 |
type | int | デバイスタイプ |
code | メッセージ | 説明 |
30001 | Param Invalid | 無効なグループ ID など |
600 | Sync Failed | リモートリクエストエラー |
パラメーター名 | 型 | 必須 | 説明 |
id | long | Yes | 登録者グループの ID |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.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に失敗しました。グループの削除に失敗しました |
パラメーター名 | 型 | 必須 | 説明 |
groupId | long | Yes | 登録者グループの ID |
userIds | list<long> | Yes | 一括で追加する登録者ID。1回の操作で最大2000人を追加できます |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
code | メッセージ | 説明 |
620 | Record non-existent Error | グループID が存在しません |
30001 | param-invalid | 無効なパラメーターです。2,000 を超える数を一度にグループに追加することはできません |
30001 | param-invalid | 無効なパラメーターです。groupId が空です |
30001 | param-invalid | 無効なパラメーターです。登録者の userId array が空です |
30001 | param-invalid | 無効なパラメーターです。登録者とグループタイプが一致しません |
50001 | RPC FAILED | RPCに失敗しました。一括登録者追加に失敗しました |
パラメーター名 | 型 | 必須 | 説明 |
groupId | long | Yes | 従業員のグループID |
userIds | list<long> | Yes | 一括で削除する登録者のID。最大2,000 まで一括で操作できます。 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
code | int | リターンコード。200 はリクエストが成功したことを示します |
message | string | リターンメッセージ |
code | メッセージ | 説明 |
620 | Record non-existent Error | グループID が存在しません |
30001 | param-invalid | 無効なパラメーターです。2,000 を超える数を一度にグループから削除することはできません |
30001 | param-invalid | 無効なパラメーターです。groupId が空です |
30001 | param-invalid | 無効なパラメーターです。登録者の userId array が空です |
30001 | param-invalid | 無効なパラメーターです。登録者とグループタイプが一致しません |
50001 | RPC FAILED | RPCに失敗しました。グループからの登録者の一括削除に失敗しました |
概要
認証用顔写真内の顔の数を特定します。
リクエストアドレスの例
https://HOST:PORT/api/v1/recognition/check
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
認証用顔写真の品質を検出します。
リクエストアドレスの例
https://HOST:PORT/api/v1/recognition/quality
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
qa_code の説明
エラーレスポンスのフィールド
概要
タイムテーブルを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable
リクエスト方法
POST application/json
リクエストパラメーター
Time フィールドの説明
Special_day フィールドの説明
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
time フィールドの説明
special_day フィールドの説明
エラーレスポンスのフィールド
概要
タイムテーブルを削除します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable/delete
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
タイムテーブルを更新します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable/update
リクエスト方法
POST application/json
リクエストパラメーター
time フィールドの説明
special_day フィールドの説明
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
time フィールドの説明
special_day フィールドの説明
エラーレスポンスのフィールド
概要
タイムテーブルリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable/list
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
タイムテーブルの詳細を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
time フィールドの説明
special_day フィールドの説明
エラーレスポンスのフィールド
概要
アクセスルールを追加します。一括追加をサポートします。最初にデバイスをグループに連携する必要があります。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/rule
リクエスト方法
POST application/json
リクエストパラメーター
passRule フィールドの説明
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
アクセスルールを削除します。一括削除が可能です。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/rule/delete
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
構成されているアクセスルールのリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/rule/list
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
すべてのデバイスおよびグループの連携関係 (アクセスルール情報を含む) を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/devices/passrules
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
timetableGroup フィールドの説明
エラーレスポンスのフィールド
概要
認証レコードを表示します。
SenseLink Cloudを利用する場合のみ使用できます。
SenseLink GE EnterpriseとSenseLink GE Enterprise Proを利用する場合は、V3を使用してください。
v3、v4のインターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v5/record/list
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
recordItem フィールドの説明
group フィールドの説明
概要
認証レコードを表示します。
SenseLink Cloudを利用する場合のみ使用できます。
SenseLink GE EnterpriseとSenseLink GE Enterprise Proを利用する場合は、V3を使用してください。
v3のインターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v4/record/list
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
recordItem フィールドの説明
group フィールドの説明
概要
認証レコードを表示します。
リクエストアドレスの例
https://HOST:PORT/api/v3/record/list
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
data.dataフィールドの説明
recordItem フィールドの説明
group フィールドの説明
外部システムはSenseLinkのサブスクリプションサービスを利用することで、SenseLinkのイベントをサブスクライブすることができます。SenseLinkはデバイスの認証とアラート(以下、「イベント」)をPOSTリクエスト(以下、「Push」)することができます。
SenseLink Cloudをご利用の場合、当節で記載される手順・設定の他にJCVサポート窓口へ以下の情報を申請してください。申請およびJCVサポート窓口の処理が完了するまで、イベントサブスクリプション機能は利用できません。
イベントを処理するAPIエンドポイント(アプリケーションのURL)
上記エンドポイントのIPアドレス
サブスクリプション申請時に提出する情報は以下のものです
固定IPアドレスとポート番号(必須)
URL(サブスクリプションを受け取るクライアント側URL)(必須)
※注:クライアント側URLとの通信に際し、BASIC認証などの認証技術は対応しておりません。
アカウントID (必須)
テナントID(オプション)
イベントをサブスクライブする外部システムのAPIエンドポイントは、SenseLinkのWeb UIのナビゲーションメニュー [システム管理]→[Open Platform] 内の サブスクリプションサービスステータス欄、もしくは本マニュアル内のAPIで設定および更新することができます。
サブスクリプションサービス設定画面が表示されます。
イベント処理サーバーアドレスの欄に、連携する外部システムのサーバーアドレスを入力してください。http、httpsをサポートしています。https://またはhttps://から入力してください。
サブスクリプションイベントタイプ欄では、サブスクライブするイベントのタイプを選んでください。デバイスで認証が行われた際に認証レコードをPushで受け取るには認証レコードを、デバイスアラートが発生した場合にPushで受け取るにはデバイスアラートを選択してください。両方を選択することも可能です。
サブスクリプションを更新した際に、再保存時に認証レコードタイプ/デバイスアラートタイプが「未選定」の状態になる場合があります。その場合は、再設定してください。
設定が完了したら、保存ボタンをクリックしてください。Open Platform画面に戻ります。 サブスクリプションサービスステータスがNormalと表示されていれば、イベントがサブスクライブされています。
サブスクリプションサービスの設定を変更するにはサブスクリプションサービス欄の詳細ボタンをクリックしてください。
サブスクリプションサービスを停止するにはサブスクリプション停止ボタンをクリックしてください。サービスが停止され、外部システムにイベントがPushされなくなります。
サブスクリプションサービスの設定を修正するには、サブスクリプション更新ボタンをクリックしてください。設定内容を変更できます。変更内容を入力後、保存してください。
イベントのPush後、外部システムは100秒以内にレスポンスを返却するか、リターンコード200を返却する必要があります。
レスポンスが100秒以内に返却されない場合、またはリターンコードが200以外の場合はエラーとみなされ、SenseLinkはそのイベントを再Pushしません。その後SenseLinkは外部システムのサブスクリプションステータスを「異常」に変更し、エラーログとして保存されます。ただし、その後発生した新しいイベントのPushには影響はありません。
なお、レスポンスが100秒以内に返却された、かつリターンコードが200になった場合、サブスクリプションステータスは「正常」に戻ります。
Open Platform画面のサブスクリプションサービスステータス欄の詳細をクリックし、サブスクリプションサービスの設定画面にあるログボタンをクリックすると、最新のイベントPushの結果(以下、「ログ」)を確認することができます。
ログは最大100件まで保存され、100を越えると古いものから順に削除されます。各ログの詳細ボタンをクリックすると認証レコードページまたはデバイスアラートページに遷移し、イベントの詳細を確認することができます。 イベントタイプまたはステータスで、ログを検索することができます。リセットボタンをクリックすると検索による絞り込みがリセットされ、すべてのログが表示されます。
テストイベント送信ボタンをクリックすると、テストイベントを連携中の外部システムにPush することができます。 認証レコードとデバイスアラートが選択されている場合、または認証レコードのみが選択されている場合は認証レコードのテストイベントが送信されます。 デバイスアラートのみが選択されている場合、デバイスアラートのテストイベントが送信されます。
POST application/json
認証レコード :
デバイスアラート :
認証レコードデータの属性 :
group フィールドの説明
デバイスのアラートレコードのデータ属性 :
レスポンスのフィールド
概要
イベントのサブスクリプションを追加または更新します。
過去のバージョンを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v4/event/updateSub
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
イベントのサブスクリプションを停止します。
リクエストアドレスの例
https://HOST:PORT/api/v3/event/stopSub
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
サブスクリプションの詳細を表示します。
リクエストアドレスの例
https://HOST:PORT/api/v4/event/viewSub
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
イベントのPushログを表示します。
サブスクリプションサービスが起動されなくても、該当するAPIを使って前に生成されたログを取得できます。
リクエストアドレスの例
https://HOST:PORT/api/v3/event/viewLog
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
テストイベントをPush送信します。
リクエストアドレスの例
https://HOST:PORT/api/v3/event/sendTest
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
Websocketプロトコルを利用したPush通知機能について記載されています。
デバイスの認証レコードやデバイスのアラートをPushするには、websocket プロトコルを利用します。
注記:本Push通知は、SenseLink GE V1.10.7を利用していたユーザー向けの機能です。 SenseLink GE V2.2.0以降では標準としてイベントサブスクリプションがサポート、利用が推奨されています。
接続アドレス :
ws://HOST:9000/websocket/record/{app_key}/{timestamp}/{sign}
接続パラメーター :
メッセージ本体 :
code:30000 認証レコード
code:30100 アラートレコード
概要
すべてのデバイスの認証レコードPushをリアルタイムで受信します(WebSocket)。
code=30000
メッセージ本体データ
group フィールドの説明
例
接続成功 :
接続失敗 :
ハートビート検知 :
メッセージPush本体 :
概要
すべてのデバイスのアラートレコードのPush(WebSocket) を受信します。
code=30100
メッセージ本体データ
例
接続成功 :
接続失敗 :
ハートビート検知 :
メッセージPush本体 :
パラメーター名
型
必須
説明
face_avatar
file
Yes
認証用顔写真
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
不正なリターンの説明
data
int
顔の数
コード
メッセージ
説明
30001
Param Invalid
認証用顔写真のタイプが不正です
30003
No Face Detected In The Image
顔が検出されませんでした。
パラメーター名
型
必須
説明
face_avatar
file
Yes
認証用顔写真
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
qa_code
int
リターンコード
qa_msg
string
リターンメッセージ
qa_desc
string
リターンの説明
リターンコード
リターンメッセージ
リターンの説明
0
PASS
通過
101
BAN:face count is over the max
顔の数が最大数の制限を超えています
10201
BAN:image size wrong, two small
認証用顔写真が小さすぎます
10301
BAN:the alignment score is substandard
検知スコアが低すぎます
1030201
BAN:the face rect's pixels is too low
顔フレームのピクセルが少なすぎます
1030301
BAN:the face pose pitch is substandard
ピッチ角が大きすぎます
1030302
BAN:the face pose yaw is substandard
転向角が大きすぎます
1030303
BAN:the face pose roll is substandard
ロール角が大きすぎます
10401
BAN:the face quality{distance to center} is substandard
対面距離が基準を満たしていません
10402
BAN:the face quality{face size} is substandard
顔サイズ比が小さすぎます(顔の長方形の領域/ 画像領域)
10403
BAN:the face quality{face cover} is substandard
顔が遮られすぎています
10404
BAN:the face quality{brightness} is substandard
明るさが基準を満たしていません
10405
BAN:the face quality{sharpness} is substandard
明度が基準を満たしていません。(写真がぼやけています)
10406
BAN:the face quality{mouth opened} is substandard
口が開き過ぎています
10407
BAN:the face quality{face missing} is substandard
欠けた顔が多すぎます
コード
メッセージ
説明
30001
Param Invalid
無効なパラメーターです
30001
Param Invalid
写真が大きすぎます
30005
Avatar File Illegal
ファイルのサイズが大きすぎます
30005
Avatar File Illegal
処理中にエラーが発生しました
30006
Face Number Invalid
無効な顔です
50002
Internal Server Error
シリアル化エラー
パラメーター名
型
必須
説明
name
string
Yes
タイムテーブルの名前
monday_period
list<time>
Yes
月曜日のアクセスルール
tuesday_period
list<time>
Yes
火曜日のアクセスルール
wednesday_period
list<time>
Yes
水曜日のアクセスルール
thursday_period
list<time>
Yes
木曜日のアクセスルール
friday_period
list<time>
Yes
金曜日のアクセスルール
saturday_period
list<time>
Yes
土曜日のアクセスルール
sunday_period
list<time>
Yes
日曜日のアクセスルール
holiday_period
list<time>
Yes
祝日のアクセスルール
start_timestamp
long
Yes
有効期限開始のタイムスタンプ
end_timestamp
long
Yes
有効期限終了のタイムスタンプ
special_days
list<special_day>
No
特別な祝日
パラメーター名
型
必須
説明
start_time
string
Yes
00:00:00 形式
end_time
string
Yes
00:00:00 形式
パラメーター名
型
必須
説明
date
string
Yes
日付
remark
string
No
特記事項
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
object
データ
パラメーター名
型
説明
id
int
ID
name
string
タイムテーブルの名前
monday
string
30分ごとのおおまかな 24 時間のアクセスルール
tuesday
string
30分ごとのおおまかな 24 時間のアクセスルール
wednesday
string
30分ごとのおおまかな 24 時間のアクセスルール
thursday
string
30分ごとのおおまかな 24 時間のアクセスルール
friday
string
30分ごとのおおまかな 24 時間のアクセスルール
saturday
string
30分ごとのおおまかな 24 時間のアクセスルール
sunday
string
30分ごとのおおまかな 24 時間のアクセスルール
holiday
string
30分ごとのおおまかな 24 時間のアクセスルール
monday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
tuesday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
wednesday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
thursday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
friday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
saturday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
sunday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
holiday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
start_timestamp
long
タイムスタンプ(ミリ秒単位)
end_timestamp
long
タイムスタンプ(ミリ秒単位)
special_days
list<special_day>
特別な日
パラメーター名
型
説明
start_time
string
00:00:00 形式
end_time
string
00:00:00 形式
パラメーター名
型
説明
id
int
特別な日の ID
date
string
日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します
remark
string
特記事項
timetable_id
int
タイムテーブルの ID
code
メッセージ
説明
30001
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
id
long
Yes
タイムテーブルの ID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
object
データ
code
メッセージ
説明
30001
Param Invalid
パラメーターエラー
610
Similar record Exist
タイムテーブルはアクセスルールに連携されているため、削除できません
620
Record non-existent Error
タイムテーブルが存在しません
パラメーター名
型
必須
説明
id
int
Yes
タイムテーブルの ID
name
string
Yes
タイムテーブルの名前
monday_period
list<time>
Yes
月曜日のアクセスルール
tuesday_period
list<time>
Yes
火曜日のアクセスルール
wednesday_period
list<time>
Yes
水曜日のアクセスルール
thursday_period
list<time>
Yes
木曜日のアクセスルール
friday_period
list<time>
Yes
金曜日のアクセスルール
saturday_period
list<time>
Yes
土曜日のアクセスルール
sunday_period
list<time>
Yes
日曜日のアクセスルール
holiday_period
list<time>
Yes
祝日のアクセスルール
start_timestamp
long
Yes
有効期限開始のタイムスタンプ
end_timestamp
long
Yes
有効期限終了のタイムスタンプ
special_days
list<special_day>
No
特別な祝日
パラメーター名
型
必須
説明
start_time
string
Yes
00:00:00 形式
end_time
string
Yes
00:30:00 形式
パラメーター名
型
必須
説明
date
string
Yes
日付
remark
string
No
特記事項
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
object
データ
パラメーター名
型
説明
id
int
タイムテーブルの ID
name
string
タイムテーブルの名前
monday
string
24 時間を 48 の期間に分割します。string は 0 と 1 で構成され、1 は該当する期間にアクセスが可能であることを示し、0 はアクセスが可能ではないことを示します。例:100000000000000000000000000000000000000000000001 は、00:00~00:30 を示し、23:30~24:00 はアクセス可能であることを示します
tuesday
string
24 時間のアクセスルール
wednesday
string
24 時間のアクセスルール
thursday
string
24 時間のアクセスルール
friday
string
24 時間のアクセスルール
saturday
string
24 時間のアクセスルール
sunday
string
24 時間のアクセスルール
holiday
string
24 時間のアクセスルール
monday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
tuesday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
wednesday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
thursday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
friday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
saturday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
sunday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
holiday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
start_timestamp
long
タイムスタンプ(ミリ秒単位)
end_timestamp
long
タイムスタンプ(ミリ秒単位)
special_days
list<special_day>
特別な日
パラメーター名
型
説明
start_time
string
00:00:00 形式
end_time
string
00:30:00 形式
パラメーター名
型
説明
id
int
特別な日の ID
date
string
日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します
remark
string
特記事項
timetable_id
int
タイムテーブルの ID
code
メッセージ
説明
30001
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
object
データ
パラメーター名
型
説明
id
int
タイムテーブルの ID
name
string
タイムテーブル名
code
メッセージ
説明
30001
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
id
long
Yes
タイムテーブルの ID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
object
データ
パラメーター名
型
説明
id
integer
タイムテーブルの ID
name
string
タイムテーブルの名前
monday
string
30分ごとのおおまかな 24 時間のアクセスルール
tuesday
string
30分ごとのおおまかな 24 時間のアクセスルール
wednesday
string
30分ごとのおおまかな 24 時間のアクセスルール
thursday
string
30分ごとのおおまかな 24 時間のアクセスルール
friday
string
30分ごとのおおまかな 24 時間のアクセスルール
saturday
string
30分ごとのおおまかな 24 時間のアクセスルール
sunday
string
30分ごとのおおまかな 24 時間のアクセスルール
holiday
string
30分ごとのおおまかな 24 時間のアクセスルール
monday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
tuesday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
wednesday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
thursday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
friday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
saturday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
sunday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
holiday_period
list<time>
アクセス時間(24時間形式、秒単位で指定)
start_timestamp
long
タイムスタンプ(ミリ秒単位)
end_timestamp
long
タイムスタンプ(ミリ秒単位)
special_days
list<special_day>
特別な日
パラメーター名
型
説明
start_time
string
00:00:00 形式
end_time
string
00:30:00 形式
パラメーター名
型
説明
id
int
特別な日の ID
date
string
日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します
remark
string
特記事項
timetable_id
int
タイムテーブルの ID
code
メッセージ
説明
30001
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
list<passRule>
Yes
アクセスルールのパラメーター
パラメーター名
型
必須
説明
device_id
long
Yes
デバイスの ID
group_id
long
Yes
グループID
timetable_id
long
Yes
タイムテーブルの ID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
object
データ
パラメーター名
型
説明
id
long
アクセスルールの ID
device_id
long
デバイスの ID
device_name
string
デバイス名
group_id
long
グループID
group_name
string
グループ名
group_type
int
グループタイプ
timetable_id
long
タイムテーブルの ID
timetable_name
string
タイムテーブル名
コード
メッセージ
説明
600
Sync Failed
RPCに失敗しました
30001
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
ids
list<long>
Yes
アクセスルール ID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
object
データ
コード
メッセージ
説明
30001
Param Invalid
パラメーターエラー
620
Record non-existent Error
レコードが存在しません。
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
object
データ
パラメーター名
型
説明
id
int
アクセスルール ID
device_id
int
デバイスの ID
device_name
string
デバイス名
group_id
int
アクセスグループ ID
group_name
string
アクセスグループ名
timetable_id
int
タイムテーブルの ID
timetable_name
string
タイムテーブル名
group_type
int
グループタイプ
コード
メッセージ
説明
30001
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
device_ids
list<long>
Yes
デバイスの ID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
object
データ
パラメーター名
型
説明
device_id
int
デバイスの ID
device_name
string
デバイス名
timetable_groups
list<timetableGroup>
連携されているタイムテーブルとアクセスグループ
パラメーター名
型
説明
group_id
int
アクセスグループ ID
group_name
string
アクセスグループ名
group_type
int
グループタイプ
timetable_id
int
タイムテーブルの ID
timetable_name
string
タイムテーブル名
コード
メッセージ
説明
30001
Param Invalid
パラメーターエラー
60001
Device Not Exist
デバイスが存在しません
パラメーター名
型
必須
説明
date_time_from
string
No
サーバー時間の作成開始日。デフォルト値は現在の日付の 0 時。例 : 2018-07-20 12:30:45
date_time_to
string
No
サーバー時間の作成終了日。デフォルト値は現在の日付の 23:59:59。例 : 2019-07-20 12:30:45
order
int
No
並び順。0 : レコードIDで降順、1 : レコードIDで昇順
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
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
パラメーター名
型
説明
list
list<recordItem>
認証レコード詳細
page_num
int
ページ番号(デフォルトは 1 です)
page_size
int
1 ページあたりのデータの数(デフォルトは 20)。最大値は 100
パラメーター名
型
説明
id
int
認証レコード ID
direction
int
デバイスのアクセス方向
latitude
double
緯度
longitude
double
経度
address
string
住所
location
string
勤務地
mobile
string
携帯電話番号
remark
string
特記事項
groups
list<group>
グループ
capture_picture
string
認証時にデバイスが撮影した写真(サムネイル)の ID
capture_bg_picture
string
認証時にデバイスが撮影した写真(大)の ID
avatar
string
認証用顔写真
heat_avatar
string
認証時にデバイスが撮影したサーマル画像
user_id
int
登録者 ID
user_name
string
登録者名
user_type
int
登録者タイプ
group_id
int
グループ ID
group_name
string
グループ名
device_name
string
デバイス名
device_ldid
string
デバイス LDID
sign_time
string
認証時間
entry_mode
int
認証モード
sign_time_zone
string
タイムゾーン
verify_score
float
認証スコア
mis_id
int
誤認証 ID
mis_type
int
誤認証タイプ
doc_photo
string
ID カード写真(利用できません)
ic_number
string
IC カード番号
id_number
string
ID カード番号読み込み(利用できません)
abnormal_type
int
異常レコードタイプ 0:なし、10001:IDカード不一致、10002:認証カード不一致、10003:認証コード不一致、20001:ビジターが有効期限外、20002:アクセス時間外、30001:無効な ID カード、30002:無効な IC カード、30003:無効な QR コード、40001:体温が異常、50001:マスク着用無し
job_number
string
従業員ID
user_ic_number
string
登録者 IC カード番号
user_id_number
string
登録者 ID 番号
reception_user_id
long
受付担当者 ID
reception_user_name
string
受付担当者名
user_remark
string
登録者コメント
sign_date
string
認証日
body_temperature
float
体温
mask
int
マスク着用識別子。0:不明、1:着用なし、2:着用あり
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
パラメーター名
型
必須
説明
date_time_from
string
No
サーバー時間の作成開始日。デフォルト値は現在の日付の 0 時。例 : 2018-07-20 12:30:45
date_time_to
string
No
サーバー時間の作成終了日。デフォルト値は現在の日付の 23:59:59。例 : 2019-07-20 12:30:45
order
int
No
並び順。0 : レコードIDで降順、1 : レコードIDで昇順
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
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
パラメーター名
型
説明
list
list<recordItem>
認証レコード詳細
total
int
認証レコード合計数
パラメーター名
型
説明
id
int
認証レコード ID
direction
int
デバイスのアクセス方向
latitude
double
緯度
longitude
double
経度
address
string
住所
location
string
勤務地
mobile
string
携帯電話番号
remark
string
特記事項
groups
list<group>
グループ
capture_picture
string
認証時にデバイスが撮影した写真(サムネイル)の ID
capture_bg_picture
string
認証時にデバイスが撮影した写真(大)の ID
avatar
string
認証用顔写真
heat_avatar
string
認証時にデバイスが撮影したサーマル画像
user_id
int
登録者 ID
user_name
string
登録者名
user_type
int
登録者タイプ
group_id
int
グループ ID
group_name
string
グループ名
device_name
string
デバイス名
device_ldid
string
デバイス LDID
sign_time
string
認証時間
entry_mode
int
認証モード
sign_time_zone
string
タイムゾーン
verify_score
float
認証スコア
mis_id
int
誤認証 ID
mis_type
int
誤認証タイプ
doc_photo
string
ID カード写真(利用できません)
ic_number
string
IC カード番号
id_number
string
ID カード番号読み込み(利用できません)
abnormal_type
int
異常レコードタイプ 0:なし、10001:IDカード不一致、10002:認証カード不一致、10003:認証コード不一致、20001:ビジターが有効期限外、20002:アクセス時間外、30001:無効な ID カード、30002:無効な IC カード、30003:無効な QR コード、40001:体温が異常、50001:マスク着用無し
job_number
string
従業員ID
user_ic_number
string
登録者 IC カード番号
user_id_number
string
登録者 ID 番号
reception_user_id
long
受付担当者 ID
reception_user_name
string
受付担当者名
user_remark
string
登録者コメント
sign_date
string
認証日
body_temperature
float
体温
mask
int
マスク着用識別子。0:不明、1:着用なし、2:着用あり
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
パラメーター名
型
必須
説明
start_record_id
long
No
認証レコード の開始ID
end_record_id
long
No
認証レコード の終了ID
device_sn
string
No
デバイスシリアル番号
type
int
No
タイプ:{ 1:従業員、2:ビジター、3:未登録人物、 5 : 拒否リスト}
user_id
long
No
登録者ID
date_time_from
string
No
ローカル時間の開始日。デフォルト値は現在の日付の 0 時。例 : 2018-07-20 12:30:45
date_time_to
string
No
ローカル時間の終了日。デフォルト値は現在の日付の 23:59:59。例 : 2019-07-20 12:30:45
name
string
No
登録者名
page
int
No
ページ番号(デフォルトは 1 です)
size
int
No
1 ページあたりのデータの数(デフォルトは 20)。最大値は 100
entry_mode
int
No
認証モード(1:顔認証、2:QR コード、3:カード、4:顔認証とカード、5 : ID カード、6:顔認証と ID カード) 1:顔認証のみ利用できます
user_id
long
No
登録者ID
group_id
long
No
グループID
mis_type
int
No
誤認証タイプ。1:別の人物、2:未登録人物、3:非生体、4:未登録人物からの攻撃、5:非生体からの攻撃
abnormal_types
int
No
認証レコードの以上検知タイプ。0:なし、10001:IDカード不一致、10002:認証カード不一致、10003:認証コード不一致、20001:ビジターが有効期限外、20002:アクセス時間外、30001:無効な ID カード、30002:無効な IC カード、30003:無効な QR コード、40001:体温が異常、50001:マスク着用無し
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
パラメーター名
型
説明
total
int
総計
size
int
容量
data
object
認証レコードの情報
page_num
int
現在のページ番号
page_size
int
ページサイズ
total_page
int
ページ合計
パラメーター名
型
説明
total
int
総計
user_count
int
従業員レコードの数
guest_count
int
ビジターレコードの数
stranger_count
int
未登録者レコードの数
record_list
list<recordItem>
認証レコード
パラメーター名
型
説明
id
int
認証レコード ID
direction
int
デバイスのアクセス方向
latitude
double
緯度
longitude
double
経度
address
string
住所
location
string
勤務地
mobile
string
携帯電話番号
remark
string
特記事項
groups
list<group>
グループ
capture_picture
string
認証時にデバイスが撮影した写真(サムネイル)の ID
capture_bg_picture
string
認証時にデバイスが撮影した写真(大)の ID
avatar
string
認証用顔写真
heat_avatar
string
認証時にデバイスが撮影したサーマル画像
user_id
int
登録者 ID
user_name
string
登録者名
user_type
int
登録者タイプ
group_id
int
グループ ID
group_name
string
グループ名
device_name
string
デバイス名
device_ldid
string
デバイス LDID
sign_time
string
認証時間
entry_mode
int
認証モード
sign_time_zone
string
タイムゾーン
verify_score
float
認証スコア
mis_id
int
誤認証 ID
mis_type
int
誤認証タイプ
doc_photo
string
ID カード写真(利用できません)
ic_number
string
IC カード番号
id_number
string
ID カード番号読み込み(利用できません)
abnormal_type
int
異常レコードタイプ 0:なし、10001:IDカード不一致、10002:認証カード不一致、10003:認証コード不一致、20001:ビジターが有効期限外、20002:アクセス時間外、30001:無効な ID カード、30002:無効な IC カード、30003:無効な QR コード、40001:体温が異常、50001:マスク着用無し
job_number
string
従業員ID
user_ic_number
string
登録者 IC カード番号
user_id_number
string
登録者 ID 番号
reception_user_id
long
受付担当者 ID
reception_user_name
string
受付担当者名
user_remark
string
登録者コメント
sign_date
string
認証日
body_temperature
float
体温
mask
int
マスク着用識別子。0:不明、1:着用なし、2:着用あり
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
パラメーター名
型
必須
説明
messageId
string
Yes
イベントの固有の識別子
eventType
string
Yes
30000:認証レコード、30100:デバイスアラート
sendTime
string
Yes
イベント発生時刻(デバイス時間)
data
object
Yes
イベントの対象
パラメーター名
型
説明
id
int
レコード ID
userId
int
認証されたユーザーの ID
name
string
認証されたユーザーの名前
type
int
ユーザーの識別子タイプ
avatar
string
認証用顔写真
direction
int
デバイスのアクセス方向
verifyScore
float
認証スコア
receptionUserId
int
認証されたユーザーの応対者の ID
receptionUserName
string
認証されたユーザーの応対者の名前
groups
list<group>
認証されたユーザーのグループ情報
deviceName
string
デバイス名
sn
string
この認証レコードのデバイス LDID 番号をアップロードします
signDate
string
認証レコードの日付
signTime
timestamp
認証時間(秒)
signAvatar
string
認証時写真(サムネイル)
signBgAvatar
string
認証時写真(大)
companyId
long
企業ID
mobile
string
認証されたユーザーの携帯電話番号
icNumber
string
認証されたユーザーのIC カード番号
idNumber
string
認証されたユーザーの ID 番号(利用できません)
jobNumber
string
認証されたユーザーの従業員ID
remark
string
特記事項
entryMode
int
認証モード (1:顔認証、2:QR コード、3:カード、4:顔認証とカード、5:ID カード、6:顔認証と ID カード)
signTimeZone
string
認証レコードのタイムゾーン
docPhoto
string
ID 写真
latitude
double
緯度
longitude
double
経度
address
string
住所
location
string
デバイスの設置場所
abnormalType
int
認証レコードの異常のタイプ。0:なし、10001:IDカード不一致、10002:認証カード不一致、10003:認証コード不一致、20001:ビジターが有効期限外、20002:アクセス期限内ではない、30001:無効な ID カード、30002:無効な IC カード、30003:無効な QR コード、40001:異常な体温、50001:マスク着用なし
userIcNumber
userIdNumber
(利用できません)
bodyTemperature
float
体温
mask
int
マスク着用識別子。0:不明、1:着用なし、2:着用あり
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプです。1:従業員グループ、2:ビジターグループ、5:拒否リストグループ
パラメーター名
型
説明
id
long
アラートレコードのID
traceId
string
アラートのシリアル番号。デバイスによって生成されるアラート固有の識別番号です。
code
int
アラートのタイプ。10001:デバイスの盗難アラート、10002:ドア・ゲート強制突破アラート、10003:ドアセンサータイムアウト、10004:パスワードクラッキング、10005 :(サポートされないアラートです。現在利用できません)、10006:サーモグラフィカメラ接続異常、20001:カメラの汚れ、20002:Non-Living アタック(非生体による認証)、20003:消防アラート、30001:デバイスオフラインアラート、40001:特徴量抽出エラー
alarmTime
string
アラート時間
level
int
アラートレベル。1:アラート、2:異常
deviceId
long
デバイスの ID
deviceSn
string
デバイスの LDID
deviceLocation
string
デバイスの設置場所
deviceName
string
デバイス名
resloveOption
int
アラートの解除オプション。0:解除不要、1:デバイスエンドでの解除のみをサポート、2:リモート解除のみをサポート、3:デバイスエンドまたはリモートでの解除
0:解除不要、10004:パスワードクラッキング、20002:Non-Living アタック(非生体による認証)、30001:デバイスオフラインアラート
1:デバイスエンドでの解除のみをサポート、10003:ドアセンサータイムアウト、20001:カメラの汚れ、10005 :(サポートされないアラートです。現在利用できません)、10006:サーモグラフィカメラ接続異常
3:デバイスエンドまたはリモートでの解除、10001:デバイスの盗難アラート、10002:ドア・ゲート強制突破アラート、20003:消防アラート
alarmPhoto
string
アラート写真
companyID
long
企業ID
description
string
アラートの説明
releaseTime
string
アラートの解除時間
status
int
アラートのステータス。1:アラート作動中、2:解除中、3:解除済み
パラメーター名
型
必須
説明
code
int
Yes
リターンコード。200 は成功を示し、その他のコードは失敗を示します
message
string
Yes
リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します
desc
string
No
リターンの説明
data
object
No
データ
パラメーター名
型
必須
説明
recognition_records_types
list<int>
Yes
認証レコードの異常のタイプ。0 - 正常な認証レコード、10001:IDカード不一致、10002:認証カード不一致、10003:認証コード不一致、20001:ビジターが有効期限外、20002:アクセス期限内ではない、30001:無効な ID カード、30002:無効な IC カード、30003:無効な QR コード、40001:異常な体温、50001:マスク着用なし
device_alarm_types
list<int>
Yes
アラートのタイプ。10001:デバイスの盗難アラート、10002:ドア・ゲート強制突破アラート、10003:ドアセンサータイムアウト、10004:パスワードクラッキング、10005:(サポートされないアラートです。現在利用できません)、10006:サーモグラフィカメラ接続異常、20001:カメラの汚れ、20002:Non-Living アタック(非生体による認証)、20003:消防アラート、30001:デバイスオフラインアラート、40001:特徴量抽出エラー
event_dest
string
Yes
イベントをサブスクライブする外部システムのサーバーアドレスを指定します。restful コールバックを利用し、http および https をサポートしています。スタイルは、http://ip:port/eventRcv または https://ip:port/eventRcv で、 最大 1,024 文字です。外部システムのサーバーアドレスは指定された仕様に基づいて申請したパーティーから提供されます。外部システムのインターフェースの認証は必要ありません
空の値で登録しないでください
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください。
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード。200 は成功を示し、その他のコードは失敗を示します
message
string
リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します
desc
string
リターンの説明
data
object
データ
パラメーター名
型
説明
recognition_records_types
list<int>
認識レコードタイプの配列
device_alarm_types
list<int>
デバイスアラートの配列
event_dest
string
イベントをサブスクライブする外部システムのサーバーアドレス
sub_status
int
サブスクリプションサービスのステータスです。0:構成されていません、1:正常、2:異常(最後のPushステータスに基づく)
code
メッセージ
説明
60001
openapi status error
OpenAPI 機能のステータスが利用可能であることをご確認ください(「利用中」または「変更のレビュー待ち」)
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード。200 は成功を示し、その他のコードは失敗を示します
message
string
リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します
desc
string
リターンの説明
data
object
データ
code
メッセージ
説明
60001
openapi status error
OpenAPI 機能のステータスが利用可能であることをご確認ください(「利用中」または「変更のレビュー待ち」)
60002
not config event sub
サブスクリプションサービスが構成されていません
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください。
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード。200 は成功を示し、その他のコードは失敗を示します
message
string
リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します
desc
string
リターンの説明
data
object
データ
パラメーター名
型
説明
recognition_records_types
list<int>
認証レコードの異常のタイプ。0 - 正常な認証レコード、10001:IDカード不一致、10002:認証カード不一致、10003:認証コード不一致、20001:ビジターが有効期限外、20002:アクセス期限内ではない、30001:無効な ID カード、30002:無効な IC カード、30003:無効な QR コード、40001:異常な体温、50001:マスク着用なし
device_alarm_types
list<int>
アラートのタイプ。10001:デバイスの盗難アラート、10002:ドア・ゲート強制突破アラート、10003:ドアセンサータイムアウト、10004:パスワードクラッキング、10005:(サポートされないアラートです。現在利用できません)、10006:サーモグラフィカメラ接続異常、20001:カメラの汚れ、20002:Non-Living アタック(非生体による認証)、20003:消防アラート、30001:デバイスオフラインアラート、40001:特徴量抽出エラー
event_dest
string
イベントをサブスクライブする外部システムのサーバーアドレス
sub_status
int
サブスクリプションサービスのステータスです。0:構成されていません、1:正常、2:異常(最後のPushステータスに基づく)
コード
メッセージ
説明
60001
openapi status error
OpenAPI 機能のステータスが利用可能であることをご確認ください(「利用中」または「変更のレビュー待ち」)
60002
not config event sub
サブスクリプションサービスが構成されていません
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード。200 は成功を示し、その他のコードは失敗を示します
message
string
リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します
desc
string
リターンの説明
data
object
リターンデータです。イベントサブスクリプションの詳細です
パラメーター名
型
説明
push_time
string
Push時間
status
int
リターンステータスです。200:成功、404:サーバー応答不可、500 : 内部例外
event_type_id
int
イベントタイプの ID です。30000:認証レコード、30100:アラートPush
event_message
string
Pushメッセージ本体
コード
メッセージ
説明
60001
openapi status error
OpenAPI 機能のステータスが利用可能であることをご確認ください(「利用中」または「変更のレビュー待ち」)
60002
not config event sub
サブスクリプションサービスが構成されていません
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
code
int
リターンコード。200 は成功を示し、その他のコードは失敗を示します
message
string
リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します
desc
string
リターンの説明
data
object
リターンデータ
コード
メッセージ
説明
60001
openapi status error
OpenAPI 機能のステータスが利用可能であることをご確認ください (「利用中」または「変更のレビュー待ち」)
60002
not config event sub
サブスクリプションサービスが構成されていません
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の章を参照してください |
timestamp | string | Yes | タイムスタンプ |
パラメーター名 | 型 | 説明 |
id | int | レコード ID |
userId | int | 認証されたユーザーの ID |
name | string | 認証されたユーザーの名前 |
direction | int | デバイスのアクセス方向 |
type | int | ユーザーの識別子タイプ |
verifyScore | float | 認証スコア |
receptionUserId | int | 認証されたユーザーの応対者の ID |
receptionUserName | string | 認証されたユーザーの応対者の名前 |
groups | list<group> | 認証されたユーザーのグループ情報 |
deviceName | string | デバイス名 |
sn | string | この認証レコードのデバイス LDID 番号をアップロードします |
signDate | string | 認証レコードの日付 |
avatar | string | 認証用顔写真 |
signAvatar | string | 認証時写真(サムネイル) |
signBgAvatar | string | 認証時写真(大) |
signTime | timestamp | 認証時間(秒) |
mobile | string | 認証されたユーザーの携帯電話番号 |
icNumber | string | 認証されたユーザーの IC カード番号 |
idNumber | string | 認証されたユーザーの ID 番号(利用できません) |
jobNumber | string | 認証されたユーザーの従業員ID |
remark | string | 特記事項 |
entryMode | int | 認証モード(1:顔認証、2:QR コード、3:カード、4:顔認証とカード、5:ID カード、6:顔認証と ID カード) |
signTimeZone | string | 認証レコードのタイムゾーン |
docPhoto | string | ID 写真 |
location | string | デバイスの設置場所 |
abnormalType | int | 認証レコードの異常のタイプ。0:なし、10001:IDカード不一致、10002:認証カード不一致、10003:認証コード不一致、20001:ビジターが有効期限外、20002:アクセス時間外、30001:無効な ID カード、30002:無効な IC カード、30003:無効な QR コード、40001:異常な体温、50001:マスク着用なし |
bodyTemperature | float | 体温 |
mask | int | マスク着用識別子。0:不明、0:着用なし、2:着用あり |
パラメーター名 | 型 | 説明 |
id | long | グループID |
name | string | グループ名 |
type | int | グループタイプ。1:従業員グループ、2:ビジターグループ、5:拒否リストグループ |
パラメーター名 | 型 | 説明 |
id | long | アラートレコードのID |
level | int | アラートレベル。1:アラート、2:異常 |
code | int | アラートのタイプ。10001:デバイスの盗難アラート、10002:ドアの強制開放、10003:ドアセンサータイムアウト、10004:パスワードクラッキング、10005:(サポートされないアラートです。現在利用できません)、10006:サーモグラフィカメラ接続異常、20001:カメラの汚れ、20002:Non-Living アタック(非生体による認証)、20003:消防アラート、30001:デバイスオフラインアラート、40001:特徴量抽出エラー |
description | string | アラートの説明 |
status | int | アラートのステータス。1:アラート作動中、2:解除中、3:解除済み |
traceId | string | アラートのシリアル番号。デバイスによって生成されるアラート固有の識別番号です |
deviceId | long | デバイスの ID |
deviceName | string | デバイス名 |
deviceSn | string | デバイスの LDID |
deviceLocation | string | デバイスの設置場所 |
alarmTime | string | アラート時間 |
releaseTime | string | アラートの解除時間 |
alarmPhoto | string | アラート写真 |
resloveOption | int | アラートの解除オプション。0:解除不要、1:デバイスエンドでの解除のみをサポート、2:リモート解除のみをサポート、3:デバイスエンドまたはリモートでの解除 0:解除不要 、10004:パスワードクラッキング、20002:Non-Living アタック(非生体による認証)、30001:デバイスオフラインアラート 1:デバイスエンドでの解除のみをサポート、10003:ドアセンサータイムアウト、20001:カメラの汚れ、10005: (サポートされないアラートです。現在利用できません)、10006:サーモグラフィカメラ接続異常 3:デバイスエンドまたはリモートでの解除、10001:デバイスの盗難アラート、10002:ドア・ゲート強制突破アラート、20003:消防アラート |
概要
部署リストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v2/department
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
department フィールドの説明
エラーレスポンスのフィールド
概要
部署コードから部署情報を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v2/department/search/code
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
部署 ID から部署情報を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v2/department/{id}
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
部署作成のインターフェースです。
リクエストアドレスの例
https://HOST:PORT/api/v2/department
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
部署インターフェースを更新します。
リクエストアドレスの例
https://HOST:PORT/api/v2/department/update
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
部署を削除します。
リクエストアドレスの例
https://HOST:PORT/api/v2/department/delete
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
概要
従業員を追加します。
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 フィールドの説明
エラーレスポンスのフィールド
APIでの登録者操作ではのレベル低実施されます。ご注意ください。
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
id
long
部署ID
name
string
部署名
parent_id
long
上位部署の ID。0 は企業を示します
leader_id
long
部署長の ID
leader_name
string
部署長の名前
user_num
int
部署内の人数
children
list<department>
下位部署のリスト
パラメーター名
型
説明
id
long
部署ID
name
string
部署名
parent_id
long
上位部署の ID。0 は企業を示します
leader_id
long
部署長の ID
leader_name
string
部署長の名前
user_num
int
部署内の人数
children
list<department>
下位部署のリスト
コード
メッセージ
説明
30001
Param Invalid
無効なパラメーターです
パラメーター名
型
必須
説明
code
string
Yes
部署コード。長さ制限は 45
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
id
long
部署ID
name
string
部署名
parent_id
long
上位部署の ID。0 は企業を示します
leader_id
long
部署長の ID
code
string
部署コード
コード
メッセージ
説明
30001
Param Invalid
無効なパラメーターです
パラメーター名
型
必須
説明
id
long
Yes
部署ID
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
id
long
部署ID
name
string
部署名
parent_id
long
上位部署の ID。0 は企業を示します
leader_id
long
部署長の ID
code
string
部署コード
コード
メッセージ
説明
30001
Param Invalid
無効なパラメーターです。部署IDが存在しません
パラメーター名
型
必須
説明
parentId
long
Yes
上位部署 ID
name
string
Yes
名前。長さ制限は 50。空の値で登録しないでください
leaderId
long
No
部署長の ID
code
string
No
部署コード。長さ制限は 45
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
id
long
部署ID
name
string
部署名
parent_id
long
上位部署の ID。0 は企業を示します
leader_id
long
部署長の ID
code
string
部署コード
コード
メッセージ
説明
30001
Param Invalid
上位の部署を選択ください
610
Similar record Exist
同じ名前の部署が同じレベルに存在します
620
Record non-existent Error
上位部署の ID が存在しません
30001
Param Invalid
無効なパラメーターです。部署名は空にはできません
30001
Param Invalid
無効なパラメーターです。部署長が存在しません
30001
Param Invalid
無効なパラメーターです。部署コードはすでに存在します
パラメーター名
型
必須
説明
id
long
Yes
部署ID
parentId
long
Yes
上位部署 ID。上位部署IDが存在しない場合、エラーとなる可能性があります。ご注意ください
name
string
Yes
名前。長さ制限は 50
leaderId
long
No
部署長の ID
code
string
No
部署コード。長さ制限は 45
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
説明
id
long
部署ID
name
string
部署名
parent_id
long
上位部署の ID。0 は企業を示します
leader_id
long
部署長の ID
code
string
部署コード
コード
メッセージ
説明
610
Similar record Exist
同じ名前の部署が同じレベルに存在します
620
Record non-existent Error
上位部署の ID が無効です(現在のノードの上位部署は指定できません)
30001
Param Invalid
無効なパラメーターです。上位部署の ID は空にはできません
30001
Param Invalid
無効なパラメーターです。上位部署の ID は存在しません
30001
Param Invalid
無効なパラメーターです。部署 ID は空にはできません
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
タイムスタンプ
コード
メッセージ
説明
610
Similar record Exist
部署にユーザーが存在しているため、部署を削除できません
610
Similar record Exist
部署に下位部署があります
620
Record non-existent Error
上位部署の ID が存在しません
パラメーター名 | 型 | 必須 | 説明 |
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 | 無効なパラメーターです |