Получить информацию о подписке профиля
Описание
Получить подробную информацию об одной из подписок профиля.
URL-адрес
Метод: POST
https://example.com/api/v1.1/subscriptions/get
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| db_id | int | 1 | Да | Идентификатор базы данных |
| format | string | "json" | Формат возвращаемых данных (по умолчанию – "json") | |
| profile_id | string | "abcdefghijklmnqrstuvwxyz" | Да | Идентификатор профиля |
| resource_id | int | 1 | Да | Идентификатор ресурса |
Дополнительно для Email-канала:
| Параметры | Тип | Пример | Описание |
|---|---|---|---|
| channel | string | "email" | Тип канала |
| string | "john@example.com" | Email-адрес |
Дополнительно для PUSH-канала:
| Параметры | Тип | Пример | Описание |
|---|---|---|---|
| channel | string | "push" | Тип канала |
| provider | string | "Firefox" | Тип провайдера |
| subscription_id | string | "abcdefghijklmnqrstuvwxyz" | Идентификатор подписки |
Дополнительно для SMS-канала:
| Параметры | Тип | Пример | Описание |
|---|---|---|---|
| channel | string | "sms" | Тип канала |
| phone | string | "+79000000000" | Номер телефона |
Дополнительно для Telegram-канала:
| Параметры | Тип | Пример | Описание |
|---|---|---|---|
| channel | string | "telegram_bot" | Тип канала |
| cc_data | object | { | id чата в Telegram-бот |
Дополнительно для WhatsApp-канала:
| Параметры | Тип | Пример | Описание |
|---|---|---|---|
| channel | string | "whatsapp" | Тип канала |
| cc_data | object | { | Телефон профиля в WhatsApp |
Пример запроса
{
"channel": "push",
"db_id": 1,
"profile_id": "abcdefghijklmnqrstuvwxyz",
"provider": "Firefox",
"resource_id": 1,
"subscription_id": "abcdefghijklmnqrstuvwxyz",
"token": "abcdefghijklmnqrstuvwxyz"
}
Пример ответа
{
"data": {
"channel": "push",
"priority": 10,
"provider": "Firefox",
"resource_id": 1,
"status": "subscribed",
"subscription_id": "abcdefghijklmnqrstuvwxyz",
"custom_fields": {
"_device_type": "mob",
"_os": "Android",
"custom_field_1": "test value"
},
"cats": ["news_category", "transaction_category"]
},
"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-канала:
| Параметры | Тип | Описание |
|---|---|---|
| string | Email-адрес |
Дополнительно для PUSH-канала:
| Параметры | Тип | Описание |
|---|---|---|
| provider | string | Тип провайдера |
| subscription_id | string | Идентификатор подписки |
Дополнительно для SMS-канала:
| Параметры | Тип | Описание |
|---|---|---|
| phone | string | Номер телефона |
Дополнительно для Telegram-канала:
| Параметры | Тип | Описание |
|---|---|---|
| cc_data | object | id чата в Telegram-бот |
Дополнительно для WhatsApp-канала:
| Параметры | Тип | Описание |
|---|---|---|
| cc_data | object | Телефон профиля в WhatsApp |