Vorlagenkonfiguration erstellen

Erstellen Sie eine neue Vorlagenkonfiguration, mit Unterstützung für Einstellungen zu Vorlagenname, Typ, Inhalt, wichtigsten Zielländern und Signaturinformationen. Nach der Erstellung hat die Vorlage den Status „In Prüfung" und muss die Prüfung bestehen, bevor sie verwendet werden kann.

Anfrage-URL

POST https://smsapi.engagelab.com/v1/template-configs

Aufruf-Authentifizierung

Bitte lesen Sie Aufruf-Authentifizierung, um zu erfahren, wie Sie API-Anfragen authentifizieren.

Anfragebeispiel

Anfrage-Header

POST /v1/template-configs HTTP/1.1 Content-Type: application/json Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

              
              POST /v1/template-configs  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

Parameter	Typ	Option	Beschreibung
template_name	String	Erforderlich	Vorlagenname, bis zu 255 Zeichen
template_type	String	Erforderlich	Vorlagentyp: `authentication` (Authentifizierung / OTP), `utility` (Benachrichtigung), `marketing` (Marketing). Der historische Wert `otp` wird aus Kompatibilitätsgründen auf `authentication` gemappt.
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
template_id	String	Die erstellte Vorlagen-ID

Erfolgsbeispiel

{ "template_id": "123456789" }

              
              {
  "template_id": "123456789"
}

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": "sign status is not approved, can not use" }

              
              {
  "code": 400,
  "message": "sign status is not approved, can not use"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Fehlercode	HTTP-Status	Mögliche Fehler
`1000`	`500`	Interner Servicefehler; Abfrage der Vorlagenliste/-details fehlgeschlagen; Datenbankoperation beim Erstellen, Aktualisieren oder Löschen einer Vorlage fehlgeschlagen; Abfrage der Signaturinformationen oder ausstehender Sendepläne fehlgeschlagen
`2001`	`401`	Authentifizierung fehlgeschlagen; `Authorization` fehlt, hat ein falsches Format oder das Token ist ungültig
`2002`	`401/403`	Entwickler-Token abgelaufen oder deaktiviert; Geschäftseinheit wurde gelöscht
`2005`	`400`	IP nicht in der Allowlist: `ip forbidden`
`3001`	`400`	Ungültiges JSON-Format der Anfrage: `not correct parameter format`
`3002`	`400`	Ungültiges Format von `templateId`; `template_name` leer oder länger als 255 Zeichen; ungültiger `template_type`; leerer `template_content`; leere `country_codes`; fehlende `sign_id`, wenn `add_signature=true`; ungültige `sign_position`; Vorlageninhalt enthält verbotene Zeichen
`3002`	`400`	Validierung einer Vorlage vom Typ Authentifizierung fehlgeschlagen: muss `{{code}}` enthalten und unterstützt nur die beiden Variablen `{{code}}` und `{{ttl}}`
`3003`	`400`	Signatur beim Hinzufügen nicht genehmigt; Vorlage gehört nicht zur aktuellen Geschäftseinheit; Vorlagen in Prüfung können nicht aktualisiert werden; Vorlage wird von ausstehenden oder laufenden Plänen verwendet und kann nicht aktualisiert/gelöscht werden
`4001`	`400`	Vorlage existiert nicht: `template config not exist`; beim Erstellen/Aktualisieren referenzierte Signatur existiert nicht: `sign config not exist`

Häufige Fehlermeldungen:

sign config not exist: Signaturkonfiguration existiert nicht
sign status is not approved, can not use: Signaturstatus ist nicht genehmigt und kann nicht verwendet werden
template config not exist: Vorlagenkonfiguration existiert nicht
ip forbidden: IP ist nicht in der Allowlist enthalten
not correct parameter format: Ungültiges JSON-Format der Anfrage

Hinweise

Nach der Erstellung hat die Vorlage den Status „In Prüfung" (status=1) und muss die Prüfung bestehen, bevor sie zum Senden von SMS verwendet werden kann.
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
authentication	Authentifizierung / OTP
utility	Benachrichtigung
marketing	Marketing

Der historische Wert otp wird aus Kompatibilitätsgründen auf authentication gemappt. Der Inhalt einer Vorlage vom Typ Authentifizierung muss {{code}} enthalten und unterstützt nur die beiden Variablen {{code}} und {{ttl}}.

Signaturposition (sign_position)

Wert	Beschreibung
0	Keine Signatur
1	Präfix
2	Suffix