大汉三通融合消息平台CTCCMS接口手册.doc

大汉三通融合消息平台大汉三通融合消息平台 CTC-CMSCTC-CMS 业务开发接口手册业务开发接口手册 产品名称产品名称大汉三通融合消息平台大汉三通融合消息平台 CTC-CMSCTC-CMS 发布者发布者上海大汉三通网络通信有限公司上海大汉三通网络通信有限公司 发布日期发布日期 2009-082009-08 目目 录录 1 1、引言引言.3 3 1.1.目的.3 1.2.修改历史记录.3 2 2、短信短信.4 4 2.1.HTTP接口.4 2.1.1.短信下行.4 2.1.2.短信上行.5 2.1.3.短信状态报告.5 2.2.短信存储过程业务接口.6 2.2.1.处理上行存储过程格式.6 2.2.2.发送下行的存储过程.7 2.3.CTC-SERVER接口.7 2.4.WEBSERVICE接口.8 2.4.1.短信下行.8 2.4.2.短信上行.9 2.4.3.短信状态报告.10 3 3、彩信彩信.1212 3.1.HTTP接口.12 3.1.1.彩信下行.12 3.1.2.彩信上行.13 3.1.3.彩信状态报告.14 3.2.CTC-SERVER接口.14 3.3.彩信存储过程业务接口.14 3.3.1.处理上行存储过程格式.14 3.3.2.发送下行的存储过程.15 3.4.短信上行接口.16 3.4.1. ctc-server接口.16 3.4.2.数据库接口.19 1 1、 引言引言 . 目的目的 该接口手册编写目的在于描述大汉三通融合消息平台 CTC-CMS（以下简称 CTC-CMS）具 体的接口对接，供设计和第三方开发人员在开发过程中参考。 . 修改历史记录修改历史记录 版版 本本修改人修改人日日 期期描描 述述 5.0.1顾黎杰2009/8/10创建文档 5.0.2刘许舟2009/11/20短信下行请求方式参数加了 MoId 5.0.3顾黎杰2010-6-1更新短信 webservice 方式推送上行跟状态报 告 5.0.4顾黎杰2010-6-10短信 webservice 下行接口增加 spNumber 支 段 支持 wap push 5.0.5顾黎杰2010-6-28增加彩信 webservice 接口 5.5.6顾黎杰2010-8-10Webservice 上行接口增加归属地 2 2、 短信短信 . http 接口接口 .1.1. 短信下行短信下行 如果业务的 url 为： :8080/cms/http/SendSms 请求方式为： :8080/cms/http/SendSms?userName= 输入说明userName 用户账号 password 用户密码（用 MD5 加密） MTMessage 对象，短信平台根据对象包含的属性来决定如何发 送短信。 MTMessage 类型结构定义： public class MTMessage private String phone;/手机号，多个以英文逗号隔 开 private String content;/短信内容 private int serviceId;/业务Id private int channelId;/通道Id private String linkId; private String moId;/对应上行短信Id private String feePhone;/计费号码 private int priority;/短信下发优先级，0-9，数 字越大优先级越高 private int deliveryReport;/是否需要状态报告， 0：否 1：是 private Date sendTime;/下行时间 private String smsId;/下行短信 ID，用于跟状态报 告匹配，如果不带，response 会自动返回 private String spNumber;/特服号 private String pushurl;/如果是 wap push 需要填 写 输出说明返回的结果是以 MTResponse 对象构成的数组，客户端可以据 此判断，方法执行成功与否。 MTResponse 类型结构定义： public class MTResponse private String phone;/手机号 private String smsId;/短信Id，用来取状态报告 private int result;/发送结果 private int errorDepict;/错误描述 private int isSuccess;/请求是否成功 ; .4.2. 短信上行短信上行 1.第三方获取第三方获取 名称getSms 功能获取上行短信的信息，一次最多取 10 条 接口方法MOMessage getSms(String useName, String password,int serviceId); 输入说明userName 用户账号 password 用户密码（用 MD5 加密） serviceId 业务 Id 输出说明返回的结果是一个以 MOMessage 对象构成的数组，据此可以 分析该上行短信的结果。 MOMessage 类型结构定义： public class MOMessage private String phone;/手机号 private String content;/短信内容 private int serviceId;/业务Id private int channelId;/通道Id private String linkId; private String moId;/短信Id private String spNumber;/上行特服号 private int functionType;/短信类型 1. 点播 2 定制 3 退订 4 普通路由参数 private int isSuccess;/请求是否成功 private int type;/1:短信 2：彩信 3：状态报告 private Date receiveDT; private String province;/手机归属地 private String region; /手机归属地 ; 2.CTC-CMS 推送 第三方可以从 :8080/cms/services/CtcSmsNotification?wsdl 获取 wsdl 文件进行开发 名称 smsDeliver 功能发送上行给第三方，一次一条 接口方法int smsDeliver (MOMessage moMessage); 输入说明moMessage ：MOMessage 类型结构 输出说明返回的结果是一个数字，0 代表成功，其他表示失败 .4.3. 短信状态报告短信状态报告 1.第三方获取第三方获取 名称getReport 功能获取状态报告信息，一次最多取 10 条 接口方法MTReport getReport(String userName, String password, MTMessage message); 输入说明userName 用户账号； password 用户密码（用 MD5 加密） ； MTMessage，包含短信 id 和手机号码的对象。 输出说明返回的结果是一个以 MTReport 对象构成的数组，据此可以分 析该状态报告的结果。 MTReport 类型结构定义： public class MTReport private String phone;/手机号 private String msgId;/下行短信Id private int stat;/0 发送成功 1 等待发送 2 发送 失败 private String err;/错误描述 private int type; private int reportType;/状态报告类型 1：彩信 2：短信 private int isSuccess;/请求是否成功 ; 2CTC-CMS 主动发 第三方可以从 :8080/cms/services/CtcSmsNotification?wsdl 获取 wsdl 文件进行开发 名称 smsReport 功能得到状态报告一次一条 接口方法int smsReport( MTReport mtReport); 输入说明mtReport：MTReport 类型结构 输出说明返回的结果是一个数字，0 代表成功，其他表示失败 3 3、 彩信彩信 . http 接口接口 .1.1. 彩信下行彩信下行 如果业务的 url 为： :8080/cms/http/SendMms 请求方式为： :8080/cms/http/SendMms?userName=)分 隔。每个资源内部包含三个 信息，分别是：帧号，类型， 内容（按字节码 base64 编码） 这三个信息用半角逗号(,)分 隔 linkIdString,可以为空 feePhone计费号码String,可以为空 priority发送优先级int,可以为空. 1-9 数字,越大优先级越高 subject彩信标题String,不空 productId产品 IdString,可以为空。由 CTC- CMS 提供 deliveryReport状态报告int 0-不需要 1-需要 sendTime定时发送时间String,可以为空，为空就是立 即发送。定时发送格式为年 月日时分，如： 200803201615 返回参数定义如下： 参数名称描述 response-101：缺少请求参数或参数不正确 -1：帐号登陆失败 -2：ip 验证失败 -3：没有业务权限 -10：所带的 productId 错误 -11：资源内容为空 phone手机号 responsecode响应状态码 0：成功 -1：错误的手机号 -2：黑名单用户 -3：错误的业务 -4：错误的通道 -5：错误的产品 -6：错误的内容 -7：通道上未开展此业务 -8：关键字过滤 -10：没有改业务权限 responseinfo响应描述 mmsid彩信 ID .1.2. 彩信上行彩信上行 由大汉三通融合消息平台主动推送给第三方客户，第三方客户可以用一个 servlet 地址来接收消 息，具体支段定义如下 参数名称描述 phone手机号码 serviceId业务 Id channelId通道 Id content彩信内容，是一个 zip 包，经过 base64 编码 linkId moId上行彩信 Id functionType彩信类型 1. 点播 2 定制 3 退订 4 普通路由参数 spNumber上行特服号 type1：短信 2：彩信 3：状态报告 .1.3. 彩信状态报告彩信状态报告 由大汉三通融合消息平台主动推送给第三方客户，第三方客户可以用一个 servlet 地址来接收消 息，具体字段定义如下 参数名称描述 phone手机号码 stat0 发送成功 1 等待发送 2 发送失败 msgId下行短信 Id err错误描述 . Ctc-server 接口接口 . 彩信存储过程业务接口彩信存储过程业务接口 .3.1. 处理上行存储过程格式处理上行存储过程格式 参数名称参数名称类型类型描述描述 phoneVarchar(50)手机号码 SPNumberVarchar(50)上行来的 SP 的号码 serviceIDInt业务 ID chanIDInt上行通道 ID functionTypeInt指令通途 1 点播 2 定制 3 退订 4 普 通路由参数 moTypeInt 1短信 mo 2彩信 mo 3状态报告 msgVarchar(200)如果是短信，这里是短信内容 如果是彩信，这里是彩信的 subject。 如果是状态报告报告，格式如： MsgID + 空格+ Nstat + 空格 + 错误码+ 空格+错误描述 linkIDVarchar(50) mmschannelInt如果是短点彩，这里是对应的彩信通道 moIDVarchar(100)Mo 标识 如果是短信，则对应 mo_sms 表的 ID； 如果是彩信，则对应 mo_mms 表的 ID .3.2. 发送下行的存储过程发送下行的存储过程 Proc_MtSend 参数名称参数名称类型类型描述描述 phoneVarchar(50)手机号码 serviceIDInt业务 ID chanIDInt通道 ID MsgTypeInt通道类型 1彩信 2短信 MsgVarchar(100)如果是彩信，对应产品 ID； 如果是短信则是短信内容。 SPNumberVarchar(50)上行来的 SP 的号码 linkIDVarchar(50) moIDVarchar(100)Mo 标识 如果是短信，则对应 mo_sms 表的 ID； 如果是彩信，则对应 mo_mms 表的 ID。 返回值Int . 短信上行接口短信上行接口 短信上行接口主要用于彩信平台与短信平台对接，实现短点彩业务。 .4.1. ctc-serverctc-server 接口接口 ctc-server 接口一般用于彩信平台直接与大汉三通短信平台直接对接。 短信通道配置短信通道配置 通道名称：标识通道的名称； 企业代码：运营商分配给 SP 的代码。 服务代码：通道号码。 运营商： 该通道支持下发那些运营商的手机号码。 运营商 IP：只用于彩信通道，标识运营商彩信中心的 IP 地址。 通道类型：短信或者彩信。 配置文件路径：通道配置文件的路径。 对于短信通道，通道的配置文件如下： -文件开始 此处填写协议标识此处填写协议标识 03 28010 8505 123 16 60000 3 此处填写短信平台此处填写短信平台 connID 此处填写短信平台此处填写短信平台 pgID -文件结束 业务配置业务配置 在为每个业务配置通道的时候，需要选择对应的短信通道。 配置指令的时候也要配置短信类型的指令。 这个时候才能实现短点彩业务。 .4.2. 数据库接口数据库接口 平台的上行队列表 PendingSMS，平台会自动监控这张表，一旦有记录，就会取出来直接 进行上行业务处理。 表结构如下： 字字 段段类类 型型描描 述述 IDInt主键表里面记录不能重复 ChannelIDInt短信通道 ID UserMobilevarchar(20)用户手机号 SmsCodevarchar(30)上行短信服务号码 SmsContentvarchar(300)短信内容 LinkedIDvarchar(50)用于标识点播订购关系 CreateDTdatetime添加时间 短信通道配置和业务配置跟 ctc server 接口差不多。 注意：注意： 通道配置的时候，配置文件基本不用配置，这个通道不必开启。通道配置的时候，配置文件基本不用配置，这个通道不必开启。 . WebService 接口接口 .5.1. CpCp 接口接口 名称 CmsWs 功能上传产品到 ctc-cms 接口方法 String uploadFiles(String userName, String password, byte bs,String fileName, String groupId, String internalFlag,String productName) 输入说明userName 用户账号 password 用户密码 bs 要上传的字节数组 fileNane 文件名 groupId 产品组 id internalFlag 内部编号 productName 产品名 输出说明返回的结果是产品上传成功后的 id，客户端可以据此判断，方 法执行成功与否。 返回值说明大于 0：返回的是产品 Id -1：用户名不存在 -2：密码错误 -3：上传的 bs 为空 -4：上传文件失败 -5：上传的不是 zip 包 -6：解压缩失败 -7：素材主目录或上行彩信路径或资源素材相对路径没配置 .5.2. 彩信下行彩信下行 名称sendMms 功能发送多条内容相同的彩信 接口方法MmsMTResponse sendMms(String userName, String password, MmsMTMessage message); 彩信打包说明四种方式： 1：直接传入平台现有的彩信产品的 Id，支段为 productId 2：把所有彩信内容打包成 zip 文件，base64 编码 3：多个资源用半角分号(;)分隔。每个资源内部包含三个信息， 分别是：帧号，类型，内容（按字节码 base64 编码）这三个 信息用半角逗号(,)分隔 4：直接用 webservice 带附件的方式上传 输入说明userName 用户账号 password 用户密码（用 MD5 加密） MmsMTMessag