SIMs (Devices)

Send TCP/UDP cloud message to a SIM

Send a cloud message (data) to one or more SIMs using device IDs. Messages can be sent as plain text using the data parameter or as base64-encoded content using the base64data parameter. Port must be between 1 and 65535. Protocol must be TCP or UDP. Max data size is 10K.

post/devices/messages

Request

Base URL
https://dashboard.hologram.io/api/1
Auth
HTTP basic
TypeScript
https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/devices/messages/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

deviceidsinteger[] required

List of device IDs to send the message to

portinteger required

Destination port number (1–65535)

protocol'TCP' | 'UDP' required

Transport protocol for the message

datastring

Data to send (plain text). Max 10K

base64datastring

Data to send encoded in base64. Max 10K

encryptedboolean

When true (default), encrypt the message payload

Example request

{
  "protocol": "TCP"
}

Response

successboolean

Indicates whether the request was successful.

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.