Retrieve the Priority Mass Messages broadcasts of an account
Changed onRate limit: 5 requests per second
A schedule reads back as null once the broadcast has been dispatched; a broadcast paused before its schedule came due keeps it.
Sent, unsent and purchased figures, and the purchased amount, count the first message of the broadcast only; replies are counted across every step. Because of that a sequence can report more replies than sends, and its reply_rate then reads null rather than a figure above 1.
A broadcast whose content could not be read is listed with messages: [] and every figure at zero, rather than failing the page.
Required permission: priority_mass_messages.view
Request
- Base URLhttps://omapi.onlymonster.ai
- AuthAPI key in header x-om-auth-token
Path parameters
OnlyMonster account whose broadcasts are read.
Query parameters
Items per page (min: 1, max: 100, default: 50).
Items to skip (default: 0).
Include archived broadcasts in the page (default: false). Only archived is affected — every other state is always listed.
Response
A page of the account Priority Mass Messages broadcasts, newest first.
Example response
{
"items": [
{
"id": "4312",
"account_id": "12345",
"created_by": {
"id": "42"
},
"scheduled_at_timezone": "Europe/Berlin",
"rules": {
"end_at_timezone": "Europe/Berlin"
},
"messages": [
{
"price_gross": 9.99,
"attachments": [
{
"id": "1289402"
}
],
"tagged_platform_account_ids": [
"67890"
]
}
]
}
]
}Changes
- warning
added the new
verified_accountenum value to the////response property for the response status
- warning
- info
endpoint added
- info