Courier (Unabhängiger Herausgeber) (Vorschau)

Courier ist ein Service- und Webstudio für Entwicklungsteams, um alle vom Produkt ausgelösten Kommunikationen (E-Mail, Chat, In-App, SMS, Push usw.) an einem Ort zu verwalten. Courier wurde für Entwickler entwickelt, die eine außergewöhnliche Benachrichtigungserfahrung bereitstellen möchten.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung	Class	Regions
Copilot Studio	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:      - US Government (GCC)      - US Government (GCC High)      - China Cloud betrieben von 21Vianet      - US Department of Defense (DoD)
Logik-Apps	Norm	Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:      – Azure Government-Regionen      - Azure China-Regionen      - US Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps-Regionen mit Ausnahme der folgenden:      - US Government (GCC)      - US Government (GCC High)      - China Cloud betrieben von 21Vianet      - US Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:      - US Government (GCC)      - US Government (GCC High)      - China Cloud betrieben von 21Vianet      - US Department of Defense (DoD)

Kontakt
Name	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Connectormetadaten
Herausgeber	Troy Taylor
Webseite	https://www.courier.com/
Datenschutzrichtlinie	https://www.courier.com/privacy/
Kategorien	Kommunikation; Soziale Medien

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe	Parameter zum Erstellen einer Verbindung.	Alle Regionen	Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name	Typ	Description	Erforderlich
Token (in Form "Bearer yourToken")	securestring	Das Token (in Form "Bearer yourToken") für diese API	Richtig

Drosselungsgrenzwerte

Name	Aufrufe	Verlängerungszeitraum
API-Aufrufe pro Verbindung	100	60 Sekunden

Aktionen

Abrufen aller Empfängerlisten	Dient zum Abrufen einer Liste aller Empfängerlisten.
Abrufen aller Überwachungsereignisse	Dient zum Abrufen einer Liste von Überwachungsereignissen.
Abrufen der Abonnements der Liste	Ruft die Abonnements für eine Liste ab.
Abrufen der Benutzer eines Massenauftrags	Rufen Sie die Benutzer eines Massenauftrags ab.
Abrufen des Inhalts einer Nachricht	Dient zum Abrufen des Inhalts einer zuvor gesendeten Nachricht.
Abrufen des Verlaufs einer Nachricht	Dient zum Abrufen der Ereignisse einer zuvor gesendeten Nachricht.
Abrufen einer Liste	Dient zum Abrufen der Elemente einer Liste.
Abrufen einer Nachricht	Rufen Sie den Status einer Nachricht ab.
Abrufen einer Zielgruppe	Gibt die angegebene Zielgruppe nach Bezeichner zurück.
Abrufen eines Massenauftrags	Rufen Sie die Informationen zu einem Massenauftrag ab.
Abrufen eines Profils	Ruft das angegebene Empfängerprofil ab.
Abrufen eines Überwachungsereignisses	Rufen Sie ein bestimmtes Überwachungsereignis anhand des Bezeichners ab.
Aktualisieren einer Liste	Erstellt oder ersetzt eine vorhandene Liste durch die angegebenen Werte.
Aktualisieren eines Profils	Aktualisiert in einem Teil eines Profils.
Alle Zielgruppen auflisten	Rufen Sie alle Benutzergruppen ab, die Ihrem Konto zugeordnet sind.
Archiv einer Nachricht	Fordern Sie an, dass eine Nachricht archiviert wird.
Ausführen einer Ad-hoc-Automatisierung	Rufen Sie eine Automatisierung in einer Ad-hoc-Ausführung auf.
Ausführen einer vorlagenbasierten Automatisierung	Rufen Sie eine Automatisierungsausführung aus einer Automatisierungsvorlage auf.
Ausführen eines Massenauftrags	Starten Sie die Ausführung eines Massenauftrags.
Benachrichtigungen auflisten	Ruft eine Liste von Benachrichtigungen ab.
Benutzergruppenmitglieder auflisten	Dient zum Abrufen einer Liste von Mitgliedern einer Zielgruppe.
Ein Profil löschen	Löscht das angegebene Empfängerprofil.
Erstellen einer Marke	Erstellt eine neue Marke aus den bereitgestellten Einstellungen.
Erstellen eines Massenauftrags	Erstellt einen Massenauftrag für die bereitgestellten Nachrichtenparameter.
Erstellen eines Profils	Führen Sie die angegebenen Werte mit einem vorhandenen Profil zusammen, oder erstellen Sie ein neues Profil, wenn noch kein Profil vorhanden ist.
Erstellen oder Aktualisieren einer Benutzergruppe	Erstellt oder aktualisiert eine Benutzergruppe basierend auf den bereitgestellten Parametern und Filtern.
Hinzufügen von Abonnenten zu einer Liste	Fügen Sie einer Liste weitere Abonnenten hinzu.
Hinzufügen von Benutzern zu einem Massenauftrag	Aufnehmen von Benutzerdaten in einen Massenauftrag.
Kündigen eines Benutzers aus einer Liste	Löscht ein Abonnement für eine Liste nach Listen- und Empfänger-IDs.
Löschen einer Benutzergruppe	Löscht die angegebene Empfängergruppe.
Löschen einer Liste	Löscht eine Liste nach Listenbezeichner.
Marke abrufen	Rufen Sie eine bestimmte Marke nach Bezeichner ab.
Marken auflisten	Dient zum Abrufen einer Liste von Marken.
Nachricht senden	Sendet eine Nachricht an einen oder mehrere Empfänger.
Nachrichten auflisten	Abrufen der Status von zuvor gesendeten Nachrichten.
Wiederherstellen einer Liste	Stellt eine vorhandene Liste anhand des Bezeichners wieder her.

Abrufen aller Empfängerlisten

Vorgangs-ID:

ListsGet

Dient zum Abrufen einer Liste aller Empfängerlisten.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Mauszeiger	paging.cursor	string	Der Cursor.
Mehr	paging.more	boolean	Ob es mehr gibt.
Ergebnisse	results	array of object
Erstellt	results.created	string	Beim Erstellen.
ID	results.id	string	Der Bezeichner.
Name	results.name	string	Der Name.
Updated	results.updated	string	Wenn aktualisiert.

Abrufen aller Überwachungsereignisse

Vorgangs-ID:

AuditEventsGet

Dient zum Abrufen einer Liste von Überwachungsereignissen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Mauszeiger	cursor		string	Der Cursor.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Mauszeiger	paging.cursor	string	Der Cursor.
Mehr	paging.more	boolean	Ob es mehr gibt.
Ergebnisse	results	array of object
Überwachungsereignis-ID	results.auditEventId	string	Der Überwachungsereignisbezeichner.
ID	results.actor.id	string	Der Bezeichner.
Email	results.actor.email	string	Die E-Mail-Adresse.
ID	results.target.id	string	Der Bezeichner.
Email	results.target.email	string	Die E-Mail-Adresse.
Quelle	results.source	string	Die Quelle.
Zeitstempel	results.timestamp	string	Der Zeitstempel.
Typ	results.type	string	Der Typ.

Abrufen der Abonnements der Liste

Vorgangs-ID:

ListSubscriptionsGet

Ruft die Abonnements für eine Liste ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Listen-ID	list_id	True	string	Der Listenbezeichner.
Mauszeiger	cursor		string	Der Cursor.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Mauszeiger	paging.cursor	string	Der Cursor.
Mehr	paging.more	boolean	Ob es mehr gibt.
Gegenstände	items	array of object
Empfänger-ID	items.recipientId	string	Der Empfängerbezeichner.
Erstellt	items.created	string	Beim Erstellen.

Abrufen der Benutzer eines Massenauftrags

Vorgangs-ID:

BulkJobUsersGet

Rufen Sie die Benutzer eines Massenauftrags ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Auftrags-ID	job_id	True	string	Die Job-ID.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Gegenstände	items	array of object
Recipient	items.recipient	string	Der Empfänger.
Email	items.email	string	Die E-Mail-Adresse.
Gebietsschema	items.locale	string	Das Gebietsschema.
Mauszeiger	paging.cursor	string	Der Cursor.
Mehr	paging.more	boolean	Ob es mehr gibt.

Abrufen des Inhalts einer Nachricht

Vorgangs-ID:

MessageContentGet

Dient zum Abrufen des Inhalts einer zuvor gesendeten Nachricht.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Nachrichten-ID	message_id	True	string	Der Nachrichtenbezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Ergebnisse	results	array of object
Kanal	results.channel	string	Der Kanal.
Kanal-ID	results.channel_id	string	Der Kanalbezeichner.
HTML	results.content.html	string	Der HTML-Code.
Betreff	results.content.subject	string	Der Betreff.
Text	results.content.text	string	Der Text.
Blöcke	results.content.blocks	array of object
Typ	results.content.blocks.type	string	Der Typ.
Text	results.content.blocks.text	string	Der Text.

Abrufen des Verlaufs einer Nachricht

Vorgangs-ID:

MessageHistoryGet

Dient zum Abrufen der Ereignisse einer zuvor gesendeten Nachricht.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Nachrichten-ID	message_id	True	string	Der Nachrichtenbezeichner.
Typ	type		string	Der Typ.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Ergebnisse	results	array of object
Name	results.data.name	string	Der Name.
Event	results.event	string	Das Ereignis.
Recipient	results.recipient	string	Der Empfänger.
TS	results.ts	integer	Das TS.
Typ	results.type	string	Der Typ.
Ereignis-ID	results.event_id	string	Der Ereignisbezeichner.
Benachrichtigungs-ID	results.notification_id	string	Der Benachrichtigungsbezeichner.
ID	results.channel.id	string	Der Bezeichner.
ID	results.integration.id	string	Der Bezeichner.
Provider	results.integration.provider	string	Der Anbieter.

Abrufen einer Liste

Vorgangs-ID:

ListGet

Dient zum Abrufen der Elemente einer Liste.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Listen-ID	list_id	True	string	Der Listenbezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Erstellt	created	string	Beim Erstellen.
ID	id	string	Der Bezeichner.
Name	name	string	Der Name.
Updated	updated	string	Die Aktualisierung.

Abrufen einer Nachricht

Vorgangs-ID:

MessageGet

Rufen Sie den Status einer Nachricht ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Nachrichten-ID	message_id	True	string	Der Nachrichtenbezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	id	string	Der Bezeichner.
Der Status	status	string	Der Status.
Enqueued	enqueued	integer	Die Queued.
Gesendet	sent	integer	Der gesendete.
Geliefert	delivered	integer	Die geliefert.
Geöffnet	opened	integer	Das geöffnete.
Geklickt	clicked	integer	Das Geklickt.
Recipient	recipient	string	Der Empfänger.
Event	event	string	Das Ereignis.
Notification	notification	string	Die Benachrichtigung.
Fehler	error	string	Der Fehler.
Ursache	reason	string	Der Grund.
Providers	providers	array of object
Gesendet	providers.sent	integer	Der gesendete.
Geliefert	providers.delivered	integer	Die geliefert.
Geklickt	providers.clicked	integer	Das Geklickt.
Geöffnet	providers.opened	integer	Das geöffnete.
Fehler	providers.error	string	Der Fehler.
Provider	providers.provider	string	Der Anbieter.
Der Status	providers.status	string	Der Status.

Abrufen einer Zielgruppe

Vorgangs-ID:

AudienceGet

Gibt die angegebene Zielgruppe nach Bezeichner zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Benutzergruppen-ID	audience_id	True	string	Der Zielgruppenbezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	id	string	Der Bezeichner.
Name	name	string	Der Name.
Description	description	string	Die Beschreibung.
Bediener	filter.operator	string	Der Operator.
Wert	filter.value	string	Der Wert.
Pfad	filter.path	string	Der Pfad.

Abrufen eines Massenauftrags

Vorgangs-ID:

BulkJobGet

Rufen Sie die Informationen zu einem Massenauftrag ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Auftrags-ID	job_id	True	string	Die Job-ID.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Event	job.definition.event	string	Das Ereignis.
Enqueued	job.enqueued	integer	Die Queued.
Ausfälle	job.failures	integer	Die Fehler.
Empfangen	job.received	integer	Wenn sie empfangen werden.
Der Status	job.status	string	Der Status.

Abrufen eines Profils

Vorgangs-ID:

ProfileGet

Ruft das angegebene Empfängerprofil ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Empfänger-ID	recipient_id	True	string	Der Empfängerbezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Email	profile.email	string	Die E-Mail-Adresse.
Rufnummer	profile.phone_number	string	Die Telefonnummer.

Abrufen eines Überwachungsereignisses

Vorgangs-ID:

AuditEventGet

Rufen Sie ein bestimmtes Überwachungsereignis anhand des Bezeichners ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Überwachungsereignis-ID	audit-event-id	True	string	Der Überwachungsereignisbezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Überwachungsereignis-ID	auditEventId	string	Der Überwachungsereignisbezeichner.
ID	actor.id	string	Der Bezeichner.
Email	actor.email	string	Die E-Mail-Adresse.
ID	target.id	string	Der Bezeichner.
Email	target.email	string	Die E-Mail-Adresse.
Quelle	source	string	Die Quelle.
Zeitstempel	timestamp	string	Der Zeitstempel.
Typ	type	string	Der Typ.

Aktualisieren einer Liste

Vorgangs-ID:

ListPut

Erstellt oder ersetzt eine vorhandene Liste durch die angegebenen Werte.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Listen-ID	list_id	True	string	Der Listenbezeichner.
Name	name		string	Der Name.

Gibt zurück

response

string

Aktualisieren eines Profils

Vorgangs-ID:

ProfilePatch

Aktualisiert in einem Teil eines Profils.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Empfänger-ID	recipient_id	True	string	Der Empfängerbezeichner.
Operation	op		string	Der Vorgang.
Pfad	path		string	Der Pfad.
Wert	value		string	Der Wert.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Der Status	status	string	Der Status.

Alle Zielgruppen auflisten

Vorgangs-ID:

AudiencesGet

Rufen Sie alle Benutzergruppen ab, die Ihrem Konto zugeordnet sind.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Mauszeiger	cursor		string	Der Cursor.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Gegenstände	items	array of object
ID	items.id	string	Der Bezeichner.
Name	items.name	string	Der Name.
Description	items.description	string	Die Beschreibung.
Bediener	items.filter.operator	string	Der Operator.
Wert	items.filter.value	string	Der Wert.
Pfad	items.filter.path	string	Der Pfad.
Mauszeiger	paging.cursor	string	Der Cursor.
Mehr	paging.more	boolean	Ob es mehr gibt.

Archiv einer Nachricht

Vorgangs-ID:

MessagePut

Fordern Sie an, dass eine Nachricht archiviert wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Anfrage-ID	request_id	True	string	Der Anforderungsbezeichner.

Gibt zurück

response

string

Ausführen einer Ad-hoc-Automatisierung

Vorgangs-ID:

AutomationAdHocPost

Rufen Sie eine Automatisierung in einer Ad-hoc-Ausführung auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Abbruchtoken	cancelation_token		string	Das Abbruchtoken.
Marke	brand		string	Die Marke.
Template	template		string	Die Vorlage.
Recipient	recipient		string	Der Empfänger.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Ausführungs-ID	runId	string	Den Ausführungsbezeichner

Ausführen einer vorlagenbasierten Automatisierung

Vorgangs-ID:

AutomationTemplatedPost

Rufen Sie eine Automatisierungsausführung aus einer Automatisierungsvorlage auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Vorlagen-ID	templateId	True	string	Der Vorlagenbezeichner.
Marke	brand		string	Die Marke.
Template	template		string	Die Vorlage.
Recipient	recipient		string	Der Empfänger.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Ausführungs-ID	runId	string	Den Ausführungsbezeichner

Ausführen eines Massenauftrags

Vorgangs-ID:

BulkJobRunPost

Starten Sie die Ausführung eines Massenauftrags.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Auftrags-ID	job_id	True	string	Die Job-ID.

Gibt zurück

response

object

Benachrichtigungen auflisten

Vorgangs-ID:

NotificationsGet

Ruft eine Liste von Benachrichtigungen ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Mauszeiger	cursor		string	Der Cursor.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Mauszeiger	paging.cursor	string	Der Cursor.
Mehr	paging.more	boolean	Ob es mehr gibt.
Ergebnisse	results	array of object
Erstellt unter	results.created_at	integer	Beim Erstellen bei.
ID	results.id	string	Der Bezeichner.
Daten	results.tags.data	array of object
ID	results.tags.data.id	string	Der Bezeichner.
Name	results.tags.data.name	string	Der Name.
Title	results.title	string	Der Titel.
Aktualisiert unter	results.updated_at	integer	Wenn aktualisiert unter.

Benutzergruppenmitglieder auflisten

Vorgangs-ID:

AudienceMembersGet

Dient zum Abrufen einer Liste von Mitgliedern einer Zielgruppe.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Benutzergruppen-ID	audience_id	True	string	Der Zielgruppenbezeichner.
Mauszeiger	cursor		string	Der Cursor.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Gegenstände	items	array of object
Mitglieds-ID	items.member_id	string	Der Memberbezeichner.
Hinzugefügt am	items.added_at	string	Wird hinzugefügt bei.
Benutzergruppen-ID	items.audience_id	string	Der Zielgruppenbezeichner.
Benutzergruppenversion	items.audience_version	integer	Die Benutzergruppenversion.
Ursache	items.reason	string	Der Grund.
Mauszeiger	paging.cursor	string	Der Cursor.
Mehr	paging.more	boolean	Ob es mehr gibt.

Ein Profil löschen

Vorgangs-ID:

ProfileDelete

Löscht das angegebene Empfängerprofil.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Empfänger-ID	recipient_id	True	string	Der Empfängerbezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Der Status	status	string	Der Status.

Erstellen einer Marke

Vorgangs-ID:

BrandPost

Erstellt eine neue Marke aus den bereitgestellten Einstellungen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID	id		string	Der Bezeichner.
Name	name	True	string	Der Name.
Primary	primary		string	Die primäre.
Secondary	secondary		string	Die sekundäre.
Tertiär	tertiary		string	Das Tertiär.
Balkenfarbe	barColor		string	Die Balkenfarbe.
HREF	href		string	Das HREF.
Bild	image		string	Das Bild.
Markdown	markdown		string	Das Markdown.
URL	url		string	Die URL-Adresse.
URL	url		string	Die URL-Adresse.
URL	url		string	Die URL-Adresse.
URL	url		string	Die URL-Adresse.
URL	url		string	Die URL-Adresse.
Symbol "Nachricht deaktivieren"	disableMessageIcon		boolean	Gibt an, ob das Nachrichtensymbol deaktiviert werden soll.
Platzierung	placement		string	Die Platzierung.
Gegenstände	items		array of string	Die Elemente.

Gibt zurück

response

string

Erstellen eines Massenauftrags

Vorgangs-ID:

BulkJobPost

Erstellt einen Massenauftrag für die bereitgestellten Nachrichtenparameter.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Event	event		string	Das Ereignis.
Marke	brand		string	Die Marke.
Template	template		string	Die Vorlage.
Marken-ID	brand_id		string	Der Markenbezeichner.
Methode	method		string	Die Methode.
Kanäle	channels		array of string	Die Kanäle.
Event	event		string	Das Ereignis.
Stichwörter	tags		array of string	Die Tags.
Ablaufverfolgungs-ID	trace_id		string	Der Ablaufverfolgungsbezeichner.
Kampagne	campaign		string	Die Kampagne.
Content	content		string	Der Inhalt.
Mittelstufe	medium		string	Das Medium.
Quelle	source		string	Die Quelle.
Begriff	term		string	Der Begriff.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Auftrags-ID	jobId	string	Die Job-ID.

Erstellen eines Profils

Vorgangs-ID:

ProfilePost

Führen Sie die angegebenen Werte mit einem vorhandenen Profil zusammen, oder erstellen Sie ein neues Profil, wenn noch kein Profil vorhanden ist.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Empfänger-ID	recipient_id	True	string	Der Empfängerbezeichner.
Email	email		string	Die E-Mail-Adresse.
Rufnummer	phone_number		string	Die Telefonnummer.
Formatiert	formatted		string	Die formatierte Adresse.
Anschrift	street_address		string	Die Straße.
Örtlichkeit	locality		string	Die Lokalität.
Region	region		string	Die Region.
Postleitzahl	postal_code		string	Die Postleitzahl.
Country	country		string	Das Land.
Geburtsdatum	birthdate		string	Das Geburtsdatum.
E-Mail bestätigt	email_verified		boolean	Gibt an, ob E-Mails überprüft wurden.
Telefonnummer überprüft	phone_number_verified		boolean	Gibt an, ob die Telefonnummer überprüft wurde.
Vorname	given_name		string	Der angegebene Name.
Zweitname	middle_name		string	Der zweite Vorname.
Familienname	family_name		string	Der Familienname.
Bevorzugter Name	preferred_name		string	Der bevorzugte Name.
Geschlecht	gender		string	Das Geschlecht.
Gebietsschema	locale		string	Das Gebietsschema.
Bild	picture		string	Das Bild.
Profile	profile		string	Das Profil.
Sub	sub		string	Der Unterteil.
Aktualisiert unter	updated_at		string	Wenn aktualisiert unter.
Webseite	website		string	Die Website.
Zoneninformationen	zoneinfo		string	Die Zoneninformationen.
Benannter Benutzer	named_user		string	Der benannte Benutzer.
Gerätetypen	device_types		array of string	Die Gerätetypen.
APN	apn		string	Der APN.
Ziel-ARN	target_arn		string	Das Ziel ARN.
Kanal-ID	channel_id		string	Der Kanalbezeichner.
Benutzer-ID	user_id		string	Der Benutzerbezeichner.
Token	token		string	Das Token.
Tokenen	tokens		array of string	Die Token.
Facebook PS-ID	facebookPSID		string	Der Facebook PS-Bezeichner.
Firebase-Token	firebaseToken		string	Das Firebase-Token.
Von	from		string	The From.
ID	id		string	Der Bezeichner.
Benutzer-ID	user_id		string	Der Benutzerbezeichner.
Unterhaltungs-ID	conversation_id		string	Der Unterhaltungsbezeichner.
Mieter-ID	tenant_id		string	Der Mandantenbezeichner.
Dienst-URL	service_url		string	Die Dienst-URL-Adresse.
OneSignal Player-ID	oneSignalPlayerID		string	Der OneSignal Player-Bezeichner.
Zugriffstoken	access_token		string	Das Zugriffstoken.
Kanal	channel		string	Der Kanal.
Email	email		string	Die E-Mail-Adresse.
Benutzer-ID	user_id		string	Der Benutzerbezeichner.
URL	url		string	Die URL-Adresse.
URL	url		string	Die URL-Adresse.
Methode	method		string	Die Methoden.
Modus	mode		string	Der Modus.
Nutzername	username		string	Der Benutzername.
Kennwort	password		string	Das Kennwort.
Token	token		string	Das Token.
Profile	profile		string	Das Profil.

Gibt zurück

response

string

Erstellen oder Aktualisieren einer Benutzergruppe

Vorgangs-ID:

AudiencePut

Erstellt oder aktualisiert eine Benutzergruppe basierend auf den bereitgestellten Parametern und Filtern.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Benutzergruppen-ID	audience_id	True	string	Der Zielgruppenbezeichner.
Name	name		string	Der Name.
Pfad	path		string	Der Pfad.
Bediener	operator		string	Der Operator.
Wert	value		string	Der Wert.
Pfad	path		string	Der Pfad.
Bediener	operator		string	Der Operator.
Wert	value		string	Der Wert.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	id	string	Der Bezeichner.
Name	name	string	Der Name.
Description	description	string	Die Beschreibung.
Bediener	filter.operator	string	Der Operator.
Wert	filter.value	string	Der Wert.
Pfad	filter.path	string	Der Pfad.
Filter	filter.filters	array of object
Pfad	filter.filters.path	string	Der Pfad.
Bediener	filter.filters.operator	string	Der Operator.
Wert	filter.filters.value	string	Der Wert.

Hinzufügen von Abonnenten zu einer Liste

Vorgangs-ID:

ListSubscribersPost

Fügen Sie einer Liste weitere Abonnenten hinzu.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Listen-ID	list_id	True	string	Der Listenbezeichner.
Empfänger-ID	recipientId		string	Der Empfängerbezeichner.

Gibt zurück

response

string

Hinzufügen von Benutzern zu einem Massenauftrag

Vorgangs-ID:

BulkJobUsersPost

Aufnehmen von Benutzerdaten in einen Massenauftrag.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Auftrags-ID	job_id	True	string	Die Job-ID.
Recipient	recipient		string	Der Empfänger.

Gibt zurück

response

string

Kündigen eines Benutzers aus einer Liste

Vorgangs-ID:

ListSubscribeDelete

Löscht ein Abonnement für eine Liste nach Listen- und Empfänger-IDs.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Listen-ID	list_id	True	string	Der Listenbezeichner.
Empfänger-ID	recipient_id	True	string	Der Empfängerbezeichner.

Gibt zurück

response

string

Löschen einer Benutzergruppe

Vorgangs-ID:

AudienceDelete

Löscht die angegebene Empfängergruppe.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Benutzergruppen-ID	audience_id	True	string	Der Zielgruppenbezeichner.

Gibt zurück

response

string

Löschen einer Liste

Vorgangs-ID:

ListDelete

Löscht eine Liste nach Listenbezeichner.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Listen-ID	list_id	True	string	Der Listenbezeichner.

Gibt zurück

response

string

Marke abrufen

Vorgangs-ID:

BrandGet

Rufen Sie eine bestimmte Marke nach Bezeichner ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Marken-ID	brand_id	True	string	Der Markenbezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Erstellt	created	integer	Beim Erstellen.
ID	id	string	Der Bezeichner.
Name	name	string	Der Name.
Veröffentlicht	published	integer	Wenn sie veröffentlicht wird.
Updated	updated	integer	Die Aktualisierung.
Version	version	string	Die Version.
Primary	settings.colors.primary	string	Die primäre.
Secondary	settings.colors.secondary	string	Die sekundäre.
Tertiär	settings.colors.tertiary	string	Das Tertiär.
Balkenfarbe	settings.email.header.barColor	string	Die Balkenfarbe.
HREF	settings.email.header.logo.href	string	Das HREF.
Bild	settings.email.header.logo.image	string	Das Bild.
Markdown	settings.email.footer.markdown	string	Das Markdown.
URL	settings.email.footer.social.facebook.url	string	Die URL-Adresse.
URL	settings.email.footer.social.instagram.url	string	Die URL-Adresse.
URL	settings.email.footer.social.linkedin.url	string	Die URL-Adresse.
URL	settings.email.footer.social.medium.url	string	Die URL-Adresse.
URL	settings.email.footer.social.twitter.url	string	Die URL-Adresse.
Symbol "Nachricht deaktivieren"	settings.inapp.disableMessageIcon	boolean	Gibt an, ob das Nachrichtensymbol deaktiviert werden soll.
Platzierung	settings.inapp.placement	string	Die Platzierung.
Gegenstände	snippets.items	array of string	Die Elemente.

Marken auflisten

Vorgangs-ID:

BrandsGet

Dient zum Abrufen einer Liste von Marken.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Mauszeiger	cursor		string	Der Cursor.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Mauszeiger	paging.cursor	string	Der Cursor.
Mehr	paging.more	boolean	Ob es mehr gibt.
Ergebnisse	results	array of object
Erstellt	results.created	integer	Beim Erstellen.
ID	results.id	string	Der Bezeichner.
Name	results.name	string	Der Name.
Veröffentlicht	results.published	integer	Wenn sie veröffentlicht wird.
Updated	results.updated	integer	Wenn aktualisiert.
Version	results.version	string	Die Version.
Primary	results.settings.colors.primary	string	Die primäre.
Secondary	results.settings.colors.secondary	string	Die sekundäre.
Tertiär	results.settings.colors.tertiary	string	Das Tertiär.
Balkenfarbe	results.settings.email.header.barColor	string	Die Balkenfarbe.
HREF	results.settings.email.header.logo.href	string	Das HREF.
Bild	results.settings.email.header.logo.image	string	Das Bild.
Markdown	results.settings.email.footer.markdown	string	Das Markdown.
URL	results.settings.email.footer.social.facebook.url	string	Die URL-Adresse.
URL	results.settings.email.footer.social.instagram.url	string	Die URL-Adresse.
URL	results.settings.email.footer.social.linkedin.url	string	Die URL-Adresse.
URL	results.settings.email.footer.social.medium.url	string	Die URL-Adresse.
URL	results.settings.email.footer.social.twitter.url	string	Die URL-Adresse.
Symbol "Nachricht deaktivieren"	results.settings.inapp.disableMessageIcon	boolean	Gibt an, ob das Nachrichtensymbol deaktiviert werden soll.
Platzierung	results.settings.inapp.placement	string	Die Platzierung.
Gegenstände	results.snippets.items	array of string	Die Elemente.

Nachricht senden

Vorgangs-ID:

MessageSendPost

Sendet eine Nachricht an einen oder mehrere Empfänger.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Idempotenz	idempotency	True	string	Der Idempotenzschlüssel.
Title	title		string	Der Titel.
Body	body		string	Der Körper.
Benutzer-ID	user_id		string	Der Benutzerbezeichner.
Listen-ID	list_id		string	Der Listenbezeichner.
Benutzergruppen-ID	audience_id		string	Der Zielgruppenbezeichner.
Email	email		string	Die E-Mail-Adresse.
Rufnummer	phone_number		string	Die Telefonnummer.
Gebietsschema	locale		string	Das Gebietsschema.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Anfrage-ID	requestId	string	Der Anforderungsbezeichner.

Nachrichten auflisten

Vorgangs-ID:

MessagesGet

Abrufen der Status von zuvor gesendeten Nachrichten.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Archived	archived		boolean	Gibt an, ob archiviert.
Mauszeiger	cursor		string	Der Cursor.
Event	event		string	Das Ereignis.
List	list		string	Die Liste.
Nachrichten-ID	messageId		string	Der Nachrichtenbezeichner.
Notification	notification		string	Die Benachrichtigung.
Recipient	recipient		string	Der Empfänger.
Der Status	status		string	Der Status.
Stichwörter	tags		string	Die Tags.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Mauszeiger	paging.cursor	string	Der Cursor.
Mehr	paging.more	boolean	Ob es mehr gibt.
Ergebnisse	results	array of object
ID	results.id	string	Der Bezeichner.
Der Status	results.status	string	Der Status.
Enqueued	results.enqueued	integer	Die Queued.
Gesendet	results.sent	integer	Der gesendete.
Geliefert	results.delivered	integer	Die geliefert.
Geöffnet	results.opened	integer	Das geöffnete.
Geklickt	results.clicked	integer	Das Geklickt.
Recipient	results.recipient	string	Der Empfänger.
Event	results.event	string	Das Ereignis.
Notification	results.notification	string	Die Benachrichtigung.
Fehler	results.error	string	Der Fehler.
Ursache	results.reason	string	Der Grund.

Wiederherstellen einer Liste

Vorgangs-ID:

ListRestorePut

Stellt eine vorhandene Liste anhand des Bezeichners wieder her.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Listen-ID	list_id	True	string	Der Listenbezeichner.

Gibt zurück

response

string

Definitionen

Schnur

Dies ist der grundlegende Datentyp "string".

Objekt

Dies ist der Typ „Objekt“.