Правила модификации CalledId и CallerId (provider_callerids)

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/uc/provider_callerids

Создание нового правила модификации

GET

/rest/v1/uc/provider_callerids

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

GET

/rest/v1/uc/provider_callerids/<id>

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

PATCH

/rest/v1/uc/provider_callerids/<id>

Изменение данных правила модификации

DELETE

/rest/v1/uc/provider_callerids/<id>

Удаление правила модификации

LOOKUP

/rest/v1/uc/provider_callerids

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

Создание нового правила модификации

Запрос

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

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

provider_callerid entity

Ответ

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

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

{
  "id": "0ea04335-016c-d72e-dbe9-50e54938780c",
  "idprovider": "58563833-016c-d21b-070f-50e54938780c",
  "providercode": "",
  "priority": 99,
  "dir": "outer",
  "fromdomain": "",
  "fromnumber": "7912XXXXXXX",
  "tonumber": "",
  "modfromdisplay": "*",
  "modfromnumber": "/XXXX/XXXXXXX",
  "modtonumber": "100",
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-28T07:44:28.13Z",
    "lwt": "2019-08-28T07:44:28.13Z"
  }
}

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

Запрос

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

filter

object

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

mask

str

Список полей для вывода. Доступные поля для выдачи: id, provider, providercode, priority, dir, fromdomain, fromnumber, tonumber, modfromdisplay, modfromnumber, modtonumber, opts.title, ext.lwt, ext.ct.

offset

int

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

limit

int

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

order

array<object|str>

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

flat

bool

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

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

Пример запроса
GET /rest/v1/uc/provider_callerids?offset=0&limit=2 HTTP/1.1

Ответ

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

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

[
  {
    "id": "0ea04335-016c-d72e-dbe9-50e54938780c",
    "idprovider": "58563833-016c-d21b-070f-50e54938780c",
    "providercode": "",
    "priority": 99,
    "dir": "outer",
    "fromdomain": "",
    "fromnumber": "7912XXXXXXX",
    "tonumber": "",
    "modfromdisplay": "",
    "modfromnumber": "/XXXX/XXXXXXX",
    "modtonumber": "100",
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-28T07:44:28.13Z",
      "lwt": "2019-08-28T07:44:28.13Z"
    }
  },
  {
    "id": "1e19ccdf-016c-d729-098f-50e54938780c",
    "idprovider": "",
    "providercode": "sipnet_",
    "priority": 100,
    "dir": "inner",
    "fromdomain": "",
    "fromnumber": "8XXXXXXXXXX",
    "tonumber": "",
    "modfromdisplay": "*",
    "modfromnumber": "/X/7XXXXXXXXXX",
    "modtonumber": "100",
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-28T07:38:06.60Z",
      "lwt": "2019-08-28T07:38:06.60Z"
    }
  }
]

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

Запрос

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

mask

str

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

flat

bool

Преобразование в плоский вид составных полей.
Пример запроса
GET /rest/v1/uc/provider_callerids/0ea04335-016c-d72e-dbe9-50e54938780c HTTP/1.1

Ответ

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

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

{
  "id": "0ea04335-016c-d72e-dbe9-50e54938780c",
  "idprovider": "58563833-016c-d21b-070f-50e54938780c",
  "providercode": "",
  "priority": 99,
  "dir": "outer",
  "fromdomain": "",
  "fromnumber": "7912XXXXXXX",
  "tonumber": "",
  "modfromdisplay": "*",
  "modfromnumber": "/XXXX/XXXXXXX",
  "modtonumber": "100",
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-28T07:44:28.13Z",
    "lwt": "2019-08-28T07:44:28.13Z"
  }
}

Изменение данных правила модификации

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

Запрос

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

Пример запроса
PATCH /rest/v1/uc/provider_callerids/0ea04335-016c-d72e-dbe9-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

provider_callerid entity

Ответ

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

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

{
  "id": "0ea04335-016c-d72e-dbe9-50e54938780c",
  "idprovider": "58563833-016c-d21b-070f-50e54938780c",
  "providercode": "",
  "priority": 99,
  "dir": "outer",
  "fromdomain": "",
  "fromnumber": "7912XXXXXXX",
  "tonumber": "",
  "modfromdisplay": "Outer-{D}",
  "modfromnumber": "/XXXX/XXXXXXX",
  "modtonumber": "100",
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-28T07:44:28.13Z",
    "lwt": "2019-09-08T17:32:34.27Z"
  }
}

Удаление правила модификации

Запрос

Пример запроса
DELETE /rest/v1/uc/provider_callerids/0ea04335-016c-d72e-dbe9-50e54938780c HTTP/1.1

Ответ

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

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

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

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

Запрос

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

"0ea04335-016c-d72e-dbe9-50e54938780c"

Ответ

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

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

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