# Создание и управление пользовательскими полями при интеграции по API

Пользовательские поля - это поля с дополнительными данными о коммуникациях, которые вы можете передавать из интегрируемой системы по API в систему dealapp для более комплексного анализа коммуникаций. Например, CSAT, NPS, CS, тематику сообщений, статус клиента, город, этап воронки и др. данные, которые фиксируются в сторонних системах.

#### Как подготовить передачу дополнительной информации?

Блок создания пользовательских полей находится на странице API интеграций, в личном кабинете администратора. Создать поля можно как во время настройки интеграции, так и позже, перейдя в уже созданную интеграцию. Нажмите кнопку "Добавить поле", чтобы создать новое пользовательское поле.

Пример добавления пользовательского поля

[О том как создать интеграцию по API рассказано в инструкции](/qolio-or-baza-znanii/integracii/podklyuchenie-po-api/integraciya-po-api-dlya-ip-telefonii-i-chatov.md)

#### Как настроить пользовательское поле?

В редакторе пользовательского поля, которое открывается после нажатия на кнопку расположены следующие поля:

* Название поля - текстовое название данных, которе будет отображаться в интерфейсе dealapp;
* Ключ поля - уникальный идентификатор поля, присвоенное значение которому будет сохраняться как дополнительная информация о коммуникации.
* Тип поля - диапазон значений, которое может принимать пользовательское поле: enum, строка, число, массив строк, массив чисел, дата и время, булевское значение (true/false). Значение поля должно соответствовать его типу, в противном случае, при отправке поля вместе с коммуникацией, дополнительная информация может не сохраниться.

Также в в редакторе есть два чек-бокса:

* "Используется для фильтрации" - позволяет скрыть или отобразить пользовательское поле на странице "Список коммуникаций" в блоке фильтров "Дополнительная информация", тем самым позволяя производить поиск коммуникаций по пользовательскому полю.
* "Используется для оценки" - позволяет скрыть или отобразить пользовательское поле во всплывающем окне "Дополнительная информация" на странице оценки коммуникации.

#### Как отправить поле?

При отправке коммуникации в dealapp, в body запроса необходимо добавить объект с ключем "custom\_fields", поместив в него информацию о полях, которые вы хотите передать.

Пример body для поле city: string

```
{
"operator_id": "c74e2260-994c-4f6e-8b8c-0e139ef85506",
"started_at": "2021-06-08T09:36:38.090Z",
"client": {
"id": "client@email.com",
"company_name": "Test Company",
"first_name": "John",
"last_name": "Doe"
},
"uid": "test-communication-kpnup67l",
"client_phone_number": "+375332222453",
"direction": "incoming",
"duration": 410.1,
"media_url": "https://demo-records.s3.eu-central-1.amazonaws.com/News_Room_News.mp3",
"communication_id": "test-communication-kpnup67l",
"custom_fields": {
"city": "Minsk"
}
}
```

#### Отображение поля во время оценки коммуникации

Проверить, что пользовательское поле прикрепилось к созданной коммуникации, можно открыв коммуникацию и нажав на кнопку "Дополнительная информация". Для того чтобы поле отображалось во всплывающем окне, надо установить чек-бокс "Используется для оценок" при создании пользовательского поля.

#### Поиск коммуникаций по пользовательском полю

При создании пользовательского поля установите чек-бокс "Используется для фильтрации", тогда на странице "Список коммуникаций" в блоке фильтров появится в блок с дополнительной информацией из пользовательских полей.

После установки значения поиска нажмите кнопку "Применить фильтры" - система выведет спсисок коммуникаций, соответсвующих установленному фильтру.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wiki.qolio.ru/qolio-or-baza-znanii/integracii/podklyuchenie-po-api/sozdanie-i-upravlenie-polzovatelskimi-polyami-pri-integracii-po-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.