Call Follow-up in REST 3.0: Methods Overview

CoPilot Follow-Up is an AI assistant for Bitrix24 video calls. After a call ends, it analyzes the meeting, identifies key topics, and generates materials to help the team record the outcome.

The following may be available in a Follow-up:

• Call summary
• Agreements
• Recommendations and efficiency rating
• Summary and meeting transcript

Quick navigation: All Methods

User documentation: CoPilot Follow-Up: AI Speech Analytics for Video Calls

When to Use Each MethodWhen to Use Each Method

Use call.followup.list when you need to retrieve a list of Follow-ups for a specific period, filter calls by attendee, or paginate through the results.

Use call.followup.get when you need to retrieve the Follow-up for a single call using the callId identifier.

Use call.followup.field.list and call.followup.field.get when you need to retrieve a list of available Follow-up fields or the description of a specific field for select configuration.

Workflow for Call Follow-upsWorkflow for Call Follow-ups

1. Retrieve a list of Follow-ups for the required period via call.followup.list
2. Take the callId from the list result
3. Retrieve the full call Follow-up via call.followup.get
4. Configure select to retrieve only the required fields and AI blocks
5. If necessary, clarify the field structure via *.field.list and *.field.get

Data AccessData Access

A standard User receives Follow-ups for calls they participated in or for which they are part of a linked chat. An Administrator has access to all Follow-ups.

The call scope grants the application access to the methods but does not expand data visibility. The method still verifies the access rights of the User on whose behalf the request is being executed.

Field SelectionField Selection

The select parameter controls the composition of the response. You can request root Follow-up fields, an entire AI block, or a specific subfield using dot notation.

See the Call Follow-up Fields article for a complete list of fields and nested objects.

Connection with Other ObjectsConnection with Other Objects

Calls. The callId identifier links a Follow-up to a specific call. You can retrieve the callId from call.followup.list, then pass it to call.followup.get.

Chats. Access to a Follow-up depends not only on participation in the call but also on the User's participation in the linked chat. If a User did not participate in the call and is not part of the chat, the method will return an access error.

Users. The call attendees are returned in the participants field. You can map Follow-ups to Employees and their meeting participation using User identifiers.

Overview of MethodsOverview of Methods

Scope: call

Who can execute the method: depends on the method

Method	Description
call.followup.list	Returns a list of Follow-up calls for a period
call.followup.get	Returns the Follow-up of a single call
call.followup.field.list	Returns a list of Follow-up fields
call.followup.field.get	Returns the description of a Follow-up field by name

Continue LearningContinue Learning

• Get a List of Follow-up Calls call.followup.list
• Get Call Follow-up call.followup.get
• Call Follow-up Fields
• Get Follow-up Fields List call.followup.field.list
• Get Follow-up Field Description call.followup.field.get
• Overview of REST API 3.0