Erstellen einer Empfehlung

Artikel
08/12/2024

In diesem Artikel wird erläutert, wie Sie eine Empfehlung erstellen.

Voraussetzungen

Anmeldeinformationen, wie in der Empfehlungs-API-Authentifizierung beschrieben. In diesem Szenario wird die Authentifizierung mit App- und Benutzeranmeldeinformationen unterstützt.

REST-Anforderung

Anforderungssyntax

Methode	Anforderungs-URI
POST	`https://api.partner.microsoft.com/v1.0/engagements/referrals`

Anforderungsheader

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

Anforderungstext

In der folgenden Tabelle werden die Eigenschaften von Empfehlungsressourcen im Anforderungstext für eine neue Empfehlung beschrieben:

Eigenschaft	Typ	BESCHREIBUNG
Name	Zeichenfolge	Der Name der Empfehlung.
ExternalReferenceID	Zeichenfolge	Ein externer Bezeichner für die Empfehlung. Beispielsweise deine eigene Dynamics 365-Lead- oder -Verkaufschancen-ID.
Status	ReferralStatus	Eine Enumeration mit Werten, die den Status der Empfehlung angeben.
Unterstatus	ReferralSubstatus	Eine Enumeration mit Werten, die den Substatus der Empfehlung angeben.
StatusReason	Zeichenfolge	Eine beschreibende Statusmeldung. Erläutere beispielsweise, warum die Empfehlung nicht erfolgreich war.
ReferralType	ReferralType	Stellt die Art der Empfehlung dar. Erforderlich.
Qualification	ReferralQualification	Stellt die Qualität der Empfehlung dar.
CustomerProfile	CustomerProfile	Die Kontaktinformationen des Kunden. Erforderlich.
Einwilligung	Zustimmung	Zustimmungsflags hinsichtlich der Weitergabe von Informationen an andere Organisationen und der Erlaubnis, Kontakt mit Benutzern aufzunehmen. Erforderlich.
Details	ReferralDetails	Kundendetails, Hinweise, Wert des Geschäfts, Währung und Enddatum. Erforderlich.
Team	Member	Stellt Benutzer in den Organisationen dar, die an dem Partner-Engagement beteiligt sind.
InviteContext	InviteContext	Stellt weitere Informationen dar, die ein Benutzer bereitstellen kann, wenn er eine andere Organisation in das Partner-Engagement einlädt.
Ziel	ReferralTarget	Stellt weitere Informationen dar, die ein Benutzer bereitstellen kann, wenn er eine andere Organisation in das Partner-Engagement einlädt.
Partnerrolle	PartnerRole	Nur für Co-Sell-Empfehlungen für Dienste erforderlich
Lösungsbereich	SolutionArea	Der Lösungsbereich des Kundenbedarfs in der Gelegenheit. Nur für Co-Sell-Empfehlungen für Dienste erforderlich
Lösungswiedergabe	Lösungswiedergabe	Das Lösungsspiel des Kundenbedarfs in der Gelegenheit. Nur für Co-Sell-Empfehlungen für Dienste erforderlich

Anforderungsbeispiel

Wichtig

In dieser Beispielanforderung wird beschrieben, wie Sie eine private Empfehlung mit minimal erforderlichen Informationen erstellen. Beachten Sie, dass der schlüsselparameter, um diese Empfehlung zu einem privaten Deal zu machen, consentToShareReferralWithMicrosoftSellers ist.

POST https://api.partner.microsoft.com/v1.0/engagements/referrals HTTP/1.1
Authorization: Bearer <token>
Host: api.partner.microsoft.com
Content-Type: application/json

 {
	"name": "Contoso Test Deal - [Private]",
	"qualification": "SalesQualified",
	"type": "Independent",
	"customerProfile": {
		"name": "Contoso Customer Inc",
		"address": {
			"addressLine1": "One Microsoft Way",
			"addressLine2": "34",
			"city": "Redmond",
			"state": "WA",
			"postalCode": "98052",
			"country": "US"
		},
		"size": "10to50employees",
		"team": [
			{
				"firstName": "Sue",
				"lastName": "Smith",
				"phoneNumber": "1234567890",
				"email": "sue.smith@contosocustomer.com"
			}
		]
	},
	"consent": {
		"ConsentToToShareInfoWithOthers": true,
		"ConsentToContact": true,
		"ConsentToMicrosoftToContactSpecificPartners": true,
		"consentToShareReferralWithMicrosoftSellers": false
	},
	"details": {
		"notes": "Customer is looking to leverage Dynamics 365 to manage their supply chain. There's also a need to leverage a set of custom apps to enable their business processes.",
		"dealValue": 50000,
		"currency": "USD",
		"closingDateTime": "2024-11-14T00:00:00Z",
		"requirements": {
			"solutions": [
				{
					"type": "Name",
					"id": "SOL-15974-MQF",
					"name": "Contoso-Ale_Test",
					"publisherName": "Contoso_Test",
					"solutionType": "3P"
				}
			],
			"additionalRequirements": {
				"iot": {},
				"attributes": [
					{
						"id": "HaveNotDecided",
						"type": "CustomerMarketplaceIntent"
					}
				]
			}
		}
	},
	"team": [
		{
			"firstName": "John",
			"lastName": "Doe",
			"phoneNumber": "1231231234",
			"email": "john.doe@contoso.com"
		}
	],
	"target": [],
	"mpnId": "<ENTER PARTNER_ID>"
}

REST-Antwort

Bei erfolgreicher Ausführung gibt diese Methode die aufgefüllte Empfehlungsressource im Antworttext zurück.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode, der Erfolg oder Fehler und weitere Debuginformationen angibt. Verwenden Sie ein Netzwerkablaufverfolgungstool, um diesen Code, fehlertyp und andere Parameter zu lesen. Die vollständige Liste findest du unter Partner-API: REST-Fehlercodes.

Beispielantwort

{
	"id": "4eb82669-ccf8-4856-86fc-b9ffe116376b",
	"engagementId": "6d72b13d-8584-4bba-a642-6800b8e32330",
	"name": "Contoso Test Deal - [Private]",
	"organizationId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
	"organizationName": "Contoso Pvt Ltd",
	"lastModifiedVia": "4990cffe-04e8-4e8b-808a-1175604b879f",
	"target": [],
	"createdDateTime": "2024-07-27T14:57:00.0952954Z",
	"updatedDateTime": "2024-07-27T14:57:00.0952954Z",
	"status": "Active",
	"substatus": "Accepted",
	"qualification": "SalesQualified",
	"type": "Independent",
	"customerProfile": {
		"name": "Contoso Customer Inc",
		"address": {
			"addressLine1": "One Microsoft Way",
			"addressLine2": "34",
			"city": "Redmond",
			"state": "WA",
			"postalCode": "98052",
			"country": "US"
		},
		"size": "10to50employees",
		"team": [
			{
				"contactPreference": {
					"locale": "en-us",
					"disableNotifications": false
				},
				"firstName": "Sue",
				"lastName": "Smith",
				"phoneNumber": "1234567890",
				"email": "sue.smith@contosocustomer.com",
				"emailValidationStatus": "None",
				"phoneValidationStatus": "None"
			}
		],
		"ids": [],
		"isMatchingComplete": false
	},
	"consent": {
		"consentToToShareInfoWithOthers": true,
		"consentToContact": true,
		"ConsentToMicrosoftToContactSpecificPartners": true,
		"consentToShareReferralWithMicrosoftSellers": false
	},
	"details": {
		"notes": "Customer is looking to leverage Dynamics 365 to manage their supply chain. There's also a need to leverage a set of custom apps to enable their business processes.",
		"dealValue": 50000.0,
		"currency": "USD",
		"closingDateTime": "2024-11-14T00:00:00Z",
		"requirements": {
			"industries": [],
			"products": [],
			"services": [],
			"solutions": [
				{
					"name": "Contoso-Ale_Test",
					"type": "Name",
					"publisherName": "Contoso_Test",
					"solutionType": "3P",
					"id": "SOL-15974-MQF"
				}
			],
			"additionalRequirements": {
				"iot": {
					"azureCertifiedDevice": false,
					"attachServices": false
				},
				"attributes": [
					{
						"type": "CustomerMarketplaceIntent",
						"id": "HaveNotDecided"
					}
				]
			}
		}
	},
	"team": [
		{
			"contactPreference": {
				"locale": "en-us",
				"disableNotifications": false
			},
			"firstName": "John",
			"lastName": "Doe",
			"phoneNumber": "1231231234",
			"email": "john.doe@contoso.com",
			"emailValidationStatus": "None",
			"phoneValidationStatus": "None"
		}
	],
	"inviteContext": {
		"invitedBy": {
			"organizationId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
			"organizationName": "Contoso Pvt Ltd"
		},
		"assistanceRequestCode": "Unknown",
		"invitedMpnId": "<PARTNER_ID>"
	},
	"favorite": false,
	"trackingInfo": {},
	"direction": "Outgoing",
	"mpnId": "<PARTNER_ID>",
	"dealSensitivity": "None",
	"createdVia": "4990cffe-04e8-4e8b-808a-1175604b879f",
	"acceptedDateTime": "2024-07-27T14:56:59.2938209Z",
	"registrationStatus": "None",
	"links": {
		"relatedReferrals": {
			"uri": "https://api.partner.microsoft.com/v1.0/engagments/referrals?$filter=engagementId eq '6d72b13d-8584-4bba-a642-6800b8e32330'",
			"method": "GET"
		},
		"self": {
			"uri": "https://api.partner.microsoft.com/v1.0/engagments/referrals/4eb82669-ccf8-4856-86fc-b9ffe116376b",
			"method": "GET"
		}
	}
}

Erstellen eines Co-Sell-Deals oder einer geteilten Empfehlung

Es gibt zwei Schritte zum Erstellen eines Co-Sell-Deals oder einer Empfehlung des Typs "Shared Referral":

Erstellen eines partnergeführten Deals, der für Microsoft-Verkäufer sichtbar ist
Erstellen einer Microsoft-Empfehlung mithilfe von Partnerempfehlungendetails

Das folgende Flussdiagramm veranschaulicht diese beiden Schritte beim Erstellen einer freigegebenen Empfehlung.

Flussdiagramm mit einer freigegebenen Empfehlung mit zwei Verweisen, die über die API verbunden sind.

Schritt 1: Erstellen eines partnergeführten Deals, der für Microsoft-Verkäufer sichtbar ist

Erstellen Sie zunächst einen partnergeführten Deal, der für Microsoft-Verkäufer sichtbar ist, indem Sie die folgende Anforderungsnutzlast verwenden.

Wichtig

Beachten Sie, dass eine Empfehlung partnergeführt, consentToShareReferralWithMicrosoftSellers als true angegeben wird. Eine aktive private Empfehlung kann nur durch Aktualisieren der Empfehlung für dieses Feld in partnergeführt werden.

POST https://api.partner.microsoft.com/v1.0/engagements/referrals HTTP/1.1
Authorization: Bearer <token>
Host: api.partner.microsoft.com
Content-Type: application/json

 {
	"name": "Contoso Test Deal - [PartnerLed]",
	"qualification": "SalesQualified",
	"type": "Shared",
	"customerProfile": {
		"name": "Contoso Customer Inc",
		"address": {
			"addressLine1": "One Microsoft Way",
			"addressLine2": "34",
			"city": "Redmond",
			"state": "WA",
			"postalCode": "98052",
			"country": "US"
		},
		"size": "10to50employees",
		"team": [
			{
				"firstName": "Sue",
				"lastName": "Smith",
				"phoneNumber": "1234567890",
				"email": "sue.smith@contosocustomer.com"
			}
		]
	},
	"consent": {
		"ConsentToToShareInfoWithOthers": true,
		"ConsentToContact": true,
		"ConsentToMicrosoftToContactSpecificPartners": true,
		"consentToShareReferralWithMicrosoftSellers": true
	},
	"details": {
		"notes": "Customer is looking to leverage Dynamics 365 to manage their supply chain. There's also a need to leverage a set of custom apps to enable their business processes.",
		"dealValue": 50000,
		"currency": "USD",
		"closingDateTime": "2024-11-14T00:00:00Z",
		"requirements": {
			"solutions": [
				{
					"type": "Name",
					"id": "SOL-15974-MQF",
					"name": "Contoso-Ale_Test",
					"publisherName": "Contoso_Test",
					"solutionType": "3P"
				}
			],
			"additionalRequirements": {
				"iot": {},
				"attributes": [
					{
						"id": "HaveNotDecided",
						"type": "CustomerMarketplaceIntent"
					}
				]
			}
		}
	},
	"team": [
		{
			"firstName": "John",
			"lastName": "Doe",
			"phoneNumber": "1231231234",
			"email": "john.doe@contoso.com"
		}
	],
	"target": [],
	"mpnId": "<ENTER PARTNER_ID>"
}

ReferralTarget stellt zusätzliche Informationen dar, die ein Partner bereitstellen kann, wenn er andere Organisationen in das Engagement einlädt. Wenn Sie "target" in einer Empfehlung für den Typ SolutionProfile angeben möchten, finden Sie hier einen Beispielwert für die Referenz:

"target": [
        {
            "type": "SolutionProfile",
            "id": "SOL-ABC-DEF"
        }
    ]

Hinweis

Der Feldtyp, der in der Anforderungseingabe als unabhängig oder freigegeben bereitgestellt wird, ist nur ein Richtwert und wirkt sich nicht auf den Dealtyp aus. Der tatsächliche Wert, der innerhalb der API zugewiesen ist, basierend auf anderen Parametern wie Consent und inviteContext.

Schritt 2: Erstellen einer Microsoft-Empfehlung mithilfe von Partnerempfehlungendetails

Erstellen Sie dann die Microsoft-Empfehlung über einen anderen API-Aufruf, und verknüpfen Sie sie mit der Partnerempfehlung mithilfe des Felds "Engagement-ID", das aus Schritt 1 zurückgegeben wird.

POST https://api.partner.microsoft.com/v1.0/engagements/referrals HTTP/1.1
Authorization: Bearer <token>
Host: api.partner.microsoft.com
Content-Type: application/json

{
    "engagementId": "<ENGAGEMENT_ID (FROM PARTNER REFERRAL)>",
    "organizationId": "msft",
    "organizationName": "Microsoft",
    "name": "Contoso Test Deal",
    "type": "Shared",
    "qualification": "SalesQualified",
    "customerProfile": {
		"name": "Contoso Customer Inc",
		"address": {
			"addressLine1": "One Microsoft Way",
			"addressLine2": "34",
			"city": "Redmond",
			"state": "WA",
			"postalCode": "98052",
			"country": "US"
		},
		"size": "10to50employees",
		"team": [
			{
				"firstName": "Sue",
				"lastName": "Smith",
				"phoneNumber": "1234567890",
				"email": "sue.smith@contosocustomer.com",
				"emailValidationStatus": "None",
				"phoneValidationStatus": "None"
			}
		],
		"isMatchingComplete": false
	},
    "consent": {
        "consentToToShareInfoWithOthers": true,
        "consentToContact": true,
        "ConsentToMicrosoftToContactSpecificPartners": true,
        "consentToShareReferralWithMicrosoftSellers": true
    },
    "details": {
        "notes": "Test notes to Microsoft.",
        "dealValue": 50000.0,
	"currency": "USD",
        "closingDateTime": "2024-11-14T00:00:00Z"
    },
    "team": [],
    "inviteContext": {
        "notes": "Proof of concept / Demo , Test notes to Microsoft.",
        "invitedBy": {
            "organizationId": "<ORGANIZATION_ID (FROM PARTNER REFERRAL)>",
            "organizationName": "<ORGANIZATION_NAME (FROM PARTNER REFERRAL)>"
        },
        "assistanceRequestCode": "ProofOfConceptOrDemo"
    },
    "target": []
}

Wenn Sie "ReferralTarget" für eine Microsoft-Empfehlung angeben möchten, finden Sie hier einen Beispielwert für die Referenz:

"target": [
        {
            "type": "BusinessProfileLocation",
            "id": "msft"
        }
    ]

Create Services Co-Sell Verkaufschance

Um eine Services Co-Sell-Verkaufschance zu erstellen, müssen PartnerRole, SolutionArea und SolutionPlay in detaillierten > Anforderungen > zusätzliche Anforderungen bereitgestellt werden.
Lösungsdetails sind optional in Services Co-Sell-Verkaufschancen.

"details": {
		"dealValue": 123456,
		"currency": "USD",
		"closingDateTime": "2025-01-21T18:30:00.000Z",
		"notes": "Test Notes",
		"requirements": {
			"solutions": [],
			"additionalRequirements": {
				"attributes": [
					{
						"id": "Adoption and change management",
						"type": "PartnerRole"
					},
					{
						"id": "Data and AI",
						"type": "SolutionArea"
					},
					{
						"id": "Enable Unified Data Governance",
						"type": "SolutionPlay"
					}
				]
			}
		}
	}

Empfehlungsressourcen

Freigeben über

Erstellen einer Empfehlung

Voraussetzungen

REST-Anforderung

Anforderungssyntax

Anforderungsheader

Anforderungstext

Anforderungsbeispiel

REST-Antwort

Erfolgs- und Fehlercodes der Antwort

Beispielantwort

Erstellen eines Co-Sell-Deals oder einer geteilten Empfehlung

Schritt 1: Erstellen eines partnergeführten Deals, der für Microsoft-Verkäufer sichtbar ist

Schritt 2: Erstellen einer Microsoft-Empfehlung mithilfe von Partnerempfehlungendetails

Create Services Co-Sell Verkaufschance

Feedback

Zusätzliche Ressourcen

Freigeben über

Erstellen einer Empfehlung

Voraussetzungen

REST-Anforderung

Anforderungssyntax

Anforderungsheader

Anforderungstext

Anforderungsbeispiel

REST-Antwort

Erfolgs- und Fehlercodes der Antwort

Beispielantwort

Erstellen eines Co-Sell-Deals oder einer geteilten Empfehlung

Schritt 1: Erstellen eines partnergeführten Deals, der für Microsoft-Verkäufer sichtbar ist

Schritt 2: Erstellen einer Microsoft-Empfehlung mithilfe von Partnerempfehlungendetails

Create Services Co-Sell Verkaufschance

Zugehöriger Inhalt

Feedback

Zusätzliche Ressourcen