Créer une configuration de modèle

Créez une nouvelle configuration de modèle, permettant de définir le nom du modèle, son type, son contenu, les pays de destination et les informations de signature. Après sa création, le modèle est à l'état « En attente de validation » et doit être validé avant de pouvoir être utilisé.

URL d'appel

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

Authentification des appels

Veuillez consulter Authentification des appels pour savoir comment authentifier vos requêtes API.

Exemple de requête

En-tête de requête

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

Afficher ce bloc de code dans la fenêtre flottante

Corps de requête

{ "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", "add_signature": true, "sign_id": "987654321", "sign_position": 2 }

              
              {
  "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",
  "add_signature": true,
  "sign_id": "987654321",
  "sign_position": 2
}

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de requête

Paramètre	Type	Option	Description
template_name	String	Obligatoire	Nom du modèle, 255 caractères maximum
template_type	String	Obligatoire	Type de modèle : `authentication` (authentification / OTP), `utility` (notification), `marketing` (marketing). La valeur historique `otp` est mappée vers `authentication` pour des raisons de compatibilité.
template_content	String	Obligatoire	Contenu du modèle, ne peut pas contenir : `【`, `】`, `、`, `测试`, `test`, `[`, `]`
country_codes	String	Obligatoire	Codes des principaux pays de destination, séparés par des virgules
add_signature	Boolean	Facultatif	Indique s'il faut ajouter une signature, false par défaut
sign_id	String	Obligatoire sous condition	Obligatoire lorsque add_signature vaut true, ID de la signature
sign_position	Integer	Obligatoire sous condition	Obligatoire lorsque add_signature vaut true, position de la signature : 1-préfixe, 2-suffixe

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 contient les champs suivants :

Champ	Type	Description
template_id	String	ID du modèle créé

Exemple de succès

{ "template_id": "123456789" }

              
              {
  "template_id": "123456789"
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse en cas d'échec

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étail de l'erreur

Exemple d'erreur

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

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

Afficher ce bloc de code dans la fenêtre flottante

Codes d'erreur

Code d'erreur	Statut HTTP	Erreurs possibles
`1000`	`500`	Erreur interne du service ; échec de la récupération de la liste/des détails des modèles ; échec d'une opération base de données lors de la création, mise à jour ou suppression d'un modèle ; échec de la récupération des informations de signature ou des plans en attente d'envoi
`2001`	`401`	Échec d'authentification ; `Authorization` manquant, mal formé, ou token invalide
`2002`	`401/403`	Token développeur expiré ou désactivé ; l'entreprise (business) a été supprimée
`2005`	`400`	IP non autorisée : `ip forbidden`
`3001`	`400`	Format JSON de la requête invalide : `not correct parameter format`
`3002`	`400`	Format de `templateId` invalide ; `template_name` vide ou de plus de 255 caractères ; `template_type` invalide ; `template_content` vide ; `country_codes` vide ; `sign_id` manquant quand `add_signature=true` ; `sign_position` invalide ; contenu du modèle contenant des caractères interdits
`3002`	`400`	Échec de validation d'un modèle de type authentification : doit contenir `{{code}}` et ne prend en charge que les deux variables `{{code}}` et `{{ttl}}`
`3003`	`400`	La signature ajoutée n'est pas approuvée ; le modèle n'appartient pas à l'entreprise actuelle ; un modèle en attente de validation ne peut pas être mis à jour ; un modèle utilisé par des plans en attente ou en cours d'exécution ne peut pas être mis à jour/supprimé
`4001`	`400`	Modèle inexistant : `template config not exist` ; la signature référencée lors de la création/mise à jour n'existe pas : `sign config not exist`

Messages d'erreur courants :

sign config not exist : la configuration de signature n'existe pas
sign status is not approved, can not use : la signature n'a pas été validée et ne peut pas être utilisée
template config not exist : la configuration du modèle n'existe pas
ip forbidden : l'IP n'est pas dans la liste d'autorisation
not correct parameter format : format JSON de la requête invalide

Points d'attention

Après sa création, le modèle est à l'état « En attente de validation » (status=1) et doit être validé avant de pouvoir être utilisé pour envoyer des SMS
Si une signature est ajoutée, celle-ci doit avoir été validée
Le contenu du modèle ne peut pas contenir les caractères interdits : 【, 】, 、, 测试, test, [, ]
Les ID du modèle et de la signature sont tous deux des nombres de type chaîne de caractères

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
authentication	Authentification / OTP
utility	Notification
marketing	Marketing

La valeur historique otp est mappée vers authentication pour des raisons de compatibilité. Le contenu d'un modèle de type authentification doit contenir {{code}} et ne prend en charge que les deux variables {{code}} et {{ttl}}.

Position de la signature (sign_position)

Valeur	Description
0	Aucune signature
1	Préfixe
2	Suffixe