Получение списка SIP-линий

Метод	`get.sip_lines`
Описание	Получение списка SIP-линий
Кому доступен	Партнёр, Клиент

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

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

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

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Описание
`id`	number		да		Уникальный идентификатор SIP-линии
`phone_number`	string		да		Номер телефона SIP-линии
`type`	enum	in in_out	да	да	Тип входящей связи доступной для SIP-линии. in - Поддержка только входящей связи in_out - Поддержка входящей и исходящей связи
`channels_count`	number				Количество доступных линий на SIP-линии
`dial_time`	number	от 1 до 100			Значение по умолчанию "60". Время дозвона по номеру в профиле сотрудника. Значение в секундах.
`billing_state`	enum	active manual_lock limit_lock	да	да	Состояние SIP-линии в биллинге. active - SIP-линия активна; manual_lock - SIP-линия заблокирована вручную; limit_lock - SIP-линия заблокирована автоматически.
`physical_state`	enum	Зарегистрирован Не зарегистрирован	да	да	Физическое состояние SIP-линии.
`virtual_phone_number`	string	E164	да	да	Виртуальный номер отображаемый при исходящем вызове Если тип SIP-линии "in", то данное поле будет пустым
`status`	enum	active inactive	да	да	Статус sip-номера в профиле сотрудника, см. методы "get.employees"
`employee_id`	number		да	да	Уникальный идентификатор сотрудника, см. методы "get.employees"
`employee_full_name`	string		да		Фамилия Имя Отчество сотрудника, см. методы "get.employees"
IP-адреса
`ip_addresses`	array		да		IP-адреса зарегистрированных терминалов. Актуально для SIP-линий, которые имеют значение параметра "physical_state" = "Зарегистрирован"
`date_time`	iso8601	YYYY-MM-DD hh:mm:ss			Дата и время регистрации
`ip`	string				IP-адрес

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.sip_lines",
  "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",
        "phone_number": "string",
        "type": "enum",
        "employee_id": "number",
        "employee_full_name": "string",
        "channels_count": "number",
        "dial_time": "number",
        "billing_state": "enum",
        "physical_state": "enum",
        "status": "enum",
        "virtual_phone_number": "string",
        "ip_addresses": [
          {
            "date_time": "iso8601",
            "ip": "string"
          }
        ]
      }
    ]
  }
}

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

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