Получить структуру лида
Получает структуру с описанием полей для создания лида
Функция ПолучитьСтруктуруЛида(Знач URL, Знач Токен = "") Экспорт
Параметр | CLI опция | Тип | Обяз. | Назначение |
---|---|---|---|---|
URL | --url | Строка | ✔ | URL внешнего вебхука или адрес Bitrix24 при использовании токена |
Токен | --token | Строка | ✖ | Токен авторизации, если используется не вебхук |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24
подсказка
Метод в документации API: crm.lead.fields
Пример использования для 1С:Предприятие/OneScript
URL = "https://b24-ar17wx.bitrix24.by/rest/1/yg2...";
Результат = OPI_Bitrix24.ПолучитьСтруктуруЛида(URL);
URL = "b24-ar17wx.bitrix24.by";
Токен = "48573267006e9f06006b12e400000001000...";
Результат = OPI_Bitrix24.ПолучитьСтруктуруЛида(URL, Токен);
- Bash
- CMD/Bat
oint bitrix24 ПолучитьСтруктуруЛида \
--url "b24-ar17wx.bitrix24.by" \
--token "***"
oint bitrix24 ПолучитьСтруктуруЛида ^
--url "b24-ar17wx.bitrix24.by" ^
--token "***"
Результат
{
"result": {
"ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID"
},
"TITLE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Название лида"
},
"HONORIFIC": {
"type": "crm_status",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"statusType": "HONORIFIC",
"title": "Обращение"
},
"NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Имя"
},
"SECOND_NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Отчество"
},
"LAST_NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Фамилия"
},
"BIRTHDATE": {
"type": "date",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Дата рождения"
},
"COMPANY_TITLE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Название компании"
},
"SOURCE_ID": {
"type": "crm_status",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"statusType": "SOURCE",
"title": "Источник"
},
"SOURCE_DESCRIPTION": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Дополнительно об источнике"
},
"STATUS_ID": {
"type": "crm_status",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"statusType": "STATUS",
"title": "Стадия"
},
"STATUS_DESCRIPTION": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Дополнительно о стадии"
},
"STATUS_SEMANTIC_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Состояние статуса"
},
"POST": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Должность"
},
"ADDRESS": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Адрес"
},
"ADDRESS_2": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Адрес (стр. 2)"
},
"ADDRESS_CITY": {
...