SMS-Vorlage

Die folgende Schnittstelle ermöglicht das Hinzufügen, Bearbeiten und Löschen von SMS-Vorlagen sowie das Abfragen, Einreichen und Genehmigen von SMS und SMS-Vorlagen.

Abfrage

Detailierte Informationen der zurückgegebenen SMS-Vorlage

URL

https://sms.api.engagelab.cc/v1/templates/{template_id}

              
              https://sms.api.engagelab.cc/v1/templates/{template_id}

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)

Anfragebeispiel

curl -X GET "https://sms.api.engagelab.cc/v1/templates/1235" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "https://sms.api.engagelab.cc/v1/templates/1235" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabeparameter-Beschreibung

Parameter	Beschreibung
template_id	Vorlagen-ID
template_name	Vorlagenname
msg_type	SMS-Typ, 2 steht für internationale SMS
template_type	SMS-Inhaltstyp, 0 steht für Verifizierungscode, 1 für Branchenbenachrichtigung, 2 für Marketing
approval_status	Überprüfungsstatus: 0 ausstehend, 1 genehmigt, -1 abgelehnt, -2 nicht zur Prüfung eingereicht
approval_message	Überprüfungsinformation, nur bei approval_Status -1 vorhanden
template_content	Vorlageninhalt, maximal 512 Zeichen lang
create_time	Erstellungszeit der Vorlage
update_time	Änderungszeit der Vorlage

Rückgabebeispiel

Antwort-Erfolg

HTTP-Status: 200

{ "result": { "template_id": 123, "template_name": "test", "msg_type": 2, "template_type": 1, "template_content": "Sehr geehrter %name%, Ihr Verbrauchsbetrag auf der Plattform in diesem Monat beträgt:***", "approval_status": 1, "approval_message": "", "create_time": "2015-03-23T14:27:48+0800", "update_time": "2017-03-29T14:27:48+0800" } }

              
              {
    "result": {
        "template_id": 123,
        "template_name": "test",
        "msg_type": 2,
        "template_type": 1,
        "template_content": "Sehr geehrter %name%, Ihr Verbrauchsbetrag auf der Plattform in diesem Monat beträgt:***",
        "approval_status": 1,
        "approval_message": "",
        "create_time": "2015-03-23T14:27:48+0800",
        "update_time": "2017-03-29T14:27:48+0800"
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status :400

{ "code": 33001, "message": "Die Vorlage existiert nicht" }

              
              {
    "code": 33001,
    "message": "Die Vorlage existiert nicht"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Abfrage (Batch)

Basisinformationen der zurückgegebenen SMS-Vorlagen

URL

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

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

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)

Abfrageparameter-Beschreibung

Parameter	Typ	Erforderlich	Beschreibung
template_ids	string	nein	Vorlage-ID, für mehrere bitte durch Kommas trennen
approval_status	string	nein	Überprüfungsstatus, 0 ausstehend, 1 genehmigt, -1 abgelehnt, -2 nicht eingereicht
template_name	string	nein	Vorlagenname, unscharfe Suche
offset	int	nein	Offset-Position, [0-], Standard 0
limit	int	nein	Anzahl, [0-100], Standardwert 100

Tipp:

Benutzer können eine Vorlage-ID zur Abfrage angeben. Wenn nicht angegeben, werden standardmäßig alle Vorlagen abgefragt.

Anfragebeispiel

curl -X GET "https://sms.api.engagelab.cc/v1/templates?approval_status=1" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "https://sms.api.engagelab.cc/v1/templates?approval_status=1" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabeparameter-Beschreibung

Parameter	Beschreibung
template_id	Vorlagen-ID
template_name	Vorlagenname
msg_type	SMS-Typ
template_type	SMS-Inhaltstyp
approval_status	Überprüfungsstatus
approval_message	Überprüfungsinformation, nur bei approval_Status -1 vorhanden
template_content	Vorlageninhalt
sign_id	Signatur-ID
create_time	Erstellungszeit der Vorlage
update_time	Änderungszeit der Vorlage

Rückgabebeispiel

Antwort-Erfolg

HTTP-Status: 200

{ "result" : [{ "template_id" : 100, "template_name" : "tset", "msg_type" : 2, "template_type" : 1, "template_content" : "Sehr geehrter %name%, Ihr Verbrauchsbetrag auf der Plattform in diesem Monat beträgt:***", "approval_status" : 1, "approval_message": "", "create_time" : "2016-08-25T14:27:48+0800", "update_time" : "2016-08-25T14:27:48+0800" } ], "count":1, "total" : 1 }

              
              {
    "result" :  [{
                "template_id" : 100,
                "template_name" : "tset",
                "msg_type" : 2,
                "template_type" : 1,
                "template_content" : "Sehr geehrter %name%, Ihr Verbrauchsbetrag auf der Plattform in diesem Monat beträgt:***",
                "approval_status" : 1,
                "approval_message": "",
                "create_time" : "2016-08-25T14:27:48+0800",
                "update_time" : "2016-08-25T14:27:48+0800"
            }
        ],
        "count":1,
        "total" : 1
    }

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status: 400

{ "code": 30002, "message": "Ungültiges Limit" }

              
              {
  "code": 30002,
  "message": "Ungültiges Limit"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Hinzufügen

Information, ob das Hinzufügen erfolgreich war

URL

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

POST

              
              POST

Diesen Codeblock im schwebenden Fenster anzeigen

Content-type

application/json

              
              application/json

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

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

Parameter-Beschreibung

Parameter	Typ	Erforderlich	Beschreibung
template_name	string	ja	Vorlagenname, eindeutig im Konto, maximal 64 Zeichen
template_content	string	ja	Vorlageninhalt, darf keine Zeichen wie [],【】, test, 测试 enthalten, maximal 512 Zeichen
template_type	string	ja	SMS-Inhaltstyp: 0=Verifizierungscode, 1=Branchenbenachrichtigung, 2=Marketing
msg_type	string	nein	SMS-Typ, 2 steht für internationale SMS, Standardwert 2
sign_id	Integer	nein	Signatur-ID
sign_pos	string	nein	Position der Signatur, 0=vorne, 1=hinten, Standard 0
submit	bool	nein	Direkt zur Prüfung einreichen, Standard false

Anfragebeispiel

curl -X POST "https://sms.api.engagelab.cc/v1/templates" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "template_name": "test", "template_content": "Sehr geehrter %name%, Ihr Verbrauchsbetrag auf der Plattform in diesem Monat beträgt:***", "sign_id": 1235, "template_type": "0" }'

              
              curl -X POST "https://sms.api.engagelab.cc/v1/templates"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "template_name": "test",
    "template_content": "Sehr geehrter %name%, Ihr Verbrauchsbetrag auf der Plattform in diesem Monat beträgt:***",
    "sign_id": 1235,
    "template_type": "0"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabeparameter-Beschreibung

Parameter	Beschreibung
template_id	Vorlagen-ID
template_name	Vorlagenname
msg_type	SMS-Typ
template_type	SMS-Inhaltstyp
approval_status	Überprüfungsstatus
approval_message	Überprüfungsinformation, nur bei approval_Status -1 vorhanden
template_content	Vorlageninhalt
sign_id	Signatur-ID
create_time	Erstellungszeit der Vorlage
update_time	Änderungszeit der Vorlage

Rückgabebeispiel

Antwort-Erfolg

HTTP-Status: 200

{ "result" : { "template_id" : 200, "template_name" : "bill", "msg_type" : 2, "template_type" : 1, "template_content" : "Sehr geehrter %name%, Ihr Verbrauchsbetrag auf der Plattform in diesem Monat beträgt:***", "approval_status" : 1, "approval_message": "", "create_time" : "2022-08-25T14:35:48+0800", "update_time" : "2022-08-25T14:35:48+0800" } }

              
              {
    "result" : {
        "template_id" : 200,
        "template_name" : "bill",
        "msg_type" : 2,
        "template_type" : 1,
        "template_content" : "Sehr geehrter %name%, Ihr Verbrauchsbetrag auf der Plattform in diesem Monat beträgt:***",
        "approval_status" : 1,
        "approval_message": "",
        "create_time" : "2022-08-25T14:35:48+0800",
        "update_time" : "2022-08-25T14:35:48+0800"
        
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status: 400

{ "code": 33006, "message": "Vorlagenname unterstützt maximal 64 Zeichen" }

              
              {
    "code": 33006,
    "message": "Vorlagenname unterstützt maximal 64 Zeichen"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Einreichen

Basisinformation, ob das Einreichen erfolgreich war

URL

https://sms.api.engagelab.cc/v1/templates/{template_id}/submit

              
              https://sms.api.engagelab.cc/v1/templates/{template_id}/submit

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

POST

              
              POST

Diesen Codeblock im schwebenden Fenster anzeigen

Content-type

application/json

              
              application/json

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

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

Anfragebeispiel

curl -X POST "https://sms.api.engagelab.cc/v1/templates/3381/submit" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/x-www-form-urlencoded"

              
              curl -X POST "https://sms.api.engagelab.cc/v1/templates/3381/submit"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/x-www-form-urlencoded"

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabebeispiel

Antwort-Erfolg

HTTP-Status: 200

{ }

Diesen Codeblock im schwebenden Fenster anzeigen

Bearbeiten

Basisinformation, ob die Übermittlung erfolgreich war

URL

https://sms.api.engagelab.cc/v1/templates/{template_id}

              
              https://sms.api.engagelab.cc/v1/templates/{template_id}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

PUT

PUT

Diesen Codeblock im schwebenden Fenster anzeigen

Content-type

application/json

              
              application/json

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

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

Parameter-Beschreibung

Parameter	Typ	Erforderlich	Beschreibung
template_name	string	nein	Vorlagenname, eindeutig im Konto, maximal 64 Zeichen
template_content	string	nein	Vorlageninhalt, darf keine Zeichen wie [],【】, test, 测试 enthalten, maximal 512 Zeichen
sign_id	Integer	nein	Signatur-ID
sign_pos	string	nein	Position der Signatur, 0=vorne, 1=hinten, Standard 0
template_type	string	nein	SMS-Inhaltstyp: 0=Verifizierungscode, 1=Branchenbenachrichtigung, 2=Marketing
submit	bool	nein	Direkt zur Prüfung einreichen, Standard false

Tipp：

Nach Aufruf dieser Schnittstelle führt die Aktualisierung von template_name nicht zu einer Änderung des Prüfstatus; eine Änderung anderer Parameter jedoch schon.

Anfragebeispiel

curl -X PUT "https://sms.api.engagelab.cc/v1/templates/3381" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "template_name": "test", "template_content": "Sehr geehrter %name%, Ihr Verbrauchsbetrag auf der Plattform in diesem Monat beträgt:***", "sign_id": 132, "template_type": 0 }'

              
              curl -X PUT "https://sms.api.engagelab.cc/v1/templates/3381"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "template_name": "test",
    "template_content": "Sehr geehrter %name%, Ihr Verbrauchsbetrag auf der Plattform in diesem Monat beträgt:***",
    "sign_id": 132,
    "template_type": 0
    }'

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabebeispiel

Antwort-Erfolg

HTTP-Status: 200

{ "count": 1 }

              
               { 
 "count": 1 
 }

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status: 401

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

Löschen

URL

https://sms.api.engagelab.cc/v1/templates/{template_id}

              
              https://sms.api.engagelab.cc/v1/templates/{template_id}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

DELETE

              
              DELETE

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

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

Anfragebeispiel

curl -X DELETE "https://sms.api.engagelab.cc/v1/templates/3381" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://sms.api.engagelab.cc/v1/templates/3381" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabebeispiel

Antwort-Erfolg

HTTP-Status: 200

{ "count": 1 }

              
               { 
 "count": 1 
 }

Diesen Codeblock im schwebenden Fenster anzeigen