Hämta listan över leads och affärsmöjligheter

Artikel
03/05/2024

Den här artikeln beskriver hur du hämtar listan över leads som tas emot från Microsofts lösningsleverantörssida och säljsamarbeten som tas emot från Microsoft-säljare eller andra partner. Den här processen hämtar också listan över säljsamarbeten eller pipelineavtal som skapats av din organisation.

Kommentar

Leads som tas emot från Microsofts kommersiella marknadsplats (Azure Marketplace och AppSource) stöds inte.

Förutsättningar

Autentiseringsuppgifter enligt beskrivningen i Partner-API-autentisering. Det här scenariot stöder autentisering med app+användarautentiseringsuppgifter.
Det här API:et stöder för närvarande endast användaråtkomst där partner måste ha någon av följande roller: Global administratör, Referensadministratör eller Referensanvändare.

REST-begäran

Syntax för begäran

Metod	URI för förfrågan
GET	`https://api.partner.microsoft.com/v1.0/engagements/referrals`

OData-åtgärder som stöds

Name	beskrivning	Obligatoriskt	Exempel
$select	Markerar fält	Nej	`/referrals?$select=id,status,customerProfile`
$filter	Filtrerar resultat	Rekommenderat	`/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	Orderresultat	Rekommenderat	`/referrals?$orderby=createdDateTime desc`

Orderby-parametrar som stöds

Använd följande $orderby parametrar för att sortera listan över leads och affärsmöjligheter

Namn	Type	Beskrivning
createdDateTime	Datum/tid	Skapandedatum och tid för leadet eller affärsmöjligheten
updatedDateTime	Datum/tid	Uppdatera datum och tid för leadet eller affärsmöjligheten

Begärandehuvuden

Mer information finns i REST-huvuden för partner.

Begärandetext

Inga.

Exempel på begäran

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

REST-svar

Om det lyckas innehåller svarstexten en samling leads och/eller affärsmöjligheter.

Svarsframgång och felkoder

Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och annan felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och fler parametrar.

Svarsexempel

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

@odata.nextLink Använd för att hämta nästa sida med resultat.

Kommentar

Fälten i det här exemplet är inte uttömmande. Det faktiska API-svaret innehåller fler fält som kund- och partnerteamen. En fullständig lista över fält som stöds finns i referensresurser.

Exempelbegäranden

I följande exempel får du de 10 senaste inkommande säljmöjligheterna. Begäran hämtar affärsmöjligheter som initieras av en Microsoft-säljare eller en annan partner och bjuder in din organisation att delta i en samförsäljningsaktivitet.

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

I följande exempel hämtas de senaste inkommande leadsen och affärsmöjligheterna som inte har besvarats.

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

Viktigt!

Om du inte svarar på ett lead eller en affärsmöjlighet inom den tilldelade tiden (för närvarande 14 dagar) arkiverar vi den som Förfallen och meddelar antingen Microsoft eller partnern som skickade dig den här möjligheten.

I följande exempel får du de senaste aktiva säljmöjligheterna som initierats av din organisation och som en specifik säljare arbetar med.

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

Nästa steg

Skapa en hänvisning

Dela via