mass-messages

Retrieve the Mass Messages of an account

Changed on

Rate limit: 5 requests per second

Pagination is by cursor: set to to the created_at of the last item of the page just read. The cursor has one-second precision — deduplicate by id.

The first page starts with every scheduled Mass Message, soonest first, then every Mass Message still sending, then the history newest first. The scheduled and sending ones are not counted against limit, so the first page may hold more than limit items. It is the only page that carries total; total reads null on every page after it.

Required permission: mass_messages.view

get/api/v0/accounts/{account_id}/mass-messages

Request

  • Base URL
    https://omapi.onlymonster.ai
  • Auth
    API key in header x-om-auth-token

Path parameters

account_idstring required

OnlyMonster account whose Mass Messages are addressed.

Query parameters

limitinteger

Items per page (min: 1, max: 100, default: 50).

tostring date-time

Cursor: the created_at of the last item of the previous page.

Response

A page of the account's Mass Messages. The first page starts with every scheduled message, soonest first, then every message still sending, then the history newest first; the scheduled and sending ones are not counted against limit, so it may hold more than limit items.

has_moreboolean required

True when more Mass Messages exist beyond this page.

totalinteger required

The account's number of Mass Messages. Null on every page after the first.

Example response

{
  "items": [
    {
      "id": "4312"
    }
  ]
}

Changes