Skip to end of metadata
Go to start of metadata

Описание

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

URL-адрес

Метод: POST

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

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
formatstring"json"НетФормат возвращаемых данных
по умолчанию – "json"
resource_idint1ДаИдентификатор ресурса
db_idint1НетИдентификатор базы данных
channelstring"email"НетТип канала
statusstring"subscribed"НетСтатус подписки
from_idstring"60df2b6325bf0aa04e22e8f5"НетИдентификатор первого профиля в списке
limitint1НетЛимит на количество возвращаемых данных

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

{
    "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"
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 1
}

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

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
resource_idintИдентификатор ресурса, связанного с подпиской
channelstringТип канала

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

Параметры

Тип

Описание

emailstringEmail-адрес

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

Параметры

Тип

Описание

providerstringТип провайдера
subscription_idstringИдентификатор подписки

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

Параметры

Тип

Описание

phonestringНомер телефона
  • No labels