Получение списка кампаний исходящего обзвона

Метод	get.auto_call_campaigns
Описание	Получение списка кампаний исходящего обзвона
Кому доступен	Агент, Клиент

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

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

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

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Описание
id	number		да		Уникальный идентификатор виртуального номера
name	string		да	да	Название кампании
add_time	iso8601	YYYY-MM-DD hh:mm:ss			Дата создания кампании
begin_date	iso8601	YYYY-MM-DD hh:mm:ss			Дата и время начала обзвона
end_date	iso8601	YYYY-MM-DD hh:mm:ss			Дата и время завершения обзвона
status	enum	`draft` - Черновик `planned` - Запланирована `in_process` - В работе `paused` - Приостановлена `completed` - Завершена `cancelled` - Отменена	да		Статус кампании
phone_numbers	array				Список номеров абонента
phone_number	string		да		Номер абонента
status	enum	`successfully_processed` - Успешный `unsuccessfully_processed` - Неуспешный `not_processed` - Не обработан `processed_outside_campaign` - Обработан вне кампании `deleted` - Удален	да		Статус номера в кампании

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.auto_call_campaigns",
  "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": {
    "metadata": {

    },
    "data": [
      {
        "id": "number",
        "name": "string",
        "add_time": "iso8601",
        "begin_date": "iso8601",
        "end_date": "iso8601",
        "status": "enum",
        "phone_numbers": [
          {
            "phone_number": "number",
            "status": "enum",
          }
        ]
      }
    ]
  }
}

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

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