crm.lead.details.configuration.get
Получить параметры карточки
Описание
Метод crm.lead.details.configuration.get получает настройки карточки лидов.
Настройки карточки повторных лидов могут отличаться от настроек карточки простых лидов. Для переключения между настройками карточек лидов используйте параметр lead.customer.type в extras.
Параметры
userId
user
необязательный
Идентификатор пользователя, для которого нужно получить личную конфигурацию.
Если параметр не передан, будет использован userId пользователя, который вызывает метод.
Нужен только при запросе личных настроек
scope
string
необязательный
Область применения настроек. Возможные значения:
- 'P' - личные настройки
- 'C' - общие настройки
По умолчанию используется значение 'P'
extras
object
необязательный
Дополнительные параметры. Структура описана ниже
Параметр extras
lead.customer.type
integer
необязательный
Тип лида. Возможные значения:
- 1 - простой лид
- 2 - повторный лид
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"scope":"P","userId":1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.details.configuration.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"scope":"P","userId":1,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.lead.details.configuration.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
type CrmLeadCardSectionElement = {
name: string
optionFlags: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type CrmLeadCardSection = {
name: string
title: string
type: string
elements: CrmLeadCardSectionElement[]
}
try {
const response = await $b24.actions.v2.call.make<CrmLeadCardSection[] | null>({
method: 'crm.lead.details.configuration.get',
params: {
scope: 'P',
userId: 1,
},
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('Card sections:', 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 getLeadCardConfiguration() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.lead.details.configuration.get',
params: {
scope: 'P',
userId: 1,
},
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('Card sections:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getLeadCardConfiguration)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.lead.details.configuration.get(
scope="P",
user_id=1,
extras={"leadCustomerType": 2},
).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(
'crm.lead.details.configuration.get',
[
'scope' => 'P',
'userId' => 1
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'crm.lead.details.configuration.get',
{
scope: "P",
userId: 1,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.lead.details.configuration.get',
[
'scope' => 'P',
'userId' => 1
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.lead.details.configuration.get", b24.Params{
"scope": "P",
"userId": 1,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.lead.details.configuration.get: %w", err)
}
var items []struct {
Name string `json:"name"`
Title string `json:"title"`
Type string `json:"type"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.Name, it.Title)
}
Ответ
HTTP-статус: 200
{
"result": [
{
"name": "main",
"title": "О лиде",
"type": "section",
"elements": [
{
"name": "TITLE",
"optionFlags": "0"
},
{
"name": "STATUS_ID",
"optionFlags": "0"
},
{
"name": "SOURCE_ID",
"optionFlags": "0"
}
]
},
{
"name": "additional",
"title": "Дополнительно",
"type": "section",
"elements": [
{
"name": "ASSIGNED_BY_ID",
"optionFlags": "0"
},
{
"name": "COMMENTS",
"optionFlags": "0"
}
]
}
],
"time": {
"start": 1720624891.017344,
"finish": 1720624891.405621,
"duration": 0.3882770538330078,
"processing": 0.02097320556640625,
"date_start": "2024-07-10T17:21:31+02:00",
"date_finish": "2024-07-10T17:21:31+02:00",
"operating": 0
}
}
Возвращаемые данные
result
section[]
Корневой элемент ответа. Содержит конфигурацию разделов карточки лида. Возвращает null, если конфигурация не найдена
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
| Код | Описание | Значение |
|---|---|---|
| — | Access denied | Недостаточно прав для получения запрошенной конфигурации |

