Get SIP Lines of the Application voximplant.sip.get
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
telephonyWho can execute the method: user with the Management of Numbers — modification access permission
The method voximplant.sip.get returns a list of SIP lines created by the current application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
FILTER |
Object for filtering in the format See the list of available fields for filtering below. Supported operators in the filter key:
By default — no filtering. The method always adds a system filter by |
|
SORT |
Sorting field. Uses fields from the list of fields for filtering. By default — no sorting. |
|
ORDER |
Sorting direction. Possible values:
By default — no sorting. |
|
start |
Pagination parameter. The page size of results is 50 records. To get the second page, pass Formula:
|
Available Fields for Filtering
|
Name |
Description |
|
ID |
Internal identifier of the SIP line record. This field is not returned in the method response. |
|
TYPE |
Type of PBX. Possible values:
|
|
TITLE |
Connection name. |
|
CONFIG_ID |
Identifier of the SIP line configuration. |
|
REG_ID |
Identifier of the SIP registration. Relevant for cloud PBX. |
|
APP_ID |
Application identifier. Filtering by this field is forcibly limited to the current application. |
|
SERVER |
Address of the SIP registration server. |
|
LOGIN |
Login for connecting to the server. |
|
PASSWORD |
Password for connecting to the server. |
|
INCOMING_SERVER |
Address of the server for incoming calls. Relevant for office PBX. |
|
INCOMING_LOGIN |
Login for incoming calls. Relevant for office PBX. |
|
INCOMING_PASSWORD |
Password for incoming calls. Relevant for office PBX. |
|
AUTH_USER |
Username for authentication. |
|
OUTBOUND_PROXY |
Address of the SIP proxy for outgoing connection to the operator or PBX. |
|
DETECT_LINE_NUMBER |
Indicator for line number detection. Possible values:
|
|
LINE_DETECT_HEADER_ORDER |
Order of headers for line number detection. |
|
REGISTRATION_STATUS_CODE |
SIP registration status code. |
|
REGISTRATION_ERROR_MESSAGE |
SIP registration error message. |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"FILTER":{"CONFIG_ID":[3,7,9]},"SORT":"CONFIG_ID","ORDER":"ASC"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/voximplant.sip.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"FILTER":{"CONFIG_ID":[3,7,9]},"SORT":"CONFIG_ID","ORDER":"ASC","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/voximplant.sip.get
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each SIP line item returned in result[]
type SipLineItem = {
TYPE: string
CONFIG_ID: string
TITLE: string
REG_ID?: string
SERVER: string
LOGIN: string
PASSWORD: string
INCOMING_SERVER?: string
INCOMING_LOGIN?: string
INCOMING_PASSWORD?: string
AUTH_USER: string | null
OUTBOUND_PROXY: string | null
DETECT_LINE_NUMBER: string
LINE_DETECT_HEADER_ORDER: string
REGISTRATION_STATUS_CODE: string
REGISTRATION_ERROR_MESSAGE: string | null
}
try {
// voximplant.sip.get returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<SipLineItem[]>({
method: 'voximplant.sip.get',
params: {
FILTER: {
CONFIG_ID: [3, 7, 9],
},
SORT: 'CONFIG_ID',
ORDER: 'ASC',
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('SIP lines fetched:', result.length, result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function fetchSipLines() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// voximplant.sip.get returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'voximplant.sip.get',
params: {
FILTER: {
CONFIG_ID: [3, 7, 9],
},
SORT: 'CONFIG_ID',
ORDER: 'ASC',
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('SIP lines fetched:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchSipLines)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
filter = {
"CONFIG_ID": [
3,
7,
9,
],
}
try:
bitrix_response = client.voximplant.sip.get(
filter=filter,
sort='CONFIG_ID',
order='ASC',
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'voximplant.sip.get',
[
'FILTER' => [
'CONFIG_ID' => [3, 7, 9]
],
'SORT' => 'CONFIG_ID',
'ORDER' => 'ASC'
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching SIP data: ' . $e->getMessage();
}
BX24.callMethod(
'voximplant.sip.get',
{
FILTER: {
CONFIG_ID: [3, 7, 9]
},
SORT: 'CONFIG_ID',
ORDER: 'ASC'
},
function(result)
{
if (result.error())
{
console.error(result.error(), result.error_description());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'voximplant.sip.get',
[
'FILTER' => [
'CONFIG_ID' => [3, 7, 9]
],
'SORT' => 'CONFIG_ID',
'ORDER' => 'ASC'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "voximplant.sip.get", b24.Params{
"FILTER": b24.Params{
"CONFIG_ID": []int{3, 7, 9},
},
"SORT": "CONFIG_ID",
"ORDER": "ASC",
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("voximplant.sip.get: %w", err)
}
var items []struct {
Type string `json:"TYPE"`
ConfigID b24.ID `json:"CONFIG_ID"`
RegID b24.ID `json:"REG_ID"`
Server string `json:"SERVER"`
Login string `json:"LOGIN"`
Password string `json:"PASSWORD"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.Type, it.ConfigID)
}
Response Handling
HTTP Status: 200
{
"result": [
{
"TYPE": "cloud",
"CONFIG_ID": "3",
"REG_ID": "150907",
"SERVER": "sipnet.com",
"LOGIN": "0045281811",
"PASSWORD": "N7K4mCG9",
"AUTH_USER": "",
"OUTBOUND_PROXY": "",
"DETECT_LINE_NUMBER": "N",
"LINE_DETECT_HEADER_ORDER": "diversion;to",
"REGISTRATION_STATUS_CODE": "200",
"REGISTRATION_ERROR_MESSAGE": "",
"TITLE": "SIP line"
},
{
"TYPE": "office",
"CONFIG_ID": "7",
"SERVER": "office.provider.local",
"LOGIN": "office_user",
"PASSWORD": "secret",
"INCOMING_SERVER": "ip.b24-6068-1537535782.bitrixphone.com",
"INCOMING_LOGIN": "sip7",
"INCOMING_PASSWORD": "71747523265mb091225eb31996a4a225",
"AUTH_USER": null,
"OUTBOUND_PROXY": null,
"DETECT_LINE_NUMBER": "N",
"LINE_DETECT_HEADER_ORDER": "diversion;to",
"REGISTRATION_STATUS_CODE": "0",
"REGISTRATION_ERROR_MESSAGE": null,
"TITLE": "Office PBX 1"
},
{
"TYPE": "cloud",
"CONFIG_ID": "9",
"REG_ID": "151083",
"SERVER": "sip.provider.com",
"LOGIN": "sip_user",
"PASSWORD": "secret",
"AUTH_USER": null,
"OUTBOUND_PROXY": null,
"DETECT_LINE_NUMBER": "N",
"LINE_DETECT_HEADER_ORDER": "diversion;to",
"REGISTRATION_STATUS_CODE": "502",
"REGISTRATION_ERROR_MESSAGE": "Unable to resolve hostname",
"TITLE": ""
}
],
"total": 3,
"time": {
"start": 1773662224,
"finish": 1773662224.187874,
"duration": 0.18787407875061035,
"processing": 0,
"date_start": "2026-03-16T14:57:04+01:00",
"date_finish": "2026-03-16T14:57:04+01:00",
"operating_reset_at": 1773662824,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Array of SIP line records created by the current application. The composition of records depends on the An empty array means that there are no records matching the |
|
total |
Total number of records in the selection. |
|
next |
Offset for the next page (if any). |
|
time |
Information about the execution time of the request. |
Error Handling
HTTP Status: 403
{
"error": "ACCESS_DENIED",
"error_description": "Access denied!"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
|
Insufficient permissions to retrieve the list of SIP lines. |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |