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

Creating Device Commands

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

Typical Scenario

The device profile file defines commands that the IoT platform can deliver to a device. When an NA needs to configure or modify the service attributes of a device, the NA can call this API to deliver commands to the device.

The IoT platform provides two command delivery modes:

  • Immediate delivery: The IoT platform delivers commands to devices immediately after receiving the commands. This ensures real-time performance but does not ensure serialization.
  • Pending delivery: After receiving commands, the IoT platform caches the commands. When the devices are reachable, the IoT platform delivers the commands in sequence. Specifically, the IoT platform delivers the latter command only after receiving the response of the previous command (which is the ACK automatically replied by the module) to ensure serialization instead of real-time performance.

API Function

This API is used by NAs to deliver commands to devices. Immediate delivery and pending delivery are supported on the IoT platform.

API Description

1
PostDeviceCommandOutDTO2 postDeviceCommand(PostDeviceCommandInDTO2 pdcInDTO, String appId, String accessToken) throws NorthApiException

Parameter Description

Parameter

Mandatory or Optional

Type

Location

Description

pdcInDTO

Mandatory

PostDeviceCommandInDTO2 structure

body

For details, see PostDeviceCommandInDTO2 structure.

appId

Mandatory

String

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

String

header

If the Periodically Refreshing a Token API is called, set this parameter to null. Otherwise, set this parameter to the accessToken obtained by the Authentication API.

PostDeviceCommandInDTO2 structure

Parameter

Mandatory or Optional

Type

Location

Description

deviceId

Mandatory

String(64)

body

Uniquely identifies the device that delivers the command.

command

Mandatory

CommandDTOV4

body

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

callbackUrl

Optional

String(1024)

body

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

Optional

Integer(>=0)

body

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

If this parameter is set to 0, the IoT platform will deliver the command to the specific device immediately regardless of the command mode set on the IoT platform (if the device is sleeping or the link has aged, the device cannot receive the command, the IoT platform cannot receive any response from the device, and the command times out in the end).

maxRetransmit

Optional

Integer(0-3)

body

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

CommandDTOV4 structure

Parameter

Mandatory or Optional

Type

Location

Description

serviceId

Mandatory

String(1-64)

body

Identifies the service corresponding to the command. The value of this parameter must be the same as serviceId defined in the profile.

method

Mandatory

String(1-128)

body

Indicates the command name. The value of this parameter must be the same as the command name defined in the profile file.

paras

Mandatory

ObjectNode

body

Indicates a command parameter in the jsonString format. The value consists of key-value pairs. Each key is the paraName parameter in commands in the profile file. The specific format depends on the application and device.

If no parameter is defined in the command in the profile file, left it blank, that is, "paras": {}.

Response Parameters

PostDeviceCommandOutDTO2 structure

Parameter

Type

Description

commandId

String(1-64)

Identifies a device command.

appId

String(1-64)

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

deviceId

String(1-64)

Uniquely identifies the device that delivers the command.

command

CommandDTOV4

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

callbackUrl

String(1024)

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

Integer(>=0)

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

String

Indicates the status of the command.

  • PENDING: 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.
  • DELIVERED: The command has been delivered.
  • SENT: The command is being delivered.

creationTime

String(20)

Indicates the time when the command is created.

executeTime

String(20)

Indicates the time when the command is executed.

platformIssuedTime

String(20)

Indicates the time when the IoT platform sends the command.

deliveredTime

String(20)

Indicates the time when the command is delivered.

issuedTimes

Integer(>=0)

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

maxRetransmit

Integer(0-3)

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

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.

200

100428

The device is not online.

The device is not online.

Recommended handling: Check whether the connection between the device and the IoT platform is normal.

200

100431

The serviceType is not exist.

The service type does not exist.

Recommended handling:

  • Check whether the profile file of the device has been uploaded to the IoT platform.
  • Check whether the request parameters are correct and whether serviceId exists in the profile file.

400

100022

The input is invalid.

An input parameter is invalid.

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

400

100223

Command counts has reached the upLimit.

The number of cached commands reaches the limit. The number of commands in the PENDING state does not exceed the limit. The default value is 20.

Recommended handling: If the commands cached on the IoT platform need to be executed, enable the device to report data to trigger delivery of the cache commands. If a command cached on the IoT platform does not need to be executed, call the API used for modifying device commands V4 to change the state of the command from PENDING to CANCELED.

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

100612

Device is zombie.

The device is a zombie device. (The interval between the current system time and the time when the device went online exceeds the threshold. The default value is seven days.)

Recommended handling: Run the command again after the device goes online.

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

100023

The data in database is abnormal.

The database is abnormal.

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.

500

101016

Get iotws address failed.

Failed to obtain the IoTWS address.

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

500

101017

Get newCallbackUrl from oss failed.

Obtaining a new callback URL from the OSS fails.

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

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