修改模板
更新时间:2022-11-09
1.功能说明
1.1.该接口可以修改自定义模板内容,实现和自己业务系统无缝对接。
1.2.建议采用Post方法提交请求。
1.3.接口调用地址:http(s)://api.guoyangyun.com/api/template/update.htm
1.4.汉字字符集:UTF-8,请注意参数的大小写。
1.2.建议采用Post方法提交请求。
1.3.接口调用地址:http(s)://api.guoyangyun.com/api/template/update.htm
1.4.汉字字符集:UTF-8,请注意参数的大小写。
2.输入参数
参数 | 名称 | 类型 | 必须 | 描述 |
公共参数 | 公共参数 | — | 是 | 详见《公共参数和配置》文档 |
templateCode | 模板ID | String | 是 | 要修改的模板ID |
label | 分类标签 | String | 否 | 修改后的模板分类标签,方便模板归类管理 |
smsType | 模板类型 | String | 否 | 修改后的类型,对应值:VT(验证码模板),NT(通知类模板),MT(营销类模板) |
templateName | 模板名称 | String | 否 | 修改后的模板名称,方便自己管理,短信发送时不会发给客户 |
message | 模板内容 | String | 否 | 修改后的模板内容,模板中如有变量,格式:**英文变量名** |
sceneRemark | 场景说明 | String | 否 | 修改后的使用场景、事例等说明。验证码场景可提供登录链接 |
3.调用示例
http(s)://api.guoyangyun.com/api/template/update.htm?appkey=XXX&appsecret=XXX&templateCode=XXXX&label=&smsType=&templateName=&message=&sceneRemark=
特别提醒:需对url中的参数进行URLEncode编码,以免出现模板内容被截断等异常错误。
4.Json返回
4.1.返回参数
参数 | 名称 | 类型 | 描述 |
code | 返回码 | Int | 提交返回结果。0:表示成功,其他:失败。(状态码详见:《公共错误代码定义》) |
msg | 信息提示内容 | String | 返回成功/错误详细描述信息。 |
4.2.调用成功样例
{
"code": "0",
"msg": "成功"
}
4.3.调用失败样例
{
"code":"XXXX",
"msg":"错误提示内容"
}