Перейти к основному содержимому

Получить список триггер кампаний

Описание

Получить список триггер кампаний.

URL-адрес

Метод: POST

https://example.com/api/v1.1/campaigns/triggers/list/

Параметры запроса

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
from_idint11768НетИдентификатор первой кампании в списке.
По умолчанию – 1.
limitint10НетЛимит на количество возвращаемых данных.
По умолчанию – 1000.
formatstring"json"НетФормат возвращаемых данных.
По умолчанию – "json".
is_activebooltrueНетСтатус кампании
ui_tags[]String[ "tag1", "tag2" ]НетСписок тегов для поиска.
По умолчанию – [].
groups[]String[ "group1", "group2" ]НетСписок групп для поиска.
По умолчанию – [].
groups_id[]int[ 0, 1 ]НетСписок Id групп для поиска.
По умолчанию – [].

Пример запроса

{
"limit": 2,
"token": "abcdefghijklmnqrstuvwxyz"
}

Пример ответа

{
"data": [
{
"id": 1,
"name": "New campaign1",
"type": "api_call",
"is_active": true,
"for_confirm": false,
"ui_tags": [
"tag3",
"tag4"
],
"Groups": [
{
"Id": 1,
"Name": "subaccount"
}
]
},
{
"id": 2,
"name": "New campaign2",
"type": "api_call",
"is_active": true,
"for_confirm": false,
"ui_tags": [
"tag1",
],
"Groups": [
{
"Id": 0,
"Name": "main"
}
]
}
],
"error": 0,
"error_text": "Successful operation",
"total_count": 7
}

Возвращаемые параметры

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
idintИдентификатор кампании
namestringНазвание кампании
typestringТип триггера
for_confirmboolИмеет ли кампания сообщения со ссылкой подтверждения
is_activeboolСтатус кампании
ui_tags[]StringСписок тегов
groups[]StringСписок групп