35SMS运营服务WebService 接口

1、SMS API调用使用指南（WebService）上海傲融软件技术有限公司2008年6月一、 发送短信函数名称: SendSmsToServerXML参数结构:XML结构类型缺省值长度/最大值必填备注LoginXMLY用户帐号与密码LoginUserIDString“”20Y用户帐号LoginPasswordString“”20Y用户密码SendTaskListXMLY包括多个SendTaskSendTaskListTotalNumint01000Y短信个数.最大值1000.如果个数太多,请分开传输.SendTaskListSendTaskXMLY一个发送任务SendTaskListSendT

2、askClientTaskIDint0Int最大值Y客户端TaskID,标志唯一一条短信记录.用于查询发送结果SendTaskListSendTaskSmsNumberString“”20Y短信号码.SmsOptionsXML作业参数设置SmsOptions Priorityint12优先级.1-低,2-高SmsOptions ContentString“”210短信内容Soap消息体:<?xml version="1.0" encoding="gb2312"?><SmsInfo xmlns=""xmlns:xsi=

3、"/2001/XMLSchema-instance"xsi:schemaLocation=" sms_schema.xsd"><Login><UserID>12345</UserID><Password>abcd123</Password></Login><SendTaskList><SendTask><ClientTaskID>1</ClientTaskID><SmsNumber>02

4、168416178</ SmsNumber></SendTask> <SendTask><ClientTaskID>1</ClientTaskID><SmsNumber>02168416178</ SmsNumber></SendTask></SendTaskList><SmsOptions><Priority>0</Priority><Content>0</Content> </SmsOptions></Sm

5、sInfo>表明调用函数SendSmsToServer返回结果XML参数结构:XML结构类型缺省值长度/最大值必填备注HeaderXMLY消息头HeaderErrorFlagint020Y调用是否成功.0-成功.其它-失败,参考表AHeaderReturnMessageString“”20Y调用结果信息JobNoString“”20Y作业号TotalNumint01000Y总短信个数ValidNumint01000Y有效短信个数Soap消息体:<?xml version="1.0" encoding="gb2312"?><soap

6、:Envelope xmlns:xsi="/2001/XMLSchema-instance"xmlns:xsd="/2001/XMLSchema"xmlns:soap="/soap/envelope/"><soap:Body><Header><ErrorFlag>int</ErrorFlag><ReturnMessage>string</ReturnM

7、essage></Header><SendSmsToServerResponse><SendSmsToServerResult><JobNo>string</JobNo><TotalNum>int</TotalNum><ValidNum>int</ValidNum></SendSmsToServerResult></SendSmsToServerResponse></soap:Body></soap:Envelope>二、 查询发送清

8、单函数名称:QueryResultForSmsTask查询所有未获取的清单注：如果查询条件都不填，即查询所有发送清单；如果有查询条件，条件是”与”的关系。XML参数结构:XML结构类型缺省值长度/最大值必填备注LoginXMLY用户帐号与密码LoginUserIDString“”20Y用户帐号LoginPasswordString“”20Y用户密码Soap消息体:<?xml version="1.0" encoding="gb2312"?> <SmsInfo xmlns="" xmlns:xsi="http

9、://2001/XMLSchema-instance" xsi:schemaLocation=" sms_schema.xsd"> <QueryResultForSmsTask> <Login> <UserID>00000001</UserID> <Password>111111</Password> </Login> </QueryResultForSmsTask> </SmsInfo> 调用函数QueryResultForSen

10、dTask反馈信息如下:注:服务端做流量控制,每次不能超过多少条,防止传输太慢,影响服务器性能。 建议客户如果SendSmsResultNum=1000,继续调用,直到SendSmsResultNum<1000,或者缩小查询范围。XML参数结构:XML结构类型缺省值长度/最大值必填备注HeaderXMLY消息头HeaderErrorFlagint020Y调用是否成功.0-成功.其它-失败,参考表AHeaderReturnMessageString“”20Y调用结果信息SendSmsResultNumint01000Y查询到的任务个数SendSmsResultListXML查询到的任务列表

11、SendSmsResultList SendSmsResultXML查询到的任务SendSmsResultList SendSmsResultClientTaskIDint0Int最大值Y客户端任务IDSendSmsResultList SendSmsResultresultint0100Y发送结果.0-成功,其它-不成功.参考表CSendSmsResultList SendSmsResultNumberOfSectsint01000Y发送段数SendSmsResultList SendSmsResultBillingFeedouble0.0010000Y发送费用.单位:元,保留两位小数.So

12、ap消息体:<?xml version="1.0" encoding="gb2312"?><soap:Envelope xmlns:xsi="/2001/XMLSchema-instance"xmlns:xsd="/2001/XMLSchema"xmlns:soap="/soap/envelope/"><soap:Body><Header&g

13、t;<ErrorFlag>int</ErrorFlag><ReturnMessage>string</ReturnMessage></Header><QueryResultForSendTaskResponse><QueryResultForSendTaskResult><SendSmsResultNum>10</SendSmsResultNum><SendSmsResultList><SendSmsResult><ClientTaskID>int&l

14、t;/ClientTaskID><result>int</result><NumberOfSects>int</NumberOfSects><BillingFee> double </BillingFee></SendSmsResult> <SendSmsResult><ClientTaskID>int</ClientTaskID><result>int</result><NumberOfSects>int</NumberOfS

15、ects><BillingFee> String </BillingFee></SendSmsResult></SendSmsResultList></QueryResultForSendTaskResult></QueryResultForSendTaskResponse></soap:Body></soap:Envelope> 附录Appendix表AHeader ErrorFlag 通信层返回的结果值说明0成功-1用户名，密码认证错误-2该帐号连接已存在-3参数输入有误-9IP地址错误-10Xml错误 -11无合格号码-12参数有误-14新密码不能为空-15余额不足-16短信内容为空-17短信内容不合法-18短信段数计算错误-99未知错误表C 任务状态值说明0发送成功17余额不足32无应答6