Logo Site EngageLab Mark Colored TransparentDocumentation
Rechercher

Obtenir le détail d'un modèle

Adresse d'appel

GET https://otp.api.engagelab.cc/v1/template-configs/{templateId}

Authentification

Veuillez consulter Authentification pour savoir comment effectuer l'authentification de l'API.

Requête

Paramètres de requête

Le {templateId} présent dans l'URL désigne l'identifiant du modèle à récupérer ; cet identifiant est défini par l'appelant lors de l'appel à l'interface de création de modèle.

Exemple de requête

En-tête de requête

GET /v1/template-configs/{templateId} HTTP/1.1 Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
              
              GET /v1/template-configs/{templateId}  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            
Afficher ce bloc de code dans la fenêtre flottante

Corps de la requête

Aucun

Réponse

Paramètres de réponse

Renvoie un objet JSON contenant les informations de configuration détaillées du modèle.

Exemple de réponse

Réponse en cas de succès

{ "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, renvoyée lorsque le modèle contient 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, renvoyée 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, valeur fixe 1 }, "sms_config": { // configuration de la stratégie sms, renvoyée 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_parts": 1, // nombre estimé de segments facturés pour le modèle sms ; si le modèle est trop long, le prix exact = nombre de segments facturés * prix unitaire de facturation "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}} } }, "voice_config": { // configuration de la stratégie voice, renvoyée 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, valeur fixe 1 }, "email_config": { // configuration de la stratégie email, renvoyée 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é, valable lorsque le type de modèle email est un modèle 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 de variable n'est spécifiée lors de l'envoi, les valeurs par défaut ci-dessous sont utilisées pour remplacer les variables ; déclarées sous forme de paires clé-valeur "self": "Voici la valeur prédéfinie de la variable self" } }] }, "pwa_config": { // configuration relative au pwa, renvoyée uniquement lorsqu'une configuration pwa existe "pwa_platform": "xx", // plateforme pwa utilisée "pwa_code": "xx" // code dans la plateforme pwa utilisée }, "created_time": 1234567890, // date de création du modèle, au format horodatage, à la seconde près "status": 1, // statut du modèle, valeurs : 1-en attente de révision/2-révision approuvée/3-révision refusée "audit_remark": "xx" // remarque de révision, généralement consultable lorsque la révision est refusée pour connaître le motif du refus }
              
              {
    "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, renvoyée lorsque le modèle contient 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, renvoyée 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, valeur fixe 1
    },
    "sms_config": {                             // configuration de la stratégie sms, renvoyée 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_parts": 1,                    // nombre estimé de segments facturés pour le modèle sms ; si le modèle est trop long, le prix exact = nombre de segments facturés * prix unitaire de facturation
        "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}}
        }
    },
    "voice_config": {                           // configuration de la stratégie voice, renvoyée 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, valeur fixe 1
    },
    "email_config": {                           // configuration de la stratégie email, renvoyée 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é, valable lorsque le type de modèle email est un modèle 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 de variable n'est spécifiée lors de l'envoi, les valeurs par défaut ci-dessous sont utilisées pour remplacer les variables ; déclarées sous forme de paires clé-valeur
                "self": "Voici la valeur prédéfinie de la variable self"
            }
        }]
    },
    "pwa_config": {                             // configuration relative au pwa, renvoyée uniquement lorsqu'une configuration pwa existe
        "pwa_platform": "xx",                   // plateforme pwa utilisée
        "pwa_code": "xx"                        // code dans la plateforme pwa utilisée
    },
    "created_time": 1234567890,                 // date de création du modèle, au format horodatage, à la seconde près
    "status": 1,                                 // statut du modèle, valeurs : 1-en attente de révision/2-révision approuvée/3-révision refusée
    "audit_remark": "xx"                        // remarque de révision, généralement consultable lorsque la révision est refusée pour connaître le motif du refus
}

            
Afficher ce bloc de code dans la fenêtre flottante

Réponse en cas d'échec

{ "code": 4001, "message": "config not exist" }
              
              {
    "code": 4001,
    "message": "config not exist"
}

            
Afficher ce bloc de code dans la fenêtre flottante

Codes d'erreur

Code d'erreur http code Description
1000 500 Erreur interne
2001 401 Échec de l'authentification, le token correct n'a pas été fourni
2002 401 Échec de l'authentification, le token a expiré ou a été désactivé
2004 403 Aucune autorisation pour appeler cette API
4001 400 Le modèle n'existe pas
Icon Solid Transparent White Qiyu
Contactez-nous