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

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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
            const response = await $b24.callMethod(
                'telephony.externalCall.attachRecord',
                {
                    CALL_ID: 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
                    FILENAME: 'call-001.mp3',
                    FILE_CONTENT: 'SUQzAwAAAAAiVVRJVDI...AAAAAAAAAAAAP8='
                }
            );
            
            const result = response.getData().result;
            console.log('Record attached:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('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>';

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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

End Call

Add Transcription of Recording to Call

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

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

If both FILENAME and FILE_CONTENT are providedIf both FILENAME and FILE_CONTENT are provided

If FILENAME is provided without FILE_CONTENTIf FILENAME is provided without FILE_CONTENT

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning