SMS Label

Über die folgende Schnittstelle können Sie SMS-Labels abfragen, hinzufügen, bearbeiten und löschen.

Abfrage (Einzeln)

Gibt Basisinformationen eines SMS-Labels zurück.

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}

              
              https://sms.api.engagelab.cc/v1/labels/{label_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/labels/598802" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
label_id	Label-ID
label_name	Name des Labels
create_time	Erstellungszeitpunkt des Labels
update_time	Änderungszeitpunkt des Labels

Beispiel der Rückgabewerte

Antwort-Erfolg

HTTP Status: 200

{ "result": { "label_id": 598802, "label_name": "xjm226", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } }

              
              {
        "result": 
            {
                "label_id": 598802,
                "label_name": "xjm226",
                "create_time": "2022-11-14T14:27:48+0800",
                "update_time": "2022-11-14T14:27:48+0800"
            }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP Status :400

{ "code": 34020, "message": "label_id muss eine Ganzzahl sein" }

              
              {
  "code": 34020,
  "message": "label_id muss eine Ganzzahl sein"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Abfrage (Batch)

Listet alle gefundenen Labels auf

URL

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

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

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	Integer	nein	Startposition, [0-], Standard ist 0
limit	Integer	nein	Anzahl, [0-100], Standard ist 100
label_name	string	nein	Unscharfe Suche nach Labelnamen

Anfragebeispiel

curl -X GET "https://sms.api.engagelab.cc/v1/labels?label_name=test" --header "Authorization: Basic <<YOUR_AUTHORIZATION_KEY>>"

              
              curl -X GET "https://sms.api.engagelab.cc/v1/labels?label_name=test" 
--header "Authorization: Basic <<YOUR_AUTHORIZATION_KEY>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
label_id	Label-ID
label_name	Name des Labels
create_time	Erstellungszeitpunkt
update_time	Änderungszeitpunkt

Beispiel der Rückgabewerte

Antwort-Erfolg

HTTP Status: 200

{ "result": [ { "create_time": "2022-11-14T14:27:48+0800", "label_id": 10, "label_name": "test", "update_time": "2022-11-14T14:27:48+0800" } ], "total": 28, "count": 1 }

              
              {
    "result": [
       {
            "create_time": "2022-11-14T14:27:48+0800",
            "label_id": 10,
            "label_name": "test",
            "update_time": "2022-11-14T14:27:48+0800"
        }
    ],
    "total": 28,
    "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP Status :401

{ "code": 30000, "message": "Nicht autorisiert." }

              
              {  
    "code": 30000,
    "message": "Nicht autorisiert."
}

Diesen Codeblock im schwebenden Fenster anzeigen

Hinzufügen

Gibt die Basisinformationen des neu hinzugefügten SMS-Labels zurück.

URL

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

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

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)

Parameterbeschreibung

Parameter	Typ	Erforderlich	Beschreibung
label_name	string	ja	Hinzuzufügender Labelname (max. 64 Zeichen)

Hinweis

Die Obergrenze für die Erstellung von Labels liegt bei 100000.

Anfragebeispiel

curl -X POST "https://sms.api.engagelab.cc/v1/labels" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name": "test2" }'

              
              curl -X POST "https://sms.api.engagelab.cc/v1/labels"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "label_name": "test2"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
label_id	Label-ID
label_name	Name des Labels
create_time	Erstellungszeitpunkt
update_time	Änderungszeitpunkt

Beispiel der Rückgabewerte

Antwort-Erfolg

HTTP Status: 200

{ "result": { "label_id": 11, "label_name": "test", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } }

              
              {
    "result": {
        "label_id": 11,
        "label_name": "test",
        "create_time": "2022-11-14T14:27:48+0800",
        "update_time": "2022-11-14T14:27:48+0800"
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP Status :401

{ "code": 30000, "message": "Nicht autorisiert." }

              
              {
    "code": 30000,
    "message": "Nicht autorisiert."
}

Diesen Codeblock im schwebenden Fenster anzeigen

Bearbeiten

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}

              
              https://sms.api.engagelab.cc/v1/labels/{label_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)

Parameterbeschreibung

Parameter	Typ	Erforderlich	Beschreibung
label_name	string	ja	Neuer Labelname (maximal 64 Zeichen)

Anfragebeispiel

curl -X PUT "https://sms.api.engagelab.cc/v1/labels/11" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name": "test3" }'

              
              curl -X PUT "https://sms.api.engagelab.cc/v1/labels/11"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "label_name": "test3"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
count	Anzahl der bearbeiteten Labels

Beispiel der Rückgabewerte

Antwort-Erfolg

HTTP Status: 200

{ "count":1 }

              
              {
    "count":1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP Status :401

{ "code": 30000, "message": "Nicht autorisiert." }

              
              {
    "code": 30000,
    "message": "Nicht autorisiert."
}

Diesen Codeblock im schwebenden Fenster anzeigen

Löschen

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}

              
              https://sms.api.engagelab.cc/v1/labels/{label_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/labels/11" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
count	Anzahl der gelöschten Labels

Beispiel der Rückgabewerte

Antwort-Erfolg

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP Status :401

{ "code": 30000, "message": "Nicht autorisiert." }

              
              {
    "code": 30000,
    "message": "Nicht autorisiert."
}

Diesen Codeblock im schwebenden Fenster anzeigen