Get SIP Lines of the Application voximplant.sip.get

Scope: telephony

Who 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 `type`	Description
FILTER `object`	Object for filtering in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. See the list of available fields for filtering below. Supported operators in the filter key: `!` — not equal `>=` — greater than or equal to `>` — greater than `<=` — less than or equal to `<` — less than `><` — between (inclusive range) `!><` — not between (outside the range) `?` — string search `=` — equal, exact match (used by default) `!=` — not equal `%` — LIKE, substring search `!%` — NOT LIKE, substring search By default — no filtering. The method always adds a system filter by `APP_ID` of the current application.
SORT `string`	Sorting field. Uses fields from the list of fields for filtering. By default — no sorting.
ORDER `string`	Sorting direction. Possible values: `ASC` — ascending order `DESC` — descending order By default — no sorting.
start `integer`	Pagination parameter. The page size of results is 50 records. To get the second page, pass `50`; for the third — `100`, and so on. Formula: `start = (N - 1) * 50`, where `N` is the page number.

Available Fields for Filtering

Name `type`	Description
ID `integer`	Internal identifier of the SIP line record. This field is not returned in the method response.
TYPE `string`	Type of PBX. Possible values: `cloud` — cloud PBX `office` — office PBX
TITLE `string`	Connection name.
CONFIG_ID `integer`	Identifier of the SIP line configuration.
REG_ID `integer`	Identifier of the SIP registration. Relevant for cloud PBX.
APP_ID `string`	Application identifier. Filtering by this field is forcibly limited to the current application.
SERVER `string`	Address of the SIP registration server.
LOGIN `string`	Login for connecting to the server.
PASSWORD `string`	Password for connecting to the server.
INCOMING_SERVER `string`	Address of the server for incoming calls. Relevant for office PBX.
INCOMING_LOGIN `string`	Login for incoming calls. Relevant for office PBX.
INCOMING_PASSWORD `string`	Password for incoming calls. Relevant for office PBX.
AUTH_USER `string`	Username for authentication.
OUTBOUND_PROXY `string`	Address of the SIP proxy for outgoing connection to the operator or PBX.
DETECT_LINE_NUMBER `string`	Indicator for line number detection. Possible values: `Y` — line number detection enabled `N` — line number detection disabled.
LINE_DETECT_HEADER_ORDER `string`	Order of headers for line number detection.
REGISTRATION_STATUS_CODE `integer`	SIP registration status code.
REGISTRATION_ERROR_MESSAGE `string`	SIP registration error message.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
            const response = await $b24.callMethod(
                'voximplant.sip.get',
                {
                    FILTER: {
                        CONFIG_ID: [3, 7, 9]
                    },
                    SORT: 'CONFIG_ID',
                    ORDER: 'ASC'
                }
            );
            
            const result = response.getData().result;
            console.log('Fetched SIP data:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('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>';

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 `type`	Description
result `object[]`	Array of SIP line records created by the current application. The composition of records depends on the `FILTER` conditions. An empty array means that there are no records matching the `FILTER` conditions.
total `integer`	Total number of records in the selection.
next `integer`	Offset for the next page (if any).
time `time`	Information about the execution time of the request.

Error Handling

HTTP Status: 403

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied!"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`ACCESS_DENIED`	`Access denied!`	Insufficient permissions to retrieve the list of SIP lines.

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Add SIP Connection

Modify SIP Connection

Get SIP Lines of the Application voximplant.sip.get

Method ParametersMethod Parameters

Available Fields for FilteringAvailable Fields for Filtering

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning