Skip to content

Получение правил обработки звонка

Метод getobj.call_processing_rules
Описание Получение правил обработки звонка
Кому доступен Агент, Клиент

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
number_capacity_id number да Уникальный идентификатор виртуального номера: "get.virtual_numbers"

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

Название Тип Допустимые значения Фильтрация Сортировка Описание
Сценарии
scenarios array да Список сценариев, которые связанны с виртуальным номером
scenario_id number Уникальный идентификатор сценария
scenario_name string Название сценария
call_processing_rule_id number Уникальный идентификатор правила обработки вызова
is_active boolean Активно ли правило
Callouts - исходящие звонки, совершенные через пин - код.
callouts array да Список правил Callout, связанныx с виртуальным номером
call_processing_rule_id number Уникальный идентификатор правила обработки вызова
is_dialtone boolean Установлен тональный сигнал
numa array Список номеров для который сработает Callout
is_active boolean Активно ли правило
Callback - обратный звонок
callback array да Список правил Callback, связанныx с виртуальным номером
call_processing_rule_id number Уникальный идентификатор правила обработки вызова
is_active boolean Активно ли правило
is_global boolean Правило для любых номеров
callback_phone string Номер телефона, на который придет входящий звонок от Системы.
numa array Список номеров для который сработает Callback

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"getobj.call_processing_rules",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "number_capacity_id":"number"
  }
}

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

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "metadata": {},
    "data":
      {
        "scenarios": [
          {
            "scenario_id": "number",
            "scenario_name": "string",
            "is_active": "boolean",
            "call_processing_rule_id": "number"
          }
        ],
        "callouts": [
          {
            "call_processing_rule_id": "number",
            "is_active": "boolean",
            "is_dialtone": "boolean",
            "numa": [
              "string"
            ]
          }
        ],
        "callbacks": [
          {
            "call_processing_rule_id": "number",
            "numa": [
              "string"
            ],
            "is_active": "boolean",
            "callback_phone": "string",
            "is_global": "boolean"
          }
      }
  }
}

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

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