Help Center > > API Reference> Northbound PHP SDK API Reference> Service API List> Message Push> NB-IoT Device Command Status Change Notification

NB-IoT Device Command Status Change Notification

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

Typical Scenario

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

API Function

The IoT platform pushes notification messages to NAs when the command status changes.

Note

  1. When Creating Device Commands, an NA must subscribe to the specified callback address in the API description. The server and port in the callback address are the public IP address and specified port of the NA.
  2. An NA receives the content of a push message by inheriting the PushMessageReceiver class and rewriting the callback API.
  3. If the callback address is not the address of the NA, the NA must implement the original callback API.

API Description

Callback URL

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

Callback API

function handleNBCommandStateChanged(NotifyNBCommandStatusChangedDTO $body)

Class

PushMessageReceiver

Parameter Description

NotifyNBCommandStatusChangedDTO structure

Parameter

Mandatory or Optional

Location

Description

$deviceId

Mandatory

body

Uniquely identifies a device.

$commandId

Mandatory

body

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

$result

Mandatory

body

For details, see NBCommandResult structure.

NBCommandResult structure

Parameter

Mandatory or Optional

Location

Description

$resultCode

Mandatory

body

Indicates the command status result.

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

$resultDetail

Mandatory

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
    }
}

Response Example

Response:
Status Code: 200 OK

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