Получение всех ПКТ.

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

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

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

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

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Описание
`id`	number		да	да	Уникальный идентификатор ПКТ
`name`	string		да	да	Название ПКТ
`is_named_by_user`	boolean		да	да	Признак, что название введено ручную
`priority`	string		нет	нет	Приоритет
`rule_type`	enum	site_calls, external_area	нет	нет	Вид ПКТ
`reserve_phone_numbers_time`	number	да		Время резерва динамического номера за посетителем в минутах (от 5 до 10080)
Условия для определения ПКТ.
`conditions`	array	нет		Условия для определения ПКТ, допустимо только для `call_tracking_type` = dynamic, `is_fraffic_type` = false, и пустом sources
`filters`	array			Выражение, может содержать в себе как простые фильтры, так и дерево фильтров
`field`	string			Список допустимых значений и возможных операторов см. в таблице "Список параметров и их операторов
`operator`	enum			Список допустимых значений и возможных операторов см. в таблице "Список параметров и их операторов"
`value`	string			Значение для оператора фильтрации.
`call_tracking_type`	enum	static, dynamic	нет	нет	Тип коллтрекинга
`site_ids`	array		да	нет	Идентификаторы сайтов, на которые настроен с ПКТ
`child_customer_ids`	array		да	нет	Идентификаторы клиентов агента связанные с ПКТ
Список сайтов связанных с ПКТ.
`sites`	array		нет	нет	Сайты связанные с ПКТ
`id`	number		нет	нет	Идентификатор сайта
`name`	string		нет	нет	Название
`domain`	string		нет	нет	Домен
Список источников, на которые настроено ПКТ.
`sources`	string		нет	нет	Источники, которые связаны с ПКТ
`source_channel_id`	string		нет	нет	Идентификатор канала
`source_group_id`	string		нет	нет	Идентификатор группы
`source_id`	string		нет	нет	Идентификатор источника
`name`	string		нет	нет	Название источника или группы или канала
`is_available_edit`	boolean		нет	нет	Признак допустимости редактирования данного ПКТ данным пользователем
`is_available_set_priority`	boolean		нет	нет	Признак допустимости редактирования приоритета
`state`	enum	active, draft	нет	нет	Статус ПКТ
`is_all_traffic`	boolean		нет	нет	Признак настройки ПКТ на весь трафик
`coverage`	number				Минимальный фактический охват по всем пулам ПКТ
`is_multi_redirections`	number				Признак настроенной переадрисации на разные номера и правила ВАТС
`redirection_numbers`	number				Номер переадресации ПКТ, если он единственный
`call_processing_rule_groups`	number				Группа правил ВАТС для переадресации ПКТ, если она единственная
Настройки переадресации для звонков со сторонних площадок.
`external_replacement_settings`	array				Настройка статических номеров. Может присутствовать в запросе только если `call_tracking_type` = static и `rule_type` = site_calls
`id`	number				Идентификатор блока с настройкой.
`replacement_phones_groups`	array				Идентификатор группы телефонных номеров и сайтов для замены на номера коллтрекинга.
`id`	number				Идентификатор группы телефонных номеров. Метод получение списка существующих групп: "get.replacement_phones_groups"
`site_id`	number				Идентификатор сайта. Метод получение списка существующих сайтов: "get.sites"
`source_id`	number				Идентификатор источника. Метод получение списка существующих Источников: "get.sources"
`static_phone_id`	number				Номер для статического коллтрекинга. Метод для получения номеров "get.virtual_numbers"
`child_customer_id`	number				Клиент агента
Группа правил переадресации.
`call_processing_rule_group`	number				Группа правил обработки звонков. Метод получение списка групп: "get.call_processing_rule_groups" В запросе может быть либо custom_redirection_phone либо redirection_phone либо call_processing_rule_group
`id`	number				Идентификатор группы
`name`	string				Название группы
`custom_redirection_phone`	string				Номер для переадресации. запросе может быть либо custom_redirection_phone либо redirection_phone либо call_processing_rule_group
`redirection_phone`	object				Номер для переадресации. запросе может быть либо custom_redirection_phone либо redirection_phone либо call_processing_rule_group
`id`	number				Идентификатор номера телефона. Метод для получения номеров "get.virtual_numbers"
`child_customer_id`	number				Идентификатор филиала, которому принадлежит номер. Метод получение списка клиентов: "get.customers"
Настройки статических номеров и переадресации звонков.
`static_replacement_phones_settings`	array				Настройка статических номеров. Может присутствовать в запросе только если `call_tracking_type` = static и `rule_type` = site_calls
`id`	number				Идентификатор блока с настройкой.
`replacement_phones_groups`	array				Идентификатор группы телефонных номеров и сайтов для замены на номера коллтрекинга.
`id`	number				Идентификатор группы телефонных номеров. Метод получение списка существующих групп: "get.replacement_phones_groups"
`site_id`	number				Идентификатор сайта. Метод получение списка существующих сайтов: "get.sites"
`source`	object				Источник, на которые настроена гарантия.
`source_channel_id`	number				Идентификатор канала источника. Метод получение списка существующих каналов: "get.sources_channels"
`source_group_id`	number				Идентификатор группы источника. Метод получение списка существующих групп: "get.sources_groups"
`source_id`	number				Идентификатор источника. Метод получение списка существующих Источников: "get.sources"
`name`	string		нет	нет	Название источника или группы или канала
`default_source`	number				Источник для отображения в отчете. Метод получение списка существующих Источников: "get.sources"
`source_channel_id`	string		нет	нет	Идентификатор канала
`source_group_id`	string		нет	нет	Идентификатор группы
`source_id`	string		нет	нет	Идентификатор источника
`name`	string		нет	нет	Название источника
`static_phone_id`	number				Номер для статического коллтрекинга. Метод для получения номеров "get.virtual_numbers"
`call_processing_rule_group`	number				Группа правил обработки звонков. Метод получение списка групп: "get.call_processing_rule_groups" В запросе может быть либо custom_redirection_phone либо redirection_phone либо call_processing_rule_group
`id`	number				Идентификатор группы
`name`	string				Название группы
`custom_redirection_phone`	string	нет		Номер для переадресации. запросе может быть либо custom_redirection_phone либо redirection_phone либо call_processing_rule_group
`redirection_phone`	object				Номер для переадресации. запросе может быть либо custom_redirection_phone либо redirection_phone либо call_processing_rule_group
`id`	number				Идентификатор номера телефона. Метод для получения номеров "get.virtual_numbers"
`child_customer_id`	number				Идентификатор филиала, которому принадлежит номер. Метод получение списка клиентов: "get.customers"
Настройки динамической автоматического выбора номеров и правила обработки звонков.
`dynamic_replacement_phones_settings`	array				Настройки групп телефонных номеров для замены на номера динамического коллтрекинга. Может присутствовать в запросе только если `call_tracking_type` = dynamic
`id`	number				Идентификатор блока с настройкой.
`replacement_phones_groups`	array				Идентификатор группы телефонных номеров и сайтов для замены на номера коллтрекинга.
`id`	number				Идентификатор группы телефонных номеров. Метод получение списка существующих групп: "get.replacement_phones_groups"
`site_id`	number				Идентификатор сайта. Метод получение списка существующих сайтов: "get.sites"
`prefix`	string				Префиск номеров коллтрекинга. Обязателен и заполняется только, если is_dynamic = true. Метод получение списка доступных префиксов: "get.available_ct_phone_prefixes"
`virtual_numbers_count`	number				Общее количество номеров коллтрекинга в одном блоке. Необходимое количество номеров будет докуплено.
`visitors_count`	number				Количество посещений в сутки. Обязателен и заполняется только, если is_dynamic = true
`call_processing_rule_group`	number				Группа правил обработки звонков. Метод получение списка групп: "get.call_processing_rule_groups" В запросе может быть либо custom_redirection_phone либо redirection_phone либо call_processing_rule_group
`id`	number				Идентификатор группы
`name`	string				Название группы
`custom_redirection_phone`	string				Номер для переадресации. запросе может быть либо custom_redirection_phone либо redirection_phone либо call_processing_rule_group
`redirection_phone`	object				Номер для переадресации. запросе может быть либо custom_redirection_phone либо redirection_phone либо call_processing_rule_group
`id`	number				Идентификатор номера телефона. Метод для получения номеров "get.virtual_numbers"
`child_customer_id`	number				Идентификатор филиала, которому принадлежит номер. Метод получение списка клиентов: "get.customers"
Настройки гарантии на источник.
`sources_bundle_settings`	array				Гарантия на источник, позволяет сохранить источник при звонке на статические номера. Может присутствовать в запросе только если `call_tracking_type` = dynamic
`id`	number				Идентификатор блока с настройкой.
`replacement_phones_groups`	array				Идентификатор группы телефонных номеров и сайтов для замены на номера коллтрекинга.
`id`	number				Идентификатор группы телефонных номеров. Метод получение списка существующих групп: "get.replacement_phones_groups"
`site_id`	number				Идентификатор сайта. Метод получение списка существующих сайтов: "get.sites"
`source`	object				Список источников, на которые настроена гарантия.
`source_channel_id`	number				Идентификатор канала источника. Метод получение списка существующих каналов: "get.sources_channels"
`source_group_id`	number				Идентификатор группы источника. Метод получение списка существующих групп: "get.sources_groups"
`source_id`	number				Идентификатор источника. Метод получение списка существующих Источников: "get.sources"
`default_source`	number				Идентификатор источника для отображения в отчете. Метод получение списка существующих Источников: "get.sources"
`source_channel_id`	string		нет	нет	Идентификатор канала
`source_group_id`	string		нет	нет	Идентификатор группы
`source_id`	string		нет	нет	Идентификатор источника
`name`	string		нет	нет	Название источника или группы или канала
`static_phone_id`	number				Номер для статического коллтрекинга. Метод для получения номеров "get.virtual_numbers"
`call_processing_rule_group`	number				Группа правил обработки звонков. Метод получение списка групп: "get.call_processing_rule_groups" В запросе может быть либо custom_redirection_phone либо redirection_phone либо call_processing_rule_group
`id`	number				Идентификатор группы
`name`	string				Название группы
`custom_redirection_phone`	string				Номер для переадресации. запросе может быть либо custom_redirection_phone либо redirection_phone либо call_processing_rule_group
`redirection_phone`	object				Номер для переадресации. запросе может быть либо custom_redirection_phone либо redirection_phone либо call_processing_rule_group
`id`	number				Идентификатор номера телефона. Метод для получения номеров "get.virtual_numbers"
`child_customer_id`	number				Идентификатор филиала, которому принадлежит номер. Метод получение списка клиентов: "get.customers"
`reserve_pool_id`	number		да	да	Идентификатор резервной группы к которой подключено ПКТ.

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

Копировать

{
 "jsonrpc":"2.0",
 "id":"number",
 "method":"get.call_tracking_rules",
 "params":{
  "access_token":"string",
  "user_id":"number",
  "offset":"number",
  "limit":"number",
  "search_string":"string",
  "site_ids":["number"],
  "call_tracking_types":["string"],
  "rule_types":["string"],
  "is_save_sources":"boolean",
  "coverage":"number",
  "filter":{

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

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

Копировать

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

    },
    "data": [
     {
      "name": "string",
      "is_named_by_user": "boolean",
      "rule_type": "string",
      "call_tracking_type": "string",
      "is_all_traffic": "boolean",
      "state": "string",
      "sites": [
       {
        "id": "number",
        "name": "string",
        "domain": "string"
       }
      ],
      "site_ids":["number"],
      "child_customer_ids":["number"],
      "reserve_pool_id": "number",
      "sources": [
       {
        "source_id": "number",
        "source_group_id": "number",
        "source_channel_id": "number"
       }
      ],
      "dynamic_replacement_phones_settings": [
       {
        "id": "number",
        "replacement_phones_groups": [
         {
          "id": "number",
          "site_id": "number"
         },
         {
          "id": "number",
          "site_id": "number"
         }
        ],
        "custom_redirection_phone": "string",
        "redirection_phone": {
         "id": "number",
         "child_customer_id": "number"
        },
        "call_processing_rule_group_id": "number",
        "scenario_id": "number",
        "employee_id": "number",
        "sip_id": "number",
        "sip_protocol": "string",
        "prefix": "string",
        "visitors_count": "number",
        "virtual_numbers_count": "number",
        "coverage": "number"
       }
      ],
      "static_replacement_phones_settings": [
       {
        "id": "number",
        "replacement_phones_groups": [
         {
          "id": "number",
          "site_id": "number"
         }
        ],
        "custom_redirection_phone": "string",
        "redirection_phone": {
         "id": "number",
         "child_customer_id": "number"
        },
        "call_processing_rule_group_id": "number",
        "scenario_id": "number",
        "employee_id": "number",
        "sip_id": "number",
        "sip_protocol": "string",
        "static_phone_id": "number",
        "source": {
         "source_id": "number",
         "source_group_id": "number",
         "source_channel_id": "number",
         "name": "string"
        },
        "default_source": {
         "source_id": "number",
         "source_group_id": "number",
         "source_channel_id": "number",
         "name": "string"
        }
       }
      ],
      "external_replacement_settings": [
       {
        "id": "number",
        "replacement_phones_groups": [
         {
          "id": "number",
          "site_id": "number"
         }
        ],
        "custom_redirection_phone": "string",
        "redirection_phone": {
         "id": "number",
         "child_customer_id": "number"
        },
        "call_processing_rule_group_id": "number",
        "scenario_id": "number",
        "employee_id": "number",
        "sip_id": "number",
        "sip_protocol": "string",
        "static_phone_id": "number",
        "child_customer_id": "number",
        "source_id": "number"
       }
      ],
      "sources_bundle_settings": [
       {
        "id": "number",
        "replacement_phones_groups": [
         {
          "id": "number",
          "site_id": "number"
         }
        ],
        "custom_redirection_phone": "string",
        "redirection_phone": {
         "id": "number",
         "child_customer_id": "number"
        },
        "call_processing_rule_group_id": "number",
        "scenario_id": "number",
        "employee_id": "number",
        "sip_id": "number",
        "sip_protocol": "string",
        "static_phone_id": "number",
        "source": {
         "source_id": "number",
         "source_group_id": "number",
         "source_channel_id": "number",
         "name": "string"
        },
        "default_source": {
         "source_id": "number",
         "source_group_id": "number",
         "source_channel_id": "number",
         "name": "string"
        }
       }
      ],
      "reserve_phone_numbers_time": "number",
      "conditions": {
      "filters": [
       {
       "filters": [
        {
        "filters": [
         {
         "field": "string",
         "operator": "string",
         "value": "string"
         }
        ],
        "condition": "string"
        },
        {
        "field": "string",
        "operator": "string",
        "value": "string"
        }
       ],
       "condition": "string"
       },
       {
       "field": "string",
       "operator": "string",
       "value": "string"
       }
      ],
      "condition": "string"
      }
     }
    ]
  }
}

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

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