call.followup.field.list — метод REST API Битрикс24

Описание

Метод относится к 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 — тип элемента для составных полей

Примеры запроса

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>

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();
}

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

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`"
    }
}

Код	Описание	Значение
`Поле`	Описание ошибки	Как исправить
—	Недостаточно прав доступа: отсутствует необходимый scope	Проверьте, что у приложения или вебхука есть scope `call`