Status

Abfrage

Liste des SMS-Status, die von Benutzern gesendet wurden. Sie können diese Liste abfragen.

URL

https://sms.api.engagelab.cc/v1/status

              
              https://sms.api.engagelab.cc/v1/status

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

GET

GET

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

Header	Typ	Erforderlich	Beschreibung
Authorization	string	ja	Basic base64(sms_user:sms_key)

Beschreibung der Abfrageparameter

Parameter	Typ	Erforderlich	Beschreibung
offset	string	nein	Startposition, [0-], Standardwert ist 0
limit	string	nein	Anzahl, [0-100], Standardwert ist 100
time_zone	string	nein	Zeitzone, z. B.: +8
send_date	string	ja	Format des Versanddatums ist yyyy-MM-dd
phone	string	nein	Telefonnummer
sms_ids	string	nein	Bei erfolgreichem Versand zurückgegebene SMS-IDs, mehrere sms_IDs durch ; getrennt, bis zu 10 unterstützt
msg_type	string	nein	SMS-Typ, 2 steht für internationale SMS
sms_user	string	nein	Bestimmter SMS_USER für den Kunden
template_id	string	nein	ID der SMS-Vorlage
label_id	string	nein	ID des SMS-Labels
status	string	nein	1 gesendet, 2 zugestellt, 3 auf Ergebnis warten, 4 Verarbeitung fehlgeschlagen, 5 Versand fehlgeschlagen
sub_status	string	nein	Unterstatus

Hinweise：

Unterstützung für die Abfrage von Tagesdetails innerhalb von 6 Monaten.

Die jeweils erhaltenen Datensätze werden für 10 Minuten zwischengespeichert.

Diese Schnittstelle beschränkt jeden SMS_USER auf 60 Aufrufe pro Minute.

Anfragebeispiel

curl -X GET "sms.api.engagelab.cc/v1/status?start_date=2011-11-20&end_date=2011-11-20?msg_types=2" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "sms.api.engagelab.cc/v1/status?start_date=2011-11-20&end_date=2011-11-20?msg_types=2" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung des Rückgabewerts

Parameter	Beschreibung
phone	Telefonnummer
sms_id	SMS-ID
msg_type	SMS-Typ
sms_user	SMS_USER
template_id	ID der SMS-Vorlage
template_name	Name der SMS-Vorlage
status	1 gesendet, 2 zugestellt, 3 auf Ergebnis warten, 4 Verarbeitung fehlgeschlagen, 5 Versand fehlgeschlagen
status_desc	Beschreibung des SMS-Zustellstatus, aufgeteilt in gesendet, zugestellt, abwarten, Verarbeitung fehlgeschlagen, Versand fehlgeschlagen
sub_status	Unterstatus
sub_status_desc	Die Beschreibung des Unterstatus ist in der untenstehenden Tabelle ersichtlich
request_time	Anforderungszeitpunkt
update_time	Aktualisierungszeitpunkt
response_message	Antwort

Statuscodes und Beschreibung für Verarbeitungsfehler:

sub_status	Beschreibung des Unterstatus
410	Verarbeitung fehlgeschlagen – global gesperrt
420	Verarbeitung fehlgeschlagen – teilweise gesperrt
430	Verarbeitung fehlgeschlagen – abgemeldet
440	Verarbeitung fehlgeschlagen – Schlüsselwort gesperrt
450	Verarbeitung fehlgeschlagen – Variablenfehler
460	Verarbeitung fehlgeschlagen – Inhaltsfehler
470	Verarbeitung fehlgeschlagen – Häufigkeit überschritten
480	Verarbeitung fehlgeschlagen – Sonstiges

Statuscodes und Beschreibung für Versandfehler:

sub_status	Beschreibung des Unterstatus
500	Versand fehlgeschlagen – leer
510	Versand fehlgeschlagen – außer Betrieb
520	Versand fehlgeschlagen – auf Blacklist
530	Versand fehlgeschlagen – besetzt
540	Versand fehlgeschlagen – keine Antwort
550	Versand fehlgeschlagen – Abfangen
560	Versand fehlgeschlagen – Störung
570	Versand fehlgeschlagen – nicht im Dienst
580	Versand fehlgeschlagen – ausgeschaltet
590	Versand fehlgeschlagen – Sonstiges

Rückgabewert Beispiel

{ "result": [{ "sms_id":"***_**_**_**_**$**", "msg_type": 2, "phone": "+16235217", "request_time": "2017-02-19 00:21:20", "response_message": "success", "sms_user": "*****", "status_desc": "zugestellt", "status":2, "template_id": "10", "template_name": "engagelab code", "update_time": "2017-02-19 00:21:21" } ], "total": 1 } }

              
              {
    "result":  [{
                "sms_id":"***_**_**_**_**$**",
                "msg_type": 2,
                "phone": "+16235217",
                "request_time": "2017-02-19 00:21:20",
                "response_message": "success",
                "sms_user": "*****",
                "status_desc": "zugestellt",
                "status":2,
                "template_id": "10",
                "template_name": "engagelab code",
                "update_time": "2017-02-19 00:21:21"
            }
        ],
        "total": 1
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen