添加模板

更新时间：2022-11-09

1.功能说明

1.1.该接口可以添加自定义模板，实现和自己业务系统无缝对接。
1.2.建议采用Post方法提交请求。
1.3.接口调用地址：http(s)://api.guoyangyun.com/api/template/add.htm
1.4.汉字字符集：UTF-8，请注意参数的大小写。

2.输入参数

参数	名称	类型	必须	描述
公共参数	公共参数	—	是	详见《公共参数和配置》文档
username	子账户名	String	否	如果为子账户添加模板，可指定子账户名
label	分类标签	String	否	模板分类标签，方便模板归类管理，非必选。
smsType	模板类型	String	是	对应值：VT（验证码模板），NT（通知类模板），MT（营销类模板）
templateName	模板名称	String	是	模板名称，方便自己管理，短信发送时不会发给客户。
message	模板内容	String	是	模板内容，模板中如有变量，格式：英文变量名
sceneRemark	场景说明	String	是	模板使用场景、事例等说明。验证码场景可提供登录链接。填写详细可提升通过率

3.调用示例

http(s)://api.guoyangyun.com/api/template/add.htm?appkey=XXXXX&appsecret=XXXXX&username=&label=&smsType=VT&templateName=登录注册验证码&message=验证码：******code******，如非本人操作，请忽略本短信！&sceneRemark=网站注册登录验证使用

特别提醒：需对url中的参数进行URLEncode编码，以免出现模板内容被截断等异常错误。

4.Json返回

4.1.返回参数

参数	名称	类型	描述
code	返回码	Int	提交返回结果。0：表示成功，其他：失败。（状态码详见：《公共错误代码定义》）
msg	信息提示内容	String	返回成功/错误详细描述信息。
data	模板信息	List	返回模板详细信息
created	创建时间	String	模板的创建时间
modified	修改时间	String	模板最近一次修改时间
primaryName	主账户名	String	主账户的登录名称
username	账户名称	String	账户登录名称
status	模板状态	String	WAIT_AUDIT：等待审核；ENABLE：正常；AUDIT_REJECT：审核拒绝；DISABLE：禁用
label	模板标签	String	模板所属分类标签
smsType	模板类型	String	VT：验证码；NT：通知；MT：营销
templateName	模板名称	String	模板名称
message	模板内容	String	模板的完整内容
templateCode	模板ID	String	模板代码
sceneRemark	使用场景	String	模板的使用场景描述

4.2.调用成功样例

{
    "code": "0", 
    "msg": "成功", 
    "data": {
        "created": "2022-05-12 16:45:34",        //模板创建时间
        "modified": "2022-05-12 16:45:34",       //模板修改时间
        "primaryName": "a123456",                //主账户名
        "username": "a123456",                   //账户名
        "status": "WAIT_AUDIT",                  //模板状态
        "label": "",                             //模板分类标签名
        "smsType": "VT",                         //模板类型：VT，NT，MT
        "templateName": "登录注册验证码",           //模板名称
        "message": "验证码：**code**，5分钟有效",   //模板内容
        "templateCode": "57dbf34aaa13abf9f0",    //模板code
        "sceneRemark": "场景说明"                 //使用场景说明
    }
}

4.3.调用失败样例

{
    "code":"XXXX",
    "msg":"错误提示内容"
}

results matching ""

No results matching ""