Attach a Record to a Completed Call telephony.externalCall.attachRecord

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: telephony

Who can execute the method: any user

The method telephony.externalCall.attachRecord attaches a record to a completed call and to the CRM activity of the call.

Call this method after telephony.externalCall.finish when the record is ready.

Method Parameters

Required parameters are marked with *

Name
type

Description

CALL_ID*
string

The identifier of the call from the method telephony.externalCall.register.

If the method is called again for the same call, the new record will replace the previously attached one.

RECORD_URL
string

The URL of the record on an external server. If this parameter is provided, Bitrix24 will download the file from the link.

It is recommended to use this only if the file is reliably and quickly accessible.

FILENAME
string

The name of the record file.

Possible extensions:

  • wav
  • mp3

In RECORD_URL mode:

  • if FILENAME is not provided, the name is taken from the URL.

FILE_CONTENT
string

The file in Base64 encoding.

If FILENAME is provided but FILE_CONTENT is not, the method will return uploadUrl and fieldName for subsequent file content upload in a separate request.

If both FILENAME and FILE_CONTENT (or RECORD_URL) are provided, the file is attached immediately, and FILE_ID is returned in the response.

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","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 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.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 and ctx are already created — see the Go SDK section
        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("parse response: %w", err)
        }
        fmt.Println(item.FileID)
        

Response Handling

If both FILENAME and FILE_CONTENT are provided

HTTP status: 200

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

If FILENAME is provided without FILE_CONTENT

{
            "result": {
                "uploadUrl": "https://test.bitrix24.com/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+01:00",
                "date_finish": "2026-03-10T12:17:20+01:00",
                "operating_reset_at": 1773134840,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

The root element of the response

FILE_ID
integer

The identifier of the attached file

uploadUrl
string

The URL for uploading the file if FILE_CONTENT was not provided

fieldName
string

The field name for uploading the file

time
time

Information about the request execution time

Error Handling

HTTP status: 400

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

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

ERROR_CORE

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

Neither RECORD_URL nor FILENAME was provided

ERROR_CORE

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

The call was not found in the statistics. Ensure that the call is completed.

ERROR_CORE

File name is empty

Empty FILENAME

ERROR_CORE

Wrong file extension. Only wav and mp3 are allowed

Invalid file extension

ERROR_CORE

File content is empty.

Empty FILE_CONTENT

ERROR_CORE

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

FILE_CONTENT was not provided in Base64 format

ERROR_CORE

Server returns HTTP error code

HTTP error when uploading the record via RECORD_URL

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

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

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning