Получить расшифровку звонка crm.activity.call.getTranscript

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с доступом на чтение объекта CRM

Метод crm.activity.call.getTranscript возвращает текст готовой расшифровки звонка по идентификатору дела CRM.

Метод не запускает генерацию расшифровки, а только читает расшифровку, сформированную AI-обработкой звонка.

Если расшифровка не готова, отсутствует или обработка звонка завершилась с ошибкой, метод возвращает null.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

activityId*
integer

Идентификатор дела типа Звонок, например 12345.

Получить идентификатор можно методом crm.activity.list. Передайте в фильтре идентификатор объекта CRM и тип дела TYPE_ID: 2

Примеры кода

Как использовать примеры в документации

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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
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("разбор ответа: %w", err)
}
fmt.Println(item.Transcription)

Обработка ответа

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
object или null

Корневой элемент ответа. Если расшифровки нет, возвращает null (подробное описание)

time
time

Информация о времени выполнения запроса

Объект result

Название
тип

Описание

transcription
string

Полный текст расшифровки звонка

Обработка ошибок

HTTP-статус: 400, 403

{
    "error": "NOT_FOUND",
    "error_description": "Элемент не найден"
}

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Статус

Код

Описание

Значение

400

NOT_FOUND

Элемент не найден

Дело с указанным activityId не найдено или не привязано к объектам CRM

403

ACCESS_DENIED

Доступ запрещен

У пользователя нет прав на чтение привязанных объектов CRM или в Битрикс24 выключена AI-обработка звонков

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение