Deleting a Device (Verification Code Mode)

Typical Scenario

If a device that has been registered with the IoT platform does not need to connect to the platform, an NA can call this API to delete the device. If the device needs to connect to the IoT platform again, the NA must register the device again.

API Function

This API is used by an NA to delete a registered device from the IoT platform.

API Description

1	public function deleteDirectDevice($deviceId, $cascade, $appId, $accessToken)

Class

DeviceManagement

Parameter Description

Parameter	Mandatory or Optional	Location	Description
$deviceId	Mandatory	path	Identifies a device. The device ID is allocated by the IoT platform during device registration.
$cascade	Mandatory	query	This parameter is valid only when the device is connected to a non-directly connected device. If this parameter is not set, the value null is used. true: The directly connected device and the non-directly-connected devices connected to it are deleted. false: The directly connected device is deleted but the non-directly-connected devices connected to it are not deleted. In addition, the attribute of the non-directly-connected devices is changed to directly-connected.
$appId	Mandatory	query	If the device belongs to the current application, set this parameter to null. Otherwise, set this parameter to the ID of the authorized application.
$accessToken	Mandatory	header	This parameter is set to the value of the access token obtained by calling the Authentication API.

Return Value

Status Code: 204 No Content

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.
404	100418	The deviceData is not existed.	The device data does not exist. Recommended handling: If deviceId carried in the request is incorrect, check whether deviceId belongs to appId or whether deviceId is incorrect. Check whether appId carried in the header contains deviceId. If the URL contains the optional parameter appId, check whether the value of appId 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.