Update External Line telephony.externalLine.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: any user
The method telephony.externalLine.update modifies the parameters of the application's external line.
This method works only in the context of the application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
NUMBER* |
The number of the external line. The number can be obtained using the telephony.externalLine.get method. |
|
NAME |
The new name of the external line. |
|
CRM_AUTO_CREATE |
Auto-creation of a CRM object for outgoing calls. Possible values:
|
At least one field must be provided for modification: NAME or CRM_AUTO_CREATE. Otherwise, you will receive an ERROR_CORE error.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"NUMBER":"14151234567","NAME":"Support Line","CRM_AUTO_CREATE":"N","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/telephony.externalLine.update
try
{
const response = await $b24.callMethod(
'telephony.externalLine.update',
{
NUMBER: '14151234567',
NAME: 'Support Line',
CRM_AUTO_CREATE: 'N'
}
);
const result = response.getData().result;
console.log('Updated external line with ID:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'telephony.externalLine.update',
[
'NUMBER' => '14151234567',
'NAME' => 'Support Line',
'CRM_AUTO_CREATE' => 'N'
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating external line: ' . $e->getMessage();
}
BX24.callMethod(
"telephony.externalLine.update",
{
NUMBER: '14151234567',
NAME: 'Support Line',
CRM_AUTO_CREATE: 'N'
},
function(result)
{
if (result.error())
{
console.error(result.error(), result.error_description());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'telephony.externalLine.update',
[
'NUMBER' => '14151234567',
'NAME' => 'Support Line',
'CRM_AUTO_CREATE' => 'N'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"ID": "7"
},
"time": {
"start": 1772806119,
"finish": 1772806120.006578,
"duration": 1.006577968597412,
"processing": 1,
"date_start": "2026-03-06T17:08:39+02:00",
"date_finish": "2026-03-06T17:08:40+02:00",
"operating_reset_at": 1772806719,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response. |
|
ID |
The identifier of the updated external line. |
|
time |
Information about the request execution time. |
Error Handling
HTTP Status: 400, 403
{
"error": "WRONG_AUTH_TYPE",
"error_description": "Current authorization type is denied for this method"
}
|
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 |
|
|
Current authorization type is denied for this method |
Method called outside the context of the application. |
|
|
There are no fields to update |
No fields provided for modification |
|
|
NUMBER should not be empty |
Required parameter |
|
|
Could not find line with number |
Line with the specified number not found. |
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
- Add External Line telephony.externalLine.add
- Get a List of External Lines with telephony.externalLine.get
- Delete External Line telephony.externalLine.delete
- Register an External Call in Bitrix24 telephony.externalCall.register