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

Описание

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

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
db_id	int	1	Да	Идентификатор базы данных
profile_id	string	"abcdefghijklmnqrstuvwxyz"	Да	Идентификатор профиля

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

JSON

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

XML

<xml>
    <db_id>1</db_id>
    <profile_id>abcdefghijklmnqrstuvwxyz</profile_id>
</xml>

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

JSON

{
    "data": [
        {
            "resource_id": 29,
            "channel": "email",
            "email": "example@example.com",
            "priority": 10,
            "status": "suspended",
            "custom_fields": {
                "custom_int_field_2": 20000
            }
        }
    ],
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data>
        <channel>email</channel>
        <custom_fields>
            <custom_int_field_2>20000</custom_int_field_2>
        </custom_fields>
        <email>example@example.com</email>
        <priority>10</priority>
        <resource_id>29</resource_id>
        <status>suspended</status>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

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

Параметр	Тип	Описание
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*

---

*Организация Meta, которой принадлежат продукты Instagram, Facebook и WhatsApp, признана экстремистской и запрещена на территории РФ.