Créer un modèle

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

            

              
              {
    "template_id": "test-template-1",       // id de modèle personnalisé, unique au sein de l'application
    "description": "Modèle de test 1",          // description explicative du modèle
    "send_channel_strategy": "whatsapp|sms",    // stratégie d'envoi du modèle, prend en charge les quatre types whatsapp/sms/voice/email ; pour une stratégie combinée, utilisez le caractère ｜ pour indiquer le renvoi en cas d'échec
    "brand_name": "Nom de la marque",          // nom de la marque, utilisé dans la signature du contenu des modèles de certains pays/régions (par exemple, certains pays/régions exigent l'enregistrement d'une signature sur le canal SMS)
    "verify_code_config": {                     // configuration du code de vérification, utilisée pour configurer le code de vérification généré automatiquement, obligatoire lorsque le modèle inclut un type de code de vérification
        "verify_code_type": 1,                  // type de code de vérification, plage de valeurs [1,7]
        "verify_code_len": 6,                   // longueur du code de vérification, plage de valeurs [4,10]
        "verify_code_ttl": 1                    // durée de validité du code de vérification, plage de valeurs [1,10] ; attention, lorsque la stratégie inclut whatsapp, la valeur ne peut être que 1, 5 ou 10
    },
    "whatsapp_config": {                        // configuration de la stratégie whatsapp, valable lorsque la stratégie d'envoi inclut whatsapp
        "template_type": 1,                      // type de modèle whatsapp, seul le modèle par défaut est actuellement pris en charge, soit la valeur fixe 1
        "template_default_config": {            // configuration du modèle whatsapp par défaut, valable pour le type de modèle par défaut
            "contain_security": false,              // indique s'il faut ajouter un rappel de sécurité
            "contain_expire": false                 // indique s'il faut ajouter le contenu relatif au délai d'expiration
        }
    },
    "sms_config": {                             // configuration de la stratégie sms, valable lorsque la stratégie d'envoi inclut sms
        "template_type": 2,                     // type de modèle sms, valeurs : 1-modèle par défaut/2-modèle personnalisé
        "template_default_config": {            // configuration du modèle sms par défaut, valable pour le type de modèle par défaut
            "contain_security": false,              // indique s'il faut ajouter un rappel de sécurité
            "contain_expire": false                 // indique s'il faut ajouter le contenu relatif au délai d'expiration
        },
        "template_custom_config": {             // configuration du modèle sms personnalisé, valable lorsque le type de modèle sms est un modèle personnalisé
            "custom_sub_type": "authentication",    // type de modèle personnalisé, valeurs : authentication-code de vérification/marketing-marketing/utility-notification
            "custom_content": "xxx",                // contenu du modèle personnalisé ; attention, si le sous-type est authentication (code de vérification), il doit contenir la variable {{code}}
            "custom_country_codes": "HK,PH"         // pays/régions cibles du modèle personnalisé, utilisés comme référence lors de la révision du modèle ; veuillez les renseigner conformément à la réalité, sous peine d'affecter l'envoi effectif
        }
    },
    "voice_config": {                           // configuration de la stratégie voice, valable lorsque la stratégie d'envoi inclut voice
        "template_type": 1,                      // type de modèle voice, seul le modèle par défaut est actuellement pris en charge, soit la valeur fixe 1
        "template_default_config": {            // configuration du modèle voice par défaut, valable pour le type de modèle par défaut
            "contain_security": false,              // indique s'il faut ajouter un rappel de sécurité
            "contain_expire": false                 // indique s'il faut ajouter le contenu relatif au délai d'expiration
        }
    },
    "email_config": {                           // configuration de la stratégie email, valable lorsque la stratégie d'envoi inclut email
        "template_name": "nom du modèle email",               // nom du modèle email
        "template_custom_configs": [{           // configuration du modèle email personnalisé ; attention, il s'agit ici d'un tableau d'objets, principalement pour configurer plusieurs entrées distinguées par language
            "language": "default",              // langue, default étant la valeur par défaut ; lors de l'envoi du message, différents contenus de modèle peuvent être associés selon le paramètre language
            "pre_from_name": "test",            // nom de l'expéditeur prédéfini
            "pre_from_mail": "test@test.com",   // adresse e-mail de l'expéditeur prédéfini
            "pre_subject": "test",              // objet de l'e-mail prédéfini
            "template_content": "Contenu prédéfini du modèle d'e-mail, obligatoire, variables personnalisées comme {{self}}, le code de vérification est {{code}}",    // contenu de l'e-mail, prend en charge le html ; les variables doivent être entourées de doubles accolades {{}}
            "pre_param_map": {                  // valeurs par défaut des variables du contenu de l'e-mail ; si aucune valeur n'est spécifiée lors de l'envoi, les valeurs par défaut ci-dessous remplacent les variables ; déclarées sous forme de paires clé-valeur, la valeur devant être une chaîne de caractères
                "self": "Voici la valeur prédéfinie de la variable self"
            }
        }]
    },
    "pwa_config": {                             // configuration relative au pwa, temporairement inutilisée
        "pwa_platform": "xx",                   // plateforme pwa utilisée, veuillez contacter le support technique pour déterminer les valeurs précises
        "pwa_code": "xx"                        // code dans la plateforme pwa utilisée
    }
}

            

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

            

              
              {
    "code": 3003,
    "message": "not contains any channel config"
}

            

              
              {{brand_name}} Code de vérification

            

              
              <img src="{{logo_url}}" />
<strong>{{title}}</strong>
<p>Votre code de vérification est <strong>{{code}}</strong>, veuillez terminer la vérification dans un délai de {{ttl}} minutes.</p>
<p>Pour toute question, veuillez contacter <a href="mailto:{{support_email}}">{{support_email}}</a></p>

            

              
              "pre_param_map": {
  "logo_url": "https://example.com/logo.png",
  "title": "Votre code de vérification",
  "support_email": "support@example.com"
}

            

              
              {
  "to": "user@example.com",
  "template": {
    "id": "my_email_template",
    "language": "default",
    "params": {
      "logo_url": "https://example.com/logo.png",
      "title": "Votre code de vérification",
      "support_email": "support@example.com"
    }
  }
}