リードや営業案件のリストを取得する

この記事では、潜在顧客と共同販売の機会の一覧を取得する方法について説明します。 これらの潜在顧客は Microsoft のソリューション プロバイダー ページから受け取られますが、共同販売の機会は Microsoft の販売者または他のパートナーから受け取ります。 このプロセスでは、組織によって作成された共同販売機会またはパイプライン取引の一覧も取得されます。

Note

Microsoft コマーシャル マーケットプレース (Azure Marketplace および AppSource) から受信したリードはサポートされていません。

前提条件

• Referrals 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 パラメーター

潜在顧客と営業案件の一覧を並べ替えるには、次の$orderby パラメーターを使用します

名前	種類	説明
createdDateTime	DateTime	リードまたは営業案件の作成日時
updatedDateTime	DateTime	リードまたは営業案件の日付と時刻を更新する

要求ヘッダー

詳細については、「 Partner 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を使用して、結果の次のページを取得します。

Note

この例のフィールドは完全ではありません。 実際の 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

関連するコンテンツ

• 紹介を作成する