Messages

SendDeviceMessage

Allows a user or IP device to send a message that is subsequently published over an MQTT topic, on behalf of the IP device whose deviceId is specified. The device ID for the message comes from the topic. For instance, if the topic property on the request is m/d/nrf-352656101081837/d2c/custom, the device ID determined for the message will be 'nrf-352656101081837'.

For more information, see Sending device messages.

post/devices/{deviceId}/messages

Request

Base URL
https://api.nrfcloud.com/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nrfcloud/apis/nrf-cloud-rest-api/docs/devices/:deviceId/messages/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

deviceIdstring required

This is the canonical device id used in the device certificate, and as the MQTT client id.

Example:nrf-1234567890123456789000

Request body

topicstring

A string specifying an MQTT topic.

Example request

{
  "topic": "d/7e8f29fa-cb04-4351-a7c4-3917649d2d36/d2c/bulk",
  "message": [
    {
      "temp": 59,
      "units": "F",
      "ts": 1631470795000
    },
    {
      "temp": 54,
      "units": "F",
      "ts": 1631557195000
    }
  ]
}

Changes

No recorded changes to this operation across all 7 revisions of this API.