通过

获取潜在客户和商机的列表

  • 项目

本文介绍如何获取潜在顾客列表和联合销售机会。 这些潜在顾客来自Microsoft的解决方案提供商页面，而联合销售机会则来自Microsoft销售商或其他合作伙伴。 此过程还会提取组织创建的联合销售机会或管道交易列表。

注意

不支持从Microsoft商业市场（Azure 市场和 AppSource）接收的潜在顾客。

先决条件

  • 引荐 API 身份验证中所述的凭据。 此方案支持使用应用凭据和用户凭据进行身份验证。
  • 此 API 目前仅支持合作伙伴必须处于以下角色之一的用户访问权限：引荐管理员或引荐用户。

REST 请求

请求语法

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

支持的 OData 操作

名称 说明 必须 示例
$select 选择字段 否 /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参数对潜在顾客和商机列表进行排序

名称 Type 描述
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

相关内容