添加模版


HTTP 头信息:


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


请求


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


请求参数


特别说明:
验证码类模板必填参数websitetplTypeapply_description

参数名

类型

是否必须

描述

示例

apikey

string

用户唯一标识,在账号设置-子帐号管理中查看

9b11127a9701975c734b8aee81ee3526

tpl_content

string

模板内容,必须以带符号【】的签名开头

【云片网】您的验证码是#code#

notify_type

integer

审核结果短信通知的方式。其中:
0 表示需要通知,默认;
1 表示仅审核不通过时通知;
2 表示仅审核通过时通知;
3 表示不需要通知;

1

website

string

验证码类模板对应的官网注册页面,验证码类模板必填

https://www.yunpian.com/entry?method=register

tpl_type

integer

1 代表验证码类模板,验证码类模板必填;

0 代表通知类模板;

(仅适用于系统子号,营销子号无需传此参数,默认都是营销类模板)

1

callback

string

审核结果会向这个地址推送

http://your_receive_url_address

apply_description

string

说明模板的发送场景和对象,验证码类模板必填

用于向云片注册用户发送验证码短信


callback 推送参数举例,您需要 post 方式接收数据,推送的数据格式为表单

名称

类型

描述

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

审核未通过的原因


Json 返回值示例(国内短信模板):


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