InterAction (预览版)
LexisNexis InterAction+ 是专为律师事务所设计的综合性 CRM(客户关系管理)解决方案。 利用此连接器将第三方应用程序与 InterAction+ 集成,以自动化工作、简化任务和加强客户端关系。
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 政府区域 - Azure 中国区域 - 美国国防部(DoD) |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 联系人 | |
|---|---|
| Name | 互动 |
| URL | https://www.lexisnexis.com/en-us/products/interaction/default.page |
| support@interaction.com |
| 连接器元数据 | |
|---|---|
| 发布者 | LexisNexis 法律和专业版 |
| 网站 | https://www.lexisnexis.com/en-us/products/interaction/default.page |
| 隐私策略 | https://www.lexisnexis.com/en-us/terms/privacy-policy.page |
| 类别 | Marketing |
InterAction+
LexisNexis InterAction+ 是专为律师事务所设计的综合性 CRM(客户关系管理)解决方案。 利用此连接器将第三方应用程序与 InterAction+ 集成,以自动化工作、简化任务和加强客户端关系。
发布者:LexisNexis
先决条件
需要满足以下条件才能继续作:
- Microsoft PowerAutomate/Flow 计划。
- 具有 InterAction+ 管理员访问权限的帐户。
- InterAction+ 应用 URL(例如
https://example.apps.interaction.com或 https://us.apps.interaction.com/example)和区域(美国、AU 或欧盟)。 若要详细了解 InterAction+ 和服务,请与我们联系 support@interaction.com。
支持的作
连接器支持以下作:
-
Get Lists:从 InterAction+ 获取所有列表,其中包括 workingList、marketingList 和 marketingListWithSponsorship。 -
Get List By Id:按 InterAction+中的列表 ID 获取列表详细信息。 -
Get List By Name:按 InterAction+中的列表名称获取列表详细信息。 -
Get Additional Field Definitions And Values:从 Interaction+获取列表的其他字段定义和值。 -
Add or Update Additional field values for Contact:在 Interaction+ 中添加或更新联系人的其他字段值。 -
Get Contact By Id:在 InterAction+中按 ID 获取联系人详细信息。 -
Create Person Contact:在 InterAction+中创建人员联系人。 -
Update Person Contact:在 InterAction+中更新公共联系人。 -
Search Person Contact:在 InterAction+中基于名字、姓氏和电子邮件地址筛选器搜索人员联系人。 -
Add Contacts to Lists:向 InterAction+中的一个或多个列表添加一个或多个联系人。 对于多个联系人或列表,请切换输入模式。 -
Remove Contacts from List:从 InterAction+的列表中删除联系人。 -
Create Activity:在 InterAction+中创建活动。 -
Update Activity:在 Interaction+ 中编辑或更新联系人的活动字段值。 -
Get List Contact Membership Changes:此作检索已添加到给定日期范围内或从指定列表中移除的联系人。 它旨在捕获联系人列表中的增量更改,帮助用户根据修改监视更新、同步数据或触发下游进程。 -
Get Created or Removed Lists:此作检索在给定日期范围内在 InterAction+ 中创建或删除的列表。 它旨在捕获列表的增量更改,帮助用户基于修改监视更新、同步数据或触发下游进程。 -
Get Created or Removed Contacts:此作检索在给定日期范围内在 InterAction+ 中创建或删除的联系人。 它旨在捕获联系人的增量更改,帮助用户根据修改监视更新、同步数据或触发下游进程。 -
Get Updated Contacts:此作检索在给定日期范围内在 InterAction+ 中更新的联系人。 它旨在捕获联系人的增量更改,帮助用户根据修改监视更新、同步数据或触发下游进程。
获取凭据
通过联系 InterAction+ 支持请求访问权限 (support@interaction.com)
常见错误和补救措施
下面是在使用连接器时可能遇到的一些问题:
-
Error 400:发出错误的请求时显示,这意味着输入参数错误。 -
Error 401:未经授权访问请求的信息时显示。 -
Error 429:请求过多错误,指示客户端应用程序停止发送请求,因为它们目前没有足够的资源来接受请求。
Support
如需进一步支持,请联系 support@interaction.com
正在创建连接
连接器支持以下身份验证类型:
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用:所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| 应用程序 URL | 字符串 | InterAction+ 应用程序 URL(例如 https://us.apps.interaction.com/tpcqa) | True |
| 区域 | 字符串 | 选择区域 | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 从列表中删除联系人 |
从 InterAction+中的列表中删除联系人。 |
| 创建人员联系人 |
在 InterAction+中创建人员联系人。 |
| 创建活动 |
在 InterAction+中创建活动。 |
| 向列表添加联系人 |
向 InterAction+中的一个或多个列表添加一个或多个联系人。 对于多个联系人或列表,请切换输入模式。 |
| 按 ID 获取列表 |
在 InterAction+ 中按 ID 获取列表。 |
| 按 ID 获取联系人 |
通过 ID 获取 Contact 以及 InterAction+ 中的其他字段值。 |
| 按名称获取列表 |
在 InterAction+ 中按名称获取列表。 |
| 搜索人员联系人 |
根据名字、姓氏和电子邮件地址搜索人员联系人。 |
| 更新人员联系人 |
在 InterAction+中更新人员联系人。 |
| 更新活动 |
在 Interaction+ 中编辑或更新联系人的活动字段值。 |
| 添加或更新联系人的其他字段值 |
在 InterAction+ 中添加或更新联系人的其他字段值。 |
| 获取其他字段定义和值 |
从 InterAction+获取列表的其他字段定义和值。 |
| 获取列表 |
从 InterAction+ 获取列表,其中包括 workingList、marketingList 和 marketingListWithSponsorship。 |
| 获取列表联系人成员身份更改 |
此作检索已添加到给定日期范围内或从指定列表中移除的联系人。 它旨在捕获联系人列表中的增量更改,帮助用户根据修改监视更新、同步数据或触发下游进程。 |
| 获取创建或删除的列表 |
此作检索在给定日期范围内在 InterAction+ 中创建或删除的列表。 它旨在捕获列表的增量更改,帮助用户根据修改监视更新、同步数据或触发下游进程。 |
| 获取已创建或删除的联系人 |
此作检索在给定日期范围内在 InterAction+ 中创建或删除的联系人。 它旨在捕获联系人的增量更改,帮助用户根据修改监视更新、同步数据或触发下游进程。 |
| 获取更新的联系人 |
此作检索在给定日期范围内在 InterAction+ 中更新的联系人。 它旨在捕获联系人的增量更改,帮助用户根据修改监视更新、同步数据或触发下游进程。 |
从列表中删除联系人
从 InterAction+中的列表中删除联系人。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
联系人 ID
|
contactIds | True | array of string |
要从列表中删除的联系人 ID。 |
|
列表 ID
|
listId | True | string |
要从中删除联系人的列表 ID。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
resultText
|
data.removeContactsFromList.resultText | string |
resultText |
|
pendingContactsEffected
|
data.removeContactsFromList.pendingContactsEffected | integer |
pendingContactsEffected |
|
contactsEffected
|
data.removeContactsFromList.contactsEffected | integer |
contactsEffected |
创建人员联系人
在 InterAction+中创建人员联系人。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
名字
|
firstName | string |
名字。 |
|
|
中间名
|
middleName | string |
中间名称。 |
|
|
姓氏
|
lastName | True | string |
姓。 |
|
GoesBy
|
goesBy | string |
公用名。 |
|
|
Title
|
title | string |
标题(夫人、夫人、博士等)。 |
|
|
电子邮件地址
|
emailAddress | string |
业务电子邮件地址。 |
|
|
公司名称
|
companyName | string |
公司名称。 |
|
|
职务
|
jobTitle | string |
职务。 |
|
|
直接/主要电话
|
primaryPhone | string |
直接/主要电话。 |
|
|
国家
|
country | string |
业务地址的国家/地区。 |
|
|
街道
|
street | string |
商业地址的街道。 |
|
|
City
|
city | string |
商务地址之城。 |
|
|
行政区/州/地区/区/省
|
administrativeDivision | string |
行政区/州/地区/区/省。 |
|
|
邮政编码
|
postalCode | string |
如果你的国家/地区不使用邮政编码,则商务地址的邮政编码将保留为空。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
状态
|
data.addPerson.status | string |
状态 |
|
id
|
data.addPerson.item.id | string |
id |
|
firstName
|
data.addPerson.item.firstName | string |
firstName |
|
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 |
数字 |
|
标签
|
data.addPerson.item.phoneNumbers.label | string |
标签 |
|
类型
|
data.addPerson.item.phoneNumbers.type | string |
类型 |
|
使用情况
|
data.addPerson.item.phoneNumbers.usage | string |
使用情况 |
|
电子邮件地址
|
data.addPerson.item.emailAddresses | array of object |
电子邮件地址 |
|
id
|
data.addPerson.item.emailAddresses.id | string |
id |
|
类型
|
data.addPerson.item.emailAddresses.type | string |
类型 |
|
使用情况
|
data.addPerson.item.emailAddresses.usage | string |
使用情况 |
|
address
|
data.addPerson.item.emailAddresses.address | string |
address |
|
标签
|
data.addPerson.item.emailAddresses.label | string |
标签 |
|
validationErrors
|
data.addPerson.validationErrors | array of |
validationErrors |
创建活动
在 InterAction+中创建活动。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
活动类型
|
typeId | True | string |
新活动的活动类型。 |
|
活动日期
|
activityDate | True | string |
字符串格式的活动日期。 它接受 YYYY-MM-DD HH:mm:ss 的日期/时间格式。 |
|
Subject
|
subject | True | string |
活动的主题。 |
|
概要
|
summary | string |
活动的摘要。 |
|
|
链接实体 ID
|
linkedEntityIds | True | array of string |
联系人 ID,表示链接到活动的实体。 它接受 GUID 格式 00000000-0000-0000-0000-0000000000000。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
data.addActivity.id | string |
id |
向列表添加联系人
向 InterAction+中的一个或多个列表添加一个或多个联系人。 对于多个联系人或列表,请切换输入模式。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
列表 ID
|
listIds | True | array of string |
要添加联系人的列表 ID |
|
联系人 ID
|
contactIds | True | array of string |
要添加到列表的联系人 ID |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
totalCount
|
data.addContactsToLists.totalCount | integer |
totalCount |
|
successCount
|
data.addContactsToLists.successCount | integer |
successCount |
|
resultText
|
data.addContactsToLists.resultText | string |
resultText |
按 ID 获取列表
在 InterAction+ 中按 ID 获取列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
列表 ID
|
id | True | string |
列表 ID。 |
|
跳过联系人
|
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 |
电子邮件地址 |
|
displayName
|
data.list.contacts.models.displayName | string |
displayName |
|
companyName
|
data.list.contacts.models.companyName | string |
companyName |
|
companyId
|
data.list.contacts.models.companyId | string |
companyId |
|
contactEntity
|
data.list.contacts.models.contactEntity | string |
contactEntity |
|
displayName
|
data.list.contacts.models.sponsors.displayName | string |
displayName |
|
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 |
按 ID 获取联系人
通过 ID 获取 Contact 以及 InterAction+ 中的其他字段值。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
联系人 ID
|
contactid | True | string |
联系人 ID。 |
|
列表 ID
|
listid | True | string |
列表 ID 不能为 null,默认值设置为 00000000-0000-0000-0000-0000000000000。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
contactId
|
data.contact.contactId | string |
contactId |
|
displayName
|
data.contact.displayName | string |
displayName |
|
title
|
data.contact.title | string |
title |
|
firstName
|
data.contact.firstName | string |
firstName |
|
middleName (中间名称)
|
data.contact.middleName | string |
middleName (中间名称) |
|
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 |
|
地址
|
data.contact.addresses | array of object | |
|
id
|
data.contact.addresses.id | string |
addressId |
|
街道
|
data.contact.addresses.street | string |
街道 |
|
城市
|
data.contact.addresses.city | string |
城市 |
|
administrativeDivision
|
data.contact.addresses.administrativeDivision | string |
administrativeDivision |
|
country
|
data.contact.addresses.country | string |
country |
|
postalCode
|
data.contact.addresses.postalCode | string |
postalCode |
|
类型
|
data.contact.addresses.type | string |
类型 |
|
使用情况
|
data.contact.addresses.usage | string |
使用情况 |
|
能见度
|
data.contact.visibility | string |
能见度 |
|
电子邮件地址
|
data.contact.emailAddresses | array of object |
电子邮件地址 |
|
emailId
|
data.contact.emailAddresses.emailId | string |
emailId |
|
类型
|
data.contact.emailAddresses.type | string |
类型 |
|
使用情况
|
data.contact.emailAddresses.usage | string |
使用情况 |
|
address
|
data.contact.emailAddresses.address | string |
address |
|
标签
|
data.contact.emailAddresses.label | string |
标签 |
|
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 |
数字 |
|
标签
|
data.contact.phoneNumbers.label | string |
标签 |
|
类型
|
data.contact.phoneNumbers.type | string |
类型 |
|
使用情况
|
data.contact.phoneNumbers.usage | string |
使用情况 |
|
owningContactId
|
data.contact.phoneNumbers.owningContactId | string |
owningContactId |
|
isGlobal (全球)
|
data.contact.phoneNumbers.isGlobal | boolean |
isGlobal (全球) |
|
跳过
|
data.contact.activities.skip | integer |
跳过 |
|
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 |
|
类型
|
data.contact.activities.models.type | string |
类型 |
|
类型 Id
|
data.contact.activities.models.typeId | string |
类型 Id |
|
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 |
主题 |
|
摘要
|
data.contact.activities.models.summary | string |
摘要 |
|
位置
|
data.contact.activities.models.location | string |
位置 |
|
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 |
描述 |
|
类型
|
data.contact.lists.models.type | string |
类型 |
|
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 |
赞助商 |
|
sponsorId
|
data.contact.lists.models.sponsors.sponsorId | string |
sponsorId |
|
displayName
|
data.contact.lists.models.sponsors.displayName | string |
displayName |
|
isPrimary
|
data.contact.lists.models.sponsors.isPrimary | boolean |
isPrimary |
|
fullName
|
data.contact.lists.models.sponsors.fullName | string |
fullName |
按名称获取列表
在 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 |
电子邮件地址 |
|
displayName
|
data.lists.models.contacts.models.displayName | string |
displayName |
|
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 |
|
displayName
|
data.lists.models.contacts.models.sponsors.displayName | string |
displayName |
|
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 |
搜索人员联系人
根据名字、姓氏和电子邮件地址搜索人员联系人。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
按电子邮件地址搜索
|
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 |
|
displayName
|
data.searchFirmContacts.models.displayName | string |
displayName |
|
contactEntity
|
data.searchFirmContacts.models.contactEntity | string |
contactEntity |
|
title
|
data.searchFirmContacts.models.title | string |
title |
|
firstName
|
data.searchFirmContacts.models.firstName | string |
firstName |
|
middleName (中间名称)
|
data.searchFirmContacts.models.middleName | string |
middleName (中间名称) |
|
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 |
|
地址
|
data.searchFirmContacts.models.addresses | array of object |
地址 |
|
addressID
|
data.searchFirmContacts.models.addresses.addressID | string |
addressID |
|
街道
|
data.searchFirmContacts.models.addresses.street | string |
街道 |
|
城市
|
data.searchFirmContacts.models.addresses.city | string |
城市 |
|
administrativeDivision
|
data.searchFirmContacts.models.addresses.administrativeDivision | string |
administrativeDivision |
|
country
|
data.searchFirmContacts.models.addresses.country | string |
country |
|
postalCode
|
data.searchFirmContacts.models.addresses.postalCode | string |
postalCode |
|
类型
|
data.searchFirmContacts.models.addresses.type | string |
类型 |
|
使用情况
|
data.searchFirmContacts.models.addresses.usage | string |
使用情况 |
|
能见度
|
data.searchFirmContacts.models.visibility | string |
能见度 |
|
电子邮件地址
|
data.searchFirmContacts.models.emailAddresses | array of object |
电子邮件地址 |
|
emailId
|
data.searchFirmContacts.models.emailAddresses.emailId | string |
emailId |
|
类型
|
data.searchFirmContacts.models.emailAddresses.type | string |
类型 |
|
使用情况
|
data.searchFirmContacts.models.emailAddresses.usage | string |
使用情况 |
|
address
|
data.searchFirmContacts.models.emailAddresses.address | string |
address |
|
标签
|
data.searchFirmContacts.models.emailAddresses.label | string |
标签 |
|
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 |
数字 |
|
标签
|
data.searchFirmContacts.models.phoneNumbers.label | string |
标签 |
|
类型
|
data.searchFirmContacts.models.phoneNumbers.type | string |
类型 |
|
使用情况
|
data.searchFirmContacts.models.phoneNumbers.usage | string |
使用情况 |
|
owningContactId
|
data.searchFirmContacts.models.phoneNumbers.owningContactId | string |
owningContactId |
|
isGlobal (全球)
|
data.searchFirmContacts.models.phoneNumbers.isGlobal | boolean |
isGlobal (全球) |
|
跳过
|
data.searchFirmContacts.models.activities.skip | integer |
跳过 |
|
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 |
|
类型
|
data.searchFirmContacts.models.activities.models.type | string |
类型 |
|
类型 Id
|
data.searchFirmContacts.models.activities.models.typeId | string |
类型 Id |
|
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 |
主题 |
|
摘要
|
data.searchFirmContacts.models.activities.models.summary | string |
摘要 |
|
位置
|
data.searchFirmContacts.models.activities.models.location | string |
位置 |
|
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 |
描述 |
|
类型
|
data.searchFirmContacts.models.lists.models.type | string |
类型 |
|
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 |
赞助商 |
|
sponsorId
|
data.searchFirmContacts.models.lists.models.sponsors.sponsorId | string |
sponsorId |
|
displayName
|
data.searchFirmContacts.models.lists.models.sponsors.displayName | string |
displayName |
|
isPrimary
|
data.searchFirmContacts.models.lists.models.sponsors.isPrimary | boolean |
isPrimary |
|
fullName
|
data.searchFirmContacts.models.lists.models.sponsors.fullName | string |
fullName |
更新人员联系人
在 InterAction+中更新人员联系人。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
联系人 ID
|
id | True | string |
联系人的联系人 ID。 |
|
Title
|
title | string |
标题(夫人、夫人、博士等)。 |
|
|
名字
|
firstName | string |
名字。 |
|
|
中间名
|
middleName | string |
中间名称。 |
|
|
姓氏
|
lastName | True | string |
人员的姓氏。 |
|
GoesBy
|
goesBy | string |
公用名。 |
|
|
职务
|
jobTitle | string |
职务。 |
|
|
街道
|
street | string |
街。 |
|
|
City
|
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
|
activityId | True | string |
活动 ID,它接受 GUID 格式类型 0000000-0000-0000-0000-0000000000000。 |
|
活动类型
|
typeId | True | string |
更新活动的活动类型。 |
|
活动日期
|
activityDate | string |
字符串格式的活动日期。 它接受 YYYY-MM-DD HH:mm:ss 的日期/时间格式。 |
|
|
Subject
|
subject | string |
活动的主题。 |
|
|
概要
|
summary | string |
活动的摘要。 |
|
|
链接实体 ID
|
linkedEntityIds | True | array of string |
联系人 ID,表示链接到活动的实体。 它接受 GUID 格式 00000000-0000-0000-0000-0000000000000。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
validationErrors
|
data.updateActivity.validationErrors | array of |
validationErrors |
|
id
|
data.updateActivity.item.id | string |
id |
|
类型
|
data.updateActivity.item.type | string |
类型 |
|
类型 Id
|
data.updateActivity.item.typeId | string |
类型 Id |
|
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 |
主题 |
|
摘要
|
data.updateActivity.item.summary | string |
摘要 |
|
位置
|
data.updateActivity.item.location | string |
位置 |
|
关于
|
data.updateActivity.item.regarding | string |
关于 |
添加或更新联系人的其他字段值
在 InterAction+ 中添加或更新联系人的其他字段值。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
联系人 ID
|
contactId | True | string |
要更新的联系人 ID。 |
|
字段 ID
|
fieldId | True | string |
其他字段的字段 ID。 |
|
价值
|
value | True | string |
其他字段的值。 |
|
值 ID
|
valueId | string |
仅需要值 ID 才能更新现有值。 对于新值,请将此字段留空。 |
|
|
上次编辑日期
|
lastEditDate | string |
上次编辑日期仅需要更新现有值。 对于新值,请将此字段留空。 |
|
|
字段数据类型
|
fieldDataType | True | string |
其他字段的数据类型。 允许的数据类型为整数、文本、布尔值、十进制、用户、日期和列表。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
models
|
data.updateListContactAdditionalFields.models | array of object |
models |
|
failureReason (失败原因)
|
data.updateListContactAdditionalFields.models.failureReason | string |
failureReason (失败原因) |
|
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+获取列表的其他字段定义和值。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
列表 ID
|
id | True | string |
列表 ID。 |
|
跳过联系人
|
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 |
电子邮件地址 |
|
displayName
|
data.list.contacts.models.displayName | string |
displayName |
|
companyName
|
data.list.contacts.models.companyName | string |
companyName |
|
companyId
|
data.list.contacts.models.companyId | string |
companyId |
|
contactEntity
|
data.list.contacts.models.contactEntity | string |
contactEntity |
|
displayName
|
data.list.contacts.models.sponsors.displayName | string |
displayName |
|
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 |
|
格式
|
data.list.contacts.models.additionalFieldValues.models.format | string |
格式 |
|
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 |
获取列表
从 InterAction+ 获取列表,其中包括 workingList、marketingList 和 marketingListWithSponsorship。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
List 类
|
listClass | string |
列表的分类类型。 |
|
|
跳过列表
|
skip | integer |
检索列表的起点。 默认值设置为 0。 |
|
|
限制列表
|
limit | integer |
要检索的列表数。 默认值设置为 100。 |
|
|
列表名称
|
filterByName | string |
列表名称(检索包含指定名称的列表)。 |
返回
- Body
- ListResponse
获取列表联系人成员身份更改
此作检索已添加到给定日期范围内或从指定列表中移除的联系人。 它旨在捕获联系人列表中的增量更改,帮助用户根据修改监视更新、同步数据或触发下游进程。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
事件类型
|
eventTypes | True | array of string |
事件类型 |
|
起始日期
|
start | date-time |
指定日期范围的开始日期,包括时区信息。 开始日期默认为 90 天前(如果未提供)。 如果未提供开始日期,则开始日期偏移量根据指定的结束日期确定,否则默认为 UTC(零偏移量)。 日期格式 YYYY-MM-DDTHH:mm:ssZ。 |
|
|
截止日期
|
end | date-time |
指定日期范围的结束日期,包括时区信息。 日期格式 YYYY-MM-DDTHH:mm:ssZ。 |
|
|
列表 ID
|
listIds | True | array of string |
检索指定列表 ID 的联系人添加或删除事件。 |
|
跳过
|
skip | integer |
分页的起始索引。 默认值 = 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 |
发生此事件的列表的 ID。 |
|
联系人 ID
|
data.listEventViews.models.contactId | string |
添加到列表中或删除的联系人的 ID。 |
|
联系人 ID
|
data.listEventViews.models.contact.contactId | string |
联系人的 ID。 |
|
显示名称
|
data.listEventViews.models.contact.displayName | string |
联系人的显示名称。 |
|
ContactEntity
|
data.listEventViews.models.contact.contactEntity | string |
联系人的实体类型。 |
|
Title
|
data.listEventViews.models.contact.title | string |
联系人的标题。 |
|
名字
|
data.listEventViews.models.contact.firstName | string |
联系人的名字。 |
|
中间名
|
data.listEventViews.models.contact.middleName | string |
联系人的中间名称。 |
|
LastName
|
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 |
公司的 ID。 |
|
地址
|
data.listEventViews.models.contact.addresses | array of object |
检索与联系人关联的地址。 |
|
AddressId
|
data.listEventViews.models.contact.addresses.addressID | string |
地址的 ID。 |
|
街道
|
data.listEventViews.models.contact.addresses.street | string |
地址的街道名称。 |
|
City
|
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 |
联系人的可见性设置。 |
|
电子邮件地址
|
data.listEventViews.models.contact.emailAddresses | array of object |
检索与联系人关联的电子邮件地址。 |
|
EmailId
|
data.listEventViews.models.contact.emailAddresses.emailId | string |
电子邮件地址的 ID。 |
|
类型
|
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 |
拥有此电子邮件地址的联系人的 ID。 |
|
IsGlobal
|
data.listEventViews.models.contact.emailAddresses.isGlobal | boolean |
指示此地址是否为全局电子邮件地址。 |
|
电话号码
|
data.listEventViews.models.contact.phoneNumbers | array of object |
检索与联系人关联的电话号码。 |
|
PhoneId
|
data.listEventViews.models.contact.phoneNumbers.phoneId | string |
电话号码的 ID。 |
|
编号
|
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 |
拥有此电话号码的联系人的 ID。 |
|
IsGlobal
|
data.listEventViews.models.contact.phoneNumbers.isGlobal | boolean |
指示此号码是否为全局电话号码。 |
|
Name
|
data.listEventViews.models.contact.name | string |
联系人的名称。 |
|
ListID
|
data.listEventViews.models.list.listId | string |
列表的 ID。 |
|
Name
|
data.listEventViews.models.list.name | string |
列表的名称。 |
|
Description
|
data.listEventViews.models.list.description | string |
列表的说明。 |
|
Id
|
data.listEventViews.models.list.listType.id | string |
列表类型的 ID。 |
|
IsActive
|
data.listEventViews.models.list.listType.isActive | boolean |
指示列表类型是否处于活动状态。 |
|
ListClass
|
data.listEventViews.models.list.listType.listClass | string |
与此列表类型关联的列表类。 |
|
Name
|
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 |
指示是否可以添加备注。 |
|
OwnerName
|
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 |
分页的起始索引。 默认值 = 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 |
发生此事件的列表的 ID。 |
|
ListID
|
data.listEventViews.models.list.listId | string |
列表的 ID。 |
|
Name
|
data.listEventViews.models.list.name | string |
列表的名称。 |
|
描述
|
data.listEventViews.models.list.description | string |
列表的说明。 |
|
Id
|
data.listEventViews.models.list.listType.id | string |
文件夹类型的 ID。 |
|
IsActive
|
data.listEventViews.models.list.listType.isActive | boolean |
指示文件夹类型是否处于活动状态。 |
|
ListClass
|
data.listEventViews.models.list.listType.listClass | string |
与此文件夹类型关联的列表类。 |
|
Name
|
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 |
指示是否可以添加备注。 |
|
OwnerName
|
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+ 中创建或删除的联系人。 它旨在捕获联系人的增量更改,帮助用户根据修改监视更新、同步数据或触发下游进程。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
事件类型
|
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 |
分页的起始索引。 默认值 = 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 |
事件发生的日期和时间。 |
|
联系人 ID
|
data.firmContactEventViews.models.contactId | string |
发生此事件的公司 ID。 |
|
联系人 ID
|
data.firmContactEventViews.models.contact.contactId | string |
联系人的 ID。 |
|
显示名称
|
data.firmContactEventViews.models.contact.displayName | string |
联系人的显示名称。 |
|
ContactEntity
|
data.firmContactEventViews.models.contact.contactEntity | string |
联系人的实体类型。 |
|
Title
|
data.firmContactEventViews.models.contact.title | string |
联系人的标题。 |
|
名字
|
data.firmContactEventViews.models.contact.firstName | string |
联系人的名字。 |
|
中间名
|
data.firmContactEventViews.models.contact.middleName | string |
联系人的中间名称。 |
|
LastName
|
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 |
公司的 ID。 |
|
地址
|
data.firmContactEventViews.models.contact.addresses | array of object |
检索与联系人关联的地址。 |
|
AddressId
|
data.firmContactEventViews.models.contact.addresses.addressID | string |
地址的 ID。 |
|
街道
|
data.firmContactEventViews.models.contact.addresses.street | string |
地址的街道名称。 |
|
City
|
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 |
联系人的可见性设置。 |
|
电子邮件地址
|
data.firmContactEventViews.models.contact.emailAddresses | array of object |
检索与联系人关联的电子邮件地址。 |
|
EmailId
|
data.firmContactEventViews.models.contact.emailAddresses.emailId | string |
电子邮件地址的 ID。 |
|
类型
|
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 |
拥有此电子邮件地址的联系人的 ID。 |
|
IsGlobal
|
data.firmContactEventViews.models.contact.emailAddresses.isGlobal | boolean |
指示此地址是否为全局电子邮件地址。 |
|
电话号码
|
data.firmContactEventViews.models.contact.phoneNumbers | array of object |
检索与联系人关联的电话号码。 |
|
PhoneId
|
data.firmContactEventViews.models.contact.phoneNumbers.phoneId | string |
电话号码的 ID。 |
|
编号
|
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 |
拥有此电话号码的联系人的 ID。 |
|
IsGlobal
|
data.firmContactEventViews.models.contact.phoneNumbers.isGlobal | boolean |
指示此号码是否为全局电话号码。 |
|
Name
|
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。 |
|
|
联系人 ID
|
contactIds | array of string |
公司联系人的 ID,用于筛选公司联系人事件的 ID。 |
|
|
跳过
|
skip | integer |
分页的起始索引。 默认值 = 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 |
事件发生的日期和时间。 |
|
联系人 ID
|
data.firmContactEventViews.models.contactId | string |
发生此事件的公司 ID。 |
|
联系人 ID
|
data.firmContactEventViews.models.contact.contactId | string |
联系人的 ID。 |
|
显示名称
|
data.firmContactEventViews.models.contact.displayName | string |
联系人的显示名称。 |
|
ContactEntity
|
data.firmContactEventViews.models.contact.contactEntity | string |
联系人的实体类型。 |
|
Title
|
data.firmContactEventViews.models.contact.title | string |
联系人的标题。 |
|
名字
|
data.firmContactEventViews.models.contact.firstName | string |
联系人的名字。 |
|
中间名
|
data.firmContactEventViews.models.contact.middleName | string |
联系人的中间名称。 |
|
LastName
|
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 |
公司的 ID。 |
|
地址
|
data.firmContactEventViews.models.contact.addresses | array of object |
检索与联系人关联的地址。 |
|
AddressId
|
data.firmContactEventViews.models.contact.addresses.addressID | string |
地址的 ID。 |
|
街道
|
data.firmContactEventViews.models.contact.addresses.street | string |
地址的街道名称。 |
|
City
|
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 |
联系人的可见性设置。 |
|
电子邮件地址
|
data.firmContactEventViews.models.contact.emailAddresses | array of object |
检索与联系人关联的电子邮件地址。 |
|
EmailId
|
data.firmContactEventViews.models.contact.emailAddresses.emailId | string |
电子邮件地址的 ID。 |
|
类型
|
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 |
拥有此电子邮件地址的联系人的 ID。 |
|
IsGlobal
|
data.firmContactEventViews.models.contact.emailAddresses.isGlobal | boolean |
指示此地址是否为全局电子邮件地址。 |
|
电话号码
|
data.firmContactEventViews.models.contact.phoneNumbers | array of object |
检索与联系人关联的电话号码。 |
|
PhoneId
|
data.firmContactEventViews.models.contact.phoneNumbers.phoneId | string |
电话号码的 ID。 |
|
编号
|
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 |
拥有此电话号码的联系人的 ID。 |
|
IsGlobal
|
data.firmContactEventViews.models.contact.phoneNumbers.isGlobal | boolean |
指示此号码是否为全局电话号码。 |
|
Name
|
data.firmContactEventViews.models.contact.name | string |
联系人的名称。 |
定义
ListResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
跳过
|
data.lists.skip | integer |
跳过 |
|
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 |