短信接口 HTTP 1.1
1.短信发送接口
1.0、接入信息
UserID | 企业ID |
Account | 用户账户 |
Password | 用户密码(MD5加密) |
1.1、请求URL,请求方式 http post
https://www.suisms.net/sms.aspx
1.2、参数说明
参数名称 | 含义 | 说明 |
---|---|---|
userid | 企业id | 企业ID |
account | 发送用户帐号 | 用户帐号 |
password | 发送帐号密码 | 用户账号对应的密码 |
mobile | 手机号码 | 发信发送的目的号码.多个号码之间用半角逗号隔开 |
content | 发送内容 | 短信的内容,内容需要UTF-8编码 |
sendTime | 定时发送时间 | 为空表示立即发送,定时发送格式2010-10-24 09:08:10 |
action | 发送任务命令 | 设置为固定的:send |
extno | 扩展子号 | 请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多10位数。 |
1.3、示列
https://www.suisms.net/sms.aspx?action=send&userid=12&account=账号&password=密码&mobile=13000000001,13900000002&content=内容&sendTime=&extno=
1.4、返回参数,返回以xml的方式返回处理结果
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<returnstatus>status</returnstatus> ---------- 返回状态值:成功返回Success 失败返回:Faild
<message>message</message> ---------- 返回信息:见下表
<remainpoint> remainpoint</remainpoint> ---------- 返回余额
<taskID>taskID</taskID> ----------- 返回本次任务的序列ID
<successCounts>successCounts</successCounts> --成功短信数:当成功后返回提交成功短信数
</returnsms>
2.状态报告接口
2.1、请求URL,请求方式 http post
https://www.suisms.net/statusApi.aspx
2.2、参数说明
参数名称 | 含义 | 说明 |
---|---|---|
userid | 企业id | 企业ID |
account | 用户帐号 | 用户帐号 |
password | 帐号密码 | 用户账号对应的密码 |
statusNum | 每次取得号码数 | 必须为数字,默认4000,可不填 |
action | 任务名称 | 设置为固定的:query |
2.3、示列
https://www.suisms.net/statusApi.aspx?action=query&userid=12&account=账号&password=密码
2.4、返回值
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<statusbox>
<mobile>15023239810</mobile>-------------对应的手机号码
<taskid>1212</taskid>-------------同一批任务ID
<status>10</status>---------状态报告----10:发送成功,20:发送失败
<receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间
<errorcode>DELIVRD</errorcode>-上级网关返回值,不同网关返回值不同,仅作为参考
<extno>01</extno>--子号,即自定义扩展号
</statusbox>
<statusbox>
<mobile>15023239811</mobile>
<taskid>1212</taskid>
<status>20</status>
<receivetime>2011-12-02 22:12:11</receivetime>
<errorcode>2</errorcode>
<extno></extno>
</statusbox>
</returnsms>
2.5、错误返回值——状态报告请求错误返回格式及对应值
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<errorstatus>
<error>1</error>-------------错误码(1:用户名或密码不能为空 2:用户名或密码错误 3:该用户不允许查看报告 4:参数不正确)
<remark>用户名或密码不能为空</remark>-------------错误描述
</errorstatus>
</returnsms>
3.短信上行接口
3.1、请求URL,请求方式 http post
https://www.suisms.net/callApi.aspx
3.2、参数说明
参数名称 | 含义 | 说明 |
---|---|---|
userid | 企业id | 企业ID |
account | 用户帐号 | 用户帐号 |
password | 帐号密码 | 用户账号对应的密码 |
ownExt | 使用自有扩展号 | 可不填或为空。当该值为1时,返回的extno将剔除系统强制附加的子号,为客户自己提交的子号,前提是上级通道支持时 |
action | 任务名称 | 设置为固定的:query |
3.3、示列
https://www.suisms.net/callApi.aspx?action=query&userid=12&account=账号&password=密码
3.4、返回值
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<callbox>
<mobile>15023239810</mobile>-------------对应的手机号码
<taskid>1212</taskid>-------------同一批任务ID
<content>你好,我不需要</content>---------上行内容
<receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间
<extno>01</extno>----子号,即自定义扩展号
</callbox>
<callbox>
<mobile>15023239811</mobile>
<taskid>1212</taskid>
<content>你好,本次活动路线是怎么的</content>
<receivetime>2011-12-02 22:12:11</receivetime>
<extno>01</extno>
</callbox>
</returnsms>
4.余额查询接口
4.1、请求URL,请求方式 http post
https://www.suisms.net/sms.aspx
4.2、参数说明
参数名称 | 含义 | 说明 |
---|---|---|
userid | 企业id | 企业ID |
account | 用户帐号 | 用户帐号 |
password | 帐号密码 | 用户账号对应的密码 |
action | 任务名称 | 设置为固定的:overage |
4.3、示列
https://www.suisms.net/sms.aspx?action=overage&userid=12&account=账号&password=密码
4.4、返回值
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<returnstatus>status</returnstatus>-------返回状态值:成功返回Sucess (注意:此处是Sucess,和其它接口返回的Success不同)失败返回:Faild
<message>message</message>--------------返回信息提示:见下表
<payinfo>payinfo</payinfo>--------------返回支付方式 后付费,预付费
<overage>overage</overage>-------------返回余额
<sendTotal>sendTotal</sendTotal>----返回总条数 当支付方式为预付费是返回总充值条数
</returnsms>