Получить расшифровку звонка crm.activity.call.getTranscript
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с доступом на чтение объекта CRM
Метод crm.activity.call.getTranscript возвращает текст готовой расшифровки звонка по идентификатору дела CRM.
Метод не запускает генерацию расшифровки, а только читает расшифровку, сформированную AI-обработкой звонка.
Если расшифровка не готова, отсутствует или обработка звонка завершилась с ошибкой, метод возвращает null.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
activityId* |
Идентификатор дела типа Звонок, например Получить идентификатор можно методом crm.activity.list. Передайте в фильтре идентификатор объекта CRM и тип дела |
Примеры кода
Как использовать примеры в документации
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('Расшифровки для этого звонка нет')
} 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('Расшифровки для этого звонка нет')
} 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 'Расшифровки для этого звонка нет';
} 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('Расшифровки для этого звонка нет');
} 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>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"transcription": "Текст расшифровки звонка..."
},
"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"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Если расшифровки нет, возвращает |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
transcription |
Полный текст расшифровки звонка |
Обработка ошибок
HTTP-статус: 400, 403
{
"error": "NOT_FOUND",
"error_description": "Элемент не найден"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Элемент не найден |
Дело с указанным |
|
|
|
Доступ запрещен |
У пользователя нет прав на чтение привязанных объектов CRM или в Битрикс24 выключена AI-обработка звонков |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |