Appearance
Bind Device Using DK
API Address:/v2/binding/enduserapi/bindDeviceDk
Request Method:POST
Request Data Type:application/json
Response Data Type:*/*
API Description:Bind device using DK
Request Parameters:
Parameter Name | Parameter Description | Request Type | Required | Data Type | Schema |
---|---|---|---|---|---|
dk | Device Key | query | true | string | |
pk | Product Key | query | true | string | |
capabilitiesBitmask | Device network capabilities: 1-WAN 2-LAN(WiFi) 3-LAN(WiFi)+WAN 4-BLE 5-WAN+BLE 6-LAN(WiFi)+BLE 7-WAN+LAN(WiFi)+BLE 8-Matter 9-WAN+Matter 10-LAN(WiFi)+Matter 11-LAN(WiFi)+WAN+Matter 12-BLE+Matter 13-WAN+BLE+Matter 14-LAN(WiFi)+BLE+Matter 15-WAN+LAN(WiFi)+BLE+Matter | query | false | integer(int32) | |
fid | Family ID | query | false | string | |
frid | Room ID | query | false | string | |
isCommonDevice | In home mode, whether to add to common device list (added by default) | query | false | boolean | |
name | Device name | query | false | string |
Response Status:
Status Code | Description | Schema |
---|---|---|
200 | Successfully bound device using DK | Registration code response data«AuthKey» |
5032 | Token verification failed | |
5041 | No permission | |
5049 | Device already bound | |
5052 | Device not bound | |
5066 | Please enter Product Key | |
5067 | Please enter Device Key | |
5106 | Please enter token | |
5229 | User domain not authorized for this product | |
5314 | Device query failed in cloud platform | |
5327 | No permission for this product | |
5333 | Device name exceeds length limit | |
5358 | No product permission | |
5361 | Incorrect DK format | |
5412 | Product binding mode is unique, cannot bind repeatedly | |
5624 | Home mode not enabled | |
5636 | Please enter family ID | |
5669 | Regular user has no permission to bind device | |
5893 | Failed to add common device | |
6040 | Already accepted device sharing | |
6083 | Bound device does not belong to current data center |
Response Parameters:
Parameter Name | Parameter Description | Type | Schema |
---|---|---|---|
code | Response status code | integer(int32) | integer(int32) |
data | Response data | AuthKey | AuthKey |
authKey | AuthKey | string | |
extMsg | Extended message | string | |
msg | Response message | string |
Response Example:
javascript
{
"code": 0,
"data": {
"authKey": ""
},
"extMsg": "",
"msg": ""
}