http:// 服务器地址:端口/service/webService/Web_Service?wsdl
- 接口参数:
- 服务器地址:IP
- 端口:PORT
- 用户账号:
- 用户密码:
- 通信认证密码:
第一章 余额
1.1 请求地址
String getAmount(String xmlParams)
xmlParams:字符串类型,以xml格式的请求参数,详细请求格式看以下具体参数说明。
1.2参数说明
testss 123456 453245
参数名称 | 含义 | 说明 |
username | 用户账号 | 用户账号 |
password | 用户密码 | 用户密码 |
veryCode | 通信认证密码 |
1.3返回值
在接收请求后,返回以xml的方式返回处理结果。格式为:
返回值说明:0 -------返回状态值:成功返回0 失败返回:失败代码------当status为0时,会出现该属性
名称 | 说明 |
status | 返回状态值,具体参照状态码说明 |
account | 余额,条数= acount * 10 |
返回码 | 描 述 |
0 | 查询成功 |
100 | 查询余额失败 |
101 | 用户账号不存在或密码错误 |
102 | 账号已禁用 |
103 | 参数不正确 |
105 | 认证码错误 |
117 | 未开通此接入方式 |
数字account | 短信余额 |
第二章 发送接口
2.1 请求地址
String sendMsg(String xmlParams)
xmlParams:字符串类型,以xml格式的请求参数,详细请求格式看以下具体参数说明。
2.2参数说明
JSM00001 123456 453245 1595****097 @1@=你好 8888 2 1 JSM00001-0001
参数名称
|
含义
|
说明
|
username
|
用户账号(必填)
|
用户账号
|
password
|
用户密码(必填)
|
用户密码
|
veryCode
|
通信认证密码(必填) | 通信认证密码。 |
mobile | 手机号码(必填) | 手机号码(群发短信时,最多100个,英文逗号,隔开) |
content | 短信内容(必填) | 短信内容(最多300个汉字),特殊字符需要转义;如果使用模板短信发送,此参数用来传递模板短信的变量和值,参数之间以逗号隔开 |
extcode | 扩展码 | 用户自己分配的小号(即显示在接收手机上的主叫尾号,可用于上行信息匹配)例:我们给合作方开的特服号是106905994140010,然后合作方在发送信息的时候可以随意填写扩展号ext=8888(最大支持4位),那么用户收到信息时显示的下发号码就是1069059941400108888 |
sendtime | 定时时间 | 定时短信的定时时间,格式为: (yyyyMMddhhmmss),例如:20140504111010 代表2014年5月4日 11时10分10秒,短信会在指定的时间发送出去 sendTime值为空时,为即时发送短信 sendTime值不为空时,为定时发送短信 |
msgtype |
短信类型(必填) |
短信类型。1-普通短信,2-模板短信。 |
signtag |
短信签名序号 |
短信签名序号,如果帐号报备多个签名,此参数指定使用第几个签名(由于运营商要求,帐号只允许单一签名,此参数可以省略) |
signtext |
自定义签名 |
自定义签名,帐号支持自定义签名该参数才生效 |
tempid |
模板短信编号 |
模板编号,(msgtype=2时参数必填) |
code | 编码格式 | 编码方式(utf-8,gbk),默认:gbk |
1) IP:如果用户开账户时指定IP,则接口只接收该IP发送请求。
2) 发送模版短信msgtype=2,tempid必须填写模版编号
2.3 返回值
返回值说明
名称 | 说明 |
status | 返回状态值,具体参照状态码说明 |
msgid | 消息id,和状态报告内msgid匹配的 |
返回码 | 描 述 |
0 | 提交成功 |
100 | 发送失败 |
101 | 用户账号不存在或密码错误 |
102 | 账号已禁用 |
103 | 参数不正确 |
105 | 短信内容超过300字或为空、或内容编码格式不正确 |
106 | 手机号码超过100个或有错误号码 |
108 | 余额不足 |
109 | ip错误 |
110#(敏感词A,敏感词B) | 短信内容存在系统保留关键词,如有多个词,使用逗号分隔:110#(李老师,XX,成人) |
114 | 模板短信序号不存在 |
115 | 短信签名标签序号不存在 |
116 | 认证码不正确 |
117 | 未开通此接入方式 |
第三章 状态报告接口
3.1 请求地址
String queryReport(String xmlParams)
xmlParams:字符串类型,以xml格式的请求参数,详细请求格式看以下具体参数说明。
建议访问频率:3分钟一次
3.2参数说明
JSM00001 123456 453245
参数名称 | 含义 | 说明 |
username | 用户账号(必填) | 用户账号 |
password | 用户密码(必填) | 用户密码 |
veryCode | 通信认证密码(必填) |
3.3返回值
返回值说明:1595****097 7506751276725633025 MA:0006 1595****097 7506751276725633026 MA:0006 1595****097 7507418680283693057 DELIVRD
名称 | 说明 |
mobile | 返回状态值,具体参照状态码说明 |
msgid | 消息id,与发送接口消息id对应 |
status | 返回状态码,具体参照状态码说明 |
time | 状态报告的时间 |
extno | 扩展码 |
返回码 | 描 述 |
DELIVRD | 发送成功,返回其他请参照失败状态码 |
3.4错误返回值
返回值说明:
名称 | 说明 |
status | 返回状态码,具体参照状态码说明 |
返回码 | 描 述 |
100 | 获取状态报告失败 |
101 | 用户账号不存在或密码错误 |
102 | 账号已禁用 |
103 | 参数不正确 |
104 | 暂无短信状态报告 |
105 | 认证码错误 |
117 | 未开通此接入方式 |
第四章 上行接口
4.1 请求地址
String queryMo(String xmlParams)
xmlParams:字符串类型,以xml格式的请求参数,详细请求格式看以下具体参数说明。
建议访问频率:3分钟一次
4.2 参数说明
JSM00001 123456 453245
参数名称 | 含义 | 说明 |
username | 用户账号(必填) | 用户账号 |
password | 用户密码(必填) | 用户密码 |
veryCode | 通信认证密码(必填) |
4.3返回值
返回值说明:1595****097 106905994140001 江苏美圣信息技术有限公司 1595****097 106905994140001 4006000699
名称 | 说明 |
mobile | 对应的手机号码 |
recvcode | 接受号码 |
content | 回复内容 |
time | 接收时间 |
4.4错误返回值
返回值说明:
名称 | 说明 |
status | 返回状态码,请参照状态码说明 |
返回码 | 描 述 |
100 | 获取上行短信失败 |
101 | 用户账号不存在或密码错误 |
102 | 账号已禁用 |
103 | 参数不正确 |
104 | 暂无上行短信 |
105 | 认证码错误 |
117 | 未开通此接入方式 |