logoDokumentation
Suchen

Beschwerden-API: Abfrage und Löschung von E-Mail-Adressen

Wenn Nutzer:innen Spam-E-Mails melden, werden deren E-Mail-Adressen zur Spam-Beschwerdeliste hinzugefügt.

In dieser Liste werden E-Mail-Adressen vom System abgefangen und der Zustellungsstatus wird als „Ungültige E-Mail – In SendCloud-Blacklist: Bounced (worker: Adresse in Beschwerdeliste)“ klassifiziert.

Sie können E-Mail-Adressen in der Liste abfragen und löschen.

Aufrufadresse

Stellen Sie bei der Nutzung der REST-API sicher, dass das gewählte Rechenzentrum zur entsprechenden Basis-URL passt.

POST/v1/complaints

Abfrage

URL

https://email.api.engagelab.cc/v1/complaints
              
              https://email.api.engagelab.cc/v1/complaints

            
Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

GET
              
              GET

            
Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Abfrageparameter

Parameter Typ Erforderlich Beschreibung
start_date string * Startdatum (Format: yyyy-MM-dd)
end_date string * Enddatum (Format: yyyy-MM-dd)
email string * E-Mail-Adresse, z. B. 22@gmail.com
offset int nein Startposition [0-], Standardwert: 0
limit int nein Anzahl [0-100], Standardwert: 100

Beispiel für eine Anfrage:

curl -X GET -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ 'https://email.api.engagelab.cc/v1/complaints?offset=0&limit=90'
              
              curl -X GET -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     'https://email.api.engagelab.cc/v1/complaints?offset=0&limit=90'

            
Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter Beschreibung
email Beschwerde-E-Mail-Adresse
reason Grund für die Beschwerde
complaint_time Zeitstempel der Beschwerde
expire_time Ablaufzeitpunkt der Beschwerde-Interzeption

Beispiel für Rückgabewerte

{ "result": [ { "email": "9978977@qq.com", "reason": "from softbounce", "complaint_time": "2016-02-01T14:53:20+0800", "expire_time": "2017-02-01T14:53:20+0800" } ], "count": 1, "total": 1 }
              
              {
  "result": [
    {
      "email": "9978977@qq.com",
      "reason": "from softbounce",
      "complaint_time": "2016-02-01T14:53:20+0800",
      "expire_time": "2017-02-01T14:53:20+0800"
    }
  ],
  "count": 1,
  "total": 1
}

            
Diesen Codeblock im schwebenden Fenster anzeigen

Löschen

URL

https://email.api.engagelab.cc/v1/complaints
              
              https://email.api.engagelab.cc/v1/complaints

            
Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

DELETE
              
              DELETE

            
Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Body-Parameter

Parameter Typ Erforderlich Beschreibung
start_date string * Startdatum (Format: yyyy-MM-dd)
end_date string * Enddatum (Format: yyyy-MM-dd)
email string * Zu löschende E-Mail-Adresse

Beispiel für eine Anfrage

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ --data '{"email": "x@example.com"}' \ 'https://email.api.engagelab.cc/v1/complaints' curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ --data '{"start_date": "2023-04-01 08:00:00", "end_date": "2023-07-01 08:00:00"}' \ 'https://email.api.engagelab.cc/v1/complaints'
              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     --data '{"email": "x@example.com"}' \
     'https://email.api.engagelab.cc/v1/complaints'

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     --data '{"start_date": "2023-04-01 08:00:00", "end_date": "2023-07-01 08:00:00"}' \
     'https://email.api.engagelab.cc/v1/complaints'

            
Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Keine

Beispiel für Rückgabewerte

{ "count": 2 }
              
              {
  "count": 2
}

            
Diesen Codeblock im schwebenden Fenster anzeigen
icon
Vertrieb kontaktieren