Blocks

Wenn Sie auf böswillige Registrierungen stoßen und keine E-Mails an bestimmte Adressen oder Postfächer senden möchten, können Sie die Domain oder eine spezifische E-Mail-Adresse zur Blockliste hinzufügen. E-Mail-Adressen in dieser Liste werden vom System blockiert. Sie können Einträge in dieser Liste abfragen, hinzufügen und löschen.

Aufrufadresse

Rechenzentrum	URL
Singapur	https://email.api.engagelab.cc
Türkei	https://emailapi-tr.engagelab.com

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

POST/v1/blocks

Abfrage

URL

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

GET

GET

Diesen Codeblock im schwebenden Fenster anzeigen

Header

Header	Typ	Erforderlich	Beschreibung
Authorization	String	ja	Basic base64(api_user:api_key)

Beschreibung der Query-Parameter

Parameter	Typ	Erforderlich	Beschreibung
start_date	string	*	Startdatum, Format `yyyy-MM-dd`
end_date	string	*	Enddatum, Format `yyyy-MM-dd`
email_or_domain	string	*	E-Mails oder Domains (z. B. `11@gmail.com`, `hotmail.com`)
api_user	string	nein	Block API_USER, Standardwert `all`
offset	int	nein	Start [0-100], Standardwert 100
limit	int	nein	Anzahl [0-100], Standardwert 100

Hinweise:

Der Zeitraum darf maximal 3 Monate betragen.

Beispielanfrage:

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
api_user	Block API_USER
email_or_domain	Blockierte E-Mail oder Domain
create_time	Erstellungszeitpunkt
expire_time	Ablaufzeitpunkt

Beispiel Rückgabewert

{ "result": [ { "block_id": 122, "api_user": "all", "email_or_domain": "11@gmail.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" },{ "block_id": 123, "api_user": "all", "email_or_domain": "hotmail.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" },{ "block_id": 124, "api_user": "all", "email_or_domain": "22@yahoo.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" } ], "count": 3, "total": 10 }

              
              {
  "result": [
    {
      "block_id": 122,
      "api_user": "all",
      "email_or_domain": "11@gmail.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    },{
      "block_id": 123,
      "api_user": "all",
      "email_or_domain": "hotmail.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    },{
      "block_id": 124,
      "api_user": "all",
      "email_or_domain": "22@yahoo.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    }
  ],
  "count": 3,
  "total": 10
}

Diesen Codeblock im schwebenden Fenster anzeigen

Hinzufügen

URL

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

POST

              
              POST

Diesen Codeblock im schwebenden Fenster anzeigen

Header

Header	Typ	Erforderlich	Beschreibung
Authorization	String	ja	Basic base64(api_user:api_key)

Beschreibung der Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
api_user	string	nein	Block API_USER, Standardwert `all`
email_or_domain	array	ja	E-Mails oder Domains (z. B. `["11@gmail.com","hotmail.com","22@yahoo.com"]`)
expire_time	string	ja	Ablaufzeitpunkt, Format `yyyy-MM-dd`

Beispielanfrage:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"api_user": "123456abc","email_or_domain": ["11@gmail.com","hotmail.com","22@yahoo.com"],"expire_time":"2023-12-31"}' 'https://email.api.engagelab.cc/v1/blocks'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"api_user": "123456abc","email_or_domain": ["11@gmail.com","hotmail.com","22@yahoo.com"],"expire_time":"2023-12-31"}'
     'https://email.api.engagelab.cc/v1/blocks'

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
api_user	Block API_USER
email_or_domain	E-Mail oder Domain
create_time	Erstellungszeitpunkt
expire_time	Ablaufzeitpunkt

Beispiel Rückgabewert

{ "result": [ { "api_user": "all", "email_or_domain": "11@gmail.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" },{ "api_user": "all", "email_or_domain": "hotmail.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" },{ "api_user": "all", "email_or_domain": "22@yahoo.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" } ] }

              
              {
   "result": [
    {
      "api_user": "all",
      "email_or_domain": "11@gmail.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    },{
      "api_user": "all",
      "email_or_domain": "hotmail.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    },{
      "api_user": "all",
      "email_or_domain": "22@yahoo.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    }
    ]
}

Diesen Codeblock im schwebenden Fenster anzeigen

Blockierte Einträge löschen

URL

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

DELETE

              
              DELETE

Diesen Codeblock im schwebenden Fenster anzeigen

Header

Header	Typ	Erforderlich	Beschreibung
Authorization	String	ja	Basic base64(api_user:api_key)

Beschreibung der Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
api_user	string	nein	Block API_USER
email_or_domain	array	ja	Blockierte Empfangsdomains oder E-Mail-Adressen

Beispielanfrage:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"api_user":"123456abc","email_or_domain":["xjmfc@example.com","gmail.com"]}' 'https://email.api.engagelab.cc/v1/blocks'

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"api_user":"123456abc","email_or_domain":["xjmfc@example.com","gmail.com"]}'
     'https://email.api.engagelab.cc/v1/blocks'

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
count	Anzahl erfolgreich gelöschter Einträge

Beispiel Rückgabewert

{ "count": 1 }

              
              {
    "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Blocks API

Aufrufadresse

Abfrage

Hinzufügen

Blockierte Einträge löschen