Initialize LinkSDK, set network request parameters
Member Function
Description
Version Introduced
boolean isCAVerify()
get CA Verification
Get CA Verification
Parameter
None
Return
Exception
None
Get Connect Timeout
Parameter
None
Return
Connect Timeout (millisecond precision)
Exception
None
Get Read Timeout
Parameter
None
Return
Read Timeout (millisecond precision)
Exception
None
Get Write Timeout
Parameter
None
Return
Write Timeout (millisecond precision)
Exception
No
Add Interceptor
Parameter
Return
Current Object
Exception
None
Get Language Type
Parameter
None
Return
LanguageTypeEnum
Exception
None
Initialize
Parameter
Return
Current Object
Exception
None
Set URL
Parameter
Return
Current Object
Exception
None
set CA Verification
Parameter
Return
Current Object
Exception
None
Set Connect Timeout
Parameter
Return
Current Object
Exception
None
Set read timeout
Parameter
Return
Current Object
Exception
None
Set Write timeout
Parameter
Return
Current Object
Exception
None
BatchAdd interceptors
Parameter
Return
Current Object
Exception
None
Get Interceptor List
Parameter
None
Return
Interceptor List
Exception
None
Set Language Type
Parameter
Return
Current Object
Exception
None
Get URL
Parameter
None
Return
Server Address
Exception
None
2.0.0
int getConnectTimeout()
get Connect Timeout
2.0.0
int getReadTimeout()
get Read Timeout
2.0.0
int getWriteTimeout()
get Write Timeout
2.0.0
LinkSDKHelper addInterceptor(Interceptor interceptor)
add Interceptor
2.0.0
LanguageTypeEnum getLanguageType()
get Language Type
2.0.0
LinkSDKHelper init(String url,Context context)
Initialization
2.0.0
LinkSDKHelper setUrl(String url)
Set URL
2.0.0
LinkSDKHelper setCAVerify(boolean caVerify)
set CA Verification
2.0.0
LinkSDKHelper setConnectTimeout(int connectTimeout)
set Connect Timeout
2.0.0
LinkSDKHelper setReadTimeout(int readTimeout)
set Read Timeout
2.0.0
LinkSDKHelper setWriteTimeout(int writeTimeout)
set Write Timeout
2.0.0
LinkSDKHelper setInterceptorList(List interceptorList)
Batch Add Interceptor
2.0.0
List getInterceptorList()
get Interceptor List
2.0.0
LinkSDKHelper setLanguage(LanguageTypeEnum type)
set Language Type
2.0.0
String getUrl()
Get URL
2.0.0
Returned Value
Description
Version Introduced
true
All network connections will verify the CA certificate
2.0.0
false
All network connections will not verify the CA certificate
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
interceptor
Interceptor
Interceptor
okhttp Interceptor
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
url
String
server address
None
2.0.0
context
Context
Context
None
Parameter Name
Type
Description
Note
Version Introduced
url
String
server address
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
caVerify
boolean
set CA Verification
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
connectTimeout
int
Connect Timeout
millisecond precision
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
readTimeout
int
read Timeout
millisecond precision
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
writeTimeout
int
write Timeout
millisecond precision
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
interceptorList
List
Interceptor List
Okhttp Interceptor
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
type
LanguageTypeEnum
Language Type
None
2.0.0
2.0.0
HTTP interface implementation
Member Function
Description
Version Introduced
byte[] getImage(int type, String imageId)
Get Image Data
Get Image Data
Parameter
Return
Image Data
Exception
None
Get Current Connection Configuration
Parameter
None
Return
ConnectConfigEntity
Exception
None
Alarm Report
Parameter
Return
Result
Exception
None
Bind Default Group
Parameter
None
Return
Result
Exception
No
Check Password
Parameter
Return
Result
Exception
None
Check Tsl Exist
Parameter
Return
Result<TslCheckExistResult>
Exception
None
Check Tsl Language Exist
Parameter
Return
Result<TslLanguageCheckExistResult>
Exception
None
Server Identification
Parameter
Return
Result<FaceSearchResult>
Exception
None
Get Group Index List Bound to the device
Parameter
None
Return
Result<GroupIndex>
Exception
None
Get User Index List in a Group
Parameter
None
Return
Result>
Exception
None
Get User Info List
Parameter
Return
Result>
Exception
None
Get Server Configuration
Parameter
None
Return
Result
Exception
None
Get Group List Bound to the Device
Parameter
None
Return
Result<DeviceGroups>
Exception
None
Get Device DetaiIed Info
Parameter
None
Return
Result<DeviceDetailInfo>
Exception
None
Get Company Info
Parameter
None
Return
Result<Company>
Exception
No
Get User Detailed Info
Parameter
Return
Result<UserDetailInfo>
Exception
None
Get Guest Detailed Info
Parameter
Return
Result<GuestDetailInfo>
Exception
None
Get Server Version
Parameter
None
Return
Result<ServerVersion>
Exception
None
Get Pass Time Table
Parameter
Return
Result<TimeTable>
Exception
None
Log out
Parameter
None
Return
None
Exception
None
QR Code Identification Interface
Parameter
Return
Result<QRResult>
Exception
None
Device Login
Parameter
Return
Result<LoginResult>
Exception
None
Device Registration
Parameter
Return
Result<RegisterResult>
Exception
None
Result reportUserStatus(UserStatusParameter userStatusParameter)
Upload the abnormal status of the user in the local database
Parameter
Return
Result
Exception
None
Upload the abnormal status of the user in the local database
Parameter
Return
Result
Exception
None
Refresh Connect Configuration
Parameter
Return
None
Exception
None
Report Device Event
Parameter
Return
Result
Exception
None
Upload Identification Record
Parameter
Return
Result<RecordResult>
Exception
None
Upload Device Version Info
Parameter
Return
Result
Exception
None
Upload Configuration
Parameter
Return
Result
Exception
None
Upload Tsl
Parameter
Return
Result
Exception
None
Upload Tsl Language Package
Parameter
Return
Result
Exception
None
identifier
String
Device Identifier
None
2.0.0
duid
String
Device sn
None
2.0.0
2.0.0
ConnectConfigEntity getConnectConfigEntity()
Get Current Connection Configuration
2.0.0
Result alarmReport(AlarmReportParameter reportParameter)
Alarm Report
2.0.0
Result bindDefaultGroup()
bind Default Group
2.0.0
Result checkPasswordUseLoginInterface(String password)
check Password
2.0.0
Result<TslCheckExistResult> checkTslExist(String md5)
check Tsl Exist
2.0.0
Result<TslLanguageCheckExistResult> checkTslLanguageExist(Result checkTslLanguageExist(String lang))(String lang)
check Tsl Language Exist
2.0.0
Result<FaceSearchResult> faceSearch(FaceSearchParameter searchParameter)
Server Identification
2.0.0
Result> getGroupIndexList()
Get Group Index List Bound to the device
2.0.0
Result> getUserIndexList(int groupId)
Get User Index List in a Group
2.0.0
Result> getUserInfoList(UserInfoParameter parameter)
Get User Info List
2.0.0
Result getServiceConfigJson()
Get Server Configuration
2.0.0
Result<DeviceGroups> getAllGroupList()
Get Group List Bound to the Device
2.0.0
Result<DeviceDetailInfo> getDeviceDetailInfo()
Get Device DetaiIed Info
2.0.0
Result<Company> getCompanyInfo()
Get Company Info
2.0.0
Result<UserDetailInfo> getUserInfo(long id)
Get User Detailed Info
2.0.0
Result<GuestDetailInfo> getGuestInfo(long id)
Get Guest Detailed Info
2.0.0
Result<ServerVersion> getServerVersion()
Get Server Version
2.0.0
Result<TimeTable> getPassTimeTable(long timetableId)
Get Pass Time Table
2.0.0
void logout()
logout
2.0.0
Result<QRResult> identifyQRCode(IdentifyQRCodeParameter parameter)
QR Code Identification Interface
2.0.0
Result<LoginResult> login(String account, String password,String identifier, String duid)
Device Login
2.0.0
Result<RegisterResult> register( RegisterParameter registerParameter)
Device Registration
2.0.0
Result reportUserStatus(UserStatusParameter userStatusParameter)
Upload the abnormal status of the user in the local database
2.0.0
Result reportUserStatus(UserSyncStatusParameter userSyncStatusParameter)
Upload the abnormal status of the user in the local database
2.0.0
void refreshConnectConfig(ConnectConfigEntity connectConfig)
refresh Connect Configuration
2.0.0
Result reportDeviceEvent(DeviceReportEventParamer param)
Report Device Status
2.0.0
Result<RecordResult> uploadRecord(RecordParameter recordParameter)
Upload Identification Record
2.0.0
Result uploadDeviceVersionInfo(DeviceVersionInfoParameter deviceInfoParameter)
Upload Device Version Info
2.0.0
Result uploadConfig(String deviceConfigKey, Object config)
Upload Configuration
2.0.0
Result uploadTsl(TslUploadParameter parameter)
upload Tsl
2.0.0
Result uploadTslLanguage(TslLanguageUploadParameter parameter)
upload Tsl Language Package
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
type
int
Image Type
1-Base Image in Senselink, 2-Recognition Image
2.0.0
imageId
String
Image ID
None
Parameter Name
Type
Description
Note
Version Introduced
reportParameter
AlarmReportParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
password
String
password
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
md5
String
File md5
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
lang
String
Language
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
searchParameter
FaceSearchParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
parameter
UserInfoParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
id
long
User ID
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
id
long
Guest ID
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
timetableId
long
Pass Time Table ID
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
parameter
IdentifyQRCodeParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
account
String
Device Login Account
None
2.0.0
password
String
Device Login Password
None
Parameter Name
Type
Description
Note
Version Introduced
registerParameter
RegisterParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
userStatusParameter
UserStatusParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
userSyncStatusParameter
UserSyncStatusParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
connectConfig
ConnectConfigEntity
Configuration
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
param
DeviceReportEventParamer
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
recordParameter
RecordParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
deviceInfoParameter
DeviceVersionInfoParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
deviceConfigKey
String
Device config key
None
2.0.0
config
Object
config Configuration
None
Parameter Name
Type
Description
Note
Version Introduced
parameter
TslUploadParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
parameter
TslLanguageUploadParameter
Parameter
None
2.0.0
2.0.0
2.0.0
2.0.0
MQTT Interface implementation
Member Function
Description
Version introduced
void connectMqtt(IMqttActionListener listener, IConnectionLost connectionLost, boolean useTokenConnect, SocketFactory socketFactory)
Connect MQTT
Connect MQTT
Parameter
Return
None
Exception
None
Disconnect MQTT
Parameter
Return
None
Exception
None
Get User List In a Group
Parameter
Return
None
Exception
None
Register Device and User In Group Change Callback
Parameter
Return
None
Exception
None
Register User In Group Change Callback
Parameter
Return
None
Exception
None
Register Warning Action Change Callback
Parameter
Return
None
Exception
None
Register Access Strategy Change Callback
Parameter
Return
None
Exception
None
Register APP and ROM Update Callback
Parameter
Return
None
Exception
None
Register Device Status Change Callback
Parameter
Return
None
Exception
None
Register Device Configuration Change Callback
Parameter
Return
None
Exception
None
Register Device Server End Notification Push Callback
Parameter
Return
None
Exception
None
Register Device Keep Door Open Or Close Schedule Push Callback
Parameter
Return
None
Exception
None
Unregister Device and User In Group Change Callback
Parameter
None
Return
None
Exception
None
Unregister User In Group Change Callback
Parameter
Return
None
Exception
None
Unregister User List of a Group
Parameter
Return
No
Exception
No
Unregister Warning Action Change Callback
Parameter
None
Return
None
Exception
None
Unregister Access Strategy Change Callback
Parameter
None
Return
None
Exception
None
Unregister APP and ROM Update Callback
Parameter
No
Return
No
Exception
No
Unregister Device Status Change Callback
Parameter
None
Return
None
Exception
None
Unregister Device Configuration Change Callback
Parameter
None
Return
None
Exception
None
Unregister Device Server End Notification Push Callback
Parameter
None
Return
None
Exception
None
Unregister Device Keep Door Open Or Close Schedule Push Callback
Parameter
None
Return
None
Exception
None
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Method
Description of Method
useTokenConnect
boolean
Use Token Connect
None
2.0.0
socketFactory
SocketFactory
The verification method used to build https
certificate not verified by default
2.0.0
None
2.0.0
JP
Japanese
None
2.0.0
KO
Korean
None
2.0.0
identifier
String
Device Identifier
None
2.0.0
duid
String
Device SN
None
2.0.0
token
String
Device Token
None
2.0.0
ldid
String
Device Background Identification Number
None
2.0.0
companyId
int
Company ID
None
2.0.0
isNewDevice
boolean
Is New Device
None
2.0.0
message
String
message
None
2.0.0
desc
String
Description
None
2.0.0
originData
String
Origin Data
None
2.0.0
rawData
byte[]
Binary Data
None
2.0.0
None
2.0.0
N
code
int
Alarm Code
10001 stands for disassembly alarm, 10002 stands for forced door open alarm, 10003 stands for door magnetism overtime alarm, 10004 is password attack alarm, 10005 is Bluetooth power shortage, 10006 indicates thermal imager connection exception, 20001 shows camera contamination, 20002 means a non-liveness attack, 20003 is fire alarm and 40001 stands for feature extraction failure
2.0.0
If the parameter "status" is 1, then the parameter "code" is necessary, otherwise it is optional
description
String
Alarm Description
None
2.0.0
N
eventTime
Long
Event Time
millisecond precision
2.0.0
Y
status
int
Alarm Report Event
1 means there is an alarm, 2 means alarm clearance failed, 3 means alarm clearance successful
2.0.0
Y
rectangle
List<VerticesItem>
rectangle coordinate
The first is the upper left corner coordinates, the second is the lower right corner coordinates
2.0.0
N
userId
long
User ID
None
2.0.0
N
None
2.0.0
Y
showAvatar
String
Show Avatar
None
2.0.0
name
String
Name
None
2.0.0
groups
List<GroupsItem>
Group
None
2.0.0
mobile
String
Contact Info
None
2.0.0
guestCompany
String
Guest Company
None
2.0.0
birthday
String
Birthday
None
2.0.0
position
String
Position
None
2.0.0
idNumber
String
ID Number
None
2.0.0
icNumber
String
ic Card Number
None
2.0.0
String
None
2.0.0
guestPurpose
String
Guest Purpose
None
2.0.0
receptionUserId
long
reception User id
None
2.0.0
receptionUserName
String
reception User Name
None
2.0.0
dateTimeFrom
String
Effective Time From
None
2.0.0
dateTimeTo
String
Effective Time To
None
2.0.0
level
int
level
None
2.0.0
remark
String
Note
None
2.0.0
type
int
Group Type
1:User Group, 2: Guest Group, 5: deny list Group
2.0.0
personCount
int
person Count
None
2.0.0
timestamp
long
Timestamp uploaded when requested by the client
None
2.0.0
passRuleType
int
Pass Rule Type
0: Local Pass Rule 1: Server Pass Rule
2.0.0
sign
String
md5, check note for detail
The md5 Value of {timestamp}-{ldid}-{gateCtrl}-{passRuleType}
2.0.0
userId
int
User ID
None
2.0.0
userCardId
String
User Door Access Card ID
None
2.0.0
userImage
Content
User Library Image
None
2.0.0
trackId
int
id for Face Tracking
None
2.0.0
userName
String
User Name
None
2.0.0
displayMsg
String
display Msg
None
2.0.0
displayColor
String
display Color
None
2.0.0
verifyCode
int
Verification Code
1: Unactivated, 2: activated, 3: Unauthorized 4: Match failed, 5: Not within the passable time range
2.0.0
type
int
Type
None
2.0.0
idNumber
String
id Number
None
2.0.0
sign
String
md5
the md5 Value of {verifyCode}-{timestamp}-{ldid}-{userId}
2.0.0
extra
String
Extra String
None
2.0.0
url
String
Image url
choose it or data
2.0.0
None
2.0.0
N
receiveTime
long
receive Timestamp
millisecond class
2.0.0
N
fullImage
Content
full picture
full picture is not required if a caputured small picture is uploaded
2.0.0
Y
captureTime
long
Capture Timestamp
millisecond class
2.0.0
N
cameraInfo
CameraInfo
Camera Common Info
None
2.0.0
N
timestamp
long
Timestamp
millisecond class
2.0.0
N
content
Content
Image Content
None
2.0.0
imageType
int
Image Type
1: rgb Image, 2: ir Image
2.0.0
mask
int
Wear Mask
0 Not pass in, 1 No，2 Yes
2.0.0
bodyTemperature
float
body Temperature
None
2.0.0
rectangle
Rectangle
Rectangle
None
2.0.0
landmarks
List<LandmarksItem>
Object key point coordinate
None
2.0.0
quality
float
Target detection quality
[0.0, 1.0]
2.0.0
yaw
int
Face yaw angle
None
2.0.0
tollgateId
String
id of the toll gate where the camera is located
None
2.0.0
tollgateName
String
Name of the toll gate where the camera is located
None
2.0.0
cameraId
String
Camera id
None
2.0.0
deviceType
String
Camera HardwareType
None
2.0.0
placeCode
String
code of the place where the camera is located
None
2.0.0
groupName
String
Group Name
None
2.0.0
createdAt
long
Created Timestamp
None
2.0.0
String
None
2.0.0
gender
int
Gender
0-Unknown, 1-Female, 2-Male
userName
String
User Name
None
2.0.0
phoneSuffix
String
Mobile Number Suffix
None
2.0.0
createdAt
long
Create Timestamp
None
2.0.0
remark
String
Remark
None
2.0.0
addChannel
int
add Channel
1: web; 2: senseid; 3: QR Code; 4: openapi 5: SenseHi App Self-modification 6: batch tool
type
int
User Type
1:User 2:Guest 3 deny list
avatarShow
String
Art Photo ID
None
2.0.0
dateTimeTo
long
End Timestamp
None
2.0.0
guestCompany
String
Guest Company
None
2.0.0
guestLevel
String
Guest Level
None
2.0.0
feature
String
Face Feature
None
2.0.0
updatedAt
long
Update Timestamp
None
2.0.0
jobNumber
String
Job Number
None
2.0.0
icNumber
String
IC Card Number
None
2.0.0
dateTimeFrom
long
Start Timestamp
None
2.0.0
entryTime
long
Entry Time
None
2.0.0
idNumber
String
ID Number
None
2.0.0
companyId
int
User Company ID
None
2.0.0
departmentId
int
User Department ID
None
2.0.0
departmentName
String
Department Name
None
2.0.0
areaCode
String
Area Code
None
2.0.0
mobile
String
Mobile Number
None
2.0.0
permission
int
Access permission
0-Permitted, 1-Not Permitted
2.0.0
receptionUserId
int
User id for Guest Reception
None
2.0.0
avatar
String
Avatar ID
None
2.0.0
countryCode
String
Country Code
None
2.0.0
staffType
int
Staff Type
1-Staff, 2Intern
2.0.0
userId
int
User ID
None
2.0.0
guestPurpose
String
guest Purpose
None
2.0.0
location
String
Location
None
2.0.0
position
String
Position
None
2.0.0
placeCode
String
Place Code
None
2.0.0
prompt
String
Personalized Prompt
None
2.0.0
guestGroups
List<GroupsItem>
Guest Group
None
2.0.0
denyListGroup
List<GroupsItem>
deny list group
None
2.0.0
typeName
String
Device Type Name
None
2.0.0
userGroup
List<GroupsItem>
User Group
None
2.0.0
guestGroup
List<GroupsItem>
Guest Group
None
2.0.0
typeId
int
Device TypeID
None
2.0.0
name
String
Device Name
None
2.0.0
description
String
Device Description Info
None
2.0.0
location
String
Device Location
None
2.0.0
id
int
Device ID
None
2.0.0
state
int
Device State
1 - Online, 0-Offline
2.0.0
direction
int
Device In and Out Direction
0-Default, 1-In, 2-Out
2.0.0
typeId
int
Device Type ID
None
2.0.0
maxOnlineNum
int
Device Max Online Number
None
2.0.0
id
String
Device ID
None
2.0.0
createBy
String
Creator ID
None
2.0.0
background
String
Background
None
2.0.0
contact
String
Contact
None
2.0.0
validTo
String
Valid To
None
2.0.0
name
String
Company Name
None
2.0.0
updateAt
String
Update Time
None
2.0.0
logo
String
Company logo
None
2.0.0
id
int
Company ID
None
2.0.0
createAt
String
Create Time
None
2.0.0
welcome
String
Welcome Message
None
2.0.0
introduction
String
Company Introduction
None
2.0.0
userGroupId
int
User Group ID
None
2.0.0
rsaId
String
Key ID
None
2.0.0
entryTime
String
Entry Time
None
2.0.0
idNumber
String
ID Number
None
2.0.0
String
None
2.0.0
areaCode
String
Area Code
None
2.0.0
phoneSuffix
String
Mobile Number Suffix
None
2.0.0
mobile
String
Mobile Number
None
2.0.0
groups
List<GroupsItem>
Group Info
None
2.0.0
remark
String
Remark
None
2.0.0
avatar
String
Avatar ID
None
2.0.0
avatarShow
String
Art Photo ID
None
2.0.0
countryCode
String
Country Code
None
2.0.0
name
String
User Name
None
2.0.0
location
String
Location
None
2.0.0
departmentRoute
List<DeptItem>
Department
None
2.0.0
id
long
User ID
None
2.0.0
position
String
Position
None
2.0.0
jobNumber
String
job Number
None
2.0.0
placeCode
String
Place Code
None
2.0.0
department
int
Department ID
None
2.0.0
prompt
String
Personalized Prompt
None
2.0.0
type
int
Department Type
None
2.0.0
provider
String
Provider
ST-BI, ST-JCV
2.0.0
product
String
Product Name
SenseLink, SenseLink GE
2.0.0
coreEdition
String
core Edition
None
2.0.0
appEdition
String
Show app Edition
None
2.0.0
name
String
Pass Time Table Name
None
2.0.0
groupId
int
Pass Group ID
None
2.0.0
monday
String
Monday 24h Access Strategy
None
2.0.0
mondayPeriod
String
Monday Pass Time Period
None
2.0.0
tuesday
String
Tuesday 24h Access Strategy
None
2.0.0
tuesdayPeriod
String
Tuesday Pass Time Period
None
2.0.0
wednesday
String
Wednesday 24h Access Strategy
None
2.0.0
wednesdayPeriod
String
Wednesday Pass Time Period
None
2.0.0
thursday
String
Thursday 24h Access Strategy
None
2.0.0
thursdayPeriod
String
Thursday Pass Time Period
None
2.0.0
friday
String
Friday 24h Access Strategy
None
2.0.0
fridayPeriod
String
Friday Pass Time Period
None
2.0.0
saturday
String
Saturday 24h Access Strategy
None
2.0.0
saturdayPeriod
String
Saturday Pass Time Period
None
2.0.0
sunday
String
Sunday 24h Access Strategy
None
2.0.0
sundayPeriod
String
Sunday Pass Time Period
None
2.0.0
holiday
String
Holiday 24h Access Strategy
None
2.0.0
holidayPeriod
String
Holiday Pass Time Period
None
2.0.0
startTimestamp
long
Start Timestamp
millisecond precision
2.0.0
endTimestamp
long
End Timestamp
millisecond precision
2.0.0
specialDayList
List<SpecialDay>
Special Date
None
2.0.0
remark
String
Note
None
2.0.0
idNumber
String
ID Number
None
2.0.0
userId
int
User ID
None
2.0.0
userImage
Content
User Library Image
None
2.0.0
userCardId
String
User Door Access Card ID
None
2.0.0
userName
String
User Name
None
2.0.0
entryStatus
int
Status code
1-Pass; 2-QR code illegal; 3-QR code decryption failed; 4-QR code content error; 5-QR code invalid; 6-QR code is not within the validity period; 7-QR code has no passes; 8-The user corresponding to the QR code is invalid
2.0.0
sign
String
md5
The md5 Value of {entryStatus}-{timestamp}-{ldid}-{userId}-{passRuleType}
2.0.0
type
int
User Type
1:Staff; 2:Guest;3:Stranger; 4:Non-liveness; 5-denyList
2.0.0
timestamp
long
Timestamp Uploaded by the Client
None
2.0.0
passRuleType
int
Pass Rule Type
None
2.0.0
None
2.0.0
Y
companyId
int
Company ID
None
2.0.0
defaultGuestGroupId
int
default User Group ID
None
2.0.0
threshold
int
Face Detection Threshold
None
2.0.0
newDeviceKey
boolean
New Device
None
2.0.0
token
String
Token
None
2.0.0
deviceTypeMaxOnline
DeviceTypeMaxOnline
Maximum online device information
None
2.0.0
accountId
int
Account ID
None
2.0.0
name
String
Name
None
2.0.0
userRspVO
UserRspVO
User Info
None
2.0.0
company
Company
Company Info
None
2.0.0
lang
String
Language
None
2.0.0
device
Device
Device Info
None
2.0.0
account
String
Account Name
None
2.0.0
entryTime
String
entry Time
None
2.0.0
idNumber
String
ID Number
None
2.0.0
String
None
2.0.0
areaCode
String
Place Code
None
2.0.0
phoneSuffix
String
Mobile Number Suffix
None
2.0.0
mobile
String
Mobile Number
None
2.0.0
groups
List<GroupsItem>
User Group ID
None
2.0.0
remark
String
Note
None
2.0.0
avatar
String
Avatar ID
None
2.0.0
avatarShow
String
Art Photo ID
None
2.0.0
countryCode
String
Country Code
None
2.0.0
name
String
Name
None
2.0.0
departmentRoute
List<DepartmentRouteItem>
Department
None
2.0.0
location
String
Location
None
2.0.0
id
Integer
User ID
None
2.0.0
jobNumber
String
Job Number
None
2.0.0
placeCode
String
Area Code
None
2.0.0
position
String
Position
None
2.0.0
department
Integer
Department ID
None
2.0.0
type
int
Department Type
None
2.0.0
typeId
int
Device Type
None
2.0.0
name
String
Device Name
None
2.0.0
updateAt
String
Update Time
None
2.0.0
description
String
Description
None
2.0.0
location
String
Device Location
None
2.0.0
id
int
Device ID
None
2.0.0
softwareVersion
String
Device Software Version
None
2.0.0
createAt
String
Create Time
None
2.0.0
direction
int
Device In and Out Direction
None
2.0.0
info
String
Info
None
2.0.0
content
String
Remark
None
2.0.0
typeId
int
Device TypeID
None
2.0.0
name
String
Device Name
None
2.0.0
updateAt
String
Update Time
None
2.0.0
description
String
Device Description
None
2.0.0
location
String
Device Location
None
2.0.0
id
int
Device ID
None
2.0.0
softwareVersion
String
Device Software Version
None
2.0.0
createAt
String
Create Time
None
2.0.0
direction
int
Device In and Out Direction
None
2.0.0
info
String
Device Info
None
2.0.0
0-Default, 1-In, 2-Out
2.0.0
Y
location
String
Device Location Description
None
2.0.0
N
description
String
Device Description
None
2.0.0
N
softwareVersion
String
Software Version
None
2.0.0
N
info
String
Other Info
None
2.0.0
N
totalUserCount
int
Total User Count
None
2.0.0
None
2.0.0
Y
totalUserCount
int
Total User Count
None
2.0.0
Y
action
int
Type
0-Upload the Status of All Device Users, 1-Upload the Status of Abnormal Device Users
2.0.0
Y
1: DoorMagnetismReportEventContent, 2: BluetoothReportEventContent, 3: ThermalImagerReportEventContent
2.0.0
Y
millisecond precision
2.0.0
Y
None
2.0.0
N
signAvatar
String
Facial Image
None
2.0.0
N
signBgAvatar
String
Background Image
None
2.0.0
N
signTime
long
Clock Time
None
2.0.0
Y
type
int
Personnel Type
1:Staff; 2:Guest; 3: Stranger; 4: Non Liveness; 999: Others
2.0.0
Y
abnormalType
int
Abnormal Record Type
0-No; 10001-Person and ID mismatch;10002-Person and Card mismatch;10003-Person and Code mismatch;20001-The guest is not within the validity period; 20002-Not within the passable time range; 30001-Invalid id card; 30002-Invalid IC Card; 30003-Invalid QR Code
2.0.0
N
idNumber
String
ID Number
None
2.0.0
N
icNumber
String
work card
None
2.0.0
N
idInfo
String
other information of ID card
Json String
2.0.0
N
inTime
int
Whether uploaded timely
Yes: 1; No: 0
2.0.0
Y
mode
int
Device Mode
1: Swipe Face or Card; 2: Swipe Face+Card; 3: Swipe Face or ID Card; 4: Swipe Face+ID Card; 5: Swipe Face+ID Card for Appointment; 6: Swipe Face or QR Code; 7: Swipe Face and QR Code; 8: Bluetooth; 9: Face; 10: Face or QR Code or Swipe Card
2.0.0
Y
rectangle
List<VerticesItem>
rectangle
Coordinates of the upper left corner, coordinates of the lower right corner
2.0.0
N
entryMode
int
Entry Mode
1: Swipe Face; 2: QR Code; 3: Swipe Card; 4: Swipe Face+Card; 5: Swipe ID Card; 6: Swipe Face+ID Card; 7: Swipe Face+ID Card for Appointment; 8: Swipe Face and QR Code; 9: Bluetooth
2.0.0
N
pushOption
int
Push Record
1, Yes, 0 No
2.0.0
N
wearMaskType
int
Mask Status
0: No Status (Mask Identification not activated) 1: Without Mask 2: With Mask
2.0.0
N
verifyScore
float
Verify Score
None
2.0.0
N
docPhoto
String
ID card photo
None
2.0.0
N
heatAvatar
String
thermodynamic diagram
None
2.0.0
N
bodyTemperature
float
Body Temperatur
None
2.0.0
N
remark
String
Note
None
2.0.0
N
None
2.0.0
Y
apkVersionCode
String
apk Version Code
None
2.0.0
Y
packageName
String
package Name
None
2.0.0
Y
model
String
Model
None
2.0.0
Y
serialNumber
String
Device serial Number
None
2.0.0
Y
romSoftwareVersion
String
ROM Software Version
None
2.0.0
Y
manufacturer
String
manufacturer
None
2.0.0
Y
userId
int
User ID
None
2.0.0
recordId
int
Recordid
None
2.0.0
type
int
Data Type
1-In the Library, 2-Stranger, 3-Liveness, 4-Non-liveness
2.0.0
height
int
Depth Data Height
None
2.0.0
en,zh,zh-tw
2.0.0
Y
event
MessageEventEnum
Event
None
2.0.0
captcha
String
authentication code
None
2.0.0
None
2.0.0
2.0.0
void disConnectMqtt(IMqttActionListener listener)
Disconnect MQTT
2.0.0
void getUserListInGroup
(int groupId, MessageCallback callback)
Get User List In a Group
2.0.0
void registerGroupChangeListener
(MessageCallback callback)
Register Device and User In Group Change Callback
2.0.0
void registerUserInGroupChangeListener
(int groupId, MessageCallback callback)
Register User In Group Change Callback
2.0.0
void registerWarningAction(MessageCallback callback)
Register Warning Action Change Callback
2.0.0
void registerAccessStrategy
(MessageCallback callback)
Register Access Strategy Change Callback
2.0.0
void registerUpgrade
(MessageCallback callback)
Register APP and ROM Update Callback
2.0.0
void registerDeviceStatus
(MessageCallback callback)
Register Device Status Change Callback
2.0.0
void registerDeviceConfig(MessageCallback callback)
Register Device Configuration Change Callback
2.0.0
void registerDeviceNotify(MessageCallback callback)
Register Device Server End Notification Push Callback
2.0.0
void registerKeepDoorOpenOrCloseSchedule
(MessageCallback callback)
Register Device Keep Door Open Or Close Schedule Push Callback
2.0.0
void unRegisterGroupChangeListener()
Unregister Device and User In Group Change Callback
2.0.0
void unegisterUserInGroupChangeListener(int groupId)
Unregister User In Group Change Callback
2.0.0
void unegisterGetUserListInGroup(int groupId)
Unregister User List of a Group
2.0.0
void unRegisterWarningAction()
Unregister Warning Action Change Callback
2.0.0
void unRegisterAccessStrategy()
Unregister Access Strategy Change Callback
2.0.0
void unRegisterUpgrade()
Unregister APP and ROM Update Callback
2.0.0
void unRegisterDeviceStatus()
Unregister Device Status Change Callback
2.0.0
void unRegisterDeviceConfig()
Unregister Device Configuration Change Callback
2.0.0
void unRegisterDeviceNotify()
Unregister Device Server End Notification Push Callback
2.0.0
void unRegisterKeepDoorOpenOrCloseSchedule()
Unregister Device Keep Door Open Or Close Schedule Push Callback
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
listener
IMqttActionListener
Callback
None
2.0.0
connectionLost
IConnectionLost
Connection Lost Callback
None
Parameter Name
Type
Description
Note
Version Introduced
listener
IMqttActionListener
Callback
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
groupId
int
Group ID
None
2.0.0
callback
MessageCallback
Callback
None
Parameter Name
Type
Description
Note
Version Introduced
callback
MessageCallback
Callback
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
groupId
int
Group ID
None
2.0.0
callback
MessageCallback
Callback
None
Parameter Name
Type
Description
Note
Version Introduced
callback
MessageCallback
Callback
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
callback
MessageCallback
Callback
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
callback
MessageCallback
Callback
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
callback
MessageCallback
Callback
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
callback
MessageCallback
Callback
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
callback
MessageCallback
Callback
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
callback
MessageCallback
Callback
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
groupId
int
Group ID
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
groupId
int
Group ID
None
2.0.0
Member
Description
Note
Version Introduced
ZH
Simplified Chinese
None
2.0.0
ZH_TW
Traditional Chinese
None
2.0.0
EN
Member
Type
Description
Note
Version Introduced
account
String
Account
None
2.0.0
password
String
Password
None
Member
Type
Description
Note
Version Introduced
code
int
Status Code
None
2.0.0
data
T
Data
None
Member Function
Description
Note
Version Introduced
boolean isSuccess()
Request Success
true-success, false-fail
2.0.0
Member
Type
Description
Note
Version Introduced
is it necessary
traceId
String
Alarm Serial Number
None
2.0.0
Y
alarmPhoto
String
Member
Type
Description
Note
Version Introduced
is it necessary
x
int
x Coordinate
None
2.0.0
Y
y
int
Member
Type
Description
Note
Version Introduced
id
long
Guest id
None
2.0.0
avatar
String
Compare Avatar
None
Member
Type
Description
Note
Version Introduced
id
int
Group ID
None
2.0.0
name
String
Group Name
None
Member
Type
Description
Note
Version Introduced
flag
int
Flag
0 Not Exist, 1 Exist
2.0.0
Member
Type
Description
Note
Version Introduced
flag
int
Flag
0 Not Exist, 1 Exist
2.0.0
md5
String
File md5
None
Member
Type
Description
Note
Version Introduced
searchResult
List<SearchResultItem>
Search Result
None
2.0.0
gateCtrl
boolean
Door Open
None
Member
Type
Description
Note
Version Introduced
faceCutImage
Content
Face Cut Image
None
2.0.0
score
float
Verify Score
None
Member
Type
Description
Note
Version Introduced
data
String
Original Image Data
Choose it or url
2.0.0
format
String
Image Type
IMAGE_UNKNOWN, IMAGE_JPEG, IMAGE_PNG, IMAGE_BMP, IMAGE_TIFF, IMAGE_GIF
Member
Type
Description
Note
Version Introduced
Is it necessary
targetImages
ImagesItem
Capture several groups of small pictures
small picture is not required if a full picture is uploaded
2.0.0
N
extraInfo
String
Member
Type
Description
Note
Version Introduced
detectionMode
String
detection Mode
DETECT_MODE_AUTO: Automatically select the detection frame according to TargetAnnotation.rectangle and the size of the captured image.DETECT_MODE_BOUNDING_ONLY: Only use TargetAnnotation.rectangle.Rectangle must be passed in, otherwise it is an invalid target.DETECT_MODE_FORCE_DETECTION: Mandatory use of detection model for detection
2.0.0
targetInfo
TargetInfo
general capture target information structure
None
Member
Type
Description
Note
Version Introduced
trackId
int
Track id
None
2.0.0
angle
Angle
Face Angle Info
None
Member
Type
Description
Note
Version Introduced
roll
int
Face roll angle
None
2.0.0
pitch
int
Face pitch angle
None
Member
Type
Description
Note
Version Introduced
vertices
List<VerticesItem>
Target rectangular area
coordinates of the upper left corner, coordinates of the lower right corner
2.0.0
Member
Type
Description
Note
Version Introduced
x
int
x Coordinate
None
2.0.0
y
int
y Coordinate
None
Member
Type
Description
Note
Version Introduced
x
int
x Coordinate
None
2.0.0
y
int
y Coordinate
None
Member
Type
Description
Note
Version Introduced
placeName
String
Name of the place where the camera is located
None
2.0.0
deviceId
String
Camera Hardware id
None
Member
Type
Description
Note
Version Introduced
updatedAt
long
Update Timestamp
None
2.0.0
groupId
int
Group ID
None
Member
Type
Description
Note
Version Introduced
userUpdatedAt
long
User Update Time
None
2.0.0
userId
int
User ID
None
Member
Type
Description
Note
Version Introduced
birthday
String
Birthday
None
2.0.0
modelVersion
String
Model Version
None
Member
Type
Description
Note
Version Introduced
userIds
List
User id Arrays
Up to 20,000 arrays at a time
2.0.0
modelVersion
String
Model Version
None
Member
Type
Description
Note
Version Introduced
id
String
Device ID
None
2.0.0
userGroups
List<GroupsItem>
User Group
None
Member
Type
Description
Note
Version Introduced
deviceTypeMaxOnline
DeviceTypeMaxOnline
Device Type Max Online
None
2.0.0
ldid
String
Device LDID
None
Member
Type
Description
Note
Version Introduced
companyId
int
Device Company ID
None
2.0.0
serviceConfig
List<ServiceConfigItem>
Server Configuration
None
Member
Type
Description
Note
Version Introduced
name
String
Device Name
None
2.0.0
options
List<Options>
Customized Options
None
Member
Type
Description
Note
Version Introduced
text
String
Text String
None
2.0.0
value
String
Corresponding Content
None
Member
Type
Description
Note
Version Introduced
guestGroupId
int
Guest Group ID
None
2.0.0
validFrom
String
Valid From
None
Member
Type
Description
Note
Version Introduced
empoent
String
e1
None
2.0.0
module
String
Product of prime numbers
None
Member
Type
Description
Note
Version Introduced
birthday
String
Birthday
None
2.0.0
icNumber
String
IC Care Number
None
Member
Type
Description
Note
Version Introduced
name
String
Department Name
None
2.0.0
id
int
Department ID
None
Member
Type
Description
Note
Version Introduced
date
String
Date
for example 20190815
2.0.0
edition
String
Edition
for example 1.11.0.2
Member
Type
Description
Note
Version Introduced
id
long
Access Strategy ID
None
2.0.0
ruleId
long
Rule ID
None
Member
Type
Description
Note
Version Introduced
id
long
Special Date Id
None
2.0.0
date
String
Date
None
Member
Type
Description
Note
Version Introduced
entryTimeLeft
int
Number of Passes Remaining
None
2.0.0
entryHint
String
Entry Hint
None
Member
Type
Description
Note
Version Introduced
Is it necessary
content
String
QR Code Content
None
2.0.0
Y
timestamp
long
Member
Type
Description
Note
Version Introduced
defaultUserGroupId
int
default User Group ID
None
2.0.0
role
int
Role
None
Member
Type
Description
Note
Version Introduced
birthday
String
Birthday
None
2.0.0
icNumber
String
IC Number
None
Member
Type
Description
Note
Version Introduced
name
String
Department Name
None
2.0.0
id
int
Department ID
None
Member
Type
Description
Note
Version Introduced
ldid
String
Device UDID
None
2.0.0
companyId
int
Device Compay ID
None
Member
Type
Description
Note
Version Introduced
recordId
String
identification record id
None
2.0.0
type
int
Misrecognition Type
1 Other person, 2 Stranger, 3 Non-liveness, 4 Stranger Break, 5 Non-liveness Break
Member
Type
Description
Note
Version Introduced
ldid
String
Device LDID
None
2.0.0
companyId
int
Device Compay ID
None
Member
Type
Description
Note
Version Introduced
Is it necessary
name
String
Device Name
None
2.0.0
Y
direction
int
Member
Type
Description
Note
Version Introduced
exceptionList
List<ExceptionListItem>
Exception List
None
2.0.0
verifyModelVersion
String
Verify Model Version
None
Member
Type
Description
Note
Version Introduced
code
int
Status Code
None
2.0.0
userId
int
User ID
None
Member
Type
Description
Note
Version Introduced
Is it necessary
statusList
List<UserStatusListItem>
User Status List
None
2.0.0
Y
verifyModelVersion
String
Member
Type
Description
Note
Version Introduced
status
int
Status Code
1-Synchronizing, 2-Features Normal, 3-Image download failed, 4-Image parsing failed, 5-Feature extraction failed
2.0.0
userIds
int[]
User ID Arrays
None
Member
Type
Description
Note
Version Introduced
Is it necessary
type
int
Event Type
1-Door Magnetism Event; 2-Bluetooth power; 3-Thermal Imager Status
2.0.0
Y
content
BaseDeviceReportEventContent
Member
Type
Description
Note
Version Introduced
Is it necessary
status
int
Event Status
1-ON, 2-OFF, 3-No
2.0.0
Y
timestamp
long
Member
Type
Description
Note
Version Introduced
Is it necessary
power
int
Power Remained
0-100
2.0.0
Y
Member
Type
Description
Note
Version Introduced
Is it necessary
status
int
Event Status
0-Unknown, 1-Connected, 2-Unconnected
2.0.0
Y
Member
Type
Description
Note
Version Introduced
recordId
String
RecordID
None
2.0.0
Member
Type
Description
Note
Version Introduced
Is it necessary
userId
int
User ID
None
2.0.0
N
username
String
Member
Type
Description
Note
Version Introduced
Is it necessary
apkVersionName
String
apk Version Name
None
2.0.0
Y
romHardwareVersion
String
Member
Type
Description
Note
Version Introduced
images
List<ImagesItem>
Data
None
2.0.0
depth
Depth
Depth Data
None
Member
Type
Description
Note
Version Introduced
data
String
Depth Data Content
None
2.0.0
width
int
Depth Data Width
None
Member
Type
Description
Note
Version Introduced
Is it necessary
content
String
Tsl json String
None
2.0.0
Y
Member
Type
Description
Note
Version Introduced
Is it necessary
content
String
Language Package Content
None
2.0.0
Y
lang
String
Member
Type
Description
Note
Version Introduced
mobile
String
Mobile Number
None
2.0.0
areaCode
String
Area Code
None
Member
Description
Note
Version Introduced
LOGIN
Login
None
2.0.0
CHANGE_INFO
Change Info
None
2.0.0
VALIDATE
Member Function
Description
Note
Version Introduced
void onConnectionLost(Throwable cause)
Callback on Connection Lost
None
2.0.0
Member Function
Description
Note
Version Introduced
void success(MqttMessage msg)
Callback on Receiving Message
None
2.0.0
void error(int code, String msg, Throwable throwable)
Callback on Failure
None
2.0.0
2.0.0
2.0.0
2.0.0
English
2.0.0
2.0.0
Alarm Photo
y Coordinate
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
Extra String
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
Timestamp
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
2.0.0
Device Direction
2.0.0
2.0.0
Verify Model Version
2.0.0
content corresponding to the event
Event Time
User Name
ROM Hardware Version
2.0.0
2.0.0
Language
2.0.0
Validate