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

Описание

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

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
db_id	int	1	Да	Идентификатор базы данных
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
profile_id	string	"abcdefghijklmnqrstuvwxyz"	Да	Идентификатор профиля

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

{
    "db_id": 1,
    "profile_id": "abcdefghijklmnqrstuvwxyz",
    "token": "abcdefghijklmnqrstuvwxyz"
}

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

{
    "data": [
        {
            "channel": "email",
            "email": "john@example.com",
            "priority": 0,
            "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"
}

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
channel	string	Тип канала (email, push или sms)
priority	int	Приоритет подписки (меньше число – больше приоритет)
resource_id	int	Идентификатор ресурса, связанного с подпиской
status	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