彩信平台--对接方案.doc

CTC-MMS大汉三通彩信平台 安装手册CTC-MMS大汉三通彩信平台对接方案文档名称大汉三通彩信平台对接方案版本编号1.0文档编号MMS-011发布者上海大汉三通网络通信有限公司发布日期2006-12-14目录：前言31 适用范围42 术语和定义43 网络结构54 接口功能概述65 通信方式76 OA系统接入说明77 下行接口87.1 流程描述87.2 参数说明97.3 返回状态108 上行接口118.1 流程描述118.2 参数说明118.3 返回状态11附录I：彩信资源类型列表13前言本规范是大汉三通彩信平台接口规范。本规范描述了梧州移动OA系统（即第三方，以下简称OA系统）使用本接口进行彩信业务活动时所必须遵循的接口规则。根据梧州移动OA系统的具体情况，本规范中的操作和参数将会做进一步的调整和增加。1 适用范围本规范规定了以下两方面的内容：1） OA系统到彩信平台的下行接口协议；2）彩信平台到OA系统的上行接口协议；2 术语和定义名称全称描述MMSMultimedia Messaging Service多媒体消息服务MMSCMultimedia Messaging Service Center多媒体消息中心SMILSynchronized Multimedia Integration Language同步多媒体集成语言TPThird Party第三方，OA系统MOMobile Originate手机用户上行MTMobile TerminatedOA系统下行3 网络结构图3-1：合作网络结构图如图3-1所示，OA系统与彩信平台通过HTTP的方式相连，通过接口间接向运营商提交和接收业务数据。接口将负责OA系统下行消息的转发以及对（属于）OA系统的（上行）消息的转发。4 接口功能概述本接口主要提供如下两类业务操作：1） 信息发送：OA系统通过接口向手机用户下发彩信详细的流程参考本文中对下行接口的描述部分；2） 信息接收：OA系统通过接口接收来自手机用户的彩信详细的流程参考本文中对上行接口的描述部分；5 通信方式如前面所述，OA系统与接口通过HTTP协议通信；其中，下行接口同时支持HTTP/GET和HTTP/POST，而上行接口则只支持HTTP/POST。6 OA系统接入说明1）OA系统在接入接口时需要提供上行消息的接收地址。2）在OA系统接入时将由彩信平台提供下行接口地址7 下行接口下行接口定义为：OA系统向手机用户下发消息的接口7.1 流程描述在OA系统进行下行操作时，接口将依次对OA系统的请求完成参数校验，鉴权及资源准备（仅当OA系统下发彩信时）等操作，如果上述任何一个操作失败将返回给OA系统一个错误代码和错误描述（详细说明参考下文关于下行接口返回数据的描述）；如果所有操作成功，此时接口将向运营商网关提交下发请求，并返回给OA系统一个唯一的消息ID用以标识该条消息（详细说明参考下文关于下行接口返回数据的描述），OA系统下行操作的流程如下所示：OA系统彩信平台运营商网关1: 下发请求2: 下行参数检查3: 下行鉴权4: 资源准备5: 返回错误代码图7-1：失败的下行流程OA系统彩信平台运营商网关1: 下发请求2: 下行参数检查3: 下行鉴权4: 资源准备7: 返回消息ID5: 提交下发请求6: 图7-2：成功的下行流程7.2 参数说明参数参数名描述ToUser接收方号码接收方的号码，不在号码前附加86FromUser发送方号码发送方的号码，该号码将由北纬统一分配ChargedUser计费方号码计费方的号码，不在号码前附加86；当接收方即为计费方时，该参数可以省略ServiceCode业务代码所使用的业务代码，该代码将由北纬统一分配OperatorID运营商ID接收方所属运营商ID，可能的取值包括：CMCC：中国移动CU-GSM：中国联通G网CU-CDMA：中国联通C网当接收方为中国移动用户时，该参数可以省略LinkIDLink ID运营商要求的Link ID，该参数由用户上行产生并通过上行接口转发至OA系统Message消息内容编码方式：GB2312ContentCount资源数目彩信资源数量ContentType?资源类型彩信资源类型（见附录I）（？）代表一个介于1和ContentCount间的整数，假定ContentCount=11，则可能的取值有：ContentType1，ContentType2，ContentType11ContentURL?资源路径彩信资源路径或ID：符号?代表一个介于1和ContentCount间的整数，假定ContentCount=11，则可能的取值有：ContentURL1，ContentURL2，ContentURL11注：1）黑体部分为必须参数2）下行举例（为方便书写，此处仅以通过HTTP/GET方式下发为例）：http:/localhost:8080/CTC-MMS/MT?MessageType=2&ToUserFromUser=10981&ServiceCode=5301&Message=Test MMS&ResLocation=1&ContentCount=2&ContentType1=image/gif&ContentURL1=/caixin/phpfb/upload/images/a.jgp&ContentType2=image/gif&ContentURL2=/caixin/phpfb/upload/yd/dgct/1040b47f3089a99dfa8b7619e5bb73d5.gif7.3 返回状态返回给OA系统的响应页面结构如下：错误代码,错误描述关于错误代码详细说明如下:错误代码描述1000消息已成功提交至运营商网关注：此时将在响应头里面增加参数MessageID作为该条信息的唯一标识，随后的状态报告也将以此MessageID来唯一标识；（MessageID为由数字09，字符AZ组成的25位字符串）4001请求被拒绝：鉴权失败。引发该错误的可能原因包括：1）OA系统地址鉴权失败2）OA系统所使用的长号码或业务代码不正确4005所指定的彩信信息源（部分或全部）无法读取4007请求被拒绝：发送速度过快4008请求参数格式错误，引发该错误可能的原因包括：1）接收方或计费方号码格式不正确2）消息类型无效3）资源路径类型无效4）资源类型无效5）请求方式不正确（如使用了HTTP/GET）4009缺少必须参数5000其它错误8 上行接口上行接口定义为：OA系统接收手机用户上行消息的接口8.1 流程描述当接收到用户的上行消息时，将通过HTTP/POST方式将上行的消息转发至OA系统指定的地址。8.2 参数说明参数参数名描述ToUser接收方号码接收方的号码，不在号码前附加86FromUser发送方号码发送方的号码，该号码将由北纬统一分配ServiceCode业务代码所使用的业务代码，该代码将由北纬统一分配LinkIDLink ID运营商要求的Link ID，该参数由用户上行产生并通过上行接口转发至OA系统Message消息内容编码方式：GB23121）MessageID的值在下发的响应头中以参数MessageID标识，参考下行的响应说明；2）状态报告的格式为：状态码,返回时间。返回时间的格式为：yymmddhhMM,yymmddhhMM（前者为发送时间，后者为状态报告时间），完整的Message格式如下：状态码,发送时间,返回时间$MessageIDContentCount资源数目彩信资源数量ContentURL?资源路径彩信资源路径或ID：符号?代表一个介于1和ContentCount间的整数，假定ContentCount=11，则可能的取值有：ContentURL1，ContentURL2，ContentURL118.3 返回状态服务器响应页面结构如下：错误代码,错误描述关于错误代码详细说明如下:错误代码描述1000用户上行消息已经处理4001请求被拒绝4005所指定的彩信信息源无法读取4008请求参数格式错误，引发该错误可能的原因包括：1） 接收方或计费方号码格式不正确2） 所发送的消息长度超长（应少于70个汉字）3） 请求方式不正确（如使用了HTTP/GET）4009请求参数错误，引发该错误可能的原因包括：1）缺少必须参数5000其它错误附录I：彩信资源类型列表注：不区分大小写ContentType文件类型ContentType文件类型application/smilsmilimage/vnd.wap.wbmpwbmptext/plaintxtimage/pngpngtext/x-eMelodyimyaudio/midmidimage/jp