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

子账号相关API接口文档

概述

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

请求域名

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

服务端API接口

API 1 : 查询子账号列表

【功能描述】

查询子账号列表

【请求类型】

POST

【请求地址】

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

【请求参数】

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

【返回参数】

参数 类型 示例 描述
partner_id int 合作方用户名
mobile string 注册手机号
email string 邮箱
contacts string 联系人
company string 公司名
live_account_status 直播账号状态 0:未开通 1:服务正常 2:服务已停止
user_limit int 直播套餐并发值,并发计费用户生效
max_user_limit int 直播可超额使用到的并发值,并发计费用户生效,且不能小于user_limit
user_count int 直播套餐人次/时长点数值,人次/时长点数计费用户生效
max_user_count int 直播可超额使用到的人次/时长点数值,人次/时长点数计费用户生效,且不能小于user_count
live_max_speakers int 最大上麦路数
video_account_status 点播账号状态 0:未开通 1:服务正常 2:服务已停止
storage_limit int 点播存储空间容量,如开通点播,则该值为必传值。
max_storage_limit int 点播可超额使用到的容量,如开通点播,则该值为必传值。该值必须不小于storage_limit
flow_limit int 点播套餐月流量,如开通点播,则该值为必传值。
max_flow_limit int 点播可超额使用到的月流量,如开通点播,则该值为必传值。该值必须不小于flow_limit
effect_time string 账号生效时间
expire_time string 账号失效时间
create_time string 账号创建时间
private_domain string 个性域名

【返回示例】

{
    "code": 0,
    "data": {
        "total": 1,
        "list": [
            {
                "partner_id": 37169793,
                "mobile": "19901218233",
                "contacts": "武汉钱图有限公司",
                "company": "百家云子账号",
                "live_account_status": 2,
                "live_max_speakers": 10,
                "user_count": 1000,
                "max_user_count": 1200,
                "user_limit": 1,
                "video_account_status": 2,
                "storage_limit": 10,
                "flow_limit": 1,
                "create_time": "2017-10-23 15:56:05",
                "effect_time": "2017-10-23 00:00:00",
                "expire_time": "2018-10-23 23:59:59",
                "max_user_limit": 1,
                "max_storage_limit": 10,
                "max_flow_limit": 1
            }
        ]
    },
    "msg": "",
    "ts": 1511512700
}

API 2 : 创建子账号

【功能描述】

创建子账号

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/sub_account/createSubAccount

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
mobile string 手机号必须是未注册过的
email string 邮箱必须是未注册过的
password string 密码必须为6-18位之间
contacts string 联系人
company string 公司名
live_on int 是否开通直播 0:不开通 1:开通
video_on int 是否开通点播 0:不开通 1:开通
effect_time string 账号生效日期,格式如:2017-11-24
expire_time string 账号失效日期,格式如:2018-11-24
user_limit int 直播套餐并发值,如开通直播,且为并发计费,则该值为必传值。必须是正整数。
max_user_limit int 直播可超额使用到的并发值,如开通直播,且为并发计费,则该值为必传值。该值必须不小于user_limit。必须是正整数。
user_count int 直播套餐人次/时长点数值,如开通直播,且为人次/时长点数计费,则该值为必传值
max_user_count int 直播可超额使用到的人次/时长点数值,如开通直播,且为人次/时长点数计费,则该值为必传值,且不能小于user_count
live_max_speakers int 最大上麦路数
storage_limit int 点播存储空间容量,如开通点播播,则该值为必传值。 必须是正整数。
max_storage_limit int 点播可超额使用到的容量,如开通点播,则该值为必传值。该值必须不小于storage_limit。必须是正整数。
flow_limit int 点播套餐月流量,如开通点播,则该值为必传值。必须是正整数。
max_flow_limit int 点播可超额使用到的月流量,如开通点播,则该值为必传值。该值必须不小于flow_limit。必须是正整数。
timestamp int 当前时间,unix时间戳
sign string 签名

【返回参数】

参数 类型 示例 描述
partner_id int 合作方用户名
mobile string 注册手机号
email string 邮箱
partner_key string partner_key
secret_key string
contacts string 联系人
company string 公司名
live_account_status int 直播账号状态 0:未开通 1:服务正常 2:服务已停止
user_limit int 直播套餐并发值,如开通直播,则该值为必传值。
video_account_status int 点播账号状态 0:未开通 1:服务正常 2:服务已停止
storage_limit int 点播存储空间容量,如开通点播播,则该值为必传值。
flow_limit int 点播套餐月流量,如开通点播,则该值为必传值。
effect_time string 账号生效时间
expire_time string 账号失效时间
create_time string 账号创建时间
user_count int 直播套餐人次/时长点数值,人次/时长点数计费用户生效
max_user_count int 直播可超额使用到的人次/时长点数值,人次/时长点数计费用户生效,且不能小于user_count
live_max_speakers int 最大上麦路数
max_user_limit int 直播可超额使用到的并发值,如开通直播,则该值为必传值。该值必须不小于user_limit
max_storage_limit int 点播可超额使用到的容量,如开通点播,则该值为必传值。该值必须不小于storage_limit
max_flow_limit int 点播可超额使用到的月流量,如开通点播,则该值为必传值。该值必须不小于flow_limit
private_domain string 个性域名

【返回示例】

{
    "code": 0,
    "data": {
        "partner_id": 37169793,
        "mobile": "19901218233",
        "partner_key": "cXXbACY/G6w5yw6LhdVFHc1GyfqyHcDTzPr08OeEBHCjvyAFKHG28jJbrbLKy1uAr4pv/0tic5EJqq21Zw/CLg==",
        "secret_key": "419518be3fc0eb19e80cc42952874177",
        "contacts": "武汉钱图有限公司",
        "company": "百家云子账号",
        "live_account_status": 2,
        "user_limit": 1,
        "user_count": 1000,
        "max_user_count": 1200,
        "live_max_speakers": 10,
        "video_account_status": 2,
        "storage_limit": 10,
        "flow_limit": 1,
        "create_time": "2017-10-23 15:56:05",
        "effect_time": "2017-10-23 00:00:00",
        "expire_time": "2018-10-23 23:59:59",
        "max_user_limit": 1,
        "max_storage_limit": 10,
        "max_flow_limit": 1
    },
    "msg": "",
    "ts": 1514344149
}

API 3 : 停用子账号

【功能描述】

停用子账号

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/sub_account/stopSubAccount

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
sub_partner_id int 要停用的子账号ID
timestamp int 当前时间,unix时间戳
sign string 签名

【返回参数】

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

【返回示例】

{
    "code": 0,
    "data": {
        "partner_id": 32958737
    "msg": "",
    "ts": 1511512700
}

API 4 : 获取子账号信息

【功能描述】

获取子账号信息

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/sub_account/getSubAccountInfo

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
sub_partner_id int 子账号ID
timestamp int 当前时间,unix时间戳
sign string 签名

【返回参数】

参数 类型 示例 描述
partner_id int 合作方用户名
mobile string 注册手机号
email string 邮箱
partner_key string partner_key
secret_key string secret_key
contacts string 联系人
company string 公司名
live_account_status int 直播账号状态 0:未开通 1:服务正常 2:服务已停止
user_limit int 直播套餐并发值,如开通直播,则该值为必传值。
video_account_status int 点播账号状态 0:未开通 1:服务正常 2:服务已停止
storage_limit int 点播存储空间容量,如开通点播播,则该值为必传值。
flow_limit int 点播套餐月流量,如开通点播,则该值为必传值。
effect_time string 账号生效时间
expire_time string 账号失效时间
create_time string 账号创建时间
max_user_limit int 直播可超额使用到的并发值,如开通直播,则该值为必传值。该值必须不小于user_limit
max_storage_limit int 点播可超额使用到的容量,如开通点播,则该值为必传值。该值必须不小于storage_limit
max_flow_limit int 点播可超额使用到的月流量,如开通点播,则该值为必传值。该值必须不小于flow_limit
user_count int 直播套餐人次/时长点数值,人次/时长点数计费用户生效
max_user_count int 直播可超额使用到的人次/时长点数值,人次/时长点数计费用户生效,且不能小于user_count
live_max_speakers int 最大上麦路数
private_domain string 个性域名

【返回示例】

{
    "code": 0,
    "data": {
        "partner_id": 37169793,
        "mobile": "19901218233",
        "partner_key": "cXXbACY/G6w5yw6LhdVFHc1GyfqyHcDTzPr08OeEBHCjvyAFKHG28jJbrbLKy1uAr4pv/0tic5EJqq21Zw/CLg==",
        "secret_key": "419518be3fc0eb19e80cc42952874177",
        "contacts": "蔡伊",
        "company": "百家云子账号",
        "live_account_status": 2,
        "user_limit": 1,
        "user_count": 1000,
        "max_user_count": 1200,
        "live_max_speakers": 10,
        "video_account_status": 2,
        "storage_limit": 10,
        "flow_limit": 1,
        "create_time": "2017-10-23 15:56:05",
        "effect_time": "2017-10-23 00:00:00",
        "expire_time": "2018-10-23 23:59:59",
        "max_user_limit": 1,
        "max_storage_limit": 10,
        "max_flow_limit": 1
    },
    "msg": "",
    "ts": 1514344149
}

API 5 : 修改子账号配置

【功能描述】

修改子账号配置

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/sub_account/modifySubAccount

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
sub_partner_id int 子账号ID
live_on int 直播账号状态 1:服务正常 2:服务已停止
video_on int 点播账号状态 0:未开通 1:服务正常 2:服务已停止
storage_limit int 点播存储空间容量,如开通点播播,则该值为必传值。
max_storage_limit int 点播可超额使用到的容量,该值必须不小于storage_limit。必须是正整数。
flow_limit int 点播套餐月流量
max_flow_limit int 点播可超额使用到的月流量,该值必须不小于flow_limit。必须是正整数。
live_max_speakers int 最大上麦路数
effect_time string 生效时间
expire_time string 失效时间
user_limit int 并发人数上限,并发计费可设置
max_user_limit int 直播可超额使用到的并发值,直播并发计费有效。该值必须不小于user_limit。必须是正整数。
user_count int 人次/时长上限,人次/时长计费可设置
max_user_count int 直播可超额使用到的人次/时长点数值,直播人次/时长点数计费有效,且不能小于user_count
timestamp int 当前时间,unix时间戳
sign string 签名

【返回示例】

{
    "code": 0,
    "data": {},
    "msg": "",
    "ts": 1514344149
}