Правила переадресации
Обзор
Управляет набором Правил переадресации, назначенных указанной учетной записи SIP, прикрепленной к авторизованному пользователю.
Коллекция по полному пути доступна пользователям для подписки на изменения через websocket subscr, а также на операции CRUD через websocket rest.
Запросы
| HTTP verb | Endpoint | Описание |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Для всех запросов:
Тип домена: рабочий
Получение списка правил переадресации
Возвращает список всех правил переадресации, назначенных для учетной записи SIP, указанной с помощью идентификатора и прикрепленной к авторизованному пользователю.
Запрос
GET /rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9/redirect_rules HTTP/1.1Ответ
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"id": "d0b0e345-0183-c6ad-52de-7cd30a921f58",
"enabled": 1,
"filter_fromnumber": "*",
"tran_number": "13",
"type": "dnd",
"priority": 107,
"schedule": "all",
"periods": [],
"opts": {
"comment": "",
"tab": [],
"title": ""
}
},
{
"id": "cefa0a22-0183-c6ad-75c1-7cd30a921f58",
"enabled": 1,
"filter_fromnumber": "*",
"tran_number": "13",
"type": "error",
"priority": 105,
"schedule": "all",
"periods": [],
"opts": {
"comment": "zzz",
"tab": [],
"title": "f1"
}
},
{
"id": "54b0cd97-0183-c6ad-8773-7cd30a921f58",
"enabled": 1,
"filter_fromnumber": "*",
"tran_number": "13",
"type": "busy",
"priority": 100,
"schedule": "all",
"periods": [],
"opts": {
"comment": "",
"tab": [],
"title": ""
}
}
]Очистка списка правил переадресации
Удаляет все правила переадресации, назначенные для учетной записи SIP, указанной с помощью идентификатора и прикрепленной к авторизованному пользователю.
Создание нового правила переадресации
Создает новое правило переадресации.
Автоматически привязывает его к учетной записи SIP, указанной с помощью идентификатора и прикрепленной к авторизованному пользователю.
Запрос
POST /rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9/redirect_rule HTTP/1.1
Content-Type: application/json
{
"enabled": 0,
"filter_fromnumber": "*",
"tran_number": "13",
"type": "error",
"priority": 105,
"schedule": "all",
"periods": [],
"opts": {
"comment": "1234",
"tab": [],
"title": "AAAAAAAA"
}
}Ответ
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "cefa0a22-0183-c6ad-75c1-7cd30a921f58",
"enabled": 0,
"filter_fromnumber": "*",
"tran_number": "13",
"type": "error",
"priority": 105,
"schedule": "all",
"periods": [],
"opts": {
"comment": "1234",
"tab": [],
"title": "AAAAAAAA"
}
}Получение правила переадресации
Запрос
GET /rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9/redirect_rule/cefa0a22-0183-c6ad-75c1-7cd30a921f58 HTTP/1.1Ответ
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "cefa0a22-0183-c6ad-75c1-7cd30a921f58",
"enabled": 1,
"filter_fromnumber": "*",
"tran_number": "13",
"type": "error",
"priority": 105,
"schedule": "all",
"periods": [],
"opts": {
"comment": "zzz",
"tab": [],
"title": "f1"
}
}Замена правила переадресации
Производит замещение существующего правила переадресации или создает новое с указанным идентификатором.
Автоматически привязывает его к учетной записи SIP, указанной с помощью идентификатора и прикрепленной к авторизованному пользователю.
Запрос
PUT /rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9/redirect_rule/cefa0a22-0183-c6ad-75c1-7cd30a921f58 HTTP/1.1
Content-Type: application/json
{
"enabled": 0,
"filter_fromnumber": "*",
"tran_number": "13",
"type": "error",
"priority": 105,
"schedule": "all",
"periods": [],
"opts": {
"comment": "1234",
"tab": [],
"title": "AAAAAAAA"
}
}Ответ
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "cefa0a22-0183-c6ad-75c1-7cd30a921f58",
"enabled": 0,
"filter_fromnumber": "*",
"tran_number": "13",
"type": "error",
"priority": 105,
"schedule": "all",
"periods": [],
"opts": {
"comment": "1234",
"tab": [],
"title": "AAAAAAAA"
}
}Изменение правила переадресации
Производит частчное изменение существующего правила переадресации.
Передаваемый в содержимом объект сливается с существующим правилом передаресации. Отсутствующие в содержимом поля остаются неизменными.
Поле 'opts' сливается на 1 уровень в глубину. Так, отсутствие в передаваемом поле opts ключа оставляет его неизменным.
Запрос
PATCH /rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9/redirect_rule/cefa0a22-0183-c6ad-75c1-7cd30a921f58 HTTP/1.1
Content-Type: application/json
{
"enabled": 1,
"opts": {
"comment": "zzz",
"title": "f1"
}
}Ответ
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "cefa0a22-0183-c6ad-75c1-7cd30a921f58",
"enabled": 1,
"filter_fromnumber": "*",
"tran_number": "13",
"type": "error",
"priority": 105,
"schedule": "all",
"periods": [],
"opts": {
"comment": "zzz",
"tab": [],
"title": "f1"
}
}Удаление правила переадресации
Удаляет указанное правило переадресации, назначенное для учетной записи SIP, указанной с помощью идентификатора и прикрепленной к авторизованному пользователю.