Личный кабинет
Интернет-магазин
3.9.5 Получение набора пользовательских полей
POST /vpbx/ab/custom_fields/
Используя этот запрос, вы можете получить только набор пользовательских полей из контакта, в отличие от запроса « Получить контакт по ID», в котором вы получаете сразу все данные контакта.
Параметры запроса: пустой json.
Примечание. Согласно модели взаимодействия, в POST-запросах отправляются обязательные поля vpbx_api_key и sign.
Пример запроса:
POST https://app.mango-office.ru/vpbx/ab/custom_fields/
vpbx_api_key = 1234567890qwerty,
sign = 1234567890qwerty,
json =
{}
В результате обработки запроса, формируются и передаются JSON-данные, содержащие следующие параметры:
| № | Параметры | Тип | Обяза-тель-ный | Описание |
|---|---|---|---|---|
| 1 | result | Да | Код результата | |
| Общие атрибуты | Общие атрибуты | Общие атрибуты | Общие атрибуты | Общие атрибуты |
| 2 | custom_field_id | Идентификатор пользовательского поля | ||
| 3 | type | Тип поля (1 - текст, 2 - список, 3 - мультисписок) | ||
| 4 | order | Порядковый номер поля | ||
| 5 | name | Наименование пользовательского поля | ||
| 6 | required | Признак обязательно ли к заполнению | ||
| 7 | api_only | Признак. что поле не может редактировать пользователь, заполнение поля доступно только через импорт контактов | ||
| Атрибуты типа "Текст" | Атрибуты типа "Текст" | Атрибуты типа "Текст" | Атрибуты типа "Текст" | Атрибуты типа "Текст" |
| 8 | unique | Проверка уникальности при сохранении | ||
| 9 | check_mode | Тип проверки длины поля: 0 - без проверки, 1 - '<' 2 - '==' 3 - '>' | ||
| 10 | check_lengt | Длина строки используемая при check_mode!= 0; | ||
| Атрибуты типа "Список" и "Мультисписок" | Атрибуты типа "Список" и "Мультисписок" | Атрибуты типа "Список" и "Мультисписок" | Атрибуты типа "Список" и "Мультисписок" | Атрибуты типа "Список" и "Мультисписок" |
| 11 | Items | Да | Массив объектов «Пункт списка». Элемент для атрибутов типа "Список" и "Мультисписок" | |
| 12 | enum_id | Идентификатор пункта списка | ||
| 13 | order | Порядковый номер поля | ||
| 14 | name | Название пункта |
Пример ответа:
{"result": 1000,
"data":
{
"custom_field_id": 5396,
"name: "тест",
"type: 3,
"order: 0,
"required: false,
"api_only: false,
"items:
[
{
"enum_id: 6725,
"name: "1",
"order: 0
},
{
"enum_id: 6747,
"name: "4",
"order: 1
},
{
"enum_id: 6756,
"name: "ОдинИзмен",
"order: 2
},
},
{
"custom_field_id": 3262,
"name": "Притве Андрей",
"type": 2,
"order": 1,
"required": false,
"api_only": false,
"items":
{
"enum_id": 6553,
"name": "Кока",
"order": 0
},
{
"enum_id": 6554,
"name": "Квок",
"order": 1
},
},
{
"custom_field_id": 5453,
"name": "Пользовательское поле 2",
"type"": 1,
"order: 8,
"required": false,
"api_only": true,
"unique": false,
"check_mode": 0,
"check_length": 10
}
]}
Была ли статья полезна?
Предыдущая
