Cloud Services API ReferenceIoT CoreDevice ManagementQuery Pairing Result

Query Pairing Result

Last Updated on : 2023-11-23 06:54:26download

Based on the pairing token, query the pairing result.

API address

GET: /v2.0/cloud/thing/active/token/{token}

Request parameter

Parameter name	Type	IN	Required	Description
token	String	path	true	The pairing token.

Return parameter

Parameter name	Type	Description
result	DeviceActiveRes	The list of returned data.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: The operation succeeded. `false`: The operation failed.
t	Long	The timestamp.
tid	String	The link ID.

Description of result

Parameter name	Type	Description
successDevices	List	The list of paired devices.
errorDevices	List	The list of devices failed in pairing.

Description of errorDevices

Parameter name	Type	Description
id	String	The device ID.
name	String	The device name.
errorCode	String	The error code returned on failure.
errorMsg	String	The error message.

Description of successDevices

Parameter name	Type	Description
id	String	The device ID.
name	String	The device name.
productId	String	The product ID.
lon	String	The longitude.
lat	String	The latitude.
ip	String	The IP address of the specified device.
online	Boolean	Indicates whether the device is online.
uuid	String	The universally unique identifier (UUID) of the specified device.

Request example

GET: /v2.0/cloud/thing/active/token/AG******

Return example

{
    "tid": "b8a2b49abbbc11eda71e169efc83a172",
    "result": {
        "successDevices": [
            {
                "productId": "ngarn****",
                "ip": "0.0.0.0",
                "lon": "0",
                "uuid": "drdz05cce7**********",
                "name": "Device name",
                "online": true,
                "id": "vdevo163815529739***",
                "lat": "0"
            }
        ],
        "errorDevices": [
            {
                "errorCode": "2001",
                "errorMsg": "device is offline",
                "name": "Device name",
                "id": "vdevo163815529739***"
            }
        ]
    },
    "t": 1678065474602,
    "success": true
}

Error code

For more information, see error code.

Prev DocPair Device by Scanning QR Code

Next DocDevice Control