文档_云片

修改模版

注意：模板成功修改之后需要重新审核才能使用！同时提醒您如果修改了变量，请重新务必测试，以免替换出错！

HTTP 头信息:

Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;

请求

URL：https://sms.yunpian.com/v2/tpl/update.json
注意：海外服务器地址 us.yunpian.com
访问方式：POST

请求参数

参数名	类型	是否必须	描述	示例
apikey	string	是	用户唯一标识，在账号设置-子帐号管理中查看	9b11127a9701975c734b8aee81ee3526
tpl_id	long	是	模板 id，64 位长整形	9527
tpl_content	string	是	模板内容。当region参数传入global时，模板必须以带符号【】的签名开头，变量需使用 `#变量名#` 包裹，例如：`#code#`	【云片网】您的验证码是#code#
region	string	是	国际模板可发地区。其中： abroad：除中国大陆外的国家及地区； global：全球。	abroad
tpl_variable	string	否当region为global且模版含变量时必传	当region为global且模板含有变量时，此参数必传。格式为：变量集合 JSON 字符串。详见下方变量结构说明。变量名：必须以英文字母开头，英文、数字、下划线_的组合，仅支持英文下划线_。	见下文
notify_type	integer	否	审核结果短信通知的方式。其中: 0 表示需要通知,默认; 1 表示仅审核不通过时通知; 2 表示仅审核通过时通知; 3 表示不需要通知；	1
website	string	否	验证码类模板对应的注册页面网址	https://https://www.yunpian.com/entry?method=register
tplType	integer	否	1 代表验证码类模板，验证码类模板必填； 0 代表通知类模板； (仅适用于系统子号，营销子号无需传此参数，默认都是营销类模板) 详见模板类型与参数规则表	1
callback	string	否	审核结果会向这个地址推送，推送参数如下	http://yourreceiveurl_address
apply_description	string	否	说明模板的发送场景、对象、发送国家地区等	发送国家包含：美国、加拿大

`tpl_variable` 参数说明（当模板中含变量时必填）

该参数是 JSON 字符串格式的数组，每项为一个变量的定义对象：

[
  {
    "variable": "code",
    "variableType": 8,
    "paramValueExample": "https://www.yunpian.com"
  }
]

子字段说明：

字段名	类型	是否必填	说明
variable	string	是	变量名称，必须以英文字母开头，英文、数字、下划线_的组合，仅支持英文下划线_。该名称应与模板内容中的变量保持一致，如 `#code#` 则对应 `code`。当模版中存在多个名称相同的变量，仅保留一个变量并通过类型区分用途。
variableType	integer	是	变量类型，详见下方变量类型表。用于说明变量的语义，便于模板审核。
paramValueExample	string	否	参数示例值，建议提供真实样例。当变量类型为“链接”或“其他”时必须提供。示例：`https://www.yunpian.com` 。

变量类型表

变量类型值	变量类型含义	参数示例值是否必填	参数示例说明
1	验证码	否
2	其他号码	否
3	用户昵称	否
4	个人姓名	否
5	地址	否
7	金额	否
8	链接	是	仅支持单个完整链接（仅支持HTTP/HTTPS URL或短链接），且长度不超过100个字符 https://www.yunpian.com dx5.cn/4g66a
9	时间	否
10	其他	是	实际的下发内容实例

模板类型与参数规则

模板类型	值	支持变量	说明
验证码	1	是	不支持链接类型变量
行业通知	0	是	不支持验证码类型变量
营销推广	无需传	是	不支持验证码类型变量

callback 推送参数举例

名称	类型	描述
tpl_id	string	模板 id
tpl_content	string	模板内容
check_status	string	//审核状态：CHECKING/SUCCESS/FAIL
reason	string	审核未通过的原因

响应

名称	类型	描述
tpl_id	string	模板 id
tpl_content	string	模板内容
check_status	string	//审核状态：CHECKING/SUCCESS/FAIL
reason	string	审核未通过的原因
lang（已过期，请参考country_code返回值为依据）	string	支持语言
country_code	string	支持地区

Json 响应示例：

{
  "tpl_id": 9527,
  "tpl_content": "【云片网】您的验证码是#code#",
  "check_status": "CHECKING",
  "reason": null,
  "lang": null,
  "country_code": "abroad"
}

修改模版

请求

请求参数

tpl_variable 参数说明（当模板中含变量时必填）

模板类型与参数规则

响应

Json 响应示例：

马上体验云片

`tpl_variable` 参数说明（当模板中含变量时必填）