テンプレート詳細の取得

リクエスト URL

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

認証

API 認証の方法については 認証 を参照してください。

リクエスト

リクエストパラメータ

URL 中の {templateId} は取得対象のテンプレート ID を表し、テンプレート作成インターフェースの呼び出し時に呼び出し側が定義したものです。

リクエスト例

リクエストヘッダー

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

            
このコードブロックはフローティングウィンドウ内に表示されます

リクエストボディ

なし

レスポンス

レスポンスパラメータ

テンプレートの詳細な設定情報を含む JSON オブジェクトを返します。

レスポンス例

成功レスポンス

{ "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": { // voice 戦略の設定。配信戦略に voice を含む場合に返却 "template_type": 1 // voice テンプレート種別。現在はデフォルトテンプレートのみ対応し、固定値は 1 }, "email_config": { // email 戦略の設定。配信戦略に email を含む場合に返却 "template_name": "email template name", // email テンプレート名 "template_custom_configs": [{ // email カスタムテンプレート設定。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": { // メール本文中の変数の既定値。つまり配信時に変数値を指定しない場合、以下の既定値で変数を置き換える。キーと値のペアで宣言する "self": "Here is the preset value for the self variable" } }] }, "pwa_config": { // pwa 関連の設定。pwa 設定がある場合のみ返却 "pwa_platform": "xx", // 使用する pwa プラットフォーム "pwa_code": "xx" // 使用する pwa プラットフォーム内の code }, "created_time": 1234567890, // テンプレートの作成時刻。タイムスタンプ形式、秒単位 "status": 1, // テンプレートのステータス。値: 1-審査待ち/2-承認済み/3-却下 "audit_remark": "xx" // 審査の備考。一般に審査が却下された場合、このフィールドで却下理由を確認できる }
              
              {
    "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 を含む場合、値は 1510 のみ指定可能
    },
    "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": {                       // voice 戦略の設定。配信戦略に voice を含む場合に返却
        "template_type": 1                  // voice テンプレート種別。現在はデフォルトテンプレートのみ対応し、固定値は 1
    },
    "email_config": {                       // email 戦略の設定。配信戦略に email を含む場合に返却
        "template_name": "email template name", // email テンプレート名
        "template_custom_configs": [{       // email カスタムテンプレート設定。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": {              // メール本文中の変数の既定値。つまり配信時に変数値を指定しない場合、以下の既定値で変数を置き換える。キーと値のペアで宣言する
                "self": "Here is the preset value for the self variable"
            }
        }]
    },
    "pwa_config": {                         // pwa 関連の設定。pwa 設定がある場合のみ返却
        "pwa_platform": "xx",               // 使用する pwa プラットフォーム
        "pwa_code": "xx"                    // 使用する pwa プラットフォーム内の code
    },
    "created_time": 1234567890,             // テンプレートの作成時刻。タイムスタンプ形式、秒単位
    "status": 1,                            // テンプレートのステータス。値: 1-審査待ち/2-承認済み/3-却下
    "audit_remark": "xx"                    // 審査の備考。一般に審査が却下された場合、このフィールドで却下理由を確認できる
}

            
このコードブロックはフローティングウィンドウ内に表示されます

失敗レスポンス

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

            
このコードブロックはフローティングウィンドウ内に表示されます

エラーコード

エラーコード HTTP コード 説明
1000 500 内部エラー
2001 401 認証失敗。付与されたトークンが正しくない
2002 401 認証失敗。トークンが期限切れまたは無効化されている
2004 403 この API を呼び出す権限がない
4001 400 テンプレートが存在しない
Icon Solid Transparent White Qiyu
お問い合わせ