模板Template

创建模板

请求接口地址

POST    https://api.innopaas.com/api/whatsapp/v3/template/submit

请求参数

字段	数据类型	是否必填	描述
wabaId	String	是	WhatsApp商业账户唯一标识
name	String	是	模板名称：(eg:limited_time_offer_tuscan_getaway_2023)由小写字母、数字、下划线组合,字段限制为512个字符.
category	String	是	模板类型：1-MARKETING,2-AUTHENTICATION,3-UTILITY
messageLanguage	String	是	模板支持的语言，(需要传语言缩写编码)请参考附录1
headerType	Integer	是	是否支持多媒体,默认1,1:None,2:Text,3:Image,4:Video,5:Document
caption	String	否	页眉内容:字段限制为字符(多媒体模板时，该字段为空),动参格式{{1}}
messageBody	String	否	正文内容:字段限制为1024个字符.动参格式{{1}}{{2}},前后按序插入
footer	String	否	页脚内容:字段限制为60字符(AUTHENTICATION模板时,该字段表示过期时间,非必填,过期时间限制90分钟内)
safetyAdvice	Integer	否	AUTHENTICATION模板是否添加安全建议(0:不添加 1:添加)选填,未添加显示：*{{1}}* 是你的验证码。添加后显示：*{{1}}* 是你的验证码。为安全起见，请不要分享这组验证码。
buttons	Object[]	否	按钮总数不超过10个
├─actionType	String		按钮类型 1-quick reply,2-visit website,3-call phone number,4-copy code(category为2时),5-auto fill (category为2时)
├─label	String		按钮文本
├─ phoneArea	String		号码区号(eg:86)
├─ phone	String		号码(eg:18877776666)
├─packageName	String		应用包名,模板类型为AUTHENTICATION,选填
├─sigNatureHash	String		应用哈希散列,模板类型为AUTHENTICATION,选填
├─ autoFill	String		自动填充,模板类型为AUTHENTICATION,选填
├─ targetUrl	String		网址访问(eg："https://www.chuanglan.com/{{1}}") 只支持一个动参，格式{{1}}
├─buttonExample	Array		按钮变量示例(eg："buttonExample": ["https://www.chuanglan.com/whatsApp"])网址访问含有变量时必填,变量内容为完整网址
headerExample	Objec	否
├─ header_handle	Array		多媒体模板变量(eg："header_handle": ["4::axxxx"])多媒体模板时，填写文件上传返回时句柄内容
├─ header_text	Array		纯文本模板变量(eg："header_text": ["创蓝云智"])文本动参模板变量,动参个数限制1
bodyExample	Object	否
├─ body_text	Array		body变量(eg: "body_text":[["variable1","variable2"]]) 变量示例与变量按序对应，变量{{1}}对应variable1，以此类推

请求示例

{
    "name": "transland_marketing_promotion_6",
    "category": "1",
    "messageLanguage": "zh_CN",
    "headerType":2,
    "caption": "Transland API Account {{1}} Opened",
    "messageBody": "Dear customer {{1}}，your SMS API account {{2}} is avaliable, please rember the secret of this account. The secret is sent via email.",
    "footer": "Have a nice sms experience.",
    "buttonType":2,
    "headerExample": {
        "header_text": [
            "II2024089"
        ]
    },
    "bodyExample": {
        "body_text": [
            [
                "Tom",
                "II2024089"
            ]
        ]
    },
    "wabaId": "121009624329108",
    "buttons": [
        {
            "actionType": 1,
            "label": "Call Us",
            "phone": "[phone]"
        },
        {
            "actionType": 2,
            "label": "Websit",
            "targetUrl": "https://www.chuanglan.com/{{1}}",
            "buttonExample": [
                "https://www.chuanglan.com/document"
            ]
        }
    ]
}

响应示例

{
    "code": "0",
    "message": "Success",
    "data": "1399631517488334"
}

修改模板

请求接口地址

POST     https://api.innopaas.com/api/whatsapp/v3/template/update

请求参数

字段	数据类型	是否必填	描述
templateId	String	是	模板id
wabaId	String	是	WhatsApp商业账户唯一标识
name	String	是	模板名称：(eg:limited_time_offer_tuscan_getaway_2023)由小写字母、数字、下划线组合,字段限制为512个字符.
category	String	是	模板类型：1-MARKETING,2-AUTHENTICATION,3-UTILITY
messageLanguage	String	是	模板支持的语言:(需要传语言缩写简码)请参考附录1
headerType	Integer	是	是否支持多媒体,默认1,1:None,2:Text,3:Image,4:Video,5:Document
caption	String	否	页眉内容:字段限制为字符(多媒体模板时，该字段为空),动参格式{{1}}
messageBody	String	否	正文内容:字段限制为1024个字符.动参格式{{1}}{{2}},前后按序插入
footer	String	否	页脚内容:字段限制为60字符(AUTHENTICATION模板时,该字段表示过期时间,非必填,过期时间限制90分钟内)
safetyAdvice	Integer	否	AUTHENTICATION模板是否添加安全建议(0:不添加 1:添加)选填,未添加显示：*{{1}}* 是你的验证码。添加后显示：*{{1}}* 是你的验证码。为安全起见，请不要分享这组验证码。
buttons	Object[]	否	按钮总数不超过10个
├─actionType	String		按钮类型 1-quick reply,2-visit website,3-call phone number,4-copy code(category为2时),5-auto fill (category为2时)
├─label	String		按钮文本
├─ phoneArea	String		号码区号(eg:86)
├─ phone	String		号码(eg:18877776666)
├─packageName	String		应用包名,模板类型为AUTHENTICATION,选填
├─sigNatureHash	String		应用哈希散列,模板类型为AUTHENTICATION,选填
├─ autoFill	String		自动填充,模板类型为AUTHENTICATION,选填
├─ targetUrl	String		网址访问(eg："https://www.chuanglan.com/{{1}}") 只支持一个动参，格式{{1}}
├─buttonExample	Array		按钮变量示例(eg："buttonExample": ["https://www.chuanglan.com/whatsApp"])网址访问含有变量时必填,变量内容为完整网址
headerExample	Object[]	否
├─ header_handle	Array		多媒体模板变量(eg："header_handle": ["4::axxxx"])多媒体模板时，填写文件上传返回时句柄内容
├─ header_text	Array		纯文本模板变量(eg："header_text": ["创蓝云智"])文本动参模板变量,动参个数限制1
bodyExample	Object[]	否
├─ body_text	Array		body变量(eg: "body_text":[["variable1","variable2"]]) 变量示例与变量按序对应，变量{{1}}对应variable1，以此类推

请求示例

{   "templateId":"123123123123213",
    "name": "transland_marketing_promotion_6",
    "category": "1",
    "messageLanguage": "zh_CN",
    "headerType":2,
    "caption": "Transland API Account {{1}} Opened",
    "messageBody": "Dear customer {{1}}，your SMS API account {{2}} is avaliable, please rember the secret of this account. The secret is sent via email.",
    "footer": "Have a nice sms experience.",
    "buttonType":2,
    "headerExample": {
        "header_text": [
            "II2024089"
        ]
    },
    "bodyExample": {
        "body_text": [
            [
                "Tom",
                "II2024089"
            ]
        ]
    },
    "wabaId": "121009624329108",
    "buttons": [
        {
            "actionType": 1,
            "label": "Call Us",
            "phone": "[phone]"
        },
        {
            "actionType": 2,
            "label": "Websit",
            "targetUrl": "https://www.chuanglan.com/{{1}}",
            "buttonExample": [
                "https://www.chuanglan.com/document"
            ]
        }
    ]
}

响应示例

{
    "code": "0",
    "message": "Success",
    "data": "1399631517488334"
}

模版列表

请求接口地址

POST    https://api.innopaas.com/api/whatsapp/v3/template/list

请求参数

字段	数据类型	是否必填	描述
page	Integer	是	页码
size	Integer	是	每页返回条数
wabaId	String	是	WhatsApp商业账户唯一标识
name	String	否	模板名称
templateId	String	否	模板id
category	list	否	模板类型 1-MARKETING,2-AUTHENTICATION,3-UTILITY
messageLanguage	list	否	模板语言(eg:en)
auditStatus	list	否	模板状态 1:待定(Pending), 2: 通过（Approved） 3: 拒绝（Rejected） 4: 暂停（Paused） 5: 禁用（Disabled）

请求示例代码

{
    "page":1,
    "size":100
    "name": "transland_marketing_promotion_01"
    "wabaId": "100853739759190"
}

响应示例

{
    "code": "0",
    "message": "成功",
    "data": {
        "total": 1,
        "pages": 1,
        "list": [
            {
                "updateDate": "2023-10-16 19:09:45",
                "bodyExample": {
                    "body_text": [
                        [
                            "Tom",
                            "II2024089"
                        ]
                    ]
                },
                "buttons": [
                    {
                        "actionType": 3,
                        "phone": "15121041046",
                        "phoneArea": "86",
                        "label": "Call Us"
                    },
                    {
                        "actionType": 2,
                        "buttonExample": [
                            "\"https://www.chuanglan.com/document\""
                        ],
                        "label": "Websit",
                        "targetUrl": "https://www.chuanglan.com/{{1}}"
                    }
                ],
                "messageBody": "Dear customer {{1}}，your SMS API account {{2}} is avaliable, please rember the secret of this account. The secret is sent via email.",
                "footer": "Have a nice sms experience.",
                "messageLanguage": "zh_CN",
                "caption": "Transland API Account {{1}} Opened",
                "updateUser": "",
                "source": 1,
                "delFlag": 0,
                "templateId": "FCFD7669C142497684F090203F88AE98",
                "customerName": "CXQ测试20230426",
                "sid": "634562468792622",
                "headerExample": {
                    "header_text": [
                        "II2024089"
                    ]
                },
                "wabaId": "wabaId",
                "name": "transland_marketing_promotion_01",
                "auditStatus": 2,
                "headerType": 2,
                "createUser": "",
                "id": 194,
                "category": 1,
                "createDate": "2023-10-16 19:09:45",
                "safetyAdvice": 0
            }
        ]
    }
}