IPTV业务管理平台2.0订购接口.doc

1. 订购及计费接口1.1 业务订购/退订购流程STB业务系统业务管理平台1.Http请求3.业务订购请求4.返回订购确认页面2.重定向8.返回处理页面5.确认订购6.返回处理结果7.保存订购信息图4-5-1-1：即时业务订购流程图链接：64:7001/iptv3a/user/subscribe/subscribe.do1.1.1 接口协议内容承载协议：1. HTTP GET 增值业务使用2. SOAP EPG使用接口方向：EPG服务系统重定向 业务管理平台接口功能: 用户订购业务。请求消息包含以下关键参数业务订购请求参数名称说明数据类型长度（字节）是否必选SPIDSP的唯一标识string8MUserIDIPTV用户业务编号string36OContentID内容IDstring32OServiceIDIPTV服务编号string20MProductIDIPTV产品编号string16OUserToken业务管理平台为该用户分配的临时身份证明，可采用Cookie的方式传递string32MReturnURL返回EPG服务页面的URLstring256MAction订购动作1：订购；2：退订Sting1M返回参数名称说明数据类型长度（字节）是否必选Result业务订购结果 0：成功 其他：失败String4MDescription结果描述String256OUserIDIPTV用户业务编号string36OUserToken业务管理平台为该用户分配的临时身份证明，可采用Cookie的方式传递string32OServiceIDIPTV服务编号string20MProductIDIPTV产品编号string16MProductNameIPTV产品名称string100OPurchaseType0：免费1：按次支付5：包月int4MFee支付金额(以分为单位)int4OSPIDSP的唯一标识string8OTransactionID订购的事务编号string40OExpiredTime订购关系的失效时间， 格 式 为YYYYMMDDhhmmss。缺少该参数表示永久有效。String14O1.1.2 订购参数校验要求1. UserToken必须有效，从UserToken可以找到UserID；2. Serviceid和Contentid必须两者存在其一；3. 通过UserID，可以从User表得到用户数据，用户状态正常；4. 通过ProductID，可以从Product表获得产品数据；5. 产品状态为发布状态（status=3）；6. 产品应该没有过期，过期时间小于当前时间；7. 如果是包月产品，应该至少还有一个月的使用时间，到期时间至少在一个月以后；8. 非CRM产品，其授权应该不存在；9. CRM产品在存在有效授权的情况下（ProductAuth表status=1），订购会先作废原有授权，然后继续进行，生成新的授权；10. 产品应该存在计费策略；11. 产品应该有服务对应关系。1.1.3 退订购参数校验要求1. UserToken必须有效，从UserToken可以找到UserID；2. Serviceid和Contentid必须两者存在其一；3. 通过UserID，可以从User表得到用户数据，用户状态正常；4. 通过ProductID，可以从Product表获得产品数据；5. 产品状态为发布状态（status=3）；6. 产品必须是包月产品，按次和免费产品均不可以退订购；7. 必须是有效授权，授权状态不能为过期（ProductAuth表status!=9）；8. 如果产品的授权还在免费期内，不可以退订购；9. 产品应该存在计费策略；10. 产品应该有服务对应关系；11. 如果是CRM产品，必须30天以后才可以退订购。1.1.4 订购/退订购接口SOAP方式和HTTP方式异同由于EPG订购采用SOAP方式，而增值业务订购采用HTTP方式，所以处理有所不同。1. EPG处理请求与确认页面，具体说为：EPG订购由EPG负责订购请求页面，该页面直接通过服务鉴权接口，获得可以订购的产品列表，列表中已经包含产品价格及优惠内容等信息；IPTV3A平台判定是否可以订购/退订购，然后执行订购/退订购动作。2. 增值业务管理平台处理请求页面，确认页面由IPTV3A平台提供。增值业务平台没有实现单个增值业务业务鉴权接口，所以不会获得产品价格和优惠信息；订购的时候，由增值业务平台发起请求，IPTV3A平台生成确认页面，给用户说明产品，并列出优惠信息。1.1.5 错误代码表分类代码描述全部0成功订购关系1001该产品已经存在有效授权1002生成产品授权错1003产品授权无法插入数据库1005无有效产品授权1004终止授权关系出错1006无法执行完成退订购1007无法执行完成暂停订购关系1008无法执行完成恢复订购关系1009授权关系异常：非暂停状态1011服务授权无法插入数据库1021内容授权无法插入数据库1031CDR无法插入数据库1032无法计算有效CDR1033ProductID无效1034ServiceID无效1035ContentID无效业务鉴权失败1051CRM-退订修改授权期失败用户2001用户不存在2002用户已停机或销户2003用户不是正常状态2011UserToken无效2012UserToken过期产品3001产品不存在3002非包月产品3003非包月即时订购产品3004产品还没有过免费期3005产品不是发布状态3006产品过期3007包月产品即将下线3008CRM产品退订购只有在订购后下月起效预付费4001预付费账户错误，预付费网络错误4002预付费账户错误，账户不存在或状态异常4003预付费账户余额不足4004预付费未知错CRM51主业务产品订购过程中，请求已被处理5001CRM接口无法调用计费6001无法计算费用6002无法生成代理计费未知异常9999未知的异常2. 增值业务接口2.1 用户已订购及免费产品列表接口方式：SOAP接口方向：增值业务入口-IPTV3A平台接口功能：获取用户已经订购过和可以免费使用的增值业务产品列表业务订购请求参数名称说明数据类型长度（字节）是否必选SPIDSP的唯一标识string8OUserIDIPTV用户业务编号string36MUserToken业务管理平台为该用户分配的临时身份证明，可采用Cookie的方式传递string32M业务订购请求响应参数名称说明数据类型长度（字节）是否必选SPIDSP的唯一标识string8OUserIDIPTV用户业务编号string36MEPGGroupNMBEPG分组编号string10OSTBID机顶盒IDstring24OMAC用户本次登录的MAC地址string24OProducts产品列表详细信息复合类型MProduct参数说明名称说明数据类型长度（字节）是否必选ProductID产品标识string40MProductName产品名称string60MProductDesc产品描述string200MPurchaseType产品类型：0免费、1按次、5包月int10OFee产品标识价格（分）int10MEPGGroupNMBEPG分组编号string10O说明：1. 产品列表包含由用户已经订购的增值业务产品和免费产品两部分组成；2. 请求同时传入UserToken和UserID做校验使用；3. 返回的产品列表，即Products参数，对应SOAP客户端，被自动解析成Object的形式，用Object需用类VasProductDetailResponseVO转义。2.2 用户未订购产品列表接口方式：SOAP接口方向：增值业务入口-IPTV3A平台接口功能：获取用户已经未订购过的增值业务产品列表业务退订购请求参数名称说明数据类型长度（字节）是否必选SPIDSP的唯一标识string8OUserIDIPTV用户业务编号string36MUserToken业务管理平台为该用户分配的临时身份证明，可采用Cookie的方式传递string32M业务退订购请求响应参数名称说明数据类型长度（字节）是否必选SPIDSP的唯一标识string8OUserIDIPTV用户业务编号string36MEPGGroupNMBEPG分组编号string10OSTBID机顶盒IDstring24OMAC用户本次登录的MAC地址string24OProducts产品列表详细信息复合类型MProduct参数说明名称说明数据类型长度（字节）是否必选ProductID产品标识string40MProductName产品名称string60MProductDesc产品描述string200MPurchaseType产品类型：0免费、1按次、5包月int10OFee产品标识价格（分）int10MEPGGroupNMBEPG分组编号string10O说明：1. 产品列表包含由用户未订购的增值业务产品；2. 请求同时传入UserToken和UserID做校验使用；3. 返回的产品列表，即Products参数，对应SOAP客户端，被自动解析成Object的形式，用Object需用类VasProductDetailResponseVO转义。2.3 产品信息详细查询接口方式：SOAP接口方向：增值业务入口-IPTV3A平台接口功能：获取单个增值业务产品的详细信息获取单个增值业务产品的详细信息请求参数名称说明数据类型长度（字节）是否必选SPIDSP的唯一标识string8