Liste der Vorlagenkonfigurationen abrufen

Rufen Sie eine Liste aller Vorlagenkonfigurationen des aktuellen Unternehmens ab; zurückgegeben wird eine Liste mit Vorlagennamen, Typen, Inhalt, Prüfungsstatus usw.

Anfrage-URL

GET 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

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

Anfragetext

Keiner

Anfrageparameter

Keine

Antwortparameter

Erfolgsantwort

Der HTTP-Statuscode ist 200, und der Antworttext ist ein Array von Vorlagenkonfigurationen:

Feld	Typ	Beschreibung
template_id	String	Vorlagen-ID
template_name	String	Vorlagenname
template_type	String	Vorlagentyp: `utility` (Benachrichtigung), `marketing` (Marketing)
template_content	String	Vorlageninhalt
country_codes	String	Wichtigste Zielländercodes, durch Komma getrennt
status	Integer	Status: 1-In Prüfung, 2-Genehmigt, 3-Abgelehnt
sign_id	String	Signatur-ID (optional)
sign_name	String	Signaturname (optional)
sign_position	Integer	Signaturposition: 0-keine, 1-Präfix, 2-Suffix (optional)
sign_status	Integer	Signaturstatus (optional)
audit_remark	String	Prüfungsanmerkungen
created_time	Integer	Erstellungszeit (Unix-Zeitstempel)
updated_time	Integer	Aktualisierungszeit (Unix-Zeitstempel)

Erfolgsbeispiel

[ { "template_id": "123456789", "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", "status": 2, "sign_id": "987654321", "sign_name": "Company Name", "sign_position": 2, "sign_status": 2, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 } ]

              
              [
  {
    "template_id": "123456789",
    "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",
    "status": 2,
    "sign_id": "987654321",
    "sign_name": "Company Name",
    "sign_position": 2,
    "sign_status": 2,
    "audit_remark": "",
    "created_time": 1699000000,
    "updated_time": 1699000000
  }
]

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": 500, "message": "Internal server error" }

              
              {
  "code": 500,
  "message": "Internal server error"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Fehlercode	HTTP-Code	Beschreibung
400	400	Parameterfehler oder Fehler in der Geschäftslogik
500	500	Interner Serverfehler

Anhang

Status der Vorlagenkonfiguration (status)

Wert	Beschreibung
1	In Prüfung
2	Genehmigt
3	Abgelehnt

Vorlagentyp (template_type)

Wert	Beschreibung
utility	Benachrichtigung
marketing	Marketing