Zum Inhalt springen
Developer

MassNotification

Benachrichtigung / MassNotification

Chat und Benachrichtigungen3 EndpunkteNotification / MassNotification

MassUserNotification neu anlegen

POST/api/notification/mass_notification

Request-Body application/json

  • dataMassUserNotification
    Felder anzeigen (16)
    • send_pushboolean

      Ob Push-Benachrichtigungen gesendet werden sollen.

    • send_mailboolean

      Ob E-Mails gesendet werden sollen.

    • send_letterboolean

      Ob Briefe gesendet werden sollen.

    • send_smsboolean

      Ob SMS-Nachrichten gesendet werden sollen.

    • send_whatsappboolean

      Ob WhatsApp-Nachrichten gesendet werden sollen.

    • reference_class_namestring

      Klassenname der Datensätze, auf die sich die Benachrichtigung bezieht.

    • reference_idsarray<string>

      IDs der Datensätze, auf die sich die Benachrichtigung bezieht.

    • textstring

      Die Überschrift der Benachrichtigung

    • long_textstring

      Der Text der Benachrichtigung

    • html_textstring

      Der HTML-Text der Benachrichtigung; überschreibt den langen Text

    • attachmentsarray<Attachment12>

      Anhänge der Massenbenachrichtigung.

    • templateFlexibleLatexTemplate3

      Vorlage für die Massenbenachrichtigung.

    • save_as_attachmentboolean

      Ob die Benachrichtigung als Anhang gespeichert wird.

    • check_for_duplicatesboolean

      Ob doppelte Empfänger geprüft werden.

    • create_questionnaire_draftboolean

      Wenn true, wird für jeden referenzierten BaseEventSignUp-Empfänger ein Entwurf von MediaQuestionnaireAnswer angelegt (oder wiederverwendet), und sein Ausfülllink wird als Vorlagen-Platzhalter bereitgestellt.

    • questionnaire_draft_questionnaireMediaQuestionnaire3

      Der Fragebogen für die Ergebnisliste, für den die Entwürfe je Empfänger erstellt werden.

Antworten

200MassUserNotification neu anlegenMassUserNotification2

Felder anzeigen (20)
  • idinteger

    Primärschlüssel der Massenbenachrichtigung. Interne ID.

  • processedboolean

    Ob die Massenbenachrichtigung verarbeitet wurde.

  • send_pushboolean

    Ob Push-Benachrichtigungen gesendet werden sollen.

  • send_mailboolean

    Ob E-Mails gesendet werden sollen.

  • send_letterboolean

    Ob Briefe gesendet werden sollen.

  • send_smsboolean

    Ob SMS-Nachrichten gesendet werden sollen.

  • send_whatsappboolean

    Ob WhatsApp-Nachrichten gesendet werden sollen.

  • reference_class_namestring

    Klassenname der Datensätze, auf die sich die Benachrichtigung bezieht.

  • reference_idsarray<string>

    IDs der Datensätze, auf die sich die Benachrichtigung bezieht.

  • textstring

    Die Überschrift der Benachrichtigung

  • long_textstring

    Der Text der Benachrichtigung

  • html_textstring

    Der HTML-Text der Benachrichtigung; überschreibt den langen Text

  • attachmentsarray<Attachment22>

    Anhänge der Massenbenachrichtigung.

    Felder anzeigen (26)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • googledownloadlinkstring

      Download-Link der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • templateFlexibleLatexTemplate

    Vorlage für die Massenbenachrichtigung.

    Felder anzeigen (35)
    • predefinedboolean

      Wahr für Vorlagen, die mit dem servercontrolpanel ausgeliefert werden (PredefinedFlexibleTemplateMap). Ihre IDs werden im Code referenziert, daher bietet die Oberfläche an, sie zu duplizieren ("Vorlage anpassen"), statt sie zu bearbeiten.

    • data_typestring

      Datentyp (Referenzklassenschlüssel), mit dem die Vorlage gerendert und geprüft wird. Für vordefinierte Vorlagen (Tag IW_PFLT) ist dies der Datentyp des Codes, der sie verwendet.

    • data_type_labelstring

      Menschlich lesbare Bezeichnung des zugewiesenen Datentyps, null bei Tags, die keinem bekannten Datentyp entsprechen.

    • template_modestring

      Serialisierter Modus, damit Clients nicht wissen müssen, dass null Standard bedeutet.

    • last_check_statusstring

      Zusammenfassung der letzten Vorlagenprüfung für Listenansichten; das vollständige Ergebnis ist nur in der Admin-Detailansicht verfügbar.

    • idstring

      Primärschlüssel der Vorlage. Interne ID. Wird als String-Kennung verwendet.

    • namestring

      Name der Vorlage.

    • tagstring

      Tag, mit dem Vorlagen gruppiert werden.

    • mass_messageboolean

      Ob die Vorlage für Massennachrichten verwendet wird.

    • default_store_as_pdfboolean

      Ob das erzeugte Dokument standardmäßig als PDF gespeichert wird.

    • security_scopestring

      Scope, der steuert, wer die Vorlage verwenden kann.

    • security_user_access_typeinteger

      Für die Verwendung der Vorlage erforderlicher Zugriffstyp.

    • param1string

      In der Vorlage verwendeter Wert von Parameter 1.

    • param2string

      In der Vorlage verwendeter Wert von Parameter 2.

    • param3string

      In der Vorlage verwendeter Wert von Parameter 3.

    • param4string

      In der Vorlage verwendeter Wert von Parameter 4.

    • param5string

      In der Vorlage verwendeter Wert von Parameter 5.

    • param6string

      In der Vorlage verwendeter Wert von Parameter 6.

    • param7string

      In der Vorlage verwendeter Wert von Parameter 7.

    • param8string

      In der Vorlage verwendeter Wert von Parameter 8.

    • param9string

      In der Vorlage verwendeter Wert von Parameter 9.

    • param10string

      In der Vorlage verwendeter Wert von Parameter 10.

    • default_value_param1string

      Standardwert von Parameter 1.

    • default_value_param2string

      Standardwert von Parameter 2.

    • default_value_param3string

      Standardwert von Parameter 3.

    • default_value_param4string

      Standardwert von Parameter 4.

    • default_value_param5string

      Standardwert von Parameter 5.

    • default_value_param6string

      Standardwert von Parameter 6.

    • default_value_param7string

      Standardwert von Parameter 7.

    • default_value_param8string

      Standardwert von Parameter 8.

    • default_value_param9string

      Standardwert von Parameter 9.

    • default_value_param10string

      Standardwert von Parameter 10.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • save_as_attachmentboolean

    Ob die Benachrichtigung als Anhang gespeichert wird.

  • check_for_duplicatesboolean

    Ob doppelte Empfänger geprüft werden.

  • create_questionnaire_draftboolean

    Wenn true, wird für jeden referenzierten BaseEventSignUp-Empfänger ein Entwurf von MediaQuestionnaireAnswer angelegt (oder wiederverwendet), und sein Ausfülllink wird als Vorlagen-Platzhalter bereitgestellt.

  • questionnaire_draft_questionnaireMediaQuestionnaire

    Der Fragebogen für die Ergebnisliste, für den die Entwürfe je Empfänger erstellt werden.

    Felder anzeigen (34)
    • idinteger

      Primärschlüssel des Fragebogens. Interne ID.

    • questionnaire_typestring

      Art des Fragebogens, zum Beispiel Anmeldung oder Umfrage.

    • tokenstring

      Öffentlicher Token des Fragebogens. Anstelle der ID verwendet.

    • public_copyrightstring

      Urheberrechtstext, der mit dem Fragebogen angezeigt wird.

    • public_language_codestring

      Sprache des Fragebogens, zum Beispiel de.

    • complexity_levelinteger

      Komplexitätsstufe des Fragebogens.

    • public_authorstring

      Öffentlich angezeigter Autor.

    • show_free_textboolean

      Ein Freitextfeld anzeigen.

    • show_attachmentboolean

      Ein Upload-Feld für Anhänge anzeigen.

    • require_attachmentboolean

      Ein Anhang muss hochgeladen werden.

    • with_paginationboolean

      Den Fragebogen seitenweise anzeigen.

    • one_entry_per_personboolean

      Wenn true, ist nur ein Eintrag pro Person erlaubt - nur für angemeldete Benutzer und Tabellenergebnisse

    • require_addressboolean

      Die Adresse muss eingegeben werden.

    • require_contactboolean

      Kontaktdaten müssen eingegeben werden.

    • require_ageboolean

      Das Alter muss eingegeben werden.

    • require_grade_levelboolean

      Die Schulklassenstufe muss eingegeben werden.

    • start_timestring (date-time)

      Beginn der Verfügbarkeit des Fragebogens.

    • end_timestring (date-time)

      Ende der Verfügbarkeit des Fragebogens.

    • age_groupstring

      Altersgruppe, für die der Fragebogen gedacht ist.

    • min_ageinteger

      Mindestalter in Jahren.

    • max_ageinteger

      Maximales Alter in Jahren.

    • min_grade_levelinteger

      Mindestschulstufe.

    • max_grade_levelinteger

      Maximale Klassenstufe.

    • age_toleranceinteger

      Jahre, um die das Alter außerhalb der Spanne liegen darf und dennoch akzeptiert wird.

    • group_allowedboolean

      Ob der Fragebogen auf eine Gruppe beschränkt ist.

    • allow_self_registerboolean

      Ob sich Personen selbst für die Beantwortung des Fragebogens registrieren können.

    • allow_self_download_result_templateboolean

      Ob Antwortende ihr eigenes Ergebnis herunterladen können.

    • clarification_enabledboolean

      Zweite Schleife nach dem KI-Vergleich: Antworten, die die KI nicht als erfüllt bewertet, werden zu Klärungspunkten (MediaQuestionnaireClarification), die mit dem Kunden besprochen und entschieden werden, bevor die Ergebnisvorlage angelegt wird. Ohne sie folgt die Ergebnisvorlage direkt dem KI-Vergleich.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • image_urlstring

      URL des Bildes des Datensatzes.

    • namestring

      Name der Einheit.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/notification/mass_notification \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "send_mail": true,
    "reference_class_name": "Beispiel",
    "text": "Text",
    "long_text": "Text",
    "html_text": "Text",
    "send_push": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "send_mail": true,
  "reference_class_name": "Beispiel",
  "text": "Text",
  "long_text": "Text",
  "html_text": "Text",
  "processed": true,
  "send_push": true,
  "send_letter": true,
  "send_sms": true
}

Liste von SimpleReference abrufen

GET/api/notification/mass_notification/simple_references

Query-Parameter

classNamePflichtstringDer className, für den die Referenzen ermittelt werden, z. B. person

Antworten

200Liste von SimpleReference abrufenarray<SimpleReference>

Felder anzeigen (3)
  • class_namestring
  • idstring
  • namestring
Anfrage
curl --request GET \
  --url 'https://eure-instanz.iw-erp.de/api/notification/mass_notification/simple_references?className=string' \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "class_name": "Beispiel",
    "id": "42",
    "name": "Beispiel"
  }
]

Gibt die Liste der Twig-Platzhalter zurück, die für eine bestimmte Referenzklasse oder für eine der einstellungsbasierten E-Mail-Vorlagen verfügbar sind. Wird vom Vorlageneditor / Massenbenachrichtigungs-Editor und von den Einstellungsseiten der E-Mail-Vorlagen verwendet, um Klick-einfügbare Chips bereitzustellen.

GET/api/notification/mass_notification/placeholders

Genau eines von className / templateKey muss angegeben werden.

Query-Parameter

classNamestringFQCN oder Kurzname der Referenzklasse (z. B. 'CRMPerson' oder vollständiger FQCN).
templateKeystringEinstellungsschlüssel einer Mailvorlage (zum Beispiel „templates_mail_ticket_created_txt_twig“).

Antworten

default

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/notification/mass_notification/placeholders \
  --header 'x-iw-jwt-token: <TOKEN>'