Querying Device Activation Status

Typical Scenario

After an NA registers a device on the IoT platform, the activation status of the device is false before the device connects to the IoT platform for the first time. When the device connects to the IoT platform for the first time, the activation status of the device is true regardless of whether the device is online, offline, or abnormal. The NA can call this API to query the activation status of the device to check whether the device has connected to the IoT platform.

API Function

This API is used by an NA to query the activation status of a device on the IoT platform to determine whether the device has connected to the IoT platform.

API Prototype

Method	GET
URL	https://server:port/iocm/app/reg/v1.1.0/deviceCredentials/{deviceId}?appId={appId}
Transport Protocol	HTTPS

Request Parameters

Parameter	Mandatory or Optional	Type	Location	Description
app_key	Mandatory	String	header	Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform.
Authorization	Mandatory	String	header	Indicates the authentication information for accessing the IoT platform. The value is Bearer {accessToken}, in which {accessToken} indicates the access token returned by the Authentication API.
deviceId	Mandatory	String	path	Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.
appId	Optional	String	query	Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform. Set this parameter to the value of appId of the authorized application.

Response Parameters

Status Code: 200 OK

Parameter	Type	Description
deviceId	String(256)	Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.
activated	Boolean	Indicates whether the device is activated through a verification code. true: The device is activated. false: The device is not activated.
name	String(256)	Indicates the device name.

Parameter

Type

Description

deviceId

String(256)

Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.

activated

Boolean

Indicates whether the device is activated through a verification code.

true: The device is activated.
false: The device is not activated.

name

String(256)

Indicates the device name.

Request Example

Method: GET
Request:
https://server:port/iocm/app/reg/v1.1.0/deviceCredentials/{deviceId}
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json

Response Example

Response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
  "deviceId": "*******",
  "activated": "*******",
  "name": "*******"
}

Error Codes

HTTP Status Code	Error Code	Error Description	Remarks
403	100203	The application is not existed.	The application does not exist. Recommended handling: Check whether appId carried in the HTTP request header is correct. Check whether appId in the request path (URL) is correct.
403	100217	The application hasn't been authorized.	The application has not been authorized. Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null.
403	1010009	app throttle exceed.	The NA calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default). Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency.
403	1010005	App_key or access_token is invalid.	The access token is invalid. Recommended handling: Check whether accessToken carried in the API request is correct.
404	100403	The device is not existed.	The device does not exist. Recommended handling: Check whether deviceId is correct.
500	100203	The application is not existed.	The application does not exist. Recommended handling: Check whether appId carried in the HTTP request header is correct. Check whether appId in the request path (URL) is correct.
500	50252	Internal server error.	An internal server error occurs. Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.