目录

短信验证码(模板短信)

注意:默认以67个汉字(同67个英文)为一条(可容纳字数受您应用名称占用字符影响),超过长度短信平台将会自动分割为多条发送。分割后的多条短信将按照具体占用条数计费。

? 模板示例如下,其中{数字}为需要接口替换的内容。

【UCPaaS】您注册{1}网站的验证码为{2},请于{3}分钟内正确输入验证码

1.1 请求

请求地址

/{SoftVersion}/Accounts/{accountSid}/Messages/templateSMS

请求包头

详情请查阅统一请求包头,并使用开发者账号进行验证。

请求包体

属性 类型 约束 说明
appId String 必选 应用Id
templateId String 必选 模板Id
to String 必选 短信接收端手机号码(国内短信不要加前缀,国际短信号码前须带相应的国家区号,如日本:0081)
param String 必选 内容数据,用于替换模板中{数字},若有多个替换内容,用英文逗号隔开即可

XML请求示例

POST/2014-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/Messages/templateSMS.xml?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>

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"
    }
}

1.2 响应

响应包体

属性 类型 约束 说明
respCode String 必选 请求状态码,取值000000(成功)
failure String 必选 表示短信验证码发送失败的条数。注:批量发送时,才会返回该字段
smsId String 必选 短信标识符。一个由32个字符组成的短信唯一标识符
createDate String 必选 短信的创建时间

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>

JSON响应示例

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