使用应用程序中的见解扩充 CRM 记录详细信息(预览)
重要提示
- 这是生产就绪预览功能。
- 生产就绪预览需要满足补充使用条款。
[本文为预发布文档,可能会发生变化。]
销售人员可以查看已保存联系人的详细信息,以及相关记录,如客户和商机。 您可以使用来自您自己的应用程序的见解,扩展销售用 Copilot 提供的客户关系管理 (CRM) 记录详细信息功能。
API 描述
您必须将以下 API 说明添加到操作中。 这样,销售用 Copilot 可以识别必须调用来扩充功能的正确 API。
此操作将获取与 CRM 记录相关的记录。 操作增强了销售用 Copilot 的现有技能。
API 运算
此 API 使用运算类型:GET
输入参数
销售用 Copilot 设计为向您的 API 提供以下输入参数。
客户 | 数据类型/格式 | 必需 | 详情 | 要在操作中添加的说明 |
---|---|---|---|---|
recordType | String | 可以 | 请求相关记录的 CRM 中实体或对象的类型。 此值包括实体或对象类型与语言无关的唯一名称,不是可以本地化的显示名称。 示例包括客户和商机。 | 此输入标识 CRM 中为其请求相关记录的记录类型。 |
recordId | String | 可以 | CRM 记录的唯一标识符。 | 此输入提供为其请求相关记录的 CRM 记录的唯一标识符。 |
主要 | 整型 | 不可以 | 要提取的活动数。 | 此输入指示要提取的相关记录数量。 |
skip | 整型 | 不可以 | 要跳过的活动数。 | 此输入指示提取相关记录时要跳过的记录数。 |
crmType | String | 不可以 | CRM 系统的类型。 有效值为 Dynamics 365 和 Salesforce。 | 此输入指示从中提取相关记录的 CRM 类型。 |
crmOrgUrl | String | 不可以 | CRM 组织的主机名,如 contoso.crm.dynamics.com。 | 此输入指示从中提取相关记录的 CRM 环境的 URL。 |
备注
此扩展点支持在 Outlook 挎斗中呈现最多来自五个连接器扩展的见解。
输出参数
销售用 Copilot 预期会从您的 API 收到见解(对象)列表,并预期每个见解都有特定的参数。 为确保销售用 Copilot 能够正确分析输出,响应结构必须符合下表中的准则。
参数 | 数据类型 | 必需 | 详情 |
---|---|---|---|
value | 数组 | 可以 | 见解(对象)列表,按见解架构一节描述的方法定义。 |
hasMoreResults | 布尔型 | 不可以 | 指示是否有更多可用结果的值。 |
见解架构
客户 | 数据类型/格式 | 必需 | 详情 | 要在操作中添加的说明 |
---|---|---|---|---|
recordId | String | 可以 | 记录的唯一标识符。 | 此输出唯一标识操作返回的每个相关记录。 |
recordTypeDisplayName | String | 可以 | 记录类型的显示名称,如 Contract。 它应本地化为通过 Accept-Language 标头指定的语言。 |
此输出指示操作返回的每个相关记录的记录类型的显示名称。 |
recordTypePluralDisplayName | String | 可以 | 记录类型的复数显示名称,如 Contracts。 它应本地化为通过 Accept-Language 标头指定的语言。 |
此输出指示操作返回的每个相关记录的记录类型的复数显示名称。 |
recordType | String | 可以 | 记录类型的系统名称,如 contract。 | 此输出指示操作返回的每个相关记录的类型。 |
recordTitle | String | 可以 | 记录的名称,如 Contoso 2023 Renewal Contract。 | 此输出指示操作返回的每个相关记录的标题。 |
url | String | 不可以 | 用于在合作伙伴应用程序中打开记录的有效 URL。 | 此输出指示操作返回的每个相关记录的 URL。 |
additionalProperties | 具有字符串类型的属性名称和属性值值的对象 | 不可以 | 详细视图中显示的其他属性。 属性名称和值采用通过 { |
此输出将其他属性指示为操作返回的每个相关记录的名称-值对。 |
示例
{
"value": [
{
"recordId": "ID1",
"recordTypeDisplayName": "Contract",
"recordTitle": "50 Cafe A-100 Automatic Renewal Contract",
"recordTypePluralDisplayName": "Documents",
"recordType": "contract",
"url": "https://contosohub.com/contract/id1",
"additionalProperties": {
"Status": "Signed",
"Date": "9/7/23",
"Signed by": "Alberto Burgos, Tony [last name]"
}
},
{
"recordId": "ID2",
"recordTypeDisplayName": "Contract",
"recordTitle": "ABC Company 2023 Renewal Contract",
"recordTypePluralDisplayName": "Documents",
"recordType": "contract",
"url": "https://contosohub.com/contract/id2",
"additionalProperties": {
"Status": "Delivered",
"Date": "9/3/23",
"Signed by": "Alberto Burgos"
}
}
],
"hasMoreResults": false
}
下图中的示例显示 API 的输出如何映射到相关记录。
图例:
- 显示合作伙伴应用程序中的相关记录的卡。
- 卡的图标和标题。 此图标从 Microsoft Power Platform 连接器元数据检索。 标题是 Microsoft Power Platform 连接器的名称。
- API 响应中的相关记录标题。 API 响应中的两个其他属性将呈现为每个相关记录的关键字段。
- “更多操作”按钮,可用于复制记录链接或在合作伙伴应用程序中查看记录详细信息的链接。 此链接基于 API 响应中相关记录的 URL。
- API 响应中相关记录的其他属性。
相关信息
查看记录详细信息
使用应用程序中的见解扩充电子邮件摘要
使用应用程序中的文件链接扩充电子邮件草稿
使用应用程序中的见解扩充关键销售信息
使用应用程序中的见解扩充 CRM 记录摘要
使用合作伙伴应用程序扩展销售用 Microsoft 365 销售用 Copilot
构建销售用 Copilot 扩展