CalledId and CallerId modification rules (provider_callerids)
Requests
| HTTP verb | Endpoint | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Creating a new modification rule
Request
Field description: provider_callerid entity
POST /rest/v1/uc/provider_callerids HTTP/1.1
Content-Type: application/json; charset=utf-8
provider_callerid entity
Response
Field description: 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"
}
}
Getting the list of modification rules
Request
| Name | Type | Description |
|---|---|---|
|
|
Filter by field values. |
|
|
List of fields to output. Available fields for output: id, provider, providercode, priority, dir, fromdomain, fromnumber, tonumber, modfromdisplay, modfromnumber, modtonumber, opts.title, ext.lwt, ext.ct. |
|
|
Offset in the list of resources to output. |
|
|
Maximum number of resources in the list. |
|
|
Sorting order of resources in the list. |
|
|
Transformation of composite fields to flat form. |
GET /rest/v1/uc/provider_callerids?offset=0&limit=2 HTTP/1.1
Response
Field description: 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"
}
}
]
Getting modification rule data
Request
| Name | Type | Description |
|---|---|---|
|
|
List of fields to output. |
|
|
Transformation of composite fields to flat form. |
GET /rest/v1/uc/provider_callerids/0ea04335-016c-d72e-dbe9-50e54938780c HTTP/1.1
Response
Field description: 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"
}
}
Modifying modification rule data
Fields prohibited for modification: id
Request
Field description: 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
Response
Field description: 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"
}
}
Deleting a modification rule
Searching for a modification rule identifier
Searches for a resource by the specified key and returns the identifier(s) for building the endpoint.
Key fields for search: id