短信API接口文档（适用于验证码/通知/营销）

在开发前，建议您先了解一下调用短信接口发送短信的操作流程：

 

1、注册账号：用户接入秒赛科技短信功能，首先需要用户在秒赛科技官网注册账号；立即注册>>
 

2、身份认证：注册后在用户中心，完成身份认证信息（支持企业认证&个人认证）；
 

3、创建签名和模板：

      在对应的产品栏目的【签名管理】-新增签名，审核通过后即可调用；
      在对应的产品栏目的【模板管理】-添加短信模板，审核通过即可调用；

（注：接口调用内容需与审核通过的签名、模板完全匹配才能发送，否则会报错，提示：自动审核驳回）
 

5、接口对接：开发调试过程请查看下方 API文档 和 代码示例（支持PHP、Java、c#等各种开发语言），接入后可使用系统赠送的100条短信条数进行测试；
 

6、套餐充值：测试条数有限，未避免影响正常使用，测试成功后请尽快充值。

.....................................................................................................................................................................

以下是接口文档正文：
 

 

一、普通短信发送
 

 

1.短信提交地址
 

验证码通知短信地址

http://139.196.108.241:8080/Api/HttpSendSMYzm.ashx

 

营销短信地址 

http://139.196.108.241:8080/Api/HttpSendSMYx.ashx

 

语音验证码地址

http://139.196.108.241:8080/Api/HttpSendSMVoice.ashx

 

2.参数定义

序号	参数	说明
1	account	必填参数。用户账号
2	ts	可选参数，时间戳，格式yyyyMMddHHmmss
3	pswd	必填参数。用户密码，ts参数为空时填明文密码，ts参数不为空时填md5(账号+密码+时间戳)，对账号密码时间戳拼接的字符串进行md5加密
4	mobile	必填参数。合法的手机号码，号码间用英文逗号分隔。最大50000个号码
5	msg	必填参数。短信内容，长度不能超过700个字符。使用URL方式编码为UTF-8格式。短信内容超过70个字符时，会被拆分成多条，然后以长短信的格式发送。
6	sms_sign	短信签名。默认不需要传，需要使用特定签名时可添加此参数

 

3.短信提交响应

用户短信通过http请求提交到服务器后，服务器返回响应

 

1）返回JSON格式说明

 

{

"result": 0,

"result_msg": "提交成功",

"msgid": "1670510103017877300",

"ts": "20180510103019"

}

result为响应状态（0表示成功，其他表示失败），result_msg 为提示消息，ts为响应时间,msgid 为消息id,状态匹配使用

2）响应状态值说明
 

代码	说明
-1	一般错误
0	提交成功
101	无此用户
102	密码错
103	提交过快（提交速度超过流速限制）
104	系统忙（因平台侧原因，暂时无法处理提交的短信）
105	敏感短信（短信内容包含敏感词）
106	消息长度错（>700或<=0）
107	包含错误的手机号码
108	手机号码个数错（>50000或<=0）
109	无发送额度（该用户可用短信条数为0）
110	不在发送时间内
111	超出该账户当月发送额度限制
112	无此产品，用户没有订购该产品
115	自动审核驳回
116	签名不合法，未带签名（用户必须带签名的前提下）
117	IP地址认证错,请求调用的IP地址不是系统登记的IP地址
118	用户没有相应的发送权限
119	用户已过期
120	内容不在白名单模板中

 

4.注意事项

用户群发短信如果有审核的限制，则客户的短信必须经过管理人员的审核，审核通过后才能被提交到行业网关进行短信实际发送。

 

5.短信发送例子

验证码发送:

http://139.196.108.241:8080/Api/HttpSendSMYzm.ashx?account=xx&pswd=xx&mobile=xx&msg=xx

 

营销短信发送:

http://139.196.108.241:8080/Api/HttpSendSMYx.ashx?account=xx&pswd=xx&mobile=xx&msg=xx

 

语音验证码发送:

http://139.196.108.241:8080/Api/HttpSendSMVoice.ashx?account=xx&pswd=xx&mobile=xx&msg=xx

二、状态报告推送
 

如果配置了账户的状态报告接收地址，则用户可以接收到其发送短信的状态报告。用户侧启动一个HTTP服务用于接收状态报告。

使用HTTP GET方式推送状态，每次一条。

 

1.参数定义

 

序号	参数	说明
1	receiver	接收状态报告验证的用户名（不是账户名），是按照用户要求配置的名称，可以为空
2	pswd	接收状态报告验证的密码，可以为空
3	msgid	提交短信时平台返回的msgid，参见1.2
4	reportTime	格式YYMMDDhhmmss，其中YY=年份的最后两位（00-99），MM=月份（01-12），DD=日（01-31），hh=小时（00-23），mm=分钟（00-59）ss=秒(00-59)
5	mobile	单一的手机号码
6	status	状态报告数值
7	status_msg	状态报告中文释义

2.示例

 

http://pushUrl?receiver=admin&pswd=12345&msgid=1234567890&reportTime=1012241002&mobile=13900210021&status=DELIVRD&status_msg=发送成功

 

其中，pushUrl为用户启动的服务地址。

三、短信接收
 

1、参数定义

序号	参数	说明
1	receiver	接收信息验证的用户账号
2	moTime	格式YYMMDDhhmmss，其中YY=年份的最后两位（00-99），MM=月份（01-12），DD=日（01-31），hh=小时（00-23），mm=分钟（00-59）ss=秒(0-59)
3	mobile	单一的手机号码
4	msg	MO短信内容，文字内容使用UTF-8编码
5	destcode	用户上行的目的号码
6	isems	是否为长短信的一部分，1:是，0，不是。 不带该参数，默认为普通短信
7	emshead	Isems为1时，本参数以ASCII码形式显示长短信的头信息。用“,”隔开，分为三个部分，第一部分标识该条长短信的ID（该ID为短信中心生成）；第二部分，表明该长短信的总条数（pk_total）；第三部分，该条短信为该长短信的第几条(pk_number)。 例如：234,4,1，该短信的ID为234,该长短信的总长度为4条，1，当前为第一条。

2.示例

普通短信：

http://pushMoUrl?receiver=admin&pswd=12345&moTime=1208212205&destcode=1065751600001&mobile=13800210021&msg=hello

 

长短信短信：

http://pushMoUrl?receiver=admin&pswd=12345&moTime=1208212205&destcode=1065751600001&mobile=13800210021&msg=hello&isems=1&emshead=255,5,5

 

其中，pushUrl为用户启动的服务地址。

四、额度查询接口
 

1.接口地址

http://139.196.108.241:8080/Api/ HttpQueryBalance.ashx

 

2.参数定义

 

序号	参数	说明
1	account	必填参数。用户账号
2	ts	可选参数，时间戳，格式yyyyMMddHHmmss
3	pswd	必填参数。用户密码，ts参数为空时填明文密码，ts参数不为空时填md5(账号+密码+时间戳)，对账号密码时间戳拼接的字符串进行md5加密

 

3.提交响应

 

1）JSON格式说明

{

"result": 0,

"ts": "20180510102315",

"products": [{

"product": "验证码/通知",

"num": 17907

}, {

"product": "营销",

"num": 5072

}, {

"product": "语音验证码",

"num": 25

}]

}

result为响应状态（0表示成功，其他表示失败）, ts为响应时间，products为产品列表（product为产品名称, num为产品剩余条数。

 

4.提交响应值

 

代码	说明
0	成功
101	无此用户
102	密码错
103	查询过快（30秒查询一次）

 

5.示例

http://139.196.108.241:8080/Api/HttpQueryBalance.ashx?account=XX&pswd=xx