Information about linked accounts SIP

Table of Contents

Requests
Getting a list of linked accounts SIP
Retrieving account data SIP
Getting the list of partitions

Requests

HTTP verb Endpoint Description

HTTP verb	Endpoint	Description
`GET`	`/rest/v1/user/sip/accounts`	Getting a list of linked accounts SIP
`GET`	`/rest/v1/user/sip/accounts/:AccountID`	Retrieving account data SIP
`GET`	`/rest/v1/user/sip/accounts/:AccountID/`	Getting the list of partitions

GET

/rest/v1/user/sip/accounts

Getting a list of linked accounts SIP

GET

/rest/v1/user/sip/accounts/:AccountID

Retrieving account data SIP

GET

/rest/v1/user/sip/accounts/:AccountID/

Getting the list of partitions

For all requests:
Domain Type: working

Getting a list of linked accounts SIP

Returns a list of SIP accounts attached to an authorized user.

The output is identical to the contents of the 'sip_accounts' field in response to a REST request '/rest/v1/user/info'.

Using the identifiers of the listed accounts, you can generate URLs for REST requests to entities associated with the corresponding accounts SIP.
For example, '/rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9', '/rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9/parallel'.

Request

Request example

GET /rest/v1/user/sip/accounts HTTP/1.1

Response

Response example

HTTP/1.1 200 OK

[
  {
    "id": "c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9",
    "login": "7913",
    "phonenumber": "7913"
  },
  {
    "id": "57278625-5fa4-eb0c-fb53-f6fa26881f25",
    "login": "p.bukashin",
    "phonenumber": "414"
  }
]

Retrieving account data SIP

Returns selected properties of the SIP account specified using the identifier and attached to the authorized user.

Request

Request example

GET /rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9 HTTP/1.1

Response

Response example

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9",
  "login": "sip3",
  "phonenumber": "13",
  "name": "SIP3-{D}-{A}",
  "reg": true
  "devices": [],
  "lic": {
    "devices": 123456789
  },
  "opts": {
    "ap_device_model": "",
    "ap_devices": [],
    "ap_mac_address": "",
    "calltimesec": 30,
    "dlgtimesec": 0,
    "parallel": [
      "101"
    ],
    "trunks": -1
  },
  "ext": {
    "k": "abc"
  }
}

Getting the list of partitions

Returns a list of Endpoints-API partitions in the catalog '/rest/v1/user/sip/:Account/'.

Request

Request example

GET /rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9/ HTTP/1.1

Response

Response example

HTTP/1.1 200 OK

[
  "parallel",
  "redirect_rules",
  "voicemail_messages",
  "callback_requests"
]