Freigeben über


Auflisten der Leads und Verkaufschancen

In diesem Artikel wird erläutert, wie Sie die Liste der Leads und Co-Sell-Verkaufschancen erhalten. Diese Leads werden von der Microsoft Solution-Provider-Seite empfangen, während Co-Sell-Verkaufschancen von Microsoft-Verkäufern oder anderen Partnern erhalten werden. Dieser Prozess ruft auch die Liste der Co-Sell-Verkaufschancen oder Pipeline-Deals ab, die von Ihrer Organisation erstellt wurden.

Hinweis

Leads, die vom kommerziellen Marketplace von Microsoft (Azure Marketplace und AppSource) empfangen werden, werden nicht unterstützt.

Voraussetzungen

  • Anmeldeinformationen, wie in der Empfehlungs-API-Authentifizierung beschrieben. In diesem Szenario wird die Authentifizierung mit App- und Benutzeranmeldeinformationen unterstützt.
  • Diese API unterstützt derzeit nur den Benutzerzugriff, bei dem Sich Partner in einer der folgenden Rollen befinden müssen: Empfehlungsadministrator oder Empfehlungsbenutzer.

REST-Anforderung

Anforderungssyntax

Methode Anforderungs-URI
GET https://api.partner.microsoft.com/v1.0/engagements/referrals

Unterstützte OData-Vorgänge

Name BESCHREIBUNG Erforderlich Beispiel
$select Markiert Felder No /referrals?$select=id,status,customerProfile
$filter Filtert Ergebnisse Empfohlen /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 Dient zum Sortieren der Ergebnisse. Empfohlen /referrals?$orderby=createdDateTime desc

Unterstützte Sortierparameter

Verwenden Sie die folgenden $orderby Parameter, um die Liste der Leads und Verkaufschancen zu sortieren.

Name Typ Beschreibung
createdDateTime DateTime Erstellungsdatum und -uhrzeit des Leads oder der Verkaufschance
updatedDateTime DateTime Datum und Uhrzeit des Leads oder der Verkaufschance aktualisieren

Anforderungsheader

Weitere Informationen finden Sie unter Partner-REST-Headern.

Anforderungstext

Keine.

Anforderungsbeispiel

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

REST-Antwort

Bei erfolgreicher Ausführung enthält der Antworttext eine Sammlung von Leads und/oder Verkaufschancen.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode , der Erfolg oder Fehler und andere Debuginformationen angibt. Verwenden Sie ein Netzwerkablaufverfolgungstool, um diesen Code, den Fehlertyp und weitere Parameter zu lesen.

Beispielantwort

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"
}

Verwenden Sie die @odata.nextLink Seite zum Abrufen der nächsten Seite mit Ergebnissen.

Hinweis

Die Felder in diesem Beispiel sind nicht vollständig. Die tatsächliche API-Antwort enthält weitere Felder wie die Kunden- und Partnerteams. Die vollständige Liste der unterstützten Felder finden Sie unter Empfehlungsressourcen.

Beispielanforderungen

Im folgenden Beispiel werden die 10 top eingehenden Co-Sell-Verkaufschancen abgerufen. Die Anforderung ruft Verkaufschancen ab, die von einem Microsoft-Vertriebsmitarbeiter oder einem anderen Partner initiiert werden, und lädt Ihre Organisation zur Teilnahme an einer Co-Selling-Aktivität ein.

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

Im folgenden Beispiel werden die neuesten eingehenden Leads und Verkaufschancen abgerufen, auf die nicht geantwortet wird.

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

Wichtig

Wenn Sie nicht innerhalb der vorgesehenen Zeit (derzeit 14 Tage) auf eine Lead- oder Verkaufschance reagieren, archivieren wir sie als abgelaufen, und benachrichtigen Sie entweder Microsoft oder den Partner, der Sie diese Verkaufschance gesendet hat.

Das folgende Beispiel ruft die neuesten aktiven Co-Sell-Verkaufschancen ab, die von Ihrer Organisation initiiert und von einem bestimmten Verkäufer bearbeitet werden.

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