ONonlymonster
priority-mass-message-campaigns

Retrieve one Priority Mass Messages broadcast

Changed on

Rate 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 refused with 502 here, because that content is exactly what was asked for.

Required permission: priority_mass_messages.view

get/api/v0/accounts/{account_id}/priority-mass-message-campaigns/{campaign_id}

Request

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

Path parameters

account_idstring required

OnlyMonster account the broadcast belongs to.

campaign_idstring required

Broadcast identifier.

Response

One Priority Mass Messages broadcast of the account.

idstring required

Broadcast identifier.

account_idstring required

OnlyMonster account the broadcast belongs to.

namestring required

Broadcast name as the account owner set it. For a single-message broadcast created without a name, the text of that message, as the panel shows it. Null for a broadcast created without a name whose content could not be read.

status'scheduled' | 'queued' | 'sending' | 'paused' | 'unsending' | 'sent' | 'unsent' | 'archived' required

State of the broadcast, as the panel shows it. Null for a broadcast holding a state this API does not name, which no broadcast created through it can reach.

pause_reason'manual' | 'send_errors' | 'recipient_import_failed' required

Why the broadcast is paused: manual when a person paused it, send_errors when too many sends failed, recipient_import_failed when the recipients of the broadcast could not be loaded. Null when it is not paused.

progress_percentinteger required

How far the broadcast has got through its audience, from 0 to 100.

created_atstring date-time required

When the broadcast was created (ISO 8601 Zulu).

scheduled_atstring date-time required

When the broadcast is due to go out (ISO 8601 Zulu). Null once it has been dispatched, and null for one that was never scheduled; a broadcast paused before its schedule came due keeps it.

scheduled_at_timezonestring required

IANA zone name the schedule was stated in, so a client can show it the way the panel does. Null whenever scheduled_at is null.

targeted_recipients_countinteger required

Fans the broadcast resolved to. 0 until it has been prepared, and unaffected by what was delivered afterwards.

Example response

{
  "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