Obtenir les détails d'une configuration de modèle

Récupère les informations détaillées d'une configuration de modèle à partir de l'ID de modèle, notamment le nom du modèle, le type, le contenu, le statut de validation, etc.

Adresse d'appel

GET https://smsapi.engagelab.com/v1/template-configs/:templateId

Authentification

Veuillez consulter Authentification pour savoir comment authentifier les appels à l'API.

Exemple de requête

En-tête de requête

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

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

Afficher ce bloc de code dans la fenêtre flottante

Corps de la requête

Aucun

Paramètres de requête

Paramètres de chemin

Paramètre	Type	Option	Description
templateId	String	Obligatoire	ID du modèle

Paramètres de réponse

Réponse en cas de succès

Le code de statut HTTP est 200 et le corps de la réponse est un objet de configuration de modèle :

Champ	Type	Description
template_id	String	ID du modèle
template_name	String	Nom du modèle
template_type	String	Type de modèle : `utility` (notification), `marketing` (marketing)
template_content	String	Contenu du modèle
country_codes	String	Codes des principaux pays de destination, séparés par des virgules
status	Integer	Statut : 1-En attente de validation, 2-Validé, 3-Rejeté
sign_id	String	ID de la signature (facultatif)
sign_name	String	Nom de la signature (facultatif)
sign_position	Integer	Position de la signature : 0-aucune, 1-préfixe, 2-suffixe (facultatif)
sign_status	Integer	Statut de la signature (facultatif)
audit_remark	String	Remarque de validation
created_time	Integer	Date de création (horodatage Unix)
updated_time	Integer	Date de mise à jour (horodatage Unix)

Exemple de succès

{ "template_id": "123456789", "template_name": "Modèle de notification de commande", "template_type": "utility", "template_content": "Votre commande {order_no} a été expédiée et devrait être livrée d'ici {delivery_time}", "country_codes": "CN,US", "status": 2, "sign_id": "987654321", "sign_name": "Nom de l'entreprise", "sign_position": 2, "sign_status": 2, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 }

              
              {
  "template_id": "123456789",
  "template_name": "Modèle de notification de commande",
  "template_type": "utility",
  "template_content": "Votre commande {order_no} a été expédiée et devrait être livrée d'ici {delivery_time}",
  "country_codes": "CN,US",
  "status": 2,
  "sign_id": "987654321",
  "sign_name": "Nom de l'entreprise",
  "sign_position": 2,
  "sign_status": 2,
  "audit_remark": "",
  "created_time": 1699000000,
  "updated_time": 1699000000
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse en cas d'erreur

Le code de statut HTTP est 4xx/5xx et le corps de la réponse contient les champs suivants :

Champ	Type	Description
code	Integer	Code d'erreur
message	String	Détails de l'erreur

Exemple d'erreur

{ "code": 400, "message": "invalid templateId" }

              
              {
  "code": 400,
  "message": "invalid templateId"
}

Afficher ce bloc de code dans la fenêtre flottante

Codes d'erreur

Code d'erreur	http code	Description
400	400	Erreur de paramètre ou erreur de logique métier
500	500	Erreur interne du serveur

Messages d'erreur courants :

invalid templateId : format de l'ID de modèle incorrect
template config not exist : la configuration de modèle n'existe pas

Annexe

Statut de la configuration de modèle (status)

Valeur	Description
1	En attente de validation
2	Validé
3	Rejeté

Type de modèle (template_type)

Valeur	Description
utility	Notification
marketing	Marketing