Skip to Content
1MSG
ReferenceCampaigns API

Аналитика по получателям

GET
/api/v1/campaigns/{campaignId}/analytics/recipients

Одна строка на получателя. filter — список через запятую: sent, delivered, read, replied, failed, skipped или cancelled. filter=clicked отклоняется: используйте filter=replied вместе с replyType=button. fields ограничивает набор колонок. conversationId — диалог в Inbox. providerConversationId — id чата у провайдера. messageId и providerMessageId — id сообщения у провайдера. limit — максимум 100. cursor — nextCursor.

Authorization

bearer
headerAuthorizationBearer <API key>

Ключ выдаётся в Settings → Developer → API key. Методам Inbox нужен доступ Inbox, методам Campaigns — доступ Campaigns.

Path Parameters

campaignId*string

id рассылки из ответа на создание или из списка.

Query Parameters

filter?string

Через запятую: sent, delivered, read, replied, failed, skipped, cancelled. filter=clicked отклоняется — используйте replied вместе с replyType=button.

replied?string

true оставляет только тех, кто ответил. false — тех, кто не ответил.

Value in"true""false"
replyType?string

button оставляет нажатия кнопок. text — ответы текстом.

Value in"button""text"
buttonId?string

id одной кнопки шаблона. Используйте вместе с replyType=button.

reason?string

Точная причина пропуска или ошибки из списка ошибок.

fields?string

Нужные колонки через запятую. Если нужны id у провайдера, добавьте providerConversationId и providerMessageId. conversationId — id диалога в Inbox. messageId — id сообщения у провайдера.

limit?number

Размер страницы, от 1 до 100. По умолчанию 50.

cursor?string

nextCursor из предыдущей страницы. Для первой страницы оставьте пустым.

Response Body

application/json
  1. response
items*array<>

Получатели на этой странице. Если задан параметр fields, в каждом элементе только перечисленные поля.

nextCursor*|

Курсор следующей страницы или null на последней странице.

Example Request
curl -X GET 'https://api.1msg.io/api/v1/campaigns/string/analytics/recipients'
Example Response200
{  "items": [    {      "phone": "+15551234567",      "bsuid": "ab.abc123xyz",      "name": "Ana",      "conversationId": "cm3dialog01",      "providerConversationId": "[email protected]",      "messageId": "wamid.HBgM",      "providerMessageId": "wamid.HBgM",      "status": "queued",      "sentAt": "2026-11-01T09:00:00.000Z",      "deliveredAt": "2026-11-01T09:00:00.000Z",      "readAt": "2026-11-01T09:00:00.000Z",      "replies": [        {          "type": "button",          "buttonId": "shop",          "text": "string",          "receivedAt": "2026-11-01T09:00:00.000Z",          "messageId": "wamid.HBgM",          "providerMessageId": "wamid.HBgM"        }      ],      "error": {        "code": "string",        "title": "string",        "failedAt": "2026-11-01T09:00:00.000Z"      }    }  ],  "nextCursor": null}