- 云片 API 文档
- 开发引导
- 使用场景
- 国内短信 API 列表
- 国际短信 API 列表
- 语音验证码
- 超级短信
- 账户信息
- 行为验证
- OTP
- 短链接工具
- 审核规则
- 文本短信
- 超级短信
- 返回码总体说明
- 云片 API 升级至 2.0 更强大 更安全
- 云片网络通信能力开放平台服务协议
- 其他
添加模版
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
请求参数
参数名 | 类型 | 是否必须 | 描述 | 示例 |
apikey | string | 是 | 用户唯一标识,在"账号设置"-"子帐号管理"中查看 | 9b11127a9701975c734b8aee81ee3526 |
tpl_content | string | 是 | 模板内容。当region参数传入global时,模板必须以带符号【】的签名开头 | 【云片网】您的验证码是#code# |
region | string | 是 | 国际模板可发地区。其中: abroad:除中国大陆外的国家及地区; global:全球。 (部分地区(美国、加拿大、台湾、马来西亚)通知类短信需要报备后发送,否则会发送失败,报备需要2-5个工作日) | abroad |
tpl_type | integer | 否 | 1 代表验证码类模板。当region为global且模板类型为验证码类模板时,此参数必传1; 0 代表通知类模板; (仅适用于系统子号,营销子号无需传此参数,默认都是营销类模板) | 1 |
website | string | 否 | 验证码类模板对应的注册页面网址 | |
lang (已过期,请使用region) | string | 是 | 国际短信模板所需参数,模板语言:简体中文 zh_cn;英文 en; 繁体中文 zh_tw; 韩文 ko,日文 ja; 其他语言 other (其他语言功能需联系在线客服开通) | zh_cn |
notify_type | integer | 否 | 审核结果短信通知的方式。其中: 0 表示需要通知,默认; 1 表示仅审核不通过时通知; 2 表示仅审核通过时通知; 3 表示不需要通知; | 1 |
callback | string | 否 | 审核结果会向这个地址推送,推送参数如下 |
|
apply_description | string | 否 | 说明模板的发送场景、对象、发送国家地区等 | 发送国家包含:美国、加拿大 |
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 | 审核未通过的原因 |
country_code | string | 支持地区 |
Json 返回值示例(国际短信模板):
{
"tpl_id": 3614732,
"tpl_content": "【Yunpian】your verification code is 1234",
"check_status": "CHECKING",
"reason": null,
"lang": null,
"country_code": "abroad"
}
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论