Get Call Transcription crm.activity.call.getTranscript
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:
crmWho can execute the method: a user with read access to the CRM object
The crm.activity.call.getTranscript method returns the text of a completed call transcription using a CRM activity identifier.
The method does not trigger transcription generation; it only reads the transcription generated by AI call processing.
If the transcription is not ready, is missing, or if the call processing ended with an error, the method returns null.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
activityId* |
Call type activity identifier, for example You can obtain the identifier using the crm.activity.list method. Pass the CRM object identifier and the activity type |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"activityId":12345}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.call.getTranscript
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"activityId":12345,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.call.getTranscript
// 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
type CallTranscriptResult = {
transcription: string
} | null
try {
const response = await $b24.actions.v2.call.make<CallTranscriptResult>({
method: 'crm.activity.call.getTranscript',
params: {
activityId: 12345,
},
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
if (result === null) {
console.info('There is no transcript for this call')
} else {
console.info('Call transcript:', result.transcription)
}
}
} 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 getCallTranscript() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.activity.call.getTranscript',
params: {
activityId: 12345,
},
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
if (result === null) {
console.info('There is no transcript for this call')
} else {
console.info('Call transcript:', result.transcription)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getCallTranscript)
</script>
try {
$response = $b24Service
->core
->call(
'crm.activity.call.getTranscript',
[
'activityId' => 12345,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
$data = $result->data();
if ($data === null) {
echo 'There is no transcript for this call';
} else {
echo $data['transcription'];
}
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting call transcript: ' . $e->getMessage();
}
BX24.callMethod(
'crm.activity.call.getTranscript',
{
activityId: 12345,
},
result => {
if (result.error()) {
console.error(result.error());
} else {
const data = result.data();
if (data === null) {
console.log('There is no transcript for this call');
} else {
console.log(data.transcription);
}
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.call.getTranscript',
[
'activityId' => 12345
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.activity.call.getTranscript", b24.Params{
"activityId": 12345,
})
if err != nil {
return fmt.Errorf("crm.activity.call.getTranscript: %w", err)
}
var item struct {
Transcription string `json:"transcription"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Transcription)
Response Handling
HTTP status: 200
{
"result": {
"transcription": "Call transcript text..."
},
"time": {
"start": 1712132792.910734,
"finish": 1712132793.530359,
"duration": 0.6196250915527344,
"processing": 0.032338857650756836,
"date_start": "2024-04-03T10:26:32+02:00",
"date_finish": "2024-04-03T10:26:33+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Response root element. If there is no transcription, it returns |
|
time |
Information about the request execution time |
Result Object
|
Name |
Description |
|
transcription |
Full text of the call transcription |
Error Handling
HTTP status: 400, 403
{
"error": "NOT_FOUND",
"error_description": "Element not found"
}
|
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
|
Status |
Code |
Description |
Value |
|
|
|
Item not found |
Activity with the specified |
|
|
|
Access denied |
The user does not have permission to read linked CRM objects or AI call processing is disabled in Bitrix24 |
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 |
|
|
|
The REST API is available only on commercial plans. 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 |