无限通平台接口手册
产品名称 版本编号 文档编号 发布者 发布日期 无限通运营平台 1.4.6.81313 2.1.1 无限通 最后修改日期 2012/11/13
无限通平台接口手册
目 录
1、 引言................................................................................................................................................. 4
1.1. 目的 ................................................................................................................................. 4 1.2. 名称解释 ......................................................................................................................... 4 1.3. 平台信息 ......................................................................................................................... 4 2、 短信................................................................................................................................................. 4
2.1. API接口 ......................................................................................................................... 4 2.2. http接口(xml方式传输)(推荐) ................................................................................ 6
2.2.1. 短信下行 ................................................................................................................. 6 2.2.2. 短信上行 ................................................................................................................. 8 2.2.3. 短信状态报告 ......................................................................................................... 9 2.2.4. 查询余额 ................................................................................................................11 2.3. http接口(兼容企信通) ............................................................................................ 12
2.3.1. 短信下行 ............................................................................................................... 12 2.3.2. 短信上行 ............................................................................................................... 14 2.3.3. 短信状态报告 ....................................................................................................... 15 2.3.4. 查询余额 ............................................................................................................... 16 2.4. WebService接口(xml方式传输)(推荐) ................................................................. 17
2.4.1. 短信下行 ............................................................................................................... 17 2.4.2. 短信上行 ............................................................................................................... 19 2.4.3. 短信状态报告 ....................................................................................................... 21 2.4.4. 查询余额 ............................................................................................................... 22 2.5. WebService接口(发送多条内容不同的短信) ....................................................... 24
2.5.1. 自定义数据结构 ................................................................................................... 24 2.5.2. 短信下行(发送一条或者多条内容相同的短信) ........................................... 24 2.5.3. 短信下行(发送内容不同的短信) ................................................................... 25 2.5.4. 获取上行 ............................................................................................................... 26 2.5.5. 获取状态报告 ....................................................................................................... 27 2.5.6. 获取余额 ............................................................................................................... 28 2.5.7. 短信webservice错误码 ....................................................................................... 29 2.6. WebService接口(兼容企信通)(建议不用) ............................................................ 29
2.6.1. 自定义数据结构 ................................................................................................... 29 2.6.2. 短信下行(发送多条内容相同的短信) ........................................................... 31 2.6.3. 短信下行(发送多条内容不同的短信) ........................................................... 32 2.6.4. 获取上行 ............................................................................................................... 32 2.6.5. 获取状态报告(单条) ....................................................................................... 32 2.6.6. 获取状态报告(多条) ....................................................................................... 33 2.6.7. 获取余额 ............................................................................................................... 33
3、 附录............................................................................................................................................... 34
3.1. Api接口示例 ................................................................................................................ 34 3.2. Http接口示例 ............................................................................................................... 37 3.3. Webservice接口示例(xml传输方式) .................................................................... 40
第 2 页 共 45 页
无限通平台接口手册
保 密
本文件及其内容为上海大汉三通网络通信有限公司保密资料。本文件及其内容永远属于上海大汉三通网络通信有限公司拥有财产,在无上海大汉三通网络通信有限公司采用书面形式表示同意外,本文件
a. 不可以用于其他非原指定用途; b. 不可以向第三方披露;
c.
不可采用任何形式进行复制和传播,包括但不限于传真、纸张邮件和电子邮件。
第 3 页 共 45 页
无限通平台接口手册
1、 引言
1.1. 目的
该接口手册编写目的在于描述三通运营平台CTC-OSS(以下简称CTC-OSS)具体的接口协议,供接口用户进行接口的对接开发。已经整理和编写了接口Demo项目(CTC-OSS-Interface_Demo),具体细节可参考项目内的实现示例。
1.2. 名称解释
缩略语 CTC-OSS SMS MMS API MO MT SP CP 英文全名 Operational Support System Short Messaging Service Multimedia Message Service Application Programming Interface Message Original Message Terminal Service Provider Content Provider 中文全名 三通运营平台 短消息服务 多媒体消息 应用程序编程接口 消息上行 消息下行 服务提供商 内容提供商 1.3. 平台信息
Web地址:http://3tong.net API接口IP:
电信:180.153.246.63 联通:112.65.225.225
端口:28020 端口:28020
2、 短信
2.1. API接口
相关jar包包括:
ctc-smsclient.jar,ctc-message.jar,ctc-slidewindow.jar,ctc-sync.jar,ctc-util.jar。 注意:终端客户的接入方式设置为API接入时才能使用此接口 事例代码见附件(3.1 api接口示例)
第 4 页 共 45 页
无限通平台接口手册
名称 功能 接口方法 连接初始化。 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—— 其他
名称 功能 接口方法 发送短信。 public boolean sendSms(String from, String to, String msg) 输入说明 from:子号码,一般不填写; to:手机号码,支持多号码,以英文逗号隔开。建议一次最多100个; msg:短信内容。 输出说明 true:成功; false:失败。
名称 功能 onSubmitedSMS 接收下行短信响应。sendSms方法不直接返回下行响应,由此方法返回,此方法为回调方法,不需要手动调用。 接口方法 输入说明 public boolean onSubmitedSMS(ISubmitMsg arg0) arg0:下行数据结构,具体字段见示例。 第 5 页 共 45 页
sendSms