Получение пользовательских полей заявок
| Метод | get.offline_message_user_fields |
|---|---|
| Описание | Получение пользовательских полей заявок |
| Кому доступен | Агент, Клиент |
Параметры запроса
| Название | Тип | Обязательный | Описание |
|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
limit |
number | нет | Количество возвращаемых записей. См. раздел "Постраничный вывод" |
offset |
number | нет | Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
|
filter |
object | нет | См. раздел "Критерии фильтрации" |
fields |
array | нет | См. раздел "Представление возвращаемых данных" |
sort |
array | нет | См. раздел "Сортировка данных" |
Параметры ответа
| Название | Тип | Фильтрация | Сортировка | Описание |
|---|---|---|---|---|
ext_id |
string | да | да | Внешний идентификатор пользовательского поля заявки |
name |
string | да | да | Имя пользовательского поля заявки |
data_type |
string | да | да | Тип данных в поле |
JSON структура запроса
Копировать
{
"jsonrpc":"2.0",
"id":"number",
"method":"get.offline_message_user_fields",
"params":{
"access_token":"string",
"user_id":"number",
"offset":"number",
"limit":"number",
"filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
}
}
JSON структура ответа
Копировать
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"data": [
{
"ext_id": "string",
"name": "string",
"data_type": "string"
}
],
"metadata": "object"
}
}
JSON пример структуры ответа
Копировать
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"data": [
{
"name": "Статус заявки",
"ext_id": "field_2021012203_1",
"data_type": "string"
},
{
"name": "Проданы ли слоны////",
"ext_id": "field_2021012203_2",
"data_type": "numeric"
}
],
"metadata": {
"total_items": 2,
"version": null,
"limits": {
"day_limit": 3000,
"day_remaining": 2987,
"day_reset": 51959,
"minute_limit": 60,
"minute_remaining": 59,
"minute_reset": 59
}
}
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"