Skip to Content
1MSG
ReferenceCampaigns API

Участники сегмента

GET
/api/v1/campaigns/segments/{segmentId}/members

limit — размер страницы, по умолчанию 50, максимум 100. cursor — nextCursor из предыдущей страницы.

Authorization

bearer
headerAuthorizationBearer <API key>

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

Path Parameters

segmentId*string

id сегмента из ответа на создание или из списка.

Query Parameters

limit?string

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

cursor?string

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

Response Body

application/json
  1. response
items*array<>

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

nextCursor*|

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

Example Request
curl -X GET 'https://api.1msg.io/api/v1/campaigns/segments/string/members'
Example Response200
{  "items": [    {      "id": "cm3member01",      "name": "Ana",      "phone": "+15551234567",      "bsuid": "ab.abc123xyz"    }  ],  "nextCursor": null}