Получить информацию о полях подписки ресурса

Описание

Получить информацию о стандартных и дополнительных полях подписки.

URL-адрес

Метод: POST

https://example.com/api/v1.1/resources/fields_get

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
id	int	1	Да	Идентификатор ресурса
channel	string	"email" "sms" "push" "telegram_bot" "whatsapp"	Да	Канал подписки на ресурс

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

JSON

{
  "id": 1,
  "channel": "email",
  "token": "abcdefghijklmnqrstuvwxyz"
}

XML

<xml>
  <id>1</id>
  <channel>email</channel>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

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

JSON

{
  "data": [
    {
      "category": "custom",
      "title": "New_field_1",
      "name": "api_new_field_1",
      "required": false,
      "type": "int"
    },
    {
      "category": "system",
      "title": "Device type",
      "name": "_device_type",
      "required": false,
      "type": "unicode",
      "dictionary": "devices"
    },
    {
      "category": "system",
      "title": "Device model",
      "name": "_device_model",
      "required": false,
      "type": "unicode"
    },
    {
      "category": "system",
      "title": "Device name",
      "name": "_device_name",
      "required": false,
      "type": "unicode"
    },
    {
      "category": "system",
      "title": "Platform",
      "name": "_os",
      "required": false,
      "type": "unicode",
      "dictionary": "oses"
    },
    {
      "category": "system",
      "title": "Platform version",
      "name": "_os_ver",
      "required": false,
      "type": "version"
    },
    {
      "category": "system",
      "title": "Platform time zone",
      "name": "_os_tz",
      "required": false,
      "type": "unicode",
      "dictionary": "tz"
    },
    {
      "category": "system",
      "title": "Platform language",
      "name": "_os_language",
      "required": false,
      "type": "unicode",
      "dictionary": "languages"
    },
    {
      "category": "system",
      "title": "Ad tracking allowed",
      "name": "_ad_track",
      "required": false,
      "type": "bool"
    },
    {
      "category": "system",
      "title": "Ad identifier",
      "name": "_ad_id",
      "required": false,
      "type": "unicode"
    },
    {
      "category": "system",
      "title": "Application ID",
      "name": "_app_id",
      "required": false,
      "type": "unicode"
    },
    {
      "category": "system",
      "title": "Application installation ID",
      "name": "_app_iid",
      "required": false,
      "type": "unicode"
    },
    {
      "category": "system",
      "title": "Application version",
      "name": "_app_ver",
      "required": false,
      "type": "version"
    },
    {
      "category": "system",
      "title": "Browser",
      "name": "_browser_name",
      "required": false,
      "type": "unicode",
      "dictionary": "browsers"
    },
    {
      "category": "system",
      "title": "Browser version",
      "name": "_browser_ver",
      "required": false,
      "type": "version"
    }
  ],
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <category>custom</category>
    <title>New_field_1</title>
    <name>api_new_field_1</name>
    <required>false</required>
    <type>int</type>
  </data>
  <data>
    <category>system</category>
    <title>Device type</title>
    <name>_device_type</name>
    <required>false</required>
    <type>unicode</type>
    <dictionary>devices</dictionary>
  </data>
  <data>
    <category>system</category>
    <title>Device model</title>
    <name>_device_model</name>
    <required>false</required>
    <type>unicode</type>
  </data>
  <data>
    <category>system</category>
    <title>Device name</title>
    <name>_device_name</name>
    <required>false</required>
    <type>unicode</type>
  </data>
  <data>
    <category>system</category>
    <title>Platform</title>
    <name>_os</name>
    <required>false</required>
    <type>unicode</type>
    <dictionary>oses</dictionary>
  </data>
  <data>
    <category>system</category>
    <title>Platform version</title>
    <name>_os_ver</name>
    <required>false</required>
    <type>version</type>
  </data>
  <data>
    <category>system</category>
    <title>Platform time zone</title>
    <name>_os_tz</name>
    <required>false</required>
    <type>unicode</type>
    <dictionary>tz</dictionary>
  </data>
  <data>
    <category>system</category>
    <title>Platform language</title>
    <name>_os_language</name>
    <required>false</required>
    <type>unicode</type>
    <dictionary>languages</dictionary>
  </data>
  <data>
    <category>system</category>
    <title>Ad tracking allowed</title>
    <name>_ad_track</name>
    <required>false</required>
    <type>bool</type>
  </data>
  <data>
    <category>system</category>
    <title>Ad identifier</title>
    <name>_ad_id</name>
    <required>false</required>
    <type>unicode</type>
  </data>
  <data>
    <category>system</category>
    <title>Application ID</title>
    <name>_app_id</name>
    <required>false</required>
    <type>unicode</type>
  </data>
  <data>
    <category>system</category>
    <title>Application installation ID</title>
    <name>_app_iid</name>
    <required>false</required>
    <type>unicode</type>
  </data>
  <data>
    <category>system</category>
    <title>Application version</title>
    <name>_app_ver</name>
    <required>false</required>
    <type>version</type>
  </data>
  <data>
    <category>system</category>
    <title>Browser</title>
    <name>_browser_name</name>
    <required>false</required>
    <type>unicode</type>
    <dictionary>browsers</dictionary>
  </data>
  <data>
    <category>system</category>
    <title>Browser version</title>
    <name>_browser_ver</name>
    <required>false</required>
    <type>version</type>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>t>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
category	string	Категория поля подписки "system","custom"
title	string	Название поля для интерфейса
name	string	Название поля для запросов
required	bool	Обязательное поле (true)
type	string	Тип поля
default_value	*	Значение поля по умолчанию
dictionary	string	Название поля, используемое в запросе /v1.1/dictionary (запрос на получение значений системных полей, которые отображаются в интерфейсе в виде выпадающего списка) "browsers" "devices" "tz" "oses" "languages"

Системные поля подписки

Параметр	Тип	Пример	Описание
_device_type	string	"mob"	Тип устройства. В параметр рекомендуется передавать определенные значения. Получить список допустимых значений можно через запрос /v1.1/dictionary ("devices")
_device_model	string	"MHA-L29"	Модель устройства.
_device_name	string	"HUAWEI Mate 9"	Имя устройства.
_os	string	"Android"	Операционная система платформы. В параметр рекомендуется передавать определенные значения. Получить список допустимых значений можно через запрос /v1.1/dictionary ("oses")
_os_ver	string	"v11.0"	Версия ОС.
_os_tz	string	"+0300"	Часовой пояс платформы. В параметр рекомендуется передавать определенные значения. Получить список допустимых значений можно через запрос /v1.1/dictionary ("tz")
_os_language	string	"ru"	Язык платформы. В параметр рекомендуется передавать определенные значения. Получить список допустимых значений можно через запрос /v1.1/dictionary ("languages")
_ad_track	bool	true	Реклама разрешена.
_ad_id	string	"ad 123"	Рекламный идентификатор.
_app_id	string	"app 123"	Идентификатор приложения.
_app_iid	string	"example iid"	Идентификатор установки приложения.
_app_ver	string	"v1.2.3.4"	Версия приложения.
_browser_name	string	"Chrome"	Браузер. В параметр рекомендуется передавать определенные значения. Получить список допустимых значений можно через запрос /v1.1/dictionary ("browsers")
_browser_ver	string	"4.5.6.7.8"	Версия браузера.