テンプレート管理 API

              
              Authorization: Basic ${base64_auth_string}

            

              
              GET https://wa.api.engagelab.cc/v1/templates?tag_id=101

            

              
              GET https://wa.api.engagelab.cc/v1/templates?tag_id=ungrouped

            

              
              // JSON 配列。配列内の各オブジェクトが 1 件のテンプレート情報です
[
    {
        "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 分以内に入力してください。" // 二重波かっこ {{}} で囲まれた部分がテンプレート変数
            }
        ],
        "tags": [ // このテンプレートに設定されているタグ。未設定の場合は空の配列
            {
                "id": "101",
                "name": "配送通知"
            }
        ]
    },
    ......
]

            

              
              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 分以内に入力してください。" // 二重波かっこ {{}} で囲まれた部分がテンプレート変数
        }
    ],
    "tags": [ // このテンプレートに設定されているタグ。未設定の場合は空の配列
        {
            "id": "101",
            "name": "配送通知"
        }
    ]
}

            

              
              POST '/v1/media/handles' 
--header 'Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0' 
--form 'file=@"/Users/demo/files/demopic.jpeg"'

            

              
              {
    "handle_id": "4::aW1hZ2UvanBlZw==:ARb2JGd8LbvJbfmpMASFAlczcn4hxLC6tkwjasjD4WL6_i34tIisq0IdWNFFFj1KwJMRXPU4xwygHSJd4DHu1f19LcBBl2qeb8EuEcgnIUPYIQ:e:1682169041:4985146461608173:100084026087657:ARazr9kxfzKshJE4WpY"
}

            

              
              {
    "code": 3002,
    "message": "whatsapp.template field must be set correctly when type is template"
}

            

              
              {
    "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": "copy it"      // 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": "Copy code",
              "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&cta_display_name=auto1&package_name=ppssd&signature_hash=asds&code=otp{{1}}",
                "example": ["https://www.whatsapp.com/otp/code/?otp_type=ONE_TAP&cta_display_name=auto1&package_name=ppssd&signature_hash=asds&code=otp123456"]
            }]
        }
    ]
}

            

              
              {
    "template_id": "1275172986566180"		// テンプレート ID
}

            

              
              {
    "code": 5002,
    "message": "Invalid parameter. code:100:2388042"
}

            

              
              {
    "components": [{                        // テンプレートの内容
        "type": "BODY",                     // コンテンツブロック
        "text": "define var as {{1}}", 
        "example": {
            "body_text": [["var1"]]
        }
    },{
        "type": "HEADER",
        "format": "image",                  // コンテンツタイプ：image/video/document
        "example": {
            // 注意：ここにはアップロードエンドポイントが返した handle_id を指定する必要があります。画像 URL の直接指定には対応しなくなりました
            "header_handle": ["4::aW1hZ2UvanBlZw==:ARb2JGd8LbvJbfmpMASFAlcz..."]
        }
    },{
        "type": "FOOTER",
        "text": "footer only support text without variable"
    },{
        "type": "BUTTONS",
        "buttons": [{                                     
            "type": "PHONE_NUMBER",              
            "text": "this is a phone number",              
            "phone_number": "8613800138000"
        }]
    }]
}

            

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

            

              
              {
    "code": 5002,
    "message": "Invalid parameter. code:100:2593002"
}

            

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


            

              
              {
    "code": 2004,
    "message": "something error"
}

            

              
              GET https://wa.api.engagelab.cc/v1/template-tags

            

              
              [
    {
        "id": "101",
        "name": "配送通知",
        "template_count": 3
    },
    {
        "id": "102",
        "name": "アフターサポート",
        "template_count": 0
    }
]

            

              
              {
    "name": "配送通知"
}

            

              
              {
    "id": "101",
    "name": "配送通知"
}

            

              
              {
    "code": 3003,
    "message": "template tag name already exists"
}

            

              
              {
    "name": "アフターサポート"
}

            

              
              {
    "id": "101",
    "name": "アフターサポート"
}

            

              
              {
    "code": 4001,
    "message": "template tag not found"
}

            

              
              DELETE https://wa.api.engagelab.cc/v1/template-tags/101

            

              
              {
    "affected_template_count": 3
}

            

              
              {
    "code": 4001,
    "message": "template tag not found"
}

            

              
              {
    "tag_ids": ["101", "102"]
}

            

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

            

              
              {
    "code": 4001,
    "message": "template not found"
}

            

              
              {
    "code": 4001,
    "message": "template tag not found"
}

            

              
              {
    "code": 3002,
    "message": "template tag IDs must be provided as an array"
}