Finish Call and Log It in Telephony Statistics telephony.externalCall.finish
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
telephonyWho 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 |
Description |
|
CALL_ID* |
The identifier of the call from the method telephony.externalCall.register |
|
USER_ID* |
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* |
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: |
|
DURATION |
The duration of the call in seconds. Default is |
|
COST |
The cost of the call. Default is |
|
COST_CURRENCY |
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 |
The result code of the call. Possible values:
Default:
|
|
FAILED_REASON |
Text reason for the failed call. Default is an empty string |
|
RECORD_URL |
URL of the call recording. This parameter is deprecated and retained for backward compatibility. It is recommended to use telephony.externalCall.attachRecord |
|
VOTE |
Rating of the call. Possible values:
If the rating is absent — |
|
ADD_TO_CHAT |
Add a message about the call to the employee's chat. Possible values:
Default is |
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
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type ExternalCallFinishResult = {
ID: number
CALL_ID: string
EXTERNAL_CALL_ID: string | null
PORTAL_USER_ID: number
PHONE_NUMBER: string
PORTAL_NUMBER: string
INCOMING: string
CALL_DURATION: number
CALL_START_DATE: ISODate | null
CALL_STATUS: number
CALL_VOTE: number
COST: number
COST_CURRENCY: string
CALL_FAILED_CODE: string
CALL_FAILED_REASON: string
REST_APP_ID: string
REST_APP_NAME: string
CRM_ACTIVITY_ID: number
COMMENT: string | null
CRM_ENTITY_TYPE: string
CRM_ENTITY_ID: number
}
try {
const response = await $b24.actions.v2.call.make<ExternalCallFinishResult>({
method: 'telephony.externalCall.finish',
params: {
CALL_ID: 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
USER_ID: 1269,
DURATION: 95,
STATUS_CODE: '200',
VOTE: 5,
ADD_TO_CHAT: 0,
},
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('Call finished, ID:', result.ID, 'status:', result.CALL_STATUS, 'duration:', result.CALL_DURATION)
}
} 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 finishExternalCall() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'telephony.externalCall.finish',
params: {
CALL_ID: 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
USER_ID: 1269,
DURATION: 95,
STATUS_CODE: '200',
VOTE: 5,
ADD_TO_CHAT: 0,
},
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('Call finished, ID:', result.ID, 'status:', result.CALL_STATUS, 'duration:', result.CALL_DURATION)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', finishExternalCall)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.telephony.external_call.finish(
call_id="externalCall.716f1cb73def9700a23842adf9c4c568.1773130779",
user_id=1269,
duration=95,
status_code="200",
vote=5,
add_to_chat=0,
).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(
'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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "telephony.externalCall.finish", b24.Params{
"CALL_ID": "externalCall.716f1cb73def9700a23842adf9c4c568.1773130779",
"USER_ID": 1269,
"DURATION": 95,
"STATUS_CODE": "200",
"VOTE": 5,
"ADD_TO_CHAT": 0,
})
if err != nil {
return fmt.Errorf("telephony.externalCall.finish: %w", err)
}
var item struct {
CallID string `json:"CALL_ID"`
PortalUserID b24.ID `json:"PORTAL_USER_ID"`
PhoneNumber string `json:"PHONE_NUMBER"`
PortalNumber string `json:"PORTAL_NUMBER"`
Incoming string `json:"INCOMING"`
CallDuration int `json:"CALL_DURATION"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.CallID, item.PortalUserID)
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 |
Description |
|
result |
Data of the saved call record |
|
ID |
Identifier of the record in the statistics |
|
CALL_ID |
Identifier of the call |
|
EXTERNAL_CALL_ID |
External identifier of the call on the integration side |
|
PORTAL_USER_ID |
Identifier of the Bitrix24 user on behalf of whom the call was finished |
|
PHONE_NUMBER |
Subscriber's number |
|
PORTAL_NUMBER |
Line number through which the call was made |
|
INCOMING |
Type of the call. Possible values:
|
|
CALL_DURATION |
Duration of the call in seconds |
|
CALL_START_DATE |
Date and time when the call started |
|
CALL_STATUS |
Completion status. Possible values:
|
|
CALL_VOTE |
Rating of the call |
|
COST |
Cost of the call |
|
COST_CURRENCY |
Currency of the cost |
|
CALL_FAILED_CODE |
Call completion code. Possible values:
|
|
CALL_FAILED_REASON |
Text reason for the call completion |
|
REST_APP_ID |
Identifier of the application |
|
REST_APP_NAME |
Name of the application |
|
CRM_ACTIVITY_ID |
Identifier of the CRM activity for the call |
|
COMMENT |
Comment on the call |
|
CRM_ENTITY_TYPE |
Type of the CRM object associated with the call |
|
CRM_ENTITY_ID |
Identifier of the CRM object associated with the call |
|
ERRORS |
Additional processing errors (if any) |
|
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 |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Current authorization type is denied for this method |
Method called outside the application context |
|
|
CALL_ID must be a string |
Parameter |
|
|
USER_ID or USER_PHONE_INNER should be set |
|
|
|
Call is not found (call should be registered prior to finishing) |
Call not found, it must be registered using the method |
|
|
User is not found or is not active |
User not found or inactive |
|
|
Unexpected database error |
Error saving statistics |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |