Создание пула номеров

Метод	`create.call_tracking_rule`
Описание	Создание ПКТ
Кому доступен	Агент, Клиент

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

Название	Тип	Обязательный	Допустимые значения	Описание
`access_token`	string	да		Ключ сессии аутентификации
`user_id`	number	нет		Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
`name`	string	да		Название ПКТ
`is_named_by_user`	boolean	да		Признак, что название введено ручную
`rule_type`	enum	да	site_calls, external_area, manual_settings	Вид ПКТ. `site_calls` - Звонки с сайтов. `external_area` - Звонки со сторонних площадок. `manual_settings` - Ручная настройка.
`reserve_phone_numbers_time`	number	да		Время резерва динамического номера за посетителем в минутах (от 5 до 10080)
`call_tracking_type`	enum	да	static, dynamic	Тип коллтрекинга. Для `rule_type` = external_area, допустимо только значение static
`state`	enum	да	active, draft	Состояние ПКТ
`is_all_traffic`	boolean	нет	true, false	Использовать данное ПКТ для всего траффика
`sources`	array	нет		Список источников, для которых используется данное ПКТ. Может присутствовать в запросе только если `call_tracking_type` = dynamic. Если `is_all_traffic` = true, массив `sources` не передается, и `source_channel_id`, `source_group_id`, `source_id` отсутствуют.
`source_channel_id`	number	да		Идентификатор канала источника. Метод получение списка существующих каналов: "get.sources_channels"
`source_group_id`	number	нет		Идентификатор группы источника. Метод получение списка существующих групп: "get.sources_groups"
`source_id`	number	нет		Идентификатор источника. Метод получение списка существующих Источников: "get.sources"
`conditions`	array	нет		Условия для определения ПКТ, допустимо только для `rule_type` = manual_settings
`filters`	array			Выражение, может содержать в себе как простые фильтры, так и дерево фильтров
`field`	string			Список допустимых значений и возможных операторов см. в таблице "Список параметров и их операторов
`operator`	enum			Список допустимых значений и возможных операторов см. в таблице "Список параметров и их операторов"
`value`	string			Значение для оператора фильтрации.
`external_replacement_settings`	array	да, если `rule_type` = external_area		Настройка статических номеров. Обязателен, если `rule_type` = external_area. В этом случае `call_tracking_type` может быть только static. Для `site_calls` и `manual_settings` этот блок передавать нельзя.
`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			Идентификатор клиента агента, для которого заведен сайт. Метод получение списка клиентов: "get.customers"
`call_processing_rule_group_id`	number	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Группа правил обработки звонков. Метод получение списка групп: "get.call_processing_rule_groups"
`custom_redirection_phone`	string	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Номер для переадресации.
`redirection_phone`	object	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Номер для переадресации.
`id`	number	нет		Идентификатор номера телефона. Метод для получения номеров "get.virtual_numbers"
`child_customer_id`	number	нет		Идентификатор филиала, которому принадлежит номер. Метод получение списка клиентов: "get.customers"
`scenario_id`	number	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Сценарий переадресации. Метод получение списка сценариев: "get.scenarios"
`employee_id`	number	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Сотрудник, который будет обрабатывать звонки. Метод получение списка сотрудников: "get.employees"
`static_replacement_phones_settings`	array	да, если `call_tracking_type` = static и `rule_type` = site_calls или manual_settings		Настройка статических номеров. Обязателен, если `call_tracking_type` = static и `rule_type` = site_calls или manual_settings. При `call_tracking_type` = dynamic и при `rule_type` = external_area этот блок передавать нельзя.
`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_id`	number	нет		Идентификатор источника для отображения в отчете. Метод получение списка существующих Источников: "get.sources"
`static_phone_id`	number	да		Номер для статического коллтрекинга. Метод для получения номеров "get.virtual_numbers"
`call_processing_rule_group_id`	number	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Группа правил обработки звонков. Метод получение списка групп: "get.call_processing_rule_groups"
`custom_redirection_phone`	string	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Номер для переадресации.
`redirection_phone`	object	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Номер для переадресации.
`id`	number	нет		Идентификатор номера телефона. Метод для получения номеров "get.virtual_numbers"
`child_customer_id`	number	нет		Идентификатор филиала, которому принадлежит номер. Метод получение списка клиентов: "get.customers"
`scenario_id`	number	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Сценарий переадресации. Метод получение списка сценариев: "get.scenarios"
`employee_id`	number	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Сотрудник, который будет обрабатывать звонки. Метод получение списка сотрудников: "get.employees"
`dynamic_replacement_phones_settings`	array	да, если `call_tracking_type` = dynamic		Настройки групп телефонных номеров для замены на номера динамического коллтрекинга. Обязателен, если `call_tracking_type` = dynamic. При `call_tracking_type` = static и при `rule_type` = external_area этот блок передавать нельзя.
`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	нет	Минимальное значение = 1	Общее количество номеров коллтрекинга в одном блоке. Необходимое количество номеров будет докуплено.
`visitors_count`	number	нет	Минимальное значение = 1	Количество посещений в сутки. Обязателен и заполняется только, если is_dynamic = true
`call_processing_rule_group_id`	number	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Группа правил обработки звонков. Метод получение списка групп: "get.call_processing_rule_groups"
`custom_redirection_phone`	string	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Номер для переадресации.
`redirection_phone`	object	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Номер для переадресации.
`id`	number	нет		Идентификатор номера телефона. Метод для получения номеров "get.virtual_numbers"
`child_customer_id`	number	нет		Идентификатор филиала, которому принадлежит номер. Метод получение списка клиентов: "get.customers"
`scenario_id`	number	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Сценарий переадресации. Метод получение списка сценариев: "get.scenarios"
`employee_id`	number	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Сотрудник, который будет обрабатывать звонки. Метод получение списка сотрудников: "get.employees"
`sources_bundle_settings`	array	да, если `call_tracking_type` = dynamic		Гарантия на источник, позволяет сохранить источник при звонке на статические номера. Обязателен, если `call_tracking_type` = dynamic, массив может быть пустым. При `call_tracking_type` = static и при `rule_type` = external_area этот блок передавать нельзя.
`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_id`	number	нет		Идентификатор источника для отображения в отчете. Метод получение списка существующих Источников: "get.sources"
`static_phone_id`	number	да		Номер для статического коллтрекинга. Метод для получения номеров "get.virtual_numbers"
`call_processing_rule_group_id`	number	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Группа правил обработки звонков. Метод получение списка групп: "get.call_processing_rule_groups"
`custom_redirection_phone`	string	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Номер для переадресации.
`redirection_phone`	object	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Номер для переадресации.
`id`	number	нет		Идентификатор номера телефона. Метод для получения номеров "get.virtual_numbers"
`child_customer_id`	number	нет		Идентификатор филиала, которому принадлежит номер. Метод получение списка клиентов: "get.customers"
`scenario_id`	number	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Сценарий переадресации. Метод получение списка сценариев: "get.scenarios"
`employee_id`	number	нет	Одно из значений `custom_redirection_phone` `redirection_phone` `call_processing_rule_group_id` `scenario_id` `employee_id`	Сотрудник, который будет обрабатывать звонки. Метод получение списка сотрудников: "get.employees"
`reserve_pool_id`	number	нет	Может присутствовать в запросе только если `call_tracking_type` = `dynamic`	Идентификатор резервной группы к которой подключено ПКТ.

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

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Описание
`id`	number				Уникальный идентификатор пула номеров

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

Копировать

{
 "jsonrpc": "2.0",
 "id": "b-MF31Xhu62QnxWtqeWcV11",
 "method": "create.call_tracking_rule",
 "params": {
  "name": "string",
  "is_named_by_user": "boolean",
  "rule_type": "string",
  "call_tracking_type": "string",
  "is_all_traffic": "boolean",
  "state": "string",
  "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",
    "prefix": "string",
    "visitors_count": "number",
    "virtual_numbers_count": "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",
    "static_phone_id": "number",
    "source": {
     "source_id": "number",
     "source_group_id": "number",
     "source_channel_id": "number"
    },
    "default_source_id": "number"
   }
  ],
  "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",
    "static_phone_id": "number",
    "child_customer_id": "number",
    "source_id": "number",
    "child_customer_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",
    "static_phone_id": "number",
    "source": {
     "source_id": "number",
     "source_group_id": "number",
     "source_channel_id": "number"
    },
    "default_source_id": "number"
   }
  ],
  "reserve_phone_numbers_time": "number",
  "conditions": {
  "filters": [
   {
   "filters": [
    {
    "filters": [
     {
     "field": "string",
     "operator": "string",
     "value": "string"
     },
     {
     "field": "string",
     "operator": "string",
     "value": "string"
     }
    ],
    "condition": "string"
    },
    {
    "field": "string",
    "operator": "string",
    "value": "string"
    }
   ],
   "condition": "string"
   },
   {
   "field": "string",
   "operator": "string",
   "value": "string"
   }
  ],
  "condition": "string"
  }
 }
}

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

Копировать

{
 "jsonrpc": "2.0",
 "id": "number",
 "result": {
   "data": {
     "id": "number"
   },
   "metadata": "object"
 }
}

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

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