Delen via

De lijst met leads en verkoopkansen ophalen

  • Artikel

In dit artikel wordt uitgelegd hoe u de lijst met potentiële klanten en collectieve verkoopkansen kunt ophalen. Deze leads worden ontvangen van de pagina Solution-Provider van Microsoft, terwijl collectieve verkoopkansen worden ontvangen van Microsoft-verkopers of andere partners. Met dit proces wordt ook de lijst met collectieve verkoopkansen of pijplijndeals opgehaald die door uw organisatie zijn gemaakt.

Notitie

Leads die zijn ontvangen van de commerciële Marketplace van Microsoft (Azure Marketplace en AppSource) worden niet ondersteund.

Vereisten

  • Referenties zoals beschreven in verwijzings-API-verificatie. Dit scenario ondersteunt verificatie met app+gebruikersreferenties.
  • Deze API ondersteunt momenteel alleen gebruikerstoegang waarbij partners zich in een van de volgende rollen moeten bevinden: Verwijzingsbeheerder of Verwijzingsgebruiker.

REST-aanvraag

Aanvraagsyntaxis

Wijze Aanvraag-URI
GET https://api.partner.microsoft.com/v1.0/engagements/referrals

Ondersteunde OData-bewerkingen

Name Beschrijving Vereist Opmerking
$select Selecteert velden Nee /referrals?$select=id,status,customerProfile
$filter Resultaten filteren Aanbevolen /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 Ordersresultaten Aanbevolen /referrals?$orderby=createdDateTime desc

Ondersteunde orderby-parameters

Gebruik de volgende $orderby parameters om de lijst met potentiële klanten en verkoopkansen te sorteren

Name Type Description
createdDateTime Datum en tijd Aanmaakdatum en -tijd van de potentiële klant of verkoopkans
updatedDateTime Datum en tijd Datum en tijd van de potentiële klant of verkoopkans bijwerken

Aanvraagheaders

Zie Partner REST-headers voor meer informatie.

Aanvraagtekst

Geen.

Aanvraagvoorbeeld

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

REST-antwoord

Als dit lukt, bevat de hoofdtekst van het antwoord een verzameling potentiële klanten en/of verkoopkansen.

Geslaagde antwoorden en foutcodes

Elk antwoord wordt geleverd met een HTTP-statuscode die aangeeft dat de fout is geslaagd of mislukt en andere informatie over foutopsporing. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en meer parameters te lezen.

Responsvoorbeeld

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

Gebruik de @odata.nextLink pagina om de volgende pagina met resultaten op te halen.

Notitie

De velden in dit voorbeeld zijn niet volledig. Het werkelijke API-antwoord bevat meer velden, zoals de klant- en partnerteams. Zie verwijzingsbronnen voor de volledige lijst met ondersteunde velden.

Voorbeeldaanvragen

In het volgende voorbeeld worden de tien meest recente verkoopkansen voor inkomend verkeer opgehaald. De aanvraag haalt verkoopkansen op die zijn geïnitieerd door een Microsoft-vertegenwoordiger of een andere partner, waarbij uw organisatie wordt uitgenodigd om deel te nemen aan een collectieve verkoopactiviteit.

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

In het volgende voorbeeld worden de meest recente binnenkomende leads en verkoopkansen opgehaald waarop niet wordt gereageerd.

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

Belangrijk

Als u niet reageert op een potentiële klant of verkoopkans binnen de toegewezen tijd (momenteel 14 dagen), archiveren we deze als Verlopen en melden we Microsoft of de partner die u deze verkoopkans heeft gestuurd.

In het volgende voorbeeld worden de meest recente actieve collectieve-verkoopkansen die door uw organisatie zijn geïnitieerd en waaraan een specifieke verkoper heeft gewerkt.

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

Gerelateerde inhoud