methods
Получить список доступных методов
Описание
Метод methods получает список доступных методов.
Параметры
full
boolean
необязательный
Если параметр принимает значение true, то метод вернет список всех методов
scope
string
необязательный
Показ методов, входящих в указанное разрешение. Если задан параметр без значения (methods?scope=&auth=xxxxx), то будут выведены все общие методы.
Примеры запроса
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
// 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<string[]>({
method: 'methods',
params: {
scope: 'user',
},
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.length, 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 fetchMethods() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'methods',
params: {
scope: 'user',
},
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.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchMethods)
</script>
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
array
Массив с именами доступных методов
time
time
Информация о времени выполнения запроса

