Skip to Content
1MSG
ReferenceCampaigns API

Ответы

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

replyType — button или text. buttonId оставляет одну кнопку. phone и bsuid оставляют одного получателя. dateFrom и dateTo — в ISO-8601. providerConversationId — id чата у провайдера. messageId и providerMessageId — id сообщения у провайдера.

Authorization

bearer
headerAuthorizationBearer <API key>

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

Path Parameters

campaignId*string

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

Query Parameters

replyType?string

button оставляет нажатия кнопок. text — ответы текстом. Без параметра вернутся оба вида.

Value in"button""text"
buttonId?string

id одной кнопки шаблона.

phone?string

Телефон одного получателя в формате E.164.

bsuid?string

BSUID одного получателя у провайдера, например ab.abc123xyz.

dateFrom?string

Начало периода в ISO-8601, включительно, например 2026-11-01T00:00:00Z.

dateTo?string

Конец периода в ISO-8601, включительно, например 2026-11-02T00:00:00Z.

limit?number

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

cursor?string

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

Response Body

application/json
  1. response
campaignId*string

id рассылки.

totalReplies*number

Число ответов по всей рассылке, а не только на этой странице.

uniqueRepliers*number

Сколько получателей ответили хотя бы раз за всю рассылку.

items*array<>

Ответы на этой странице, сначала старые.

nextCursor*|

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

Example Request
curl -X GET 'https://api.1msg.io/api/v1/campaigns/string/analytics/replies'
Example Response200
{  "campaignId": "cm3campaign01",  "totalReplies": 4,  "uniqueRepliers": 3,  "items": [    {      "type": "button",      "buttonId": "shop",      "text": "string",      "phone": "+15551234567",      "bsuid": "ab.abc123xyz",      "name": "Ana",      "conversationId": "cm3dialog01",      "providerConversationId": "[email protected]",      "receivedAt": "2026-11-01T09:00:00.000Z",      "messageId": "wamid.HBgM",      "providerMessageId": "wamid.HBgM"    }  ],  "nextCursor": null}