Získání seznamu potenciálních zákazníků a příležitostí

Článek
03/05/2024

Tento článek vysvětluje, jak získat seznam zájemců přijatých ze stránky poskytovatele řešení Microsoftu a příležitostí ke spoluprodeji od prodejců Microsoftu nebo jiných partnerů. Tento proces také načte seznam příležitostí ke spoluprodeji nebo obchodů kanálu vytvořených vaší organizací.

Poznámka:

Potenciální zákazníci přijatí z komerčního marketplace Microsoftu (Azure Marketplace a AppSource) se nepodporují.

Požadavky

Přihlašovací údaje, jak je popsáno v ověřování rozhraní Partner API. Tento scénář podporuje ověřování pomocí přihlašovacích údajů aplikace a uživatele.
Toto rozhraní API v současné době podporuje přístup uživatelů pouze v případě, že partneři musí být v jedné z následujících rolí: globální Správa, referenční Správa nebo uživatele referenčního seznamu.

Požadavek REST

Syntaxe požadavku

metoda	Identifikátor URI žádosti
GET	`https://api.partner.microsoft.com/v1.0/engagements/referrals`

Podporované operace OData

Název	Popis	Povinní účastníci	Příklad
$select	Vybere pole.	No	`/referrals?$select=id,status,customerProfile`
$filter	Filtruje výsledky.	Doporučené	`/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	Objednávky výsledků	Doporučené	`/referrals?$orderby=createdDateTime desc`

Podporované parametry orderby

Pomocí následujících parametrů $orderby seřaďte seznam potenciálních zákazníků a příležitostí.

Name	Typ	Popis
createdDateTime	DateTime	Datum a čas vytvoření potenciálního zákazníka nebo příležitosti
updatedDateTime	DateTime	Datum a čas aktualizace potenciálního zákazníka nebo příležitosti

Záhlaví žádosti

Další informace najdete v hlavičce REST partnera.

Text požadavku

Nezaokrouhlovat.

Příklad požadavku

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

Odpověď REST

V případě úspěchu obsahuje text odpovědi kolekci potenciálních zákazníků nebo příležitostí.

Kódy úspěšnosti a chyb odpovědi

Každá odpověď obsahuje stavový kód HTTP, který označuje úspěch nebo selhání a další informace o ladění. Ke čtení tohoto kódu, typu chyby a dalších parametrů použijte nástroj pro trasování sítě.

Příklad odpovědi

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

Pomocí možnosti @odata.nextLink získat další stránku výsledků.

Poznámka:

Pole v tomto příkladu nejsou vyčerpávající. Skutečná odpověď rozhraní API obsahuje více polí, jako jsou zákaznické a partnerské týmy. Úplný seznam podporovaných polí najdete v referenčních zdrojích.

Ukázkové požadavky

Následující příklad získá prvních 10 nejnovějších příchozích příležitostí ke spoluprodeji. Žádost načte příležitosti iniciované obchodním zástupcem Microsoftu nebo jiným partnerem a zve vaši organizaci, aby se účastnila spoluprodejní aktivity.

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

Následující příklad získá nejnovější příchozí potenciální zákazníky a příležitosti, na které nebyly odpovědi.

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

Důležité

Pokud neodpovíte na potenciálního zákazníka nebo příležitost v přiděleném čase (aktuálně 14 dnů), archivujeme ho jako prošlou dobu a oznámíme microsoftu nebo partnerovi, který vám tuto příležitost poslal.

Následující příklad získá nejnovější aktivní příležitosti ke spoluprodeji iniciované vaší organizací a pracuje na konkrétním prodejci.

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

Další kroky

Vytvoření referenčního seznamu