Update External Line telephony.externalLine.update

Scope: telephony

Who 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 `type`	Description
NUMBER* `string`	The number of the external line. The number can be obtained using the telephony.externalLine.get method.
NAME `string`	The new name of the external line.
CRM_AUTO_CREATE `string`	Auto-creation of a CRM object for outgoing calls. Possible values: `Y` — enabled `N` — disabled

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 (OAuth)

PHP

BX24.js

PHP CRest

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 `type`	Description
result `object`	The root element of the response.
ID `integer`	The identifier of the updated external line.
time `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 `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
`WRONG_AUTH_TYPE`	Current authorization type is denied for this method	Method called outside the context of the application.
`ERROR_CORE`	There are no fields to update	No fields provided for modification `NAME` or `CRM_AUTO_CREATE`.
`ERROR_CORE`	NUMBER should not be empty	Required parameter `NUMBER` not provided.
`ERROR_CORE`	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 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

Retrieve a List of External Lines

Update External Line telephony.externalLine.update

Method ParametersMethod Parameters

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