开发者中心

开发文档

搜索文档

API文档概述

1.调用流程

示远科技短信API是基于HTTP协议来调用的,以下主要是针对HTTP请求进行API调用的原理进行详细解说。

填充参数 > 生成签名 > 拼装HTTP请求 > 发起HTTP请求 > 得到HTTP响应 > 解释json/xml结果

调用入口

http://send.18sms.com/msg/HttpBatchSendSM

公共参数

参数类型 属性 类型 约束 说明 举例
请求 account String 必选 用户账号
pswd String 必选 用户密码
mobile String 合法的手机号码【国际短信特别说明:
1.请填写完整的手机信息:"国际区码+城市地区代号+手机号码" 填写国际手机号码的时候,手机号码前必须填写"00" 如:以德国手机举例:国际区码:49,地区区码:0179(没有城市区号的可忽略),手机号码:1234567 填写的正确格式为:00491791234567)
2.给大陆手机号发短信,请使用普通帐号走普通接口】
msg String 必选 短信内容,验证码和国际短信内容控制在70个字符内。使用URL方式编码为UTF-8格式。通知短信内容超过70个字符时,会被拆分成多条,然后以长短信的格式发送语音内容。您的验证码是:sy6666(验证码只支持纯数字和字母,或者数字+字母,内容最长支持6位)
needstatus String 必选 是否需要状态报告,取值true或false,true,表明需要状态报告;false不需要状态报告
product String 可选 用户订购的产品id,不填写(针对老用户)系统采用用户的默认产品,用户订购多个产品时必填,否则会发生计费错误。
extno String 可选 线上用户请登陆网站用户中心——>服务管理找到签名对应的extno并填写。线下用户请为空。

2.短信提交响应

用户短信通过http请求提交到服务器后,服务器返回响应码,响应码的格式如下:

resptime,respstatus
msgid

格式说明

短信提交响应分为两行,第一行为响应时间和状态,第二行为服务器给出提交msgid。无论发送的号码是多少,一个发送请求只返回一个msgid,如果响应的状态不是“0”,则没有msgid即第二行数据。(每行以换行符(0x0a,即\n)分割)
注:needstatus参数需要等于true才会返回msgid

提交成功

20110725160412,0
1234567890100

响应时间为20110725160412,响应状态为0,表明已成功提交到服务器,1234567890100为返回的msgid,这个供状态报告匹配时使用。

提交失败

20110725160412,
101

本示例表明用户提交失败,返回错误码为101,服务器端并未返回msgid

3.注意事项

用户发短信必须提前报备短信内容,如果发送未报备的内容会进入审核平台,则客户的短信必须经过管理人员的审核,审核通过后才能被提交到行业网关进行短信实际发送。
用户群发短信必须满足手机号码最低个数的限制,低于系统设定的群发最小手机号码数,则该提交请求会被拒绝,响应码为108。
语音验证码:
1.手机号(mobile参数)目前只支持大陆合法手机号码(注:目前不支持17、14、184号段)。
2.语音目前只支持验证码内容,播报内容:您的验证码是1234 播报三次。

4.调用示例

http://send.18sms.com/msg/HttpBatchSendSM
?account=test01&pswd=123456&mobile=18900000000&msg=您好,您的验证码:1234&needstatus=true&product=

注:product产品id默认为空

5.额度查询接口

接口地址

http://send.18sms.com/msg/QueryBalance

参数定义

序号 参数 说明
1 account 必填参数。用户账号
2 pswd 必填参数。用户密码

提交响应

20130303180000,0
1234567,1000
1234531,2000

第一行显示返回额度时的时间,提交响应值。
第二行开始,每一行显示一个产品ID及其额度,有多少个产品显示多少行。

提交响应值

代码 说明
0 成功
101 无此用户
102 密码错
103 查询过快(建议每10秒查询一次)

示例

http://send.18sms.com/msg/QueryBalance
?account=111111&pswd=123456