senders

Rechenzentrum-Auswahl

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

Hinweis:
Bei der Nutzung der REST API ist sicherzustellen, dass das gewählte Rechenzentrum mit der verwendeten Basis-URL übereinstimmt.

Absender erstellen

URL

https://email.api.engagelab.cc/v1/marketing/senders

              
              https://email.api.engagelab.cc/v1/marketing/senders

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

POST

              
              POST

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

Diesen Codeblock im schwebenden Fenster anzeigen

Request-Headers

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

Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
from_name	string	ja	Name des Absenders
email	string	ja	Die E-Mail-Adresse muss dem E-Mail-Format entsprechen und eine Domain mit der Endung domain_name enthalten.
domain_name	string	ja	Domainname (wie konfiguriert)
api_user	string	ja	ApiUser-Name

Hinweis:
Der Wert von domain_name muss zum api_user passen.

Request-Beispiel

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization: Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders --data '{ "from_name": "Linghu", "email": "xjmfc@126.com", "domain_name": "126.com", "api_user": "test_abc" }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization: Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders --data '{
  "from_name": "Linghu",
  "email": "xjmfc@126.com",
  "domain_name": "126.com",
  "api_user": "test_abc"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Beispiel für eine erfolgreiche Antwort

HttpStatus: 200

{ "result": { "sender_id": 449, "name": "Qiaofeng2", "email": "zhou@aizl.net", "domain_id": 147886, "domain_name": "aizl.net", "api_user": "xiaojinmin_new", "create_time": "2022-05-24T14:04:19+0800", "update_time": "2022-05-24T15:35:09+0800" } }

              
              {
     "result": {
        "sender_id": 449,
        "name": "Qiaofeng2",
        "email": "zhou@aizl.net",
        "domain_id": 147886,
        "domain_name": "aizl.net",
        "api_user": "xiaojinmin_new",
        "create_time": "2022-05-24T14:04:19+0800",
        "update_time": "2022-05-24T15:35:09+0800"
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehler-Antwort

HttpStatus: 401

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen" }

              
              {
    "code": 30000,
    "message": "Authentifizierung fehlgeschlagen"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Absender löschen

URL

https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}

              
              https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

DELETE

              
              DELETE

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

Diesen Codeblock im schwebenden Fenster anzeigen

Request-Headers

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

Request-Beispiel

curl -X DELETE -H 'Authorization: Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/857

              
              curl -X DELETE -H 'Authorization: Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/857

Diesen Codeblock im schwebenden Fenster anzeigen

Beispiel für eine erfolgreiche Antwort

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehler-Antwort

HttpStatus: 401

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen" }

              
              {
    "code": 30000,
    "message": "Authentifizierung fehlgeschlagen"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Absender aktualisieren

URL

https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}

              
              https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

PUT

PUT

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

Diesen Codeblock im schwebenden Fenster anzeigen

Request-Headers

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

Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
from_name	string	nein	Name des Absenders
email	string	nein	E-Mail-Adresse des Absenders, muss dem E-Mail-Format entsprechen und eine Domain mit der Endung domain_name enthalten
domain_name	string	nein	Domainname (wie konfiguriert)
api_user	string	nein	ApiUser-Name

Hinweis:
Die Werte von from_name, email, domain_name und api_user dürfen nicht leer oder null sein.

Request-Beispiel

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization: Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/37 --data '{ "from_name": "Linghu", "email": "xjmfc@126.com", "domain_name": "test.com", "api_user": "test_abc" }'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization: Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/37 --data '{
  "from_name": "Linghu",
  "email": "xjmfc@126.com",
  "domain_name": "test.com",
  "api_user": "test_abc"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Beispiel für eine erfolgreiche Antwort

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehler-Antwort

HttpStatus: 401

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen" }

              
              {
    "code": 30000,
    "message": "Authentifizierung fehlgeschlagen"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Absenderdetails abrufen

URL

https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}

              
              https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

GET

GET

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

Diesen Codeblock im schwebenden Fenster anzeigen

Request-Headers

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

Request-Beispiel

curl -X GET -H 'Authorization: Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/1

              
              curl -X GET -H 'Authorization: Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/1

Diesen Codeblock im schwebenden Fenster anzeigen

Beispiel für eine erfolgreiche Antwort

HttpStatus: 200

{ "result": { "sender_id": 449, "name": "乔峰2", "email": "zhou@aizl.net", "domain_id": 147886, "domain_name": "aizl.net", "api_user": "xiaojinmin_new", "create_time": "2022-05-24T14:04:19+0800", "update_time": "2022-05-24T15:35:09+0800" } }

              
              {
    "result": {
        "sender_id": 449,
        "name": "乔峰2",
        "email": "zhou@aizl.net",
        "domain_id": 147886,
        "domain_name": "aizl.net",
        "api_user": "xiaojinmin_new",
        "create_time": "2022-05-24T14:04:19+0800",
        "update_time": "2022-05-24T15:35:09+0800"
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehler-Antwort

HttpStatus: 401

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen" }

              
              {
    "code": 30000,
    "message": "Authentifizierung fehlgeschlagen"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Absenderliste abrufen

URL

https://email.api.engagelab.cc/v1/marketing/senders

              
              https://email.api.engagelab.cc/v1/marketing/senders

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

GET

GET

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

Diesen Codeblock im schwebenden Fenster anzeigen

Request-Headers

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

Query-Parameter

Parameter	Typ	Erforderlich	Beschreibung
limit	integer	nein	Anzahl der abzurufenden Datensätze, Bereich: [1-100], Standard: 10
offset	integer	nein	Startposition für die Abfrage, Bereich: [0-], Standard: 0

Request-Beispiel

curl -X GET -H 'Authorization: Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders?offset=0&limit=10

              
              curl -X GET -H 'Authorization: Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders?offset=0&limit=10

Diesen Codeblock im schwebenden Fenster anzeigen

Response-Parameter

Parameter	Typ	Beschreibung
result	array[object]	Liste der Absender
sender_id	integer	Absender-ID
name	string	Name des Absenders
email	string	E-Mail-Adresse des Absenders
domain_id	integer	Domain-ID
domain_name	string	Domainname
api_user	string	ApiUser-Name
create_time	string	Erstellungszeit
update_time	string	Aktualisierungszeit
total	integer	Gesamtanzahl der Datensätze

Beispiel für eine erfolgreiche Antwort

HttpStatus: 200

{ "result": [ { "sender_id": 388, "name": "xjmfc", "email": "xjmfc@aizl.net", "domain_id": 147886, "domain_name": "aizl.net", "api_user": "xiaojinmin", "create_time": "2022-05-24T14:04:19+0800", "update_time": "2022-05-24T15:35:09+0800" } ], "total": 3, "count": 1 }

              
              {
    "result": [
        {
            "sender_id": 388,
            "name": "xjmfc",
            "email": "xjmfc@aizl.net",
            "domain_id": 147886,
            "domain_name": "aizl.net",
            "api_user": "xiaojinmin",
            "create_time": "2022-05-24T14:04:19+0800",
            "update_time": "2022-05-24T15:35:09+0800"
        }
    ],
    "total": 3,
    "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehler-Antwort

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen" }

              
              {
    "code": 30000,
    "message": "Authentifizierung fehlgeschlagen"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Tipp:
Nutze diese REST API zur effizienten Absenderverwaltung im E-Mail-Marketing und sorge für eine sichere Authentifizierung bei allen Anfragen.

Absenderverwaltung per REST API

Rechenzentrum-Auswahl

Absender erstellen

Absender löschen

Absender aktualisieren

Absenderdetails abrufen

Absenderliste abrufen