POST

/messages/batch

http://iotanalytics.{region}.amazonaws.com/messages/batch

Sends messages to a channel.

Access Token Required: API Key

Body Params

messagesarrayrequired

The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}. The field names of message payloads (data) that you send to IoT Analytics: <ul> <li> Must contain only alphanumeric characters and undescores (_). No other special characters are allowed. </li> <li> Must begin with an alphabetic character or single underscore (_). </li> <li> Cannot contain hyphens (-). </li> <li> In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$". </li> <li> Cannot be more than 255 characters. </li> <li> Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.) </li> </ul> For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

channelNamestringrequired

The name of the channel where the messages are sent.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://iotanalytics.{region}.amazonaws.com/messages/batch' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}