app.option.set
Привязать данные к приложению
Описание
Метод app.option.set привязывает данные к приложению.
Параметры
options
array
обязательный
Массив, где ключ — название сохраняемого свойства, а значение — значение свойства.
Если передать значение с новым ключом, то метод его запишет, а если существующее — обновит
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"options": {
"data": "value",
"data2": "value2"
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/app.option.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"options": {
"data": "value",
"data2": "value2"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/app.option.set
// 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
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'app.option.set',
params: {
options: {
data: 'value',
data2: 'value2',
},
},
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('Options saved:', 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 setAppOption() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'app.option.set',
params: {
options: {
data: 'value',
data2: 'value2',
},
},
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('Options saved:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', setAppOption)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.app.option.set(
options={
"default_language": "en",
"notification_mode": "digest",
"timezone": "Europe/Berlin",
},
).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(
'app.option.set',
[
'options' => [
'data' => 'value',
'data2' => 'value2',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo $result->data();
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error setting app options: ' . $e->getMessage();
}
BX24.callMethod(
'app.option.set',
{
"options": {
"data": "value",
"data2": "value2",
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'app.option.set',
[
'options' => [
'data' => 'value',
'data2' => 'value2'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "app.option.set", b24.Params{
"options": b24.Params{
"data": "value",
"data2": "value2",
},
})
if err != nil {
return fmt.Errorf("app.option.set: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1722001311.94644,
"finish": 1722001311.98622,
"duration": 0.0397801399230957,
"processing": 0.000041961669921875,
"date_start": "2024-07-26T13:41:51+00:00",
"date_finish": "2024-07-26T13:41:51+00:00",
"operating": 0
}
}
Возвращаемые данные
result
boolean
Возвращается true, если настройки сохранены
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":"ArgumentNullException",
"error_description":"options is empty"
}
| Код | Описание | Значение |
|---|---|---|
ArgumentNullException |
options is empty | Пустой массив options |
AccessException |
Application context required | Метод вызван вне контекста приложения |
AccessException |
Administrator authorization required | У текущего пользователя нет прав администратора |

