instant messages
Api reference content
get/api/messages/instant
Retrives all active instant messages. Results can be paged with query parameters start and limit.
Parameters
| Parameter | Place | Required | Description |
|---|---|---|---|
| start | query | required | First item in page |
| limit | query | required | Number of items in page |
Responses
| Status | Description |
|---|---|
| 200 | application/json {
"_links": {
"next": "string",
"base": "string",
"self": "string"
},
"start": "double",
"limit": "double",
"results": [
{
"name": "string",
"file_id": "string",
"actions": [
{
"mac": "string",
"audio": "boolean",
"relays": "[double]"
}
],
"special_volume": "double",
"is_stereo": "boolean",
"id": "string",
"startedAt": "double"
}
]
} |
| 400 | application/json {
"errors": "[string]"
} |