产品文档直播技术文档子账号相关API接口文档

子账号相关API接口文档

概述

本文档主要提供子账号的一些管理功能。

请求域名

以下接口请求地址中的${private_domin}部分需要换成客户的专属域名，具体请参考专属域名说明

服务端API接口

API 1 : 查询子账号列表

【功能描述】

查询子账号列表

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/new_sub/getSubAccountList

【请求参数】

参数	类型	是否必填	默认值	描述
`partner_id`	int	是		合作方用户名
`status`	int	否	0	账号状态 0:全部 1:使用中 2:停用或未开通的
`page`	string	否	1	页码，默认第一页
`page_size`	string	否	20	每页条数，默认10条
`timestamp`	int	是		当前时间，unix时间戳
`sign`	string	是		签名

【返回参数】

参数	类型	描述
`partner_id`	int	合作方用户名
`mobile`	string	注册手机号
`email`	string	邮箱
`contacts`	string	联系人
`company`	string	公司名
`effect_time`	string	账号生效时间
`expire_time`	string	账号失效时间
`large_class_status`	int	大班课产品线状态 0未开通，1开通，2关闭
`small_class_status`	int	小班课产品线状态 0未开通，1开通，2关闭
`business_status`	int	企业直播产品线状态 0未开通，1开通，2关闭
`video_status`	int	点播产品线状态 0未开通，1开通，2关闭

【返回示例】

{
    "code": 0,
    "data": {
        "total": 30,
        "list": [
            {
                "company": "",
                "partner_id": 87434923,
                "email": "12300000023@qq.com",
                "mobile": "12300000023",
                "contacts": "",
                "effect_time": "2020-07-15 19:26:53",
                "expire_time": "2020-07-21 23:59:59",
                "product_status": {
                    "large_class_status": 2,
                    "small_class_status": 2,
                    "business_status": 2,
                    "video_status": 0
                }
            }
        ]
    },
    "msg": "",
    "ts": 1600315898
}

API 2 : 添加子账号

【功能描述】

添加子账号

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/new_sub/addSubAccount

【请求参数】

参数	类型	是否必填	默认值	描述
partner_id	int	是		合作方用户名
mobile	string	是		手机号
email	string	是		邮箱
password	string	是		密码
effect_time	string	是		生效时间
expire_time	string	是		失效时间
large_class_user_limit	int	否	0	大班课并发上限，（并发计费模式设置有效，其他计费类型设置此字段没有作用）
large_class_max_user_limit	int	否	0	大班课可超出使用的并发上限（并发计费模式设置有效，其他计费类型设置此字段没有作用）
business_user_limit	int	否	0	企业直播并发上限（并发计费模式设置有效，其他计费类型设置此字段没有作用）
business_max_user_limit	int	否	0	企业直播可超出使用的并发上限（并发计费模式设置有效，其他计费类型设置此字段没有作用）
large_class_live_max_speakers	int	否	0	大班课可上麦人数
business_live_max_speakers	int	否	0	企业直播可上麦人数
large_class_status	int	否	0	是否开通大班课产品线, 0否，1是
small_class_status	int	否	0	是否开通小班课产品线, 0否，1是
business_status	int	否	0	是否开通企业直播产品线, 0否，1是
credit_money	int	否	0	子账号信用度
flow	int	否	0	流量,按量计费设置此字段不生效
max_flow	int	否	0	最大可使用的流量，按量计费设置此字段不生效
storage_limit	int	否	0	存储，按量计费设置此字段不生效
max_storage_limit	int	否	0	最大可使用的存储，按量计费设置此字段不生效
company	string	否		公司
contacts	string	否		联系人
video_status	int	否	0	点播状态 0不开通，1开通
`timestamp`	int	是		当前时间，unix时间戳
`sign`	string	是		签名

【返回参数】

参数	类型	示例	描述
`partner_id`	int		合作方用户名

【返回示例】

{
    "code": 0,
    "data": {
        "partner_id": "87510563"
    },
    "msg": "",
    "ts": 1600169832
}

API 3 : 获取账号信息

【功能描述】

获取账号信息

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/new_sub/getAccountInfo

【请求参数】

参数	类型	是否必填	默认值	描述
`partner_id`	int	是		合作方用户名
sub_partner_id	int	是		子账号partner_id

【返回参数】

参数	类型	描述
partner_id	int	合作方用户名
mobile	string	手机号
email	string	邮箱
password	string	密码
effect_time	string	生效时间
expire_time	string	失效时间
large_class_user_limit	int	大班课并发上限
large_class_max_user_limit	int	大班课可超出使用的并发上限
business_user_limit	int	企业直播并发上限
business_max_user_limit	int	企业直播并发上限可超出使用的并发上限
large_class_live_max_speakers	int	大班课可上麦人数
business_live_max_speakers	int	企业直播可上麦人数
large_class_status	int	是否开通大班课产品线, 0未开通，1开通,2关闭
small_class_status	int	是否开通小班课产品线, 0未开通，1开通,2关闭
business_status	int	是否开通企业直播产品线, 0未开通，1开通,2关闭
credit_money	int	子账号信用额度
flow	int	可用流量
max_flow	int	最大可使用的流量
storage_limit	int	可用存储
max_storage_limit	int	最大可使用的存储
company	string	公司
contacts	string	联系人
video_status	int	点播状态
partner_key	string	开发者信息，partner_key
private_domain	string	专属域名
secret_key	string	开发者信息，secret_key

【返回示例】

{
    "code": 0,
    "data": {
        "mobile": "12700000011",
        "email": "12700000011@123.com",
        "effect_time": "2020-01-01 00:00:00",
        "expire_time": "2021-01-01 00:00:00",
        "large_class_user_limit": 1,
        "large_class_max_user_limit": 2,
        "large_class_status": 2,
        "large_class_live_max_speakers": 2,
        "business_live_max_speakers": 2,
        "business_user_limit": 1,
        "business_max_user_limit": 2,
        "business_status": 2,
        "small_class_status": 2,
        "credit_money": 300,
        "flow": 2,
        "max_flow": 3,
        "storage_limit": 2,
        "max_storage_limit": 3,
        "company": "公司",
        "contacts": "联系人",
        "video_status": 2,
        "partner_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "private_domain": "exxxxxxxxxx",
        "secret_key": "xxxxxxxxxxx"
    },
    "msg": "",
    "ts": 1600316373
}

API 4 : 设置直播产品

【功能描述】

设置直播产品

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/new_sub/setLiveAccount

【请求参数】

参数	类型	是否必填	描述
partner_id	int	是	partner_id
sub_partner_id	int	是	子账号partner_id
product_type	int	是	产品线 1大班课，2小班课，4企业直播
user_limit	int	是	可用并发,非并发计费账号传0
max_user_limit	int	是	最大可用并发，非并发计费账号传0
status	int	否	产品线状态，0关1开
live_max_speakers	int	否	可上麦人数

【返回参数】

参数	类型	示例	描述

【返回示例】

{
    "code": 0,
    "data": null,
    "msg": "",
    "ts": 1600176725
}

API 5 : 设置点播产品

【功能描述】

设置点播产品

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/new_sub/setVideoAccount

【请求参数】

参数	类型	是否必填	描述
partner_id	int	是	partner_id
sub_partner_id	int	是	子账号partner_id
flow	int	是	流量 (点播按量计费的账号传0)
max_flow	int	是	最大可使用的流量 (点播按量计费的账号传0)
storage_limit	int	是	存储 (点播按量计费的账号传0)
max_storage_limit	int	是	最大可使用的存储(点播按量计费的账号传0)
status	int	否	点播状态

【返回参数】

参数	类型	示例	描述

【返回示例】

{
    "code": 0,
    "data": null,
    "msg": "",
    "ts": 1600176725
}

API 6 : 设置信用额度

【功能描述】

设置信用额度

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/new_sub/setCreditMoney

【请求参数】

参数	类型	是否必填	描述
partner_id	int	是	partner_id
sub_partner_id	int	是	子账号partner_id
credit_money	int	是	信用额度

【返回参数】

参数	类型	示例	描述

【返回示例】

{
    "code": 0,
    "data": null,
    "msg": "",
    "ts": 1600176725
}

API 7 : 停用/启用账号

【功能描述】

停用/启用账号

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/new_sub/setAccountStatus

【请求参数】

参数	类型	是否必填	描述
partner_id	int	是	partner_id
sub_partner_id	int	是	子账号partner_id
status	int	是	0停用，1启用

【返回参数】

参数	类型	示例	描述

【返回示例】

{
    "code": 0,
    "data": null,
    "msg": "",
    "ts": 1600176725
}

API 8 : 更新子账号信息

【功能描述】

更新账号信息

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/new_sub/updateSubAccount

【请求参数】

参数	类型	是否必填	描述
partner_id	int	是	partner_id
sub_partner_id	int	是	子账号partner_id
mobile	string	否	手机号
email	string	否	邮箱
password	string	否	密码
contacts	string	否	联系人
company	string	否	公司
effect_time	string	否	账号生效时间
expire_time	string	否	账号失效时间

【返回参数】

参数	类型	示例	描述

【返回示例】

{
    "code": 0,
    "data": null,
    "msg": "",
    "ts": 1600176725
}

下载为pdf格式

迄今为止，百家云已在华北、华东、华南、华中等各地建立分公司及办事处，拥有员工超过200人。百家云为您提供专业的直播、点播一站式解决方案，专业建设双师课堂，让您专注于内容及业务，低成本建设属于自己的在线直播平台不再是梦想。

国家高新技术企业中关村高新技术企业 ISO9001认证双软企业认证

百家云产品

教育直播双师课堂企业直播云点播网校系统企培系统 AI应用音视频PaaS云服务

解决方案

教育直播双师课堂企业直播金融直播会议直播医疗直播

公司地址

总部

北京市海淀区中关村软件园12号楼1层7号门百家云

北京市海淀区中关村软件园2号楼2c三层-2366房间

分公司

武汉市高新大道426号华新大厦B座401

南京市雨花台区凤展路32号A1南栋24层

上海市徐汇区桂林路406号华鑫中心1号楼11层1105室

深圳市南山区西丽街道新围工业区9栋荔园创新空间301室

桂林经开区华为信息生态产业合作区创新大厦第3层354号

办事处：

长沙办事处地址：湖南省长沙市芙蓉中路200号华侨国际大厦25楼

成都办事处地址：四川省成都市武侯区天府大道北段1700号环球中心E2-808

官方邮箱：service@baijiayun.com

售前热线：4000-369-100

售后热线：4008-616-716

如需商务合作请点击此处

技术支持 QQ1： 418208812
QQ2： 3262347115