Получить названия прав доступа access.name
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
базовыйКто может выполнять метод: любой пользователь
Метод access.name получает названия прав доступа.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
ACCESS* |
Список кодов доступа, названия для которых нужно получить. Форматы кодов:
Если параметр не передан или пуст, метод вернет |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"ACCESS": ["G2", "AU"]
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/access.name
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"ACCESS": ["G2", "AU"],
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/access.name
// 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 AccessNameItem = {
provider: string
name: string
provider_id: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type AccessNameResult = Record<string, AccessNameItem>
try {
const response = await $b24.actions.v2.call.make<AccessNameResult>({
method: 'access.name',
params: {
ACCESS: ['G2', 'AU'],
},
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(Object.keys(result), result)
}
} 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 getAccessNames() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'access.name',
params: {
ACCESS: ['G2', 'AU'],
},
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(Object.keys(result), result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getAccessNames)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.access.name(
access=[
"G2",
"AU",
],
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'access.name',
[
'ACCESS' => ['G2', 'AU']
]
);
$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 access.name: ' . $e->getMessage();
}
BX24.callMethod(
"access.name",
{
"ACCESS": ["G2", "AU"]
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'access.name',
[
'ACCESS' => ['G2','AU']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "access.name", b24.Params{
"ACCESS": []string{"G2", "AU"},
})
if err != nil {
return fmt.Errorf("access.name: %w", err)
}
keys, ok := b24.Keys(res.Result)
if !ok {
return fmt.Errorf("ожидался объект в ответе")
}
fmt.Println("полей в ответе:", len(keys))
Обработка ответа
HTTP-статус: 200
{
"result": {
"G2": {
"provider": "",
"name": "Все посетители",
"provider_id": "other"
},
"AU": {
"provider": "",
"name": "Все авторизованные пользователи",
"provider_id": "other"
}
},
"time": {
"start": 1722002504.2838,
"finish": 1722002504.32483,
"duration": 0.0410301685333252,
"processing": 0.00145506858825684,
"date_start": "2024-07-26T14:01:44+00:00",
"date_finish": "2024-07-26T14:01:44+00:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
Объект, где ключ это код доступа из параметра Структура описана ниже. Если параметр |
|
|
time |
Информация о времени выполнения запроса |
Описание кода доступа
|
Название |
Описание |
|
name |
Название кода доступа на языке Битрикс24, например |
|
provider |
Название поставщика кода доступа. Для кодов |
|
provider_id |
Идентификатор поставщика кода доступа, например |
Коды, которых нет в Битрикс24, в ответе не возвращаются.
Обработка ошибок
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |