Получить список доступных методов methods
Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.
Scope:
базовыйКто может выполнять метод: любой пользователь
Метод methods получает список доступных методов.
DEPRECATED
Развитие метода остановлено. Используйте method.get.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
full |
Если параметр принимает значение |
|
scope |
Показ методов, входящих в указанное разрешение. Если задан параметр без значения ( |
Если метод вызван без параметров, то он вернет список всех методов, доступных текущему приложению.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"scope": "user"
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/methods
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"scope": "user",
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/methods
try
{
const response = await $b24.callMethod(
"methods",
{
"scope": "user"
}
);
const result = response.getData().result;
console.log(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'methods',
[
'scope' => 'user',
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error calling method: ' . $e->getMessage();
}
BX24.callMethod(
"methods",
{
"scope": "user"
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'methods',
[
'scope' => 'user'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": [
"user.fields",
"user.current",
"user.get",
"user.search",
"user.add",
"user.update",
"user.online",
"user.counters",
"user.history.list",
"user.history.fields.list"
],
"time": {
"start": 1721986432.32646,
"finish": 1721986432.3598,
"duration": 0.0333478450775147,
"processing": 0.000032901763916015,
"date_start": "2024-07-26T09:33:52+00:00",
"date_finish": "2024-07-26T09:33:52+00:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Массив со списком разрешений |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить список доступных методов method.get
- Получить список доступных разрешений scope
- Показать информацию о приложении app.info
- Получить названия прав доступа access.name
- Получить информацию о доступности функционала на портале feature.get
- Получить текущее время сервера server.time