InterAction (предварительная версия)
LexisNexis InterAction+ — это комплексное решение CRM (управление отношениями с клиентами), разработанное специально для юридических фирм. Используйте этот соединитель для интеграции сторонних приложений с InterAction+ для автоматизации работы, оптимизации задач и укрепления отношений клиентов.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: - Azure для государственных организаций регионы - Azure регионы Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Взаимодействие |
| URL | https://www.lexisnexis.com/en-us/products/interaction/default.page |
| Адрес электронной почты | support@interaction.com |
| Метаданные соединителя | |
|---|---|
| Publisher | LexisNexis Legal и Professional |
| Website | https://www.lexisnexis.com/en-us/products/interaction/default.page |
| Политика конфиденциальности | https://www.lexisnexis.com/en-us/terms/privacy-policy.page |
| Категории | Маркетинг |
InterAction+
LexisNexis InterAction+ — это комплексное решение CRM (управление отношениями с клиентами), разработанное специально для юридических фирм. Используйте этот соединитель для интеграции сторонних приложений с InterAction+ для автоматизации работы, оптимизации задач и укрепления отношений клиентов.
Publisher: LexisNexis
Предпосылки
Для продолжения вам потребуется следующее:
- План Майкрософт PowerAutomate/Flow.
- Учетная запись с помощью InterAction+ с доступом администратора.
- URL-адрес приложения InterAction+ (например
https://example.apps.interaction.com, или https://us.apps.interaction.com/example) и регион (США, AU или ЕС). Чтобы узнать больше о InterAction+ и наших службах, свяжитесь с нами.support@interaction.com
Поддерживаемые операции
Соединитель поддерживает следующие операции:
-
Get Lists:Get All List from InterAction+, который включает в себя workingList, marketingList и marketingListWithSponsorship. -
Get List By Id:Получение сведений о списке по идентификатору списка в InterAction+. -
Get List By Name:Получение сведений о списке по имени списка в InterAction+. -
Get Additional Field Definitions And Values:Get Additional Field Definitions and Values of list from Interaction+. -
Add or Update Additional field values for Contact:Add or Update Additional field values for Contact in Interaction+. -
Get Contact By Id:Получить контактные данные по идентификатору в InterAction+. -
Create Person Contact:Create Person Contact in InterAction+. -
Update Person Contact:Обновите общедоступный контакт в InterAction+. -
Search Person Contact:Поиск контакта на основе имени, фамилии и фильтра адресов электронной почты в InterAction+. -
Add Contacts to Lists:Добавьте один или несколько контактов в один или несколько списков в InterAction+. Для нескольких контактов или списков переключение входного режима. -
Remove Contacts from List:Удалить контакты из списка в InterAction+. -
Create Activity:Create Activity in InterAction+. -
Update Activity:Edit or Update the Activity field value for Contact in Interaction+. -
Get List Contact Membership Changes:Это действие извлекает контакты, которые были добавлены или удалены из указанных списков в заданном диапазоне дат. Он предназначен для отслеживания изменений в списке контактов, помогая пользователям отслеживать обновления, синхронизировать данные или запускать подчиненные процессы на основе изменений. -
Get Created or Removed Lists:Это действие извлекает списки, созданные или удаленные в InterAction+ в заданном диапазоне дат. Он предназначен для записи разностных изменений для списков, помогая пользователям отслеживать обновления, синхронизировать данные или запускать подчиненные процессы на основе изменений. -
Get Created or Removed Contacts:Это действие извлекает контакты, созданные или удаленные в InterAction+ в заданном диапазоне дат. Он предназначен для отслеживания разностных изменений для контактов, помогая пользователям отслеживать обновления, синхронизировать данные или запускать подчиненные процессы на основе изменений. -
Get Updated Contacts:Это действие извлекает контакты, которые были обновлены в InterAction+ в заданном диапазоне дат. Он предназначен для отслеживания разностных изменений для контактов, помогая пользователям отслеживать обновления, синхронизировать данные или запускать подчиненные процессы на основе изменений. -
Add Matter:Add Matter in InterAction+. -
Remove Matter:Remove Matter from InterAction+. -
Add Matter Financials:Добавление финансовых данных для вопросов в данный период. -
Remove Matter Financials:Remove matter financials data from InterAction+.
Получение учетных данных
Запрос доступа путем обращения в службу поддержки InterAction+ (support@interaction.com)
Распространенные ошибки и средства устранения неполадок
Ниже приведены некоторые проблемы, с которыми можно столкнуться при использовании соединителя:
-
Error 400: отображается при выполнении плохого запроса, это означает, что вы неправильно введите параметры. -
Error 401: отображается при несанкционированном доступе к запрошенной информации. -
Error 429: ошибка слишком большого количества запросов, которая сообщает клиентскому приложению прекратить отправку запросов, так как они просто не имеют достаточно ресурсов, чтобы принять его в настоящее время.
Support
Чтобы получить дополнительную поддержку, обратитесь в службу поддержки. support@interaction.com
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| URL-адрес приложения | струна | URL-адрес приложения InterAction+ (например, ) https://us.apps.interaction.com/tpcqa | True |
| Регион | струна | Выберите регион | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Действие обновления |
Измените или обновите значение поля действия для contact in Interaction+. |
| Добавление или обновление дополнительных значений полей для контакта |
Добавление или обновление дополнительных значений полей для контакта в InterAction+. |
| Добавление контактов в списки |
Добавьте один или несколько контактов в один или несколько списков в InterAction+. Для нескольких контактов или списков переключение входного режима. |
| Добавление материи |
Добавление материи в InterAction+. |
| Добавление финансовых средств материи |
Добавьте финансовые данные для вопросов в данный период. |
| Контакт с пользователем поиска |
Поиск контакта с пользователем на основе имени, фамилии и адреса электронной почты. |
| Обновление контакта с пользователем |
Обновите контакт пользователя в InterAction+. |
| Получение дополнительных определений полей и значений |
Получение дополнительных определений полей и значений списка из InterAction+. |
| Получение изменений членства в списке контактов |
Это действие извлекает контакты, которые были добавлены или удалены из указанных списков в заданном диапазоне дат. Он предназначен для отслеживания изменений в списке контактов, помогая пользователям отслеживать обновления, синхронизировать данные или запускать подчиненные процессы на основе изменений. |
| Получение или удаление контактов |
Это действие извлекает контакты, созданные или удаленные в InterAction+ в заданном диапазоне дат. Он предназначен для отслеживания разностных изменений для контактов, помогая пользователям отслеживать обновления, синхронизировать данные или запускать подчиненные процессы на основе изменений. |
| Получение контакта по идентификатору |
Получение контакта по идентификатору вместе с дополнительными значениями полей в InterAction+. |
| Получение обновленных контактов |
Это действие извлекает контакты, которые были обновлены в InterAction+ в заданном диапазоне дат. Он предназначен для отслеживания разностных изменений для контактов, помогая пользователям отслеживать обновления, синхронизировать данные или запускать подчиненные процессы на основе изменений. |
| Получение созданных или удаленных списков |
Это действие извлекает списки, созданные или удаленные в InterAction+ в заданном диапазоне дат. Он предназначен для отслеживания разностных изменений для списков, помогая пользователям отслеживать обновления, синхронизировать данные или запускать подчиненные процессы на основе изменений. |
| Получение списка по идентификатору |
Получение списка по идентификатору в InterAction+. |
| Получение списка по имени |
Получение списка по имени в InterAction+. |
| Получение списков |
Получение списков из InterAction+ с рабочим списком, маркетинговым списком и маркетингомListWithSponsorship. |
| Создание действия |
Создание действия в InterAction+. |
| Создание контакта пользователя |
Создание контакта пользователя в InterAction+. |
| Удаление контактов из списка |
Удаление контактов из списка в InterAction+. |
| Удаление материи |
Удалите вопрос из InterAction+. |
| Удаление финансовых средств в отношении вопросов |
Удалите финансовые данные из InterAction+. |
Действие обновления
Измените или обновите значение поля действия для contact in Interaction+.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор действия
|
activityId | True | string |
Идентификатор действия принимает тип GUID 0000000000-0000-0000-0000-0000-000000000000. |
|
Тип действия
|
typeId | True | string |
Тип действия обновления. |
|
Дата действия
|
activityDate | string |
Дата действия в строковом формате. Он принимает формат datetime в ггГГ-MM-DD HH:mm:ss. |
|
|
Тема
|
subject | string |
Тема действия. |
|
|
Сводка
|
summary | string |
Сводка действия. |
|
|
Идентификаторы связанных сущностей
|
linkedEntityIds | True | array of string |
Идентификатор контакта, представляющий сущности, связанные с действием. Он принимает формат GUID 000000000-0000-0000-0000-0000000000000000. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
validationErrors
|
data.updateActivity.validationErrors | array of |
validationErrors |
|
id
|
data.updateActivity.item.id | string |
id |
|
type
|
data.updateActivity.item.type | string |
type |
|
TypeId
|
data.updateActivity.item.typeId | string |
TypeId |
|
activityClass
|
data.updateActivity.item.activityClass | string |
activityClass |
|
typeGroup
|
data.updateActivity.item.typeGroup | string |
typeGroup |
|
activityStartDate
|
data.updateActivity.item.activityStartDate | string |
activityStartDate |
|
lastEditedDate
|
data.updateActivity.item.lastEditedDate | string |
lastEditedDate |
|
субъект
|
data.updateActivity.item.subject | string |
субъект |
|
summary
|
data.updateActivity.item.summary | string |
summary |
|
location
|
data.updateActivity.item.location | string |
location |
|
относительно
|
data.updateActivity.item.regarding | string |
относительно |
Добавление или обновление дополнительных значений полей для контакта
Добавление или обновление дополнительных значений полей для контакта в InterAction+.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Контактный номер
|
contactId | True | string |
Идентификатор контакта для обновления. |
|
Идентификатор поля
|
fieldId | True | string |
Идентификатор поля дополнительного поля. |
|
Ценность
|
value | True | string |
Значение дополнительного поля. |
|
Идентификатор значения
|
valueId | string |
Идентификатор значения требуется только для обновления существующего значения. В случае нового значения оставьте это поле пустым. |
|
|
Дата последнего редактирования
|
lastEditDate | string |
Дата последнего изменения требуется только для обновления существующего значения. В случае нового значения оставьте это поле пустым. |
|
|
Тип данных поля
|
fieldDataType | True | string |
Тип данных дополнительного поля. Допустимые типы данных — целочисленные, текстовые, логические, десятичные, пользовательские, дата и список. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
models
|
data.updateListContactAdditionalFields.models | array of object |
models |
|
причина отказа
|
data.updateListContactAdditionalFields.models.failureReason | string |
причина отказа |
|
fieldId
|
data.updateListContactAdditionalFields.models.fieldId | string |
fieldId |
|
isSuccessful
|
data.updateListContactAdditionalFields.models.isSuccessful | boolean |
isSuccessful |
|
valueId
|
data.updateListContactAdditionalFields.models.valueId | string |
valueId |
|
__typename
|
data.updateListContactAdditionalFields.models.__typename | string |
__typename |
|
__typename
|
data.updateListContactAdditionalFields.__typename | string |
__typename |
Добавление контактов в списки
Добавьте один или несколько контактов в один или несколько списков в InterAction+. Для нескольких контактов или списков переключение входного режима.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификаторы списка
|
listIds | True | array of string |
Идентификатор списка для добавления контакта |
|
Идентификаторы контактов
|
contactIds | True | array of string |
Идентификатор контакта для добавления в список |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalCount
|
data.addContactsToLists.totalCount | integer |
totalCount |
|
successCount
|
data.addContactsToLists.successCount | integer |
successCount |
|
ResultText
|
data.addContactsToLists.resultText | string |
ResultText |
Добавление материи
Добавление материи в InterAction+.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя материи
|
matterName | True | string |
Имя вопроса. |
|
Ссылка внешней исходной системы
|
externalSourceSystemLink | string |
URL-адрес внешней исходной системы для этого вопроса. |
|
|
Исходная система
|
sourceSystem | True | string |
Исходная система для этого вопроса. |
|
Идентификатор клиента
|
clientId | True | string |
Идентификатор контакта клиента по этому вопросу. |
|
Первичный идентификатор контакта
|
primaryContactId | string |
Идентификатор основного контакта по этому вопросу. |
|
|
Идентификатор контакта партнера выставления счетов
|
billingPartnerContactId | True | string |
Идентификатор контакта партнера по выставлению счетов по этому вопросу. Контакт должен быть связан с активным пользователем. |
|
Идентификатор контакта адвоката по выставлению счетов
|
billingAttorneyContactId | string |
Идентификатор контакта адвоката по выставлению счетов по этому вопросу. Контакт должен быть связан с активным пользователем. |
|
|
Дата открытия
|
dateOpened | True | string |
Дата открытия вопроса. Формат YYYY-MM-DD. |
|
Дата закрыта
|
dateClosed | string |
Дата закрытия вопроса. Формат YYYY-MM-DD. |
|
|
Description
|
description | string |
Описание вопроса. |
|
|
Число материи
|
matterNumber | True | string |
Число вопросов для этого вопроса. |
|
Тип материи
|
matterType | string |
Тип вопроса. |
|
|
Номер клиента
|
clientNumber | string |
Номер клиента для этого вопроса. |
|
|
Результат
|
outcome | string |
Результат для этого вопроса. |
|
|
Описание результата
|
outcomeDescription | string |
Описание результата для этого вопроса. |
|
|
Соглашение о сборе
|
feeArrangement | string |
Плата за это дело. |
|
|
Оценочная сумма сборов
|
amount | integer |
Сумма по этому вопросу. |
|
|
Предполагаемая валюта сборов
|
currency | string |
Код валюты ISO для платы за этот вопрос. |
|
|
Сумма выставления счетов
|
amount | integer |
Сумма по этому вопросу. |
|
|
Плата за выставление счетов за валюту
|
currency | string |
Код валюты ISO для платы за этот вопрос. |
|
|
Сумма сбора сборов
|
amount | integer |
Сумма по этому вопросу. |
|
|
Сборная валюта
|
currency | string |
Код валюты ISO для платы за этот вопрос. |
|
|
Оплачиваемые часы
|
billableHours | float |
Оплачиваемые часы по этому вопросу. |
|
|
WorkTypes
|
workTypes | array of string |
Список рабочих типов для этого вопроса. |
|
|
Другие контакты, участвующие
|
otherContactsInvolved | array of string |
Список идентификаторов других контактов для этого вопроса. |
|
|
Другие участники группы
|
otherTeamMembers | array of string |
Список идентификаторов других контактов участников команды для маттера. Контакты должны быть связаны с активными пользователями. |
|
|
Отрасли
|
industries | array of string |
Список идентификаторов отраслей по этому вопросу. |
|
|
Группы практики
|
practiceGroups | array of string |
Список идентификаторов групп практики для этого вопроса. |
|
|
Идентификатор страны
|
countryId | string |
Идентификатор страны для расположения. |
|
|
Идентификатор состояния
|
stateId | string |
Идентификатор состояния расположения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки проверки
|
data.addMatter.validationErrors | array of |
Коллекция ошибок проверки, возникших во время операции. |
|
Идентификатор материи
|
data.addMatter.item | string |
Идентификатор созданного объекта. |
Добавление финансовых средств материи
Добавьте финансовые данные для вопросов в данный период.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Дата окончания периода
|
periodEndDate | True | string |
Дата окончания периода. Формат YYYY-MM-DD. |
|
Идентификатор клиента
|
clientId | True | string |
Идентификатор контакта клиента. |
|
Общее число вопросов
|
totalMatterCount | integer |
Общее количество вопросов. |
|
|
Число открытых вопросов
|
openMatterCount | integer |
Общее количество открытых вопросов. |
|
|
Число закрытых вопросов
|
closedMatterCount | integer |
Общее число закрытых вопросов. |
|
|
Оценочная сумма сборов
|
amount | integer |
Сумма по вопросу финансового сбора. |
|
|
Предполагаемая валюта сборов
|
currency | string |
Код валюты ISO для оплаты финансовых средств. |
|
|
Сумма выставления счетов
|
amount | integer |
Сумма по вопросу финансового сбора. |
|
|
Плата за выставление счетов за валюту
|
currency | string |
Код валюты ISO для оплаты финансовых средств. |
|
|
Сумма сбора сборов
|
amount | integer |
Сумма по вопросу финансового сбора. |
|
|
Сборная валюта
|
currency | string |
Код валюты ISO для оплаты финансовых средств. |
|
|
Сумма списания
|
amount | integer |
Сумма по вопросу финансового сбора. |
|
|
Валюта записи
|
currency | string |
Код валюты ISO для оплаты финансовых средств. |
|
|
Оплачиваемые часы
|
billableHours | float |
Общее количество оплачиваемых часов. |
|
|
Номер клиента
|
clientNumber | string |
Номер клиента. |
|
|
Идентификатор страны
|
countryId | string |
Идентификатор страны для расположения. |
|
|
Идентификатор состояния
|
stateId | string |
Идентификатор состояния расположения. |
|
|
Группы практики
|
practiceGroups | array of string |
Идентификатор связанной группы практики. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки проверки
|
data.AddMatterFinancials.validationErrors | array of |
Коллекция ошибок проверки, возникших во время операции. |
|
Идентификатор материальных финансовых средств
|
data.AddMatterFinancials.item | string |
Идентификатор созданного финансового вопроса. |
Контакт с пользователем поиска
Поиск контакта с пользователем на основе имени, фамилии и адреса электронной почты.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Поиск по адресу электронной почты
|
emailAddress | string |
Поиск контактов с пользователем с адресом электронной почты. |
|
|
Поиск по имени
|
firstName | string |
Поиск контактов с именем пользователя. |
|
|
Поиск по фамилии
|
lastName | string |
Поиск контактов с фамилией |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalModels
|
data.searchFirmContacts.totalModels | integer |
totalModels |
|
models
|
data.searchFirmContacts.models | array of object |
models |
|
contactId
|
data.searchFirmContacts.models.contactId | string |
contactId |
|
отображаемое имя
|
data.searchFirmContacts.models.displayName | string |
отображаемое имя |
|
contactEntity
|
data.searchFirmContacts.models.contactEntity | string |
contactEntity |
|
title
|
data.searchFirmContacts.models.title | string |
title |
|
Имя
|
data.searchFirmContacts.models.firstName | string |
Имя |
|
второе имя
|
data.searchFirmContacts.models.middleName | string |
второе имя |
|
lastName
|
data.searchFirmContacts.models.lastName | string |
lastName |
|
currentJobTitle
|
data.searchFirmContacts.models.currentJobTitle | string |
currentJobTitle |
|
companyName
|
data.searchFirmContacts.models.currentEmployer.companyName | string |
companyName |
|
companyId
|
data.searchFirmContacts.models.currentEmployer.companyId | string |
companyId |
|
addresses
|
data.searchFirmContacts.models.addresses | array of object |
addresses |
|
addressID
|
data.searchFirmContacts.models.addresses.addressID | string |
addressID |
|
улица
|
data.searchFirmContacts.models.addresses.street | string |
улица |
|
city
|
data.searchFirmContacts.models.addresses.city | string |
city |
|
administrativeDivision
|
data.searchFirmContacts.models.addresses.administrativeDivision | string |
administrativeDivision |
|
country
|
data.searchFirmContacts.models.addresses.country | string |
country |
|
postalCode
|
data.searchFirmContacts.models.addresses.postalCode | string |
postalCode |
|
type
|
data.searchFirmContacts.models.addresses.type | string |
type |
|
использование
|
data.searchFirmContacts.models.addresses.usage | string |
использование |
|
видимость
|
data.searchFirmContacts.models.visibility | string |
видимость |
|
emailАдреса
|
data.searchFirmContacts.models.emailAddresses | array of object |
emailАдреса |
|
emailId
|
data.searchFirmContacts.models.emailAddresses.emailId | string |
emailId |
|
type
|
data.searchFirmContacts.models.emailAddresses.type | string |
type |
|
использование
|
data.searchFirmContacts.models.emailAddresses.usage | string |
использование |
|
address
|
data.searchFirmContacts.models.emailAddresses.address | string |
address |
|
label
|
data.searchFirmContacts.models.emailAddresses.label | string |
label |
|
owningContactId
|
data.searchFirmContacts.models.emailAddresses.owningContactId | string |
owningContactId |
|
isGlobal
|
data.searchFirmContacts.models.emailAddresses.isGlobal | boolean |
isGlobal |
|
Телефонные номера
|
data.searchFirmContacts.models.phoneNumbers | array of object |
Телефонные номера |
|
phoneId
|
data.searchFirmContacts.models.phoneNumbers.phoneId | string |
phoneId |
|
число/номер
|
data.searchFirmContacts.models.phoneNumbers.number | string |
число/номер |
|
label
|
data.searchFirmContacts.models.phoneNumbers.label | string |
label |
|
type
|
data.searchFirmContacts.models.phoneNumbers.type | string |
type |
|
использование
|
data.searchFirmContacts.models.phoneNumbers.usage | string |
использование |
|
owningContactId
|
data.searchFirmContacts.models.phoneNumbers.owningContactId | string |
owningContactId |
|
isGlobal
|
data.searchFirmContacts.models.phoneNumbers.isGlobal | boolean |
isGlobal |
|
skip
|
data.searchFirmContacts.models.activities.skip | integer |
skip |
|
limit
|
data.searchFirmContacts.models.activities.limit | integer |
limit |
|
totalModels
|
data.searchFirmContacts.models.activities.totalModels | integer |
totalModels |
|
models
|
data.searchFirmContacts.models.activities.models | array of object |
models |
|
activityId
|
data.searchFirmContacts.models.activities.models.activityId | string |
activityId |
|
type
|
data.searchFirmContacts.models.activities.models.type | string |
type |
|
TypeId
|
data.searchFirmContacts.models.activities.models.typeId | string |
TypeId |
|
activityClass
|
data.searchFirmContacts.models.activities.models.activityClass | string |
activityClass |
|
typeGroup
|
data.searchFirmContacts.models.activities.models.typeGroup | string |
typeGroup |
|
activityStartDate
|
data.searchFirmContacts.models.activities.models.activityStartDate | string |
activityStartDate |
|
lastEditedDate
|
data.searchFirmContacts.models.activities.models.lastEditedDate | string |
lastEditedDate |
|
субъект
|
data.searchFirmContacts.models.activities.models.subject | string |
субъект |
|
summary
|
data.searchFirmContacts.models.activities.models.summary | string |
summary |
|
location
|
data.searchFirmContacts.models.activities.models.location | string |
location |
|
totalModels
|
data.searchFirmContacts.models.notes.allNotes.totalModels | integer |
totalModels |
|
models
|
data.searchFirmContacts.models.notes.allNotes.models | array of |
models |
|
totalModels
|
data.searchFirmContacts.models.lists.totalModels | integer |
totalModels |
|
models
|
data.searchFirmContacts.models.lists.models | array of object |
models |
|
listId
|
data.searchFirmContacts.models.lists.models.listId | string |
listId |
|
имя
|
data.searchFirmContacts.models.lists.models.name | string |
имя |
|
listClass
|
data.searchFirmContacts.models.lists.models.listClass | string |
listClass |
|
описание
|
data.searchFirmContacts.models.lists.models.description | string |
описание |
|
type
|
data.searchFirmContacts.models.lists.models.type | string |
type |
|
userIsSponsor
|
data.searchFirmContacts.models.lists.models.userIsSponsor | boolean |
userIsSponsor |
|
allowedLinkInto
|
data.searchFirmContacts.models.lists.models.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.searchFirmContacts.models.lists.models.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
ownerName
|
data.searchFirmContacts.models.lists.models.ownerName | string |
ownerName |
|
creatorName
|
data.searchFirmContacts.models.lists.models.creatorName | string |
creatorName |
|
Спонсоров
|
data.searchFirmContacts.models.lists.models.sponsors | array of object |
Спонсоров |
|
спонсируемый Идентификатор
|
data.searchFirmContacts.models.lists.models.sponsors.sponsorId | string |
спонсируемый Идентификатор |
|
отображаемое имя
|
data.searchFirmContacts.models.lists.models.sponsors.displayName | string |
отображаемое имя |
|
isPrimary
|
data.searchFirmContacts.models.lists.models.sponsors.isPrimary | boolean |
isPrimary |
|
fullName
|
data.searchFirmContacts.models.lists.models.sponsors.fullName | string |
fullName |
Обновление контакта с пользователем
Обновите контакт пользователя в InterAction+.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Контактный номер
|
id | True | string |
Идентификатор контакта пользователя. |
|
Название
|
title | string |
Название (г-н, миссис, доктор и т. д.). |
|
|
Имя (Первое имя)
|
firstName | string |
Имя. |
|
|
Второе имя
|
middleName | string |
По промежуточному имени. |
|
|
Фамилия
|
lastName | True | string |
Фамилия человека. |
|
GoesBy
|
goesBy | string |
Общее имя. |
|
|
Должность
|
jobTitle | string |
Название задания. |
|
|
Улица
|
street | string |
Улица. |
|
|
Город
|
city | string |
Город. |
|
|
Административное подразделение/ штат/ регион/ округ/ провинция
|
administrativeDivision | string |
Административное подразделение, штат, регион, регион или провинция. |
|
|
Страна
|
country | string |
Для обновления страны также требуется поле "Город". |
|
|
Почтовый индекс
|
postalCode | string |
Почтовый индекс бизнес-адреса, если ваша страна не использует почтовый индекс, оставьте его пустым. |
|
|
Электронная почта
|
electronicAddress | string |
Адрес электронной почты для бизнеса. |
|
|
Прямой или основной телефон
|
number | string |
Прямой или основной телефон. |
|
|
Название компании
|
companyName | string |
Название компании. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
data.updatePublicPerson.item.id | string |
id |
|
статус
|
data.updatePublicPerson.status | string |
статус |
|
validationErrors
|
data.updatePublicPerson.validationErrors | array of |
validationErrors |
Получение дополнительных определений полей и значений
Получение дополнительных определений полей и значений списка из InterAction+.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
id | True | string |
Идентификатор списка. |
|
Пропуск контактов
|
skip | integer |
Отправная точка для получения контактов. Значение по умолчанию равно 0. |
|
|
Ограничение контактов
|
limit | integer |
Количество контактов для получения из списков. Значение по умолчанию равно 100. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
data.list.id | string |
id |
|
имя
|
data.list.name | string |
имя |
|
описание
|
data.list.description | string |
описание |
|
id
|
data.list.listType.id | string |
id |
|
isActive
|
data.list.listType.isActive | boolean |
isActive |
|
listClass
|
data.list.listType.listClass | string |
listClass |
|
имя
|
data.list.listType.name | string |
имя |
|
totalModels
|
data.list.additionalFieldDefinitions.totalModels | integer |
totalModels |
|
models
|
data.list.additionalFieldDefinitions.models | array of object |
models |
|
userDataTypeUserProfessional
|
data.list.additionalFieldDefinitions.models.userDataTypeUserProfessional | string |
userDataTypeUserProfessional |
|
userDataTypeUserActive
|
data.list.additionalFieldDefinitions.models.userDataTypeUserActive | string |
userDataTypeUserActive |
|
stringDataTypeMultiLine
|
data.list.additionalFieldDefinitions.models.stringDataTypeMultiLine | boolean |
stringDataTypeMultiLine |
|
stringDataTypeMaxLength
|
data.list.additionalFieldDefinitions.models.stringDataTypeMaxLength | integer |
stringDataTypeMaxLength |
|
secondaryFieldName
|
data.list.additionalFieldDefinitions.models.secondaryFieldName | string |
secondaryFieldName |
|
numericDataTypeMinValue
|
data.list.additionalFieldDefinitions.models.numericDataTypeMinValue | string |
numericDataTypeMinValue |
|
numericDataTypeMaxValue
|
data.list.additionalFieldDefinitions.models.numericDataTypeMaxValue | string |
numericDataTypeMaxValue |
|
имя
|
data.list.additionalFieldDefinitions.models.name | string |
имя |
|
options
|
data.list.additionalFieldDefinitions.models.listDataType.options | array of |
options |
|
id
|
data.list.additionalFieldDefinitions.models.id | string |
id |
|
fieldDataType
|
data.list.additionalFieldDefinitions.models.fieldDataType | string |
fieldDataType |
|
описание
|
data.list.additionalFieldDefinitions.models.description | string |
описание |
|
decimalDataTypePrecision
|
data.list.additionalFieldDefinitions.models.decimalDataTypePrecision | integer |
decimalDataTypePrecision |
|
dataTypeDisplayName
|
data.list.additionalFieldDefinitions.models.dataTypeDisplayName | string |
dataTypeDisplayName |
|
booleanDataTypeFalseValue
|
data.list.additionalFieldDefinitions.models.booleanDataTypeFalseValue | string |
booleanDataTypeFalseValue |
|
booleanDataTypeTrueValue
|
data.list.additionalFieldDefinitions.models.booleanDataTypeTrueValue | string |
booleanDataTypeTrueValue |
|
allowsSecondaryField
|
data.list.additionalFieldDefinitions.models.allowsSecondaryField | boolean |
allowsSecondaryField |
|
allowsMultipleValues
|
data.list.additionalFieldDefinitions.models.allowsMultipleValues | boolean |
allowsMultipleValues |
|
totalModels
|
data.list.contacts.totalModels | integer |
totalModels |
|
models
|
data.list.contacts.models | array of object |
models |
|
id
|
data.list.contacts.models.id | string |
id |
|
title
|
data.list.contacts.models.title | string |
title |
|
номер телефона
|
data.list.contacts.models.phoneNumber | string |
номер телефона |
|
адрес электронной почты
|
data.list.contacts.models.emailAddress | string |
адрес электронной почты |
|
отображаемое имя
|
data.list.contacts.models.displayName | string |
отображаемое имя |
|
companyName
|
data.list.contacts.models.companyName | string |
companyName |
|
companyId
|
data.list.contacts.models.companyId | string |
companyId |
|
contactEntity
|
data.list.contacts.models.contactEntity | string |
contactEntity |
|
отображаемое имя
|
data.list.contacts.models.sponsors.displayName | string |
отображаемое имя |
|
fullName
|
data.list.contacts.models.sponsors.fullName | string |
fullName |
|
id
|
data.list.contacts.models.sponsors.id | string |
id |
|
isPrimary
|
data.list.contacts.models.sponsors.isPrimary | boolean |
isPrimary |
|
totalModels
|
data.list.contacts.models.additionalFieldValues.totalModels | integer |
totalModels |
|
models
|
data.list.contacts.models.additionalFieldValues.models | array of object |
models |
|
contactId
|
data.list.contacts.models.additionalFieldValues.models.contactId | string |
contactId |
|
тип данных
|
data.list.contacts.models.additionalFieldValues.models.dataType | string |
тип данных |
|
fieldDisplayName
|
data.list.contacts.models.additionalFieldValues.models.fieldDisplayName | string |
fieldDisplayName |
|
fieldId
|
data.list.contacts.models.additionalFieldValues.models.fieldId | string |
fieldId |
|
format
|
data.list.contacts.models.additionalFieldValues.models.format | string |
format |
|
id
|
data.list.contacts.models.additionalFieldValues.models.id | string |
id |
|
listId
|
data.list.contacts.models.additionalFieldValues.models.listId | string |
listId |
|
разделитель
|
data.list.contacts.models.additionalFieldValues.models.separator | string |
разделитель |
|
valueItems
|
data.list.contacts.models.additionalFieldValues.models.valueItems | array of object |
valueItems |
|
LastEditDate
|
data.list.contacts.models.additionalFieldValues.models.valueItems.lastEditDate | string |
LastEditDate |
|
квалификация
|
data.list.contacts.models.additionalFieldValues.models.valueItems.qualification | string |
квалификация |
|
value
|
data.list.contacts.models.additionalFieldValues.models.valueItems.value | string |
value |
|
valueId
|
data.list.contacts.models.additionalFieldValues.models.valueItems.valueId | string |
valueId |
Получение изменений членства в списке контактов
Это действие извлекает контакты, которые были добавлены или удалены из указанных списков в заданном диапазоне дат. Он предназначен для отслеживания изменений в списке контактов, помогая пользователям отслеживать обновления, синхронизировать данные или запускать подчиненные процессы на основе изменений.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Типы событий
|
eventTypes | True | array of string |
Тип события |
|
С даты
|
start | date-time |
Указывает дату начала диапазона дат, включая сведения о часовом поясе. Дата начала по умолчанию — 90 дней назад, если она не указана. Если дата начала не указана, смещение даты начала определяется с указанной даты окончания, в противном случае используется значение UTC (нулевое смещение). Формат YYYY-MM-DDTHH:mm:ssZ. |
|
|
На сегодняшний день
|
end | date-time |
Указывает дату окончания диапазона дат, включая сведения о часовом поясе. Формат YYYY-MM-DDTHH:mm:ssZ. |
|
|
Идентификаторы списка
|
listIds | True | array of string |
Получение событий добавления контакта или удаления для указанных идентификаторов списка. |
|
Пропустить
|
skip | integer |
Начальный индекс для разбиения на страницы. Default = 0 |
|
|
Лимит
|
limit | integer |
Максимальное количество извлекаемых элементов. По умолчанию = 100 |
|
|
Поле сортировки
|
field | True | string |
Указывает поле, используемое для сортировки событий. |
|
Направление сортировки
|
direction | string |
Указывает направление сортировки (по возрастанию или убыванию). По умолчанию = по возрастанию |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Всего моделей
|
data.listEventViews.totalModels | integer |
Общее количество найденных элементов. |
|
models
|
data.listEventViews.models | array of object |
Представляет события, произошедшие в списке. |
|
Тип события
|
data.listEventViews.models.eventType | string |
Тип события, которое произошло в списке. |
|
EventDate
|
data.listEventViews.models.eventDate | string |
Дата и время возникновения события. |
|
ListId
|
data.listEventViews.models.listId | string |
Идентификатор списка, в который произошло это событие. |
|
ContactId
|
data.listEventViews.models.contactId | string |
Идентификатор контакта, который был добавлен или удален из списка. |
|
ContactId
|
data.listEventViews.models.contact.contactId | string |
Идентификатор контакта. |
|
Отображаемое имя
|
data.listEventViews.models.contact.displayName | string |
Отображаемое имя контакта. |
|
ContactEntity
|
data.listEventViews.models.contact.contactEntity | string |
Тип сущности контакта. |
|
Название
|
data.listEventViews.models.contact.title | string |
Заголовок контакта. |
|
Имя
|
data.listEventViews.models.contact.firstName | string |
Имя контакта. |
|
MiddleName
|
data.listEventViews.models.contact.middleName | string |
По промежуточному имени контакта. |
|
Фамилия
|
data.listEventViews.models.contact.lastName | string |
Фамилия контакта. |
|
GoesBy
|
data.listEventViews.models.contact.goesBy | string |
Предпочтительное имя или псевдоним контакта. |
|
CurrentJobTitle
|
data.listEventViews.models.contact.currentJobTitle | string |
Текущее название задания контакта. |
|
Имя Компании
|
data.listEventViews.models.contact.currentEmployer.companyName | string |
Имя компании. |
|
CompanyId
|
data.listEventViews.models.contact.currentEmployer.companyId | string |
Идентификатор компании. |
|
addresses
|
data.listEventViews.models.contact.addresses | array of object |
Извлекает адреса, связанные с контактом. |
|
AddressId
|
data.listEventViews.models.contact.addresses.addressID | string |
Идентификатор адреса. |
|
Улица
|
data.listEventViews.models.contact.addresses.street | string |
Имя улицы адреса. |
|
Город
|
data.listEventViews.models.contact.addresses.city | string |
Город адреса (город, город, деревня и т. д.). |
|
AdministrativeDivision
|
data.listEventViews.models.contact.addresses.administrativeDivision | string |
Административное подразделение адреса. Это представляет собой штат, провинцию, губернаторство, департамент или аналогичный региональный отдел в зависимости от страны. Это поле может не применяться ко всем странам. |
|
Страна
|
data.listEventViews.models.contact.addresses.country | string |
Страна адреса. |
|
Почтовый индекс
|
data.listEventViews.models.contact.addresses.postalCode | string |
Почтовый индекс адреса. Это поле может не применяться ко всем странам. |
|
Тип
|
data.listEventViews.models.contact.addresses.type | string |
Тип адреса. |
|
Usage
|
data.listEventViews.models.contact.addresses.usage | string |
Тип использования адреса (AlternateBusiness, AlternateHome и т. д.). |
|
Видимость
|
data.listEventViews.models.contact.visibility | string |
Параметры видимости контакта. |
|
emailАдреса
|
data.listEventViews.models.contact.emailAddresses | array of object |
Извлекает адреса электронной почты, связанные с контактом. |
|
EmailId
|
data.listEventViews.models.contact.emailAddresses.emailId | string |
Идентификатор адреса электронной почты. |
|
Тип
|
data.listEventViews.models.contact.emailAddresses.type | string |
Тип адреса электронной почты (электронная почта, FTPSite, веб-сайт). |
|
Usage
|
data.listEventViews.models.contact.emailAddresses.usage | string |
Тип использования адреса электронной почты (AlternateBusiness, AlternateHome и т. д.). |
|
Адрес электронной почты
|
data.listEventViews.models.contact.emailAddresses.address | string |
Адрес электронной почты. |
|
Этикетка
|
data.listEventViews.models.contact.emailAddresses.label | string |
Метка адреса электронной почты. |
|
OwningContactId
|
data.listEventViews.models.contact.emailAddresses.owningContactId | string |
Идентификатор контакта, которому принадлежит этот адрес электронной почты. |
|
IsGlobal
|
data.listEventViews.models.contact.emailAddresses.isGlobal | boolean |
Указывает, является ли это глобальным адресом электронной почты. |
|
Телефонные номера
|
data.listEventViews.models.contact.phoneNumbers | array of object |
Извлекает номера телефонов, связанные с контактом. |
|
PhoneId
|
data.listEventViews.models.contact.phoneNumbers.phoneId | string |
Идентификатор номера телефона. |
|
Number
|
data.listEventViews.models.contact.phoneNumbers.number | string |
Номер телефона. |
|
Этикетка
|
data.listEventViews.models.contact.phoneNumbers.label | string |
Метка номера телефона. |
|
Тип
|
data.listEventViews.models.contact.phoneNumbers.type | string |
Тип номера телефона (мобильный, телефон, пейджер и т. д.). |
|
Usage
|
data.listEventViews.models.contact.phoneNumbers.usage | string |
Тип использования номера телефона (AlternateBusiness, AlternateHome и т. д.). |
|
OwningContactId
|
data.listEventViews.models.contact.phoneNumbers.owningContactId | string |
Идентификатор контакта, которому принадлежит этот номер телефона. |
|
IsGlobal
|
data.listEventViews.models.contact.phoneNumbers.isGlobal | boolean |
Указывает, является ли это глобальным номером телефона. |
|
Имя
|
data.listEventViews.models.contact.name | string |
Имя контакта. |
|
ListId
|
data.listEventViews.models.list.listId | string |
Идентификатор списка. |
|
Имя
|
data.listEventViews.models.list.name | string |
Имя списка. |
|
Description
|
data.listEventViews.models.list.description | string |
Описание списка. |
|
Идентификатор
|
data.listEventViews.models.list.listType.id | string |
Идентификатор типа списка. |
|
Активен
|
data.listEventViews.models.list.listType.isActive | boolean |
Указывает, активен ли тип списка. |
|
ListClass
|
data.listEventViews.models.list.listType.listClass | string |
Класс списка, связанный с этим типом списка. |
|
Имя
|
data.listEventViews.models.list.listType.name | string |
Имя типа папки. |
|
AllowedLinkInto
|
data.listEventViews.models.list.allowedLinkInto | boolean |
Указывает, могут ли записи быть связаны с этим списком. |
|
AllowedRemoveFrom
|
data.listEventViews.models.list.allowedRemoveFrom | boolean |
Указывает, можно ли удалить связанные записи из этого списка. |
|
AddAllowed
|
data.listEventViews.models.list.addAllowed | boolean |
Указывает, можно ли добавлять записи в этот список. |
|
DeleteAllowed
|
data.listEventViews.models.list.deleteAllowed | boolean |
Указывает, можно ли удалять записи из этого списка. |
|
AddActivityAllowed
|
data.listEventViews.models.list.addActivityAllowed | boolean |
Указывает, можно ли добавлять действия. |
|
AddNoteAllowed
|
data.listEventViews.models.list.addNoteAllowed | boolean |
Указывает, можно ли добавлять заметки. |
|
Имя владельца
|
data.listEventViews.models.list.ownerName | string |
Имя владельца этого списка. |
|
CreatorName
|
data.listEventViews.models.list.creatorName | string |
Имя создателя этого списка. |
|
AllowedContactEntity
|
data.listEventViews.models.list.allowedContactEntity | string |
Допустимые типы сущностей контакта для этого списка. |
|
IsAdministrator
|
data.listEventViews.models.list.isAdministrator | boolean |
Указывает, является ли текущий пользователь администратором этого списка. |
Получение или удаление контактов
Это действие извлекает контакты, созданные или удаленные в InterAction+ в заданном диапазоне дат. Он предназначен для отслеживания разностных изменений для контактов, помогая пользователям отслеживать обновления, синхронизировать данные или запускать подчиненные процессы на основе изменений.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Типы событий
|
eventTypes | True | array of string |
Тип события. |
|
С даты
|
start | date-time |
Указывает дату начала диапазона дат, включая сведения о часовом поясе. Дата начала по умолчанию — 90 дней назад, если она не указана. Если дата начала не указана, смещение даты начала определяется с указанной даты окончания, в противном случае используется значение UTC (нулевое смещение). Формат YYYY-MM-DDTHH:mm:ssZ. |
|
|
На сегодняшний день
|
end | date-time |
Указывает дату окончания диапазона дат, включая сведения о часовом поясе. Формат YYYY-MM-DDTHH:mm:ssZ. |
|
|
Пропустить
|
skip | integer |
Начальный индекс для разбиения на страницы. Default = 0 |
|
|
Лимит
|
limit | integer |
Максимальное количество извлекаемых элементов. По умолчанию = 100 |
|
|
Поле сортировки
|
field | True | string |
Указывает поле, используемое для сортировки событий. |
|
Направление сортировки
|
direction | string |
Указывает направление сортировки (по возрастанию или убыванию). По умолчанию = по возрастанию |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
TotalModels
|
data.firmContactEventViews.totalModels | integer |
Общее количество найденных элементов. |
|
models
|
data.firmContactEventViews.models | array of object |
Список событий твердого контакта. |
|
Тип события
|
data.firmContactEventViews.models.eventType | string |
Тип события, которое произошло на твердом контакте. |
|
EventDate
|
data.firmContactEventViews.models.eventDate | string |
Дата и время возникновения события. |
|
ContactId
|
data.firmContactEventViews.models.contactId | string |
Идентификатор фирмы, связавшаяся с этим событием, произошла. |
|
ContactId
|
data.firmContactEventViews.models.contact.contactId | string |
Идентификатор контакта. |
|
Отображаемое имя
|
data.firmContactEventViews.models.contact.displayName | string |
Отображаемое имя контакта. |
|
ContactEntity
|
data.firmContactEventViews.models.contact.contactEntity | string |
Тип сущности контакта. |
|
Название
|
data.firmContactEventViews.models.contact.title | string |
Заголовок контакта. |
|
Имя
|
data.firmContactEventViews.models.contact.firstName | string |
Имя контакта. |
|
MiddleName
|
data.firmContactEventViews.models.contact.middleName | string |
По промежуточному имени контакта. |
|
Фамилия
|
data.firmContactEventViews.models.contact.lastName | string |
Фамилия контакта. |
|
GoesBy
|
data.firmContactEventViews.models.contact.goesBy | string |
Предпочтительное имя или псевдоним контакта. |
|
CurrentJobTitle
|
data.firmContactEventViews.models.contact.currentJobTitle | string |
Текущее название задания контакта. |
|
Имя Компании
|
data.firmContactEventViews.models.contact.currentEmployer.companyName | string |
Имя компании. |
|
CompanyId
|
data.firmContactEventViews.models.contact.currentEmployer.companyId | string |
Идентификатор компании. |
|
addresses
|
data.firmContactEventViews.models.contact.addresses | array of object |
Извлекает адреса, связанные с контактом. |
|
AddressId
|
data.firmContactEventViews.models.contact.addresses.addressID | string |
Идентификатор адреса. |
|
Улица
|
data.firmContactEventViews.models.contact.addresses.street | string |
Имя улицы адреса. |
|
Город
|
data.firmContactEventViews.models.contact.addresses.city | string |
Город адреса (город, город, деревня и т. д.). |
|
AdministrativeDivision
|
data.firmContactEventViews.models.contact.addresses.administrativeDivision | string |
Административное подразделение адреса. Это представляет собой штат, провинцию, губернаторство, департамент или аналогичный региональный отдел в зависимости от страны. Это поле может не применяться ко всем странам. |
|
Страна
|
data.firmContactEventViews.models.contact.addresses.country | string |
Страна адреса. |
|
Почтовый индекс
|
data.firmContactEventViews.models.contact.addresses.postalCode | string |
Почтовый индекс адреса. Это поле может не применяться ко всем странам. |
|
Тип
|
data.firmContactEventViews.models.contact.addresses.type | string |
Тип адреса. |
|
Usage
|
data.firmContactEventViews.models.contact.addresses.usage | string |
Тип использования адреса (AlternateBusiness, AlternateHome и т. д.). |
|
Видимость
|
data.firmContactEventViews.models.contact.visibility | string |
Параметры видимости контакта. |
|
emailАдреса
|
data.firmContactEventViews.models.contact.emailAddresses | array of object |
Извлекает адреса электронной почты, связанные с контактом. |
|
EmailId
|
data.firmContactEventViews.models.contact.emailAddresses.emailId | string |
Идентификатор адреса электронной почты. |
|
Тип
|
data.firmContactEventViews.models.contact.emailAddresses.type | string |
Тип адреса электронной почты (электронная почта, FTPSite, веб-сайт). |
|
Usage
|
data.firmContactEventViews.models.contact.emailAddresses.usage | string |
Тип использования адреса электронной почты (AlternateBusiness, AlternateHome и т. д.). |
|
Адрес электронной почты
|
data.firmContactEventViews.models.contact.emailAddresses.address | string |
Адрес электронной почты. |
|
Этикетка
|
data.firmContactEventViews.models.contact.emailAddresses.label | string |
Метка адреса электронной почты. |
|
OwningContactId
|
data.firmContactEventViews.models.contact.emailAddresses.owningContactId | string |
Идентификатор контакта, которому принадлежит этот адрес электронной почты. |
|
IsGlobal
|
data.firmContactEventViews.models.contact.emailAddresses.isGlobal | boolean |
Указывает, является ли это глобальным адресом электронной почты. |
|
Телефонные номера
|
data.firmContactEventViews.models.contact.phoneNumbers | array of object |
Извлекает номера телефонов, связанные с контактом. |
|
PhoneId
|
data.firmContactEventViews.models.contact.phoneNumbers.phoneId | string |
Идентификатор номера телефона. |
|
Number
|
data.firmContactEventViews.models.contact.phoneNumbers.number | string |
Номер телефона. |
|
Этикетка
|
data.firmContactEventViews.models.contact.phoneNumbers.label | string |
Метка номера телефона. |
|
Тип
|
data.firmContactEventViews.models.contact.phoneNumbers.type | string |
Тип номера телефона (мобильный, телефон, пейджер и т. д.). |
|
Usage
|
data.firmContactEventViews.models.contact.phoneNumbers.usage | string |
Тип использования номера телефона (AlternateBusiness, AlternateHome и т. д.). |
|
OwningContactId
|
data.firmContactEventViews.models.contact.phoneNumbers.owningContactId | string |
Идентификатор контакта, которому принадлежит этот номер телефона. |
|
IsGlobal
|
data.firmContactEventViews.models.contact.phoneNumbers.isGlobal | boolean |
Указывает, является ли это глобальным номером телефона. |
|
Имя
|
data.firmContactEventViews.models.contact.name | string |
Имя контакта. |
Получение контакта по идентификатору
Получение контакта по идентификатору вместе с дополнительными значениями полей в InterAction+.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Контактный номер
|
contactid | True | string |
Идентификатор контакта. |
|
Идентификатор списка
|
listid | True | string |
Идентификатор списка не может иметь значение NULL, а значение по умолчанию — 00000000-0000-0000-0000-00000000000000000000. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
contactId
|
data.contact.contactId | string |
contactId |
|
отображаемое имя
|
data.contact.displayName | string |
отображаемое имя |
|
title
|
data.contact.title | string |
title |
|
Имя
|
data.contact.firstName | string |
Имя |
|
второе имя
|
data.contact.middleName | string |
второе имя |
|
lastName
|
data.contact.lastName | string |
lastName |
|
goesBy
|
data.contact.goesBy | string |
goesBy |
|
contactEntity
|
data.contact.contactEntity | string |
contactEntity |
|
currentJobTitle
|
data.contact.currentJobTitle | string |
currentJobTitle |
|
companyName
|
data.contact.currentEmployer.companyName | string |
companyName |
|
companyId
|
data.contact.currentEmployer.companyId | string |
companyId |
|
totalModels
|
data.contact.additionalFieldValues.totalModels | integer |
totalModels |
|
models
|
data.contact.additionalFieldValues.models | array of object |
models |
|
contactId
|
data.contact.additionalFieldValues.models.contactId | string |
contactId |
|
тип данных
|
data.contact.additionalFieldValues.models.dataType | string |
тип данных |
|
fieldId
|
data.contact.additionalFieldValues.models.fieldId | string |
fieldId |
|
fieldDisplayName
|
data.contact.additionalFieldValues.models.fieldDisplayName | string |
fieldDisplayName |
|
additionalFieldValueId
|
data.contact.additionalFieldValues.models.additionalFieldValueId | string |
additionalFieldValueId |
|
listId
|
data.contact.additionalFieldValues.models.listId | string |
listId |
|
valueItems
|
data.contact.additionalFieldValues.models.valueItems | array of object |
valueItems |
|
LastEditDate
|
data.contact.additionalFieldValues.models.valueItems.lastEditDate | string |
LastEditDate |
|
value
|
data.contact.additionalFieldValues.models.valueItems.value | string |
value |
|
valueId
|
data.contact.additionalFieldValues.models.valueItems.valueId | string |
valueId |
|
addresses
|
data.contact.addresses | array of object | |
|
id
|
data.contact.addresses.id | string |
addressId |
|
улица
|
data.contact.addresses.street | string |
улица |
|
city
|
data.contact.addresses.city | string |
city |
|
administrativeDivision
|
data.contact.addresses.administrativeDivision | string |
administrativeDivision |
|
country
|
data.contact.addresses.country | string |
country |
|
postalCode
|
data.contact.addresses.postalCode | string |
postalCode |
|
type
|
data.contact.addresses.type | string |
type |
|
использование
|
data.contact.addresses.usage | string |
использование |
|
видимость
|
data.contact.visibility | string |
видимость |
|
emailАдреса
|
data.contact.emailAddresses | array of object |
emailАдреса |
|
emailId
|
data.contact.emailAddresses.emailId | string |
emailId |
|
type
|
data.contact.emailAddresses.type | string |
type |
|
использование
|
data.contact.emailAddresses.usage | string |
использование |
|
address
|
data.contact.emailAddresses.address | string |
address |
|
label
|
data.contact.emailAddresses.label | string |
label |
|
owningContactId
|
data.contact.emailAddresses.owningContactId | string |
owningContactId |
|
isGlobal
|
data.contact.emailAddresses.isGlobal | boolean |
isGlobal |
|
Телефонные номера
|
data.contact.phoneNumbers | array of object |
Телефонные номера |
|
phoneId
|
data.contact.phoneNumbers.phoneId | string |
phoneId |
|
число/номер
|
data.contact.phoneNumbers.number | string |
число/номер |
|
label
|
data.contact.phoneNumbers.label | string |
label |
|
type
|
data.contact.phoneNumbers.type | string |
type |
|
использование
|
data.contact.phoneNumbers.usage | string |
использование |
|
owningContactId
|
data.contact.phoneNumbers.owningContactId | string |
owningContactId |
|
isGlobal
|
data.contact.phoneNumbers.isGlobal | boolean |
isGlobal |
|
skip
|
data.contact.activities.skip | integer |
skip |
|
limit
|
data.contact.activities.limit | integer |
limit |
|
totalModels
|
data.contact.activities.totalModels | integer |
totalModels |
|
models
|
data.contact.activities.models | array of object |
models |
|
activityId
|
data.contact.activities.models.activityId | string |
activityId |
|
type
|
data.contact.activities.models.type | string |
type |
|
TypeId
|
data.contact.activities.models.typeId | string |
TypeId |
|
activityClass
|
data.contact.activities.models.activityClass | string |
activityClass |
|
typeGroup
|
data.contact.activities.models.typeGroup | string |
typeGroup |
|
activityStartDate
|
data.contact.activities.models.activityStartDate | string |
activityStartDate |
|
lastEditedDate
|
data.contact.activities.models.lastEditedDate | string |
lastEditedDate |
|
субъект
|
data.contact.activities.models.subject | string |
субъект |
|
summary
|
data.contact.activities.models.summary | string |
summary |
|
location
|
data.contact.activities.models.location | string |
location |
|
totalModels
|
data.contact.notes.allNotes.totalModels | integer |
totalModels |
|
models
|
data.contact.notes.allNotes.models | array of object |
models |
|
changeDate
|
data.contact.notes.allNotes.models.changeDate | string |
changeDate |
|
folderId
|
data.contact.notes.allNotes.models.folderId | string |
folderId |
|
noteId
|
data.contact.notes.allNotes.models.noteId | string |
noteId |
|
заметки
|
data.contact.notes.allNotes.models.notes | string |
заметки |
|
totalModels
|
data.contact.lists.totalModels | integer |
totalModels |
|
models
|
data.contact.lists.models | array of object |
models |
|
listId
|
data.contact.lists.models.listId | string |
listId |
|
имя
|
data.contact.lists.models.name | string |
имя |
|
listClass
|
data.contact.lists.models.listClass | string |
listClass |
|
описание
|
data.contact.lists.models.description | string |
описание |
|
type
|
data.contact.lists.models.type | string |
type |
|
userIsSponsor
|
data.contact.lists.models.userIsSponsor | boolean |
userIsSponsor |
|
allowedLinkInto
|
data.contact.lists.models.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.contact.lists.models.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
ownerName
|
data.contact.lists.models.ownerName | string |
ownerName |
|
creatorName
|
data.contact.lists.models.creatorName | string |
creatorName |
|
Спонсоров
|
data.contact.lists.models.sponsors | array of object |
Спонсоров |
|
спонсируемый Идентификатор
|
data.contact.lists.models.sponsors.sponsorId | string |
спонсируемый Идентификатор |
|
отображаемое имя
|
data.contact.lists.models.sponsors.displayName | string |
отображаемое имя |
|
isPrimary
|
data.contact.lists.models.sponsors.isPrimary | boolean |
isPrimary |
|
fullName
|
data.contact.lists.models.sponsors.fullName | string |
fullName |
Получение обновленных контактов
Это действие извлекает контакты, которые были обновлены в InterAction+ в заданном диапазоне дат. Он предназначен для отслеживания разностных изменений для контактов, помогая пользователям отслеживать обновления, синхронизировать данные или запускать подчиненные процессы на основе изменений.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Типы событий
|
eventTypes | True | array of string |
Тип события. |
|
С даты
|
start | date-time |
Указывает дату начала диапазона дат, включая сведения о часовом поясе. Дата начала по умолчанию — 90 дней назад, если она не указана. Если дата начала не указана, смещение даты начала определяется с указанной даты окончания, в противном случае используется значение UTC (нулевое смещение). Формат YYYY-MM-DDTHH:mm:ssZ. |
|
|
На сегодняшний день
|
end | date-time |
Указывает дату окончания диапазона дат, включая сведения о часовом поясе. Формат YYYY-MM-DDTHH:mm:ssZ. |
|
|
Идентификаторы контактов
|
contactIds | array of string |
Идентификаторы фирмы контактов для фильтрации событий контактов фирмы. |
|
|
Пропустить
|
skip | integer |
Начальный индекс для разбиения на страницы. Default = 0 |
|
|
Лимит
|
limit | integer |
Максимальное количество извлекаемых элементов. По умолчанию = 100 |
|
|
Поле сортировки
|
field | True | string |
Указывает поле, используемое для сортировки событий. |
|
Направление сортировки
|
direction | string |
Указывает направление сортировки (по возрастанию или убыванию). По умолчанию = по возрастанию |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
TotalModels
|
data.firmContactEventViews.totalModels | integer |
Общее количество найденных элементов. |
|
models
|
data.firmContactEventViews.models | array of object |
Список событий твердого контакта. |
|
Тип события
|
data.firmContactEventViews.models.eventType | string |
Тип события, которое произошло на твердом контакте. |
|
EventDate
|
data.firmContactEventViews.models.eventDate | string |
Дата и время возникновения события. |
|
ContactId
|
data.firmContactEventViews.models.contactId | string |
Идентификатор фирмы, связавшаяся с этим событием, произошла. |
|
ContactId
|
data.firmContactEventViews.models.contact.contactId | string |
Идентификатор контакта. |
|
Отображаемое имя
|
data.firmContactEventViews.models.contact.displayName | string |
Отображаемое имя контакта. |
|
ContactEntity
|
data.firmContactEventViews.models.contact.contactEntity | string |
Тип сущности контакта. |
|
Название
|
data.firmContactEventViews.models.contact.title | string |
Заголовок контакта. |
|
Имя
|
data.firmContactEventViews.models.contact.firstName | string |
Имя контакта. |
|
MiddleName
|
data.firmContactEventViews.models.contact.middleName | string |
По промежуточному имени контакта. |
|
Фамилия
|
data.firmContactEventViews.models.contact.lastName | string |
Фамилия контакта. |
|
GoesBy
|
data.firmContactEventViews.models.contact.goesBy | string |
Предпочтительное имя или псевдоним контакта. |
|
CurrentJobTitle
|
data.firmContactEventViews.models.contact.currentJobTitle | string |
Текущее название задания контакта. |
|
Имя Компании
|
data.firmContactEventViews.models.contact.currentEmployer.companyName | string |
Имя компании. |
|
CompanyId
|
data.firmContactEventViews.models.contact.currentEmployer.companyId | string |
Идентификатор компании. |
|
addresses
|
data.firmContactEventViews.models.contact.addresses | array of object |
Извлекает адреса, связанные с контактом. |
|
AddressId
|
data.firmContactEventViews.models.contact.addresses.addressID | string |
Идентификатор адреса. |
|
Улица
|
data.firmContactEventViews.models.contact.addresses.street | string |
Имя улицы адреса. |
|
Город
|
data.firmContactEventViews.models.contact.addresses.city | string |
Город адреса (город, город, деревня и т. д.). |
|
AdministrativeDivision
|
data.firmContactEventViews.models.contact.addresses.administrativeDivision | string |
Административное подразделение адреса. Это представляет собой штат, провинцию, губернаторство, департамент или аналогичный региональный отдел в зависимости от страны. Это поле может не применяться ко всем странам. |
|
Страна
|
data.firmContactEventViews.models.contact.addresses.country | string |
Страна адреса. |
|
Почтовый индекс
|
data.firmContactEventViews.models.contact.addresses.postalCode | string |
Почтовый индекс адреса. Это поле может не применяться ко всем странам. |
|
Тип
|
data.firmContactEventViews.models.contact.addresses.type | string |
Тип адреса. |
|
Usage
|
data.firmContactEventViews.models.contact.addresses.usage | string |
Тип использования адреса (AlternateBusiness, AlternateHome и т. д.). |
|
Видимость
|
data.firmContactEventViews.models.contact.visibility | string |
Параметры видимости контакта. |
|
emailАдреса
|
data.firmContactEventViews.models.contact.emailAddresses | array of object |
Извлекает адреса электронной почты, связанные с контактом. |
|
EmailId
|
data.firmContactEventViews.models.contact.emailAddresses.emailId | string |
Идентификатор адреса электронной почты. |
|
Тип
|
data.firmContactEventViews.models.contact.emailAddresses.type | string |
Тип адреса электронной почты (электронная почта, FTPSite, веб-сайт). |
|
Usage
|
data.firmContactEventViews.models.contact.emailAddresses.usage | string |
Тип использования адреса электронной почты (AlternateBusiness, AlternateHome и т. д.). |
|
Адрес электронной почты
|
data.firmContactEventViews.models.contact.emailAddresses.address | string |
Адрес электронной почты. |
|
Этикетка
|
data.firmContactEventViews.models.contact.emailAddresses.label | string |
Метка адреса электронной почты. |
|
OwningContactId
|
data.firmContactEventViews.models.contact.emailAddresses.owningContactId | string |
Идентификатор контакта, которому принадлежит этот адрес электронной почты. |
|
IsGlobal
|
data.firmContactEventViews.models.contact.emailAddresses.isGlobal | boolean |
Указывает, является ли это глобальным адресом электронной почты. |
|
Телефонные номера
|
data.firmContactEventViews.models.contact.phoneNumbers | array of object |
Извлекает номера телефонов, связанные с контактом. |
|
PhoneId
|
data.firmContactEventViews.models.contact.phoneNumbers.phoneId | string |
Идентификатор номера телефона. |
|
Number
|
data.firmContactEventViews.models.contact.phoneNumbers.number | string |
Номер телефона. |
|
Этикетка
|
data.firmContactEventViews.models.contact.phoneNumbers.label | string |
Метка номера телефона. |
|
Тип
|
data.firmContactEventViews.models.contact.phoneNumbers.type | string |
Тип номера телефона (мобильный, телефон, пейджер и т. д.). |
|
Usage
|
data.firmContactEventViews.models.contact.phoneNumbers.usage | string |
Тип использования номера телефона (AlternateBusiness, AlternateHome и т. д.). |
|
OwningContactId
|
data.firmContactEventViews.models.contact.phoneNumbers.owningContactId | string |
Идентификатор контакта, которому принадлежит этот номер телефона. |
|
IsGlobal
|
data.firmContactEventViews.models.contact.phoneNumbers.isGlobal | boolean |
Указывает, является ли это глобальным номером телефона. |
|
Имя
|
data.firmContactEventViews.models.contact.name | string |
Имя контакта. |
Получение созданных или удаленных списков
Это действие извлекает списки, созданные или удаленные в InterAction+ в заданном диапазоне дат. Он предназначен для отслеживания разностных изменений для списков, помогая пользователям отслеживать обновления, синхронизировать данные или запускать подчиненные процессы на основе изменений.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Типы событий
|
eventTypes | True | array of string |
Тип события. |
|
С даты
|
start | date-time |
Указывает дату начала диапазона дат, включая сведения о часовом поясе. Дата начала по умолчанию — 90 дней назад, если она не указана. Если дата начала не указана, смещение даты начала определяется с указанной даты окончания, в противном случае используется значение UTC (нулевое смещение). Формат YYYY-MM-DDTHH:mm:ssZ. |
|
|
На сегодняшний день
|
end | date-time |
Указывает дату окончания диапазона дат, включая сведения о часовом поясе. Формат YYYY-MM-DDTHH:mm:ssZ. |
|
|
Пропустить
|
skip | integer |
Начальный индекс для разбиения на страницы. Default = 0 |
|
|
Лимит
|
limit | integer |
Максимальное количество извлекаемых элементов. По умолчанию = 100 |
|
|
Поле сортировки
|
field | True | string |
Указывает поле, используемое для сортировки событий. |
|
Направление сортировки
|
direction | string |
Указывает направление сортировки (по возрастанию или убыванию). По умолчанию = по возрастанию |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
TotalModels
|
data.listEventViews.totalModels | integer |
Общее количество найденных элементов. |
|
models
|
data.listEventViews.models | array of object |
Список событий списка. |
|
Тип события
|
data.listEventViews.models.eventType | string |
Представляет типы событий, которые могут возникать в списке. |
|
EventDate
|
data.listEventViews.models.eventDate | string |
Дата и время возникновения события. |
|
ListId
|
data.listEventViews.models.listId | string |
Идентификатор списка, в который произошло это событие. |
|
ListId
|
data.listEventViews.models.list.listId | string |
Идентификатор списка. |
|
Имя
|
data.listEventViews.models.list.name | string |
Имя списка. |
|
описание
|
data.listEventViews.models.list.description | string |
Описание списка. |
|
Идентификатор
|
data.listEventViews.models.list.listType.id | string |
Идентификатор типа папки. |
|
Активен
|
data.listEventViews.models.list.listType.isActive | boolean |
Указывает, активен ли тип папки. |
|
ListClass
|
data.listEventViews.models.list.listType.listClass | string |
Класс списка, связанного с этим типом папки. |
|
Имя
|
data.listEventViews.models.list.listType.name | string |
Имя типа папки. |
|
AllowedLinkInto
|
data.listEventViews.models.list.allowedLinkInto | boolean |
Указывает, могут ли записи быть связаны с этим списком. |
|
AllowedRemoveFrom
|
data.listEventViews.models.list.allowedRemoveFrom | boolean |
Указывает, можно ли удалить связанные записи из этого списка. |
|
AddAllowed
|
data.listEventViews.models.list.addAllowed | boolean |
Указывает, можно ли добавлять записи в этот список. |
|
DeleteAllowed
|
data.listEventViews.models.list.deleteAllowed | boolean |
Указывает, можно ли удалять записи из этого списка. |
|
AddActivityAllowed
|
data.listEventViews.models.list.addActivityAllowed | boolean |
Указывает, можно ли добавлять действия. |
|
AddNoteAllowed
|
data.listEventViews.models.list.addNoteAllowed | boolean |
Указывает, можно ли добавлять заметки. |
|
Имя владельца
|
data.listEventViews.models.list.ownerName | string |
Имя владельца этого списка. |
|
CreatorName
|
data.listEventViews.models.list.creatorName | string |
Имя создателя этого списка. |
|
AllowedContactEntity
|
data.listEventViews.models.list.allowedContactEntity | string |
Допустимые типы сущностей контакта для этого списка. |
|
IsAdministrator
|
data.listEventViews.models.list.isAdministrator | boolean |
isAdministrator |
Получение списка по идентификатору
Получение списка по идентификатору в InterAction+.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
id | True | string |
Идентификатор списка. |
|
Пропуск контактов
|
skip | integer |
Отправная точка для получения контактов. Значение по умолчанию равно 0. |
|
|
Ограничение контактов
|
limit | integer |
Количество контактов для получения из списков. Значение по умолчанию равно 100. |
|
|
Имя основного спонсора
|
primarySponsorName | string |
Список контактов с именем основного спонсора, который точно соответствует отображаемому имени контакта. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
data.list.id | string |
id |
|
имя
|
data.list.name | string |
имя |
|
описание
|
data.list.description | string |
описание |
|
id
|
data.list.listType.id | string |
id |
|
isActive
|
data.list.listType.isActive | boolean |
isActive |
|
listClass
|
data.list.listType.listClass | string |
listClass |
|
имя
|
data.list.listType.name | string |
имя |
|
allowedLinkInto
|
data.list.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.list.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
addAllowed
|
data.list.addAllowed | boolean |
addAllowed |
|
deleteAllowed
|
data.list.deleteAllowed | boolean |
deleteAllowed |
|
addActivityAllowed
|
data.list.addActivityAllowed | boolean |
addActivityAllowed |
|
addNoteAllowed
|
data.list.addNoteAllowed | boolean |
addNoteAllowed |
|
ownerName
|
data.list.ownerName | string |
ownerName |
|
creatorName
|
data.list.creatorName | string |
creatorName |
|
allowedContactEntity
|
data.list.allowedContactEntity | string |
allowedContactEntity |
|
isAdministrator
|
data.list.isAdministrator | boolean |
isAdministrator |
|
totalModels
|
data.list.contacts.totalModels | integer |
totalModels |
|
models
|
data.list.contacts.models | array of object |
models |
|
id
|
data.list.contacts.models.id | string |
id |
|
title
|
data.list.contacts.models.title | string |
title |
|
номер телефона
|
data.list.contacts.models.phoneNumber | string |
номер телефона |
|
адрес электронной почты
|
data.list.contacts.models.emailAddress | string |
адрес электронной почты |
|
отображаемое имя
|
data.list.contacts.models.displayName | string |
отображаемое имя |
|
companyName
|
data.list.contacts.models.companyName | string |
companyName |
|
companyId
|
data.list.contacts.models.companyId | string |
companyId |
|
contactEntity
|
data.list.contacts.models.contactEntity | string |
contactEntity |
|
отображаемое имя
|
data.list.contacts.models.sponsors.displayName | string |
отображаемое имя |
|
fullName
|
data.list.contacts.models.sponsors.fullName | string |
fullName |
|
id
|
data.list.contacts.models.sponsors.id | string |
id |
|
isPrimary
|
data.list.contacts.models.sponsors.isPrimary | boolean |
isPrimary |
Получение списка по имени
Получение списка по имени в InterAction+.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя списка
|
filterByName | True | string |
Имя списка (извлекает список, который точно соответствует указанному имени). |
|
Пропуск контактов
|
skip | integer |
Отправная точка для получения контактов. Значение по умолчанию равно 0. |
|
|
Ограничение контактов
|
limit | integer |
Количество контактов для получения из списков. Значение по умолчанию равно 100. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalModels
|
data.lists.totalModels | integer |
totalModels |
|
models
|
data.lists.models | array of object |
models |
|
id
|
data.lists.models.id | string |
id |
|
имя
|
data.lists.models.name | string |
имя |
|
описание
|
data.lists.models.description | string |
описание |
|
id
|
data.lists.models.listType.id | string |
id |
|
isActive
|
data.lists.models.listType.isActive | boolean |
isActive |
|
listClass
|
data.lists.models.listType.listClass | string |
listClass |
|
имя
|
data.lists.models.listType.name | string |
имя |
|
allowedLinkInto
|
data.lists.models.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.lists.models.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
addAllowed
|
data.lists.models.addAllowed | boolean |
addAllowed |
|
deleteAllowed
|
data.lists.models.deleteAllowed | boolean |
deleteAllowed |
|
addActivityAllowed
|
data.lists.models.addActivityAllowed | boolean |
addActivityAllowed |
|
addNoteAllowed
|
data.lists.models.addNoteAllowed | boolean |
addNoteAllowed |
|
ownerName
|
data.lists.models.ownerName | string |
ownerName |
|
creatorName
|
data.lists.models.creatorName | string |
creatorName |
|
allowedContactEntity
|
data.lists.models.allowedContactEntity | string |
allowedContactEntity |
|
isAdministrator
|
data.lists.models.isAdministrator | boolean |
isAdministrator |
|
totalModels
|
data.lists.models.contacts.totalModels | integer |
totalModels |
|
models
|
data.lists.models.contacts.models | array of object |
models |
|
id
|
data.lists.models.contacts.models.id | string |
id |
|
title
|
data.lists.models.contacts.models.title | string |
title |
|
номер телефона
|
data.lists.models.contacts.models.phoneNumber | string |
номер телефона |
|
адрес электронной почты
|
data.lists.models.contacts.models.emailAddress | string |
адрес электронной почты |
|
отображаемое имя
|
data.lists.models.contacts.models.displayName | string |
отображаемое имя |
|
companyName
|
data.lists.models.contacts.models.companyName | string |
companyName |
|
companyId
|
data.lists.models.contacts.models.companyId | string |
companyId |
|
contactEntity
|
data.lists.models.contacts.models.contactEntity | string |
contactEntity |
|
отображаемое имя
|
data.lists.models.contacts.models.sponsors.displayName | string |
отображаемое имя |
|
fullName
|
data.lists.models.contacts.models.sponsors.fullName | string |
fullName |
|
id
|
data.lists.models.contacts.models.sponsors.id | string |
id |
|
isPrimary
|
data.lists.models.contacts.models.sponsors.isPrimary | boolean |
isPrimary |
Получение списков
Получение списков из InterAction+ с рабочим списком, маркетинговым списком и маркетингомListWithSponsorship.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Класс List
|
listClass | string |
Тип классификации списка. |
|
|
Пропустить списки
|
skip | integer |
Начальная точка получения списков. Значение по умолчанию равно 0. |
|
|
Ограничения списков
|
limit | integer |
Количество извлекаемых списков. Значение по умолчанию равно 100. |
|
|
Имя списка
|
filterByName | string |
Имя списка (извлекает списки, содержащие указанное имя). |
Возвращаемое значение
- Тело
- ListResponse
Создание действия
Создание действия в InterAction+.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип действия
|
typeId | True | string |
Тип действия для нового действия. |
|
Дата действия
|
activityDate | True | string |
Дата действия в строковом формате. Он принимает формат datetime в ггГГ-MM-DD HH:mm:ss. |
|
Тема
|
subject | True | string |
Тема действия. |
|
Сводка
|
summary | string |
Сводка действия. |
|
|
Идентификаторы связанных сущностей
|
linkedEntityIds | True | array of string |
Идентификатор контакта, представляющий сущности, связанные с действием. Он принимает формат GUID 000000000-0000-0000-0000-0000000000000000. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
data.addActivity.id | string |
id |
Создание контакта пользователя
Создание контакта пользователя в InterAction+.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя (Первое имя)
|
firstName | string |
Имя. |
|
|
Второе имя
|
middleName | string |
По промежуточному имени. |
|
|
Фамилия
|
lastName | True | string |
Фамилия. |
|
GoesBy
|
goesBy | string |
Общее имя. |
|
|
Название
|
title | string |
Название (г-н, миссис, доктор и т. д.). |
|
|
Электронная почта
|
emailAddress | string |
Адрес электронной почты для бизнеса. |
|
|
Название компании
|
companyName | string |
Название компании. |
|
|
Должность
|
jobTitle | string |
Название задания. |
|
|
Прямой или основной телефон
|
primaryPhone | string |
Прямой или основной телефон. |
|
|
Страна
|
country | string |
Страна бизнес-адреса. |
|
|
Улица
|
street | string |
Улица делового адреса. |
|
|
Город
|
city | string |
Город бизнес-адреса. |
|
|
Административное подразделение/ штат/ регион/ округ/ провинция
|
administrativeDivision | string |
Административное подразделение, штат, регион, регион или провинция. |
|
|
Почтовый индекс
|
postalCode | string |
Почтовый индекс бизнес-адреса, если ваша страна не использует почтовый индекс, оставьте его пустым. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
data.addPerson.status | string |
статус |
|
id
|
data.addPerson.item.id | string |
id |
|
Имя
|
data.addPerson.item.firstName | string |
Имя |
|
lastName
|
data.addPerson.item.lastName | string |
lastName |
|
goesBy
|
data.addPerson.item.goesBy | string |
goesBy |
|
currentJobTitle
|
data.addPerson.item.currentJobTitle | string |
currentJobTitle |
|
Телефонные номера
|
data.addPerson.item.phoneNumbers | array of object |
Телефонные номера |
|
id
|
data.addPerson.item.phoneNumbers.id | string |
id |
|
число/номер
|
data.addPerson.item.phoneNumbers.number | string |
число/номер |
|
label
|
data.addPerson.item.phoneNumbers.label | string |
label |
|
type
|
data.addPerson.item.phoneNumbers.type | string |
type |
|
использование
|
data.addPerson.item.phoneNumbers.usage | string |
использование |
|
emailАдреса
|
data.addPerson.item.emailAddresses | array of object |
emailАдреса |
|
id
|
data.addPerson.item.emailAddresses.id | string |
id |
|
type
|
data.addPerson.item.emailAddresses.type | string |
type |
|
использование
|
data.addPerson.item.emailAddresses.usage | string |
использование |
|
address
|
data.addPerson.item.emailAddresses.address | string |
address |
|
label
|
data.addPerson.item.emailAddresses.label | string |
label |
|
validationErrors
|
data.addPerson.validationErrors | array of |
validationErrors |
Удаление контактов из списка
Удаление контактов из списка в InterAction+.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификаторы контактов
|
contactIds | True | array of string |
Идентификатор контакта для удаления из списка. |
|
Идентификатор списка
|
listId | True | string |
Идентификатор списка для удаления контактов. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ResultText
|
data.removeContactsFromList.resultText | string |
ResultText |
|
pendingContactsEffected
|
data.removeContactsFromList.pendingContactsEffected | integer |
pendingContactsEffected |
|
contactsEffected
|
data.removeContactsFromList.contactsEffected | integer |
contactsEffected |
Удаление материи
Удалите вопрос из InterAction+.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор материи
|
id | True | string |
Идентификатор материи |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Материя удалена
|
data.removeMatter | boolean |
removeMatter |
Удаление финансовых средств в отношении вопросов
Удалите финансовые данные из InterAction+.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор материальных финансовых средств
|
matterFinancialId | string |
Идентификатор удаляемых финансовых данных. При условии никакие другие критерии не могут быть указаны. |
|
|
Идентификатор клиента
|
clientId | string |
Идентификатор контакта клиента с данными о финансовых ресурсах, которые необходимо удалить. При условии срок окончания периода необходимо удалить данные о финансовых ресурсах клиента и периода. |
|
|
Дата окончания периода
|
periodEndDate | string |
Срок окончания данных о финансовых ресурсах, которые необходимо удалить. Формат YYYY-MM-DD. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Успешно
|
data.removeMatterFinancials.isSuccessful | boolean |
Материальные финансы удалены. |
|
TotalMatterFinancialsAffected
|
data.removeMatterFinancials.matterFinancialsAffected | integer |
Число затронутых финансовых средств. |
|
Ошибки проверки
|
data.removeMatterFinancials.validationErrors | array of |
Коллекция ошибок проверки, возникших во время операции. |
Определения
ListResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
skip
|
data.lists.skip | integer |
skip |
|
limit
|
data.lists.limit | integer |
limit |
|
totalModels
|
data.lists.totalModels | integer |
totalModels |
|
models
|
data.lists.models | array of object |
models |
|
id
|
data.lists.models.id | string |
id |
|
имя
|
data.lists.models.name | string |
имя |
|
описание
|
data.lists.models.description | string |
описание |
|
id
|
data.lists.models.listType.id | string |
id |
|
isActive
|
data.lists.models.listType.isActive | boolean |
isActive |
|
listClass
|
data.lists.models.listType.listClass | string |
listClass |
|
имя
|
data.lists.models.listType.name | string |
имя |
|
allowedLinkInto
|
data.lists.models.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.lists.models.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
addAllowed
|
data.lists.models.addAllowed | boolean |
addAllowed |
|
deleteAllowed
|
data.lists.models.deleteAllowed | boolean |
deleteAllowed |
|
addActivityAllowed
|
data.lists.models.addActivityAllowed | boolean |
addActivityAllowed |
|
addNoteAllowed
|
data.lists.models.addNoteAllowed | boolean |
addNoteAllowed |
|
ownerName
|
data.lists.models.ownerName | string |
ownerName |
|
creatorName
|
data.lists.models.creatorName | string |
creatorName |
|
allowedContactEntity
|
data.lists.models.allowedContactEntity | string |
allowedContactEntity |
|
isAdministrator
|
data.lists.models.isAdministrator | boolean |
isAdministrator |