Appearance
Sharer Query for Device Share Recipient List
API Address:/v2/binding/enduserapi/deviceShareUserList
Request Method:GET
Request Data Type:application/x-www-form-urlencoded
Response Data Type:*/*
API Description:Sharer queries the list of recipients for a shared device
Request Parameters:
Parameter Name | Parameter Description | Request Type | Required | Data Type | Schema |
---|---|---|---|---|---|
dk | Device Key | query | true | string | |
pk | Product Key | query | true | string |
Response Status:
Status Code | Description | Schema |
---|---|---|
200 | Sharer successfully queried device share recipient list | Registration code response data«List«Device Share User»» |
5032 | Token verification failed | |
5066 | Please enter Product Key | |
5067 | Please enter Device Key | |
5106 | Please enter token | |
5141 | No permission to query this device |
Response Parameters:
Parameter Name | Parameter Description | Type | Schema |
---|---|---|---|
code | Response status code | integer(int32) | integer(int32) |
data | Response data | array | Device Share User |
shareInfo | Share information | BidShareModelExtV1 | BidShareModelExtV1 |
acceptTime | Share acceptance time | integer | |
acceptTimeTs | Acceptance timestamp | integer | |
acceptingExpireAt | Share acceptance expiration time | string | |
acceptingExpireAtTs | Share acceptance expiration timestamp | integer | |
authKey | authKey | string | |
coverMark | Cover flag | integer | |
deleteTime | Share acceptance time | integer | |
deleteTimeTs | Cancellation timestamp | integer | |
deviceName | Device name | string | |
dk | dk | string | |
failureCause | Failure reason | integer | |
fid | Family ID | string | |
ownerUid | Sharer ID | string | |
pk | pk | string | |
shareCode | Share code | string | |
shareId | Share ID | integer | |
shareStatus | Share status | integer | |
shareTime | Share time | integer | |
shareTimeTs | Share timestamp | integer | |
shareUid | Share recipient ID | string | |
sharingExpireAt | Device usage expiration time | string | |
sharingExpireAtTs | Device usage expiration timestamp | integer | |
updateTime | Modification time | integer | |
updateTimeTs | Modification timestamp | integer | |
userInfo | User information | User Information | User Information |
address | Address | string | |
alipayUserId | Alipay user ID | string | |
city | City | string | |
string | |||
facebookUserId | Facebook user ID | string | |
headimg | Profile picture | string | |
lang | Language | string | |
lastLoginTime | Last login time | string | |
lastLoginTimeTs | integer | ||
nationality | Country | string | |
nikeName | Nickname | string | |
phone | Phone number | string | |
province | Province | string | |
qqUserId | QQ user ID | string | |
registerTime | Registration time | string | |
registerTimeTs | integer | ||
remark | Remarks | string | |
sex | Gender | string | |
signature | Personal signature | string | |
status | Account status: 0 Disabled 1 Normal | integer | |
timezone | Timezone | string | |
twitterUserId | Twitter user ID | string | |
uid | User ID | string | |
userDomain | User domain | string | |
wechatMiniprogramUserId | WeChat Mini Program user ID | string | |
wechatOffiaccountUserId | WeChat Official Account user ID | string | |
wechatUnionId | WeChat Universal user ID | string | |
extMsg | Extended message | string | |
msg | Response message | string |
Response Example:
javascript
{
"code": 0,
"data": [
{
"shareInfo": {
"acceptTime": 0,
"acceptTimeTs": 0,
"acceptingExpireAt": "",
"acceptingExpireAtTs": 0,
"authKey": "",
"coverMark": 0,
"deleteTime": 0,
"deleteTimeTs": 0,
"deviceName": "",
"dk": "",
"failureCause": 0,
"fid": "",
"ownerUid": "",
"pk": "",
"shareCode": "",
"shareId": 0,
"shareStatus": 0,
"shareTime": 0,
"shareTimeTs": 0,
"shareUid": "",
"sharingExpireAt": "",
"sharingExpireAtTs": 0,
"updateTime": 0,
"updateTimeTs": 0
},
"userInfo": {
"address": "",
"alipayUserId": "",
"city": "",
"email": "",
"facebookUserId": "",
"headimg": "",
"lang": "",
"lastLoginTime": "",
"lastLoginTimeTs": 0,
"nationality": "",
"nikeName": "",
"phone": "",
"province": "",
"qqUserId": "",
"registerTime": "",
"registerTimeTs": 0,
"remark": "",
"sex": "",
"signature": "",
"status": 0,
"timezone": "",
"twitterUserId": "",
"uid": "",
"userDomain": "",
"wechatMiniprogramUserId": "",
"wechatOffiaccountUserId": "",
"wechatUnionId": ""
}
}
],
"extMsg": "",
"msg": ""
}