修改默认模板角色权限设置

接口描述

1、修改角色权限默认模板设置
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/user/template/role-config/update

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥】

sign

true

String

签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】

timestamp

true

String

当前13位毫秒级时间戳，3分钟内有效

请求体参数描述

参数名必选类型说明

teacherConfig

false

Object

讲师角色权限配置【详见TeacherConfig参数描述】

guestConfig

false

Object

嘉宾角色权限配置【详见GuestConfig参数描述】

TeacherConfig参数描述

参数名必选类型说明

webStartCheckInDisplayEnabled

false

String

开播端签到功能显示开关 Y：开启、N：关闭

webStartLotteryDisplayEnabled

false

String

开播端抽奖功能显示开关 Y：开启、N：关闭

webStartQuestionnaireDisplayEnabled

false

String

开播端问卷功能显示开关 Y：开启、N：关闭

webStartAnswerDisplayEnabled

false

String

开播端答题卡功能显示开关 Y：开启、N：关闭

webStartTimerDisplayEnabled

false

String

开播端定时器功能显示开关 Y：开启、N：关闭

webStartRedPackDisplayEnabled

false

String

开播端红包功能显示开关 Y：开启、N：关闭

webStartCardPushDisplayEnabled

false

String

开播端卡片推送功能显示开关 Y：开启、N：关闭

webStartNotifyDisplayEnabled

false

String

开播端公告功能显示开关 Y：开启、N：关闭

webStartLinkMicDisplayEnabled

false

String

开播端连麦功能显示开关 Y：开启、N：关闭

webStartMultiMediaDisplayEnabled

false

String

开播端多媒体功能显示开关 Y：开启、N：关闭

webStartMembersDisplayEnabled

false

String

开播端成员列表功能显示开关 Y：开启、N：关闭

screenShareRetainCameraEnabled

false

String

共享保持摄像头状态开关 Y：开启、N：关闭

multiplexingDefaultLayout

false

String

混流布局默认应用 1：单人模式、2：平铺模式、3：主讲模式

cameraSingleModeEnabled

false

String

摄像头单人模式开关 Y：开启、N：关闭

aiVirtualBgUrl

false

String

AI抠像背景图

remixDefaultEnabled

false

String

混音默认开关 Y：开启、N：关闭

showSceneTemplateEnabled

false

String

是否显示场景模板开关 Y：开启、N：关闭

hideFramesDirectionEnabled

false

String

隐藏画面方向切换入口开关 Y：开启、N：关闭

defaultOpenMicLinkEnabled

false

String

是连麦默认方式 video：音视频、audio：音频

GuestConfig参数描述

参数名必选类型说明

webStartCheckInDisplayEnabled

false

String

开播端签到功能显示开关 Y：开启、N：关闭

webStartLotteryDisplayEnabled

false

String

开播端抽奖功能显示开关 Y：开启、N：关闭

webStartQuestionnaireDisplayEnabled

false

String

开播端问卷功能显示开关 Y：开启、N：关闭

webStartAnswerDisplayEnabled

false

String

开播端答题卡功能显示开关 Y：开启、N：关闭

webStartRedPackDisplayEnabled

false

String

开播端红包功能显示开关 Y：开启、N：关闭

webStartCardPushDisplayEnabled

false

String

开播端卡片推送功能显示开关 Y：开启、N：关闭

webStartNotifyDisplayEnabled

false

String

开播端公告功能显示开关 Y：开启、N：关闭

webStartLinkMicDisplayEnabled

false

String

开播端连麦功能显示开关 Y：开启、N：关闭

webStartMultiMediaDisplayEnabled

false

String

开播端多媒体功能显示开关 Y：开启、N：关闭

webStartMembersDisplayEnabled

false

String

开播端成员列表功能显示开关 Y：开启、N：关闭

screenShareRetainCameraEnabled

false

String

共享保持摄像头状态开关 Y：开启、N：关闭

cameraSingleModeEnabled

false

String

摄像头单人模式开关 Y：开启、N：关闭

aiVirtualBgUrl

false

String

AI抠像背景图

remixDefaultEnabled

false

String

混音默认开关 Y：开启、N：关闭

showSceneTemplateEnabled

false

String

是否显示场景模板开关 Y：开启、N：关闭

hideFramesDirectionEnabled

false

String

隐藏画面方向切换入口开关 Y：开启、N：关闭

示例

http://api.polyv.net/live/v4/user/template/role-config/update?appId=frlr1zazn3&sign=9C73C7471CF969AD8AC042221C89551D&timestamp=1677167340447

请求体json参数：

{
	"teacherConfig": {
		"webStartCheckInDisplayEnabled": "N"
	}
}

响应参数描述

参数名类型说明

code

Integer

状态码，与 http 状态码相同，用于确定基本的响应状态

data

Object

成功响应的数据

error

Object

状态码非200时的错误信息【详见Error参数描述】

requestId

String

请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩

status

String

响应结果，由业务决定，成功返回success，失败返回error

success

Boolean

是否成功响应

Error参数描述

参数名类型说明

code

Integer

错误代码，用于确定具体的错误原因

desc

String

错误描述，与 error.code 对应

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 修改角色权限默认模板设置
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void updateRoleConfigTemplateTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/user/template/role-config/update";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);

    Map<String, Object> teacherConfigMap = new HashMap<>();
    teacherConfigMap.put("webStartCheckInDisplayEnabled", "N");

    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("teacherConfig", teacherConfigMap);

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);

    log.info("测试修改角色权限默认模板设置成功：{}", response);
    //do somethings

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "a5e9b1d15f544d7a9db6f038156a851d.71.16771673423081591",
    "data": null,
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
Previous修改默认模板回放设置Next修改默认模板视频审核

Last updated