scheduled messages

Api reference content
get/api/messages/scheduled/active

Retrives all active scheduled messages. Results can be paged with query parameters start and limit.

Parameters

ParameterPlaceRequiredDescription
startqueryrequiredFirst item in page
limitqueryrequiredNumber of items in page

Responses

StatusDescription
200
application/json
{
  "_links": {
    "next": "string",
    "base": "string",
    "self": "string"
  },
  "start": "double",
  "limit": "double",
  "results": [
    {
      "id": "string",
      "name": "string",
      "start_at": "string",
      "repeat_until": "string",
      "repeat_each": "string",
      "file_id": "string",
      "days_of_week": "su | mo | tu | we | th | fr | sa",
      "actions": [
        {
          "mac": "string",
          "audio": "boolean",
          "relays": "[double]"
        }
      ],
      "duration_limit": "double"
    }
  ]
}
400
application/json
{
  "errors": "[string]"
}