テンプレート管理 API

              
              Authorization: Basic ${base64_auth_string}

            

              
              // 各オブジェクトがテンプレート情報を表すJSON配列
[
{
"id": "406979728071589", // テンプレートID
"name": "code", // テンプレート名
"language": "zh_CN", // テンプレート言語
"status": "APPROVED", // ステータス。APPROVEDは承認済みで利用可能を示します。
"category": "OTP", // カテゴリ。現在はOTP/TRANSACTIONAL/MARKETINGをサポート
"components": [ // テンプレートの具体的な内容。HEADER/BODY/FOOTER/BUTTONを含むことができます。
{
"type": "HEADER",
"format": "text", // タイプ。text/image/location/video/documentをサポート。デフォルトはTEXT
"text": "登録確認コード" // テキスト内容。formatがtextの場合は必須
},
{
"type": "BODY",
"text": "あなたの確認コードは{{1}}です。5分以内に入力してください。" // {{}}内の変数はテンプレート変数を表します
}
]
},
......
]

            

              
              GET https://wa.api.engagelab.cc/v1/templates/406979728071589

            

              
              {
"id": "406979728071589", // テンプレートID
"name": "code", // テンプレート名
"language": "zh_CN", // テンプレート言語
"status": "APPROVED", // ステータス。APPROVEDは承認済みで利用可能を示します。
"category": "OTP", // カテゴリ。現在はOTP/TRANSACTIONAL/MARKETINGをサポート
"components": [ // テンプレートの具体的な内容。HEADER/BODY/FOOTER/BUTTONを含むことができます。
{
"type": "HEADER",
"format": "text", // タイプ。text/image/location/video/documentをサポート。デフォルトはTEXT
"text": "登録確認コード" // テキスト内容。formatがtextの場合は必須
},
{
"type": "BODY",
"text": "あなたの確認コードは{{1}}です。5分以内に入力してください。" // {{}}内の変数はテンプレート変数を表します
}
]
}

            

              
              {
"name": "template_name", // テンプレート名。同じ名前を許可。小文字、数字、アンダースコアのみをサポート
"language": "zh_CN", // テンプレート言語。同じ名前で同じ言語は許可されません
"category": "OTP", // カテゴリ。現在はOTP/TRANSACTIONAL/MARKETINGをサポート
"components": [
{ // テンプレート内容
"type": "BODY", // コンテンツブロック。現在はHEADER/BODY/FOOTER/BUTTONSをサポート
"text": "define var as {{1}}" // 特定のテキスト。bodyがtextの場合、formatフィールドは不要
"example": {
"body_text": [
[
"var1"
]
]
}
},
{
"type": "HEADER",
"format": "image", // コンテンツタイプ。text/image/video/document/locationをサポート
"example": {
"header_handle": [
"https://jiguang.cn/demopic.jpg"
]
}
},
{
"type": "FOOTER",
"text": "footer only support text without variable"
},
{
"type": "BUTTONS",
"buttons": [
{
"type": "PHONE_NUMBER", // ボタンタイプ。PHONE_NUMBER/URL/QUICK_REPLYをサポート

"text": "this is a phone number",
"phone_number": "8613800138000"
}
]
}
]
}

            

              
              {
"name": "copycodetmpl",
"language": "zh_CN",
"category": "AUTHENTICATION",
"components": [
{
// bodyは必須
"type": "BODY",
"add_security_recommendation": true  // セキュリティ推奨説明を追加するかどうか
   },
    {
        // footerは任意
        "type": "FOOTER",		
        "code_expiration_minutes": 2    // 有効期限の表示を追加、範囲[1,90]、追加しない場合はこのフィールドを渡さない
    },
    {
        "type": "BUTTONS",          
        "buttons": [
            {
                "type": "OTP",
                "otp_type": "copy_code",
                "text": "コピーする"      // 文字数制限25文字
            }
        ]
    }
]
}

            

              
              {
"name": "copycodetmpl",
"language": "zh_CN",
"category": "AUTHENTICATION",
"components": [
{
"type": "BODY",
"text": "{{1}} はあなたの認証コードです。セキュリティ上の理由から、このコードを共有しないでください。",
"example": {
"body_text": [
["123456"]
]
}
},
{
"type": "FOOTER",
"text": "この認証コードは2分後に期限切れになります。"
},
{
"type": "BUTTONS",
"buttons": [{
"type": "URL",
"text": "コードをコピー",
"url": "https://www.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}",
"example": [
"https://www.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp123456"
]
}]
}
]
}

            

              
              {
"name": "copycodetmpl",
"language": "zh_CN",
"category": "AUTHENTICATION",
"components": [
{
// bodyは必須
"type": "BODY",
"add_security_recommendation": true  // セキュリティ推奨説明を追加するかどうか

    },
    {
        // footerは任意
        "type": "FOOTER",		
        "code_expiration_minutes": 2    // 有効期限の表示を追加、範囲[1,90]、追加しない場合はこのフィールドを渡さない
    },
    {
        "type": "BUTTONS",          
        "buttons": [
            {
                "type": "OTP",
                "otp_type": "one_tap",
                "text": "auto1",      // 文字数制限25文字
                "autofill_text": "auto1",      // 文字数制限25文字
                "package_name": "ppssd",    
                "signature_hash": "asds"  
            }
        ]
    }
]
}

            

              
              {
"name": "copycodetmpl",
"language": "zh_CN",
"category": "AUTHENTICATION",
"components": [
{
"type": "BODY",
"text": "{{1}} はあなたの認証コードです。セキュリティ上の理由から、このコードを共有しないでください。",
"example": {
"body_text": [
["123456"]
]
}
},
{
"type": "FOOTER",
"text": "この認証コードは2分後に期限切れになります。"
},
{
"type": "BUTTONS",
"buttons": [{
"type": "URL",
"text": "copy1",
"url": "https://www.whatsapp.com/otp/code/?otp_type=ONE_TAP\u0026cta_display_name=auto1\u0026package_name=ppssd\u0026signature_hash=asds\u0026code=otp{{1}}",
"example": ["https://www.whatsapp.com/otp/code/?otp_type=ONE_TAP\u0026cta_display_name=auto1\u0026package_name=ppssd\u0026signature_hash=asds\u0026code=otp123456"]
}]
}
]
}

            

              
              {
"code": 5002,
"message": "無効なパラメータ。code:100:2388042"
}

            

              
              {
"components": [{						// テンプレート内容
"type": "BODY",					// コンテンツブロック、現在HEADER/BODY/FOOTER/BUTTONSをサポート
"text": "変数を{{1}}として定義" // 特定のテキスト、bodyがテキストの場合はformatフィールドを渡す必要なし
"example": {
"body_text": [["var1"]]
}
},{
"type": "HEADER",
"format": "image",				// コンテンツタイプ、text/image/video/document/locationをサポート
"example": {
"header_url": ["https://jiguang.cn/demopic.jpg"]
}
},{
"type": "FOOTER",
"text": "フッターは変数なしのテキストのみをサポート"
},{
"type": "BUTTONS",
"buttons": [{

"type": "PHONE_NUMBER",         	// ボタンタイプ、PHONE_NUMBER/URL/QUICK_REPLYをサポート

"text": "これは電話番号です",

"phone_number": "8613800138000"
}]
}]
}

            

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

            

              
              {
"code": 5002,
"message": "無効なパラメータ。code:100:2593002"
}

            

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

            

              
              {
"code": 2004,
"message": "何らかのエラーが発生しました"
}