使用應用程式提供的見解擴充 CRM 記錄詳細資料 (預覽版)
重要
- 這是生產就緒型預覽功能。
- 生產就緒型預覽版應受補充使用條款所拘束。
[本文章是發行前版本文件,隨時可能變更。]
賣家可以檢視有關已儲存連絡人的詳細資料,以及其相關聯的記錄,例如客戶和商機。 您可以使用自己應用程式中的見解來擴充銷售用 Copilot 提供的客戶關係管理 (CRM) 記錄詳細資料功能。
API 描述
您必須將下列 API 描述新增至動作。 這樣,銷售用 Copilot 就可以識別必須叫用的正確 API 來擴充功能。
此動作會取得與 CRM 記錄相關的記錄。 該動作增強銷售用 Copilot 的現有技能。
API 作業
此 API 使用作業類型:GET
輸入參數
Copilot for Sales 旨在向 API 提供下列輸入參數。
姓名 | 資料類型/格式 | 必要 | Details | 要在動作中新增的描述 |
---|---|---|---|---|
recordType | 字串 | 是 | CRM 中要求相關記錄的實體或物件類型。 該值包含與語言無關的實體或物件類型唯一名稱,而不是可當地語系化的顯示名稱。 範例包括客戶和商機。 | 此輸入識別 CRM 中要求提供相關記錄的記錄類型。 |
recordId | 字串 | 是 | CRM 記錄的唯一識別碼 | 此輸入提供要求其相關記錄之 CRM 記錄的唯一識別碼。 |
熱門 | Integer | 否 | 要擷取的活動數目。 | 此輸入指示要擷取的相關記錄數目。 |
skip | Integer | 否 | 要略過的活動數目。 | 此輸入指示要在擷取相關記錄時略過的記錄數目。 |
crmType | 字串 | 否 | CRM 系統的類型。 有效值為 Dynamics 365 和 Salesforce。 | 此輸入指示從中擷取相關記錄的 CRM 類型。 |
crmOrgUrl | 字串 | 否 | CRM 組織的主機名稱,例如 contoso.crm.dynamics.com。 | 此輸入指示從中擷取相關記錄的 CRM 環境的 URL。 |
注意
此擴充點支援最多透過 Outlook 側車中的五個連接器延伸模組來呈現見解。
輸出參數
銷售用 Copilot 需要從 API 收到見解 (物件) 清單,並要求每個見解都必須有特定參數。 為了確保銷售用 Copilot 可以正確剖析輸出,回應結構必須遵循下表中的指導方針。
參數 | 資料類型 | 必要 | Details |
---|---|---|---|
數值 | 陣列 | 是 | 依照見解的結構描述一節中所述定義的見解 (物件) 清單。 |
hasMoreResults | 布林值 | 否 | 指示是否有更多可用結果的值。 |
見解的結構描述
姓名 | 資料類型/格式 | 必要 | Details | 要在動作中新增的描述 |
---|---|---|---|---|
recordId | 字串 | 是 | 記錄的唯一識別碼。 | 此輸出唯一識別動作傳回的每個相關記錄。 |
recordTypeDisplayName | 字串 | 是 | 記錄類型的顯示名稱,例如 Contract。 這應以透過 Accept-Language 標頭所指定的語言進行當地語系化。 |
此輸出指示動作所傳回每個相關記錄的記錄類型顯示名稱。 |
recordTypePluralDisplayName | 字串 | 是 | 記錄類型的複數顯示名稱,例如 Contracts。 這應以透過 Accept-Language 標頭所指定的語言進行當地語系化。 |
此輸出指示動作所傳回每個相關記錄的記錄類型複數顯示名稱。 |
recordType | 字串 | 是 | 記錄類型的系統名稱,例如 contract。 | 此輸出指示動作所傳回每個相關記錄的類型。 |
recordTitle | 字串 | 是 | 記錄的名稱,例如 Contoso 2023 年續約合約。 | 此輸出指示動作所傳回每個相關記錄的標題。 |
url | 字串 | 否 | 用於在合作夥伴應用程式中開啟記錄的有效 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 延伸模組