Grundlegende Kundenkontaktverlauf-API-Vorgänge

Artikel
04/01/2022
5 Minuten Lesedauer

Potenzielle Kunden folgen einem bestimmten Weg, wenn sie sich mit Ihrer Firma beschäftigen. Sie beginnen damit, Ihr Produkt zu entdecken, zu bewerten, ob es ihren Bedürfnissen entspricht, nach einem guten Angebot zu suchen und schließlich einen Kauf zu tätigen. Dieser Prozess wird als Kundenkontaktverlauf bezeichnet.

Mit Customer Journeys können Sie ein Modell erstellen, das die Mitglieder von Marketingsegmenten mit Hilfe von automatisierten Nachrichten, der Generierung von Aktivitäten, interaktiven Entscheidungspunkten und vielem mehr durch diesen Prozess leitet. Weitere Informationen: Kundenkontaktverlauf erstellen.

Die Customer Journey API ermöglicht die programmatische Interaktion mit Datensätzen des Kundenkontaktverlaufs, einschließlich Veröffentlichung und Validierung. Die API verwendet die standardmäßige Microsoft Dataverse Web-API für die Bearbeitung von Entitäten und Nachrichten. Weitere Informationen: Verwenden der Microsoft Dataverse-Web-API.

Wenn Sie einen Kundenkontaktverlauf erstellen, werden die Eigenschaften in der msdyncrm_customerjourney-Entität gespeichert. Sie können die Entitätsmetadaten-Informationen mithilfe von @odata.contextin der GET-Antwort durchscuchen.

Hinweis

Bevor Sie Vorgänge durchführen, sollten Sie Dynamics 365 Marketing installieren.

In diesem Artikel wird gezeigt, wie Sie die Vorgänge in der msdyncrm_customerjourney-Entität ausführen. Das Feld msdyncrm_name ist das einzige Pflichtfeld zum Erstellen eines Kundenkontaktverlaufs. Die Felder, die in diesem Artikel verwendet werden, um einen Kundenkontaktverlauf zu erstellen, werden in der folgenden Tabelle angezeigt.

Anzeigename	Schemaname	Beschreibung oder Wert
Name	msdyncrm_name	Name des Kundenkontaktverlaufs
Statusgrund	statuscode	Aktueller Status des Kundenkontaktverlaufs. Das sind die verfügbaren Statuscodes: - Entwurf `192350000` - Live `192350001` - Beendet `192350002` - Live, Bearbeitbar `192350003` - Fehler `192350005` - Liveschalten `192350006` - Wird beendet `192350007`
Unterdrückungssegment	msdyncrm_SuppressionSegmentId	Die ID des zugeordneten Unterdrückungssegments. Verwenden Sie es, um einen Verweis auf einen Datensatz der `msdyncrm_segments`-Datensatzgruppe festzulegen.
Serienintervall (Tage)	msdyncrm_recurrenceintervaldays	Die Dauer der Iteration (in Tagen). Nicht negative ganze Zahl.
Mindestzustimmung	msgdpr_requiredconsent	- (1) Zustimmung `587030001` - (2) Transaktionen `587030002` - (3) Abonnements `587030003` - (4) Marketing `587030004` - (5) Profilerstellung `587030005`
Anzahl der Serie	msdyncrm_recurrencecount	Die Anzahl der Iterationen. Nicht negative ganze Zahl.
Workflowdefinition	msdyncrm_workflowdefinition	Die Definition des Kundenkontaktverlauf-Designs Weitere Informationen: Kundenkontaktverlauf-Workflowdefinition.
Kundenkontakt-Designerstatus	msdyncrm_customerjourneydesignerstate	Dies ist ein ausgeblendetes Feld, das vom Kundenkontakt-Designer verwendet wird, um dessen internen Status zu persistieren. Das Feld sollte kopiert werden, wenn Sie eine Kopie des Felds `msdyncrm_workflowdefinition` aus einem anderen Kundenkontaktverlauf oder einem Kundenkontaktverlaufs-Vorlagendatensatz erstellen.
Zeitzone	msdyncrm_customerjourneytimezone	Effektive Zeitzone für den Kundenkontaktverlauf.
Inhaltseinstellungen	msdyncrm_contentsettingsId	Die ID zugeordneter Inhaltseinstellungen. Verwenden Sie es, um auf einen Datensatz der `msdyncrm_contentsettingss`-Datensatzgruppe zu verweisen.
Enddatum und -zeit	msdyncrm_enddatetime	Datum-/Uhrzeitwert im `ISO 8601`-UTC-Format. Beachten Sie, dass die Genauigkeit von Sekunden und Millisekunden nicht berücksichtigt wird.
Startdatum und -zeit	msdyncrm_startdatetime	Datum-/Uhrzeitwert im `ISO 8601`-UTC-Format. Beachten Sie, dass die Genauigkeit von Sekunden und Millisekunden nicht berücksichtigt wird.
Periodisch wiederkehrend	msdyncrm_isrecurring	Ein boolescher Wert.
Entitätsziel	msdyncrm_entitytarget	- Kontakt `0` - Konto `1`
Typ	msdyncrm_type	- Automatisiert `192350000` - LinkedIn `192350001`
Status	statecode	Status des Kundenkontaktverlaufs.

Hinweis

Die Felder statuscode und statecode definieren den Status des Kundenkontaktverlaufs. Das Ändern Ihrer Werte kann zum Publishing oder Stopping des Kundenkontaktverlauf-Workflows führen. Wenn Sie go live (live schalten) möchten, speichern Sie den Datensatz im Status Going Live (Statuscode = 192350006). Um einen Kundenkontaktverlauf-Datensatz zu beenden, speichern Sie den Live-Datensatz im Status Stopping (statuscode = 192350007).

Verwenden Sie das Postman-Tool, um die Vorgänge zu testen. Weitere Informationen: Postman mit Web-API verwenden

Erstellen, Abrufen, Aktualisieren sowie Löschen von Vorgängen

Anforderung erstellen

Diese Anforderung erstellt einen Kundenkontaktverlauf-Datensatz und legt den statuscode auf Draft fest. Dieser Kundenkontaktverlauf umfasst ein Segment mit ID:24db2671-1529-e911-a9b7-000d3a1e6adc und Unique Name: TC407937_DynamicSegment_2KZQ1p sowie eine E-Mail mit ID: 15bd0ab8-c12a-e911-a9b6-000d3a1e6c14. die effektiven Inhaltseinstellungen haben Datensatz ID: 1922b1d8-0523-e911-a9ba-000d3a1e689f. Die Antwortkopfzeile OData-EntityId enthält die URL dieses neu erstellten Datensatzes (Entitätsinstanz), die in Klammern die eindeutige ID dieses Datensatzes enthält.

Wichtig

Sie müssen OrgUrl durch https://<add your environment name, like ‘myorg.crm’>.dynamics.com ersetzen. Sie können den Umgebungsnamen auch von Einstellungen > Anpassungen > Entwicklerressourcen abrufen.

POST {{OrgUrl}}/api/data/v9.0/msdyncrm_customerjourneys
{
    "msgdpr_requiredconsent": 587030001,
    "msdyncrm_customerjourneydesignerstate": "{\"NextActivityID\":8,\"NextActivityItemID\":42}",
    "msdyncrm_workflowdefinition": "[{\"ActivityTypeId\":\"bpf_root\",\"ParentBranchId\":0,\"ParentRelationshipType\":\"Default\",\"ActivityId\":\"01\",\"Properties\":{\"Items\":[{\"ItemId\":null,\"ActivityTypeId\":\"bpf_root\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"New ActivityTypeName_bpf_root_TitleText\",\"ActivityItemId\":0}]}},{\"ActivityTypeId\":\"Segment\",\"ParentActivityId\":\"01\",\"ParentBranchId\":0,\"ParentRelationshipType\":\"Default\",\"ActivityId\":\"01_0\",\"Properties\":{\"Items\":[{\"ItemId\":null,\"ActivityTypeId\":\"Segment\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"New Segment group\",\"ActivityItemId\":23,\"SegmentMergeMethod\":\"Union\"},{\"ItemId\":\"24db2671-1529-e911-a9b7-000d3a1e6adc\",\"ActivityTypeId\":\"SegmentItem\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"TC407937_DynamicSegment_2KZQ1p\",\"ActivityItemId\":24,\"ContainmentMethod\":\"Inclusion\",\"SegmentSourceType\":\"Segment\",\"DciSegmentName\":\"TC407937_DynamicSegment_2KZQ1p\",\"SegmentDisplayName\":\"TC407937_DynamicSegment_2KZQ1p\",\"Description\":\"\"}]},\"EntityTarget\":\"contact\"},{\"ActivityTypeId\":\"Email\",\"ParentActivityId\":\"01_0\",\"ParentBranchId\":0,\"ParentRelationshipType\":\"Default\",\"ActivityId\":\"01_0_2\",\"Properties\":{\"Items\":[{\"ItemId\":\"15bd0ab8-c12a-e911-a9b6-000d3a1e6c14\",\"ActivityTypeId\":\"Email\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"Relationship test\",\"ActivityItemId\":32}]},\"EntityTarget\":\"contact\"}]",
    "msdyncrm_customerjourneytimezone": 92,
    "msdyncrm_contentsettingsId@odata.bind": "/msdyncrm_contentsettingss(1922b1d8-0523-e911-a9ba-000d3a1e689f)",
    "msdyncrm_enddatetime": "2019-03-09T11:29:00.000Z",
    "msdyncrm_startdatetime": "2019-02-09T11:29:00.000Z",
    "msdyncrm_name": "Simple Email Sample",
    "msdyncrm_isrecurring": false,
    "msdyncrm_type": 192350000,
    "msdyncrm_entitytarget": 0,
    "statuscode": 192350000,
    "statecode": 0,
    "ownerid@odata.bind": "/systemusers(d0e20c01-d6c6-480f-aab5-0fa6749565a5)"
}

Anforderung abrufen

Die Abrufanforderung ruft die Liste von Live-Kundenkontaktverläufen ab.

GET {{OrgUrl}}/api/data/v9.0/msdyncrm_customerjourneys?$filter=statuscode eq 192350001

Anforderung aktualisieren

Mit der Aktualisierungsanforderung aktualisieren Sie statuscode, wodurch effektiv die Veröffentlichung erfolgt.

PATCH {{OrgUrl}}api/data/v9.0/msdyncrm_customerjourneys(8aee9d91-8c2b-e911-a9b7-000d3a1e6adc)
{
    "statuscode": 192350006
}

Anforderung löschen

Mit dem Löschvorgang löschen Sie den Kundenkontaktverlauf, den Sie zuvor erstellt haben.

DELETE {{OrgUrl}}/api/data/v9.0/msdyncrm_customerjourneys(b6faa2b7-b92b-e911-8185-000d3af9d16a)

Auf Fehler überprüfen

Die Funktion „Auf Fehler überprüfen“ überprüft den aktuellen Datensatz auf fehlenden Inhalt und technische Fehler. Dann werden die Überprüfungsergebnisse angezeigt, einschließlich Fehlermeldungen, die dem Benutzer dabei helfen sollten, sämtliche gefundenen Probleme zu beheben.

Der Anforderungstext ist ein JSON-Objekt, das die Zahl der Datenelemente mit den Werten enthält, die den Entitätseigenschaften msdyncrm_customerjourney entsprechen. Das Referenzfeld (beispielsweise, Inhaltseinstellungs-ID) verwendet @odata.bind nicht mit dem Datensatzgruppen-Verweis, aber verwendet die ID des referenzierten Datensatzes. In der folgenden Tabelle wird die Zuordnung erklärt.

Key	Entsprechende Eigenschaft msdyncrm_customerjourney-Entität (logischer Name)
FieldValueCustomerJourneyId	msdyncrm_customerjourneyid
FieldValueStatusCode	statuscode
FieldValueName	msdyncrm_name
FieldValueStartDateTime	msdyncrm_startdatetime
FieldValueEndDateTime	msdyncrm_enddatetime
FieldValueWorkflowDefinition	msdyncrm_workflowdefinition
FieldValueIsRecurring	msdyncrm_isrecurring
FieldValueRecurrenceIntervalDays	msdyncrm_recurrenceintervaldays
FieldValueRecurrenceCount	msdyncrm_recurrencecount
FieldValueRequiredConsent	msgdpr_requiredconsent
FieldValueEntityTarget	msdyncrm_entitytarget
FieldValueSuppressionSegmentId	msdyncrm_suppressionsegmentid
FieldValueCustomerJourneyTimeZone	msdyncrm_customerjourneytimezone

Kundenkontaktverlaufsanforderung überprüfen

POST {{OrgUrl}}/api/data/v9.0/msdyncrm_CustomerJourneyValidate
{
    "FieldValueCustomerJourneyId": "{6628BBF7-C52A-E911-A9B7-000D3A1E6ADC}",
    "FieldValueStatusCode": 192350000,
    "FieldValueName": "Sample Customer Journey",
    "FieldValueStartDateTime": "2019-02-08T11:48:00.000Z",
    "FieldValueEndDateTime": "2019-03-08T11:48:00.000Z",
    "FieldValueWorkflowDefinition": "[{\"ActivityTypeId\":\"bpf_root\",\"ParentBranchId\":0,\"ParentRelationshipType\":\"Default\",\"ActivityId\":\"01\",\"Properties\":{\"Items\":[{\"ItemId\":null,\"ActivityTypeId\":\"bpf_root\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"New ActivityTypeName_bpf_root_TitleText\",\"ActivityItemId\":0}]}},{\"ActivityTypeId\":\"Segment\",\"ParentActivityId\":\"01\",\"ParentBranchId\":0,\"ParentRelationshipType\":\"Default\",\"ActivityId\":\"01_0\",\"Properties\":{\"Items\":[{\"ItemId\":null,\"ActivityTypeId\":\"Segment\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"New Segment group\",\"ActivityItemId\":52,\"SegmentMergeMethod\":\"Union\"},{\"ItemId\":\"056bbe66-f025-e911-a9ba-000d3a1e689f\",\"ActivityTypeId\":\"SegmentItem\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"TC407937_DynamicSegment_bmkX5u\",\"ActivityItemId\":53,\"ContainmentMethod\":\"Inclusion\",\"SegmentSourceType\":\"Segment\",\"DciSegmentName\":\"TC407937_DynamicSegment_bmkX5u\",\"SegmentDisplayName\":\"TC407937_DynamicSegment_bmkX5u\",\"Description\":\"\"}]},\"EntityTarget\":\"contact\"},{\"ActivityTypeId\":\"Email\",\"ParentActivityId\":\"01_0\",\"ParentBranchId\":0,\"ParentRelationshipType\":\"Default\",\"ActivityId\":\"01_0_3\",\"Properties\":{\"Items\":[{\"ItemId\":\"15bd0ab8-c12a-e911-a9b6-000d3a1e6c14\",\"ActivityTypeId\":\"Email\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"Relationship test\",\"ActivityItemId\":61}]},\"EntityTarget\":\"contact\"}]",
    "FieldValueIsRecurring": true,
    "FieldValueRecurrenceIntervalDays": 30,
    "FieldValueRecurrenceCount": 3,
    "FieldValueRequiredConsent": 587030001,
    "FieldValueContentSettingsId": "{1922B1D8-0523-E911-A9BA-000D3A1E689F}",
    "FieldValueEntityTarget": 0,
    "FieldValueSuppressionSegmentId": "{544A3E20-9B23-E911-A9B6-000D3A1E6C14}",
    "FieldValueCustomerJourneyTimeZone": 92
}

Kundenkontaktverlaufsantwort überprüfen

{
    "@odata.context": "{{orgUrl}}/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msdyncrm_CustomerJourneyValidateResponse",
    "ValidationResult": "{\"ActivityValidationResults\":[{\"ActivityId\":\"\",\"Fault\":\"ErrorRecurringCampaignEndDateDoesNotFitRequestedIterations\",\"Result\":\"Error\",\"ErrorMessageArguments\":[]}],\"Result\":\"Error\"}"
}

Überprüfungsergebnis

Die folgende Tabelle beschreibt das Schema des ValidationResult-Objekts, das in Kundenkontaktverlaufsantwort überprüfen empfangen wird.

Eigenschaft	Typ	Beschreibung
Ergebnis	String	Das Gesamtfehlerüberprüfungsergebnis. Es hat die folgenden Werte: Gültig – Datensätze, die die Validierungsprüfung bestanden haben. Warnung – Datensätze, die die Validierungsprüfung bestanden haben; es gibt dabei nicht blockierende Probleme. Fehler – Datensätze, die die Validierung nicht bestanden haben; es gibt dabei blockierende Probleme.
ActivityValidationResults	`Object[]`	Ein Array von Validierungsdetail-Objekten. Jedes verweist auf ein spezifisches Problem, das für den Kundenkontaktverlauf-Datensatz gelten kann, eine spezifische Kachel innerhalb des Workflow-Designs. Siehe das Aktivitätsvalidierungs-Ergebnisschema.

Aktivitätsvalidierungsergebnis

Die folgende Tabelle zeigt das Schema von Objekten, die im Array ActivityValidationResults des Objekts ValidationResult enthalten sind.

Eigenschaft	Typ	Beschreibung
ActivityId	String	Die Aktivitäts-ID der tatsächlichen Workflowkachel, für die das Validierungsergebnis gilt. Wenn sie leer ist, gilt das Validierungsergebnis global für die gesamte Workflowdefinition oder andere Eigenschaften des Kundenkontaktverlaufs.
Fehler	String	Der Code, der das tatsächliche Validierungsergebnis identifiziert. Zeigen Sie die Validierung an Beispiel, um zu erfahren, wie Sie mit Nachrichten arbeiten, die Fehlercodes zugeordnet sind.
Ergebnis	String	Der Ergebnisschweregrad. Es hat die folgenden Werte: Gültig – informativer Eintrag Warnung – Nicht blockierendes Problem Fehler – Blockierendes Problem
ErrorMessageArguments	String[]	Optionale Liste von Argumenten, die Details des Validierungsergebnisses bereitstellt, beispielsweise eine ID des Elements, das nicht den Gültigkeitskriterien entspricht.

Siehe auch

Grundlegende Vorgänge zu Kundenkontaktverlauf mithilfe von C#
Kundenkontaktverlauf-Workflowdefinition
Verwenden Sie einen Kundenkontaktverlauf zur Erstellung automatisierter Kampagnen
Kundenkontaktverläufe erstellen

Hinweis

Können Sie uns Ihre Präferenzen für die Dokumentationssprache mitteilen? Nehmen Sie an einer kurzen Umfrage teil. (Beachten Sie, dass diese Umfrage auf Englisch ist.)

Die Umfrage dauert etwa sieben Minuten. Es werden keine personenbezogenen Daten erhoben. (Datenschutzbestimmungen).

Grundlegende Kundenkontaktverlauf-API-Vorgänge

Erstellen, Abrufen, Aktualisieren sowie Löschen von Vorgängen

Anforderung erstellen

Anforderung abrufen

Anforderung aktualisieren

Anforderung löschen

Auf Fehler überprüfen

Kundenkontaktverlaufsanforderung überprüfen

Kundenkontaktverlaufsantwort überprüfen

Überprüfungsergebnis

Aktivitätsvalidierungsergebnis

Siehe auch

Feedback