Получение списка статусов

Метод	`get.statuses`
Описание	Получение списка статусов
Кому доступен	Агент, Клиент

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

Название	Тип	Обязательный	Описание
`access_token`	string	да	Ключ сессии аутентификации
`user_id`	number	нет	Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
`limit`	number	нет	Количество возвращаемых записей. См. раздел "Постраничный вывод"
`offset`	number	нет	Сдвиг, определяет с какого номера записи возвращать `"limit"` записей. По умолчанию "0". См. раздел "Постраничный вывод"
`filter`	object	нет	См. раздел "Критерии фильтрации"
`fields`	array	нет	См. раздел "Представление возвращаемых данных"
`sort`	array	нет	См. раздел "Сортировка данных"
`is_deleted`	boolean	нет	Признак удаления статуса. По умолчанию "false"

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

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Описание
`id`	number		да		Уникальный идентификатор статуса
`name`	string		да	да	Название статуса
`mnemonic`	enum	available - Доступен break - Перерыв do_not_disturb - Не беспокоить not_at_workplace - Нет на месте not_at_work - Нет на работе auto_out_call - Исходящий обзвон unknown - Неизвестно	да		Мнемоника статуса. Заполнен только для стандартных статусов
`description`	string			да	Описание статуса
`color`	string				Цвет иконки и других элементов интерфейса, относящихся к статусу. Значение представляет собой HEX-код цвета
`is_deleted`	boolean	`true`, `false`		да	Признак удаления статуса
`in_external_allowed_call_directions`	array	in out			Какие направления вызовов разрешены для входящих внешних звонков in - входящие вызовы out - исходящие вызовы
`in_internal_allowed_call_directions`	array	in out			Какие направления вызовов разрешены для входящих внутренних звонков in - входящие вызовы out - исходящие вызовы
`out_external_allowed_call_directions`	array	in out			Какие направления вызовов разрешены для исходящих внешних звонков in - входящие вызовы out - исходящие вызовы
`out_internal_allowed_call_directions`	array	in out			Какие направления вызовов разрешены для исходящих внутренних звонков in - входящие вызовы out - исходящие вызовы
`allowed_phone_protocols`	array	PSTN SIP SIP_TRUNK FMC			Типы номеров, разрешенные для звонков
`is_select_allowed`	boolean	`true`, `false`		да	Признак "Возможность выбора статуса"
`is_worktime`	boolean	`true`, `false`		да	Признак "Рабочее время"
`is_auto_out_calls_ready`	boolean	`true`, `false`		да	Признак "Готов к исходящему обзвону"

JSON структура запроса

{
  "jsonrpc": "2.0",
  "id": "number",
  "method": "get.statuses",
  "params": {
    "access_token": "string",
    "user_id": "number",
    "offset": "number",
    "limit": "number",
    "is_deleted": "boolean",
    "filter": {},
    "sort": [
      {
        "field": "string",
        "order": "string"
      }
    ],
    "fields": [
      "string"
    ]
  }
}

JSON структура ответа

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "metadata": {},
    "data": [
      {
        "id": "number",
        "name": "string",
        "mnemonic": "string",
        "description": "string",
        "color": "string",
        "is_deleted": "boolean",
        "in_external_allowed_call_directions": "array",
        "in_internal_allowed_call_directions": "array",
        "out_external_allowed_call_directions": "array",
        "out_internal_allowed_call_directions": "array",
        "allowed_phone_protocols": "array",
        "is_select_allowed": "boolean",
        "is_worktime": "boolean",
        "is_auto_out_calls_ready": "boolean"
      }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"