Skip to content

Bind Device Using SN

API Address:/v2/binding/enduserapi/bindDeviceSn

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

API Description:Bind device using SN

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
pkProduct Keyquerytruestring
snDevice SNquerytruestring
capabilitiesBitmaskDevice 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
queryfalseinteger(int32)
deviceNameDevice namequeryfalsestring
fidFamily IDqueryfalsestring
fridRoom IDqueryfalsestring
isCommonDeviceIn home mode, whether to add to common device list (added by default)queryfalseboolean

Response Status:

Status CodeDescriptionSchema
200Successfully bound device using SNRegistration code response data«Binding»
5009Device verification failed
5032Token verification failed
5041No permission
5048Device binding failed
5049Device already bound
5052Device not bound
5066Please enter Product Key
5067Please enter Device Key
5088Please enter device SN
5089Device SN request failed
5090Requested device SN invalid
5093Abnormal user domain
5106Please enter token
5229User domain not authorized for this product
5314Device query failed in cloud platform
5327No permission for this product
5333Device name exceeds length limit
5361Incorrect DK format
5412Product binding mode is unique, cannot bind repeatedly
5553Product or device does not exist
5624Home mode not enabled
5636Please enter family ID
5669Regular user has no permission to bind device
5893Failed to add common device
6040Already accepted device sharing
6083Bound device does not belong to current data center

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeResponse status codeinteger(int32)integer(int32)
dataResponse dataBindingBinding
  authKeyAuthKeystring
  dkDevice Keystring
  moduleTypeDevice modelstring
  pkProduct Keystring
extMsgExtended messagestring
msgResponse messagestring

Response Example:

javascript
{
	"code": 0,
	"data": {
		"authKey": "",
		"dk": "",
		"moduleType": "",
		"pk": ""
	},
	"extMsg": "",
	"msg": ""
}