GetRecipients

[POST] .../v1/campaign/getrecipients

Returns information about recipients campaign. Use this method after Campaign/Get or Campaign/Add to inspect recipients collected for one campaign and monitor individual delivery states. The response returns paged CampaignRecipient records with next_offset and total, including recipient ID, campaign ID, destination address or account, delivery state and last update time. The public request should filter by campaign_id and may also filter by state. The caller must have marketing campaign select permission; missing body, missing campaign_id selection, denied access, invalid filters, missing campaign for campaign_id, database failures and persistent lookup errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Number of result items to return.
offset Int32 Optional Offset from the beginning of the result set.

Filterable Fields

Field Type Description
campaign_id int Campaign ID.
state string Recipient status (New, Sended, Delivered, Error).

Request Example

{
  "filters": [
    {
      "Field": "campaign_id",
      "Operator": "Equal",
      "Value": "1"
    },
    {
      "Field": "state",
      "Operator": "Equal",
      "Value": "New"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of CampaignRecipient Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 10,
      "campaign_id": 1,
      "recipient": "\u002B998901234567",
      "state": "New",
      "last_update": 1712345680
    }
  ],
  "next_offset": 0,
  "total": 1
}