Mettre à jour la configuration de modèle

Mettez à jour une configuration de modèle existante, avec prise en charge de la modification du nom, du type, du contenu, des pays de destination et des informations de signature du modèle. Après la mise à jour, le statut du modèle repasse à « En attente de validation ».

Adresse d'appel

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

Authentification

Veuillez consulter Authentification pour savoir comment authentifier les requêtes API.

Exemple de requête

En-tête de la requête

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

            

Corps de la 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
}

            

Paramètres de requête

Paramètres de chemin

Paramètres du corps de la requête

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 :

Exemple de succès

              
              {
  "code": 0,
  "message": "success"
}

            

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 :

Exemple d'erreur

              
              {
  "code": 400,
  "message": "can not update pending status template"
}

            

Codes d'erreur

Messages d'erreur courants :

• invalid templateId : format de l'ID du modèle incorrect
• template config not exist : la configuration de modèle n'existe pas
• can not update pending status template : un modèle en attente de validation ne peut pas être mis à jour
• there are pending or running plans using current template, can not update : il existe des plans en attente d'envoi ou en cours d'exécution utilisant ce modèle, mise à jour impossible
• sign config not exist : la configuration de signature n'existe pas
• sign status is not approved, can not use : le statut de la signature n'est pas validé, utilisation impossible

Points d'attention

1. Un modèle en attente de validation ne peut pas être mis à jour.
2. S'il existe des plans de messages en attente d'envoi ou en cours d'exécution utilisant ce modèle, il ne peut pas être mis à jour.
3. Après la mise à jour, le statut du modèle repasse à « En attente de validation » (status=1).
4. Si une signature est ajoutée, celle-ci doit être au statut validé.
5. Le contenu du modèle ne peut pas contenir les caractères interdits : 【, 】, 、, 测试, test, [, ]
6. 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)

Type de modèle (template_type)

Position de la signature (sign_position)