Список агентов

Возвращает список агентов.

Формат запроса

GET https://api.tickets.yandex.net/api/crm\
 ? action=crm.agent.list\
 & auth=<string>\
 & city_id=<number>\
 & [limit=<number>]\
 & [offset=<number>]

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

Query-параметр Описание
action* string
Идентификатор запроса.
auth* string
Идентификатор внешней системы.
city_id* number
Идентификатор города.
limit number
Максимальное количество возвращаемых объектов. Выдается не больше 1000 агентов.
offset number
Количество пропускаемых в ответе объектов, начиная с первого.

* Обязательный параметр

Формат ответа

JSON

{
  "status": string,
  "result": [
    {
      "id": number,
      "name": string
    }
  ]
}

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

Параметр Описание
status string
Статус выполнения запроса.
Возможные значения:
  • 0 — запрос выполнен;
  • 1 — произошла ошибка.
    result[] [object]
    Результат выполнения запроса.
    result[].id number
    Идентификатор агента.
    result[].name string
    Название агента.

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

    {
      "status": "0",
      "result": [
        [
          {
            "id": 446582,
            "name": "Яндекс.Виджет"
          }
        ],
        [
          {
            "id": 575165,
            "name": "Касса"
          }
        ]
      ]
    }