GY∕T 346-2021 IPTV集成播控平台与传输系统用户“双认证、双计费”接口规范(广播电影电视).pdf

GY 中华人民共和国广播电视和网络视听行业标准 GY/T 3462021 IPTV 集成播控平台与传输系统 用户“双认证、双计费”接口规范 Specification of interfaces for user “double authentication and accounting” for both IPTV integrated playout management platform and transmission system 2021-02-26 发布 2021-02-26 实施 国家广播电视总局 发 布 GY/T 3462021 I 目 次 前言 . II 1 范围 . 1 2 规范性引用文件 . 1 3 术语、定义和缩略语 . 1 3.1 术语和定义 . 1 3.2 缩略语 . 1 4 接口概述 . 1 5 业务流程描述 . 2 5.1 开通/销户流程 . 2 5.2 认证流程 . 3 5.3 鉴权流程 . 4 5.4 计费流程 . 5 6 接口要求 . 7 6.1 接口交互机制 . 7 6.2 创建用户接口 . 8 6.3 修改用户状态接口 . 10 6.4 用户认证接口 . 11 6.5 业务鉴权接口 . 12 6.6 产品订购/退订同步接口 . 14 6.7 支付结果同步接口 . 15 参考文献 . 16 GY/T 3462021 II 前 言 本文件按照GB/T 1.12020标准化工作导则 第1部分：标准化文件的结构和起草规则的规定起草。 请注意本文件的某些内容可能涉及专利。本文件发布机构不承担识别这些专利的责任。 本文件由全国广播电影电视标准化技术委员会（SAC/TC 239）归口。 本文件起草单位：国家广播电视总局广播电视科学研究院、爱上电视传媒(北京)有限公司、广西广电新媒体有限公司、中广电广播电影电视设计研究院、国家广播电视总局监管中心、北京广播电视台、广西广播电视台、百视通网络电视技术发展有限责任公司、湖南广播电视台、咪咕文化科技有限公司、中国联合网络通信有限公司网络技术研究院、天翼智慧家庭科技有限公司。 本文件主要起草人：尹亚光、张伟、潘红梅、徐磊、孙海波、陈哲、王新喆、赵志成、施玉海、杨凯、李良、张琪、锁强、王慧、李洁、祝谷乔、何晶、赵耀峰、刘万年、万时华、于鼎、张帆。 GY/T 3462021 1 IPTV 集成播控平台与传输系统用户“双认证、双计费”接口规范 1 范围 本文件规定了IPTV集成播控平台与传输系统之间 “双认证、 双计费” 的主要对接流程， 定义了用户、认证、计费相关的接口规范。 本文件适用于IPTV集成播控平台和IPTV传输系统采用“双认证、双计费”方式的规划、设计、建设、运行、管理和维护。 2 规范性引用文件 本文件没有规范性引用文件。 3 术语、定义和缩略语 3.1 术语和定义 下列术语和定义适用于本文件。 3.1.1 双认证、双计费 double authentication and accounting IPTV集成播控平台与IPTV传输系统双方对用户的认证、鉴权、计费。 3.1.2 IPTV 集成播控平台 IPTV integrated playout management platform 负责对IPTV业务进行集成播出控制管理。 3.1.3 IPTV 传输系统 IPTV transmission system 负责为IPTV集成播控平台与用户端之间提供信号传输分发，为IPTV用户提供有保障的服务。 3.2 缩略语 下列缩略语适用于本文件。 HTTP 超文本传输协议（HyperText Transfer Protocol） JSON JavaScript对象表示法（JavaScript Object Notation） REST 表述性状态传递（Representational State Transfer） URL 统一资源定位符（Uniform Resource Locator） 4 接口概述 IPTV集成播控平台与IPTV传输系统之间的“双认证、双计费”接口，实现用户信息和用户状态的同步，实现双方同时进行用户认证、实现双方协同进行订购计费的功能。“双认证、双计费”接口示意图见图1。 GY/T 3462021 2 用户信息包括但不限于：用户标识、IPTV用户终端MAC地址、设备编号、归属省份、归属地市等。 用户状态包括但不限于：未激活、激活、停机、销户等。 用户管理IPTVIPTV集成播控平台集成播控平台认证、鉴权、计费用户管理IPTVIPTV传输系统传输系统用户终端软件认证、鉴权、计费用户注册认证信息鉴权信息计费信息认证信息鉴权信息计费信息计费信息IPTVIPTV用户终端用户终端 图1 “双认证、双计费”接口示意图 5 业务流程描述 5.1 开通/销户流程 用户在IPTV传输系统中开通/销户业务，IPTV传输系统需要向IPTV集成播控平台同步用户及业务信息。用户开通/ /销户流程图见图2。 GY/T 3462021 3 用户IPTV传输系统IPTV集成播控平台a）用户申请开通/销户b）处理开通/销户申请c）用户信息同步d）处理用户信息e）用户信息同步响应f）用户开通/销户响应IPTV集成播控平台 图2 用户开通/销户流程图 流程说明： a) 用户向 IPTV 传输系统发起开通/销户请求； b) IPTV 传输系统处理用户开通/销户申请； c) IPTV 传输系统将用户信息同步到 IPTV 集成播控平台，接口见 6.2，在使用过程中，用户及业务状态发生变化的时候，需要调用接口 6.3，修改用户状态； d) IPTV 集成播控平台处理用户信息； e) IPTV 集成播控平台应答用户信息同步结果； f) IPTV 传输系统向用户反馈用户开通/销户成功的信息。 5.2 认证流程 IPTV用户终端开机时，需要向IPTV集成播控平台进行认证，认证通过后才可以使用IPTV业务。 其中，采用双认证双计费方式的IPTV用户终端需要向IPTV集成播控平台和IPTV传输系统进行认证。只有双方认证都通过， 才可以使用IPTV业务。 IPTV集成播控平台用户管理系统中的用户账户应当与IPTV传输系统用户管理系统中的用户账户实现一一对应。 IPTV双认证流程图见图3。 GY/T 3462021 4 用户终端IPTV传输系统IPTV集成播控平台a）开机认证请求b）认证处理c）传输系统认证结果f）播控平台认证结果g）处理认证结果d）开机认证请求e）认证处理用户终端IPTV传输系统IPTV集成播控平台 图3 IPTV 双认证流程图 流程说明： a) 用户终端向 IPTV 传输系统发送认证请求，接口见 6.4； b) IPTV 传输系统进行认证处理； c) IPTV 传输系统返回认证结果； d) 用户终端向 IPTV 集成播控平台发送认证请求，接口见 6.4； e) IPTV 集成播控平台进行认证处理； f) IPTV 集成播控平台返回认证结果； g) 用户终端处理认证结果，两次认证都通过，用户可以使用 IPTV 业务，否则在用户终端提示认证失败信息。 5.3 鉴权流程 在“双认证、双计费”方式下，用户终端播放节目前需要到IPTV集成播控平台进行鉴权或到IPTV集成播控平台及IPTV传输系统进行双鉴权。 IPTV业务双鉴权流程图见图4。 GY/T 3462021 5 用户终端IPTV传输系统IPTV集成播控平台a）业务鉴权请求b）业务鉴权处理c）业务鉴权结果f）业务鉴权结果g）处理鉴权结果d）业务鉴权请求e）业务鉴权处理用户终端IPTV传输系统IPTV集成播控平台 图4 IPTV 业务双鉴权流程图 流程说明： a) 用户终端请求 IPTV 传输系统进行业务鉴权，接口见 6.5； b) IPTV 传输系统进行业务鉴权； c) IPTV 传输系统返回鉴权结果； d) 用户终端请求 IPTV 集成播控平台进行业务鉴权，接口见 6.5； e) IPTV 集成播控平台进行业务鉴权； f) IPTV 集成播控平台返回鉴权结果； g) 用户终端处理鉴权结果，如果鉴权失败，用户终端上显示订购列表，可以提示用户订购，跳转到计费流程。 5.4 计费流程 对于增值付费内容产品，需要先订购才能观看。IPTV增值付费内容产品的订购，由IPTV集成播控平台和IPTV传输系统共同完成。 IPTV产品订购/退订双计费流程图见图5。 GY/T 3462021 6 用户终端IPTV传输系统IPTV集成播控平台a）发起订购/退订请求b）处理订单c）同步订单信息d）订单信息同步响应e）返回订购/退订响应f）发起支付/退费请求j）返回支付/退费结果h）同步支付/退费结果i）支付/退费结果同步响应g）支付/退费处理 图5 IPTV 产品订购/退订双计费流程图 流程说明： a) 用户在终端上选择订购/退订产品，向 IPTV 集成播控平台发起订购/退订请求； b) IPTV 集成播控平台收到订购/退订请求后，生成订单信息； c) IPTV 集成播控平台向 IPTV 传输系统同步订单信息，接口见 6.6； d) IPTV 传输系统返回订单信息同步的响应； e) IPTV 集成播控平台向用户终端返回订购/退订响应； f) 用户终端向 IPTV 集成播控平台发起支付/退费请求； g) IPTV 集成播控平台进行支付/退费处理； h) IPTV 集成播控平台向 IPTV 传输系统同步支付/退费结果，接口见 6.7； i) IPTV 传输系统返回支付/退费结果同步的消息； j) IPTV 集成播控平台向用户终端返回支付/退费结果； 根据当前业务开展情况，IPTV集成播控平台可通过IPTV传输系统进行支付和退费。 其产品订购/退订的双计费流程图见图6。 GY/T 3462021 7 用户终端IPTV传输系统IPTV集成播控平台a）发起订购/退订请求b）处理订单c）同步订单信息e）返回订购/退订响应g）支付/退费处理d）订单信息同步响应用户终端IPTV传输系统IPTV集成播控平台f)发起支付/退费请求h)返回支付/退费结果i)同步支付/退费结果j)支付/退费结果同步响应 图6 IPTV 产品订购/退订流程图 流程说明： a) 用户在终端上选择订购/退订产品，向 IPTV 集成播控平台发起订购/退订请求； b) IPTV 集成播控平台收到订购/退订请求后，生成订单信息； c) IPTV 集成播控平台向 IPTV 传输系统同步订单信息，接口见 6.6； d) IPTV 传输系统返回订单信息同步的响应； e) IPTV 集成播控平台向用户终端返回订购/退订响应； f) 用户终端向 IPTV 传输系统发起支付/退费请求； g) IPTV 传输系统进行支付/退费处理； h) IPTV 传输系统向用户终端返回支付/退费结果； i) IPTV 传输系统向 IPTV 集成播控平台同步支付/退费结果，接口见 6.7； j) IPTV 集成播控平台返回支付/退费结果同步的消息。 6 接口要求 6.1 接口交互机制 GY/T 3462021 8 接口采用RESTful API，用JSON描述和实现，HTTP POST请求的header参数需要指定Content-Type：application/json。 注：RESTful 是一种网络应用程序的设计风格和开发方式。 接口交互流程见图7。 用户终端b）发送请求数据a）构造请求数据e）发送响应请求c）业务处理接口请求方接口响应方d)构造响应数据 图7 接口交互流程图 6.2 创建用户接口 6.2.1 接口描述 接口功能：在用户开通的时候，传输系统向集成播控平台同步用户数据和业务数据。 接口方向：传输系统至集成播控平台。 6.2.2 请求数据 创建用户请求的数据见表1。 表1 创建用户请求数据 参数 数据类型 是否必选 说明 UserID String 是 用户标识 FatherAccount String 否 主账号 AccountType Int 是 账号类型 Password String 否 密码 SPID String 否 播控平台的唯一标识 DeviceID String 否 设备编号 MAC String 否 IPTV 用户终端 MAC 地址，格式为：xx:xx:xx:xx:xx:xx GY/T 3462021 9 表 1（续） 参数 数据类型 是否必选 说明 Carrier Int 是 运营商类型： 0：未知 1：电信 2：联通 3：移动 4：预留 Province String 是 归属省份 City String 是 归属地市 Region String 否 归属区域 TradeFlag Int 是 业务类型： 1：标清 2：高清 3：超高清 TeamID Int 是 分组： 0：公众 1：行业 9：测试 默认为 0 UserType Int 是 付费类型： 0：后付费 1：预付费 默认为 0 Fee Int 否 预付金额（单位为分） EpgGroup String 否 EPG 分组 UserGroup String 否 用户分组 State Int 是 状态： 0：未激活（开通） 1：激活（正常） 2：停机 3：销户 默认为 1 ProductList String 是 产品列表以逗号(,)分隔，如果有多个已订购/退订产品，以逗号分开 ActiveTime String 是 生效时间： YYYYMMDDhhmmss 如果有多个已订购/退订产品，以逗号分开 UpdateTime String 是 变更时间： YYYYMMDDhhmmss 如果有多个已订购/退订产品，以逗号分开 GY/T 3462021 10 表 1（续） 参数 数据类型 是否必选 说明 ExpireTime String 是 失效时间： YYYYMMDDhhmmss 如果有多个已订购/退订产品，以逗号分开 UserName String 否 用户姓名 TelePhone String 否 电话 Address String 否 地址 IDNumber String 否 身份证号 Gender Int 否 性别： 0：男 1：女 6.2.3 返回数据 创建用户返回的数据见表2。 表2 创建用户返回数据 参数 数据类型 是否必选 说明 ResultCode Int 是 返回信息代码： 0：成功 其他：失败 ResultMessage String 是 返回信息描述 6.3 修改用户状态接口 6.3.1 接口描述 接口功能：当用户状态（销户，产品变更，停机等）发生变化时，传输系统向集成播控平台同步用户状态变化数据。 接口方向：传输系统至集成播控平台。 6.3.2 请求数据 修改用户状态请求的数据见表3。 表3 修改用户状态请求数据 参数 数据类型 是否必选 说明 SPID String 是 播控平台的唯一标识 UserID String 是 用户标识 GY/T 3462021 11 表 3（续） 参数 数据类型 是否必选 说明 Status String 是 用户状态： 0：To be activated 待激活 1：Normal 正常 2：OweFee 欠费 3：Stop 停机 4：Terminated 已销户 5：HalfStop 暂停 6：UserHalfStop 暂停 10：申请销户 6.3.3 返回数据 修改用户状态返回数据见表4。 表4 修改用户状态返回数据 参数 数据类型 是否必选 说明 ResultCode Int 是 返回信息代码： 0：成功 其他：失败 ResultMessage String 是 返回信息描述 注1：“拆机”用户(Status = 4)不能修改用户状态。 注2：“待激活”用户(Status = 0)不能修改为除正常用户(Status = 1)以外的其他用户状态。 注3：“正常”用户(Status = 1)不能修改为待激活用户(Status = 0)。 6.4 用户认证接口 6.4.1 接口描述 接口功能：用户终端分别到IPTV集成播控平台和IPTV传输系统进行开机认证。 接口方向：用户终端至IPTV集成播控平台；用户终端至IPTV传输系统。 6.4.2 请求数据 用户认证请求的数据见表5。 表5 用户认证请求数据 参数 数据类型 是否必选 说明 UserID String 是 用户标识 DeviceID String 否 设备编号 MAC String 否 IPTV 用户终端 MAC 地址，格式为：xx:xx:xx:xx:xx:xx Action String 是 “Login”表示登录 “Logout”表示注销 GY/T 3462021 12 6.4.3 返回数据 用户认证返回的数据见表6。 表6 用户认证返回数据 参数 数据类型 是否必选 说明 Result Int 是 返回结果： 0：成功 其他：失败 Description String 否 结果描述，小于 256 字节 UserToken String 是 用户登录的临时令牌，后续业务鉴权及订购消息需传此令牌，32 字节 TokenExpiredTime String 否 UserToken 的失效时间，格式为：YYYYMMDDhhmmss。 缺少该参数表示在一次登录期间，永久有效。 UserGroupNMB String 否 用户对应的用户分组信息标识 EPGGroupNMB String 是 用户对应的 EPG 分组信息标识 EpgUrl String 否 播控侧的 EPG 首页 Products String 否 用户已购买的产品编号组合，组合间采用“； ”分隔，组合内采用“， ”分隔，分别为产品 ID，内容 ID，可以为以下情形： a) ProductID：表示整个产品的订购关系，且有效期未知； b) ProductID,ExpiredTime：表示整个产品的订购关系，且存在有效期； c) ProductID,ContentID：未知有效期的单片内容订购关系； d) ProductID,ExpiredTime,ContentID： 存在有效期的单片内容订购关系。 6.5 业务鉴权接口 6.5.1 接口描述 接口功能：用户终端调用IPTV集成播控平台接口或者IPTV传输系统接口，进行业务鉴权。 接口方向：用户终端至IPTV集成播控平台；用户终端至IPTV传输系统。 6.5.2 请求数据 业务鉴权请求的数据见表7。 表7 业务鉴权请求数据 参数 数据类型 是否必选 说明 SPID String 否 播控平台的唯一标识 UserID String 是 用户标识 UserToken String 是 用户登录的临时令牌，业务鉴权及订购消息需传此令牌，32 字节。 接口 6.4 用户认证时返回结果中的数据 ContentID String 是 IPTV 内容编号，代表需要鉴权的点播或直播节目编号 TimeStamp Int 是 从 1970 年 1 月 1 日 0 时开始的毫秒数 DeviceID String 否 设备编号 GY/T 3462021 13 表 7（续） 参数 数据类型 是否必选 说明 IP String 否 终端 IP 地址 MAC String 否 IPTV 用户终端 MAC 地址，格式为：xx:xx:xx:xx:xx:xx TransactionID String 否 事务编号 6.5.3 返回数据 业务鉴权返回数据见表8，产品定义数据结构见表9。 表8 业务鉴权返回数据 参数 数据类型 是否必选 说明 Result Int 是 返回结果： 0：成功 其他：失败 UserToken String 是 用户登录的临时令牌，后续业务鉴权及订购消息需传此令牌，32 字节 ProductID String 否 产品 ID ServiceID String 否 服务 ID ContentID String 是 内容 ID DeviceID String 否 设备编号 IP String 否 终端 IP 地址 MAC String 否 IPTV 用户终端 MAC 地址，格式为：xx:xx:xx:xx:xx:xx TransactionID String 否 事务编号 ExpiredTime String 否 本订购关系的鉴权失效时间，用绝对时间标识。 格式为：YYYYMMDDhhmmss。 如本参数为空，代表长期有效。如本参数为当前时间，代表鉴权一次性有效。 ProductList Product 否 可订购产品列表，在订购失败并返回“用户未订购”的情况下携带该参数。可订购产品定义的数据结构见表 9。 表9 产品定义数据结构 参数 数据类型 是否必选 说明 ProductID String 是 产品 ID ProductName String 是 产品名称 Fee Int 是 产品价格（单位为分） PurchaseType Int 否 0：包月 3：PPV ProdcutDesc String 否 产品描述 ListPrice Int 否 标称价格（单位为分） RentalTerm Int 否 租期（单位为天） LimitTimes Int 否 可使用次数 GY/T 3462021 14 6.6 产品订购/退订同步接口 6.6.1 接口描述 接口功能：IPTV集成播控平台向IPTV传输系统同步产品订购/退订信息。 接口方向：IPTV集成播控平台至IPTV传输系统。 6.6.2 请求数据 实时订购/退订请求的数据见表10。 表10 实时订购/退订请求数据 参数 数据类型 是否必选 说明 SPID String 是 合作方 ID TransactionID String 是 事务编号 UserID String 是 用户标识 DeviceID String 否 设备编号 PackageID String 否 产品包编号，每次交易 PackageID、ProductID 只能选择一个 ProductID String 是 产品编号，每次交易 PackageID、ProductID 只能选择一个 ProgramID String 否 触发订购/退订的节目 ID ProgramName String 否 触发订购/退订的节目名称 ColumnID String 否 触发订购/退订的栏目 ID ColumnName String 否 触发订购/退订的栏目名称 NotifficationURL String 否 订购/退订完成后的，异步通知地址 Fee Int 是 消费金额（单位为分） ReturnURL String 否 订购/退订成功时，返回 EPG 服务页面的 URL，适合 BS 方式的 EPG 服务 Action Int 是 1：订购 2：退订 TimeStamp Int 是 从 1970 年 1 月 1 日 0 时开始的毫秒数 6.6.3 返回数据 IPTV传输系统接到产品订购/退订信息后，向IPTV集成播控平台返回响应。 实时订购/退订返回数据见表11。 表11 实时订购/退订返回数据 参数 数据类型 是否必选 说明 Result Int 是 接收结果： 0：成功 其他：失败 Description String 否 接收结果描述 TransactionID String 否 事务编号 GY/T 3462021 15 6.7 支付结果同步接口 6.7.1 接口描述 接口功能：IPTV传输系统与IPTV集成播控平台之间同步支付结果信息，确保双方订购数据一致。 接口方向：IPTV集成播控平台至IPTV传输系统（当IPTV集成播控平台进行支付处理时）；或IPTV传输系统至IPTV集成播控平台（当IPTV传输系统进行支付处理时）。 6.7.2 请求数据 支付结果同步请求的数据见表12。 表12 支付结果同步请求数据 参数 数据类型 是否必选 说明 TransactionID String 是 事务编号 Result Int 是 支付结果： 0：成功 其他：失败 Description String 否 结果描述 TimeStamp Int 是 从 1970 年 1 月 1 日 0 时开始的毫秒数 6.7.3 返回数据 IPTV传输系统接到支付结果信息后，向IPTV集成播控平台返回响应，响应数据见表13。 表13 支付结果同步响应数据 参数 数据类型 是否必选 说明 Result Int 是 接收结果： 0：成功 其他：失败 Description String 否 结果描述 TransactionID String 否 事务编号 GY/T 3462021 16 参 考 文 献 1 关于当前阶段IPTV集成播控平台建设管理有关问题的通知（新广电发201597号） 2 IPTV集成播控平台与传输系统规范对接工作方式（广电发201976号）