Create SIP Line voximplant.sip.add

Scope: telephony

Who can execute the method: user with the Management of numbers — modification access permission

The method voximplant.sip.add creates a new SIP line associated with an application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
SERVER* `string`	Address of the SIP registration server
LOGIN* `string`	Login for connecting to the server
PASSWORD `string`	Password for connecting to the server. Maximum length — 100 characters. Not required for calling the method, but necessary for working registration with the operator
TYPE `string`	Type of PBX. Possible values: `cloud` - cloud PBX `office` - office PBX Default: `cloud`
TITLE `string`	Name of the connection. If the parameter is not provided, the interface will display a system name based on the connection type: for `cloud` — Cloud PBX (ID) for `office` — Office PBX (ID) where `ID` is the internal identifier of the SIP line record. The `TITLE` field in the method response will be empty in this case

You can connect no more than 10 cloud SIP lines. Exceeding this limit will return the error MAX_CLOUD_PBX

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 '{"TYPE":"cloud","TITLE":"SIP line 1","SERVER":"sip.provider.com","LOGIN":"sip_user","PASSWORD":"secret"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/voximplant.sip.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TYPE":"cloud","TITLE":"SIP line 1","SERVER":"sip.provider.com","LOGIN":"sip_user","PASSWORD":"secret","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/voximplant.sip.add

try
        {
            const response = await $b24.callMethod(
                'voximplant.sip.add',
                {
                    TYPE: 'cloud',
                    TITLE: 'SIP line 1',
                    SERVER: 'sip.provider.com',
                    LOGIN: 'sip_user',
                    PASSWORD: 'secret'
                }
            );
        
            const result = response.getData().result;
            console.log('Data:', result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'voximplant.sip.add',
                    [
                        'TYPE' => 'cloud',
                        'TITLE' => 'SIP line 1',
                        'SERVER' => 'sip.provider.com',
                        'LOGIN' => 'sip_user',
                        'PASSWORD' => 'secret',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'voximplant.sip.add',
            {
                TYPE: 'cloud',
                TITLE: 'SIP line 1',
                SERVER: 'sip.provider.com',
                LOGIN: 'sip_user',
                PASSWORD: 'secret'
            },
            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.add',
            [
                'TYPE' => 'cloud',
                'TITLE' => 'SIP line 1',
                'SERVER' => 'sip.provider.com',
                'LOGIN' => 'sip_user',
                'PASSWORD' => 'secret',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

Example Response for Creating a Cloud PBX

{
            "result": {
                "ID": "5",
                "TYPE": "cloud",
                "CONFIG_ID": "5",
                "REG_ID": 151082,
                "TITLE": "SIP line 1",
                "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": null,
                "REGISTRATION_ERROR_MESSAGE": null
            },
            "time": {
                "start": 1773654128,
                "finish": 1773654129.048472,
                "duration": 1.0484719276428223,
                "processing": 1,
                "date_start": "2026-03-16T12:42:08+02:00",
                "date_finish": "2026-03-16T12:42:09+02:00",
                "operating_reset_at": 1773654728,
                "operating": 0.2883341312408447
            }
        }

Example Response for Creating an Office PBX

{
            "result": {
                "ID": "7",
                "TYPE": "office",
                "CONFIG_ID": "7",
                "SERVER": "office.provider.local",
                "LOGIN": "office_user",
                "PASSWORD": "secret",
                "INCOMING_SERVER": "ip.b24-6058-1587535982.bitrixphone.com",
                "INCOMING_LOGIN": "sip7",
                "INCOMING_PASSWORD": "71747503265fb091223eb31776a4a225",
                "AUTH_USER": null,
                "OUTBOUND_PROXY": null,
                "DETECT_LINE_NUMBER": "N",
                "LINE_DETECT_HEADER_ORDER": "diversion;to",
                "REGISTRATION_STATUS_CODE": null,
                "REGISTRATION_ERROR_MESSAGE": null,
                "TITLE": "Office PBX 1"
            },
            "time": {
                "start": 1773654928,
                "finish": 1773654928.708338,
                "duration": 0.7083380222320557,
                "processing": 0,
                "date_start": "2026-03-16T12:55:28+02:00",
                "date_finish": "2026-03-16T12:55:28+02:00",
                "operating_reset_at": 1773655528,
                "operating": 0.24362492561340332
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with the created SIP line
ID `string`	Internal identifier of the SIP line record
TYPE `string`	Type of PBX
CONFIG_ID `string`	Identifier of the SIP line configuration
REG_ID `integer`	Identifier of the SIP registration. Returned when creating a cloud PBX
TITLE `string`	Name of the connection
SERVER `string`	Address of the SIP registration server
LOGIN `string`	Login for connecting to the server
PASSWORD `string`	Password for connecting to the server
AUTH_USER `string`	User for SIP authorization
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`	Status code of the SIP line registration
REGISTRATION_ERROR_MESSAGE `string`	Text of the SIP registration error
INCOMING_SERVER `string`	Address of the server for incoming calls. Returned when creating an office PBX
INCOMING_LOGIN `string`	Login for incoming calls. Returned when creating an office PBX
INCOMING_PASSWORD `string`	Password for incoming calls. Returned when creating an office PBX
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400, 403

{
            "error": "CHECK_FIELDS_ERROR",
            "error_description": "Server address not specified"
        }

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
`CHECK_FIELDS_ERROR`	`Server address not specified`	Required parameter `SERVER` is missing
`CHECK_FIELDS_ERROR`	`Login for connecting to the server not specified`	Required parameter `LOGIN` is missing
`CHECK_FIELDS_ERROR`	`Password for connecting to the server cannot exceed 100 characters`	Exceeded limit for parameter `PASSWORD`
`TITLE_EXISTS`	`The specified connection name is already registered in the system`	A line with this name already exists
`MAX_CLOUD_PBX`	`You cannot connect more than 10 virtual PBXs.`	Exceeded limit for cloud SIP lines
`ACCESS_DENIED`	`Access denied!`	Insufficient permissions to create a SIP line

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

Get SIP Connector Status

Get List of SIP Connections

Create SIP Line voximplant.sip.add

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Example Response for Creating a Cloud PBXExample Response for Creating a Cloud PBX

Example Response for Creating an Office PBXExample Response for Creating an Office PBX

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning