MqttApiClient

MQTTインターフェースの実装

MqttApiClient

メンバー関数

説明

導入バージョン

void connectMqtt(IMqttActionListener listener, IConnectionLost connectionLost, boolean useTokenConnect, SocketFactory socketFactory)

MQTT接続

2.0.0

void disConnectMqtt(IMqttActionListener listener)

MQTT接続を切断

2.0.0

void getUserListInGroup(int groupId, MessageCallback callback)

あるグループでの登録者リストを取得

2.0.0

void registerGroupChangeListener(MessageCallback callback)

デバイスと登録者グループの変更コールバックを登録

2.0.0

void registerUserInGroupChangeListener(int groupId, MessageCallback callback)

登録者グループの登録者変更コールバックを登録

2.0.0

void registerWarningAction(MessageCallback callback)

アラームステータス変更コールバックを登録

2.0.0

void registerAccessStrategy(MessageCallback callback)

アクセスルール変更コールバックを登録

2.0.0

void registerUpgrade(MessageCallback callback)

APPとROMアップデートコールバックを登録

2.0.0

void registerDeviceStatus(MessageCallback callback)

デバイスステータスコールバックを登録

2.0.0

void registerDeviceConfig(MessageCallback callback)

デバイス構成変更コールバックを登録

2.0.0

void registerDeviceNotify(MessageCallback callback)

デバイスサーバエンドの通知配信構コールバックを登録

2.0.0

void registerKeepDoorOpenOrCloseSchedule

(MessageCallback callback)

デバイスのドア常時開/閉タイムテーブルの配信コールバックを登録

2.0.0

void unRegisterGroupChangeListener()

デバイスと登録者グループの変更コールバックの登録を取り消す

2.0.0

void unegisterUserInGroupChangeListener(int groupId)

登録者グループの登録者変更コールバックの登録を取り消す

2.0.0

void unegisterGetUserListInGroup(int groupId)

あるグループでの登録者リストの登録を取り消す

2.0.0

void unRegisterWarningActio()

アラームステータス変更コールバックの登録を取り消す

2.0.0

void [unRegisterAccessStrategy()

アクセスルール変更コールバックの登録を取り消す

2.0.0

void unRegisterUpgrade()

APPとROMアップデートコールバックの登録を取り消す

2.0.0

void unRegisterDeviceStatus()

デバイスステータスコールバックの登録を取り消す

2.0.0

void unRegisterDeviceConfig()

デバイス構成変更コールバックの登録を取り消す

2.0.0

void unRegisterDeviceNotify()

デバイスサーバエンドの通知配信構コールバック登録を取り消す

2.0.0

void unRegisterKeepDoorOpenOrCloseSchedule()

デバイスのドア常時開/閉タイムテーブルの配信コールバック登録を取り消す

2.0.0

メンバー関数の説明

void connectMqtt(IMqttActionListener listener, IConnectionLost connectionLost, boolean useTokenConnect, SocketFactory socketFactory)

MQTT接続

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

listener

IMqttActionListener

コールバック

なし

2.0.0

connectionLost

IConnectionLost

接続切断のコールバック

なし

2.0.0

useTokenConnect

boolean

トークンの方法で接続するかを判定

なし

2.0.0

socketFactory

SocketFactory

https構築するための検証方法

デフォルトとして証明書を検証しない

2.0.0

戻り値

なし

例外

なし

void disConnectMqtt(IMqttActionListener listener)

MQTT接続を切断

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

listener

IMqttActionListener

コールバック

なし

2.0.0

戻り値

なし

例外

なし

void getUserListInGroup(int groupId, MessageCallback callback)

あるグループでの登録者リストを取得

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

groupId

int

グループID

なし

2.0.0

callback

MessageCallback

コールバック

なし

2.0.0

戻り値

なし

例外

なし

void registerGroupChangeListener(MessageCallback callback)

デバイスと登録者グループの変更コールバックを登録

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

callback

MessageCallback

コールバック

なし

2.0.0

戻り値

なし

例外

なし

void registerUserInGroupChangeListener(int groupId, MessageCallback callback)

登録者グループの登録者変更コールバックを登録

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

groupId

int

グループID

なし

2.0.0

callback

MessageCallback

コールバック

なし

2.0.0

戻り値

なし

例外

なし

void registerWarningAction(MessageCallback callback)

アラートステータス変更コールバックを登録

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

callback

MessageCallback

コールバック

なし

2.0.0

戻り値

なし

例外

なし

void registerAccessStrategy(MessageCallback callback)

アクセスルール変更コールバックを登録

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

callback

MessageCallback

コールバック

なし

2.0.0

戻り値

なし

例外

なし

void registerUpgrade(MessageCallback callback)

APPとROMアップデートコールバックを登録

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

callback

MessageCallback

コールバック

なし

2.0.0

戻り値

なし

例外

なし

void registerDeviceStatus(MessageCallback callback)

デバイスステータスコールバックを登録

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

callback

MessageCallback

コールバック

なし

2.0.0

戻り値

なし

例外

なし

void registerDeviceConfig(MessageCallback callback)

デバイス構成変更コールバックを登録

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

callback

MessageCallback

コールバック

なし

2.0.0

戻り値

なし

例外

なし

void registerDeviceNotify(MessageCallback callback)

デバイスサーバエンドの通知配信構コールバックを登録

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

callback

MessageCallback

コールバック

なし

2.0.0

戻り値

なし

例外

なし

void registerKeepDoorOpenOrCloseSchedule(MessageCallback callback)

デバイスのドア常時開/閉タイムテーブルの配信コールバックを登録

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

callback

MessageCallback

コールバック

なし

2.0.0

戻り値

なし

例外

なし

void unRegisterGroupChangeListener()

デバイスと登録者グループの変更コールバックの登録を取り消す

パラメータ

なし

戻り値

なし

例外

なし

void unegisterUserInGroupChangeListener(int groupId)

登録者グループの登録者変更コールバックの登録を取り消す

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

groupId

int

グループID

なし

2.0.0

戻り値

なし

例外

なし

void unegisterGetUserListInGroup(int groupId)

あるグループでの登録者リストの登録を取り消す

パラメータ

パラメータ名

Type

説明

備考

導入バージョン

groupId

int

グループID

なし

2.0.0

戻り値

なし

例外

なし

void unRegisterWarningAction()

アラートステータス変更コールバックの登録を取り消す

パラメータ

なし

戻り値

なし

例外

なし

void unRegisterAccessStrategy()

アクセスルール変更コールバックの登録を取り消す

パラメータ

なし

戻り値

なし

例外

なし

void unRegisterUpgrade()

APPとROMアップデートコールバックの登録を取り消す

パラメータ

なし

戻り値

なし

例外

なし

void unRegisterDeviceStatus()

デバイスステータスコールバックの登録を取り消す

パラメータ

なし

戻り値

なし

例外

なし

void unRegisterDeviceConfig()

デバイス構成変更コールバックの登録を取り消す

パラメータ

なし

戻り値

なし

例外

なし

void unRegisterDeviceNotify()

デバイスサーバエンドの通知配信構コールバック登録を取り消す

パラメータ

なし

戻り値

なし

例外

なし

void unRegisterKeepDoorOpenOrCloseSchedule()

デバイスのドア常時開/閉タイムテーブルの配信コールバック登録を取り消す

パラメータ

なし

戻り値

なし

例外

なし

エンティティの説明

LanguageTypeEnum

プロパティの説明

Member

説明

備考

導入バージョン

ZH

中国語簡体字

なし

2.0.0

ZH_TW

中国語繁体字

なし

2.0.0

EN

English

なし

2.0.0

JP

日本語

なし

2.0.0

KO

韓国語

なし

2.0.0

ConnectConfigEntity

プロパティの説明

Member

Type

説明

備考

導入バージョン

account

String

アカウント

なし

2.0.0

password

String

パスワード

なし

2.0.0

identifier

String

デバイス識別子

なし

2.0.0

duid

String

デバイスSN

なし

2.0.0

token

String

デバイストークン

なし

2.0.0

ldid

String

デバイスバックグラウンドの識別番号

なし

2.0.0

companyId

int

企業ID

なし

2.0.0

isNewDevice

boolean

新規デバイスかを判定

なし

2.0.0

Result

プロパティの説明

Member

Type

説明

備考

導入バージョン

code

int

ステータスコード

なし

2.0.0

data

T

データ

なし

2.0.0

message

String

メッセージ

なし

2.0.0

desc

String

説明

なし

2.0.0

originData

String

オリジナルデータ

なし

2.0.0

rawData

byte[]

バイナリーデータ

なし

2.0.0

メソッドの説明

メンバー関数

説明

備考

導入バージョン

boolean isSuccess()

リクエストが成功したかどうか

true:成功

false:失敗

2.0.0

AlarmReportParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

traceId

String

アラートシリアルナンバー

なし

2.0.0

Y

alarmPhoto

String

アラート写真

なし

2.0.0

N

code

int

アラートコード

10001:解体盗難アラート

10002:ドア強行突破のアラート

10003:ドアマグネットのタイムオーバーアラート

10004:パスワード攻撃アラート 10005:Bluetooth電力不足 10006:サーマグラフィー接続以上

20001:カメラの汚れを意味

20002:非生体攻撃 20003:消防アラート

40001:フィーチャー抽出失敗

2.0.0

パラメータ"status"が1の場合、パラメータ"code"は必須。 そうでない場合は必須ではない

description

String

アラート説明

なし

2.0.0

N

eventTime

Long

イベント時間

ミリ秒

2.0.0

Y

status

int

アラートレポートイベント

1:アラートがあります 2:アラート解除失敗 3:アラート解除成功

2.0.0

Y

rectangle

List<VerticesItem>

顔枠の座標

1つ目は左上の座標

2つ目は右下の座標

2.0.0

N

userId

long

ユーザーID

なし

2.0.0

N

VerticesItem

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

x

int

x座標

なし

2.0.0

Y

y

int

y座標

なし

2.0.0

Y

GuestDetailInfo

プロパティの説明

Member

Type

説明

備考

導入バージョン

id

long

ビジターID

なし

2.0.0

avatar

String

比較対象のアバター

なし

2.0.0

showAvatar

String

アバター表示

なし

2.0.0

name

String

氏名

なし

2.0.0

groups

List<GroupsItem>

グループ

なし

2.0.0

mobile

String

連絡先

なし

2.0.0

guestCompany

String

ビジター企業

なし

2.0.0

birthday

String

誕生日

なし

2.0.0

position

String

役職

なし

2.0.0

idNumber

String

IDナンバー

なし

2.0.0

icNumber

String

ICカードナンバー

なし

2.0.0

mail

String

メールアドレス

なし

2.0.0

guestPurpose

String

来訪目的

なし

2.0.0

receptionUserId

long

受付担当者ユーザーID

なし

2.0.0

receptionUserName

String

受付担当者ユーザー名

なし

2.0.0

dateTimeFrom

String

来訪有効の開始時間

なし

2.0.0

dateTimeTo

String

来訪有効の終了時間

なし

2.0.0

level

int

レベル

なし

2.0.0

remark

String

特記事項

なし

2.0.0

GroupsItem

プロパティの説明

Member

Type

説明

備考

導入バージョン

id

int

グループID

なし

2.0.0

name

String

グループ名

なし

2.0.0

type

int

グループタイプ

1:登録者グループ

2:ビジターグループ

5:拒否リストグループ

2.0.0

personCount

int

人数

なし

2.0.0

TslCheckExistResult

プロパティの説明

Member

Type

説明

備考

導入バージョン

flag

int

フラッグ

0:存在しない 1:存在

2.0.0

TslLanguageCheckExistResult

プロパティの説明

Member

Type

説明

備考

導入バージョン

flag

int

フラッグ

0:存在しない 1:存在

2.0.0

md5

String

File md5

なし

2.0.0

FaceSearchResult

プロパティの説明

Member

Type

説明

備考

導入バージョン

searchResult

List<SearchResultItem>

検索結果

なし

2.0.0

gateCtrl

boolean

ドアオープンかを判定

なし

2.0.0

timestamp

long

クライアントがリクエストした際のアップロードタイムスタンプ

なし

2.0.0

passRuleType

int

アクセスルールのタイプ

0: ローカルアクセスルール

1: サーバでのアクセスルール

2.0.0

sign

String

md5

The md5 Value of {timestamp}-{ldid}-{gateCtrl}-{passRuleType}

2.0.0

SearchResultItem

プロパティの説明

Member

Type

説明

備考

導入バージョン

faceCutImage

Content

顔のカット写真

なし

2.0.0

score

float

認識スコア

なし

2.0.0

userId

int

ユーザーID

なし

2.0.0

userCardId

String

ユーザーのドアアクセスカードID

なし

2.0.0

userImage

Content

ユーザーライブラリ画像

なし

2.0.0

trackId

int

顔追跡id

なし

2.0.0

userName

String

ユーザー名

なし

2.0.0

displayMsg

String

表示メッセージ

なし

2.0.0

displayColor

String

表示カラー

なし

2.0.0

verifyCode

int

認証ステータスコード

1:未認証

2:認証済み

3:権限なし

4:マッチング失敗

5:アクセスタイムテーブル時間外

2.0.0

type

int

タイプ

なし

2.0.0

idNumber

String

IDナンバー

なし

2.0.0

sign

String

md5

the md5 Value of {verifyCode}-{timestamp}-{ldid}-{userId}

2.0.0

extra

String

拡張フィールドString

なし

2.0.0

Content

プロパティの説明

Member

Type

説明

備考

導入バージョン

data

String

オリジナル図データ

このdataかurlを選択

2.0.0

format

String

図のタイプ

IMAGE_UNKNOWN, IMAGE_JPEG, IMAGE_PNG, IMAGE_BMP, IMAGE_TIFF, IMAGE_GIF

2.0.0

url

String

図のurl

このurlかdataを選択

2.0.0

FaceSearchParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

targetImages

ImagesItem

小さい画像スナップショットの配列

フルサイズの画像をアップロードすれば、小さい画像は不要

2.0.0

N

extraInfo

String

拡張フィールドString

なし

2.0.0

N

receiveTime

long

タイムスタンプを受信

ミリ秒

2.0.0

N

fullImage

Content

フルサイズ画像

小さい画像スナップショットをアップロードすれば、フルサイズの画像は不要

2.0.0

Y

captureTime

long

スナップショットのタイプスタンプ

ミリ秒

2.0.0

N

cameraInfo

CameraInfo

カメラの共通情報

なし

2.0.0

N

timestamp

long

タイムスタンプ

ミリ秒

2.0.0

N

ImagesItem

プロパティの説明

Member

Type

説明

備考

導入バージョン

detectionMode

String

検知モード

DETECT_MODE_AUTO:TargetAnnotation.rectangleとスナップショットのサイズに従って自動的に検知枠を選択。 DETECT_MODE_BOUNDING_ONLY:TargetAnnotation.rectangleのみ使用。Rectangleを渡さないとなりません。そうでない場合、無効targetになりる。 DETECT_MODE_FORCE_DETECTION:検知のために検知モードの利用が必須となる

2.0.0

targetInfo

TargetInfo

共通スナップショット目標情報の構造

なし

2.0.0

content

Content

画像コンテンツ

なし

2.0.0

imageType

int

画像タイプ

1:RGB図

2:IR図

2.0.0

mask

int

マスクをつけるかどうか

0:未受渡し

1:未着用

2:着用済

2.0.0

bodyTemperature

float

温度

なし

2.0.0

TargetInfo

プロパティの説明

Member

Type

説明

備考

導入バージョン

trackId

int

Track ID

なし

2.0.0

angle

Angle

顔角度の情報

なし

2.0.0

rectangle

Rectangle

顔枠

なし

2.0.0

landmarks

List<LandmarksItem>

オブジェクトのキーポイント座標

なし

2.0.0

quality

float

ターゲットの検知品質

[0.0, 1.0]

2.0.0

Angle

プロパティの説明

Member

Type

説明

備考

導入バージョン

roll

int

顔の傾き角度

なし

2.0.0

pitch

int

顔の上向き・下向き角度

なし

2.0.0

yaw

int

顔の回る角度

なし

2.0.0

Rectangle

プロパティの説明

Member

Type

説明

備考

導入バージョン

vertices

List<VerticesItem>

ターゲットの矩形エリア

左上の座標

右下の座標

2.0.0

VerticesItem

プロパティの説明

Member

Type

説明

備考

導入バージョン

x

int

X座標

なし

2.0.0

y

int

Y座標

なし

2.0.0

LandmarksItem

プロパティの説明

Member

Type

説明

備考

導入バージョン

x

int

X座標

なし

2.0.0

y

int

Y座標

なし

2.0.0

CameraInfo

プロパティの説明

Member

Type

説明

備考

導入バージョン

placeName

String

カメラが所在するエリア名

なし

2.0.0

deviceId

String

カメラハードウェアID

なし

2.0.0

tollgateId

String

カメラが所在するトールゲートID

なし

2.0.0

tollgateName

String

カメラが所在するトールゲート名

なし

2.0.0

cameraId

String

カメラID

なし

2.0.0

deviceType

String

カメラのハードウェアタイプ

なし

2.0.0

placeCode

String

カメラが所在するエリアのコード

なし

2.0.0

GroupIndex

プロパティの説明

Member

Type

説明

備考

導入バージョン

updatedAt

long

更新したタイムスタンプ

なし

2.0.0

groupId

int

グループID

なし

2.0.0

groupName

String

グループ名

なし

2.0.0

createdAt

long

生成したタイムスタンプ

なし

2.0.0

UserIndex

プロパティの説明

Member

Type

説明

備考

導入バージョン

userUpdatedAt

long

ユーザーの更新時間

なし

2.0.0

userId

int

ユーザーID

なし

2.0.0

UserInfoResult

プロパティの説明

Member

Type

説明

備考

導入バージョン

birthday

String

誕生日

なし

2.0.0

modelVersion

String

モデルバージョン

なし

2.0.0

mail

String

メールアドレス

なし

2.0.0

gender

int

性別

0:不明

1:女性

2:男性

userName

String

ユーザー名

なし

2.0.0

phoneSuffix

String

携帯番号サフィックス

なし

2.0.0

createdAt

long

生成のタイムスタンプ

なし

2.0.0

remark

String

特記事項

なし

2.0.0

addChannel

int

追加チャネル

1:Web

2:SenseID

3:QR コード

4:OpenAPI

5: SenseHi App改変

6:バッチ処理ツール

type

int

ユーザータイプ

1:登録者

2:ビジター

3:拒否リスト

avatarShow

String

アート写真ID

なし

2.0.0

dateTimeTo

long

終了タイムスタンプ

なし

2.0.0

guestCompany

String

ビジター企業

なし

2.0.0

guestLevel

String

ビジターレベル

なし

2.0.0

feature

String

顔フィーチャー

なし

2.0.0

updatedAt

long

更新タイムスタンプ

なし

2.0.0

jobNumber

String

従業員番号

なし

2.0.0

icNumber

String

ICカードナンバー

なし

2.0.0

dateTimeFrom

long

開始タイムスタンプ

なし

2.0.0

entryTime

long

アクセス時間

なし

2.0.0

idNumber

String

IDナンバー

なし

2.0.0

companyId

int

ユーザー企業ID

なし

2.0.0

departmentId

int

ユーザー部署ID

なし

2.0.0

departmentName

String

部署名

なし

2.0.0

areaCode

String

エリアコード

なし

2.0.0

mobile

String

携帯番号

なし

2.0.0

permission

int

アクセス許可

0:許可

1:不許可

2.0.0

receptionUserId

int

ビジター受付のユーザーid

なし

2.0.0

avatar

String

アバターID

なし

2.0.0

countryCode

String

国・地域コード

なし

2.0.0

staffType

int

スタッフタイプ

1:従業員

2:インターン

2.0.0

userId

int

ユーザーID

なし

2.0.0

guestPurpose

String

来訪目的

なし

2.0.0

location

String

場所

なし

2.0.0

position

String

役職

なし

2.0.0

placeCode

String

地域コード

なし

2.0.0

prompt

String

カスタマイズメッセージ

なし

2.0.0

UserInfoParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

userIds

List

ユーザーID配列

1回最大20,000配列

2.0.0

modelVersion

String

モデルバージョン

なし

2.0.0

DeviceGroups

プロパティの説明

Member

Type

説明

備考

導入バージョン

id

String

デバイスID

なし

2.0.0

userGroups

List<GroupsItem>

ユーザーグループ

なし

2.0.0

guestGroups

List<GroupsItem>

ビジターグループ

なし

2.0.0

denyListGroup

List<GroupsItem>

拒否リストグループ

なし

2.0.0

DeviceDetailInfo

プロパティの説明

Member

Type

説明

備考

導入バージョン

deviceTypeMaxOnline

DeviceTypeMaxOnline

デバイスタイプの最大オンライン数

なし

2.0.0

ldid

String

デバイスLDID

なし

2.0.0

typeName

String

デバイスタイプ名

なし

2.0.0

userGroup

List<GroupsItem>

ユーザーグループ

なし

2.0.0

guestGroup

List<GroupsItem>

ビジターグループ

なし

2.0.0

typeId

int

デバイスタイプID

なし

2.0.0

name

String

デバイス名

なし

2.0.0

説明

String

デバイス説明情報

なし

2.0.0

location

String

デバイスロケーション

なし

2.0.0

id

int

デバイスID

なし

2.0.0

state

int

デバイス状態

0:オフライン

1:オンライン

2.0.0

direction

int

デバイスのInとOut方向

0:デフォルト

1:In

2:Out

2.0.0

DeviceTypeMaxOnline

プロパティの説明

Member

Type

説明

備考

導入バージョン

companyId

int

デバイスの所属する企業ID

なし

2.0.0

serviceConfig

List<ServiceConfigItem>

サーバ構成

なし

2.0.0

typeId

int

デイバイスの所属するタイプID

なし

2.0.0

maxOnlineNum

int

デバイスの同時オンライン最大数

なし

2.0.0

ServiceConfigItem

プロパティの説明

Member

Type

説明

備考

導入バージョン

name

String

デバイス名

なし

2.0.0

options

List<Options>

カスタマイズオプション

なし

2.0.0

id

String

デバイスID

なし

2.0.0

Options

プロパティの説明

Member

Type

説明

備考

導入バージョン

text

String

テキストフィールド

なし

2.0.0

value

String

対応するコンテンツ

なし

2.0.0

Company

プロパティの説明

Member

Type

説明

備考

導入バージョン

guestGroupId

int

ビジターグループID

なし

2.0.0

validFrom

String

有効開始時間

なし

2.0.0

createBy

String

作成者ID

なし

2.0.0

background

String

背景

なし

2.0.0

contact

String

連絡者

なし

2.0.0

validTo

String

有効終了時間

なし

2.0.0

name

String

企業名

なし

2.0.0

updateAt

String

更新時間

なし

2.0.0

logo

String

企業ロゴ

なし

2.0.0

id

int

企業ID

なし

2.0.0

createAt

String

作成時間

なし

2.0.0

welcome

String

挨拶メッセージ

なし

2.0.0

introduction

String

企業案内

なし

2.0.0

userGroupId

int

ユーザーグループID

なし

2.0.0

RsaResult

プロパティの説明

Member

Type

説明

備考

導入バージョン

empoent

String

e1

なし

2.0.0

module

String

素数積

なし

2.0.0

rsaId

String

Key ID

なし

2.0.0

UserDetailInfo

プロパティの説明

Member

Type

説明

備考

導入バージョン

birthday

String

誕生日

なし

2.0.0

icNumber

String

ICカードナンバー

なし

2.0.0

entryTime

String

アクセス時間

なし

2.0.0

idNumber

String

IDナンバー

なし

2.0.0

mail

String

メールアドレス

なし

2.0.0

areaCode

String

地域コード

なし

2.0.0

phoneSuffix

String

携帯番号サフィックス

なし

2.0.0

mobile

String

携帯番号

なし

2.0.0

groups

List<GroupsItem>

グループ情報

なし

2.0.0

remark

String

特記事項

なし

2.0.0

avatar

String

アバターID

なし

2.0.0

avatarShow

String

アート写真ID

なし

2.0.0

countryCode

String

国・地域コード

なし

2.0.0

name

String

ユーザー名

なし

2.0.0

location

String

場所

なし

2.0.0

departmentRoute

List<DeptItem>

部署

なし

2.0.0

id

long

ユーザーID

なし

2.0.0

position

String

役職

なし

2.0.0

jobNumber

String

従業員番号

なし

2.0.0

placeCode

String

場所コード

なし

2.0.0

department

int

部署ID

なし

2.0.0

prompt

String

カスタムメッセージ

なし

2.0.0

DeptItem

プロパティの説明

Member

Type

説明

備考

導入バージョン

name

String

部署名

なし

2.0.0

id

int

部署ID

なし

2.0.0

type

int

部署タイプ

なし

2.0.0

ServerVersion

プロパティの説明

Member

Type

説明

備考

導入バージョン

date

String

日付

for example 20190815

2.0.0

edition

String

バージョン

for example 1.11.0.2

2.0.0

provider

String

プロバイダー

ST-BI, ST-JCV

2.0.0

product

String

プロダクト名

SenseLink, SenseLink GE

2.0.0

coreEdition

String

coreバージョン

なし

2.0.0

appEdition

String

アプリで表示するバージョン番号

なし

2.0.0

TimeTable

プロパティの説明

Member

Type

説明

備考

導入バージョン

id

long

アクセスルールID

なし

2.0.0

ruleId

long

ルールID

なし

2.0.0

name

String

アクセスタイムテーブル名

なし

2.0.0

groupId

int

アクセスグループID

なし

2.0.0

monday

String

月曜日24hアクセスルール

なし

2.0.0

mondayPeriod

String

月曜日アクセスタイムテーブル

なし

2.0.0

tuesday

String

火曜日24hアクセスルール

なし

2.0.0

tuesdayPeriod

String

火曜日アクセスタイムテーブル

なし

2.0.0

wednesday

String

水曜日24hアクセスルール

なし

2.0.0

wednesdayPeriod

String

水曜日アクセスタイムテーブル

なし

2.0.0

thursday

String

木曜日24hアクセスルール

なし

2.0.0

thursdayPeriod

String

木曜日アクセスタイムテーブル

なし

2.0.0

friday

String

金曜日24hアクセスルール

なし

2.0.0

fridayPeriod

String

金曜日アクセスタイムテーブル

なし

2.0.0

saturday

String

土曜日24hアクセスルール

なし

2.0.0

saturdayPeriod

String

土曜日アクセスタイムテーブル

なし

2.0.0

sunday

String

日曜日24hアクセスルール

なし

2.0.0

sundayPeriod

String

日曜日アクセスタイムテーブル

なし

2.0.0

holiday

String

休日24hアクセスルール

なし

2.0.0

holidayPeriod

String

休日アクセスタイムテーブル

なし

2.0.0

startTimestamp

long

開始タイムスタンプ

ミリ秒

2.0.0

endTimestamp

long

終了タイムスタンプ

ミリ秒

2.0.0

specialDayList

List<SpecialDay>

特別日

なし

2.0.0

SpecialDay

プロパティの説明

Member

Type

説明

備考

導入バージョン

id

long

特別日ID

なし

2.0.0

date

String

日付

なし

2.0.0

remark

String

特記事項

なし

2.0.0

QRResult

プロパティの説明

Member

Type

説明

備考

導入バージョン

entryTimeLeft

int

残りアクセス可能回数

なし

2.0.0

entryHint

String

通行メッセージ

なし

2.0.0

idNumber

String

IDナンバー

なし

2.0.0

userId

int

ユーザーID

なし

2.0.0

userImage

Content

ユーザーライブライ写真

なし

2.0.0

userCardId

String

ユーザーのドアアクセスカードID

なし

2.0.0

userName

String

ユーザー名

なし

2.0.0

entryStatus

int

ステータスコード

1:通過

2:QRコード不正

3:QRコード解析失敗

4:QRコードコンテンツエラー

5:QRコード無効

6:QRコードが有効期間外

7:QRコードに通行回数なし

8:QRコードが対応する人物が無効

2.0.0

sign

String

md5

The md5 Value of {entryStatus}-{timestamp}-{ldid}-{userId}-{passRuleType}

2.0.0

type

int

ユーザータイプ

1:登録者

2:ビジター

3:未登録者

4:非生体

5:拒否リスト

2.0.0

timestamp

long

クライアントがアップロードするタイムスタンプ

なし

2.0.0

passRuleType

int

アクセスルールコントロールのタイプ

なし

2.0.0

IdentifyQRCodeParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

content

String

QRコードコンテンツ

なし

2.0.0

Y

timestamp

long

タイムスタンプ

なし

2.0.0

Y

LoginResult

プロパティの説明

Member

Type

説明

備考

導入バージョン

defaultUserGroupId

int

デフォルトユーザーグループID

なし

2.0.0

role

int

ロール

なし

2.0.0

companyId

int

企業ID

なし

2.0.0

defaultGuestGroupId

int

デフォルトユーザーグループID

なし

2.0.0

threshold

int

顔検知しきい値

なし

2.0.0

newDeviceKey

boolean

新規デバイス

なし

2.0.0

token

String

トークン

なし

2.0.0

deviceTypeMaxOnline

DeviceTypeMaxOnline

最大のオンラインデバイス情報

なし

2.0.0

accountId

int

アカウントID

なし

2.0.0

name

String

氏名

なし

2.0.0

userRspVO

UserRspVO

ユーザー情報

なし

2.0.0

company

Company

企業情報

なし

2.0.0

lang

String

言語

なし

2.0.0

device

Device

デバイス情報

なし

2.0.0

account

String

アカウント名

なし

2.0.0

UserRspVO

プロパティの説明

Member

Type

説明

備考

導入バージョン

birthday

String

誕生日

なし

2.0.0

icNumber

String

ICカードナンバー

なし

2.0.0

entryTime

String

入社日

なし

2.0.0

idNumber

String

IDナンバー

なし

2.0.0

mail

String

メールアドレス

なし

2.0.0

areaCode

String

場所コード

なし

2.0.0

phoneSuffix

String

携帯番号サフィックス

なし

2.0.0

mobile

String

携帯番号

なし

2.0.0

groups

List<GroupsItem>

ユーザーグループID

なし

2.0.0

remark

String

特記事項

なし

2.0.0

avatar

String

アバターID

なし

2.0.0

avatarShow

String

アート写真ID

なし

2.0.0

countryCode

String

国・地域コード

なし

2.0.0

name

String

氏名

なし

2.0.0

departmentRoute

List<DepartmentRouteItem>

部署

なし

2.0.0

location

String

場所

なし

2.0.0

id

Integer

ユーザーID

なし

2.0.0

jobNumber

String

従業員番号

なし

2.0.0

placeCode

String

地域コード

なし

2.0.0

position

String

役職

なし

2.0.0

department

Integer

部署ID

なし

2.0.0

DepartmentRouteItem

プロパティの説明

Member

Type

説明

備考

導入バージョン

name

String

部署名

なし

2.0.0

id

int

部署ID

なし

2.0.0

type

int

部署タイプ

なし

2.0.0

Device

プロパティの説明

Member

Type

説明

備考

導入バージョン

ldid

String

デバイスUDID

なし

2.0.0

companyId

int

デバイスの所属する企業ID

なし

2.0.0

typeId

int

デバイスタイプ

なし

2.0.0

name

String

デバイ名

なし

2.0.0

updateAt

String

更新時間

なし

2.0.0

description

String

説明

なし

2.0.0

location

String

デバイス場所

なし

2.0.0

id

int

デバイスID

なし

2.0.0

softwareVersion

String

デバイスソフトウエアのバージョン

なし

2.0.0

createAt

String

作成時間

なし

2.0.0

direction

int

デバイスInとOutの方向

なし

2.0.0

info

String

情報

なし

2.0.0

MisrecognitionRecordParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

recordId

String

識別レコードid

なし

2.0.0

type

int

誤認識タイプ

1:別人 2:未登録者

3:非生体

4:未登録者アタック

5:非生体アタック

2.0.0

content

String

特記事項

なし

2.0.0

RegisterResult

プロパティの説明

Member

Type

説明

備考

導入バージョン

ldid

String

デバイスLDID

なし

2.0.0

companyId

int

デバイスの所属する企業ID

なし

2.0.0

typeId

int

デバイスタイプID

なし

2.0.0

name

String

デバイス

なし

2.0.0

updateAt

String

更新時間

なし

2.0.0

description

String

デバイス説明

なし

2.0.0

location

String

デバイス場所

なし

2.0.0

id

int

デバイスID

なし

2.0.0

softwareVersion

String

デバイスソフトウエアのバージョン

なし

2.0.0

createAt

String

作成時間

なし

2.0.0

direction

int

デバイスInとOutの方向

なし

2.0.0

info

String

デバイスInfo

なし

2.0.0

RegisterParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

name

String

デバイスName

なし

2.0.0

Y

direction

int

デバイス方向

0:デフォルト

1:In

2:Out

2.0.0

Y

location

String

デバイス場所説明

なし

2.0.0

N

description

String

デバイス説明

なし

2.0.0

N

softwareVersion

String

ソフトウェアのバージョン

なし

2.0.0

N

info

String

その他の情報

なし

2.0.0

N

UserStatusParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

exceptionList

List<ExceptionListItem>

例外リスト

なし

2.0.0

verifyModelVersion

String

検証モデルバージョン

なし

2.0.0

totalUserCount

int

ユーザー総数

なし

2.0.0

ExceptionListItem

プロパティの説明

Member

Type

説明

備考

導入バージョン

code

int

ステータスコード

なし

2.0.0

userId

int

ユーザーID

なし

2.0.0

UserSyncStatusParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

statusList

List<UserStatusListItem>

ユーザーステータスリスト

なし

2.0.0

Y

verifyModelVersion

String

検証モードバージョン

なし

2.0.0

Y

totalUserCount

int

ユーザー総数

なし

2.0.0

Y

action

int

タイプ

0:デバイスの全ユーザーステータスをアップロード

1:デバイスの異常ユーザーステータスをアップロード

2.0.0

Y

UserStatusListItem

プロパティの説明

Member

Type

説明

備考

導入バージョン

status

int

ステータスコード

1:同期中、 2:ノーマルフィーチャー、 3:画像ダウンロード失敗、 4:画像解析失敗、 5:フィーチャー抽出失敗

2.0.0

userIds

int[]

ユーザーID配列

なし

2.0.0

DeviceReportEventParamer

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

type

int

イベントタイプ

1:ドアマグネットイベント

2:Bluetooth電力

3:サーモグラフィーステータス

2.0.0

Y

content

BaseDeviceReportEventContent

イベントに対応するコンテンツ

1: DoorMagnetismReportEventContent

2: BluetoothReportEventContent

3: ThermalImagerReportEventContent

2.0.0

Y

DoorMagnetismReportEventContent

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

status

int

イベントのステータス

1:ON

2:OFF

3:なし

2.0.0

Y

timestamp

long

イベント発生時間

ミリ秒

2.0.0

Y

BluetoothReportEventContent

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

power

int

バッテリーの残量

0-100

2.0.0

Y

ThermalImagerReportEventContent

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

status

int

イベントのステータス

0:不明

1:接続済

2:未接続

2.0.0

Y

RecordResult

プロパティの説明

Member

Type

説明

備考

導入バージョン

recordId

String

レコードID

なし

2.0.0

RecordParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

userId

int

ユーザーID

なし

2.0.0

N

username

String

ユーザー名

なし

2.0.0

N

signAvatar

String

顔写真

なし

2.0.0

N

signBgAvatar

String

バックグラウンド図

なし

2.0.0

N

signTime

long

打刻時間

なし

2.0.0

Y

type

int

従業員タイプ

1:登録者

2:ビジター

3:未登録者

4:非生体

999: その他

2.0.0

Y

abnormalType

int

異常レコードタイプ

0:なし

10001:人物とIDがマッチしない

10002:人物とカードがマッチしない

10003:人物とコードがマッチしない

20001:ビジターは有効期間外 20002:アクセスタイムテーブル時間外

30001:無効なIDカード

30002:無効なICカード

30003:無効なQRコード

2.0.0

N

idNumber

String

IDナンバー

なし

2.0.0

N

icNumber

String

社員カード

なし

2.0.0

N

idInfo

String

IDカードのその他の情報

Json String

2.0.0

N

inTime

int

すぐアップロードするか

はい:1

いいえ:0

2.0.0

Y

mode

int

デバイスモード

1:顔認証かカード

2:顔認証+カード

3:顔認証かIDカード

4:顔認証+ID Card

5:顔認証+IDカードによる予約

6:顔認証かQRコード

7:顔認証とQRコード

8:Bluetooth

9:顔認証

10:顔認証かQRコードかカード

2.0.0

Y

rectangle

List<VerticesItem>

顔枠

左上の座標、右下の座標

2.0.0

N

entryMode

int

アクセスモード

1:顔認証

2:QRコード

3:カード

4:顔認証+カード

5:IDカード

6:顔認証+IDカード

7:顔認証+IDカードによる予約

8:顔認証かつQRコード

9:Bluetooth

2.0.0

N

pushOption

int

レコード配信

1:はい

0:いいえ

2.0.0

N

wearMaskType

int

マスクステータス

0:ステータスなし(マスク検知オフ)

1:マスク未着用 2:マスク着用中

2.0.0

N

verifyScore

float

認識スコア

なし

2.0.0

N

docPhoto

String

IDカード写真

なし

2.0.0

N

heatAvatar

String

ヒートマップ

なし

2.0.0

N

bodyTemperature

float

温度

なし

2.0.0

N

remark

String

特記事項

なし

2.0.0

N

DeviceVersionInfoParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

apkVersionName

String

apkバージョン名

なし

2.0.0

Y

romHardwareVersion

String

ROMハードウエアバージョン

なし

2.0.0

Y

apkVersionCode

String

apkバージョンコード

なし

2.0.0

Y

packageName

String

パッケージ名

なし

2.0.0

Y

model

String

モデル

なし

2.0.0

Y

serialNumber

String

デバイスシリアルナンバー

なし

2.0.0

Y

romSoftwareVersion

String

ROMソフトウエアバージョン

なし

2.0.0

Y

manufacturer

String

メーカー

なし

2.0.0

Y

IdentifyDataParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

images

List<ImagesItem>

日付

なし

2.0.0

depth

Depth

Depthデータ

なし

2.0.0

userId

int

ユーザーID

なし

2.0.0

recordId

int

レコードid

なし

2.0.0

type

int

データタイプ

1:ライブラリーでの人物

2:未登録者

3:生体

4:非生体

2.0.0

Depth

プロパティの説明

Member

Type

説明

備考

導入バージョン

data

String

Depthデータコンテンツ

なし

2.0.0

width

int

Depthデータ幅

なし

2.0.0

height

int

Depthデータ高さ

なし

2.0.0

TslUploadParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

content

String

Tsl json String

なし

2.0.0

Y

TslLanguageUploadParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

必須

content

String

言語パッケージコンテンツ

なし

2.0.0

Y

lang

String

言語

en,zh,zh-tw

2.0.0

Y

MessageParameter

プロパティの説明

Member

Type

説明

備考

導入バージョン

mobile

String

携帯番号

なし

2.0.0

areaCode

String

地域コード

なし

2.0.0

event

MessageEventEnum

イベント

なし

2.0.0

captcha

String

認証コード

なし

2.0.0

MessageEventEnum

プロパティの説明

Member

説明

備考

導入バージョン

LOGIN

ログイン

なし

2.0.0

CHANGE_INFO

変更情報

なし

2.0.0

VALIDATE

検証

なし

2.0.0

IConnectionLost

メソッドの説明

メンバー関数

説明

備考

導入バージョン

void onConnectionLost(Throwable cause)

接続が失われた際のコールバック

なし

2.0.0

MessageCallback

メソッドの説明

メンバー関数

説明

備考

導入バージョン

void success(MqttMessage msg)

情報受信のコールバック

なし

2.0.0

void error(int code, String msg, Throwable throwable)

失敗時のコールバック

なし

2.0.0

最終更新