...
Поле | Тип | Обязательное | Комментарий |
|---|---|---|---|
id | String | да | Идентификатор клиента в CRM (Master ID) |
| contract | String | данет | Номер генерального соглашения, соглашений может быть несколько, передавать через запятую |
| telSysClientId | String | нет | Идентификатор клиента в системе телефонии |
name | String | да | ФИО клиента |
surname | String | да | Фамилия |
firstname | String | да | Имя |
patronymic | String | данет | Отчество |
type | String ("0", "1") | да | Код типа клиента (физическое лицо \ юридическое лицо). |
enabled | Boolean | да | Обслуживание клиента разрешено |
birthDate | String ("YYYY-MM-DD") | нет | Дата рождения |
extRef | String | нет | Идентификатор клиента в АБС |
cardRef | String | нет | Идентификатор клиента в карточный системе (ДКБО ID) |
bankBranch | Branch | нет | Информация о подразделении клиента |
crmURL | String | нет | Deprecated, нужно использовать ActionList Полная ссылка, по которой клиента можно открыть в CRM. |
| ActionList | List<ActionList> | нет | Список кнопок-ссылок в формате: name - value |
inn | String | нет | ИНН клиента. |
shortName | String | нет | Краткое наименование клиента. |
| accountNumbers | String | нет | Номера счета клиента. Данное поле не сохраняется в карточке клиента и храниться только в рамках открытого обращения |
| positionStream | Boolean | нет | Новый портфель, значение для PositionStream (true/false) |
| betaUser | Boolean | нет | Флаг "бета пользователь" (true/false) |
| lvlClient | String | нет | Сервисный уровень клиента, приоритет обслуживания |
| timezone | String | нет | Часовой пояс на устройстве клиента |
| osVersion | String | нет | Версия ОС устройства |
| device | String | нет | Тип устройства |
| deviceVersion | String | нет | Версия приложения |
fields | Map<String, String> | нет | Deprecated, нужно использовать fieldList Поля с дополнительной информацией о клиенте в виде название поле → значение. |
fieldList | List<Field> | нет | Поля с дополнительной информацией о клиенте, при отображении в интерфейсе оператора учитывается порядок полей. |
| contacts | Contacts | нет | Информация о контактах клиента для информирования оператора и выстраивания омниканальных связей |
| secretWord | String | нет | Кодовое слово, которое операторы или бот используют для ручной идентификации клиента |
| group | List<Group> | нет | Информация о группах клиентов для версии iQPro. |
...
Поле | Тип | Обязательное | Комментарий |
|---|---|---|---|
id | Integer | да | Идентификатор организации во внешней системе |
name | String | нет | Наименование организации |
type | String | нет | Код типа организации |
enabled | Boolean | нет | Обслуживание организации разрешено |
extRef | String | нет | Код организации в главной учетной системе (например АБС) |
inn | String | нет | ИНН |
kpp | String | нет | КПП |
resident | Boolean | нет | Признак "Нерезидент" |
phone | String | нет | Телефоны |
shortName | String | нет | Сокращенное наименование |
internationalName | String | нет | Международное наименование |
ogrn | String | нет | ОГРН |
ogrnDate | String ("YYYY-MM-DD") | нет | Дата ОГРН |
internationalAddress | String | нет | Полный международный адрес компании |
Field
Поле с дополнительной информацией о клиенте.
...
| Поле | Тип | Обязательное | Комментарий |
|---|---|---|---|
| id | Long | да | Идентификатор группы во внешней системе |
| parentGroup | Group | нет | Информация о родительской группе в случае древовидной структуры |
| name | String | нет | Наименование группы. Если не задано, можно указать вручную в iQChannels |
| description | String | нет | Описание группы |
| priority | Long | нет | Приоритет обращений от клиентов в данной группе по умолчанию |
ActionList
Группа кнопок \ ссылок.
| Поле | Тип | Обязательное | Комментарий |
|---|---|---|---|
| name | String | нет | Название/текст кнопки \ ссылки. Если не указано, то по умолчанию заполняется как “Открыть в CRM” |
| type | Integer | нет | Тип элемента (ссылка \ кнопка). Допустимые значения:
|
| value | String | да | Значение поля - URL ссылка, куда будет вести кнопка \ ссылка |
Примеры ответов
Успешный ответ
...
| Code Block | ||
|---|---|---|
| ||
{
"errorCode": "1001",
"errorText": "Client not found"
} |
Частные реализации
| Page Tree | ||
|---|---|---|
|
Изменения
Версия 1.1
- В типе Client добавлено поле shortName.
- В типе Client добавлено поле fieldList.
- Добавлен тип Field.
...
- Добавлена возможность использовать протокол AUTH с методом POST.
- В типе Client добавлено поле accountNumbers.
- В типе Client добавлено поле positionStream.
- В типе Client добавлено поле betaUser.
В типе Client добавлено поле lvlClient.
- В типе Client добавлено поле timezone.
- В типе Client добавлено поле osVersion.
- В типе Client добавлено поле device.
- В типе Client добавлено поле deviceVersion.
Версия 1.4
- В типе Client добавлено поле actionList.
- Добавлен тип ActionList.