Получить все подписки нескольких профилей

Описание

Получить все подписки нескольких профилей.

URL-адрес

Метод: POST

https://example.com/api/v1.1/subscriptions/list_all

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
resource_id	int	1	Да	Идентификатор ресурса
db_id	int	1	Нет	Идентификатор базы данных
channel	string	"email"	Нет	Тип канала
status	string	"subscribed"	Нет	Статус подписки
from_id	string	"60df2b6325bf0aa04e22e8f5"	Нет	Идентификатор первого профиля в списке
limit	int	1	Нет	Лимит на количество возвращаемых данных

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

{
    "db_id": 1,
    "from_id": "60df2b6325bf0aa04e22e8f5",
    "limit": 1,
    "resource_id": 1,
    "token": "abcdefghijklmnqrstuvwxyz"
}

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

{
    "data": [
        {
            "_xxh": "12345",
            "channel": "email",
            "db_id": 1,
            "email": "john@example.com",
            "hash_id": "12345",
            "priority": 0,
            "profile_id": "60df2b6325bf0aa04e22e8f5",
            "resource_id": 1,
            "status": "subscribed",
            "custom_fields": {
                "_browser_name": "Firefox",
                "_device_type": "web",
                "custom_field_1": "test value"
            },
            "cats": [
                "category_1",
                "category_2"
            ]
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "next_from_id": "3hDmNCv1E3pT62kP8EqdDZN77jmF9RW82p1rFvpui5wxUMdq2EYQJkg",
    "total_count": 1
}

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
next_from_id	string	Указатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории
resource_id	int	Идентификатор ресурса, связанного с подпиской
channel	string	Тип канала
custom_fields	object	Стандартные и дополнительные поля подписки. Получить информацию о полях подписки в ресурсе можно с помощью метода /v1.1/resources/fields_get
cats	array	Категории ресурса, на которые подписан профиль.

Дополнительно для Email-канала:

Параметры	Тип	Описание
email	string	Email-адрес

Дополнительно для PUSH-канала:

Параметры	Тип	Описание
provider	string	Тип провайдера
subscription_id	string	Идентификатор подписки

Дополнительно для SMS-канала:

Параметры	Тип	Описание
phone	string	Номер телефона

Дополнительно для Telegram-канала:

Параметры	Тип	Описание
cc_data	object	ID чата в Telegram-бот

Дополнительно для WhatsApp-канала:

Параметры	Тип	Описание
cc_data	object	Телефон профиля в WhatsApp