| Method | get.offline_message_user_fields |
|---|---|
| Description | Retrieving custom application fields |
| Available to | Agent, Client |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
user_id |
number | no | Unique user identifier of the agent client on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the "get.customer_users" method |
limit |
number | no | Number of records returned. See section "Paging" |
offset |
number | no | Shift determines from which record number to return "limit" records. Default is "0". See section "Paging" |
filter |
object | no | See section "Filtering Criteria" |
fields |
array | no | See "View of Returned Data" |
sort |
array | no | See section "Sorting data" |
Response parameters
| Title | Type | Filtering | Sorting | Description |
|---|---|---|---|---|
ext_id |
string | yes | yes | External ID of the application custom field |
name |
string | yes | yes | Application custom field name |
data_type |
string | yes | yes | Field data type |
JSON request structure```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 response structure```json
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"data": [
{
"ext_id": "string",
"name": "string",
"data_type": "string"
}
],
"metadata": "object"
}
}
JSON example response structure```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 } } } } ```
List of returned errors
See the section "List of errors for methods with the verb get"