テンプレートAPIインターフェース

              
              Authorization: Basic ${base64_auth_string}

            

              
              POST /v1/messages  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",    // テンプレート配信戦略、4種類をサポート：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カスタムテンプレート設定、カスタムテンプレートタイプに有効
            "custom_sub_type": "authentication",    // カスタムテンプレートタイプ、値：authentication-認証コード/marketing-マーケティング/utility-通知
            "custom_content": "xxx",                // カスタムテンプレートコンテンツ。注意：認証タイプの場合、{{code}}変数を含む必要あり
            "custom_country_codes": "HK,PH"         // カスタムテンプレートの対象国/地域、テンプレート審査時の参考として使用。必要に応じて記入、未記入の場合配信に影響する可能性あり
        }
    },
    "voice_config": {                       // 音声戦略設定、配信戦略に音声が含まれる場合に有効
        "template_type": 1,                 // 音声テンプレートタイプ、現在はデフォルトテンプレートのみサポート、固定値1
        "template_default_config": {        // 音声デフォルトテンプレート設定、デフォルトテンプレートタイプに有効
            "contain_security": false,      // セキュリティリマインダーを含むかどうか
            "contain_expire": false         // 有効期限コンテンツを含むかどうか
        }
    },
    "email_config": {                       // メール戦略設定、配信戦略にメールが含まれる場合に有効
        "template_name": "Email Template Name",     // メールテンプレート名
        "template_custom_configs": [{       // メールカスタムテンプレート設定、これはオブジェクトの配列であり、主に言語で区別される
            "language": "default",          // 言語、defaultはデフォルト。配信時に言語パラメータに基づいてテンプレートコンテンツを一致させることができる
            "pre_from_name": "test",        // プリセット送信者名
            "pre_from_mail": "test@test.com",   // プリセット送信者メール
            "pre_subject": "test",          // プリセットメール件名
            "template_content": "プリセットメールテンプレートコンテンツ、必須。{{self}}などのカスタム変数、認証コードは{{code}}",    // メールコンテンツ、HTMLをサポート。変数は二重中括弧{{}}で囲む必要あり
            "pre_param_map": {              // メールコンテンツ内の変数のデフォルト値。配信時に変数値が指定されていない場合、これらのデフォルト値が変数を置き換える。キーと値のペアとして宣言され、値は文字列でなければならない
                "self": "self変数のプリセット値"
            }
        }]
    },
    "pwa_config": {                         // PWA関連設定、オプション
        "pwa_platform": "xx",               // 使用するPWAプラットフォーム。具体的な値については技術サポートにお問い合わせください
        "pwa_code": "xx"                    // 使用するPWAプラットフォーム内のコード
    }
}

            

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

            

              
              {
    "code": 3003,
    "message": "チャネル設定が含まれていません"
}

            

              
              Authorization: Basic ${base64_auth_string}

            

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

            

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

            

              
              {
    "code": 4001,
    "message": "設定が存在しません"
}

            

              
              Authorization: Basic ${base64_auth_string}

            

              
              GET /v1/template-configs  HTTP/1.1
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
    },
    "sms_config": {                         // SMS戦略の設定。配信戦略にSMSが含まれる場合に返される
        "template_type": 2,                 // SMSテンプレートタイプ。値: 1-デフォルトテンプレート/2-カスタムテンプレート
        "template_parts": 1                 // SMSテンプレートの推定課金パーツ。テンプレートが長すぎる場合、具体的な価格 = 課金パーツ * 単価
    },
    "voice_config": {                       // 音声戦略の設定。配信戦略に音声が含まれる場合に返される
        "template_type": 1                  // 音声テンプレートタイプ。現在はデフォルトテンプレートのみサポート。固定値1
    },
    "email_config": {                       // メール戦略の設定。配信戦略にメールが含まれる場合に返される
        "template_name": "Email Template Name" // メールテンプレート名
    },
    "pwa_config": {                         // PWA関連の設定。PWA設定が存在する場合に返される
        "pwa_platform": "xx",               // 使用されるPWAプラットフォーム
        "pwa_code": "xx"                    // PWAプラットフォームで使用されるコード
    },
    "created_time": 1234567890,             // テンプレートの作成時間。タイムスタンプ形式（秒単位）
    "status": 1,                            // テンプレートのステータス。値: 1-審査中/2-承認済み/3-拒否
    "audit_remark": "xx"                    // 審査コメント。審査が拒否された場合の理由を確認するために使用
},...]      // 注: これはオブジェクトの配列です

            

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

            

              
              Authorization: Basic ${base64_auth_string}

            

              
              GET /v1/template-configs/custom-template-id  HTTP/1.1
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
    },
    "sms_config": {                         // SMS戦略の設定。配信戦略にSMSが含まれる場合に返される
        "template_type": 2,                 // SMSテンプレートタイプ。値: 1-デフォルトテンプレート/2-カスタムテンプレート
        "template_parts": 1,                // SMSテンプレートの推定課金パーツ。テンプレートが長すぎる場合、具体的な価格 = 課金パーツ * 単価
        "template_custom_config": {         // カスタムSMSテンプレート設定。SMSテンプレートタイプがカスタムの場合に有効
            "custom_sub_type": "authentication",    // カスタムテンプレートタイプ。値: authentication-認証コード/marketing-マーケティング/utility-通知
            "custom_content": "xxx"                // カスタムテンプレート内容。注: サブタイプがauthentication（認証コード）の場合、{{code}}変数を含む必要がある
        }
    },
    "voice_config": {                       // 音声戦略の設定。配信戦略に音声が含まれる場合に返される
        "template_type": 1                  // 音声テンプレートタイプ。現在はデフォルトテンプレートのみサポート。固定値1
    },
    "email_config": {                       // メール戦略の設定。配信戦略にメールが含まれる場合に返される
        "template_name": "Email Template Name", // メールテンプレート名
        "template_custom_configs": [{       // カスタムメールテンプレート設定。メールテンプレートタイプがカスタムの場合に有効。注: これはオブジェクトの配列で、主に言語で区別される
            "language": "default",          // 言語。"default"はデフォルト。メッセージ送信時に、言語パラメータに基づいて異なるテンプレート内容をマッチング可能
            "pre_from_name": "test",        // 事前設定された送信者名
            "pre_from_mail": "test@test.com",   // 事前設定された送信者メール
            "pre_subject": "test",          // 事前設定されたメール件名
            "template_content": "事前設定されたメールテンプレート内容。必須。{{self}}などのカスタム変数や認証コード{{code}}を含む", // メール内容。HTMLをサポート。変数は二重中括弧{{}}で囲む必要がある
            "pre_param_map": {              // メール内容内の変数のデフォルト値。送信時に変数値が指定されない場合、以下のデフォルト値が変数を置き換える。キーと値のペアとして宣言
                "self": "self変数のデフォルト値です"
            }
        }]
    },
    "pwa_config": {                         // PWA関連の設定。PWA設定が存在する場合に返される
        "pwa_platform": "xx",               // 使用されるPWAプラットフォーム
        "pwa_code": "xx"                    // PWAプラットフォームで使用されるコード
    },
    "created_time": 1234567890,             // テンプレートの作成時間。タイムスタンプ形式（秒単位）
    "status": 1,                            // テンプレートのステータス。値: 1-審査中/2-承認済み/3-拒否
    "audit_remark": "xx"                    // 審査コメント。審査が拒否された場合の理由を確認するために使用
}

            

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