Получить список полей Follow-up call.followup.field.list

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

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

Scope: call

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

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод call.followup.field.list возвращает список доступных полей Follow-up.

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

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

Название
тип

Описание

select
array

Список полей описания, которые нужно вернуть в ответе.

Доступные поля:

  • name — имя поля
  • type — тип данных
  • title — заголовок
  • description — описание
  • validationRules — правила валидации
  • requiredGroups — группы обязательности
  • filterable — признак доступности в фильтре
  • sortable — признак доступности в сортировке
  • editable — признак редактируемости
  • multiple — признак множественного значения
  • elementType — тип элемента для составных полей

Примеры кода

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

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/call.followup.field.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["name","type","description"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/call.followup.field.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["name","type","description"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/call.followup.field.list

// 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

type FollowUpFieldItem = {
  name: string
  type: string
  description: string | null
}

// Shape of the payload returned in result (match the "response handling" section of the page)
type FollowUpFieldListResult = {
  items: FollowUpFieldItem[]
}

try {
  const response = await $b24.actions.v3.call.make<FollowUpFieldListResult>({
    method: 'call.followup.field.list',
    params: {
      select: ['name', 'type', 'description'],
    },
    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('Fields count:', result.items.length, 'Fields:', result.items)
  }
} 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 getFollowUpFieldList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'call.followup.field.list',
        params: {
          select: ['name', 'type', 'description'],
        },
        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('Fields count:', result.items.length, 'Fields:', result.items)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getFollowUpFieldList)
</script>

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'call.followup.field.list',
            [
                'select' => ['name', 'type', 'description']
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

BX24.callMethod(
    'call.followup.field.list',
    {
        select: ['name', 'type', 'description']
    },
    function(result) {
        console.info(result.data());
        console.log(result);
    }
);

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

require_once('crest.php');

$result = CRest::call(
    'call.followup.field.list',
    [
        'select' => ['name', 'type', 'description']
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "call.followup.field.list", b24.Params{
	"select": []string{"name", "type", "description"},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("call.followup.field.list: %w", err)
}

// Метод заворачивает ответ в объект с ключом "items".
raw, ok := b24.Unwrap(res.Result, "items")
if !ok {
	return fmt.Errorf("в ответе нет ключа items")
}

var items []struct {
	Name        string `json:"name"`
	Type        string `json:"type"`
	Description string `json:"description"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.Name)
}

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

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "name": "callId",
                "type": "int",
                "description": "Bitrix24 call identifier (b_call.ID). Always present."
            },
            {
                "name": "callType",
                "type": "int",
                "description": "Call type: 1 = instant ad-hoc, 2 = permanent conference room, 3 = large room."
            },
            {
                "name": "initiatorId",
                "type": "int",
                "description": "User id of who initiated the call."
            },
            {
                "name": "startDate",
                "type": "string",
                "description": "ISO 8601 UTC timestamp when the call started."
            },
            {
                "name": "endDate",
                "type": "string",
                "description": "ISO 8601 UTC timestamp when the call ended. Null while the call is still in progress."
            },
            {
                "name": "durationSeconds",
                "type": "int",
                "description": "Total call duration in seconds (endDate - startDate)."
            },
            {
                "name": "uuid",
                "type": "string",
                "description": "Opaque UUID of the call session. Opt-in: list this in `select` to receive it."
            },
            {
                "name": "language",
                "type": "string",
                "description": "Detected transcription language (BCP-47 / ISO 639-1, for example ru or en). Null when there is no transcription."
            },
            {
                "name": "version",
                "type": "int",
                "description": "Maximum schema version across all stored outcome blocks for this call."
            },
            {
                "name": "participants",
                "type": "array",
                "description": "Call participants, enriched with display data from user profiles."
            },
            {
                "name": "outcomes",
                "type": "array",
                "description": "Names of outcome blocks present for this call: transcription, overview, summary, insights, evaluation."
            },
            {
                "name": "createdAt",
                "type": "string",
                "description": "ISO 8601 UTC timestamp of the most recently stored outcome record for this call."
            },
            {
                "name": "tracks",
                "type": "array",
                "description": "Call recordings / tracks with download URLs. Opt-in via `select`."
            },
            {
                "name": "transcription",
                "type": "object",
                "description": "Time-ordered transcription of the call with per-segment speaker attribution."
            },
            {
                "name": "overview",
                "type": "object",
                "description": "AI overview of the meeting: topic, agenda, agreements, action items, takeaways."
            },
            {
                "name": "summary",
                "type": "object",
                "description": "Segmented summary of the call by topic chunks."
            },
            {
                "name": "insights",
                "type": "object",
                "description": "AI insights: per-speaker analysis (CIS only), meeting strengths/weaknesses, recommendations."
            },
            {
                "name": "evaluation",
                "type": "object",
                "description": "Meeting efficiency evaluation: overall score and individual evaluation 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
    }
}

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

Название
тип

Описание

result
object

Объект с данными ответа

items
array

Массив объектов с описанием полей. Структура ответа зависит от select

time
time

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

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION",
        "message": "Неизвестное поле `unknownField` для объекта `DtoFieldDto`"
    }
}

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

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

Ошибки доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_INSUFFICIENTSCOPEEXCEPTION

Поле

Описание ошибки

Как исправить

-

Недостаточно прав доступа: отсутствует необходимый scope

Проверьте, что у приложения или вебхука есть scope call

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

Проверьте права пользователя и scope call

Ошибки в параметре select

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

select

Неизвестное поле #FIELD# для объекта DtoFieldDto

Передайте только поля описания: name, type, title, description, validationRules, requiredGroups, filterable, sortable, editable, multiple, elementType

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Поле

Описание ошибки

Как исправить

select

Не удается распознать выражение select #SELECT#

Передайте select как массив строк, например ["name","type"]

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Получить Follow-up по звонку
Следующая
Получить описание поля Follow-up