共用方式為

取得潛在客戶和商機的清單

  • 發行項

本文說明如何取得潛在客戶清單和共同銷售商機。 這些潛在客戶會從Microsoft的解決方案提供者頁面收到，而共同銷售商機則來自Microsoft銷售人員或其他合作夥伴。 此程式也會擷取組織所建立的共同銷售商機或管線交易清單。

注意

不支援從Microsoft商業市集 （Azure Marketplace 和 AppSource） 收到的潛在客戶。

必要條件

  • 推薦 API 驗證中所述 的認證。 此案例支援使用應用程式加上使用者的認證來進行驗證。
  • 此 API 目前僅支援合作夥伴必須處於下列其中一個角色的使用者存取權：轉介管理員或推薦使用者。

REST 要求

要求語法

方法 要求 URI
GET https://api.partner.microsoft.com/v1.0/engagements/referrals

支援的 OData 作業

名稱 描述 必要 範例
$select 選取欄位 No /referrals?$select=id,status,customerProfile
$filter 篩選結果 建議需求 /referrals?$filter=engagementId eq '65edc0b5-3485-41b7-a17e-dfa9ef4706e2'
/referrals?$filter=status eq 'New' and qualification eq 'SalesQualified'
/referrals?$filter=customerProfile/address/country eq 'US' and direction eq 'Incoming'
$orderby 排序結果 建議需求 /referrals?$orderby=createdDateTime desc

支援的 orderby 參數

使用下列$orderby參數來排序潛在客戶和商機清單

名稱 類型​​ 描述
createdDateTime Datetime 潛在客戶或商機的建立日期和時間
updatedDateTime Datetime 更新潛在客戶或商機的日期和時間

要求標頭

如需詳細資訊，請參閱 合作夥伴 REST 標頭。

要求本文

無。

要求範例

GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json

REST 回應

如果成功，回應本文會包含潛在客戶和/或商機的集合。

回應成功和錯誤碼

每個回應都有一個 HTTP 狀態代碼 ，指出成功或失敗和其他偵錯資訊。 使用網路追蹤工具來讀取此程式代碼、錯誤類型等等參數。

回應範例

HTTP/1.1 200 OK
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731
Content-Type: application/json

{
  "@odata.context": "http://api.partner.microsoft.com/v1.0/$metadata#Referrals",
  "@odata.count": 1,
  "value": [
    {
      "id": "c5fbb3b6-be74-4795-9fb5-4324c73fed37",
      "engagementId": "65edc0b5-3485-41b7-a17e-dfa9ef4706e2",
      "organizationId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
      "organizationName": "Contoso Company",
      "createdDateTime": "2020-10-30T21:03:00.0000000Z",
      "updatedDateTime": "2020-10-30T21:03:00.0000000Z",
      "status": "New",
      "substatus": "Pending",
      "qualification": "Direct",
      "type": "Independent",
      "direction": "Incoming",
      "customerProfile": {
        "name": "Fabrikam Customer Inc",
        "address": {
          "addressLine1": "One Microsoft Way",
          "addressLine2": "",
          "city": "Redmond",
          "state": "WA",
          "postalCode": "98052",
          "country": "US"
        }
      },
      "details": {
        "notes": "We are interested in deploying Microsoft 365 and are looking for support in training our employees. Can you help?",
        "dealValue": 10000,
        "currency": "USD",
        "closingDateTime": "2020-12-01T00:00:00Z",
        "requirements": {
            "industries": [ { "id": "Education" } ],
            "products": [ { "id": "Microsoft365" } ],
            "services": [ { "id": "LearningAndCertification" } ],
            "solutions": [ { "id": "SOL-Microsoft365", "name": "Microsoft365" }
          ]
        }
      },
      "links": {
        "relatedReferrals": {
          "uri": "https://api.partner.microsoft.com/v1.0/engagements/referrals?$filter=engagementId eq '65edc0b5-3485-41b7-a17e-dfa9ef4706e2'",
          "method": "GET"
        },
        "self": {
          "uri": "https://api.partner.microsoft.com/v1.0/engagements/referrals/c5fbb3b6-be74-4795-9fb5-4324c73fed37",
          "method": "GET"
        }
      }
    }
  ],
  "@odata.nextLink": "http://api.partner.microsoft.com/v1.0/referrals?$skiptoken=k181pEdP0ykypkieJfcxX"
}

@odata.nextLink使用取得下一頁的結果。

注意

此範例中的欄位並不詳盡。 實際的 API 回應包含更多欄位，例如客戶和合作夥伴小組。 如需支援欄位的完整清單，請參閱 轉介資源。

範例要求

下列範例會擷取最近 10 個輸入共同銷售商機。 要求會擷取由Microsoft銷售代表或其他合作夥伴起始的機會，邀請貴組織參與共同銷售活動。

GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$top=10&$filter=(type eq 'Shared' and direction eq 'Incoming')&$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json

下列範例會擷取未回應的最新輸入潛在客戶和商機。

GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$top=10&$filter=(direction eq 'Incoming' and substatus eq 'Pending')&$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json

重要

如果您未在分配的時間（目前為14天）內回應潛在客戶或商機，我們會將其封存為「已過期」，並通知Microsoft或傳送此商機的合作夥伴。

下列範例會取得貴組織起始的最新作用中共同銷售商機，並由特定賣方處理。

GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$filter=status eq 'Active' and direction eq 'Outgoing' and type eq 'Shared' and team/any(t:t/email eq 'r2d2@contoso.com')&$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json

相關內容