Help Center > > API Reference> Northbound PHP SDK API Reference> Service API List> Command Delivery (NB-IoT Commands)> Creating Device Command Revocation Tasks

Creating Device Command Revocation Tasks

Updated at: Aug 28, 2019 GMT+08:00

Typical Scenario

After an NA delivers commands to a device, the IoT platform does not deliver the commands to the device for execution (the commands are in the DEFAULT state) if the commands are in queue or the device is offline. In this case, the NA can call this API to revoke all the undelivered commands of a specified device. Commands that have been delivered cannot be revoked.

API Function

This API is used by an NA to create a command revocation task to revoke all undelivered commands (that is, commands in the DEFAULT state) with the specified device ID on the IoT platform.

API Description

1
public function createDeviceCmdCancelTask($cdcctInDTO, $appId, $accessToken)

Parameter Description

Parameter

Mandatory or Optional

Location

Description

$cdcctInDTO

Mandatory

body

For details, see CreateDeviceCmdCancelTaskInDTO structure.

$appId

Mandatory

query

If the command 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.

CreateDeviceCmdCancelTaskInDTO

Parameter

Mandatory or Optional

Location

Description

$deviceId

Mandatory

body

Identifies the device whose commands are to be revoked. The revocation task will revoke all commands delivered to this device.

Response Parameters

CreateDeviceCmdCancelTaskOutDTO

Parameter

Description

$taskId

Identifies a command revocation task.

$appId

Identifies the application to which the command revocation task belongs.

$deviceId

Identifies the device whose commands are to be revoked by the revocation task.

$status

Indicates the status of the command revocation task.

  • WAITING: The task is waiting to be executed.
  • RUNNING: The task is being executed.
  • SUCCESS: The task has been successfully executed.
  • FAILED: The task fails to be executed.
  • PART_SUCCESS: Task execution partially succeeds.

$totalCount

Indicates the total number of revoked commands.

$deviceCommands

Indicates the revoked device command list. For details, see DeviceCommandRespV4 structure.

DeviceCommandRespV4 structure

Parameter

Description

$commandId

Identifies a device command.

$appId

Uniquely identifies an NA. This parameter is used to identify an NA that can call open APIs provided by the IoT platform.

$deviceId

Uniquely identifies the device to which the command is delivered.

$command

Indicates information about the delivered command. For details, see CommandDTOV4 structure.

$callbackUrl

Indicates the URL for receiving command status change notifications. When the command status changes, such as execution failure, execution success, timeout, sending, or sent, the NA is notified.

$expireTime

Indicates the command expiration time, in units of seconds. The command will not be delivered after the specified time elapses. The default validity period is 48 hours (86400 seconds x 2).

$status

Indicates the status of the command.

  • DEFAULT: The command has not been delivered.
  • EXPIRED: The command has expired.
  • SUCCESSFUL: The command has been successfully executed.
  • FAILED: The command fails to be executed.
  • TIMEOUT: Command execution times out.
  • CANCELED: The command has been canceled.

$result

Indicates the detailed command execution result.

$creationTime

Indicates the time when the command is created.

$executeTime

Indicates the time when the command is executed.

$platformIssuedTime

Indicates the time when the IoT platform sends the command.

$deliveredTime

Indicates the time when the command is delivered.

$issuedTimes

Indicates the number of times the IoT platform delivers the command.

$maxRetransmit

Indicates the maximum number of times the command can be retransmitted.

CommandDTOV4 structure

Parameter

Mandatory or Optional

Description

$serviceId

Mandatory

Identifies the service corresponding to the command.

$method

Mandatory

Indicates the command name.

$paras

Optional

Indicates a JSON string of command parameters. The specific format is negotiated by the NA and the device.

Error Codes

HTTP Status Code

Error Code

Error Description

Remarks

200

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.

200

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.

200

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.

400

100022

The input is invalid.

An input parameter is invalid.

Recommended handling: Check whether parameters carried in the API call request are valid.

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.

500

100001

Internal server error.

An internal server error occurs.

Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.

500

100220

Get AppKey from header failed.

Failed to obtain the appKey.

Recommended handling: Check whether appId is carried in the API request header.

503

100501

Congestion occurs, and the current network has been flow-controlled

Congestion occurs. The current network is under flow control.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel