Get Call Follow-up call.followup.get
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
callWho can execute the method: a user with access to the call
The method belongs to REST 3.0. Calling features and the response format of the new API version are described in the REST 3.0 Overview.
The call.followup.get method returns the follow-up of a single call by its identifier.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
callId* |
Call identifier. The identifier can be obtained using the call.followup.list method |
|
select |
A list of fields and nested paths to be returned in the response. If the parameter is not provided, the method returns all fields from the Root object section. Missing data is set to If an empty array is provided, the method returns only basic metadata: If a list of fields is provided, the method returns only the listed fields and always adds |
|
mentionFormat |
Format for user mentions in AI text fields. Possible values:
Default: |
Code Examples
How to Use Examples in Documentation
Calling the new API differs by adding the /api/ parameter to the request:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/call.followup.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"callId":12345,"mentionFormat":"html"}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/call.followup.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"callId":12345,"mentionFormat":"html","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/call.followup.get
// 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 FollowUpGetResult = {
item: {
callId: number
callType?: number
initiatorId?: number
startDate?: string
endDate?: string
durationSeconds?: number
uuid?: string
language?: string
version?: number
participants?: unknown[]
outcomes?: string[]
createdAt?: string
tracks?: unknown[]
transcription?: unknown
overview?: unknown
summary?: unknown
insights?: unknown
evaluation?: unknown
}
}
try {
const response = await $b24.actions.v3.call.make<FollowUpGetResult>({
method: 'call.followup.get',
params: {
callId: 12345,
mentionFormat: 'html',
},
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(result.item)
}
} 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 getFollowUp() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'call.followup.get',
params: {
callId: 12345,
mentionFormat: 'html',
},
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(result.item)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getFollowUp)
</script>
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'call.followup.get',
[
'callId' => 12345,
'mentionFormat' => 'html',
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'call.followup.get',
{
callId: 12345,
mentionFormat: 'html'
},
function(result) {
console.info(result.data());
console.log(result);
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'call.followup.get',
[
'callId' => 12345,
'mentionFormat' => 'html',
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"item": {
"callId": 12345,
"callType": 1,
"initiatorId": 7,
"startDate": "2026-01-15T10:00:00+00:00",
"endDate": "2026-01-15T10:42:00+00:00",
"durationSeconds": 2520,
"uuid": "bb085e5d-5160-4a63-9ac4-152248046c39",
"language": "de",
"version": 3,
"participants": [ /* ParticipantDto */ ],
"outcomes": ["transcription", "overview", "summary", "insights", "evaluation"],
"createdAt": "2026-01-15T11:05:00+00:00",
"tracks": [ /* TrackDto */ ],
"transcription": { "language": "de", "segments": [ /* TranscriptionSegmentDto */ ] },
"overview": { "topic": "Sprint Planning", "actionItems": [ /* ... */ ] },
"summary": { "segments": [ /* SummarySegmentDto */ ] },
"insights": { "speakerEvaluationAvailable": true, "speakerAnalysis": [ /* ... */ ] },
"evaluation": { "efficiencyValue": 75, "criteria": { /* ... */ } }
}
},
"time": {
"start": 1784017027,
"finish": 1784017027.356922,
"duration": 0.356921911239624,
"processing": 0,
"date_start": "2026-07-14T11:17:07+03:00",
"date_finish": "2026-07-14T11:17:07+03:00",
"operating_reset_at": 1784017627,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with response data |
|
item |
Follow-up object. The field composition depends on |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 403
{
"error": {
"code": "access_denied",
"message": "No access to Follow-up data"
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Access Errors
Error Code: BITRIX_REST_V3_EXCEPTION_INSUFFICIENTSCOPEEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Insufficient access rights: required scope is missing |
Check that the application or webhook has the |
Error Code: access_denied
|
Field |
Error description |
How to Fix |
|
|
No access to Follow-up data |
Check that the user has access to the call or is part of the associated chat |
Data Not Found Errors
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Call not found |
Provide an existing call identifier. For a user without rights to the call, the method will return an access error |
Errors in the select Parameter
Error Code: invalid_select_field
|
Field |
Error description |
How to Fix |
|
|
Invalid field in |
Provide a field from the list of available values |
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
A required parameter was not provided or an incorrect type was provided |
Provide |
|
|
The provided value is not from the list of allowed formats |
Provide |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |