SIP telephony provider accounts (providers)
Overview
Manages telephony provider accounts.
The account password (the 'pwd' field) is returned only to administrators and is not returned to other users with roles granting read access to the collection.
Requests
| HTTP verb | Endpoint | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Creating a new provider account
Request
Field description: provider entity
POST /rest/v1/uc/providers HTTP/1.1
Content-Type: application/json; charset=utf-8
provider entity
Response
Field description: provider entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "c581b67c-016c-d219-b121-50e54938780c",
"code": "3528769",
"enabled": 1,
"username": "aaa",
"login": "3528769",
"pwd": "bbb",
"domain": "sipnet.ru",
"proxyaddr": "212.53.40.40",
"proxyport": 0,
"transport": "tcp",
"alternative_proxies": "",
"extaddrs": "",
"serveridxs": [11, 12],
"reg": 1,
"expires": 600,
"pingmode": "rn",
"pingsrv": "",
"pingtimeout": 10,
"localdomain": "",
"media": 0,
"reinvite": 1,
"translit": 0,
"lic": {
"siptrunks": 5
},
"trunksout": 3,
"opts": {
"title": "",
"comment": ""
},
"ext": {
"ct": "2019-08-27T08:03:14.84Z",
"lwt": "2019-08-27T08:03:14.84Z"
}
}
Getting the list of provider accounts
Request
| Name | Type | Description |
|---|---|---|
|
|
Filter by field values. |
|
|
List of fields to output. Available fields for output: id, code, enabled, username, login, domain, proxyaddr, proxyport, transport, alternative_proxies, extaddrs, serveridxs, reg, expires, pingmode, pingsrv, pingtimeout, localdomain, media, reinvite, translit, lic, trunksout, opts.title, ext.ct, ext.lwt.. |
|
|
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/providers?offset=0&limit=2 HTTP/1.1
Response
Field description: provider entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"id": "c581b67c-016c-d219-b121-50e54938780c",
"code": "3528769",
"enabled": 1,
"username": "MyAccount",
"login": "3528769",
"domain": "sipnet.ru",
"proxyaddr": "212.53.40.40",
"proxyport": 5060,
"transport": "tcp",
"alternative_proxies": "tcp:212.53.40.41:5060,tcp:212.53.40.42:5060",
"extaddrs": "sipnet.ru,212.53.40.41,212.53.40.42",
"serveridxs": [11, 12],
"reg": 1,
"expires": 600,
"pingmode": "rn",
"pingsrv": "",
"pingtimeout": 10,
"localdomain": "",
"media": 0,
"reinvite": 1,
"translit": 0,
"lic": {
"siptrunks": 5
},
"trunksout": 3,
"opts": {
"title": ""
},
"ext": {
"ct": "2019-08-27T08:03:14.84Z",
"lwt": "2019-08-27T08:03:14.84Z"
}
},
{
"id": "58563833-016c-d21b-070f-50e54938780c",
"code": "Oktell",
"enabled": 1,
"username": "testuser11",
"login": "testuser11",
"domain": "test.oktell.ru",
"proxyaddr": "",
"proxyport": 5060,
"transport": "udp",
"alternative_proxies": "",
"extaddrs": "",
"serveridxs": [11, 12],
"reg": 1,
"expires": 180,
"pingmode": "none",
"pingsrv": "",
"pingtimeout": 10,
"localdomain": "",
"media": 1,
"reinvite": 0,
"translit": 0,
"lic": {
"siptrunks": 1000
},
"trunksout": 9999,
"opts": {
"title": ""
},
"ext": {
"ct": "2019-08-27T08:04:42.38Z",
"lwt": "2019-08-27T08:04:42.38Z"
}
}
]
Getting provider account data
Request
| Name | Type | Description |
|---|---|---|
|
|
List of fields to output. |
|
|
Transformation of composite fields to flat form. |
GET /rest/v1/uc/providers/c581b67c-016c-d219-b121-50e54938780c HTTP/1.1
Response
Field description: provider entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "c581b67c-016c-d219-b121-50e54938780c",
"code": "3528769",
"enabled": 1,
"username": "MyAccount",
"login": "3528769",
"pwd": "VeryStrongPassword",
"domain": "sipnet.ru",
"proxyaddr": "212.53.40.40",
"proxyport": 5060,
"transport": "tcp",
"alternative_proxies": "tcp:212.53.40.41:5060,tcp:212.53.40.42:5060",
"extaddrs": "sipnet.ru,212.53.40.41,212.53.40.42",
"serveridxs": [11, 12],
"reg": 1,
"expires": 600,
"pingmode": "rn",
"pingsrv": "",
"pingtimeout": 10,
"localdomain": "",
"media": 0,
"reinvite": 1,
"translit": 0,
"lic": {
"siptrunks": 5
},
"trunksout": 3,
"opts": {
"title": "",
"comment": ""
},
"ext": {
"ct": "2019-08-27T08:03:14.84Z",
"lwt": "2019-08-27T08:03:14.84Z"
}
}
Modifying provider account data
Fields prohibited for modification: id
Request
Field description: provider entity
PATCH /rest/v1/uc/providers/c581b67c-016c-d219-b121-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8
provider entity
Response
Field description: provider entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "c581b67c-016c-d219-b121-50e54938780c",
"code": "3528769",
"enabled": 1,
"username": "MyAccount",
"login": "3528769",
"pwd": "VeryStrongPassword",
"domain": "sipnet.ru",
"proxyaddr": "212.53.40.40",
"proxyport": 5060,
"transport": "tcp",
"alternative_proxies": "tcp:212.53.40.41:5060,tcp:212.53.40.42:5060",
"extaddrs": "sipnet.ru,212.53.40.41,212.53.40.42",
"serveridxs": [11, 12],
"reg": 1,
"expires": 600,
"pingmode": "rn",
"pingsrv": "",
"pingtimeout": 10,
"localdomain": "",
"media": 0,
"reinvite": 1,
"translit": 0,
"lic": {
"siptrunks": 5
},
"trunksout": 3,
"opts": {
"title": "",
"comment": ""
},
"ext": {
"ct": "2019-08-27T08:03:14.84Z",
"lwt": "2019-08-27T08:03:14.84Z"
}
}