Получить список рассылок
Описание
Получить список рассылок.
URL-адрес
Метод: POST
https://example.com/api/v1.1/campaigns/list
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| from_id | int | 1 | Нет | Идентификатор первой рассылки в ответе по умолчанию – 1 |
| limit | int | 2 | Нет | Лимит на количество возвращаемых данных по умолчанию – 1000 |
| type | string | "trigger" | Нет | Тип рассылки |
| is_active | bool | true | Нет | Статус рассылки |
| ui_tags | []String | [ "tag1", "tag2" ] | Нет | Список тегов для поиска по умолчанию – [] |
| groups | []String | [ "group1", "group2" ] | Нет | Список групп для поиска по умолчанию – [] |
| groups_id | []int | [ 0, 1 ] | Нет | Список ID групп для поиска по умолчанию – [] |
| attributes | object | {"season": {"options": ["spring_2024", "summer_2024"]}} | Нет | Значения атрибутов для поиска |
| message_id | int | 42 | Нет | Идентификатор шаблона сообщения для фильтрации рассылок Возвращаются только рассылки, использующие указанный шаблон |
Пример запроса
- JSON
- XML
{
"limit": 2
}
<xml>
<limit>2</limit>
</xml>
Пример ответа
- JSON
- XML
{
"data": [
{
"id": 5,
"name": "New meteoric campaign",
"type": "broadcast",
"is_active": false,
"subid": "",
"for_confirm": false,
"ui_tags": [],
"groups": [
{
"id": 0,
"name": "main"
}
],
"attributes": {
"season": "spring_2024",
"branch": "marketing"
},
"content": [
{
"subject": "Promo email",
"from_email": "promo@example.com",
"from_name": "Promo Team",
"replyto_email": "support@example.com",
"replyto_name": "Support",
"message_id": 42,
"message_name": "Spring Promo Template"
}
],
"data_type": "segment",
"updatetime": "2026-07-22T12:00:00Z",
"updated_user": "john.doe"
},
{
"id": 7,
"name": "Copy of New meteoric campaign",
"type": "trigger",
"is_active": true,
"subid": "",
"for_confirm": false,
"ui_tags": [],
"groups": [
{
"id": 0,
"name": "main"
}
],
"providers": [
"google",
"mozilla",
"safari",
"safari-native",
"firefox-firebase",
"chrome-firebase",
"opera-firebase",
"yandex-firebase",
"samsung-firebase",
"android-firebase",
"ios-firebase",
"ios-apns"
],
"content": [
{
"message_id": 15,
"message_name": "Push Notification"
}
],
"data_type": "trigger",
"updatetime": "2026-07-22T13:00:00Z",
"updated_user": "jane.smith"
}
],
"error": 0,
"error_text": "Successful operation",
"next_from_id": 8,
"total_count": 134
}
<xml>
<error>0</error>
<error_text>Successful operation</error_text>
<data>
<id>5</id>
<name>New meteoric campaign</name>
<type>broadcast</type>
<is_active>false</is_active>
<subid></subid>
<for_confirm>false</for_confirm>
<groups>
<id>0</id>
<name>main</name>
</groups>
<attributes>
<season>spring_2024</season>
<branch>marketing</branch>
</attributes>
<content>
<subject>Promo email</subject>
<from_email>promo@example.com</from_email>
<from_name>Promo Team</from_name>
<replyto_email>support@example.com</replyto_email>
<replyto_name>Support</replyto_name>
<message_id>42</message_id>
<message_name>Spring Promo Template</message_name>
</content>
<data_type>segment</data_type>
<updatetime>2026-07-22T12:00:00Z</updatetime>
<updated_user>john.doe</updated_user>
</data>
<data>
<id>7</id>
<name>Copy of New meteoric campaign</name>
<type>trigger</type>
<is_active>true</is_active>
<subid></subid>
<for_confirm>false</for_confirm>
<groups>
<id>0</id>
<name>main</name>
</groups>
<providers>
<provider>google</provider>
<provider>mozilla</provider>
<provider>safari</provider>
<provider>ios-apns</provider>
</providers>
<content>
<message_id>15</message_id>
<message_name>Push Notification</message_name>
</content>
<data_type>trigger</data_type>
<updatetime>2026-07-22T13:00:00Z</updatetime>
<updated_user>jane.smith</updated_user>
</data>
<next_from_id>8</next_from_id>
<total_count>134</total_count>
</xml>
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |
| next_from_id | int | Значение для передачи в параметр from_id следующего запроса для постраничной навигации. Передавайте до тех пор, пока массив data н е станет пустым |
| id | int | Идентификатор рассылки |
| is_active | bool | Статус рассылки |
| name | string | Название рассылки |
| type | string | Тип рассылки |
| total_count | int | Общее количество рассылок |
| for_confirm | bool | Имеет ли рассылка сообщения со ссылкой подтверждения |
| ui_tags | []String | Список тегов |
| groups | []object | Список групп (объекты с полями id и name) |
| subid | string | SubID рассылки |
| attributes | object | Атрибуты, назначенные рассылке, и их значения |
| scampaign_id | int | Идентификатор кампании, в которой задействована рассылка (Параметр возвращается, если рассылка задействована в кампании) |
| content | []object | Массив контента рассылки (шаблоны сообщений) |
| content[].message_id | int | Идентификатор шаблона сообщения |
| content[].message_name | string | Название шаблона сообщения |
| content[].subject | string | Тема сообщения (только для email-рассылок; если не задана в рассылке — берётся из шаблона) |
| content[].from_email | string | Email отправителя (только для email-рассылок; если не задан в рассылке — берётся из шаблона) |
| content[].from_name | string | Имя отправителя (только для email-рассылок; если не задано в рассылке — берётся из шаблона) |
| content[].replyto_email | string | Email для ответа (только для email-рассылок; если не задан в рассылке — берётся из шаблона) |
| content[].replyto_name | string | Имя для ответа (только для email-рассылок; если не задано в рассылке — берётся из шаблона) |
| data_type | string | Тип источника аудитории рассылки Возможные значения: segment — сегмент, list — список, trigger — триггерная рассылка, "" — рассылка без сегмента |
| updatetime | string | Время последнего обновления рассылки (RFC 3339) |
| updated_user | string | Логин пользователя, который последний раз обновил рассылку |
| providers | []string | Список провайдеров push-уведомлений (Возвращается только для push-рассылок) |