Получение групп телефонных номеров для замены на номера коллтрекинга

Метод	`get.replacement_phones_groups`
Описание	Получение групп телефонных номеров для замены на номера коллтрекинга
Кому доступен	Агент, Клиент

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

Название	Тип	Обязательный	Допустимые значения	Описание
`access_token`	string	да		Ключ сессии аутентификации
`user_id`	number	нет		Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
`limit`	number	нет		Количество возвращаемых записей. См. раздел "Постраничный вывод"
`offset`	number	нет		Сдвиг, определяет с какого номера записи возвращать `"limit"` записей. По умолчанию "0". См. раздел "Постраничный вывод"
`site_id`	number	нет		Уникальный идентификатор сайта
`fields`	array	нет		См. раздел "Представление возвращаемых данных"
Фильтры применяемые в отчете
`filter`	object	нет	Допустимо использовать не более `2 уровней` вложенности.	Фильтры применяемые в отчете. Логика построения аналогична "Критерии фильтрации"
`filters`	array	да		Выражение, может содержать в себе как простые фильтры, так и дерево фильтров. Доступный список фильтров для отчета с их возможными значениями см.раздел "Критерии фильтрации" .
`field`	string			Поле сущности к которой будет применяться фильтрация (список заранее определен для метода)
`operator`	enum			Оператор фильтрации. Список всех операторов можно получить в разделе "Операторы фильтрации"
`value`	string			Значение для оператора фильтрации. Необязательное поле, если оно отсутствует, то считается пустота.
Сортировка применяемая в отчете
`sort`	array	нет		Сортировка применяемая в отчете. Логика построения аналогична "Сортировка данных"

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

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Описание
`id`	number		да	да	Уникальный идентификатор группы заменяемых элементов
`name`	string		да	да	Название группы. Название подсказывает, за какой номер отвечает группа. Например, можно указать название отдела: отдела продаж или тех. поддержки.
`is_show_by_click`	boolean				Признак отображение блока по клику
`child_customer_id`	integer		да	да	Идентификатор клиента агента
Массив сайтов, на которых используется данный блок номеров
`sites`	array				Массив сайтов, на которых используется данный блок номеров
`id`	number				Уникальный идентификатор сайта
`name`	string				Название сайта
`domain`	string				Адрес сайта
Массив селекторов элементов страницы сайта, автоматически выбранных номеров коллтрекинга
`phone_selectors`	array	В разрезе одного сайта(и группы) не должно быть селекторов с однинаковыми парами element_attribute и element_attribute_value			Массив селекторов элементов страницы сайта, автоматически выбранных номеров коллтрекинга
`id`	number				Уникальный идентификатор селекторов элементов страницы сайта
`element_attribute`	enum	id class name selector number	да	да	Аттрибут заменяемого элемента на странице сайта id - Идентификатор; class - Класс; name - Название; selector - Селектор; number - Номер на сайте.
`element_attribute_value`	string		да	да	Название, значение заменяемого элемента на странице сайта
`phone_number_template`	string		да	да	Формат номера. Выберите, как будет отображаться номер телефона в теге {phone}. Цифры номера обозначаются символом X, их может быть от 5 до 7. Если в вашем номере другое количество цифр, они останутся в начале маски. Например, если выбрана маска XX-XX-XX, номер с лишними символами 1234567 будет отображаться как 123-45-67. Номер с недостающими цифрами 12345 будет отображаться как 1-23-45.
`phone_number_mask`	string		да	да	Маска телефона. Правило отображения номеров коллтрекинга на сайте. Выберите один из существующих шаблонов или настройте свой, используя теги или добавляя любой текст. Значения тегов: {country} - код страны, {city} - код города, {phone} - номер телефона.

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

Копировать

{
 "jsonrpc":"2.0",
 "id":"number",
 "method":"get.replacement_phones_groups",
 "params":{
  "access_token":"string",
  "user_id":"number",
  "offset":"number",
  "site_id":"number",
  "limit":"number",
  "filter":{

  },
  "sort":[
   {
    "field":"string",
    "order":"string"
   }
  ],
  "fields":[
   "string"
  ]
 }
}

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

Копировать

{
 "jsonrpc": "2.0",
 "id": "number",
 "result": {
  "metadata": {

  },
  "data": [
   {
    "id": "number",
    "name": "string",
    "sites":[
     {
      "id": "number",
      "name": "string",
      "domain": "string"
     }
    ],
    "child_customer_id":"number",
    "phone_selectors":[
     {
      "element_attribute": "enum",
      "element_attribute_value": "string",
      "phone_number_template": "string",
      "phone_number_mask": "string"
     }
    ]
   }
  ]
 }
}

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

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