Правила переадресации (redirectrules)

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/uc/redirectrules

Создание нового правила переадресации

GET

/rest/v1/uc/redirectrules

Получение списка правил переадресации

GET

/rest/v1/uc/redirectrules/<id>

Получение данных правила переадресации

PATCH

/rest/v1/uc/redirectrules/<id>

Изменение данных правила переадресации

DELETE

/rest/v1/uc/redirectrules/<id>

Удаление правила переадресации

LOOKUP

/rest/v1/uc/redirectrules

Поиск идентификатора правила переадресации

Создание нового правила переадресации

Запрос

Описание полей: redirectrule entity

Пример запроса
POST /rest/v1/uc/redirectrules HTTP/1.1
Content-Type: application/json; charset=utf-8

redirectrule entity

Ответ

Описание полей: redirectrule entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "df684c6d-016c-d25c-23f0-50e54938780c",
  "type": "busy",
  "filter_number": "16",
  "filter_fromnumber": "*",
  "tran_number": "15",
  "priority": 100,
  "enabled": 1,
  "schedule": "all",
  "periods": [],
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2019-08-27T09:15:49.61Z",
    "lwt": "2019-08-27T09:15:49.61Z"
  }
}

Получение списка правил переадресации

Запрос

Table 1. Параметры запроса
Имя Тип Описание

filter

object

Фильтр по значениям полей.

mask

str

Список полей для вывода. Доступные поля для выдачи: id, type, filter_number, tran_number, priority, enabled, schedule, opts.title, ext.lwt, ext.ct.

offset

int

Смещение в списке ресурсов, подлежащих выдаче.

limit

int

Максимальное количество ресурсов в списке.

order

array<object|str>

Порядок сортировки ресурсов в списке.

flat

bool

Преобразование в плоский вид составных полей.

Подробно про формат параметров GET-запроса

Пример запроса
GET /rest/v1/uc/redirectrules?filter={"schedule":"non-work","enabled":1}&offset=0&limit=2 HTTP/1.1

Ответ

Описание полей: redirectrule entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "90082f72-016c-d268-a209-50e54938780c",
    "type": "busy",
    "filter_number": "2XX",
    "filter_fromnumber": "",
    "tran_number": "205",
    "priority": 55,
    "enabled": 1,
    "schedule": "non-work",
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-27T09:29:28.32Z",
      "lwt": "2019-08-27T09:29:28.32Z"
    }
  },
  {
    "id": "c4e35f4b-016c-d267-ebfa-50e54938780c",
    "type": "absolute",
    "filter_number": "2XX",
    "filter_fromnumber": "",
    "tran_number": "203",
    "priority": 99,
    "enabled": 1,
    "schedule": "non-work",
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-27T09:28:41.72Z",
      "lwt": "2019-08-27T09:28:41.72Z"
    }
  }
]

Получение данных правила переадресации

Запрос

Table 2. Параметры запроса
Имя Тип Описание

mask

str

Список полей для вывода.

flat

bool

Преобразование в плоский вид составных полей.
Пример запроса
GET /rest/v1/uc/redirectrules/df684c6d-016c-d25c-23f0-50e54938780c HTTP/1.1

Ответ

Описание полей: redirectrule entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "df684c6d-016c-d25c-23f0-50e54938780c",
  "type": "busy",
  "filter_number": "16",
  "filter_fromnumber": "*",
  "tran_number": "15",
  "priority": 100,
  "enabled": 1,
  "schedule": "all",
  "periods": [],
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2019-08-27T09:15:49.61Z",
    "lwt": "2019-08-27T09:15:49.61Z"
  }
}

Изменение данных правила переадресации

Поля запрещенные для изменения: id

Запрос

Описание полей: redirectrule entity

Пример запроса
PATCH /rest/v1/uc/redirectrules/df684c6d-016c-d25c-23f0-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

redirectrule entity

Ответ

Описание полей: redirectrule entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "df684c6d-016c-d25c-23f0-50e54938780c",
  "type": "absolute",
  "filter_number": "16",
  "filter_fromnumber": "*",
  "tran_number": "15",
  "priority": 100,
  "enabled": 1,
  "schedule": "custom",
  "periods": [
    {
      "daystart": 6,
      "timestart": 1080,
      "daystop": 7,
      "timestart": 1440
    },
    {
      "daystart": 1,
      "timestart": 0,
      "daystop": 1,
      "timestart": 480
    }
  ],
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2019-08-27T09:15:49.61Z",
    "lwt": "2019-09-09T08:47:39.22Z"
  }
}

Удаление правила переадресации

Запрос

Пример запроса
DELETE /rest/v1/uc/redirectrules/df684c6d-016c-d25c-23f0-50e54938780c HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

Поиск идентификатора правила переадресации

Производит поиск ресурса по указанному ключу, возвращает идентификатор(ы) для построения endpoint.

Ключевые поля для поиска: id, filter_number

Запрос

Пример запроса
LOOKUP /rest/v1/uc/redirectrules HTTP/1.1
Content-Type: application/json; charset=utf-8

"16"

Ответ

Пример успешного ответа
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

[
  "df684c6d-016c-d25c-23f0-50e54938780c"
]
Пример неуспешного ответа
HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

{
  "error_code": 1404,
  "error_message": "Lookup failed"
}
  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт