Skip to content

PlentyGetConversations - PlentyONE

Version: REST 1.0

← PlentyONE Add-On Übersicht

Ruft eine Liste der Konversationen (Nachrichten) aus PlentyONE Shop ab.


Inputs

Das sind die Optionen, mit denen man den Step konfigurieren kann.

Name Datentyp Beschreibung Pflichtfeld Werte
account ACCOUNT Ihr Konto Ja
limit STRING Begrenzen Sie die Anzahl der abgerufenen Konversationen. Nein
enableMessages BOOLEAN Wenn diese Option aktiviert ist, werden die Konversationsnachrichten einbezogen. Nein
  • Ja
  • Nein
fromDate DATETIME Ergebnisse nach Erstellungsdatum der Konversation filtern. Die Konversation muss nach diesem Datum erstellt worden sein. Nein
toDate DATETIME Ergebnisse nach Erstellungsdatum der Konversation filtern. Die Konversation muss vor diesem Datum erstellt worden sein. Nein
updateFromDate STRING Ergebnisse nach Aktualisierungsdatum der Konversation filtern. Die Konversation muss nach diesem Datum aktualisiert worden sein. Nein
updateToDate STRING Ergebnisse nach Aktualisierungsdatum der Konversation filtern. Die Konversation muss vor diesem Datum aktualisiert worden sein. Nein
tagIds STRING Ergebnisse nach Konversations-Tags filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. Nein
shortId STRING Ergebnisse nach "Kurze ID" der Konversation filtern. Nein
orderIds STRING Ergebnisse nach Reihenfolge der Konversationsbeziehung filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. Nein
contactIds STRING Filtert die Ergebnisse nach dem Konversationstyp "Kontakt". Es können mehrere Werte durch Kommas getrennt angegeben werden. Nein
emails STRING Ergebnisse nach E-Mail-Typ der Konversation filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. Nein
paymentIds STRING Ergebnisse nach Konversationsbeziehungstyp "Zahlung" filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. Nein
subscribersUsers STRING Ergebnisse nach Konversationsabonnenten filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. Nein
isDone STRING Ergebnisse nach Konversationsstatus filtern. Nein
  • Alle
  • Ja
  • Nein
hasAttachments STRING Ergebnisse nach Konversationen filtern, die mindestens eine Nachricht mit einem Anhang enthalten. Nein
  • Alle
  • Ja
  • Nein
hasBilledMsg STRING Ergebnisse nach Konversationen filtern, die mindestens eine in Rechnung gestellte Nachricht enthalten. Nein
  • Alle
  • Ja
  • Nein
isArchived STRING Ergebnisse aus dem Hauptindex oder aus dem Archiv filtern. Nein
  • Alle
  • Ja
  • Nein
referrer STRING Ergebnisse nach Konversations-Herkunft filtern (Herkunft der ersten Nachricht der Konversation). Nein
  • Alle
  • System
  • Backend
  • REST
  • Plugin
  • E-Mail
fromValue STRING Ergebnisse nach Absender der Konversation filtern (Absender der ersten Nachricht). Der gesuchte Wert kann eine Benutzer-ID oder eine E-Mail-Adresse sein. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. Dieser Filter funktioniert nur, wenn auch der Filter "fromType" angegeben ist. Nein
fromType STRING Ergebnisse nach Absendertyp der Konversation filtern (Absendertyp der ersten Nachricht der Konversation). Nein
  • Alle
  • Benutzer
  • E-Mail
priorityId STRING Ergebnisse nach Konversationspriorität filtern. Nein
  • Alle
  • Sehr niedrig
  • Niedrig
  • Mittel
  • Hoch
  • Sehr hoch
inboxId STRING Ergebnisse nach Posteingangs-ID filtern. Nein
deadline STRING Filtert die Ergebnisse nach dem Deadline der Konversation. Nein
  • Alle
  • Gestern
  • Heute
  • Morgen
  • Überschritten
  • In der Zukunft
statusId STRING Ergebnisse nach Konversationsstatus-ID filtern. Nein
typeId STRING Ergebnisse nach Konversationstyp-ID filtern. Nein
isDeleted STRING Ergebnisse nach dem Flag "Konversation gelöscht" filtern. Nein
  • Alle
  • Gelöscht
  • Nicht gelöscht
deletedAtBefore STRING Ergebnisse nach dem Löschdatum der Konversation filtern. Die Konversation muss vor diesem Datum gelöscht worden sein. Nein
isRead STRING Ergebnisse nach Status "Konversation gelesen" filtern. Dieser Filter wirkt nur in Kombination mit dem Filter "readById". Nein
  • Alle
  • Ja
  • Nein
readById STRING Filtern Sie die Ergebnisse nach dem Lesestatus der Konversation für die angegebene Benutzer-ID. Dieser Filter wirkt nur in Kombination mit dem Filter "isRead". Nein
uuids STRING Ergebnisse nach Konversations-IDs filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. Nein
folderId STRING Ergebnisse nach Ordner-ID filtern. Nein
owners STRING Ergebnisse nach Konversationsinhabern filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. Nein
title STRING Ergebnisse nach Konversationstitel filtern (die gesuchte Zeichenfolge muss im Titel enthalten sein). Nein
message STRING Ergebnisse nach Nachrichtentext filtern (die gesuchte Zeichenfolge muss in einer der Konversationsnachrichten enthalten sein). Nein
sortBy STRING Die Sortierspalte. Nein
  • Erstellt am
  • Aktualisiert am
sortOrder STRING Die Sortierrichtung. Nein
  • Absteigend
  • Aufsteigend

Outputs

Das sind die Ergebnisse des Steps, die von nachfolgenden Steps, nach der Ausführung verwendet werden können.

Name Datentyp Beschreibung Werte
result SPREADSHEET Das Ergebnis - SPREADSHEET, das die Konversationsdaten enthält.
Folgende Felder sind im Output enthalten:

Feld Datentyp Beschreibung Standardwert
identifier SINGLE The identifier column to import Spreadsheet into a Datastore.
ConversationID SINGLE The unique UUID identifier of the conversation.
ShortID SINGLE The short ID of the conversation.
InboxID SINGLE The inbox ID.
Title SINGLE The title of the conversation.
TagIDs MULTIPLEVALUE List of tag IDs associated with the conversation.
ReadBy MULTIPLEVALUE List of user IDs who have read the conversation.
IsClosed SINGLE Whether the conversation is closed.
PlentyIdHash SINGLE The plenty ID hash.
CreatedAt SINGLE The creation date of the conversation.
UpdatedAt SINGLE The last update date of the conversation.
DeletedAt SINGLE The deletion date of the conversation.
IsDeleted SINGLE Whether the conversation is deleted.
AttachmentsCount SINGLE The number of attachments.
BilledMsgCount SINGLE The number of billed messages.
BilledMinutesCount SINGLE The number of billed minutes.
ValidRelation SINGLE Whether the conversation has a valid relation.
PlentyID SINGLE The plenty ID.
ReferrerType SINGLE The referrer type.
ReferrerValue SINGLE The referrer value (user ID or similar).
ReferrerName SINGLE The name associated with the referrer.
PriorityID SINGLE The priority ID.
FromType SINGLE The sender type.
FromValue SINGLE The sender value (user ID or email).
FromName SINGLE The name associated with the sender.
TypeID SINGLE The type ID.
TypePosition SINGLE The type position.
StatusID SINGLE The status ID.
StatusPosition SINGLE The status position.
HasWhisperedMessages SINGLE Whether the conversation has whispered messages.
MessagesIDs MULTIPLEVALUE List of message IDs.
IsMigratedToEs SINGLE Whether the conversation is migrated to Elasticsearch.
IsArchived SINGLE Whether the conversation is archived.
CategoryID SINGLE The category ID.
ConversationPreview SINGLE The conversation preview text.
RelationContactIdValues SINGLE The conversation relation contact ids as list.
RelationEmailValues SINGLE The conversation relation emails as list.
RelationOrderIdValues SINGLE The conversation relation order ids as list.
RecipientsContactIdValues SINGLE The conversation recipients contact ids as list.
RecipientsEmailValues SINGLE The conversation recipients emails as list.
RecipientsOrderIdValues SINGLE The conversation recipients order ids as list.
MessageID SINGLE The unique identifier of the message.
parent_identifier SINGLE The parent_identifier column to import Spreadsheet into a Datastore.
MessageConversationID SINGLE The ID of the conversation this message belongs to.
MessageFromType SINGLE The sender type.
MessageFromValue SINGLE The sender value (user ID or email).
MessageFromName SINGLE The name associated with the sender.
MessageTitle SINGLE The message title.
MessageMessage SINGLE The message text.
MessagePlainMessage SINGLE The plain message.
MessageReferrerType SINGLE The referrer type.
MessageReferrerValue SINGLE The referrer value (user ID or similar).
MessageReferrerName SINGLE The name associated with the referrer.
MessageCreatedAt SINGLE The creation date of the message.
MessageUpdatedAt SINGLE The update date of the message.