35SMS运营服务WebService 接口.docx

SMS API调用使用指南

（WebService）

上海傲融软件技术有限公司
2008年6月

一、 发送短信
函数名称: SendSmsToServer
XML参数结构:
XML结构
类型
缺省值
长度/
最大值
必填
备注
Login
XML

Y
用户帐号与密码
Login
UserID
String
“”
20
Y
用户帐号
Login
Password
String
“”
20
Y
用户密码
SendTaskList
XML

Y
包括多个SendTask
SendTaskList
TotalNum
int
0
1000
Y
短信个数.最大值1000.如果个数太多,请分开传输.
SendTaskList
SendTask
XML

Y
一个发送任务
SendTaskList
SendTask
ClientTaskID
int
0
Int最大值
Y
客户端TaskID,标志唯一一条短信记录.用于查询发送结果
SendTaskList
SendTask
SmsNumber
String
“”
20
Y
短信号码.
SmsOptions
XML

作业参数设置
SmsOptions Priority
int
1
2

优先级.1-低,2-高
SmsOptions
Content
String
“”
210

短信内容
Soap消息体:
<?xml version="1.0" encoding="gb2312"?>
<SmsInfo xmlns=""
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation=" sms_schema.xsd">
<Login>
<UserID>12345</UserID>
<Password>abcd123</Password>
</Login>
<SendTaskList>
<SendTask>
<ClientTaskID>1</ClientTaskID>
<SmsNumber>02168416178</ SmsNumber>
</SendTask>
……
<SendTask>
<ClientTaskID>1</ClientTaskID>
<SmsNumber>02168416178</ SmsNumber>
</SendTask>
</SendTaskList>
<SmsOptions>
<Priority>0</Priority>
<Content>0</Content>
</SmsOptions>
</SmsInfo>
表明调用函数SendSmsToServer返回结果
XML参数结构:
XML结构
类型
缺省值
长度/
最大值
必填
备注
Header
XML

Y
消息头
Header
ErrorFlag
int
0
20
Y
调用是否成功.0-成功.其它-失败,参考表A
Header
ReturnMessage
String
“”
20
Y
调用结果信息
JobNo
String
“”
20
Y
作业号
TotalNum
int
0
1000
Y
总短信个数
ValidNum
int
0
1000
Y
有效短信个数
Soap消息体:
<?xml version="1.0" encoding="gb2312"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<Header>
<ErrorFlag>int</ErrorFlag>
<ReturnMessage>string</ReturnMessage>
</Header>
<SendSmsToServerResponse>
<SendSmsToServerResult>
<JobNo>string</JobNo>
<TotalNum>int</TotalNum>
<ValidNum>int</ValidNum>
</SendSmsToServerResult>
</SendSmsToServerResponse>
</soap:Body>
</soap:Envelope>
二、 查询发送清单
函数名称:QueryResultForSmsTask
查询所有未获取的清单
注：如果查询条件都不填，即查询所有发送清单；如果有查询条件，条件是”与”的关系。
XML参数结构:
XML结构
类型
缺省值
长度/
最大值
必填
备注
Login
XML

Y
用户帐号与密码
Login
UserID
String
“”
20
Y
用户帐号
Login
Password
String
“”
20
Y
用户密码
Soap消息体:
<?xml version="1.0" encoding="gb2312"?>
<SmsInfo xmlns=""
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation=" sms_schema.xsd">
<QueryResultForSmsTask>
<Login>
<UserID>00000001</UserID>
<Password>111111</Password>
</Login>
</QueryResultForSmsTask>
</SmsInfo>
调用函数QueryResultForSendTask反馈信息如下:
注:服务端做流量控制,每次不能超过多少条,防止传输太慢,影响服务器性能。
建议客户如果SendSmsResultNum=1000,继续调用,直到SendSmsResultNum<1000,或者缩小查询范围。

XML参数结构:
XML结构
类型
缺省值
长度/
最大值
必填
备注
Header
XML

Y
消息头
Header
ErrorFlag
int
0
20
Y
调用是否成功.0-成功.其它-失败,参考表A
Header
ReturnMessage
String
“”
20
Y
调用结果信息
SendSmsResultNum
int
0
1000
Y
查询到的任务个数
SendSmsResultList
XML

查询到的任务列表
SendSmsResultList SendSmsResult
XML

查询到的任务
SendSmsResultList SendSmsResult
ClientTaskID
int
0
Int最大值
Y
客户端任务ID
SendSmsResultList SendSmsResult
result
int
0
100
Y
发送结果.0-成功,其它-不成功.参考表C
SendSmsResultList SendSmsResult
NumberOfSects
int
0
1000
Y
发送段数
SendSmsResultList SendSmsResult
BillingFee
double
0.00
10000
Y
发送费用.单位:元,保留两位小数.
Soap消息体:
<?xml version="1.0" encoding="gb2312"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<Header>
<ErrorFlag>int</ErrorFlag>
<ReturnMessage>string</ReturnMessage>
</Header>
<QueryResultForSendTaskResponse>
<QueryResultForSendTaskResult>
<SendSmsResultNum>10</SendSmsResultNum>
<SendSmsResultList>
<SendSmsResult>
<ClientTaskID>int</ClientTaskID>
<result>int</result>
<NumberOfSects>int</NumberOfSects>
<BillingFee> double </BillingFee>
</SendSmsResult>
… …
<SendSmsResult>
<ClientTaskID>int</ClientTaskID>
<result>int</result>
<NumberOfSects>int</NumberOfSects>
<BillingFee> String </BillingFee>
</SendSmsResult>
</SendSmsResultList>
</QueryResultForSendTaskResult>
</QueryResultForSendTaskResponse>
</soap:Body>
</soap:Envelope>
附录Appendix
表A—Header ErrorFlag
通信层返回的结果
值
说明
0
成功
-1
用户名，密码认证错误
-2
该帐号连接已存在
-3
参数输入有误
-9
IP地址错误
-10
Xml错误
-11
无合格号码
-12
参数有误
-14
新密码不能为空
-15
余额不足
-16
短信内容为空
-17
短信内容不合法
-18
短信段数计算错误
-99
未知错误
表C 任务状态
值
说明
0
发送成功
17
余额不足
32
无应答
64
禁止发送

用户指南
API接入注意事项
为了提高系统的响应速度，建议如下：
n 没有等发送任务，请不要与服务器连接
n 没有等待查询任务，请不要与服务器连接
n 由于短信需要一段时间发送，建议有必要时，您每隔一分钟以上与服务器连接

查询发送清单
1. 如果不输入 查询条件 返回 所有 短信记录没有被查询过的短信 已完成的任务.如果份数大于1000条,则继续查询.
2. 如果输入查询条件 返回符合该条件的 所有的包括已查询过的 已完成的任务,条件是与的关系.如果份数大于1000条,请缩小查询范围.