Help Center> IoT Device Access> SDK Reference> Old SDKs> Application Java SDK API Reference> Message Push> Pushing an NB-IoT Device Command Status Change Notification
View PDF

Pushing an NB-IoT Device Command Status Change Notification

Typical Scenario

When an application creates a device command with the callback URL specified, the platform pushes a notification to the application if the command status changes (failed, successful, timeout, sent, or delivered).

API Function

The platform pushes notifications to applications when the command status changes.

Note

1. When creating an NB-IoT device command, an application must set the callback URL in the API description. The server and port in the callback URL are the public IP address of the application and the port specified in the server configuration.

2. An application receives the content of a push message by inheriting the PushMessageReceiver class and overriding the callback API.

3. If the callback URL is not the address of the application, the application must implement the original callback API.

API Description

Callback URL

https://server:port/v1.0.0/messageReceiver/cmd

Callback API

void handleNBCommandStateChanged(NotifyNBCommandStatusChangedDTO body)

Class

PushMessageReceiver

Parameter Description

NotifyNBCommandStatusChangedDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

deviceId

Mandatory

String

body

Uniquely identifies a device.

commandId

Mandatory

String

body

Identifies a command, which is generated by the platform during device creation.

result

Mandatory

NBCommandResult

body

For details, see NBCommandResult structure.

NBCommandResult structure

Parameter

Mandatory or Optional

Type

Location

Description

resultCode

Mandatory

String

body

Indicates the command status result.

  • SENT: The platform has delivered a command to the device but has not received a response from the device.
  • DELIVERED: The platform receives a response from a device.
  • SUCCESS: The platform receives a command result and the result is success.
  • FAIL: The platform receives a command result and the result is a failure.

resultDetail

Mandatory

ObjectNode

body

Indicates the user-defined fields carried in the command result.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "deviceId":"*********",
    "commandId":"***********",
    "result":{
        "resultCode":"DELIVERED",
        "resultDetail":null
    }
}

Normal Response Example

Response:
Status Code: 200 OK
Parent topic: Message Push