Pobieranie listy potencjalnych klientów i szans sprzedaży

W tym artykule wyjaśniono, jak uzyskać listę potencjalnych klientów i możliwości wspólnej sprzedaży. Ci potencjalni klienci otrzymują od strony dostawcy rozwiązań firmy Microsoft, natomiast możliwości wspólnej sprzedaży są odbierane od sprzedawców firmy Microsoft lub innych partnerów. Ten proces pobiera również listę szans wspólnej sprzedaży lub transakcji potoku utworzonych przez organizację.

Uwaga

Potencjalni klienci otrzymywani z komercyjnej platformy handlowej firmy Microsoft (Azure Marketplace i AppSource) nie są obsługiwani.

Wymagania wstępne

• Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie interfejsu API poleceń. Ten scenariusz obsługuje uwierzytelnianie przy użyciu poświadczeń aplikacji i użytkownika.
• Ten interfejs API obsługuje obecnie tylko dostęp użytkowników, w których partnerzy muszą należeć do jednej z następujących ról: Administrator poleceń lub Użytkownik poleceń.

Żądanie REST

Składnia żądania

Method	Identyfikator URI żądania
GET	https://api.partner.microsoft.com/v1.0/engagements/referrals

Obsługiwane operacje OData

Nazwa/nazwisko	opis	Wymagania	Przykład
$select	Zaznacza pola	Nie.	/referrals?$select=id,status,customerProfile
$filter	Filtruje wyniki	Zalecane	/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	Wyniki zamówień	Zalecane	/referrals?$orderby=createdDateTime desc

Obsługiwane parametry orderby

Użyj następujących parametrów $orderby, aby posortować listę potencjalnych klientów i szans sprzedaży

Nazwisko	Pisz	Opis
createdDateTime	DateTime	Data i godzina utworzenia potencjalnego klienta lub szansy sprzedaży
updatedDateTime	DateTime	Data i godzina aktualizacji potencjalnego klienta lub szansy sprzedaży

Nagłówki żądań

Aby uzyskać więcej informacji, zobacz Nagłówki REST partnera.

Treść żądania

Brak.

Przykład żądania

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

Odpowiedź REST

W przypadku powodzenia treść odpowiedzi zawiera kolekcję potencjalnych klientów i/lub szans sprzedaży.

Kody powodzenia i błędów odpowiedzi

Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i inne informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i więcej parametrów.

Przykład odpowiedzi

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

Użyj polecenia , @odata.nextLink aby uzyskać następną stronę wyników.

Uwaga

Pola w tym przykładzie nie są wyczerpujące. Rzeczywista odpowiedź interfejsu API zawiera więcej pól, takich jak zespoły klienta i partnerów. Aby uzyskać pełną listę obsługiwanych pól, zobacz zasoby poleceń.

Przykładowe żądania

Poniższy przykład pobiera 10 najnowszych szans wspólnej sprzedaży dla ruchu przychodzącego. Żądanie pobiera możliwości zainicjowane przez przedstawiciela sprzedaży firmy Microsoft lub innego partnera, zapraszając organizację do udziału w działaniu wspólnej sprzedaży.

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

W poniższym przykładzie pobrano najnowsze potencjalnych klientów przychodzących i możliwości, na które nie odpowiadano.

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

Ważne

Jeśli nie odpowiesz na potencjalnego klienta lub szansę sprzedaży w wyznaczonym czasie (obecnie 14 dni), zarchiwizujemy je jako Wygasłe i powiadomimy firmę Microsoft lub partnera, który wysłał Ci tę szansę sprzedaży.

Poniższy przykład pobiera najnowsze aktywne możliwości wspólnej sprzedaży zainicjowane przez organizację i pracuje nad konkretnym sprzedawcą.

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

Powiązana zawartość

• Tworzenie polecenia