产品文档 直播技术文档 后台全局设置API接口

后台全局设置API接口

API列表

API 1 : 设置水印

【接口描述】

设置水印配置

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/setWatermark

【请求参数】

参数 类型 是否必填 默认值 描述
pos int 0 位置(左上、右上、右下、左下依次是1、2、3、4,0为不启用)
attachment file 水印图片(限制1M,文件不参与签名的计算)
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
pos int 1 位置(左上、右上、右下、左下依次是1、2、3、4,0为不启用)
watermark_img int 水印图片
{
    "code": 0,
    "data": {
        "pos" : 0,
        "watermark_img" : "http://img.baijiayun.com/img/logo/live_watermark.png" 
    },
    "msg": "",
    "ts": 1555407102
}

API 2 : 获取水印配置

【接口描述】

获取水印配置

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/getWatermark

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
pos string 1 位置(左上、右上、右下、左下依次是1、2、3、4,0为不启用)
watermark_img int 水印图片
{
    "code": 0,
    "data": {
        "pos" : 0,
        "watermark_img" : "http://img.baijiayun.com/img/logo/live_watermark.png" 
    },
    "msg": "",
    "ts": 1555407102
}

API 3 : 查看当前敏感词列表

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/getSensitiveWord

【请求参数】

参数 类型 是否必填 默认值 描述
page int 1 分页参数
page_size int 20 每页返回条数
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
id string 1 敏感词id
word int 敏感词 敏感词
{
    "code": 0,
    "data": {
        "total": 1,
        "list": [
            {
                "id": 31735,
                "word": "敏感词"
            }
        ],
    },
    "msg": "",
    "ts": 1556270426
}

API 4 : 添加敏感词

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/addSensitiveWordBatch

【请求参数】

参数 类型 是否必填 默认值 描述
words string 用逗号,分开的敏感词
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
total int 2 添加的敏感词数量
{
    "code": 0,
    "data": {
        "total" : 2
    },
    "msg": "",
    "ts": 1556270426
}

API 5 : 删除敏感词

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/deleteSensitiveWordBatch

【请求参数】

参数 类型 是否必填 默认值 描述
ids string 用逗号,分开的敏感词id
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
{
    "code": 0,
    "data":null,
    "msg": "",
    "ts": 1556270426
}

API 6 : 获取跑马灯设置

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/getLiveHorseLamp

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
type int 1 0 关闭 1固定值 2 昵称
value string 百家云 跑马灯
color string #ffffff 颜色
font_size string 16 直播跑马灯字体大小
opacity float 0.3 直播跑马灯的不透明度
{
    "code": 0,
    "data": {
        "type": 1,
        "value": "跑马灯",
        "color": "#ffffff",
        "font_size": 16,
        "opacity": 0.3
    },
    "msg": "",
    "ts": 1556271229
}

API 7 : 设置跑马灯设置

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/setLiveHorseLamp

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
type int 0 关闭 1固定值 2 昵称
value string 跑马灯
color string 颜色
font_size string 直播跑马灯字体大小
opacity float 直播跑马灯不透明度
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
type int 1 0 关闭 1固定值 2 昵称
value string 百家云 跑马灯
color string #ffffff 颜色
font_size string 16 直播跑马灯字体大小
opacity float 0.3 直播跑马灯的不透明度
{
    "code": 0,
    "data": {
        "type": 1,
        "value": "百家云",
        "color": "#ffffff",
        "font_size": 16,
        "opacity": 0.3
    },
    "msg": "",
    "ts": 1556271229
}

API 8 : 添加公告模板

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/addNotice

【请求参数】

参数 类型 是否必填 默认值 描述
content int 内容
link int 链接
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
{
    "code": 0,
    "data": {
        "id" : 2999
    },
    "msg": "",
    "ts": 1556271229
}

API 9 : 获取公告列表

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/getNoticeList

【请求参数】

参数 类型 是否必填 默认值 描述
page int 1 分页参数
page_size int 20 每页返回条数
query string 关键字查询
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
id int 1 id
content string 公告 公告内容
link string http://www.baidu.com 跳转链接
{
    "code": 0,
    "data": {
        "list": [
            {
                "id": 2087,
                "content": "公告",
                "link": "http://www.baidu.com",
                "create_time": "2019-04-26 17:43:21",
            }
        ],
        "total": 1
    },
    "msg": "",
    "ts": 1556272382
}

API 10 : 删除公告

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/deleteNoticeBatch

【请求参数】

参数 类型 是否必填 默认值 描述
ids int 逗号(,)分开的id
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
{
    "code": 0,
    "data": null,
    "msg": "",
    "ts": 1556272382
}

API 11 : 添加小测

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/addQuiz

【请求参数】

参数 类型 是否必填 默认值 描述
is_force int 0 是否强制参加
attachment file 小测模板excel表格(文件不参与签名的计算)
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
{
    "code": 0,
    "data": {
        "id": 4361
    },
    "msg": "",
    "ts": 1556272382
}

API 12 : 获取小测模板

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/getQuizList

【请求参数】

参数 类型 是否必填 默认值 描述
page int 1 分页参数
page_size int 20 每页返回条数
query string 关键字查询
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
title int 试卷标题
display_order int 0 排序
is_force int 1 是否强制参与
question_total int 4 题目数量
create_time string "2019-04-27 16:20:35" 创建时间
{
    "code": 0,
    "data": {
        "list": [
            {
                "id": 4359,
                "title": "期中测验111",
                "create_time": "2019-04-27 16:20:35",
                "is_force": 1,
                "question_total": 4
            }
        ],
        "total": 1
    },
    "msg": "",
    "ts": 1556353235
}

API 13 : 删除小测模板

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/deleteQuiz

【请求参数】

参数 类型 是否必填 默认值 描述
id int 2 id
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
{
    "code": 0,
    "data": null,
    "msg": "",
    "ts": 1556353235
}

API 14 : 小测关联直播间

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/quiz/assignRoomPaper

【请求参数】

参数 类型 是否必填 默认值 描述
paper_ids string 逗号分开的试卷id
room_id int 教室号
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
{
    "code": 0,
    "data": null,
    "msg": "",
    "ts": 1559112264
}

API 15 : 查看教室小测

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/quiz/getRoomQuizList

【请求参数】

参数 类型 是否必填 默认值 描述
room_id int 教室号
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
room_id int 19052766739617 教室号
paper_id int 4529 教室小测id
parent_paper_id int 4359 小测模板id
title string 期中测验111 标题
{
    "code": 0,
    "data": {
        "list": [
            {
                "room_id": 19052766739617,
                "partner_id": 32958888,
                "paper_id": 4529,
                "create_time": "2019-05-29 14:44:23",
                "update_time": "2019-05-29 14:44:23",
                "parent_paper_id": 4359,
                "title": "期中测验111",
                "file_name": "小测模板 (1).xlsx",
                "is_force": 1
            },
            {
                "room_id": 19052766739617,
                "partner_id": 32958888,
                "paper_id": 4528,
                "create_time": "2019-05-29 14:42:58",
                "update_time": "2019-05-29 14:42:58",
                "parent_paper_id": 4359,
                "title": "期中测验111",
                "file_name": "小测模板 (1).xlsx",
                "is_force": 1
            }
        ],
        "total": 2
    },
    "msg": "",
    "ts": 1559114050
}

API 16 : 删除教室小测

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/quiz/batchDeleteRoomPaper

【请求参数】

参数 类型 是否必填 默认值 描述
room_id int 教室号
paper_ids string 逗号分开的id
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
{
    "code": 0,
    "data": null,
    "msg": "",
    "ts": 1559114364
}

API 17 : 查看教室公告

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/notice/getRoomNoticeList

【请求参数】

参数 类型 是否必填 默认值 描述
room_id int 教室号
partner_id int
product_type int 0 1大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
room_id int 19052766739617 教室号
content string 公告内容2 内容
link string http://www.baijiayun.com 链接
create_time string "2019-04-27 16:20:35" 创建时间
{
    "code": 0,
    "data": {
        "list": [
            {
                "room_id": 19052766739617,
                "id": 2095,
                "content": "公告内容2",
                "link": "http://www.baijiayun.com",
                "create_time": "2019-05-07 14:42:29"
            }
        ],
        "total": 1
    },
    "msg": "",
    "ts": 1559114668
}

API 18 : 绑定教室公告

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/notice/assignRoomNotice 

【请求参数】

参数 类型 是否必填 默认值 描述
room_id int 教室号
notice_ids string 逗号分开的id
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
{
    "code": 0,
    "data": null,
    "msg": "",
    "ts": 1559114614
}

API 19 : 删除教室公告

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/notice/batchDeleteRoomNotice 

【请求参数】

参数 类型 是否必填 默认值 描述
room_id int 教室号
notice_ids string 逗号分开的id
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
{
    "code": 0,
    "data": null,
    "msg": "",
    "ts": 1559114614
}

API 20 : 修改红包最大个数限制

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/setMaxRedPackageCount

【请求参数】

参数 类型 是否必填 默认值 描述
max_count int 最大红包限制个数,最大不超过1000
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
max_count int 1000 最大红包限制个数
{
    "code": 0,
    "data": {
        "max_count": 800
    },
    "msg": "",
    "ts": 1572858029
}

API 21 : 获取红包最大个数限制

【接口描述】

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_setting/getMaxRedPackageCount

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int
product_type int 0 1:大班课,2,小班课,3:双师,4,企业直播(单一产品线账号不需要传此参数)
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例 描述
max_count int 1000 最大红包限制个数
{
    "code": 0,
    "data": {
        "max_count": 800
    },
    "msg": "",
    "ts": 1572858029
}