短信API接口文档

作者:牛头 日期:2017-08-01 热度:67
开发者主账号ID(ACCOUNT SID)。由32个英文字母和阿拉伯数字组成的开发者账号唯一标识符。短信内容。(smsContent与templateid必须填写一项)(短信签名+短信内容。如【鸿思特科技】您的验证码是345678,30分钟输入有效。)
请求地址:
https://sms.hongsite.com/index.php?s=Smssend
请求方式:
POST
编码格式:
UTF-8
响应格式:
JSON,XML
请求包头:
Content-type:application/x-www-form-urlencoded

请求参数说明

参数名称 类型 约束 说明
accountSid String 必选 开发者主账号ID(ACCOUNT SID)。由32个英文字母和阿拉伯数字组成的开发者账号唯一标识符。
smsContent String 可选 短信内容。(smsContent与templateid必须填写一项)(短信签名+短信内容。如【鸿思特科技】您的验证码是345678,30分钟输入有效。)
templateid String 可选 短信模板ID (smsContent与templateid必须填写一项)(具体登录官网后,在模板管理查看:模板Id)
param String 可选 短信变量,多个变量用英文逗号隔开(如:模板的格式为:您的订单{1}已经处理完成,货物即将发出,请于近{2}日内查收。只有templateid有内容时该参数才可填写)
to String 必选

短信接收端手机号码集合。用英文逗号分开,每批发送的手机号数量不得超过100个。

portNumber String 可选 平台分配给开发者的端口号,暂不支持。
timestamp String 必选 时间戳。当前系统时间(24小时制),格式"yyyyMMddHHmmss"。时间戳有效时间为5分钟。
sig String 必选 签名。MD5(ACCOUNT SID + AUTH TOKEN + timestamp)。共32位(小写)。

注意:MD5中的内容不包含”+”号。

respDataType String 可选 响应数据类型,JSON 或 XML 格式。默认为JSON。

请求实例

url:

    https://sms.hongsite.com/index.php?s=Smssend
    
post数据:
 
    accountSid=a14f6bfd43ce44c9b019de57f4e2de4b&smsContent=【鸿思特科技】您的验证码是345678,30分钟输入有效。
    &to=13896543210×tamp=20150821100312&sig=a14f6bfd43ue44c9b019du57f4e2ee4r&

返回参数说明

参数名称 类型 约束 说明
respCode String 必选 请求状态码,取值00000(成功: 此步响应只表明客户的短信请求发送成功,不表明短信通道已经发送短信成功。) 具体可参照《附:返回状态码列表》
respDesc String 可选 对返回状态码的描述 如:00000 代表成功
failCount String 必选 表示验证码通知短信发送失败的条数。
failList String 可选 失败列表,包含失败号码、失败原因。
smsId String 必选 短信标识符。一个由32个字符组成的短信唯一标识符。

返回示例

JSON返回包体

{
"respCode":"00000",
"respDesc":"成功",
"failCount":"1",
"failList":
[
    {
        "phone":"13896543210",
        "respCode":"00111",
        "respDesc":"匹配到黑名单",
    }
],
"smsId":"913945fec0204b1e94baa75a5c013f59"
}