顺天万通短信服务接口手册.doc

顺天万通运营平台STWT-OSS接口手册顺天万通短信服务接口手册产品名称顺天万通运营平台版本编号215文档编号2.0.0发布者北京顺天万通科技有限公司发布日期2011.11.5最后修改日期2012/2/6目 录1、引言51.1.目的51.2.名称解释52、短信52.1.WebService接口（xml方式传输数据）52.1.1.短信下行52.1.2.短信上行72.1.3.短信状态报告92.1.4.查询余额10保密本文件及其内容为北京顺天万通科技有限公司保密资料。本文件及其内容永远属于北京顺天万通科技有限公司拥有财产，在无北京顺天万通科技有限公司采用书面形式表示同意外，本文件a. 不可以用于其他非原指定用途；b. 不可以向第三方披露；c. 不可采用任何形式进行复制和传播，包括但不限于传真、纸张邮件和电子邮件。文档修改历史版 本修改人日 期描 述1.0.0赵宝泽2011/6/1创建文档。短信部分接口。1.5.0赵宝泽2011/7/7文档格式修改，符合公司内部文档规范要求。2.0.0赵宝泽2012/2/6增加xml方式传输数据的WebService接口1、 引言1.1. 目的该接口手册编写目的在于描述顺天万通短信服务接口协议，供接口用户进行接口的对接开发。1.2. 名称解释缩略语英文全名中文全名STWT-OSSOperational Support System顺天万通通运营平台SMSShort Messaging Service短消息服务MMSMultimedia Message Service多媒体消息APIApplication Programming Interface应用程序编程接口MOMessage Original消息接口MTMessage Terminal消息发送SPService Provider服务提供商CPContent Provider内容提供商2、 短信2.1. WebService接口（xml方式传输数据）注意：终端客户的接入方式设置为WebService接入时才能使用此接口。该接口数据输入输出均采用xml格式封装的字符串，编码统一为UTF-8。访问地址：/soap/smsService2.1.1. 短信下行名称SendSMS功能发送一条或则多条内容相同的短信接口方法String SendSMS (String message)输入说明message参数xml格式如下：adminbb43a2c4081bec02fca7b72f38e630212c92825934837c4d0134837dcba001501311111111113333333333短信内容5555201101011230字段说明：account ：用户账号password：账号密码，需采用MD5加密(小写)，如：456.com加密后为bb43a2c4081bec02fca7b72f38e63021msgid：该批短信编号(32位UUID)，需保证唯一，可空，建议为空phones：接收手机号码，多个手机号码用英文逗号分隔，最多500，不能为空content：短信内容，最多500个汉字，不能为空subcode：扩展子号码，可空（验证格式和长度，不能超过20位）sendtime：发送时间,格式yyyyMMddHHmm,可空(12位数字，年月日时分，比如201111180929)输出说明返回的结果xml格式如下：2c92825934837c4d0134837dcba001500 提交成功字段说明：msgid：该批短信编号result：该批短信提交结果0提交成功1账号无效2密码错误3msgid不唯一4存在无效手机号码5手机号码个数超过最大限制6短信内容超过最大限制7扩展子号码无效8发送时间格式无效9请求来源地址无效10内容包含敏感词11余额不足97接入方式错误98系统繁忙99消息格式错误2.1.2. 短信上行名称ReceiveSMS功能获取上行短信。每次调用间隔需大于30秒接口方法String Receive(String message)输入说明message 参数xml格式如下：adminbb43a2c4081bec02fca7b72f38e63021字段说明：account ：用户账号password：账号密码，需采用MD5加密(小写)，如：456.com加密后为bb43a2c4081bec02fca7b72f38e63021输出说明返回的结果xml格式如下：0 成信内容 55552011-11-11 11:11:11字段说明：result：接口调用结果0成功1账号无效2密码错误3请求太快9请求来源地址无效97接入方式错误98系统繁忙99消息格式错误如果result为0时sms标签对将出现0到多次，否则sms标签不出现。phone：上行手机号码content：上行短信内容delivertime：上行接收时间，格式yyyy-MM-dd HH:mm:ss2.1.3. 短信状态报告名称report功能获取下行短信状态报告，每次调用间隔需大于30秒。接口方法String report(String message)输入说明message参数xml格式如下：adminbb43a2c4081bec02fca7b72f38e630212c92825934837c4d0134837dcba0015013622223333字段说明：account ：用户账号password：账号密码，需采用MD5加密(小写)，如：456.com加密后为bb43a2c4081bec02fca7b72f38e63021msgid：下行短信编号，可空phone：接收下行手机号码，可空输出说明返回的结果xml格式如下：0 成功2c92825934837c4d0134837dcba00150136222233330 成功字段说明：result：接口调用结果0成功1账号无效2密码错误3请求太快4手机号码无效9请求来源地址无效97接入方式错误98系统繁忙99消息格式错误当result为0时report标签对将出现0到多次，否则report标签不出现msgid：短信编号phone：下行手机号码content：上行短信内容status：短信发送结果0成功1失败2发送中2.1.4. 查询余额名称balance功能获取余额，每次调用间隔需大于60秒。接口方法String balance(String message)输入说明message参数xml格式如下：adminbb43a2c4081bec02fca7b72f38e63021字段说明：account ：用户账号password：账号密码，需采用MD5加密，如：456.com加密后为bb43a2c4081bec02fca7b72f38e63021输出说明返回的结果xml格式如下：0成功100.0005000.000200.0005000.000字段说明：result：接口调用结果0成功1账号无效2密码错误3请求太快9请求来源地址无效97接入方式错误98系统繁忙99消息格式错误当result为0时sms标签对出现1次，否则sms标签对不出现。amount：剩余金额，保留3位小数，单位元number：剩余短信数freeze：冻结金额，保留3位小数，单位元当result为0时mms标签对出现1次，否则m