动态内容分发接口规范.docx

1、动态内容分发接口规范-实施-发布中国移动通信集团公司 发布QB-中国移动通信企业标准中国移动动态内容分发业务接口规范Interface specification of China mobile Dynamic Content Delivery Service(报批稿)版本号：1.0.0前言本规范对中国移动动态内容分发业务涉及的接口进行规范，以保证中国移动通信集团动态内容分发业务系统在多终端厂家环境下能够顺利开展业务。本规范结合了中国移动特定的业务要求，为中国移动动态内容分发业务从终端到内容服务的开发、运行、管理和维护等提供技术依据。本标准由中国移动通信集团公司技术部提出并归口。本标准由 部门

2、负责解释。本标准起草单位：中国移动通信集团公司研究院。本标准主要起草人：孙杰、温亮生、常嘉岳、任鹏。目录1 范围 42 引用标准 43 术语和定义 44 符号和缩略语 55 系统接口描述 56 本规范中相关定义的说明 67 DCD1接口定义 67.1 WAP PUSH消息触发终端数据同步事件 77.2 请求类型定义 77.3 数据同步请求消息 87.4 数据同步响应消息 97.5 数据下载请求消息 137.6 数据下载响应消息 138 DCD2接口定义 149 安全要求 1410 模板格式定义 1510.1 模板编号 1510.2 模板为XML格式 1511 错误重传机制及错误代码定义 171

3、2 编制历史 17附件一：WAP Push SL Notification消息举例 17附件二 数据同步消息举例 17附件三 数据下载消息举例 20附件四 模板 211 范围本规范涉及的接口包括DCD1(DCD平台与DCD客户端之间的接口)、DCD2(DCD平台与SP或CP之间的接口) 。本规范着重描述各接口的消息定义以及各消息所传送的内容、格式，多个网元在实现特定业务时的信令配合不在本规范范围之内。2 引用标准1 动态内容分发业务（DCD）总体技术要求，中国移动通信集团公司2 动态内容分发系统设备规范，中国移动通信集团公司3 动态内容分发业务规范， 中国移动通信集团3 术语和定义必选本规范中

4、规定的“必选”字段要求设备必须实现并且在消息中必须携带。可选本规范中规定的“可选”字段设备可以实现并在消息中携带，如果消息中没有携带，表示设备暂不支持。视情况而定本规范中规定的“视情况而定”字段要求设备必须实现但是否在消息中携带需要根据相关条件确定。频道是动态内容分发业务下发的组织形式，是内容分发和计费的最小单元。频道项频道中的个体，例如具体的新闻故事。一个频道可以由多个频道项组成。可选频道DCD服务开通时，移动用户不能自动接收到该频道内容。移动用户通过订购和退订流程对该频道进行订购和退订。起始频道DCD服务开通时，移动用户自动接收该频道。移动用户也可以要求退订该频道。起始频道一般都是免费频道

5、。随时在线频道移动用户会自动收到这种频道的内容，不需要订购也不能退订。随时在线频道一般是免费频道，。欢迎频道移动用户会自动收到这种频道的内容，不需要订购也不能退订。欢迎频道在用户使用一段时间后（该时间可由部署人员配置）会自动消失，也就是说欢迎频道在新用户初次使用的一段时间将会自动展现给用户。 欢迎频道一般是免费频道。完整故事 每个频道项中可以导向一个完整的WAP页，可以详细介绍这个频道项，并可以链接到其他的WAP页面必选项是指终端产品所必须提供的功能或性能要求； 可选项指在目前看来是中国移动需求的发展方向，或终端产品在目前阶段可不提供的功能或性能要求已提交最新提交的内容的初始状态。已发布已获批

6、准并且可供移动用户订购的内容。尽管系统中可能存在一个内容的多个版本，但是，只有一个版本处于这个状态。停止发布如果一个频道被设置为停止发送，那么未订购该频道的移动用户将不可再订购的该频道；但是，在其状态改变之前已经订购该频道的移动用户将可以继续使用该频道并被计费，直至该频道被删除。终止服务如果一个频道被设置为中止服务，服务器将停止向客户端定期发送该频道的更新内容，同时，服务器将下发一个特殊的频道故事，显示该频道服务终止的提示，恢复服务后此提示消失。DCD客户端安装在终端上的用于和DCD平台进行数据交互并显示频道频道项内容的客户端软件。4 符号和缩略语CDR: Call Detail Record

7、 呼叫详细记录DCD： Dynamic Content Delivery 动态内容分发5 系统接口描述动态内容分发业务系统结构如下：DCD1:动态内容分发服务器与DCD终端之间的接口；DCD2: 动态内容分发服务器与SP或CP系统之间的接口；6 本规范中相关定义的说明本章定义各接口摘要消息的应用协议框架，并说明DCD服务功能的技术实现。摘要消息可以归类为由请求和响应构成的事务处理。DCD1接口用户数据同步消息和数据下载消息交互，不包括请求完整故事的wap请求消息。DCD1接口和通过数据同步消息中携带的URL地址发起的数据获取消息均采用“CMWAP”APN。对于本规范涉及的关于企业代码（SPID

8、），和业务代码（ServiceID）的说明请参见动态内容分发业务规范。图6.1 数据同步请求消息流程7 DCD1接口定义参考点DCD1定义了DCD客户端和内容分发服务器之间的事务处理。这些事务处理包括业务浏览、查询、订购、退订。本规范版本中，DCD1接口采用HTTP1.1作为承载协议，以XML语言表述。图6.1 以端到端的方式说明了其中的一些事务处理及其关系。7.1 WAP PUSH消息触发终端数据同步事件服务器端可以主动通过WAP PUSH消息触发的终端数据同步，对于WAP PUSH触发方式，要求如下：WAP PUSH消息采用SL方式。PUSH Application ID为x-oma-DC

9、D:DCD.ua，填写时为X-WAP-Application-Id: application/x-oma-DCD:DCD.uaDCD客户端在接收到PUSH消息后，采用以下步骤形成数据同步URL并发起同步请求：1) 取出预先配置好的基本URL信息，包括host，port,，且此信息不可更改；2) WAP PUSH消息中的URL地址是一个完整的URL地址。为了保证安全，终端在取出WAP PUSH消息中的URL信息，需截取出该完整地址中去除host和port的以根目录开始的相对地址，和终端上预先配置的基本URL信息的host和port一起，重新组织一个新的完整的URL，即新的完整URL=配置基本ho

10、st“:”配置基本port+根目录开始的相对地址3) 以上一步组织的新的完整URL发起数据同步请求。7.2 请求类型定义在同步请求消息和下载请求消息中，都必须在请求消息头中填写请求类型X-DP-RequestType. 下表定义了数据请求消息头中请求类型：请求类型名称功能描述HEADER填写规则ttl因DCD服务器设定的内容更新时间到达而发起的内容同步请求X-DP-RequestType: ttlman用户手工发起的内容同步请求X-DP-RequestType: mansvr因DCD服务器下发的WAP PUSH消息触发的内容同步请求X-DP-RequestType: svrmc（可选）因主清除

11、操作触发的内容初始化请求X-DP-RequestType: mcmr（可选）因主复位操作触发的内容初始化请求X-DP-RequestType: mrsim因SIM卡更换触发的内容初始化请求X-DP-RequestType: simdata预留，暂时不用X-DP-RequestType: datadata2多个内容打包为一个响应包下载X-DP-RequestType: data2data3每个图片一个请求包下载X-DP-RequestType: data37.3 数据同步请求消息数据同步请求消息采用HTTP1.1作为承载,数据同步请求消息的方式为GET方式数据同步请求定义：以下是请求头类型传送相

12、关信息。请求头字段名称存在情况功能描述类型每个的长度填写规则X-DP-RequestType必选请求类型String20ttl, man, svr, mc, mr, sim,中的任何一个User-Agent必选DCD客户端描述，包括：DCD终端类型、DCD客户端标识编号、支持的JVM能力等信息String255参照中国移动wap终端规范填写Version必选客户端支持的DCD接口版本String11XX.XX.XX.XX例如：1.0.1.3X-DP-Global-Sync-Anchor可选频道的同步定位符String100例如：globalanchor,swfasfewrw多个定位符可以用逗号

13、分隔。对于新终端第一次使用该业务以及当终端主清除，主复位，更换sim卡时，该参数为可选，其余情况下终端需要根据服务器端上次给定的值进行请求。X-DP-Sync-Anchor可选频道项的同步定位符String91例如：h7gd0vk=e.ewopg8q3.5k.0.ixeanzuw.8, dfaesd32=e.ewopg8q3.5k.0.35fdfwrwfd.8，多个定位符可以用逗号分隔。每个定位符由频道编号加等号加该频道项所在的频道的feed-meta中属性anchor的值。请参见同步响应消息标签说明。对于新终端第一次使用该业务以及当终端主清除，主复位，更换sim卡时，该参数为可选，其余情况下

14、终端必须根据服务器端上次给定的值进行请求。X-DP-Cell-Id可选终端所处的小区代码String10String类型Accept-Encoding可选支持的压缩编码格式String15Compress、gzip7.4 数据同步响应消息数据同步响应消息头定义如下：HEADER名称存在情况功能描述类型长度HEADER填写规则X-DP-RequestType可选参见数据同步请求消息String15参见数据同步请求消息X-DP-Global-Sync-Anchor可选参见数据同步请求消息String100参见数据同步请求消息X-DP-Sync-Anchor可选参见数据同步请求消息String91参

15、见数据同步请求消息Content-type必选描述同步数据类型String32application/dcd.xmlX-DP-nextURI可选描述客户端在下一次请求时的目标地址，该地址必须以”/”开始，表明是以当前web服务的根目录开始的相对地址String64在下一次请求时客户端必须用该参数组成完整的URL地址，规则如下：http:/host:por+ X-DP-nextURI。如果没有该参数，则用原来的URL进行访问同步响应包体采用XML来组织数据，其结构如下标签名称父标签子标签属性（大小字符数）功能描述metafeed*响应消息的起始和结束标签 sync-pkgglobal-metag

16、enerator#feed-meta*元数据标签，指明定购频道列表，同步定位符，目标显示区域，内容更新时间metaanchor（100）ttl（15）server-time（15）频道项元数据标签。anchor：同步定位符。ttl属性单位为毫秒。如果ttl属性为0，那么不允许终端主动定期触发内容同步请求，而只能由DCD服务器主动触发数据同步请求。server-time 指定服务器侧的系统时间，取值为从GMT 1970年1月1日00:00:00 起的毫秒值。metactxt-id（20）anchor（70）target（35）charge（1）频道数据的元数据标签。表明此频道为已定购的频道。Ct

17、xt-id属性为必选属性，是频道的唯一标识，必须是全局唯一的，不可重用。为20位以内的数字。Anchor属性为此频道的定位符。Target 属性决定内容在终端上的显示位置。目前唯一取值“container1”。charge属性表明该频道是否为收费频道，单独的收费频道charge=”Y”,免费频道charge=”N”,打包收费的频道charge=”P”#titlesummarylink#content*entry#version# （15）ctxt-id（20）template-id （20）entry-template-id# （20）feed-type （10）excerpt# （10）ex

18、cerpt-default# （10）频道标识标签。version 该频道在服务器上的颁布号。ctxt-id属性为必选属性，是频道的唯一标识，必须是全局唯一的，不可重用。feed-type属性指明此频道的频道项的类型。仅有文本的频道项，其feed-type=“ftto”；只有图形格式的频道项，则feed-type=“ftio”, 既包含文本和图形的频道项feed-type=”ftti”， 对于包含音频和（或）视频等多媒体信息的频道，feed-type=”ftmm”。默认情况下template-id填写defaultentry-template-id：标识频道的频道项所使用的模板，默认时填写de

19、fault。如果频道项为文本项，则必须填写title字段。excerpt-default是设置当前频道所有频道项的默认excerpt值feedentrytype#（32）频道（feed）或频道项（entry）标题标签type属性目前唯一取值“text/plain”feedentrytype#（32）频道或频道项的描述信息标签type属性目前唯一取值“text/plain”feedentryrel（10）type#（32）href（1024）title(60)指明点击某频道或某频道项后链接的URL地址，可以有多个rel目前取值仅有rel=alternate。type 同标签title为该连接的标

20、题，作为该连接的显示内容feedentrytype#（32）mode# （10）name（20）ctxt-id（20）href# （1024）autoplay$（1）频道或频道项的内容元素标签，比如图片信息等。频道中引用此标签用在频道模板所使用的缺省内容。type属性指明内容的MIME类型。mode属性指明内容的编码方式。name属性指明模板中的一个参考点。ctxt-id属性为必选属性，是内容的唯一标识，必须是全局唯一的，不可重用。为20位以内的数字。href：如果为一个标准格式的URL地址，则采用标准HTTP1.1协议获取内容； 对于音视频内容，必须填写autoplay属性，要求终端自动播放

21、，则autoplay=Y,否则autoplay=Nfeedtitle#summary#link#issued#author#content#activation#expiration#ctxt-id（20）template-id# （20）entry-type（10）excerpt# （10）template-href# （1024）频道项标签，可能包含一篇文字或一个图片项等。entry-type标示为频道项的类型，仅有文本的频道项，其entry-type=“etto”；只有图形格式的频道项，则entry-type=“etio”, 既包含文本和图形的频道项entry-type=”etti”，对

22、于包含音频和（或）视频等多媒体信息的频道项，entry-type=”etmm”。ctxt-id是频道项的唯一标识，必须是全局唯一的，不可重用。为20位以内的数字。template-id指明频道项所使用的模板编号，缺省填写default。template-id重载entry-template-id的规定。excerpt：指明是否使用屏保显示区。它重载feed标签的excerpt-default属性。entry-type和template-href属性的定义与feed标签一致。template-href与template-id的属性同时出现，是指template-id对应的模版文件对应的URL地址

23、。entry频道项发布的时间。取值为从GMT 1970年1月1日00:00:00 起的毫秒值。entrynameurl#email#频道项的作者entrytype# （32）终端开始显示频道项的时间。取值为从GMT 1970年1月1日00:00:00 起的毫秒值。type属性取值可能为type=rel或type=absolute，表示相对或绝对时间。如果设为rel，表示相对时间，与终端的现在时间相加，得出开始显示该频道项的时间。entrytype# （32）终端停止显示频道项的时间。取值为从GMT 1970年1月1日00:00:00 起的毫秒值。type属性取值可能为type=rel或type

24、=absolute，表示相对或绝对时间。如果设为rel，表示相对时间，与终端的现在时间相加，得出停止显示该频道项的时间。author作者姓名author为一个指向该作者相关信息的网页地址author作者的email地址说明：1. ：定购的频道必须在meta数据中罗列出来。2. 模板采用数据下载请求消息或者标准的HTTP1.1请求获取。3. 一个频道或频道项可以包含多个标签。4. 如果频道的模板属性“template-id”没有定义，那么显示频道项时，根据频道项模板“entry-template-Id”来显示每个频道项。5. 每个频道包含0至多个频道项。6. Title, summary的长度默

25、认分别是60和250字节7. 带#的属性或者子标签项目可以有一个或者多个，也可以没有该项目； 而带*的属性或者子标签项目，必须至少有一个，也可以有多个。没有任何标志的属性或者字标签项目为有且仅有一个；带$的属性或者子标签项目表示，满足某些条件时为必填项，不满足条件时不填写。8. template-id为模版编号，详细描述请参见模版格式定义9. 对于未更新的频道项及频道的同步响应处理： 对于没有更新的频道项，可以用来表示。对于没有更新的频道(包括频道的title等信息以及频道项都没有更新)，由于在中已经表明了该用户已经订阅了该频道，所以没有必要在响应信息包中增加标签。但是如果频道中有任何信息的更

26、新，都得在响应信息包中填写完整的标签（频道的title信息以及频道项信息）。7.5 数据下载请求消息数据下载请求消息的方式：GET方式。数据下载请求消息头定义如下：HEADER名称存在情况功能描述类型长度HEADER填写规则X-DP-RequestType必选请求类型String15data ,data2, data3X-DP- Request-Id必选需要从DCD服务器下载的内容列表。列表内容是前一个数据同步请求消息包含的客户端本地没有，需要更新数据的template-id或者ctxt-id值，采用逗号分割。String20例如：news20193a,news20194a,news20195

27、aUser-Agent必选DCD客户端描述，包括：DCD终端类型、DCD客户端标识编号、支持的JVM能力等信息String255参照中国移动wap终端规范填写Version必选客户端支持的DCD接口版本String11XX.XX.XX.XX例如：1.0.1.3X-DP-Cell-Id可选终端所处的小区代码String10String类型Accept-Encoding可选支持的压缩编码格式String15Compress、gzip具体实例见附录。7.6 数据下载响应消息下载响应消息头如下：HEADER名称存在情况功能描述类型长度HEADER填写规则Content-type必选描述同步数据的类型，以MIME为标准String100对于多个数据同步，该值应填写为：multipart/mixedX-DP-nextURI可选描述客户端在下一次请求时的目标地址，该地址必须以”/”开始，表明是以当前web服务的根目录开始的相对地址String64如果有该参数，则在下一次请求时客户端必须用该参数组成完整的URL地址，规则如下：http:/host:port+ X-DP-nextURI。如果没有该参数，则用原来的URL进行访问8 DCD2接口定义遵循标准RSS2.0接口定义。下表总结了动态内容分发业务对于被汇聚的内容源频