Regeln

Data Center und Basis-URL

Bei der Nutzung der REST API ist sicherzustellen, dass das gewählte Data Center zur entsprechenden Basis-URL passt.

POST/v1/mail/<module>

API-Anfrageformat

https://email.api.engagelab.cc/v1/<module>/<action>

• Module: Name des Funktionsmoduls, z. B. Mail-Modul, Adresslistenmodul.
• Action: Aktion des jeweiligen Moduls, z. B. senden, hinzufügen.

API-Rückgabecode

Die API gibt die Antwort im JSON-Format zurück. Beispiel:

              
              # Anfrage war erfolgreich
{
  "result": {}
}
// Authentifizierung fehlgeschlagen
{
  "code": 30000,
  "message": "Authentication failed",
}

// Datenabfrage erfolgreich
{
   "total": 28,
   "count": 28,
   "result": [
            {
                "label_id": 598802,
                "label_name": "xjm226",
                "create_time": "2022-11-10T15:47:05+0800",
                "update_time": "2022-11-10T15:47:05+0800"
            }
        ]
}

            

• HTTP-Status: 200
• result: Dateninformationen

HTTP-Statuscodes

E-Mail-Adressformat

E-Mail-Adressformat: local_part@domain_part, bestehend aus local_part, @ und domain_part. Die gültige E-Mail-Adresse muss folgende Regeln erfüllen:

• local_part@domain_part: Mindestlänge 6 Zeichen, Maximallänge 128 Zeichen;
• local_part: Maximallänge 96 Zeichen, darf kein @ enthalten;
• domain_part: Darf ausschließlich die Zeichen a-z, A-Z, 0-9 sowie - und . enthalten. Darf nicht mit - beginnen oder enden. Gesamtlänge maximal 255 Zeichen, jeder Abschnitt darf maximal 63 Zeichen enthalten.
• Die Top-Level-Domain darf ausschließlich 2 bis 20 Buchstaben (Groß- oder Kleinbuchstaben) enthalten;

Zeitzonenverzeichnis

Kalender-Zeitzonenverzeichnis

Tarifverzeichnis

Filterbedingungen

Struktur der Filterbedingung

              
              {
    "condition": {
        "relation": "or",
        "items": [
            {
                "field_name": "createTime",
                "op": ">=",
                "value": "2021-10-11"
            },
            {
                "field_name": "Name",
                "op": "contain",
                "value": "left"
            }
        ]
    }
}

// Filterbedingung: createTime >= '2021-10-11' oder Name enthält 'left'

            

Erläuterung der Filterbedingungen