WebService接口说明-NETCMS网站内容管理系统

1、webservice 接口说明一、 接口定义a) sendmessage 批量发送短信方法 (不支持同一userid的多线程调用)i. public sendstate sendmessage(string userid, string password, string msg, string destnumbers)ii. 参数说明：参数描 述userid用户id(平台识别的用户号码)， 49字节以内。password密码， 99字节以内msg短信内容， 159字节以内destnumbers目标号码，用分号(;)分隔，在一万条以内。iii. 返回值public class sendstate

2、 public int state;public string wrongnumbers;public string ydgroupid; / 发送到移动的短信的批次号public string ltgroupid; / 发送到联通的短信的批次号state 0: success 2: 失败需要重发 4: 内容不合法 5: 身份验证错误 6: 服务器错误 8: 短信数超过可用数12: 该用户不允许使用子用户id13: 错误的号码格式wrongnumbers 为错误的目标号码，用分号分隔，目前只是按移动和联通进行过滤。即不属于联通或移动的号码会被放入这里。ydgroupid， ltgroupid

3、发送的短信所属的批次号，用于以后查询短信的发送状态。b) sendmessagewithsub 发送短信时带有子号码 (不支持同一userid的多线程调用)i. public sendstate sendmessagewithsub(string userid, string subid, string password, string msg, string destnumbers)ii. 参数说明参数描 述userid用户id(平台识别的用户号码)，49字节以内。subid子用户号码 (14位 以内)， 14字节以内password密码， 90字节以内msg短信内容，159字节以内dest

4、numbers目标号码，用分号(;)分隔，一万条以内iii. 返回值同sendmesseagec) queryfailedmessage 查询失败短信i. public messagestateresponse queryfailedmessage(string userid, string password, int groupid)ii. 参数说明参数描 述userid用户id(平台识别的用户号码) ，49字节以内。password密码，99字节以内。groupid发送的短信所属的批次号iii. 返回值 public class messagestateresponse public in

5、t state; / 0 表示正常， 5表示身份验证错/ 10: 没有找到相应的groupidpublic string subuserid;public int totalcount; / 总数public string content; / 短信内容public messagestate msgstate; / 具体消息的状态， 这里仅包含失败短信的状态public class messagestate public string destnumber;/ 目标号码public int state; / -1 表示失败public string sendtime; / 发送时间d) que

6、rymessagestate 查询短信的发送状态i. public messagestateresponse querymessagestate(string userid, string password, int groupid)ii. 参数说明参数描 述userid用户id(平台识别的用户号码) ，49字节以内。password密码，99字节以内。groupid发送的短信所属的批次号iii. 返回值public class messagestateresponse public int state; / 0 表示正常， 5表示身份验证错 / 10: 没有找到相应的groupidpubli

7、c string subuserid;public int totalcount; / 总数public string content; / 短信内容public messagestate msgstate; / 具体消息的状态，这里包含失败和成功。public class messagestate public string destnumber;/ 目标号码public int state; / -1 表示失败 1表示成功的 (这里实际的成功需要根据计费方式判断，有实时性)public string sendtime; / 发送时间e) queryuserstate 查询用户短信余量i.

8、public userstate queryuserstate(string userid, string password)ii. 参数说明参数描 述userid用户id(平台识别的用户号码) ，49字节以内。password密码，99字节以内。iii. 返回值public class userstate public int state; /执行状态 0 为成功public int total; /用户短信发送总额public int dailytotal; / 当天发送总额public int remained; / 总的余额public int todayremained; / 今天的

9、余额二、 查询短信状态和发送短信的关系a) 发送短信后返回的批次号的意义i. 系统提供批量发送短信的能力，由于，确认短信的接收状态有一定的延迟性，所以先返回批次号，查询时使用该号码确认需要查询的短信所属的批次。ii. 由于有两个手机短信运营商，移动和联通，对短信的处理有所不同，因此在发送前，将对号码进行分类。相同运营商一次发送的短信所属的批次将是一样的。如果号码中包含两种类型，那么将得到两个批次号。b) 如何使用批次号查询i. 可以通过批次号一批短信（不管是联通还是移动），所以查询时直接发送批次号即可。ii. 查询状态的延迟性。确认手机接收情况有一定的延迟性，比如手机用户暂时关机。每次查询只能

10、得到当前已知的返回状态。 如果需要获取全部的失败短信状态，又需要尽可能快的重发失败短信，则需要多次查询。建议查询的时间安排为2,4,8,12,24,48iii. querymessagestate 和 queryfailedmessage 差别：1. querymessagestate同时返回当前已知的成功和失败的短信状态（以属性标示）2. queryfailedmessage只返回失败的短信状态（当前已知的）三、 通过web方式被动接收上行消息a) 使用被动方式接收上行消息时，需要提供一个可以处理消息的url。b) 被动方式的提交格式：i. 服务器端将向该url使用post方式提交数据，其包

11、含的字段为：1. userid 用户id2. passwd 接收端密码，可以用来屏蔽非法访问。该密码不是用户密码，需要跟管理员协商确定。接收端可以忽略该字段。但在防止黑客攻击时，比较有用。3. messages 上行的短信。使用urlencode方式encode过，处理前需要解码(decode)。每条短信内字段间以 “t” (制表符) 分隔， 每条短信以 “n” 结尾(换行符)短信中字段意义按顺序如下：字段描 述userid上行短信的目标用户id子用户id客户自定义子用户id。如果不是使用客户定义子用户发送的短信，该字段为空。来源手机号码短信来源的手机号码接收时间服务器端接收到短信的时间短信内容上行短信的内容。c) 接收方的返回值i. 接收方只需要在接收处理成功时返回字符串success即可（必须大写）。发送方将会把发送过的短信置为已读而不会重复发送。四、 url五、 常见问题或者错误a) 使用sendmessage和sendmessagewithsub时，目标号码应该用分号分隔。b) 使用sendmessagewithsub 时应该用代理商id 作为userid， 然后在subuserid里填充用户自己的子用户id。 不可以为30-49的代理商在系统中建立子用户。将会被过