用户工具

短信验证:rest_yz

短信验证接入指南

短信对接流程图

开发者账号

注册或者登录开发者账号流程说明请参考登录注册>>

创建应用及申请上线

创建应用及申请上线流程说明请参考创建应用及申请上线>>

资质认证

申请上线应用之前需完成资质认证,具体认证流程请参考账号认证>>

创建短信模板

1、创建短信模板—创建模板

点击【首页 > 短信产品管理】,在短信模板模块中点击“创建模板”按钮,

2、创建短信模板—内容填写

3、创建短信模板—模板说明

A、模板类型
验证码模板:仅支持1-4个参数,每个参数限制在10个字符内,验证码模板类型必须选择验证码模板: 
  e.g 您的验证码是{1},请于3分钟内输入。
通知模板:用于发送通知类短信。
  e.g 您有一个新的订单,订单编号为{1}。
营销短信模板:用于发送营销类短信。
  e.g 尊敬的{1},诚邀您参加本期五一优惠活动,退订请回复TD。
(需要先联系商务报备短信内容)
B、标题
最多20个字符,每个中文占3个字符
C、短信签名
会出现在下发短信的开头,建议添加应用名称或公司名称。要求3-8个中文或英文字母,运营商规定必填。
D、内容
参照下面短信模板审核标准进行填写。

审核说明 短信模板通过审核后才允许商用下发,关于模板审核的相关说明具体可参考短信模板审核>>

对接接口

注意: 为了确保数据隐私和安全, REST API须通过HTTPS方式请求 URL格式
https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/{function}/{operation}?sig={SigParameter}

URL参数属性说明

属性 说明
SoftVersion 云之讯REST API版本号,当前版本号为:2014-06-30
Account 此参数为默认固定值
accountSid 注册云之讯官网,在控制台中即可获取此参数
function 业务功能
operation 业务操作,业务功能的各类具体操作分支
SigParameter 请求URL必须带有此参数

HTTP标准包头字段(必填)

属性 说明
Accept 客户端响应接收数据格式:application/xml、application/json
Content-Type 类型:application/xml;charset=utf-8、application/json;charset=utf-8
Authorization 验证信息
Content-Length 包体长度

关键点

SigParameter是REST API 验证参数:
1、URL后必须带有sig参数,sig= MD5(账户Id + 账户授权令牌 + 时间戳),共32位(注:转成大写)
2、使用MD5加密(账户Id + 账户授权令牌 + 时间戳),共32位
3、时间戳是当前系统时间(24小时制),格式“yyyyMMddHHmmss”。时间戳有效时间为50分钟
Authorization是包头验证信息:
1、使用Base64编码(账户Id + 冒号 + 时间戳) 
2、冒号为英文冒号
3、时间戳是当前系统时间(24小时制),格式“yyyyMMddHHmmss”,需与SigParameter中时间戳相同

开发者信息说明

1.开发者账号ID--Account Sid
  a.开发者在UcPaaS平台的唯一标示,在SDK登录、REST请求中使用;
  b.开发者账号ID在网站注册后,系统自动生成,不可以更改
2.账户授权令牌--Auth Token
  a.相当于开发者账号ID(Account Sid)的密码,在SDK登录、REST请求中使用;
  b.系统自动生成;如果出现开发者Token泄露的情况,系统支持开发者Token重置。
  c.需要注册手机进行验证后方可查看

1 短信发送接口

1.appId:创建应用时系统分配的唯一标示,在“应用列表”中可以查询
2.templateId:创建短信模板时系统分配的唯一标示,在“短信管理”中可以查询
3. to:需要下发短信的手机号码,支持国际号码,需要加国家码。
4.param:模板中的替换参数,如果有多个参数则需要写在同一个字符串中,以逗号分隔. (如:param=“a,b,c”)

应用未上线只可以用【应用测试】绑定的号码测试。(点击“【应用测试】进行号码绑定”)


JSON 请求示例

JSON 请求示例

POST/2014-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/Messages/templateSMS? sig=769190B9A223549407D2164CAE92152E
Host:api.ucpaas.com
Accept:application/json
Content-Type:application/json;charset=utf-8
Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxODUwMjE=
{
 "templateSMS" : {
    "appId"       : "e462aba25bc6498fa5ada7eefe1401b7",
    "param"       : "0000",
    "templateId"  : "1",
    "to"          : "18612345678"
    }
}


JSON 响应示例

JSON 响应示例

{
 "resp"        : {
    "respCode"    : "000000",
    "failure"     : 1,
    "templateSMS" : {
        "createDate"  : 20140623185016,
        "smsId"       : "f96f79240e372587e9284cd580d8f953"
        }
    }
}


XML 请求示例

XML 请求示例

POST/2014-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/Messages/templateSMS? sig=7A685B0216D1CA6839C00C2BB18A109D 
Host:api.ucpaas.com 
Accept:application/xml 
Content-Type:application/xml;
charset=utf-8 Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxODQ4NDI=   
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<templateSMS> 
<appId>e462aba25bc6498fa5ada7eefe1401b7</appId> 
<templateId>1</templateId> 
<to>18612345678</to> 
<param>0000</param> 
</templateSMS> 


XML 响应示例

XML 响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<resp> 
<respCode>000000</respCode> 
<failure>000000</failure> 
<templateSMS> 
<createDate>20140623184836</createDate> <smsId>c04162a0c6da8b241b70f8176f3a93fa</smsId> </templateSMS> 
</resp> 

2 短信状态报告推送接口

短信验证码状态报告推送接口,平台将验证码通过手机短信的形式发送到用户手机上,并将短信验证码发送状态推送到开发者服务器上(需在开发者后台自助配置接收状态报告服务器的URL地址)。
• 推送包体

属性 类型 约束 说明
type String 必选 1:状态报告,2:上行
smsid String 必选 回状态报告给客户时填充smsId
status String 必选 0:成功;1:提交失败,4:失败,5:关键字(keys),6:黑/白名单,7:超频(overrate),8:unknown
reportTime String 必选 状态报告返回时间
desc String 必选

• XML推送示例

POST /coolweb/voiceCode HTTP/1.1 
Host: 172.16.10.32:8080 
Content-Type:text/xml;charset=utf-8 
Accept:application/xml 
Content-Length: 461
 
<?xml version="1.0"?> 
<request>     
    <type>1</type>    
    <smsid>******</smsid>
    <status>******</status>
    <reportTime>******</reportTime>
    <desc>******</desc>
</request> 

• 响应包体

属性 类型 约束 说明
retcode int 必选 返回错误码,0:成功,非0:失败

• XML响应示例

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <retcode>0</retcode>
</response> 
最后更改: 2016/12/28 16:07

页面工具