Appearance
Share Device by Inviting User
Interface Address:/v2/binding/enduserapi/shareByUid
Request Method:POST
Request Data Type:application/json
Response Data Type:*/*
Interface Description:Share Device by Inviting User
Request Parameters:
Parameter Name | Parameter Description | Request Type | Required | Data Type | schema |
---|---|---|---|---|---|
dk | Device Key | query | true | string | |
pk | Product Key | query | true | string | |
authKey | AuthKey | query | false | string | |
coverMark | Override flag 1 Directly override previous valid share (default) (override existing share code) 2 Directly add, allow multiple coexisting shares 3 Only allow override if share time has been extended | query | false | integer(int32) | |
query | false | string | |||
phone | Phone number | query | false | string | |
shareUid | Invited user uid | query | false | string | |
sharingExpireAt | Device usage expiration timestamp (milliseconds), representing how long the shared device can be used by the recipient If not provided, it is valid for life, only revoked when the authorizer actively unbinds | query | false | integer(int64) |
Response Status:
Status Code | Description | schema |
---|---|---|
200 | Device share by inviting user successful | Registration code response data«string» |
5032 | Token verification failed | |
5066 | Please enter Product Key | |
5067 | Please enter Device Key | |
5106 | Please enter token | |
5133 | Override flag parameter value out of range | |
5134 | Failed to add device share information | |
5145 | Timestamp format incorrect | |
5360 | Cannot share unverified bound device | |
5864 | Family member cannot accept family device share | |
5891 | Please enter recipient's uid, email, or phone |
Response Parameters:
Parameter Name | Parameter Description | Type | schema |
---|---|---|---|
code | Response status code | integer(int32) | integer(int32) |
data | Response data | string | |
extMsg | Extended message | string | |
msg | Response message | string |
Response Example:
javascript
{
"code": 0,
"data": "",
"extMsg": "",
"msg": ""
}