Finish Call and Log It in Telephony Statistics telephony.externalCall.finish

Scope: telephony

Who can execute the method: any user

The method telephony.externalCall.finish ends an external call, saves it in the statistics, and logs it in the CRM activity.

The method works only in the context of the application

Method Parameters

Required parameters are marked with *

Name
type

Description

CALL_ID*
string

The identifier of the call from the method telephony.externalCall.register

USER_ID*
integer

The identifier of the user who ends the call.

The user is also assigned as responsible for the CRM entities that were automatically created during the call. For previously existing CRM entities, the responsible person remains unchanged.

The identifier can be obtained using the user.get method.

USER_PHONE_INNER*
string

The internal number of the user.

The internal number can be obtained using the user.get method.

At least one of the parameters must be specified: USER_ID or USER_PHONE_INNER

DURATION
integer

The duration of the call in seconds.

Default is 0

COST
double

The cost of the call.

Default is 0

COST_CURRENCY
string

The currency of the call cost.

A list of currencies can be obtained using the crm.currency.list method.

Default is an empty string

STATUS_CODE
string

The result code of the call.

Possible values:

  • 200 — successful call
  • 304 — missed call
  • 603 — declined
  • 603-S — call canceled
  • 403 — forbidden
  • 404 — invalid number
  • 486 — busy
  • 484 — direction unavailable
  • 503 — direction unavailable
  • 480 — temporarily unavailable
  • 402 — insufficient funds
  • 423 — blocked
  • OTHER — undefined

Default:

  • 200 if DURATION > 0
  • 304 if DURATION = 0

FAILED_REASON
string

Text reason for the failed call.

Default is an empty string

RECORD_URL
string

URL of the call recording.

This parameter is deprecated and retained for backward compatibility. It is recommended to use telephony.externalCall.attachRecord

VOTE
integer

Rating of the call.

Possible values:

  • 1, 2, 3, 4, 5

If the rating is absent — 0 or null

ADD_TO_CHAT
integer

Add a message about the call to the employee's chat.

Possible values:

  • 0 — do not add
  • 1 — add

Default is 1

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CALL_ID":"externalCall.716f1cb73def9700a23842adf9c4c568.1773130779","USER_ID":1269,"DURATION":95,"STATUS_CODE":"200","VOTE":5,"ADD_TO_CHAT":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/telephony.externalCall.finish
        
try
        {
            const response = await $b24.callMethod(
                'telephony.externalCall.finish',
                {
                    CALL_ID: 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
                    USER_ID: 1269,
                    DURATION: 95,
                    STATUS_CODE: '200',
                    VOTE: 5,
                    ADD_TO_CHAT: 0
                }
            );
            
            const result = response.getData().result;
            console.log('Call finished:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'telephony.externalCall.finish',
                    [
                        'CALL_ID' => 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
                        'USER_ID' => 1269,
                        'DURATION' => 95,
                        'STATUS_CODE' => '200',
                        'VOTE' => 5,
                        'ADD_TO_CHAT' => 0
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error finishing call: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "telephony.externalCall.finish",
            {
                CALL_ID: 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
                USER_ID: 1269,
                DURATION: 95,
                STATUS_CODE: '200',
                VOTE: 5,
                ADD_TO_CHAT: 0
            },
            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.externalCall.finish',
            [
                'CALL_ID' => 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
                'USER_ID' => 1269,
                'DURATION' => 95,
                'STATUS_CODE' => '200',
                'VOTE' => 5,
                'ADD_TO_CHAT' => 0
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "CALL_ID": "externalCall.716f1cb73def9700a23842adf9c4c568.1773130779",
                "EXTERNAL_CALL_ID": null,
                "PORTAL_USER_ID": 1269,
                "PHONE_NUMBER": "19062195047",
                "PORTAL_NUMBER": "3",
                "INCOMING": "2",
                "CALL_DURATION": 95,
                "CALL_START_DATE": {},
                "CALL_STATUS": 1,
                "CALL_VOTE": 5,
                "COST": 0,
                "COST_CURRENCY": "",
                "CALL_FAILED_CODE": "200",
                "CALL_FAILED_REASON": "",
                "REST_APP_ID": "3",
                "REST_APP_NAME": "REST API Documentation",
                "CRM_ACTIVITY_ID": 7943,
                "COMMENT": null,
                "CRM_ENTITY_TYPE": "CONTACT",
                "CRM_ENTITY_ID": 797,
                "ID": 7
            },
            "time": {
                "start": 1773132478,
                "finish": 1773132480.301376,
                "duration": 2.3013761043548584,
                "processing": 2,
                "date_start": "2026-03-10T11:47:58+01:00",
                "date_finish": "2026-03-10T11:48:00+01:00",
                "operating_reset_at": 1773133078,
                "operating": 1.4118058681488037
            }
        }

Returned Data

Name
type

Description

result
object

Data of the saved call record

ID
integer

Identifier of the record in the statistics

CALL_ID
string

Identifier of the call

EXTERNAL_CALL_ID
string

External identifier of the call on the integration side

PORTAL_USER_ID
integer

Identifier of the Bitrix24 user on behalf of whom the call was finished

PHONE_NUMBER
string

Subscriber's number

PORTAL_NUMBER
string

Line number through which the call was made

INCOMING
string

Type of the call.

Possible values:

  • 1 — outgoing
  • 2 — incoming
  • 3 — incoming with redirection
  • 4 — callback
  • 5 — informational call

CALL_DURATION
integer

Duration of the call in seconds

CALL_START_DATE
datetime

Date and time when the call started

CALL_STATUS
integer

Completion status.

Possible values:

  • 1 — successful conversation
  • 0 — unsuccessful/missed

CALL_VOTE
integer

Rating of the call

COST
double

Cost of the call

COST_CURRENCY
string

Currency of the cost

CALL_FAILED_CODE
string

Call completion code.

Possible values:

  • 200 — successful call
  • 304 — missed call
  • 603 — declined
  • 603-S — call canceled
  • 403 — forbidden
  • 404 — invalid number
  • 486 — busy
  • 484 — direction unavailable
  • 503 — direction unavailable
  • 480 — temporarily unavailable
  • 402 — insufficient funds
  • 423 — blocked
  • OTHER — undefined

CALL_FAILED_REASON
string

Text reason for the call completion

REST_APP_ID
integer

Identifier of the application

REST_APP_NAME
string

Name of the application

CRM_ACTIVITY_ID
integer

Identifier of the CRM activity for the call

COMMENT
string

Comment on the call

CRM_ENTITY_TYPE
string

Type of the CRM entity associated with the call

CRM_ENTITY_ID
integer

Identifier of the CRM entity associated with the call

ERRORS
object

Additional processing errors (if any)

time
time

Information about the request execution time

Error Handling

HTTP Status: 400, 403

{
            "error": "INVALID_ARGUMENT",
            "error_description": "CALL_ID must be a string"
        }

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 application context

INVALID_ARGUMENT

CALL_ID must be a string

Parameter CALL_ID must be a string

ERROR_CORE

USER_ID or USER_PHONE_INNER should be set

USER_ID and USER_PHONE_INNER not provided

ERROR_CORE

Call is not found (call should be registered prior to finishing)

Call not found, it must be registered using the method telephony.externalCall.register before finishing

ERROR_CORE

User is not found or is not active

User not found or inactive

ERROR_CORE

Unexpected database error

Error saving statistics

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

Previous
Hide Call Detail Form for User
Next
Attach Call Recording