List connections

GET /v1/voximplant-sip

Returns the SIP connections of office and cloud PBXs available to the key, with filtering, sorting and pagination.

Parameters

Parameter	Type	Required	Default	Description
Parameter`filter` (query)	Typeobject	Requiredno	Default—	DescriptionFilter by the connection fields from the "Response fields" table, except `hasPassword` and `hasIncomingPassword`. The operator goes before the field name: `>`, `>=`, `!` — not equal, `%` — substring. Filtering syntax. Pass several values of one field as an array. Conditions on different fields are combined with AND, and `filter[logic]=OR` combines them with OR. Example: `?filter[type]=office`, `?filter[configId][]=1&filter[configId][]=17`
Parameter`sort` (query)	Typestring	Requiredno	Default—	DescriptionSort field — any field that `filter` works with. Pass it only together with `order`
Parameter`order` (query)	Typestring	Requiredno	Default—	DescriptionSort direction: `ASC` or `DESC`, case-insensitive. Pass it only together with `sort`
Parameter`start` (query)	Typenumber	Requiredno	Default`0`	DescriptionHow many records to skip. For the next page, pass the `meta.next` value from the previous response

The request accepts no other parameters.

Examples

curl — personal key

Terminal

curl "https://vibecode.bitrix24.com/v1/voximplant-sip?sort=configId&order=ASC" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal

curl "https://vibecode.bitrix24.com/v1/voximplant-sip?sort=configId&order=ASC" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/voximplant-sip?sort=configId&order=ASC', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { data, meta } = await res.json()
for (const sip of data) {
  console.log(sip.configId, sip.type, sip.title, sip.server)
}
if (meta.next !== undefined) {
  console.log('Next page: start =', meta.next)
}

JavaScript — OAuth application

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/voximplant-sip?sort=configId&order=ASC', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data, meta } = await res.json()
for (const sip of data) {
  console.log(sip.configId, sip.type, sip.title, sip.server)
}
if (meta.next !== undefined) {
  console.log('Next page: start =', meta.next)
}

Response fields

Passwords are not included in the response — the hasPassword and hasIncomingPassword flags are returned instead.

Field	Type	Description
Field`success`	Typeboolean	Description`true` on success
Field`data`	Typearray	DescriptionConnections. An empty array if nothing matches the filter
Field`data[].configId`	Typestring	DescriptionConnection ID
Field`data[].type`	Typestring	DescriptionPBX type: `office` — office PBX, `cloud` — cloud PBX
Field`data[].title`	Typestring	DescriptionConnection name
Field`data[].server`	Typestring	DescriptionSIP server address
Field`data[].login`	Typestring	DescriptionLogin on the SIP server
Field`data[].hasPassword`	Typeboolean	DescriptionWhether the connection password is set
Field`data[].authUser`	Typestring \| null	DescriptionUser name for authorization on the SIP server. `null` if not set
Field`data[].outboundProxy`	Typestring \| null	DescriptionProxy server address for outgoing calls. `null` if not set
Field`data[].detectLineNumber`	Typestring	DescriptionWhether to detect the line number from the SIP headers of an incoming call: `N` — do not detect
Field`data[].lineDetectHeaderOrder`	Typestring	DescriptionSIP headers used to detect the line number, in the order they are checked, for example `diversion;to`
Field`data[].registrationStatusCode`	Typestring \| null	DescriptionResult code of the registration on the SIP server, for example `502` when the server is not found
Field`data[].registrationErrorMessage`	Typestring \| null	DescriptionRegistration error text. `null` if there is no error
Field`data[].regId`	Typestring	DescriptionCloud PBX only: registration ID on the SIP server
Field`data[].incomingServer`	Typestring	DescriptionOffice PBX only: server address for incoming calls, issued by Bitrix24
Field`data[].incomingLogin`	Typestring	DescriptionOffice PBX only: login for incoming calls, issued by Bitrix24
Field`data[].hasIncomingPassword`	Typeboolean	DescriptionOffice PBX only: whether the password for incoming calls is set
Field`meta.total`	Typenumber	DescriptionHow many connections match the filter. When nothing matches the filter, `meta` is an empty object
Field`meta.next`	Typenumber	DescriptionThe `start` value for the next page. Present only when there is a next page

Response example

JSON

{
  "success": true,
  "data": [
    {
      "type": "cloud",
      "configId": "1",
      "regId": "133788",
      "server": "pbx.example.com",
      "login": "cloud-line",
      "hasPassword": true,
      "authUser": "cloud-user",
      "outboundProxy": "proxy.example.com",
      "detectLineNumber": "N",
      "lineDetectHeaderOrder": "diversion;to",
      "registrationStatusCode": "502",
      "registrationErrorMessage": "Unable to resolve hostname",
      "title": "Cloud PBX"
    },
    {
      "type": "office",
      "configId": "17",
      "server": "sip.example.com",
      "login": "office-line",
      "hasPassword": true,
      "incomingServer": "ip.b24-1234-1234567890.bitrixphone.com",
      "incomingLogin": "sip17",
      "hasIncomingPassword": true,
      "authUser": null,
      "outboundProxy": null,
      "detectLineNumber": "N",
      "lineDetectHeaderOrder": "diversion;to",
      "registrationStatusCode": "0",
      "registrationErrorMessage": null,
      "title": "Office PBX"
    }
  ],
  "meta": {
    "total": 2
  }
}

Error response example

400 — filter by a password field: