三通运营平台CTCOSS接口手册.doc

大汉三通三通运营平台接口手册产品名称三通运营平台版本编号文档编号发布者上海大汉三通网络通信有限公司发布日期最后修改日期2011/11/9目 录目录1、 引言 61.1. 目的 61.2. 名称解释 62、 短信 62.1. API接口 62.2. WebService接口 122.2.1. 自定义数据结构 122.2.2. 短信下行（发送一条或者多条内容相同的短信） 122.2.3. 短信下行（发送内容不同的短信） 132.2.4. 获取上行 142.2.5. 获取状态报告 152.2.6. 获取余额 162.2.7. 短信webservice错误码 172.3. WebService接口（xml方式传输数据） 172.3.1. 短信下行 182.3.2. 短信上行 192.3.3. 短信状态报告 212.3.4. 查询余额 232.4. http接口（xml方式传输数据） 242.4.1. 短信下行 252.4.2. 短信上行 262.4.3. 短信状态报告 282.4.4. 查询余额 29保 密本文件及其内容为上海大汉三通网络通信有限公司保密资料本文件及其内容永远属于上海大汉三通网络通信有限公司拥有财产，在无上海大汉三通网络通信有限公司采用书面形式表示同意外，本文件a. 不可以用于其他非原指定用途；b. 不可以向第三方披露；c. 不可采用任何形式进行复制和传播，包括但不限于、纸张邮件和电子邮件。

文档修改历史版 本修改人日 期描 述1.0.0汤喜金2011/6/1创建文档短信部分接口周艳2011/7/7文档格式修改，符合公司内部文档规范要求汤喜金2011/11/14增加xml方式传输数据的WebService接口1、 引言1.1. 目的该接口手册编写目的在于描述三通运营平台CTC-OSS（以下简称CTC-OSS）具体的接口协议，供接口用户进行接口的对接开发1.2. 名称解释缩略语英文全名中文全名CTC-OSSOperational Support System三通运营平台SMSShort Messaging Service短消息服务MMSMultimedia Message Service多媒体消息APIApplication Programming Interface应用程序编程接口MOMessage Original消息上行MTMessage Terminal消息下行SPService Provider服务提供商CPContent Provider内容提供商2、 短信2.1. API接口相关jar包包括：ctc-smsclient.jar，ctc-message.jar，ctc-slidewindow.jar，ctc-sync.jar，ctc-util.jar。

注意：终端客户的接入方式设置为API接入时才能使用此接口名称initConn功能连接初始化接口方法public int initConn(String host, int port, String user, String password) 输入说明host：CTC-OSS的ip；port：CTC-OSS的端口；user：接口用户名；password：接口密码输出说明0——成功1——已经登陆2——用户名错误3——密码错误4——客户端ip错误（需要校验ip的时候需要）5—— 其他名称sendSms功能发送短信接口方法public boolean sendSms(String from, String to, String msg) 输入说明from：子号码，一般不填写；to：号码，支持多号码，以英文逗号隔开建议一次最多100个；msg：短信内容输出说明true：成功；false：失败名称onSubmitedSMS功能接收下行短信响应sendSms方法不直接返回下行响应，由此方法返回，此方法为回调方法，不需要手动调用接口方法public boolean onSubmitedSMS(ISubmitMsg arg0) 输入说明arg0：下行数据结构，具体支段见示例。

输出说明true：成功；false：失败名称onDeliverSMS功能接收上行短信此方法为回调方法，不需要手动调用接口方法public boolean onDeliverSMS(IDeliverMsg arg0) 输入说明arg0：上行数据结构，具体支段见示例输出说明true：成功；false：失败名称onMTReportSMS功能接收状态报告此方法为回调方法，不需要手动调用接口方法public boolean onMTReportSMS(IReportMsg arg0)输入说明arg0：状态报告数据结构，具体支段见示例输出说明true：成功；false：失败示例程序：import com.chinatricom.message.IDeliverMsg;import com.chinatricom.message.IReportMsg;import com.chinatricom.message.ISubmitMsg;import com.chinatricom.slidewindow.SMSCallback;import com.chinatricom.smsclient.ctcpp.CtcppChannel;import com.chinatricom.smsclient.message.DeliverMsg;import com.chinatricom.smsclient.message.ReportMsg;import com.chinatricom.smsclient.message.SubmitMsg;/** * title: 调用CTC-SMS API客户端接口 SMSUtil.java create on 2010-10-26 copyright (c) * 2010-10-26 * * @author * @version 1.0 */public class SMSUtil implements SMSCallback { public static CtcppChannel _chan = null; static { // 相关参数定义 SMSUtil _client = new SMSUtil(); String host = "127.0.0.1"; // 调用IP地址 int port = 28013; // 调用IP地址的端口 String user = "8888"; // 用户名 String passwd = "8888";// 密码 int wndSize = 16; int timeout = 60 * 1000; // 连接超时时间 int trys = 3; int speed = 0; // 记录日志 System.out.println("start"); // 开启通道 _chan = new CtcppChannel(host, port, user, passwd, 1, wndSize, timeout, trys, speed, _client, 0, 0, 1, 1); _chan.start(); } /** * 这个函数接收上行短信，短信的各个字段都放在DeliverMsg */ public boolean onDeliverSMS(IDeliverMsg arg0) { DeliverMsg msg = (DeliverMsg) arg0; if (msg != null) { System.out.println("收到deliverMsg:phone=" + msg.getFrom() + ",内容=" + msg.getMsg() + ",to=" + msg.getTo()); } return true; } /** * 这个函数接收下发短信的状态报告，它通过msgid关联到下行短信 result : 0———成功 1——等待发送 2——失败 */ public boolean onMTReportSMS(IReportMsg arg0) { ReportMsg msg = (ReportMsg) arg0; if (msg != null) { System.out.println("收到repot: result=" + msg.getResult() + ""); } return true; } /** * 这个函数接收下行短信的response，SubmitMsg里面有了result和msgId,这里的msg就是_chan.submit(_msg) * 里面的_msg。

result = 0 表示成功， 其他均为失败 */ public boolean onSubmitedSMS(ISubmitMsg arg0) { SubmitMsg msg = (SubmitMsg) arg0; if (msg != null) { System.out.println("收到submit response:result" + "=" + msg.getResult() + ", msgid=" + msg.getMsgId()); } return true; } /** * 下发方法入口 */ public static void sendSMS(String phoneNumber, String smsContext) { try { SubmitMsg _msg = new SubmitMsg(); _msg.setChanId(1); _msg.setFrom("1"); _msg.setTo(phoneNumber); _msg.setMsg(smsContext); _chan.submit(_msg); } catch (Exception e) { e.printStackTrace(); } finally { } } public static void main(String[] args) { SMSUtil.sendSMS(, "test"); }}2.2. WebService接口注意：终端客户的接入方式设置为WebService接入时才能使用此接口。