Получить описание поля Follow-up call.followup.field.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
callКто может выполнять метод: любой пользователь
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод call.followup.field.get возвращает описание поля Follow-up по имени.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Имя поля Follow-up, описание которого нужно получить. Доступные поля можно получить методом call.followup.field.list |
|
select |
Список полей описания, которые нужно вернуть в ответе. Доступные поля:
|
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/call.followup.field.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"callId","select":["name","type","title","description","filterable","sortable","multiple"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/call.followup.field.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"callId","select":["name","type","title","description","filterable","sortable","multiple"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/call.followup.field.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 FollowUpFieldGetResult = {
item: {
name: string
type: string
title: string
description: string | null
filterable: boolean
sortable: boolean
multiple: boolean
}
}
try {
const response = await $b24.actions.v3.call.make<FollowUpFieldGetResult>({
method: 'call.followup.field.get',
params: {
name: 'callId',
select: ['name', 'type', 'title', 'description', 'filterable', 'sortable', 'multiple'],
},
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.name, result.item.type, result.item.title)
}
} 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 getFollowUpField() {
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.get',
params: {
name: 'callId',
select: ['name', 'type', 'title', 'description', 'filterable', 'sortable', 'multiple'],
},
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.name, result.item.type, result.item.title)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getFollowUpField)
</script>
SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.
try {
$response = $b24Service
->core
->call(
'call.followup.field.get',
[
'name' => 'callId',
'select' => ['name', 'type', 'title', 'description', 'filterable', 'sortable', 'multiple']
]
);
$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.get',
{
name: 'callId',
select: ['name', 'type', 'title', 'description', 'filterable', 'sortable', 'multiple']
},
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.get',
[
'name' => 'callId',
'select' => ['name', 'type', 'title', 'description', 'filterable', 'sortable', 'multiple']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "call.followup.field.get", b24.Params{
"name": "callId",
"select": []string{"name", "type", "title", "description", "filterable", "sortable", "multiple"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("call.followup.field.get: %w", err)
}
// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("в ответе нет ключа item")
}
var item struct {
Name string `json:"name"`
Type string `json:"type"`
Title string `json:"title"`
Description string `json:"description"`
Filterable bool `json:"filterable"`
Sortable bool `json:"sortable"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Name, item.Type)
Обработка ответа
HTTP-статус: 200
{
"result": {
"item": {
"name": "callId",
"type": "int",
"title": "callId",
"description": "Bitrix24 call identifier (b_call.ID). Always present.",
"filterable": false,
"sortable": false,
"multiple": false
}
},
"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 |
Объект с данными ответа |
|
item |
Объект с описанием поля. Структура ответа зависит от |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта запроса",
"validation": [
{
"field": "name",
"message": "Обязательное поле `name` не указано"
}
]
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_INSUFFICIENTSCOPEEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Недостаточно прав доступа: отсутствует необходимый scope |
Проверьте, что у приложения или вебхука есть scope |
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
Проверьте права пользователя и scope |
Ошибки нахождения данных
Код ошибки: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Поле |
Передайте существующее имя поля. Список полей можно получить методом call.followup.field.list |
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Обязательное поле |
Передайте параметр |
Ошибки в параметре select
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Передайте только поля описания: |
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать выражение select |
Передайте |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |