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

Описание

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

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	Нет	Лимит на количество возвращаемых данных

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

JSON

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

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <db_id>1</db_id>
  <resource_id>1</resource_id>
  <from_id>abcdefghijklmnqrstuvwxyz</from_id>
  <limit>1</limit>
</xml>

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

JSON

{
    "data": [
        {
            "db_id": 1,
            "profile_id": "6643052fee44bb50a671161d",
            "_xxh": "026e82a364dd17e6",
            "hash_id": "fcf06ea1",
            "resource_id": 29,
            "channel": "email",
            "email": "example@example.com",
            "priority": 0,
            "status": "subscribed",
            "custom_fields": {
                "custom_int_field_2": 20000
            }
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "next_from_id": "cPydNpzRRGLhjKziMHRQ3awnGtyo8hjzn7Jar5mhd"
}

XML

<xml>
    <data>
        <_xxh>026e82a364dd17e6</_xxh>
        <channel>email</channel>
        <custom_fields>
            <custom_int_field_2>20000</custom_int_field_2>
        </custom_fields>
        <db_id>1</db_id>
        <email>example@example.com</email>
        <hash_id>fcf06ea1</hash_id>
        <priority>0</priority>
        <profile_id>6643052fee44bb50a671161d</profile_id>
        <resource_id>29</resource_id>
        <status>subscribed</status>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <next_from_id>cPydNpzRRGLhjKziMHRQ3awnGtyo8hjzn7Jar5mhdm</next_from_id>
</xml>

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

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

---

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