用户工具

短信:authentication_sms

接口鉴权

统一请求地址

https://open.ucpaas.com/ol/sms/{function}

注意:为降低遭受恶意攻击的风险,请遵循下述安全策略使用短信发送接口
1、为防止请求被拦截并伪造攻击,请勿将该接口直接用于前端开发。如需由前端发送短信,请对本接口进行二次封装并且强制要求二次验证(例如:图形验证码、滑块验证);
2、在功能上线前,进入开发者控制后台绑定服务器IP白名单,以禁止其法IP发送请求攻击;
3、使用https协议,减少信息被拦截和伪造的风险;

鉴权说明

身份鉴权常用参数

参数 描述 示例 位置
token用户密钥“Auth Token”23f757bad208226ec301e117e40006ed可在后台首页获取“Auth Token”
sid用户的账号唯一标识“Account Sid”da3f8e03476844bddb3fd45abb24f2d0可在后台首页获取“Account Sid”
appid创建应用时系统分配的唯一标示(appId)2d92c6132139467b989d087c84a365d8获取路径后台→应用管理→点击需要对接应用,查看appId
templateId可在后台短信产品→选择接入的应用→短信模板-模板ID,查看该模板ID1000001可在后台短信产品对应应用的“短信模板”中查看

Token 和 sid 和 appid

templateId

示例:指定模板单发

请求URL

https://open.ucpaas.com/ol/sms/sendsms				

请求方式
请求方式:POST,支持HTTPS

参数 类型 约束 描述 示例
sidString必填用户的账号唯一标识“Account Sid”,在开发者控制台获取(位置39467b989d087c2d92c6132184a365d8
tokenString必填用户密钥,在开发者控制台获取23f757bad208226ec301e117e40006ed
appidString必填创建应用时系统分配的唯一标示2d92c6132139467b989d087c84a365d8
templateidString必填创建短信模板时系统分配的唯一标示154501
paramString选填模板中的替换参数,如该模板不存在参数则无需传该参数或者参数为空,如果有多个参数则需要写在同一个字符串中,以英文逗号分隔 (如:“a,b,c”),参数中不能含有特殊符号“【】”和“,”87828,3
mobileString必填接收的单个手机号,暂仅支持国内号码18011984299,18011801180
uidString选填用户透传ID,随状态报告返回2d92c6132139467b989d087c84a365d8

JSON 请求示例

{
 "sid":"39467b989d087c2d92c6132184a365d8",
 "token":"23f757bad208226ec301e117e40006ed",
 "appid":"2d92c6132139467b989d087c84a365d8",
 "templateid":"154501",
 "param":"87828,3",
 "mobile":"18011984299"
}

JSON 响应示例

{
   "code":"0",
   "msg":"OK", 
   "count":"1",
   "create_date":"2017-08-28 19:08:28",
   "uid":"",
   "smsid":"f96f79240e372587e9284cd580d8f953",
   "mobile":"18011984299"
}					

相关资料


页面工具