Skip to content

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 NameParameter DescriptionRequest TypeRequiredData Typeschema
dkDevice Keyquerytruestring
pkProduct Keyquerytruestring
authKeyAuthKeyqueryfalsestring
coverMarkOverride 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
queryfalseinteger(int32)
emailEmailqueryfalsestring
phonePhone numberqueryfalsestring
shareUidInvited user uidqueryfalsestring
sharingExpireAtDevice 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
queryfalseinteger(int64)

Response Status:

Status CodeDescriptionschema
200Device share by inviting user successfulRegistration code response data«string»
5032Token verification failed
5066Please enter Product Key
5067Please enter Device Key
5106Please enter token
5133Override flag parameter value out of range
5134Failed to add device share information
5145Timestamp format incorrect
5360Cannot share unverified bound device
5864Family member cannot accept family device share
5891Please enter recipient's uid, email, or phone

Response Parameters:

Parameter NameParameter DescriptionTypeschema
codeResponse status codeinteger(int32)integer(int32)
dataResponse datastring
extMsgExtended messagestring
msgResponse messagestring

Response Example:

javascript
{
	"code": 0,
	"data": "",
	"extMsg": "",
	"msg": ""
}