Add Transcription to Call with telephony.call.attachTranscription
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.call.attachTranscription adds a transcription of the conversation to a completed call.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
CALL_ID* |
Identifier of the call from the method telephony.externalCall.register |
|
MESSAGES* |
Array of transcription utterances |
|
COST |
Cost of the transcription. By default — not set |
|
COST_CURRENCY |
Currency of the transcription cost. Used only with By default — not set |
MESSAGES Parameter
|
Name |
Description |
|
SIDE* |
Participant of the conversation. Possible values:
|
|
START_TIME* |
Start time of the utterance in seconds from the beginning of the call. Minimum value — |
|
STOP_TIME* |
End time of the utterance in seconds from the beginning of the call. Minimum value — |
|
MESSAGE* |
Text of the utterance |
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","MESSAGES":[{"SIDE":"User","START_TIME":1,"STOP_TIME":3,"MESSAGE":"Good afternoon"},{"SIDE":"Client","START_TIME":4,"STOP_TIME":7,"MESSAGE":"Hello"}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/telephony.call.attachTranscription
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CALL_ID":"externalCall.716f1cb73def9700a23842adf9c4c568.1773130779","MESSAGES":[{"SIDE":"User","START_TIME":1,"STOP_TIME":3,"MESSAGE":"Good afternoon"},{"SIDE":"Client","START_TIME":4,"STOP_TIME":7,"MESSAGE":"Hello"}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/telephony.call.attachTranscription
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type AttachTranscriptionResult = {
TRANSCRIPT_ID: number
}
try {
const response = await $b24.actions.v2.call.make<AttachTranscriptionResult>({
method: 'telephony.call.attachTranscription',
params: {
CALL_ID: 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
MESSAGES: [
{ SIDE: 'User', START_TIME: 1, STOP_TIME: 3, MESSAGE: 'Hello' },
{ SIDE: 'Client', START_TIME: 4, STOP_TIME: 7, MESSAGE: 'Hi there' },
],
},
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('Transcript ID:', result.TRANSCRIPT_ID)
}
} 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 attachTranscription() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'telephony.call.attachTranscription',
params: {
CALL_ID: 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
MESSAGES: [
{ SIDE: 'User', START_TIME: 1, STOP_TIME: 3, MESSAGE: 'Hello' },
{ SIDE: 'Client', START_TIME: 4, STOP_TIME: 7, MESSAGE: 'Hi there' },
],
},
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('Transcript ID:', result.TRANSCRIPT_ID)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', attachTranscription)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
messages = [
{
"SIDE": "User",
"START_TIME": 1,
"STOP_TIME": 3,
"MESSAGE": "Hello",
},
{
"SIDE": "Client",
"START_TIME": 4,
"STOP_TIME": 7,
"MESSAGE": "Hi there",
},
]
try:
bitrix_response = client.telephony.call.attach_transcription(
call_id="externalCall.716f1cb73def9700a23842adf9c4c568.1773130779",
messages=messages,
).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.call.attachTranscription',
[
'CALL_ID' => 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
'MESSAGES' => [
['SIDE' => 'User', 'START_TIME' => 1, 'STOP_TIME' => 3, 'MESSAGE' => 'Good afternoon'],
['SIDE' => 'Client', 'START_TIME' => 4, 'STOP_TIME' => 7, 'MESSAGE' => 'Hello']
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error attaching transcription: ' . $e->getMessage();
}
BX24.callMethod(
"telephony.call.attachTranscription",
{
CALL_ID: 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
MESSAGES: [
{ SIDE: 'User', START_TIME: 1, STOP_TIME: 3, MESSAGE: 'Good afternoon' },
{ SIDE: 'Client', START_TIME: 4, STOP_TIME: 7, MESSAGE: 'Hello' }
]
},
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.call.attachTranscription',
[
'CALL_ID' => 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
'MESSAGES' => [
['SIDE' => 'User', 'START_TIME' => 1, 'STOP_TIME' => 3, 'MESSAGE' => 'Good afternoon'],
['SIDE' => 'Client', 'START_TIME' => 4, 'STOP_TIME' => 7, 'MESSAGE' => 'Hello']
]
]
);
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.call.attachTranscription", b24.Params{
"CALL_ID": "externalCall.716f1cb73def9700a23842adf9c4c568.1773130779",
"MESSAGES": []b24.Params{
{
"SIDE": "User",
"START_TIME": 1,
"STOP_TIME": 3,
"MESSAGE": "Good afternoon",
},
{
"SIDE": "Client",
"START_TIME": 4,
"STOP_TIME": 7,
"MESSAGE": "Hello",
},
},
})
if err != nil {
return fmt.Errorf("telephony.call.attachTranscription: %w", err)
}
var item struct {
TranscriptID b24.ID `json:"TRANSCRIPT_ID"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.TranscriptID)
Response Handling
HTTP Status: 200
{
"result": {
"TRANSCRIPT_ID": 1
},
"time": {
"start": 1773136191,
"finish": 1773136191.49517,
"duration": 0.49517011642456055,
"processing": 0,
"date_start": "2026-03-10T12:49:51+01:00",
"date_finish": "2026-03-10T12:49:51+01:00",
"operating_reset_at": 1773136791,
"operating": 0.1380019187927246
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
TRANSCRIPT_ID |
Identifier of the transcription |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "ERROR_CORE",
"error_description": "MESSAGES should be an array"
}
|
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 |
|
|
CALL_ID should be set |
|
|
|
MESSAGES should be an array |
Parameter |
|
|
MESSAGES[{N}][SIDE] should be either Client or User |
Invalid value for |
|
|
MESSAGES[{N}][START_TIME] should be greater or equal to zero |
Invalid |
|
|
MESSAGES[{N}][STOP_TIME] should be greater than zero |
Invalid |
|
|
MESSAGES[{N}][MESSAGE] is empty |
Empty text for the utterance |
|
|
Call {CALL_ID} is not found. Is it finished? |
Call not found in the statistics. Ensure the call is completed |
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 |