SMS-Bounces
URL
https://sms.api.engagelab.cc/v1/bounces
https://sms.api.engagelab.cc/v1/bounces
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Anfragemethode
GET
GET
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Headers
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | string | ja | Basic base64(sms_user:sms_key) |
Beschreibung der Abfrageparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| offset | Integer | nein | Offset-Position, [0-], Standardwert ist 0 |
| limit | Integer | nein | Anzahl, [0-100], Standardwert ist 100 |
| phone | string | nein | Telefonnummer |
| start_date | string | ja | Startdatum, Format yyyy-MM-dd |
| end_date | string | ja | Enddatum, Format yyyy-MM-dd |
Hinweis：
Der maximale Abfragezeitraum zwischen start_date und end_date darf 90 Tage nicht überschreiten.
Anfragebeispiel
curl -X GET "https://sms.api.engagelab.cc/v1/bounces"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/bounces"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung des Rückgabewerts
| Parameter | Beschreibung |
|---|---|
| phone | Telefonnummer |
| bounce_type | Bounce-Typ |
| msg_type | SMS-Typ, 2 steht für internationale SMS |
| bounce_time | Zeitpunkt der Rücksendung |
| expire_time | Ablaufzeit |
| reason | Grund der Rücksendung |
bounce_type Bedeutung der einzelnen Typcodes
| Bounce_Type | Beschreibung |
|---|---|
| 500 | Sende-Fehler, Nummer existiert nicht |
| 510 | Sende-Fehler, Nummer außer Betrieb |
| 520 | Sende-Fehler, Nummer auf Blacklist |
| 530 | Sende-Fehler, Leitung besetzt |
| 540 | Sende-Fehler, keine Antwort |
| 550 | Sende-Fehler, Template-Inhalt abgefangen |
| 560 | Sende-Fehler, Fehler am Mobilgerät |
| 570 | Sende-Fehler, Handy außer Betrieb |
| 580 | Sende-Fehler, Handy ausgeschaltet |
| 590 | Sende-Fehler, andere Gründe |
| 410 | Globale Sperrliste |
| 411 | Benutzerdefinierte globale Sperrliste |
| 420 | Lokale Sperrliste |
| 421 | Benutzerdefinierte lokale Sperrliste |
| 430 | Abmeldung |
| 440 | Keyword-Filterung |
| 450 | Fehler beim Variablenersatz |
| 460 | Variablenlänge überschreitet das Limit |
| 470 | Encoding-Ausnahme (Hinweis: Encoding und 460 zusammengefasst, 470 = Frequenzlimit überschritten) |
| 480 | Nicht unterstützter Sendetyp |
Beispiel für Rückgabewerte
Response-success
HTTP Status: 200
{
"result": [
{
"phone": "008613681312917",
"bounce_type": 421,
"bounce_time": "2023-08-04T16:47:02+0800",
"expire_time": "2023-08-08T00:00:00+0800",
"msg_type": 2,
"reason": "Benutzerdefinierte lokale Sperrliste"
}
],
"total": 1,
"count": 1
}
{
"result": [
{
"phone": "008613681312917",
"bounce_type": 421,
"bounce_time": "2023-08-04T16:47:02+0800",
"expire_time": "2023-08-08T00:00:00+0800",
"msg_type": 2,
"reason": "Benutzerdefinierte lokale Sperrliste"
}
],
"total": 1,
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Löschen
URL
https://sms.api.engagelab.cc/v1/bounces
https://sms.api.engagelab.cc/v1/bounces
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Anfragemethode
DELETE
DELETE
Diesen Codeblock im schwebenden Fenster anzeigen
Content-type
application/json
application/json
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Headers
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | string | ja | Basic base64(sms_user:sms_key) |
Beschreibung der Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| phone | string | ja | Telefonnummer |
| start_date | string | ja | Startdatum, Format yyyy-MM-dd |
| end_date | string | ja | Enddatum, Format yyyy-MM-dd |
Hinweis：
Der maximale Abfragezeitraum zwischen start_date und end_date darf 90 Tage nicht überschreiten.
Anfragebeispiel
curl -X DELETE "https://sms.api.engagelab.cc/v1/bounces"
--data '{"start_date": "2021-03-01","end_date":"2021-03-02","phone":"008613681312917"}'
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://sms.api.engagelab.cc/v1/bounces"
--data '{"start_date": "2021-03-01","end_date":"2021-03-02","phone":"008613681312917"}'
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung des Rückgabewerts
| Parameter | Beschreibung |
|---|---|
| count | Anzahl der gelöschten Bounces |
Beispiel für Rückgabewerte
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Diesen Codeblock im schwebenden Fenster anzeigen
