Skip to main content

Send Downlink Message

POST https://link.monoz.io/api/v1/{Org-Id}/Publish/Message

This API can be used to send a downlink message to the connected device. The default topic for downlink message shall be published to /< ORGID>/< ICCID>/sub

Args​
ICCID
Unique ICCID of target device
Topic
MQTT Topic can be empty or multiple but must start with a slash (/). For example: "/Name1/Name2/..".
Max length is 512 bytes with including default topc "/< ORGID>/<ICCID>/sub".
QoS
MQTT QoS can be 0 or 1.
Message
Downlink message. Range is 1-4096 bytes.
monoZ:Jet max message length is 1024 bytes.
RetainLastMessage
When set to true, the message is stored by monoZ:Link broker and device shall receive it upon successful subscribe.
True: Send as Retain message.
False: Send as Non-Retain message.
Format
Designate downlink message format.
0:JSON
If message is JSON format, any CRLF or CR included in messsage shall be removed by monoZ:Link before pushing to the device.
1:TEXT
Sends message without any formatting.

Response​
200
Success MessagePublished
Response Body​

StatusCode   integer

HTTP status code of the response.

Message   string

Message indicating the result of the operation.

401
Unauthorized If the API Key is wrong or there is no permission to access the requested data.
400
Bad Request If the input value is not in the correct format.
404
Not Found If the specified ICCID was not found in the system.
500
Server Error As described in the Message field.
cURL​
    curl --location 'https://link.monoz.io/api/v1/mti/Publish/Message' \
    --header 'Content-Type: application/json' \
    --header 'X-API-Key: 3fa36b0e-c88b-45f4-95b9-d77c0e27c07a' \
    --data '{
        "ICCID": "12345678",
        "Topic": "/ABC",
        "Message": "XYZ",
        "RetainLastMessage": true,
        "QoS": 0,
        "Format": 1
    }'
Response​
{
    "StatusCode": 200,
    "Message": "MessagePublished"
}