Прикрепить запись к завершенному звонку telephony.externalCall.attachRecord

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

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

Scope: telephony

Кто может выполнять метод: любой пользователь

Метод telephony.externalCall.attachRecord прикрепляет запись к завершенному звонку и к CRM-делу звонка.

Вызывайте метод после telephony.externalCall.finish, когда запись готова.

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

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

Название
тип

Описание

CALL_ID*
string

Идентификатор звонка из метода telephony.externalCall.register.

Если вызвать метод повторно для одного и того же звонка, новая запись заменит ранее прикрепленную

RECORD_URL*
string

URL записи на внешнем сервере. Если параметр передан, Битрикс24 скачивает файл по ссылке.

Рекомендуется использовать только если файл доступен стабильно и быстро.

Адрес должен быть доступен из интернета. Если домен из ссылки указывает на непубличный IP-адрес, например из локальной сети, Битрикс24 не скачивает файл и метод возвращает ошибку. Запись из внутренней сети передайте в FILE_CONTENT или загрузите по uploadUrl

FILENAME*
string

Имя файла записи.

Возможные расширения:

  • wav
  • mp3

В режиме RECORD_URL:

  • если FILENAME не передан, имя берется из URL

Необходимо указать хотя бы один из параметров: RECORD_URL или FILENAME

FILE_CONTENT
string

Файл в кодировке Base64

Если передан FILENAME, но не передан FILE_CONTENT, метод вернет uploadUrl и fieldName для последующей загрузки содержимого файла отдельным запросом.

Если переданы и FILENAME, и FILE_CONTENT (или указан RECORD_URL), файл прикрепляется сразу, и в ответе возвращается FILE_ID

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CALL_ID":"externalCall.716f1cb73def9700a23842adf9c4c568.1773130779","FILENAME":"call-001.mp3","FILE_CONTENT":"SUQzAwAAAAAiVVRJVDI...AAAAAAAAAAAAP8="}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/telephony.externalCall.attachRecord
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CALL_ID":"externalCall.716f1cb73def9700a23842adf9c4c568.1773130779","FILENAME":"call-001.mp3","FILE_CONTENT":"SUQzAwAAAAAiVVRJVDI...AAAAAAAAAAAAP8=","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/telephony.externalCall.attachRecord
// 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 AttachRecordResult = {
  FILE_ID?: number
  uploadUrl?: string
  fieldName?: string
}

try {
  const response = await $b24.actions.v2.call.make<AttachRecordResult>({
    method: 'telephony.externalCall.attachRecord',
    params: {
      CALL_ID: 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
      FILENAME: 'call-001.mp3',
      FILE_CONTENT: 'SUQzAwAAAAAiVVRJVDI...AAAAAAAAAAAAP8=',
    },
    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('FILE_ID:', result.FILE_ID, 'uploadUrl:', result.uploadUrl, 'fieldName:', result.fieldName)
  }
} 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 attachRecord() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'telephony.externalCall.attachRecord',
        params: {
          CALL_ID: 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
          FILENAME: 'call-001.mp3',
          FILE_CONTENT: 'SUQzAwAAAAAiVVRJVDI...AAAAAAAAAAAAP8=',
        },
        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('FILE_ID:', result.FILE_ID, 'uploadUrl:', result.uploadUrl, 'fieldName:', result.fieldName)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', attachRecord)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.telephony.external_call.attach_record(
        call_id="externalCall.716f1cb73def9700a23842adf9c4c568.1773130779",
        filename="call-001.mp3",
        file_content="SUQzAwAAAAAiVVRJVDI...AAAAAAAAAAAAP8=",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'telephony.externalCall.attachRecord',
            [
                'CALL_ID' => 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
                'FILENAME' => 'call-001.mp3',
                'FILE_CONTENT' => 'SUQzAwAAAAAiVVRJVDI...AAAAAAAAAAAAP8='
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error attaching record: ' . $e->getMessage();
}
BX24.callMethod(
    "telephony.externalCall.attachRecord",
    {
        CALL_ID: 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
        FILENAME: 'call-001.mp3',
        FILE_CONTENT: 'SUQzAwAAAAAiVVRJVDI...AAAAAAAAAAAAP8='
    },
    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.attachRecord',
    [
        'CALL_ID' => 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
        'FILENAME' => 'call-001.mp3',
        'FILE_CONTENT' => 'SUQzAwAAAAAiVVRJVDI...AAAAAAAAAAAAP8='
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "telephony.externalCall.attachRecord", b24.Params{
	"CALL_ID":      "externalCall.716f1cb73def9700a23842adf9c4c568.1773130779",
	"FILENAME":     "call-001.mp3",
	"FILE_CONTENT": "SUQzAwAAAAAiVVRJVDI...AAAAAAAAAAAAP8=",
})
if err != nil {
	return fmt.Errorf("telephony.externalCall.attachRecord: %w", err)
}

var item struct {
	FileID b24.ID `json:"FILE_ID"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.FileID)

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

Если переданы и FILENAME, и FILE_CONTENT

HTTP-статус: 200

{
    "result": {
        "FILE_ID": 9079
    },
    "time": {
        "start": 1773134738,
        "finish": 1773134740.398239,
        "duration": 2.3982388973236084,
        "processing": 2,
        "date_start": "2026-03-10T12:25:38+03:00",
        "date_finish": "2026-03-10T12:25:40+03:00",
        "operating_reset_at": 1773135338,
        "operating": 1.9444890022277832
    }
}

Если передан FILENAME без FILE_CONTENT

{
    "result": {
        "uploadUrl": "https://test.bitrix24.ru/rest/upload.json?auth=2ae2af690000071b006e2cf2000004f5000007e78a418f2bdef34c831de35c35aaa7ac&token=telephony%7CY2FsbElkPWV4dGVybmFsQ2FsbC43MTZmMWNiNzNkZWY5NzAwYTIzODQyYWRmWRxVVVhdzE%3D%7CInekVhYWE3YWMi.rgOHch62uz5kg9GEslf46sPRmN5MYa/kxBkWcOQtZ/8=",
        "fieldName": "file"
    },
    "time": {
        "start": 1773134240,
        "finish": 1773134240.377464,
        "duration": 0.37746405601501465,
        "processing": 0,
        "date_start": "2026-03-10T12:17:20+03:00",
        "date_finish": "2026-03-10T12:17:20+03:00",
        "operating_reset_at": 1773134840,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Корневой элемент ответа

FILE_ID
integer

Идентификатор прикрепленного файла

uploadUrl
string

URL загрузки файла, если FILE_CONTENT не был передан

fieldName
string

Имя поля для загрузки файла

time
time

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

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Required parameters are not set. Request should contain or URL or FILENAME parameter"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

Пустое значение

Required parameters are not set. Request should contain or URL or FILENAME parameter

Не переданы RECORD_URL и FILENAME

Пустое значение

Call is not found in the statistic table. Looks like it is not finished yet.

Звонок не найден в статистике. Убедитесь, что звонок завершен

ERROR_CORE

File name is empty

Пустой FILENAME

ERROR_CORE

Wrong file extension. Only wav and mp3 are allowed

Недопустимое расширение файла

ERROR_CORE

File content is empty.

Пустой FILE_CONTENT

ERROR_CORE

File content is not properly encoded. Base64 encoding is expected.

FILE_CONTENT передан не в Base64

ERROR_CORE

Server returns HTTP error code

Ошибка HTTP при загрузке записи по RECORD_URL

Пустое значение

Record URL resolves to a non-public address and was blocked.

RECORD_URL указывает на непубличный IP-адрес, например из локальной сети. Передайте запись в FILE_CONTENT или загрузите по uploadUrl

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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