共用方式為

智慧約會 API 參考

  • 發行項

重要

自 2024 年 5 月 22 日起，智慧約會已棄用，並且不可用於部署。 如果現有使用者已經部署和設定此功能，則可以照常繼續使用該功能。

使用智慧約會API 集合來搜尋相關的顧問，並安排和管理會議。 此 API 是以 Power Platform 自訂 API 為基礎所建立。

注意

此 API 中所有的命令都使用 POST 訊息。

可用性和排程命令

Command 描述
GetSchedulingProperties 從 Dataverse 環境中擷取所有與會議類型相關的資訊。
GetAvailableMeetingTimeSlots 根據要求的地點、主旨、技能和日期範圍來擷取相關顧問的可用時段。
CreateMeeting 允許排定與所要求的顧問資源的會議。
GetMeeting 擷取連絡人的已排定會議。
CancelMeeting 取消現有的會議

GetSchedulingProperties

描述：從 Dataverse 環境中擷取所有與會議類型相關的資訊。

外掛程式名稱：GetSchedulingPropertiesPlugin.cs

HTTP 要求：POST {{url}}/api/data/v9.0/msfsi_GetSchedulingProperties

要求輸入參數 (在本文中)：空白

回應輸出參數：

參數名稱 描述 類型​ 注意事項
位置 位置物件的陣列。 這些是位於 MeetingType 物件中的位置。 物件陣列 當會議僅在現場舉行時，會填入位置物件。
主題 主題物件的陣列。 這些是位於 MeetingType 物件中的主題。 物件陣列
MeetingTypes MeetingTypes 的陣列 物件陣列
位置物件
Id 位置識別碼 (OrganizationalUnit 實體)。 字串
名稱 位置的名稱 (分行實體)。 字串
地址 1 位置的地址第一行 (分行實體)。 字串
Address2 位置的地址第二行 (分行實體)。 字串
縣/市 位置的縣/市 (分行實體)。 字串
StateOrProvince 位置的州或省 (分行實體)。 字串
Country 位置的國家/地區 (分行實體)。 字串
PostalCode 位置的郵遞區號 (分行實體)。 字串
電話 位置的電話號碼 (分行實體)。 字串
主題物件
Id 主題的識別碼。 字串
名稱 主題名稱。 字串
描述 主題的描述。 字串
MeetingType 物件
Id MeetingType 的識別碼。 字串
名稱 MeetingType 的名稱。 字串
描述 MeetingType 的描述。 字串
Duration MeetingType 所描述的會議期間。 Int
注意事項 會議出席者須遵循的注意事項。 字串
主題 已連接至此 MeetingType 之主題的識別碼陣列。 String[] 主題陣列中提供完整的詳細清單。
位置 已連接至此 MeetingType 之位置的識別碼陣列。 String[] 當會議僅在現場舉行時，會填入位置物件。 完整的詳細清單可在位置陣列中找到。
管道 此 MeetingType 設定的管道。 選項組
  • 104800000：僅線上進行
  • 104800001：線上或現場
  • 104800002：僅現場進行

每個選項組皆以包含值及標籤的物件來表示。
DefaultMethod 此 MeetingType 設定的預設方法。 選項組
  • 104800000：線上
  • 104800001：現場

每個選項組皆以包含值及標籤的物件來表示。

注意

並非所有的參數都會傳回：

  • 不會顯示僅現場進行且沒有任何分行的會議。

  • 不會顯示未含必要欄位的會議。

  • 不會顯示非使用中狀態的實體。

  • 下列參數可能不會傳回值：

  • 如果為 Null，則不會傳回 Channel 和 DefaultMethod 參數。

    • 如果沒有任何位置連接至 MeetingType，則不會有位置陣列。 只有在管道的值為 [現場] 以外的值時，才可以這樣。

    • 如果沒有任何主題連接至 MeetingType (透過連接實體)，則無法顯示 Topics 參數。

    • Id、Name、Description 和 Duration 參數永遠都是回應中每個元素的一部分。

    • Topic 和 Location 是含有實體的陣列。 Id 是主題和位置物件的必要參數。

回應範例：

{
    "@odata.context": "https://orgc7816042.crm.dynamics.com/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msfsi_GetSchedulingPropertiesResponse",
    "Locations": [
        {
            "@odata.type": "#Microsoft.Dynamics.CRM.expando",
            "Id": "0781fd19-f1a8-ec11-983f-000d3a323337",
            "Name": "Woodgrove Oklahoma City branch",
            "Address1": "91011 East Blue Stone Drive",
            "Address2": "91011 East Blue Stone Drive",
            "City": "Oklahoma City",
            "Country": "USA",
            "PostalCode": "64555",
            "Telephone": "+1(917)145-4533"
        },
        {
            "@odata.type": "#Microsoft.Dynamics.CRM.expando",
            "Id": "600ef125-f1a8-ec11-983f-000d3a323337",
            "Name": "Woodgrove Savannah branch",
            "Address1": "678 Van Hoose Drive",
            "Address2": "678 Van Hoose Drive",
            "City": "Savannah",
            "Country": "USA",
            "PostalCode": "48645",
            "Telephone": "+1(403)123-4567"
        }
    ],
    "Topics": [
        {
            "@odata.type": "#Microsoft.Dynamics.CRM.expando",
            "Id": "5a007aa3-809f-ec11-b400-0022480b8113",
            "Name": "Everyday banking",
            "Description": "Account opening, credit cards, financial health check ups and general assistance subjects"
        },
        {
            "@odata.type": "#Microsoft.Dynamics.CRM.expando",
            "Id": "eb4e85b5-819f-ec11-b400-0022480b8113",
            "Name": "Loans",
            "Description": "Mortgage, Loan consults, follow up and contracting meetings"
        }
    ],
    "MeetingTypes": [
        {
            "@odata.type": "#Microsoft.Dynamics.CRM.expando",
            "Id": "5ce28b83-899f-ec11-b400-0022480b8113",
            "Name": "Apply for credit card",
            "Description": "Submitting an application for a credit card program",
            "Duration": 30,
            "Topics@odata.type": "#Collection(String)",
            "Topics": [
                "5a007aa3-809f-ec11-b400-0022480b8113"
            ],
            "Locations@odata.type": "#Collection(String)",
            "Locations": [
                "0781fd19-f1a8-ec11-983f-000d3a323337",
                "600ef125-f1a8-ec11-983f-000d3a323337"
            ],
            "Channel": {
                "@odata.type": "#Microsoft.Dynamics.CRM.expando",
                "Value": 104800002,
                "Label": "Online or on location"
            },
            "DefaultMethod": {
                "@odata.type": "#Microsoft.Dynamics.CRM.expando",
                "Value": 104800000,
                "Label": "Online"
            }
        },
        {
            "@odata.type": "#Microsoft.Dynamics.CRM.expando",
            "Id": "1167906a-8d9f-ec11-b400-0022480b8113",
            "Name": "Mortgage Application phase 1",
            "Description": "Onboarding meeting to submit a loan application for a specific property",
            "Duration": 30,
            "Topics@odata.type": "#Collection(String)",
            "Topics": [
                "eb4e85b5-819f-ec11-b400-0022480b8113"
            ],
            "Locations@odata.type": "#Collection(String)",
            "Channel": {
                "@odata.type": "#Microsoft.Dynamics.CRM.expando",
                "Value": 104800002,
                "Label": "Online only"
            },
            "DefaultMethod": {
                "@odata.type": "#Microsoft.Dynamics.CRM.expando",
                "Value": 104800000,
                "Label": "Online"
            }
        }
    ]
}

GetAvailableMeetingTimeSlots

描述：根據要求的地點、主旨、技能和日期範圍來擷取相關顧問的可用時段。

外掛程式名稱：GetTimeSlotsPlugin.cs

HTTP 要求：POST {{url}}/api/data/v9.0/msfsi_GetAvailableMeetingTimeSlots

要求輸入參數 (在本文中)：

參數名稱 描述 類型​ 必要 注意事項
MeetingType 使用者希望搜尋的 MeetingType 的識別碼。 字串 (msfsi_meetingtype 識別碼) .是 此參數的值必須是有效的 GUID。
StartDateTime 要搜尋可用性的開始日期及時間。 日期時間 .是 必須以 UTC 提供時間。
EndDateTime 要搜尋可用性的結束日期及時間。 日期時間 .是 必須以 UTC 提供時間。
RequestedMeetingLocation 使用者希望搜尋的位置 (OrganizationalUnit) 的識別碼。 字串 (msdyn_organizationalunit 識別碼) 無 當 IsOnlineMeeting 設定為 false 時為必要。

此參數的值必須是有效的 GUID。
IsOnlineMeeting 指示約會是否為線上會議。 布林值 .是
SkillFilter 字串陣列，包含所有要納入可用性要求搜尋之技能的識別碼。 String[] (特性識別碼) 無 添加已在資源組範本上設置為預設值的篩選器會導致錯誤。

此參數的值必須是有效的 GUID。
分頁 分頁字串。 如果未提供，則擷取第一頁；否則，傳回對應的頁面。 字串 無

要求範例：

{
    "MeetingType": "5ce28b83-899f-ec11-b400-0022480b8113",
    "StartDateTime": "2022-08-21T11:00:00+03:00",
    "EndDateTime": "2022-08-23T12:00:00+03:00",
    "IsOnlineMeeting": false,
    "RequestedMeetingLocation": "cfc7f51f-f1a8-ec11-983f-000d3a323337",
    "SkillFilter": [
        "2953c0d2-d2d9-ec11-a7b6-000d3a3089fb"
    ],
    "Paging": ""
}

回應輸出參數：

參數名稱 描述 類型​ 注意事項
Timeslots Timeslots 物件的陣列，表示要求的顧問、會議類型及地點所傳回的可用時段。 Timeslots 物件的陣列
NextPaging 用於進行分頁的分頁字串。 如果沒有可用結果，則此值為 Null。 字串 如需詳細資訊，請前往 URS 文件。
Timeslots 物件
StartTime 搜尋要求中指定的開始日期及時間。 日期時間 時間是以 UTC 傳回。
EndTime 搜尋要求中指定的結束日期及時間。 日期時間 時間是以 UTC 傳回。
顧問 表示顧問的物件清單。 每個物件都會保存識別碼和顧問名稱。 物件陣列 使用 CreateMeeting 建立會議並擷取要顯示的資源資訊時，會使用這些識別碼。 每個時段只會傳回一組顧問。 如果會議類型的要求是會議中的單個顧問，則每個時間段僅包含一個值。 如果有多個顧問可用，則排程引擎會根據情境和產能來設定顧問的優先順序。

回覆範例：基於空間考量，已移除一些傳回的時段。

注意

當傳回的時段超過 20 個時，會新增 NextPaging。

{
    "@odata.context": "https://demoenvironment.crm.dynamics.com/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msfsi_GetAvailableMeetingTimeSlotsResponse",
    "NextPaging": "{\"nte\":\"1\",\"nti\":\"2022-08-21T17:30:00.0000000Z\",\"res\":{\"nfr\":20,\"nft\":20,\"rbd\":{\"2022-08-21T08:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T08:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T09:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T09:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T10:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T10:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T11:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T11:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T12:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T12:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T13:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T13:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T14:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T14:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T15:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T15:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T16:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T16:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T17:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T17:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null}}}}",
"Timeslots": [
      {
        "@odata.type": "#Microsoft.Dynamics.CRM.expando",
        "StartTime": "2022-08-21T08:15:00Z",
        "EndTime": "2022-08-21T08:45:00Z",
        "Advisors@odata.type": "#Collection(Microsoft.Dynamics.CRM.crmbaseentity)",
        "Advisors": [
          {
            "@odata.type": "#Microsoft.Dynamics.CRM.expando",
            "Id": "876b4623-5d08-ed11-82e4-000d3a364a5d",
            "Name": "Temp Admin"
          }
        ]
      },
      {
        "@odata.type": "#Microsoft.Dynamics.CRM.expando",
        "StartTime": "2022-08-21T08:45:00Z",
        "EndTime": "2022-08-21T09:15:00Z",
        "Advisors@odata.type": "#Collection(Microsoft.Dynamics.CRM.crmbaseentity)",
        "Advisors": [
          {
            "@odata.type": "#Microsoft.Dynamics.CRM.expando",
            "Id": "876b4623-5d08-ed11-82e4-000d3a364a5d",
            "Name": "Temp Admin"
          }
        ]
      }
    ]
  }

CreateMeeting

描述：允許排定與所要求的顧問資源的會議。

外掛程式名稱：CreateMeetingPlugin.cs

HTTP 要求：POST {{url}}/api/data/v9.0/msfsi_CreateMeeting

要求輸入參數 (在本文中)：

參數名稱 描述 類型​ 必要 注意事項
MeetingType 所選 MeetingType 的識別碼。 字串 (msfsi_meetingtype) .是 此參數的值必須是有效的 GUID。
StartDateTime 會議的開始日期及時間。 日期時間 .是 根據會議類型和系統管理員設定，將準備和摘要約會新增至顧問的行事曆。
連絡人​​ 表示參與會議之客戶的連絡人識別碼。 字串 (連絡人識別碼) .是 此參數的值必須是有效的 GUID。
IsOnlineMeeting 指示約會是否為線上會議。 布林值 .是 如果此值為 False，則必須改為提供會議地點。
RequestedMeetingLocation 要舉行會議所在位置 (OrganizationalUnit) 的識別碼。 字串 (OrganizationalUnit(OU) 識別碼) 無 對於連線會議，此欄位不是必需的。 對於連線顧問位於特定 OrganizationalUnit（OU）中的連線會議實現，需要專用的 OU 參考。
RequestedAdvisors 必要顧問識別碼 (可預約資源識別碼) 的陣列。 這些識別碼取自 GetAvailableMeetingTimeSlots 回應中所提供的顧問陣列。 EntityCollection (資源) .是 若要讓預約成功，資源必須有與之相關聯的系統使用者。 這些使用者會出現在約會的必要欄位中。 陣列中的字串必須是有效的 GUID。
CustomerAdditionalNotes 客戶要分享的關於近期會議的附註。 字串 無 此參數會出現在 CRM 應用程式的客戶通訊和約會描述中。

要求範例：

{
    "MeetingType": "aaafeaad-8c9f-ec11-b400-0022480b8113",
    "StartDateTime": "2022-8-17T12:30:00",
    "Contact": "8788facf-828e-4333-8405-b825b0f29ea0",
    "IsOnlineMeeting": false,
    "RequestedMeetingLocation": "8bcdf8e8-eda8-ec11-983f-000d3a323337",
    "RequestedAdvisors": ["8240fdbc-e20d-ed11-82e5-000d3a593e34"],
    "CustomerAdditionalNotes": "Some test notes"
}

回應輸出參數：

參數名稱 描述 類型​ 注意事項
Id 表示已排定會議的識別碼。 字串 表示 GUID。
StartTime 會議的開始日期及時間。 日期時間 時間是以 UTC 提供。
EndTime 會議的結束日期及時間。 日期時間 時間是以 UTC 提供。
Duration 已排定會議的期間 (以分鐘為單位)。 Int
IsOnline 指示約會是否為線上會議。 布林值
CustomerAdditionalNotes 客戶要分享的關於已排定會議的附註。 字串
MeetingJoinUrl 加入已排定會議的連結。 字串
州/省 已排定會議的狀態。 選項組 (物件)
  • 0：開啟
  • 1：已完成
  • 2：已取消
  • 3：已排定

每個選項組皆以包含值及標籤的物件來表示。
位置 現場約會的會議位置物件。 Object 此參數僅對於現場會議為非空。
顧問 表示已排定會議中顧問的物件清單。 物件陣列
MeetingType 表示 MeetingType 的物件。 Object
位置物件
Id 位置識別碼 (OrganizationalUnit 實體)。 字串 表示 GUID。
名稱 位置的名稱 (分行實體)。 字串
地址 1 位置的地址第一行 (分行實體)。 字串
Address2 位置的地址第一行 (分行實體)。 字串
縣/市 位置的縣/市 (分行實體)。 字串
StateOrProvince 位置的州或省 (分行實體)。 字串
Country 位置的國家/地區 (分行實體)。 字串
PostalCode 位置的郵遞區號 (分行實體)。 字串
電話 位置的電話號碼 (分行實體)。 字串
顧問物件
Id 顧問的識別碼 (可預約資源實體)。 字串 表示 GUID。
名稱 顧問的名稱。 字串
MeetingType 物件
Id MeetingType 的識別碼。 字串
名稱 MeetingType 的名稱。 字串
注意事項 會議出席者須遵循的注意事項。 字串
描述 MeetingType 的描述。 字串

回應範例：

{
    "@odata.context": "https://aa-isdaily.crm.dynamics.com/api/data/v9.0/$metadata#expando/$entity",
    "@odata.type": "#Microsoft.Dynamics.CRM.expando",
    "Id": "4d6d4b05-4e0f-ed11-82e5-00224822509a",
    "StartTime": "2022-08-17T12:30:00Z",
    "EndTime": "2022-08-17T13:15:00Z",
    "Duration": 45,
    "IsOnline": false,
    "CustomerAdditionalNotes": "Some test notes",
    "State": {
        "@odata.type": "#Microsoft.Dynamics.CRM.expando",
        "Value": 3,
        "Label": "Scheduled"
    },
    "Location": {
        "@odata.type": "#Microsoft.Dynamics.CRM.expando",
        "Id": "8bcdf8e8-eda8-ec11-983f-000d3a323337",
        "Name": "Woodgrove Anchorage branch",
        "Address1": "123 Eastview Lane",
        "City": "Anchorage"
    },
    "Advisors@odata.type": "#Collection(Microsoft.Dynamics.CRM.crmbaseentity)",
    "Advisors": [
        {
            "@odata.type": "#Microsoft.Dynamics.CRM.expando",
            "Id": "f35a29b9-02b1-ec11-9840-000d3a9937ed",
            "Name": "IS admin"
        }
    ],
    "MeetingType": {
        "@odata.type": "#Microsoft.Dynamics.CRM.expando",
        "Id": "aaafeaad-8c9f-ec11-b400-0022480b8113",
        "Name": "Setting Investment goals",
        "Notes": "If this is your first planning meeting, please bring:\n1. 401(k) and other investment plan statements\n2. Mortgage and other debt statements\n3. Pay stubs for you and/or your spouse\n4. Your most recent tax return\n5. Your monthly budget of income and expenses",
        "Description": "Creating wealth management goals"
    }
}

GetMeeting

描述：擷取連絡人的已排定會議。

外掛程式名稱：GetMeetingPlugin.cs

HTTP 要求：POST {{url}}/api/data/v9.0/msfsi_GetMeeting

要求輸入參數 (在本文中)：

參數名稱 描述 類型​ 必要 注意事項
會議 會議的識別碼。 字串 .是 會議識別碼是取自 CreateMeeting 回應。

此參數的值必須是有效的 GUID。
連絡人​​ 為其安排會議之客戶的識別碼。 字串 .是 此參數的值必須是有效的 GUID。

要求範例：

{
    "Meeting": "4d6d4b05-4e0f-ed11-82e5-00224822509a",
    "Contact": "8788facf-828e-4333-8405-b825b0f29ea0"
}

回應輸出參數：

參數名稱 描述 類型​ 注意事項
Id 表示已排定會議的識別碼。 字串 表示 GUID。
StartTime 會議的開始日期及時間。 日期時間 時間是以 UTC 提供。
EndTime 會議的結束日期及時間。 日期時間 時間是以 UTC 提供。
Duration 已排定會議的期間 (以分鐘為單位)。 Int
IsOnline 指示約會是否為線上會議。 布林值
CustomerAdditionalNotes 客戶要分享的關於已排定會議的附註。 字串
MeetingJoinUrl 加入已排定會議的連結。 字串
州/省 已排定會議的狀態。 選項組 (物件)
  • 0：開啟
  • 1：已完成
  • 2：已取消
  • 3：已排定

每個選項組皆以包含值及標籤的物件來表示。
位置 現場約會的會議位置物件。 Object 此參數僅對於現場會議為非空。
顧問 表示已排定會議中顧問的物件清單。 物件陣列
MeetingType 表示 MeetingType 的物件。 Object
位置物件
Id 位置識別碼 (OrganizationalUnit 實體)。 字串 表示 GUID。
名稱 位置的名稱 (分行實體)。 字串
地址 1 位置的地址第一行 (分行實體)。 字串
Address2 位置的地址第一行 (分行實體)。 字串
縣/市 位置的縣/市 (分行實體)。 字串
StateOrProvince 位置的州或省 (分行實體)。 字串
Country 位置的國家/地區 (分行實體)。 字串
PostalCode 位置的郵遞區號 (分行實體)。 字串
電話 位置的電話號碼 (分行實體)。 字串
顧問物件
Id 顧問的識別碼 (可預約資源實體)。 字串 表示 GUID。
名稱 顧問的名稱。 字串
MeetingType 物件
Id MeetingType 的識別碼。 字串
名稱 MeetingType 的名稱。 字串
注意事項 會議出席者須遵循的注意事項。 字串
描述 MeetingType 的描述。 字串

回應範例：

{
    "@odata.context": "https://aa-isdaily.crm.dynamics.com/api/data/v9.0/$metadata#expando/$entity",
    "@odata.type": "#Microsoft.Dynamics.CRM.expando",
    "Id": "4d6d4b05-4e0f-ed11-82e5-00224822509a",
    "StartTime": "2022-08-17T12:30:00Z",
    "EndTime": "2022-08-17T13:15:00Z",
    "Duration": 45,
    "IsOnline": false,
    "CustomerAdditionalNotes": "Some test notes",
    "State": {
        "@odata.type": "#Microsoft.Dynamics.CRM.expando",
        "Value": 3,
        "Label": "Scheduled"
    },
    "Location": {
        "@odata.type": "#Microsoft.Dynamics.CRM.expando",
        "Id": "8bcdf8e8-eda8-ec11-983f-000d3a323337",
        "Name": "Woodgrove Anchorage branch",
        "Address1": "123 Eastview Lane",
        "City": "Anchorage"
    },
    "Advisors@odata.type": "#Collection(Microsoft.Dynamics.CRM.crmbaseentity)",
    "Advisors": [
        {
            "@odata.type": "#Microsoft.Dynamics.CRM.expando",
            "Id": "f35a29b9-02b1-ec11-9840-000d3a9937ed",
            "Name": "IS admin"
        }
    ],
    "MeetingType": {
        "@odata.type": "#Microsoft.Dynamics.CRM.expando",
        "Id": "aaafeaad-8c9f-ec11-b400-0022480b8113",
        "Name": "Setting Investment goals",
        "Notes": "If this is your first planning meeting, please bring:\n1. 401(k) and other investment plan statements\n2. Mortgage and other debt statements\n3. Pay stubs for you and/or your spouse\n4. Your most recent tax return\n5. Your monthly budget of income and expenses",
        "Description": "Creating wealth management goals"
    }
}

CancelMeeting

描述：取消現有的會議。

外掛程式名稱：CancelMeetingPlugin.cs

HTTP 要求：POST {{url}}/api/data/v9.0/msfsi_CancelMeeting

要求輸入參數 (在本文中)：

參數名稱 描述 類型​ 必要 注意事項
會議 要取消之會議的識別碼。 字串 (約會識別碼) .是 會議識別碼取自客戶現有約會的擷取要求。 只能取消未來的使用中會議。

已連結至客戶會議的準備及摘要約會也會取消。

此參數的值必須是有效的 GUID。
連絡人​​ 為其安排會議之客戶的識別碼。 字串 (連絡人識別碼) .是 此參數的值必須是有效的 GUID。

要求範例：

{
    "Meeting": "5d98de42-8c9f-ec11-b400-0022480b81c4",
    "Contact": "ce43d612-4d9d-ec11-b400-0022480b8d8e"
    "Appointment": {
        "activityid": "5d98de42-8c9f-ec11-b400-0022480b81c4"
    },
    "Contact": {
        "contactid": "ce43d612-4d9d-ec11-b400-0022480b8d8e"
    }
}

回應輸出參數：

參數名稱 描述 類型​ 注意事項
IsAppointmentCancelled 指示會議是否已取消。 布林值 只能取消未來的使用中會議。

回應範例：

{
    "@odata.context": "https://#####.crm.dynamics.com/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msfsi_CancelMeetingResponse",
    "IsMeetingCancelled": true
}

擷取資料命令

提供給智慧約會的一組 API 和應用程式，必須為您提供充分的資訊。 OData 擷取命令可用來擷取關於 API 所用之基礎實體的資訊。 實體數據的獲取是使用標準 FetchXML 查詢完成的 Dataverse。
瞭解詳細資訊： 用於 FetchXML 構造查詢。

建議提取的實體清單如下：

  • MeetingTopics：擷取可用會議主題的清單。 主題是可以將會議分組到不同容器中的實體。 這是選用值。

  • MeetingTypeTopic：表示用於識別會議類型與主題之間連結的對應。 可以在多個主題下提供特定會議類型。 如果使用會議主題，請務必將會議分組至相關主題容器中。

  • MeetingTypes：擷取可用會議類型的清單。

  • MeetingType：擷取特定會議類型的詳細資料，例如：

    • 支援的會議方法 (線上、面對面或兩者)

    • 會議描述

    • 提供此會議的分行清單

    • 會議期間

    • 安排會議時的客戶會議指示。

  • 分行：擷取智慧約會解決方案中支援的分行清單。 此清單必須與會議類型交互參考，才能確認只有支援特定會議服務的分行可供客戶選擇。

  • 分行：擷取特定分行的詳細資料，例如分行名稱、分行代碼和地址。

  • 約會：擷取客戶的約會清單。

  • 約會：依據連絡人識別碼擷取特定約會的詳細資料。詳細資料包括：

    • 約會狀態

    • 線上會議連結

    • 已新增至會議的其他客戶附註

    • 會議地點

    • 需要出席會議的顧問

    • 描述

  • BookableResources：擷取可用資源及其詳細資料 (例如名稱和標題) 的清單。

另請參閱

使用 Microsoft Dataverse Web API
使用 Web API 擷取資料表資料列
智慧約會
設定智慧約會
什麼是 Microsoft Cloud for Financial Services？