SMS Signatur
Über die folgende Schnittstelle können Sie SMS-Signaturen abfragen, hinzufügen und aktualisieren.
Abfrage
Gibt die Basisinformationen einer SMS-Signatur zurück
URL
https://sms.api.engagelab.cc/v1/signs/{sign_id}
https://sms.api.engagelab.cc/v1/signs/{sign_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) |
Anfrage-Beispiel
curl -X GET "https://sms.api.engagelab.cc/v1/signs/10"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/signs/10"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Rückgabewerte-Beschreibung
| Parameter | Beschreibung |
|---|---|
| sign_id | ID der Signatur |
| sign_name | Name der Signatur |
| create_time | Erstellungszeitpunkt der Signatur |
| update_time | Zeitpunkt der letzten Aktualisierung |
Beispiel Rückgabewert
Antwort-Erfolg
HTTP-Status: 200
{
"result": {
"sign_id": 10,
"sign_name": "shanshan",
"create_time": "2021-04-10T10:44:37+0800",
"update_time": "2022-06-14T19:20:35+0800"
}
}
{
"result": {
"sign_id": 10,
"sign_name": "shanshan",
"create_time": "2021-04-10T10:44:37+0800",
"update_time": "2022-06-14T19:20:35+0800"
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Antwort-Fehler
HTTP-Status: 400
{
"code": 34010,
"message": "sign not exists"
}
{
"code": 34010,
"message": "sign not exists"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Abfrage (Batch)
URL
https://sms.api.engagelab.cc/v1/signs
https://sms.api.engagelab.cc/v1/signs
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) |
Parameter-Beschreibung
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| sign_name | string | ja | Name der Signatur, unterstützt unscharfe Suche |
Anfrage-Beispiel
curl -X GET "https://sms.api.engagelab.cc/v1/signs"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/signs"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Rückgabewerte-Beschreibung
| Parameter | Beschreibung |
|---|---|
| sign_id | ID der Signatur |
| sign_name | Name der Signatur |
| create_time | Erstellungszeitpunkt der Signatur |
| update_time | Zeitpunkt der letzten Änderung |
Beispiel Rückgabewert
Antwort-Erfolg
HTTP-Status: 200
{
"result": [{
"sign_id": 1427,
"sign_name": "shanshan",
"create_time": "2015-04-10T10:44:37+0800",
"update_time": "2016-06-14T19:20:35+0800"
}
],
"count":1,
"total":1
}
{
"result": [{
"sign_id": 1427,
"sign_name": "shanshan",
"create_time": "2015-04-10T10:44:37+0800",
"update_time": "2016-06-14T19:20:35+0800"
}
],
"count":1,
"total":1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Antwort-Fehler
HTTP-Status: 401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Hinzufügen
Gibt die Basisinformationen der SMS-Signatur nach erfolgreichem Hinzufügen zurück
URL
https://sms.api.engagelab.cc/v1/signs
https://sms.api.engagelab.cc/v1/signs
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 |
|---|---|---|---|
| sign_name | string | ja | Name der Signatur, 2-60 Zeichen, keine Sonderzeichen []、【】 |
Hinweise:
- Die Anzahl der erstellbaren Online-Signaturen ist auf 100 begrenzt.
Anfrage-Beispiel
curl -X POST "https://sms.api.engagelab.cc/v1/signs"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"sign_name": "ccc"
}'
curl -X POST "https://sms.api.engagelab.cc/v1/signs"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"sign_name": "ccc"
}'
Diesen Codeblock im schwebenden Fenster anzeigen
Rückgabewerte-Beschreibung
| Parameter | Beschreibung |
|---|---|
| sign_id | ID der Signatur |
| sign_name | Name der Signatur |
| create_time | Erstellungszeitpunkt der Signatur |
| update_time | Zeitpunkt der letzten Änderung |
Beispiel Rückgabewert
Antwort-Erfolg
HTTP-Status: 200
{
"result": {
"sign_id": 1529,
"sign_name": "ccc",
"create_time": "2015-04-10T10:44:37+0800",
"update_time": "2016-06-14T19:20:35+0800"
}
}
{
"result": {
"sign_id": 1529,
"sign_name": "ccc",
"create_time": "2015-04-10T10:44:37+0800",
"update_time": "2016-06-14T19:20:35+0800"
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Antwort-Fehler
HTTP-Status: 400
{
"code": 34005,
"message": "Invalid sign_name"
}
{
"code": 34005,
"message": "Invalid sign_name"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Bearbeiten
Gibt die Basisinformationen der SMS-Signatur nach erfolgreicher Bearbeitung zurück
URL
https://sms.api.engagelab.cc/v1/signs/{sign_id}
https://sms.api.engagelab.cc/v1/signs/{sign_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 |
|---|---|---|---|
| sign_name | string | ja | Name der Signatur, 2-60 Zeichen, keine Sonderzeichen []、【】 |
Anfrage-Beispiel
curl -X PUT "https://api.sendcloud.net/v1/signs/11617"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"sign_name": "ccc"
}'
curl -X PUT "https://api.sendcloud.net/v1/signs/11617"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"sign_name": "ccc"
}'
Diesen Codeblock im schwebenden Fenster anzeigen
Beispiel Rückgabewert
Antwort-Erfolg
HTTP-Status: 200
{
"count": 1
}
{
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Antwort-Fehler
HTTP-Status: 400
{
"code": 34005,
"message": "Invalid sign_name"
}
{
"code": 34005,
"message": "Invalid sign_name"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Löschen
Gibt grundlegende Informationen zurück, ob das Löschen erfolgreich war
URL
https://sms.api.engagelab.cc/v1/signs/{sign_id}
https://sms.api.engagelab.cc/v1/signs/{sign_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) |
Anfrage-Beispiel
curl -X DELETE "https://api.sendcloud.net/v1/signs/11617"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://api.sendcloud.net/v1/signs/11617"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Beispiel Rückgabewert
Antwort-Erfolg
HTTP-Status: 200
{
"count": 1
}
{
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
