Liste der Leads und Verkaufschancen

Gilt für:

  • Partner-API

In diesem Thema wird erläutert, wie Sie die Liste der Leads, die von der Seite des Microsoft-Lösungsanbieters empfangen wurden, und Co-Selling-Verkaufschancen von Microsoft-Verkäufern oder anderen Partnern Dadurch wird auch die Liste der Co-Selling-Verkaufschancen oder Pipeline Geschäfte abgerufen, 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 unter Partner-API-Authentifizierung beschrieben. In diesem Szenario wird die Authentifizierung mit App- und Benutzeranmeldeinformationen unterstützt.
  • Diese API unterstützt derzeit nur den Benutzer Zugriff, wenn Partner eine der folgenden Rollen haben müssen: globaler Administrator, Referenz Administrator oder verweisbenutzer.

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 Wählt Felder aus. Nein /referrals?$select=id,status,customerProfile
$filter Filter 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 Type Beschreibung
createdDateTime Datetime Erstellungsdatum und-Zeit des Leads oder der Verkaufschance
updatedDateTime Datetime Aktualisieren von Datum und Uhrzeit des Leads oder der Verkaufschance

Anforderungsheader

Weitere Informationen findest du unter Partner-API: REST-Header.

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

Wenn der Vorgang erfolgreich ist, enthält der Antworttext eine Auflistung von Leads und/oder Verkaufschancen.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode , der einen Erfolg oder Fehler und zusätzliche Debuginformationen angibt. Verwende ein Tool für die Netzwerkablaufverfolgung, um diesen Code, den Fehlertyp und zusätzliche Parameter zu lesen.

Beispielantwort

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

{
  "@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": "7d23e5ca-19dc-4eaa-aac8-5e6b559f0d1d",
      "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 das @odata.nextLink , um die nächste Seite mit Ergebnissen zu erhalten.

Hinweis

Die Felder in der obigen Beispiel-illustratration 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 Referenz Ressourcen.

Beispielanforderungen

  1. Ruft die ersten 10 letzten eingehenden Co-Selling-Verkaufschancen ab. Die Anforderung ruft Verkaufschancen ab, die von einem Microsoft-Vertriebsmitarbeiter oder einem anderen Partner initiiert werden, und fordert Ihre Organisation zur Teilnahme an einer Co-Selling-Aktivität auf.

    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
    
  2. Ruft die neuesten eingehenden Leads und Verkaufschancen ab, auf die nicht geantwortet wurde.

    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 einen Lead oder eine Gelegenheit reagieren, archivieren wir ihn als abgelaufen und Benachrichtigen entweder Microsoft oder den Partner, der Ihnen diese Gelegenheit gesendet hat.

  3. Ruft die letzten aktiven Co-Selling-Möglichkeiten ab, die von Ihrer Organisation initiiert wurden und von einem bestimmten Verkäufer bearbeitet wurden.

    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