Vorlagenkonfiguration aktualisieren
Aktualisieren Sie eine bestehende Vorlagenkonfiguration, mit Unterstützung für die Änderung von Vorlagenname, Typ, Inhalt, Zielländern und Signaturinformationen. Nach der Aktualisierung wechselt der Vorlagenstatus zurück zu „In Prüfung".
Anfrage-URL
PUT https://smsapi.engagelab.com/v1/template-configs/:templateId
Aufruf-Authentifizierung
Bitte lesen Sie Aufruf-Authentifizierung, um zu erfahren, wie Sie API-Anfragen authentifizieren.
Anfragebeispiel
Anfrage-Header
PUT /v1/template-configs/123456789 HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
PUT /v1/template-configs/123456789 HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
Diesen Codeblock im schwebenden Fenster anzeigen
Anfragetext
{
"template_name": "Order Notification Template",
"template_type": "utility",
"template_content": "Your order {order_no} has been shipped and is expected to be delivered by {delivery_time}",
"country_codes": "CN,US",
"add_signature": true,
"sign_id": "987654321",
"sign_position": 2
}
{
"template_name": "Order Notification Template",
"template_type": "utility",
"template_content": "Your order {order_no} has been shipped and is expected to be delivered by {delivery_time}",
"country_codes": "CN,US",
"add_signature": true,
"sign_id": "987654321",
"sign_position": 2
}
Diesen Codeblock im schwebenden Fenster anzeigen
Anfrageparameter
Pfadparameter
| Parameter | Typ | Option | Beschreibung |
|---|---|---|---|
| templateId | String | Erforderlich | Vorlagen-ID |
Anfragetext-Parameter
| Parameter | Typ | Option | Beschreibung |
|---|---|---|---|
| template_name | String | Erforderlich | Vorlagenname, bis zu 255 Zeichen |
| template_type | String | Erforderlich | Vorlagentyp: utility (Benachrichtigung), marketing (Marketing) |
| template_content | String | Erforderlich | Vorlageninhalt, darf nicht enthalten: 【, 】, 、, 测试, test, [, ] |
| country_codes | String | Erforderlich | Wichtigste Zielländercodes, durch Komma getrennt |
| add_signature | Boolean | Optional | Ob eine Signatur hinzugefügt wird, Standard false |
| sign_id | String | Bedingt erforderlich | Erforderlich, wenn add_signature true ist, Signatur-ID |
| sign_position | Integer | Bedingt erforderlich | Erforderlich, wenn add_signature true ist, Signaturposition: 1-Präfix, 2-Suffix |
Antwortparameter
Erfolgsantwort
Der HTTP-Statuscode ist 200, und der Antworttext enthält die folgenden Felder:
| Feld | Typ | Beschreibung |
|---|---|---|
| code | Integer | Statuscode, 0 bedeutet Erfolg |
| message | String | Statusbeschreibung |
Erfolgsbeispiel
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlerantwort
Der HTTP-Statuscode ist 4xx/5xx, und der Antworttext enthält die folgenden Felder:
| Feld | Typ | Beschreibung |
|---|---|---|
| code | Integer | Fehlercode |
| message | String | Fehlerdetails |
Fehlerbeispiel
{
"code": 400,
"message": "can not update pending status template"
}
{
"code": 400,
"message": "can not update pending status template"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlercodes
| Fehlercode | HTTP-Code | Beschreibung |
|---|---|---|
| 400 | 400 | Parameterfehler oder Fehler in der Geschäftslogik |
| 500 | 500 | Interner Serverfehler |
Häufige Fehlermeldungen:
invalid templateId: Formatfehler der Vorlagen-IDtemplate config not exist: Vorlagenkonfiguration existiert nichtcan not update pending status template: Vorlage im Status „In Prüfung" kann nicht aktualisiert werdenthere are pending or running plans using current template, can not update: Es gibt ausstehende oder laufende Pläne, die diese Vorlage verwenden, sie kann nicht aktualisiert werdensign config not exist: Signaturkonfiguration existiert nichtsign status is not approved, can not use: Signaturstatus ist nicht genehmigt und kann nicht verwendet werden
Hinweise
- Vorlagen im Status „In Prüfung" können nicht aktualisiert werden.
- Wenn es ausstehende oder laufende Nachrichtenpläne gibt, die diese Vorlage verwenden, kann sie nicht aktualisiert werden.
- Nach der Aktualisierung wechselt der Vorlagenstatus zurück zu „In Prüfung" (status=1).
- Wenn eine Signatur hinzugefügt wird, muss die Signatur den Status „genehmigt" haben.
- Der Vorlageninhalt darf keine verbotenen Zeichen enthalten:
【,】,、,测试,test,[,] - Sowohl die Vorlagen- als auch die Signatur-ID sind Zahlen vom Typ String.
Anhang
Status der Vorlagenkonfiguration (status)
| Wert | Beschreibung |
|---|---|
| 1 | In Prüfung |
| 2 | Genehmigt |
| 3 | Abgelehnt |
Vorlagentyp (template_type)
| Wert | Beschreibung |
|---|---|
| utility | Benachrichtigung |
| marketing | Marketing |
Signaturposition (sign_position)
| Wert | Beschreibung |
|---|---|
| 0 | Keine Signatur |
| 1 | Präfix |
| 2 | Suffix |










