区电子政务公共短信平台api文档（通用模板）
以下为《区电子政务公共短信平台api文档（通用模板）》的无排版文字预览，完整格式请下载
下载前请仔细阅读文字预览以及下方图片预览。图片预览是什么样的，下载的文档就是什么样的。
禅城区电子政务短信平台
接
口
说
明
文
档
*_**
2019.12
目 录
第一部分 接口说明 1
1.1 Soap协议接口 1
1.1.1 服务定义地址 1
1.1.2 短信发送（1） 1
1.1.3 短信发送（2） 2
1.1.4 短信定时发送 2
1.1.5 接收短信回执 3
1.1.6 接收回复短信 4
1.1.7 查询当前余额 5
1.2 Http/Https协议接口 6
1.2.1 短信发送（1） 6
1.2.2 短信发送（2） 7
1.2.3 短信定时发送 8
1.2.4 接收短信回执 8
1.2.5 接收回复短信 10
1.2.6 查询当前余额 11
短信平台登陆首页：
http://172.16.150.15
接口说明
双方都通过SOAP/HTTP请求、答复进行数据交换以至业务的完成。
Soap协议接口
服务定义地址
http:// 172.16.150.15/services/susunws?wsdl
短信发送（1）
submitSms(loginid,password,numbers,contents)
参数名
中文说明
数据类型
说明
loginid
登陆id
字符
用户名。
password
登陆密码
字符
密码。
receiver
手机号码
字符
为手机号码数组。单发数组长度为1，群发短信最大可以发送1000条。
content
发送内容
字符
短信内容。
返回值
返回一个实体，属性如下：
code:返回操作结果，0代表成某某，-1代表失败。
text:返回每个短信主题的smsid。查询短信回执和短信回复时的唯一标识。
短信发送（2）
submitSmsTo(loginid,password,receiver,content)
参数名
中文说明
数据类型
说明
loginid
登陆id
字符
用户名。
password
登陆密码
字符
密码。
receiver
手机号码
字符
用分号分隔的手机号码字符串。
content
发送内容
字符
短信内容。
返回值
返回一个实体，属性如下：
code:返回操作结果，0代表成某某，-1代表失败。
text:返回每个短信主题的smsid。查询短信回执和短信回复时的唯一标识。
短信定时发送
submitSmsToTime(loginid,password,receiver,content,datetime)
参数名
中文说明
数据类型
说明
loginid
登陆id
字符
用户名。
password
登陆密码
字符
密码。
receiver
手机号码
字符
用分号分隔的手机号码字符串。
content
发送内容
字符
短信内容。
sendtime
定时发送时间
日期
数据类型根据开发语言或框架生成的实际类型为准。例如：使用java，cxf生成为XMLGregorianCalendar类型。
返回值
返回一个实体，属性如下：
code:返回操作结果，0代表成某某，-1代表失败。
text:返回每个短信主题的smsid。查询短信回执和短信回复时的唯一标识。
接收短信回执
fetchReport（login,password,smsid）
参数名
中文说明
数据类型
说明
loginid
登陆id
字符
用户名。
password
登陆密码
字符
密码。
smsid
发送内容
字符
32位短信id
返回值
返回一个实体，属性如下：
code:0代表成某某，-1代表失败。
text:结果描述。
data数组：
code:回执代码，第一位为回执结果，0成某某，-1失败。
desc:返回结果描述。
mobile:手机号码。
time:回执时间。
注：因为发送短信后，运营商短信网关不会立刻返回回执，所以发短信后，立刻收取回执是收取不到回执的。要收取回执，需要在发送短信后隔一定时间收取。
接收回复短信
fetchReply（login,password,smsid）
参数名
中文说明
数据类型
说明
loginid
登陆id
字符
用户名。
password
登陆密码
字符
密码。
smsid
发送内容
字符
短信主题ID。
返回值
返回一个实体，属性如下：
code:0代表成某某，-1代表失败。
text:结果描述。
data数组：
mobile:手机号码。
content:回复内容。
time:回复时间。
查询当前余额
fetchBalance(loginid,passsword)
参数名
中文说明
数据类型
说明
loginid
登陆id
字符
用户名。
password
登陆密码
字符
密码。
返回值
返回一个实体，属性如下：
code:0代表成某某，-1代表结束。
text:结果描述。
data数组:
operators:“CMCC”代表移动，“CUCC”代表联通，“CT”代表电信。
total:配额。
used:已使用数量。
balance:余额。
Http/Https协议接口
服务定义地址：
http://172.16.150.15/services/susunrs?wadl
注：2019.10.1起暂限定为政务网内使用。
短信发送（1）
地址：
http://172.16.150.15/services/susunrs/submit
提交方式：post
参数名
中文说明
数据类型
说明
loginid
登陆id
字符
用户名。
password
登陆密码
字符
密码。
receiver
手机号码
字符
为手机号码数组。单发数组长度为1，群发短信最大可以发送1000条。
content
发送内容
字符
短信内容。
返回值
返回值:JSON格式字符串。
说明：
code:返回操作结果，0代表成某某，-1代表失败。
text:返回短信主题的smsid。
例子：
返回提交成某某的短信主题id。
{"result":{"code":0,"text":"9o*********202020"}}
短信发送（2）
地址：
http://172.16.150.15/services/susunrs/submitto
提交方式：post
参数名
中文说明
数据类型
说明
loginid
登陆id
字符
用户名。
password
登陆密码
字符
密码。
receiver
手机号码
字符
分号分隔的电话号码字符串。
content
发送内容
字符
短信内容。
返回值
返回值:JSON格式字符串。
说明：
code:返回操作结果，0代表成某某，-1代表失败。
text:返回短信主题的smsid。
例子：
返回提交成某某的短信主题id。
{"result":{"code":0,"text":"9o*********202020"}}
短信定时发送
地址：
http://172.16.150.15/services/susunrs/submittotime
提交方式：post
参数名
中文说明
数据类型
说明
loginid
登陆id
字符
用户名。
password
登陆密码
字符
密码。
receiver
手机号码
字符
分号分隔的电话号码字符串。
content
发送内容
字符
短信内容。
sendtime
发送时间
字符
格式：yyyy-MM-dd HH:mm:ss
返回值
返回值:JSON格式字符串。
说明：
code:返回操作结果，0代表成某某，-1代表失败。
text:返回短信主题的smsid。
例子：
返回提交成某某的短信主题id。
{"result":{"code":0,"text":"9o*********202020"}}
接收短信回执
地址：
http://172.16.150.15/services/susunrs/report
提交方式：post
参数名
中文说明
数据类型
说明
loginid
登陆id
字符
用户名。
password
登陆密码
字符
密码。
smsid
发送内容
字符
短信主题id。
返回值
返回值:JSON格式字符串。
说明：
code:0代表成某某，-1代表失败。
text:结果描述。
data数组：
code:回执代码，短信发送成某某返回0，否则返回错误代码。
desc:返回结果描述。
mobile:手机号码。
time:回执时间。
例子：
返回两条短信回执。
{"result":{"code":0,"text":"共收到2条短信回执！","data":[{"code":8008,"desc":"","mobile":"***","time":"2012-06-07 17:40:00"},{"code":0,"desc":"","mobile":"***","time":"2012-06-18 11:10:00"}]}}
注：因为发送短信后，运营商短信网关不会立刻返回回执，所以发短信后，立刻收取回执是收取不到回执的。要收取回执，需要在发送短信后隔一定时间收取。
接收回复短信
地址：
http://172.16.150.15/services/susunrs/reply
提交方式：post
参数名
中文说明
数据类型
说明
loginid
登陆id
字符
用户名。
password
登陆密码
字符
密码。
smsid
发送内容
字符
短信主题ID。
返回值
返回值：JSON格式字符串。
说明：
code:0代表成某某，-1代表失败。
text:结果描述。
data数组：
mobile:手机号码。
content:回复内容。
time:回复时间。
例子：
返回两条短信回复。
{"result":{"code":0,"text":"共收到2条短信回复！","data":[{"mobile":"***","content":"短信回复内容...","time":"2012-06-07 17:40:00"},{"mobile":"***","content":"短信回复内容2","time":"2012-06-18 11:10:00"}]}}
查询当前余额
地址：
http://172.16.150.15/services/susunrs/balance
提交方式：post
参数名
中文说明
数据类型
说明
loginid
登陆id
字符
用户名。
password
登陆密码
字符
密码。
返回值
返回值：JSON格式字符串。
说明：
code:0代表成某某，-1代表结束。
text:结果描述。
data数组:
operators:“CMCC”代表移动，“CUCC”代表联通，“CT”代表电信。
total:配额。
used:已使用数量。
balance:余额。
例子：
返回查询余额结果。
{"result":{"code":0,"text":"查询当前余额成某某","data":[{"operators":"CMCC","total":"51000","used":"46600","balance":"4400"},{"operators":"CUCC","total":"21000","used":"13600","balance":"7400"},{"operators":"CT","total":"51000","used":"46600","balance":"4400"}]}}
以上为《区电子政务公共短信平台api文档（通用模板）》的无排版文字预览，完整格式请下载
下载前请仔细阅读上面文字预览以及下方图片预览。图片预览是什么样的，下载的文档就是什么样的。
图片预览
