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:
telephonyWho 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 |
Description |
|
CONFIG_ID* |
Identifier of the SIP line configuration. You can obtain the identifier using the voximplant.sip.get method. |
|
TITLE |
New name for the connection. |
|
SERVER |
New SIP registration server address. |
|
LOGIN |
New login for connecting to the server. |
|
PASSWORD |
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
try
{
const response = await $b24.callMethod(
'voximplant.sip.update',
{
CONFIG_ID: 5,
TITLE: 'SIP line 1 (updated)'
}
);
const result = response.getData().result;
console.log('Data:', result);
}
catch (error)
{
console.error('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>';
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 |
Description |
|
result |
Result of the update.
|
|
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 |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
|
SIP line with the specified |
|
|
|
An empty or incorrect value was provided for the |
|
|
|
An empty or incorrect value was provided for the |
|
|
|
The limit for the |
|
|
|
A line with that name already exists. |
|
|
|
Insufficient permissions to update the SIP line. |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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
- Create SIP Line voximplant.sip.add
- Update SIP Line voximplant.sip.update
- Get SIP Lines of the Application voximplant.sip.get
- Delete SIP Line voximplant.sip.delete
- Get SIP Registration Status voximplant.sip.status
- Get the Status of the SIP Connector voximplant.sip.connector.status