テンプレートの作成

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

            

              
              {
    "template_id": "test-template-1",       // カスタムテンプレート id。アプリケーション内で一意
    "description": "Test template 1",       // テンプレートの説明
    "send_channel_strategy": "whatsapp|sms",// テンプレート配信戦略。whatsapp/sms/voice/email に対応。組み合わせ戦略は | 文字で失敗時のフォールバックを表す
    "brand_name": "Brand Name",             // ブランド名。一部の国／地域でテンプレート内容の署名に使用（例: 一部の国では SMS チャネルで登録済み署名が必要）
    "verify_code_config": {                 // 検証コード設定。自動生成される検証コードの設定に使用。テンプレートに検証コード種別を含む場合は必須
        "verify_code_type": 1,              // 検証コード種別。値の範囲は [1,7]
        "verify_code_len": 6,               // 検証コードの長さ。値の範囲は [4,10]
        "verify_code_ttl": 1                // 検証コードの有効期間。値の範囲は [1,10]。戦略に whatsapp を含む場合、値は 1、5、10 のみ指定可能
    },
    "whatsapp_config": {                    // whatsapp 戦略の設定。配信戦略に whatsapp を含む場合に有効
        "template_type": 1,                 // whatsapp テンプレート種別。現在はデフォルトテンプレートのみ対応し、固定値は 1
        "template_default_config": {        // whatsapp デフォルトテンプレート設定。デフォルトテンプレート種別の場合に有効
            "contain_security": false,      // セキュリティ注意を追加するかどうか
            "contain_expire": false         // 有効期限の内容を追加するかどうか
        }
    },
    "sms_config": {                         // sms 戦略の設定。配信戦略に sms を含む場合に有効
        "template_type": 2,                 // sms テンプレート種別。値: 1-デフォルトテンプレート／2-カスタムテンプレート
        "template_default_config": {        // sms デフォルトテンプレート設定。デフォルトテンプレート種別の場合に有効
            "contain_security": false,      // セキュリティ注意を追加するかどうか
            "contain_expire": false         // 有効期限の内容を追加するかどうか
        },
        "template_custom_config": {         // sms カスタムテンプレート設定。sms テンプレート種別がカスタムテンプレートの場合に有効
            "custom_sub_type": "authentication", // カスタムテンプレート種別。値: authentication/marketing/utility
            "custom_content": "xxx",        // カスタムテンプレートの内容。サブ種別が authentication の場合は {{code}} 変数を含める必要がある
            "custom_country_codes": "HK,PH" // カスタムテンプレートの対象国／地域。テンプレート審査時の参考に使用。実際の状況に合わせて入力してください。そうでない場合、実際の配信に影響する可能性があります
        }
    },
    "voice_config": {                       // voice 戦略の設定。配信戦略に voice を含む場合に有効
        "template_type": 1,                 // voice テンプレート種別。現在はデフォルトテンプレートのみ対応し、固定値は 1
        "template_default_config": {        // voice デフォルトテンプレート設定。デフォルトテンプレート種別の場合に有効
            "contain_security": false,      // セキュリティ注意を追加するかどうか
            "contain_expire": false         // 有効期限の内容を追加するかどうか
        }
    },
    "email_config": {                       // email 戦略の設定。配信戦略に email を含む場合に有効
        "template_name": "email template name", // email テンプレート名
        "template_custom_configs": [{       // email カスタムテンプレート設定。オブジェクト配列であることに注意。主に language で複数言語を設定するために使用
            "language": "default",          // 言語。デフォルトは default。メッセージ配信時に language パラメータに応じて異なるテンプレート内容をマッチできる
            "pre_from_name": "test",        // 既定の送信者名
            "pre_from_mail": "test@test.com",// 既定の送信者メールアドレス
            "pre_subject": "test",          // 既定のメール件名
            "template_content": "Preset email template content, required, custom variables like {{self}}, verification code is {{code}}", // メール本文。html に対応。変数は二重波括弧 {{}} で囲む必要がある
            "pre_param_map": {              // メール本文中の変数の既定値。つまり配信時に変数値を指定しない場合、以下の既定値で変数を置き換える。キーと値のペアで宣言し、value は文字列である必要がある
                "self": "Here is the preset value for the self variable"
            }
        }]
    },
    "pwa_config": {                         // pwa 関連の設定。現在は未使用
        "pwa_platform": "xx",               // 使用する pwa プラットフォーム。具体的な値はテクニカルサポートにお問い合わせください
        "pwa_code": "xx"                    // 使用する pwa プラットフォーム内の code
    }
}

            

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

            

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

            

              
              {{brand_name}} Verification Code

            

              
              <img src="{{logo_url}}" />
<strong>{{title}}</strong>
<p>Your verification code is <strong>{{code}}</strong>, please complete verification within {{ttl}} minutes.</p>
<p>If you have any questions, please contact <a href="mailto:{{support_email}}">{{support_email}}</a></p>

            

              
              "pre_param_map": {
  "logo_url": "https://example.com/logo.png",
  "title": "Your Verification Code",
  "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": "Your Verification Code",
      "support_email": "support@example.com"
    }
  }
}