接口验证开发指南

版本: 1.7.0
日期: 2019-01-21

概述

通过CC直播间登录接口验证,客户的用户系统可对观看直播和回放的用户进行鉴权,并可以自定义头像信息、自定义UA及设置跑马灯参数。

验证接口说明

验证接口由客户进行开发,在学员登录时,由CC视频云平台将登录信息提交给该接口验证用户身份信息。

接口地址:

创建直播间时,验证方式选择接口验证并填写接口地址

请求方式:

POST

注意:请确保验证接口稳定性,请求超时时间为2s,超时默认为验证失败。

接口参数说明:

参数名称参数类型参数说明
userid字符串用户ID
roomid字符串直播间ID
viewername字符串登陆用户名,限制20个字符
viewertoken字符串登录校验码,限制40个字符
viewercustomua 字符串 可选,用户uatype信息,限制40个字符
liveid 字符串 观看回放验证时会传递该参数
recordid 字符串 观看回放验证时会传递该参数

返回值:

{
    "result": "ok",
    "message": "登录成功",
    "user":{
        "id": "E6A232B2DEDF69469C33DC5901307461",
        "name": "学员A",
        "groupid": "a1",
        "avatar": "http://domain.com/icon.png",
        "customua": "customua1",
        "viewercustommark": "mark1",
        "viewercustominfo": "{\"exportInfos\": [{\"key\": \"区域\", \"value\": \"北京\"}, {\"key\": \"城市\", \"value\": \"北京\"}, {\"key\": \"姓名\", \"value\": \"哈哈\"}, {\"key\": \"邮箱\", \"value\": \"someone@bokecc.com\"}]}",
        "marquee": "{\"loop\":-1,\"type\":\"text\",\"text\":{\"content\":\"跑马灯内容\",\"font_size\":20,\"color\":\"0xf0f00f\"},\"action\":[{\"duration\":4000,\"start\":{\"xpos\":0,\"ypos\":0,\"alpha\":0.5},\"end\":{\"xpos\":0.6,\"ypos\":0,\"alpha\":1}},{\"duration\":4000,\"start\":{\"xpos\":0,\"ypos\":0.7,\"alpha\":0.3},\"end\":{\"xpos\":0.7,\"ypos\":0.7,\"alpha\":0.9}}]}"
    }
}

返回值参数说明:

注意:返回的value都是string类型,需要带双引号

参数名称参数类型参数说明
result字符串验证结果,除“ok”外,云平台将其他结果均认为验证失败,即不允许登陆
message字符串当用户不能登陆(验证结果不为“ok”)时,展示给登陆用户的提示信息。(长度不能超过40个字符)
id字符串用户ID,不可为空,用户的唯一标示(长度不能超过40个字符)
name字符串用户名称,不可为空,在聊天室中显示该名称(长度不能超过20个字符)
groupid字符串分组id,仅支持数字和字母(区分大小写),最大长度40;格式错误默认为空
avatar字符串可选,用户的头像,在直播页面中显示该用户头像信息(长度不能超过400个字符,如果超过400个字符,登录会提示参数错误)
customua 字符串 可选,用户自定义UA信息(该信息不能包含\、/、|等特殊字符,长度不能超过50个字符),该信息用于统计用户观看直播的来源,可以在查询直播统计中获取
viewercustommark 字符串 可选,自定义用户标识信息(该信息不能包含\、/、|等特殊字符,长度不能超过300个字符),该信息用于个性化用户角色,可以在直播聊天信息中获取
viewercustominfo 字符串 可选,json格式字符串,自定义用户信息,该信息会记录在用户访问记录中,用于统计分析使用(长度不能超过2000个字符)
marquee字符串可选,json格式字符串,跑马灯信息(长度不能超过2000个字符)

跑马灯节点说明

{
    "loop": -1, // 循环次数,数据类型:int, -1表示无限循环
    "type": "text", // 跑马灯类型,字符串类型,值可为:text(文字),image(图片)
    "text": { // 当类型为text时,取该节点作为跑马灯内容
        "content": "跑马灯内容", // 跑马灯文字内容
        "font_size": 20, // 文字字体大小(单位:px)
        "color": "0xf0f00f" // 文字颜色,数据内容为16进制颜色
    },

    "image": { // 当类型为image时,取该节点作为跑马灯内容
        "image_url": "http://domain.com/marquee.png",
        "width": 100, // 图片宽度(单位:px)
        "height": 100 // 图片高度(单位:px)
    },

    "action": [ // 跑马灯的动作节点,可以定义一组动作,播放器会按顺序执行动作
        {
            "index": 0, // 动作的执行顺序,播放器从该值最小的动作开始执行
            "duration": 4000, // 动作的执行时间(单位:ms)
            "start": { // 动作起始点
                "xpos": 0, // 距离视频左上角原点水平距离,数据类型:float,取值范围:0~1,具体距离:视频宽度* xpos
                "ypos": 0, // 距离视频左上角原点垂直距离,数据类型:float,取值范围:0~1,具体距离:视频宽度* ypos
                "alpha": 0.5 // 透明度,取值范围:0~1
            },
            "end": { // 动作结束点
                "xpos": 0.6,
                "ypos": 0,
                "alpha": 1
            }
        },
        {
            "duration": 4000,
            "start": {
                "xpos": 0,
                "ypos": 0.7,
                "alpha": 0.3
            },
            "end": {
                "xpos": 0.7,
                "ypos": 0.7,
                "alpha": 0.9
            }
        }
    ]
}

注意:跑马灯功能目前仅支持PC网页端Flash播放器;

版本更新记录

更新日期 版本号 更新内容
2019-01-21 1.7.0 新增直播分组(groupid)
2018-10-31 1.6.0 新增自定义用户信息(viewercustominfo)
2017-11-28 1.5.0 新增自定义标识信息(viewercustommark)
2017-09-14 1.4.1 新增自定义ua(customua)
2017-06-22 1.4.0 新增跑马灯功能(marquee)

results matching ""

    No results matching ""