重要
- 这是生产就绪预览功能。
- 生产就绪预览需要满足补充使用条款。
[本文为预发布文档,可能会发生变化。]
当卖家在 Outlook 中阅读和撰写电子邮件时,他们可以使用“销售”应用查看机会见解,以获取与电子邮件相关的机会的详细信息。
你可以使用来自你自己应用程序的见解来扩展 Sales 应用的机会洞察功能。
API 描述
必须将以下 API 说明添加到动作中。 这样,Sales 应用就可以标识必须调用的正确 API 来扩充功能。
此操作将获取其他销售见解,这些见解将显示在 Outlook 挎斗的 C4S 关键销售信息卡中。 操作增强了 Copilot 副驾驶® for Sales 的现有技能。
API 运算
此 API 使用操作类型:GET
输入参数
Sales 应用旨在向 API 提供以下输入参数。
| Name | 数据类型/格式 | 必选 | 详细信息 | 要在操作中添加的说明 |
|---|---|---|---|---|
| 记录类型 | String | 是的 | 客户关系管理(CRM)中的记录类型。 记录可以指定与电子邮件相关的帐户、机会、潜在顾客或联系人。 | 此输入标识 CRM 中请求密钥销售信息的记录类型。 |
| recordId | String | 是的 | CRM 中的记录 ID。 | 此输入提供请求关键销售信息的 CRM 记录的唯一标识符。 |
| crmType | String | 否 | CRM 系统的类型。 有效值为 Salesforce 和 Dynamics 365。 | 此输入指示为其请求关键销售信息的 CRM 记录所在的 CRM 类型。 |
| crmOrgUrl | String | 否 | CRM 组织 URL | 此输入指示为其请求关键销售信息的 CRM 记录所在的 CRM 环境的 URL。 |
| top | 整数 | 否 | 要提取的见解数。 | 此输入指示要提取的销售亮点数量。 |
| 跳过 | 整数 | 否 | 要跳过的见解数。 | 此输入指示提取销售亮点时要跳过的项目数。 |
输出参数
Sales 应用需要从 API 接收见解(对象)列表,并且预期每个见解都具有特定的参数。 为了确保 Sales 应用能够正确分析输出,响应结构必须遵循下表中的准则。
| 参数 | 数据类型 | 必选 | 详细信息 |
|---|---|---|---|
| value | Array | 是的 | 见解(对象)列表,按见解架构一节描述的方法定义。 |
| hasMoreResults | 布尔 | 否 | 一个值,该值指示是否有更多结果可用。 |
洞察架构
| Name | 数据类型/格式 | 必选 | 详细信息 | 要在操作中添加的说明 |
|---|---|---|---|---|
| title | String | 是的 | 销售见解引文卡的标题。 它应仅包含合作伙伴的名称,最多可以包含 20 个字符。 | 此输出指示见解的引文卡标题。 |
| description | String | 是的 | 销售见解的描述。 在关键销售信息窗格中显示为要点,最多可以包含 130 个字符。 下面是一个示例: 验证:后续步骤:与时间线和成功条件保持一致。 | 此输出指示要包含在关键销售信息中的见解的文本。 |
| url | String | 否 | 用于在合作伙伴应用程序中打开见解的有效 URL。 | 此输出指示一个 URL,用于了解更多有关见解的信息。 |
| dateTime | 日期时间 | 否 | 活动的日期和时间(采用 UTC 格式)。 如果活动同时具有开始时间和结束时间,应用程序必须确定要显示的时间。 格式遵循 OpenAPI 规范。 下面是一个示例: 2017-07-21T17:32:28Z。 | 此输出表示与见解关联的时间。 |
| additionalProperties | 具有属性名称和属性值的对象,其类型为字符串 | 否 | 一组名称-值对,指示操作返回的相关见解的其他属性。 当用户在 “密钥销售信息 ”窗格中选择见解时,该信息会显示在弹出卡中。 | 此输出将其他属性指示为操作返回的每个相关见解的名称-值对。 |
Example
{
"value": [
{
"title": "Contract signed",
"description": "Kenny Smith sent Renewal Contract on 04/23/2023 related to 50 Cafe A-100 Automatic",
"dateTime": "2023-09-07T03:42:35.4662309Z",
"url": https://contosohub.com,
"additionalProperties": {
"Contract name": "Renewal contract for Fourth Coffee",
"Signed by": "Alberto Burgos, Tony Benis",
"Signed": "9/7/23",
"Related Opportunity": "50 CafeA-100 Automatic"
}
}
],
"hasMoreResults": false
}
下图中的示例演示如何将 API 的输出映射到机会见解。
图例:
- 显示合作伙伴应用程序中的数据的卡。
- 显示来自合作伙伴应用程序的见解的部分。 节标题派生自 Microsoft Power Platform 连接器的名称。
- API 响应中见解的说明。
- 可以选择的引文编号以查看有关见解的详细信息。
- 显示有关见解的详细信息的引文卡。
- 见解的图标和标题。 该图标从 Microsoft Power Platform 连接器元数据中检索。 标题是 API 响应中见解的标题。
- API 响应中见解的其他属性。
- 合作伙伴应用程序的名称。 显示的名称是Microsoft Power Platform 连接器的名称。
- 可以选择来查看合作伙伴应用程序中的见解详细信息的链接。 基于 API 响应中见解的 URL。
相关信息
在“销售”应用中查看商机见解
通过应用程序的见解丰富电子邮件摘要
使用来自应用程序的文件链接扩充电子邮件草稿
使用应用程序中的见解扩充 CRM 记录详细信息
利用应用程序中的洞察来丰富 CRM 记录摘要
使用合作伙伴应用程序扩展 Microsoft 365 Copilot 中的销售额
为 Microsoft 365 Copilot 构建 Sales 扩展