Update SIP Line voximplant.sip.update

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: telephony

Who can execute the method: user with the Manage Numbers — Edit access permission

The method voximplant.sip.update updates an existing SIP line created by the current application.

Method Parameters

Required parameters are marked with *

Name
type

Description

CONFIG_ID*
integer

Identifier of the SIP line configuration.

You can obtain the identifier using the voximplant.sip.get method.

TITLE
string

New name for the connection.

SERVER
string

New SIP registration server address.

LOGIN
string

New login for connecting to the server.

PASSWORD
string

New password for connecting to the server. Maximum length is 100 characters.

To make changes, at least one of the following fields must be provided: TITLE, SERVER, LOGIN, PASSWORD.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CONFIG_ID":5,"TITLE":"SIP line 1 (updated)"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/voximplant.sip.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CONFIG_ID":5,"TITLE":"SIP line 1 (updated)","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/voximplant.sip.update
        
// 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
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'voximplant.sip.update',
            params: {
              CONFIG_ID: 5,
              TITLE: 'SIP line 1 (updated)',
            },
            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 line updated, result:', 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 updateSipLine() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'voximplant.sip.update',
                params: {
                  CONFIG_ID: 5,
                  TITLE: 'SIP line 1 (updated)',
                },
                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 line updated, result:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateSipLine)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.voximplant.sip.update(
                config_id=5,
                title='SIP line 1 (updated)',
            ).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.update',
                    [
                        'CONFIG_ID' => 5,
                        'TITLE' => 'SIP line 1 (updated)',
                    ]
                );
        
            $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.update',
            {
                CONFIG_ID: 5,
                TITLE: 'SIP line 1 (updated)'
            },
            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.update',
            [
                'CONFIG_ID' => 5,
                'TITLE' => 'SIP line 1 (updated)',
            ]
        );
        
        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.update", b24.Params{
        	"CONFIG_ID": 5,
        	"TITLE":     "SIP line 1 (updated)",
        })
        if err != nil {
        	return fmt.Errorf("voximplant.sip.update: %w", err)
        }
        
        var value b24.ID
        if err := json.Unmarshal(res.Result, &value); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("result:", value)
        

Response Handling

HTTP Status: 200

{
            "result": 1,
            "time": {
                "start": 1773657589,
                "finish": 1773657589.659046,
                "duration": 0.659045934677124,
                "processing": 0,
                "date_start": "2026-03-16T13:39:49+01:00",
                "date_finish": "2026-03-16T13:39:49+01:00",
                "operating_reset_at": 1773658189,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
integer

Result of the update.

1 — update was successful.

time
time

Information about the request execution time.

Error Handling

HTTP Status: 400, 403, 404

{
            "error": "ERROR_NOT_FOUND",
            "error_description": "Specified CONFIG_ID is not found"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

ERROR_NOT_FOUND

Specified CONFIG_ID is not found

SIP line with the specified CONFIG_ID was not found among the lines of the current application.

CHECK_FIELDS_ERROR

Server address not specified

An empty or incorrect value was provided for the SERVER parameter.

CHECK_FIELDS_ERROR

Login for connecting to the server not specified

An empty or incorrect value was provided for the LOGIN parameter.

CHECK_FIELDS_ERROR

Password for connecting to the server cannot exceed 100 characters

The limit for the PASSWORD parameter has been exceeded.

TITLE_EXISTS

The specified connection name is already registered in the system

A line with that name already exists.

ACCESS_DENIED

Access denied!

Insufficient permissions to update the SIP line.

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

The REST API is available only on commercial plans. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning