Register Sub-device

Last Updated on : 2024-02-28 03:29:39download

API address

POST: /v1.0/iot-03/3rdcloud/devices/{third_cloud_device_id}/sub/register

Request parameter

Parameter name	Type	IN	Required	Description
third_cloud_device_id	String	uri	true	The unique ID of a manufacturer's device. It can be a unique readable identifier of the specified device, such as device SN, MAC address, or IMEI. It contains no more than 64 characters, including only numbers, uppercase letters, and lowercase letters.

Description of body

Parameter name	Type	IN	Required	Description
device_name	String	body	true	The name of the specified device, with no more than 50 characters.
product_id	String	body	true	The ID of the specified Tuya-enabled device.
gateway_id	String	body	true	The ID of the specified Tuya-enabled gateway device.
options	Object	body	false	The extension information about the specified device. Valid values: `installLocation`: the installation location. `outProjectId`: the project ID of the device in the manufacturer's cloud. `mac`: the MAC address. `extendData`: in JSON format, for example, `{"roomNo":"16"}`, where `roomNo` is the hotel room number.
group_id	String	body	false	The binding ID, which can be the home ID or asset ID. If you want to bind a device with a user, you can select either the `group_id` field or the `has_qrcode` field.
has_qrcode	Boolean	body	false	Specifies whether or not to generate a short URL for device pairing. If this parameter is selected, the short URL for device pairing will be returned in the response result. The manufacturer can generate a QR code based on the returned short URL and paste it on the device. After getting the device, a user can use a Tuya-enabled app to scan the QR code on the device, and thus bind the device with the user. If you want to bind a device with a user, you can select either the `group_id` field or the `has_qrcode` field.

Return parameter

Parameter name	Type	Description
result	Object	The response result.
code	String	The response code. It is empty if the request is successful.
msg	String	The message that is returned if the request fails. It is empty if the request is successful.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
t	Long	The 13-digit timestamp of a response.

Description of result

Parameter name	Type	Description
device_id	String	The ID of the specified Tuya-enabled device.
short_url	String	The short URL for device pairing.

Request example

POST: /v1.0/iot-03/3rdcloud/devices/A18007210830****/sub/register

{
  "device_name": "Test Device",
  "product_id": "xz0uukkq5oce****",
  "gateway_id": "26f4b7ef5f6511cafb****",
  "options": {
    "mac": "48ea63fd****",
    "installLocation": "****Jiangdun Road, Xihu District, Hangzhou City",
  }
}

Return example

{
    "result": {
        "device_id": "6cf4171005d11e2ca7****"
    },
    "t": 1561456817168,
    "success": true
}

Error code

For more information, see error code.

Prev DocReport Device DPs

Next DocIdentity and Access Management