'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'imp', 'version' => '2021-06-30', ], 'directories' => [ [ 'id' => 121844, 'title' => null, 'type' => 'directory', 'children' => [ 'GetAuthToken', ], ], [ 'id' => 121852, 'title' => null, 'type' => 'directory', 'children' => [ [ 'id' => 167587, 'title' => null, 'type' => 'directory', 'children' => [ 'ListLiveRooms', 'ListLiveRoomsById', ], ], [ 'id' => 167586, 'title' => null, 'type' => 'directory', 'children' => [ 'GetLiveRoomStatistics', 'GetLiveRoomUserStatistics', ], ], [ 'id' => 169037, 'title' => null, 'type' => 'directory', 'children' => [ 'GetLiveRecord', 'CreateLiveRecordSliceFile', 'ListLiveFiles', 'DeleteLiveFilesById', ], ], 'CreateLiveRoom', 'DeleteLiveRoom', 'PublishLiveRoom', 'UpdateLiveRoom', 'StopLiveRoom', 'GetLiveRoom', ], ], [ 'id' => 121846, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateClass', 'DeleteClass', 'StopClass', 'UpdateClass', 'GetClassDetail', 'ListClasses', 'GetClassRecord', 'UpdateShareScreenLayout', ], ], [ 'id' => 121863, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateRoom', 'DeleteRoom', 'UpdateRoom', 'KickRoomUser', 'SetUserAdmin', 'CancelUserAdmin', 'GetRoom', 'ListRooms', 'ListRoomUsers', ], ], [ 'id' => 121870, 'title' => null, 'type' => 'directory', 'children' => [ [ 'id' => 167432, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateSensitiveWord', 'DeleteSensitiveWord', 'ListSensitiveWord', ], ], [ 'id' => 167433, 'title' => null, 'type' => 'directory', 'children' => [ 'CancelBanAllComment', 'CancelBanComment', 'BanAllComment', 'BanComment', ], ], [ 'id' => 167434, 'title' => null, 'type' => 'directory', 'children' => [ 'SendCustomMessageToAll', 'SendCustomMessageToUsers', 'SendComment', 'DeleteComment', 'ListComments', 'DeleteCommentByCreatorId', ], ], ], ], [ 'id' => 121880, 'title' => null, 'type' => 'directory', 'children' => [ 'DeleteConference', 'RemoveMember', 'GetConference', 'ListConferenceUsers', ], ], [ 'id' => 121893, 'title' => null, 'type' => 'directory', 'children' => [ 'GetStandardRoomJumpUrl', ], ], [ 'id' => 167286, 'title' => null, 'type' => 'directory', 'children' => [ 'DescribeMeterImpWatchLiveTimeByLiveId', 'DescribeMeterImpPlayBackTimeByLiveId', ], ], [ 'id' => 121914, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateLive', 'DeleteLive', 'PublishLive', 'UpdateLive', 'StopLive', 'GetLive', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'GetAuthToken' => [ 'summary' => '获取登录Token', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '用户的应用ID，在控制台创建应用时生成', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'AppKey', 'in' => 'formData', 'schema' => [ 'title' => '终端设备类型,通过控制台创建和查询', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '06***9c', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '用户UserId,在AppId下单独唯一', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], [ 'name' => 'DeviceId', 'in' => 'formData', 'schema' => [ 'title' => '终端设备ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'a494caec-***-695ef345db77', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AccessToken' => [ 'title' => '用于长连接建连的token', 'description' => '', 'type' => 'string', 'example' => 'oauth_cloud_key:***-b0YY5Gy6Q', ], 'RefreshToken' => [ 'title' => '更新Token，若AccessToken过期，则可以使用RefreshToken再次获取新Token', 'description' => '', 'type' => 'string', 'example' => 'oauth_cloud_key:****-Q62xggOTdgk3gw=', ], 'AccessTokenExpiredTime' => [ 'title' => '登录token过期时间(毫秒)', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '86400000', ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"AccessToken\\": \\"oauth_cloud_key:***-b0YY5Gy6Q\\",\\n \\"RefreshToken\\": \\"oauth_cloud_key:****-Q62xggOTdgk3gw=\\",\\n \\"AccessTokenExpiredTime\\": 86400000\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n oauth_cloud_key:***-b0YY5Gy6Q\\n oauth_cloud_key:****-Q62xggOTdgk3gw=\\n 86400000\\n \\n","errorExample":""}]', ], 'ListLiveRooms' => [ 'summary' => '查询场景化直播列表', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'Status', 'in' => 'formData', 'schema' => [ 'title' => '直播状态，0-在播 1-下播，不传则返回所有直播。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'title' => '查询页码，从1开始，传空默认查询第1页。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'title' => '每页显示个数，最大支持50，参数为空默认显示个数为10。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '创建场景化直播返回的结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '直播总数。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'PageTotal' => [ 'title' => '直播总页数。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'HasMore' => [ 'title' => '是否还有下一页。', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'LiveList' => [ 'title' => '直播列表信息。', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => '应用ID。', 'description' => '', 'type' => 'string', 'example' => '7m***q', ], 'LiveId' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'example' => 'b7f2****ebb3', ], 'Status' => [ 'title' => '直播状态，0-在播 1-下播。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RoomId' => [ 'title' => '房间ID。', 'description' => '', 'type' => 'string', 'example' => 'AE35-****-T95F', ], 'ChatId' => [ 'title' => '聊天ID。', 'description' => '', 'type' => 'string', 'example' => '09***f8', ], 'Title' => [ 'title' => '标题。', 'description' => '', 'type' => 'string', 'example' => 'Title001', ], 'Notice' => [ 'title' => '公告。', 'description' => '', 'type' => 'string', 'example' => 'Notice001', ], 'CoverUrl' => [ 'title' => '封面。', 'description' => '', 'type' => 'string', 'example' => 'http://***.png', ], 'AnchorId' => [ 'title' => '主播ID。', 'description' => '', 'type' => 'string', 'example' => 'as****hs', ], 'Uv' => [ 'title' => '访问用户数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'Extension' => [ 'title' => '直播拓展字段。', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'test001', 'description' => '', ], ], 'AnchorNick' => [ 'title' => '主播昵称。', 'description' => '', 'type' => 'string', 'example' => 'User001', ], 'Pv' => [ 'title' => '访问用户人次。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'OnlineCount' => [ 'title' => '在线用户数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'CreateTime' => [ 'title' => '直播的创建时间。单位为ms。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000', ], 'StartTime' => [ 'title' => '直播的开始时间。单位为ms。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259600000', ], 'EndTime' => [ 'title' => '直播的结束时间。单位为ms。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259800000', ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"PageTotal\\": 10,\\n \\"HasMore\\": true,\\n \\"LiveList\\": [\\n {\\n \\"AppId\\": \\"7m***q\\",\\n \\"LiveId\\": \\"b7f2****ebb3\\",\\n \\"Status\\": 1,\\n \\"RoomId\\": \\"AE35-****-T95F\\",\\n \\"ChatId\\": \\"09***f8\\",\\n \\"Title\\": \\"Title001\\",\\n \\"Notice\\": \\"Notice001\\",\\n \\"CoverUrl\\": \\"http://***.png\\",\\n \\"AnchorId\\": \\"as****hs\\",\\n \\"Uv\\": 100,\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n },\\n \\"AnchorNick\\": \\"User001\\",\\n \\"Pv\\": 200,\\n \\"OnlineCount\\": 50,\\n \\"CreateTime\\": 1624259500000,\\n \\"StartTime\\": 1624259600000,\\n \\"EndTime\\": 1624259800000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n 100\\n 10\\n true\\n \\n 7m***q\\n b7f2****ebb3\\n 1\\n AE35-****-T95F\\n 09***f8\\n \\n Notice001\\n http://***.png\\n as****hs\\n 100\\n \\n test001\\n \\n User001\\n 200\\n 50\\n \\n \\n","errorExample":""}]', ], 'ListLiveRoomsById' => [ 'summary' => '根据直播id批量查询直播信息', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'LiveIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '直播ID列表。', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '["b7f2****ebb3"]', ], 'required' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '创建场景化直播返回的结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'LiveList' => [ 'title' => '直播列表信息。', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => '应用ID。', 'description' => '', 'type' => 'string', 'example' => '7m***q', ], 'LiveId' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'example' => 'b7f2****ebb3', ], 'Status' => [ 'title' => '直播状态，0-在播 1-下播。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RoomId' => [ 'title' => '房间ID。', 'description' => '', 'type' => 'string', 'example' => 'AE35-****-T95F', ], 'ChatId' => [ 'title' => '聊天ID。', 'description' => '', 'type' => 'string', 'example' => '09***f8', ], 'Title' => [ 'title' => '标题。', 'description' => '', 'type' => 'string', 'example' => 'Title001', ], 'Notice' => [ 'title' => '公告。', 'description' => '', 'type' => 'string', 'example' => 'Notice001', ], 'CoverUrl' => [ 'title' => '封面。', 'description' => '', 'type' => 'string', 'example' => 'http://***.png', ], 'AnchorId' => [ 'title' => '主播ID。', 'description' => '', 'type' => 'string', 'example' => 'as****hs', ], 'Uv' => [ 'title' => '访问用户数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'Extension' => [ 'title' => '直播拓展字段。', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'test001', 'description' => '', ], ], 'AnchorNick' => [ 'title' => '主播昵称。', 'description' => '', 'type' => 'string', 'example' => 'User001', ], 'Pv' => [ 'title' => '访问用户人次。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'OnlineCount' => [ 'title' => '在线用户数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'CreateTime' => [ 'title' => '直播的创建时间。单位为ms。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000', ], 'StartTime' => [ 'title' => '直播的开始时间。单位为ms。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000', ], 'EndTime' => [ 'title' => '直播的结束时间。单位为ms。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000', ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"LiveList\\": [\\n {\\n \\"AppId\\": \\"7m***q\\",\\n \\"LiveId\\": \\"b7f2****ebb3\\",\\n \\"Status\\": 1,\\n \\"RoomId\\": \\"AE35-****-T95F\\",\\n \\"ChatId\\": \\"09***f8\\",\\n \\"Title\\": \\"Title001\\",\\n \\"Notice\\": \\"Notice001\\",\\n \\"CoverUrl\\": \\"http://***.png\\",\\n \\"AnchorId\\": \\"as****hs\\",\\n \\"Uv\\": 100,\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n },\\n \\"AnchorNick\\": \\"User001\\",\\n \\"Pv\\": 200,\\n \\"OnlineCount\\": 50,\\n \\"CreateTime\\": 1624259500000,\\n \\"StartTime\\": 1624259500000,\\n \\"EndTime\\": 1624259500000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n \\n 7m***q\\n b7f2****ebb3\\n 1\\n AE35-****-T95F\\n 09***f8\\n \\n RoomNotice001\\n http://***.png\\n as****hs\\n 100\\n \\n test001\\n \\n User001\\n 200\\n 50\\n \\n \\n","errorExample":""}]', ], 'GetLiveRoomStatistics' => [ 'summary' => '获取直播数据统计', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '创建场景化直播返回的结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'LiveId' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'example' => 'b7f2****ebb3', ], 'Status' => [ 'title' => '直播状态，0-已创建 1-直播中 2-已关闭。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Uv' => [ 'title' => '访问用户数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'Pv' => [ 'title' => '访问用户人次。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'MessageCount' => [ 'title' => '互动消息数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '500', ], 'StartTime' => [ 'title' => '直播开始时间，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000', ], 'EndTime' => [ 'title' => '直播结束时间，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000', ], 'WatchLiveTime' => [ 'title' => '总观看时长，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000', ], 'LikeCount' => [ 'title' => '点赞数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'OnlineCount' => [ 'title' => '在线用户数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"LiveId\\": \\"b7f2****ebb3\\",\\n \\"Status\\": 1,\\n \\"Uv\\": 100,\\n \\"Pv\\": 200,\\n \\"MessageCount\\": 500,\\n \\"StartTime\\": 1624259500000,\\n \\"EndTime\\": 1624259500000,\\n \\"WatchLiveTime\\": 10000000,\\n \\"LikeCount\\": 100,\\n \\"OnlineCount\\": 50\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n b7f2****ebb3\\n 1\\n 100\\n 200\\n 500\\n 1624259500000\\n 1624259500000\\n 10000000\\n 100\\n 50\\n \\n","errorExample":""}]', ], 'GetLiveRoomUserStatistics' => [ 'summary' => '获取直播用户数据统计', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'title' => '查询页码，从1开始，传空默认查询第1页。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'title' => '每页显示个数，最大支持50，参数为空默认显示个数为10。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '25', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '创建场景化直播返回的结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'LiveId' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'example' => 'b7f2****ebb3', ], 'TotalCount' => [ 'title' => '用户总数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'PageTotal' => [ 'title' => '用户总页数。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'HasMore' => [ 'title' => '是否还有下一页。', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'UserStatisticsList' => [ 'title' => '用户观看数据列表。', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID。', 'description' => '', 'type' => 'string', 'example' => 'User001', ], 'WatchLiveTime' => [ 'title' => '观看时长，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', ], 'CommentCount' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'LikeCount' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], ], ], 'example' => '10000000', ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"LiveId\\": \\"b7f2****ebb3\\",\\n \\"TotalCount\\": 100,\\n \\"PageTotal\\": 10,\\n \\"HasMore\\": true,\\n \\"UserStatisticsList\\": [\\n {\\n \\"UserId\\": \\"User001\\",\\n \\"WatchLiveTime\\": 100000,\\n \\"CommentCount\\": 100,\\n \\"LikeCount\\": 100\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n b7f2****ebb3\\n 100\\n 10\\n true\\n \\n User001\\n 100000\\n 100\\n 100\\n \\n \\n","errorExample":""}]', ], 'GetLiveRecord' => [ 'summary' => '获取直播录制详情', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'lq****cu', ], ], [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播唯一标识，由调用CreateLiveRoom返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '操作人用户ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '34**29', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08F', ], 'Result' => [ 'title' => 'API请求的返回结果结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'PlaybackUrlMap' => [ 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'array', 'items' => [ 'type' => 'string', 'example' => 'http://demo.aliyundoc.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', 'description' => '', ], 'description' => '', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08F\\",\\n \\"Result\\": {\\n \\"PlaybackUrlMap\\": {\\n \\"key\\": [\\n \\"http://demo.aliyundoc.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n \\n http://***.aliyundoc.nm/***8fc5-***f8****.webm?****77650&***xzSQU***\\n \\n \\n","errorExample":""}]', ], 'CreateLiveRecordSliceFile' => [ 'summary' => '创建直播录制的片段文件', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'lq****cu', ], ], [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'StartTime', 'in' => 'formData', 'schema' => [ 'title' => '片段开始时间，时间戳，单位为毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1577836800000', ], ], [ 'name' => 'EndTime', 'in' => 'formData', 'schema' => [ 'title' => '片段结束时间，时间戳，单位为毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1577836800000', ], ], [ 'name' => 'FileName', 'in' => 'formData', 'schema' => [ 'title' => '自定义文件名称。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'sliceFile', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'ER52****O9CA', ], 'Result' => [ 'title' => '创建场景化直播返回的结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'SliceRecordUrl' => [ 'title' => '片段录制文件的地址。', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-playback.com/**.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.Live.RecordContentExceed', 'errorMessage' => 'The record content between StartTime and EndTime is exceeded, please narrow down the range.', ], [ 'errorCode' => 'Invalid.Live.RecordContentTooShort', 'errorMessage' => 'The record time between StartTime and EndTime is too short, please enlarger the range.', ], [ 'errorCode' => 'Invalid.Live.RecordEndTimeMismatch', 'errorMessage' => 'Specified end time does not math the specified start time.', ], [ 'errorCode' => 'Invalid.Live.RecordInvalidBucket', 'errorMessage' => 'The oss bucket is invalid.', ], [ 'errorCode' => 'Invalid.Live.RecordLiveNotFound', 'errorMessage' => 'The live is not found.', ], [ 'errorCode' => 'Invalid.Live.RecordLiveStreamNotFound', 'errorMessage' => 'The live stream info is not found.', ], [ 'errorCode' => 'Invalid.Live.RecordNoContent', 'errorMessage' => 'The record has no content, please check the live record toggle.', ], [ 'errorCode' => 'Invalid.Live.RecordPlaybackDomainNotFound', 'errorMessage' => 'The record playback domain is not found, please open the liveRecordToggle in imp console and config playback domain.', ], [ 'errorCode' => 'Invalid.Live.WrongRecordOssConfig', 'errorMessage' => 'Specified oss config is wrong.', ], [ 'errorCode' => 'Invalid.Scene.LiveNotExist', 'errorMessage' => 'The live record does not exist. Please check again.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ER52****O9CA\\",\\n \\"Result\\": {\\n \\"SliceRecordUrl\\": \\"http://demo-app-playback.com/**.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\"\\n }\\n}","type":"json"}]', ], 'ListLiveFiles' => [ 'summary' => '获取直播的录制文件列表', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'lq**xy', ], ], [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'acbder-**-34uh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '返回结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'FileList' => [ 'title' => '文件列表。', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FileName' => [ 'title' => '文件名称。', 'description' => '', 'type' => 'string', 'example' => '12345/**/1.ts', ], 'Url' => [ 'title' => '文件下载地址。', 'description' => '', 'type' => 'string', 'example' => 'https://aliyundoc.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3/1.ts', ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"FileList\\": [\\n {\\n \\"FileName\\": \\"12345/**/1.ts\\",\\n \\"Url\\": \\"https://aliyundoc.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3/1.ts\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DeleteLiveFilesById' => [ 'summary' => '根据直播ID删除录制文件', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'lq**xy', ], ], [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'acbder-**-34uh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '返回结果。', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","type":"json"}]', ], 'CreateLiveRoom' => [ 'summary' => '创建场景化直播', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => [ 'title' => '标题，支持中英文，最大长度32位。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'Title001', ], ], [ 'name' => 'Notice', 'in' => 'formData', 'schema' => [ 'title' => '公告，支持中英文，最大长度256位。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Notice001', ], ], [ 'name' => 'CoverUrl', 'in' => 'formData', 'schema' => [ 'title' => '封面，支持图片地址链接格式', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'http://***.png', ], ], [ 'name' => 'Extension', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '拓展字段，按需传递，需要额外记录的房间属性。最大支持4096个字节。', 'description' => '', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'required' => false, 'example' => 'test001', ], 'example' => 'AE35****T95F', ], ], [ 'name' => 'AnchorId', 'in' => 'formData', 'schema' => [ 'title' => '主播id，仅支持英文和数字，最大长度36位。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], [ 'name' => 'AnchorNick', 'in' => 'formData', 'schema' => [ 'title' => '主播昵称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'User001', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '操作人ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'as****hs', ], ], [ 'name' => 'EnableLinkMic', 'in' => 'formData', 'schema' => [ 'title' => '是否开启连麦。', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '创建场景化直播返回的结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => '应用ID。', 'description' => '', 'type' => 'string', 'example' => '7m***q', ], 'RoomId' => [ 'title' => '房间ID。', 'description' => '', 'type' => 'string', 'example' => 'AE35-****-T95F', ], 'LiveId' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'example' => 'b7f2****ebb3', ], 'ChatId' => [ 'title' => '聊天ID。', 'description' => '', 'type' => 'string', 'example' => '09***f8', ], 'Title' => [ 'title' => '标题。', 'description' => '', 'type' => 'string', 'example' => 'Title001', ], 'Notice' => [ 'title' => '公告。', 'description' => '', 'type' => 'string', 'example' => 'Notice001', ], 'CoverUrl' => [ 'title' => '封面。', 'description' => '', 'type' => 'string', 'example' => 'http://***.png', ], 'AnchorId' => [ 'title' => '主播ID。', 'description' => '', 'type' => 'string', 'example' => 'as****hs', ], 'PlaybackUrl' => [ 'title' => '直播回放地址。', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'PushUrl' => [ 'title' => '直播推流地址。', 'description' => '', 'type' => 'string', 'example' => 'rtmp://demo-app-push.com/live/e620****a8e3?auth_key=e620****a8e3', ], 'LiveUrl' => [ 'title' => '直播拉流地址。', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'PluginInstanceInfoList' => [ 'title' => '活跃插件列表。', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PluginType' => [ 'title' => '插件唯一标识，取值：live-直播，wb-白板，chat-聊天，rtc。', 'description' => '', 'type' => 'string', 'example' => 'live', ], 'PluginId' => [ 'title' => '插件实例唯一标识。', 'description' => '', 'type' => 'string', 'example' => 'HASU-****-ASHD', ], 'CreateTime' => [ 'title' => '插件实例创建时间戳，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624589848000', ], 'Extension' => [ 'title' => '插件拓展字段。', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'test001', 'description' => '', ], ], ], ], ], 'Extension' => [ 'title' => '直播拓展字段。', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'test001', 'description' => '', ], ], 'AnchorNick' => [ 'title' => '主播昵称。', 'description' => '', 'type' => 'string', 'example' => 'User001', ], 'HlsUrl' => [ 'title' => '原画HLS播放地址。', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'ArtcInfo' => [ 'title' => 'RTS低延迟播流信息。', 'description' => '', 'type' => 'object', 'properties' => [ 'ArtcUrl' => [ 'title' => 'RTS原码流地址，推荐移动端使用。', 'description' => '', 'type' => 'string', 'example' => 'artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'ArtcH5Url' => [ 'title' => 'RTS转码流地址，推荐web端使用。', 'description' => '', 'type' => 'string', 'example' => 'artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.Live.ConfigNotFound', 'errorMessage' => 'The live push domain and pull domain config not found.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"AppId\\": \\"7m***q\\",\\n \\"RoomId\\": \\"AE35-****-T95F\\",\\n \\"LiveId\\": \\"b7f2****ebb3\\",\\n \\"ChatId\\": \\"09***f8\\",\\n \\"Title\\": \\"Title001\\",\\n \\"Notice\\": \\"Notice001\\",\\n \\"CoverUrl\\": \\"http://***.png\\",\\n \\"AnchorId\\": \\"as****hs\\",\\n \\"PlaybackUrl\\": \\"http://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"PushUrl\\": \\"rtmp://demo-app-push.com/live/e620****a8e3?auth_key=e620****a8e3\\",\\n \\"LiveUrl\\": \\"http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"PluginInstanceInfoList\\": [\\n {\\n \\"PluginType\\": \\"live\\",\\n \\"PluginId\\": \\"HASU-****-ASHD\\",\\n \\"CreateTime\\": 1624589848000,\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n }\\n }\\n ],\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n },\\n \\"AnchorNick\\": \\"User001\\",\\n \\"HlsUrl\\": \\"http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"ArtcInfo\\": {\\n \\"ArtcUrl\\": \\"artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"ArtcH5Url\\": \\"artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n 7m***q\\n AE35-****-T95F\\n b7f2****ebb3\\n 09***f8\\n \\n Notice001\\n http://***.png\\n as****hs\\n http://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n rtmp://demo-app-push.com/live/e620****a8e3?auth_key=e620****a8e3\\n http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n \\n live\\n HASU-****-ASHD\\n 1624589848000\\n \\n test001\\n \\n \\n \\n test001\\n \\n User001\\n http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n \\n artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n \\n \\n","errorExample":""}]', ], 'DeleteLiveRoom' => [ 'summary' => '删除直播', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '操作人ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'as****hs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Forbidden.Scene.LiveStillStreaming', 'errorMessage' => 'Live is still streaming and cannot be deleted.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n","errorExample":""}]', ], 'PublishLiveRoom' => [ 'summary' => '发布直播', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '操作人ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'as****hs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '创建场景化直播返回的结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'LiveId' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'example' => 'b7f2****ebb3', ], 'LiveUrl' => [ 'title' => '直播拉流地址。', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'PushUrl' => [ 'title' => '直播推流地址。', 'description' => '', 'type' => 'string', 'example' => 'rtmp://demo-app-push.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.Live.StatusNotMatch', 'errorMessage' => 'The live status not match.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"LiveId\\": \\"b7f2****ebb3\\",\\n \\"LiveUrl\\": \\"http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"PushUrl\\": \\"rtmp://demo-app-push.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n ER52****O9CA\\n \\n b7f2****ebb3\\n http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n rtmp://demo-app-push.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n \\n","errorExample":""}]', ], 'UpdateLiveRoom' => [ 'summary' => '更新直播', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => [ 'title' => '标题，支持中英文，最大长度32位。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Title001', ], ], [ 'name' => 'Notice', 'in' => 'formData', 'schema' => [ 'title' => '公告，支持中英文，最大长度256位。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Notice001', ], ], [ 'name' => 'CoverUrl', 'in' => 'formData', 'schema' => [ 'title' => '封面，支持图片地址链接格式', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'http://***.png', ], ], [ 'name' => 'Extension', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '拓展字段，按需传递，需要额外记录的房间属性。', 'description' => '', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'required' => false, 'example' => 'test001', ], 'example' => 'AE35****T95F', ], ], [ 'name' => 'AnchorId', 'in' => 'formData', 'schema' => [ 'title' => '主播id，仅支持英文和数字，最大长度36位。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'as****hs', ], ], [ 'name' => 'AnchorNick', 'in' => 'formData', 'schema' => [ 'title' => '主播昵称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'User001', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '操作人ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'user001', ], ], [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n","errorExample":""}]', ], 'StopLiveRoom' => [ 'summary' => '关闭场景化直播', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '操作人ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'as****hs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.Live.PermissionDenied', 'errorMessage' => 'The permission is denied.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n","errorExample":""}]', ], 'GetLiveRoom' => [ 'summary' => '查询场景化直播详情', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '创建场景化直播返回的结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => '应用ID。', 'description' => '', 'type' => 'string', 'example' => '7m***q', ], 'LiveId' => [ 'title' => '直播ID。', 'description' => '', 'type' => 'string', 'example' => 'b7f2****ebb3', ], 'Status' => [ 'title' => '直播状态，0-在播 1-下播。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RoomId' => [ 'title' => '房间ID。', 'description' => '', 'type' => 'string', 'example' => 'AE35-****-T95F', ], 'ChatId' => [ 'title' => '聊天ID。', 'description' => '', 'type' => 'string', 'example' => '09***f8', ], 'Title' => [ 'title' => '标题。', 'description' => '', 'type' => 'string', 'example' => 'Title001', ], 'Notice' => [ 'title' => '公告。', 'description' => '', 'type' => 'string', 'example' => 'Notice001', ], 'CoverUrl' => [ 'title' => '封面。', 'description' => '', 'type' => 'string', 'example' => 'http://***.png', ], 'AnchorId' => [ 'title' => '主播ID。', 'description' => '', 'type' => 'string', 'example' => 'as****hs', ], 'Uv' => [ 'title' => '访问用户数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'OnlineCount' => [ 'title' => '在线用户数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'PlaybackUrl' => [ 'title' => '直播回放地址。', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'PlaybackUrlHttps' => [ 'title' => 'https协议的直播回放地址', 'description' => '', 'type' => 'string', 'example' => 'https://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'CreateTime' => [ 'title' => '直播创建时间，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000', ], 'EndTime' => [ 'title' => '直播结束时间，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000', ], 'PushUrl' => [ 'title' => '直播推流地址。', 'description' => '', 'type' => 'string', 'example' => 'rtmp://demo-app-push.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'LiveUrl' => [ 'title' => '直播拉流地址。', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'LiveUrlHttps' => [ 'title' => 'https协议的直播拉流地址。', 'description' => '', 'type' => 'string', 'example' => 'https://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'PluginInstanceInfoList' => [ 'title' => '活跃插件列表。', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PluginType' => [ 'title' => '插件唯一标识，取值：live-直播，wb-白板，chat-聊天，rtc。', 'description' => '', 'type' => 'string', 'example' => 'live', ], 'PluginId' => [ 'title' => '插件实例唯一标识。', 'description' => '', 'type' => 'string', 'example' => 'HASU-****-ASHD', ], 'CreateTime' => [ 'title' => '插件实例创建时间戳，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624589848000', ], 'Extension' => [ 'title' => '插件拓展字段。', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'test001', 'description' => '', ], ], ], ], ], 'Extension' => [ 'title' => '直播拓展字段。', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'test001', 'description' => '', ], ], 'Pv' => [ 'title' => '访问用户人次。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'AnchorNick' => [ 'title' => '主播昵称', 'description' => '', 'type' => 'string', 'example' => 'User001', ], 'StartTime' => [ 'title' => '直播开始时间，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000', ], 'HlsUrl' => [ 'title' => '原画HLS播放地址。', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'HlsUrlHttps' => [ 'title' => 'https协议的原画HLS播放地址。', 'description' => '', 'type' => 'string', 'example' => 'https://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'RtmpUrl' => [ 'title' => 'rtmp协议的播放地址', 'description' => '', 'type' => 'string', 'example' => 'rtmp://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'ArtcInfo' => [ 'title' => 'RTS低延迟播流信息。', 'description' => '', 'type' => 'object', 'properties' => [ 'ArtcUrl' => [ 'title' => 'RTS原码流地址，推荐移动端使用。', 'description' => '', 'type' => 'string', 'example' => 'artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'ArtcH5Url' => [ 'title' => 'RTS转码流地址，推荐web端使用。', 'description' => '', 'type' => 'string', 'example' => 'artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], ], ], 'EnableLinkMic' => [ 'title' => '是否开启连麦。', 'description' => '', 'type' => 'boolean', 'example' => 'true:开启连麦。false:未开启连麦。', ], 'ConfId' => [ 'title' => '连麦会议唯一标识。', 'description' => '', 'type' => 'string', 'example' => 'fb0f-****-4cb1', ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"AppId\\": \\"7m***q\\",\\n \\"LiveId\\": \\"b7f2****ebb3\\",\\n \\"Status\\": 1,\\n \\"RoomId\\": \\"AE35-****-T95F\\",\\n \\"ChatId\\": \\"09***f8\\",\\n \\"Title\\": \\"Title001\\",\\n \\"Notice\\": \\"Notice001\\",\\n \\"CoverUrl\\": \\"http://***.png\\",\\n \\"AnchorId\\": \\"as****hs\\",\\n \\"Uv\\": 100,\\n \\"OnlineCount\\": 50,\\n \\"PlaybackUrl\\": \\"http://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"PlaybackUrlHttps\\": \\"https://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"CreateTime\\": 1624259500000,\\n \\"EndTime\\": 1624259500000,\\n \\"PushUrl\\": \\"rtmp://demo-app-push.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"LiveUrl\\": \\"http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"LiveUrlHttps\\": \\"https://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"PluginInstanceInfoList\\": [\\n {\\n \\"PluginType\\": \\"live\\",\\n \\"PluginId\\": \\"HASU-****-ASHD\\",\\n \\"CreateTime\\": 1624589848000,\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n }\\n }\\n ],\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n },\\n \\"Pv\\": 200,\\n \\"AnchorNick\\": \\"User001\\",\\n \\"StartTime\\": 1624259500000,\\n \\"HlsUrl\\": \\"http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"HlsUrlHttps\\": \\"https://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"RtmpUrl\\": \\"rtmp://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"ArtcInfo\\": {\\n \\"ArtcUrl\\": \\"artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"ArtcH5Url\\": \\"artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\"\\n },\\n \\"EnableLinkMic\\": true,\\n \\"ConfId\\": \\"fb0f-****-4cb1\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n 7m***q\\n b7f2****ebb3\\n 1\\n AE35-****-T95F\\n 09***f8\\n \\n Notice001\\n http://***.png\\n as****hs\\n 100\\n 50\\n http://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n https://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n 1624259500000\\n 1624259500000\\n rtmp://demo-app-push.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n https://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n \\n live\\n HASU-****-ASHD\\n 1624589848000\\n \\n test001\\n \\n \\n \\n test001\\n \\n 200\\n User001\\n 1624259500000\\n http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n https://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n rtmp://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n \\n artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n \\n \\n","errorExample":""}]', ], 'CreateClass' => [ 'summary' => '创建课堂', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => [ 'title' => '课堂标题', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'ClassTitle001', ], ], [ 'name' => 'CreateUserId', 'in' => 'formData', 'schema' => [ 'title' => '创建人用户ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], [ 'name' => 'CreateNickname', 'in' => 'formData', 'schema' => [ 'title' => '创建人用户昵称。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'nickname001', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => 'API请求的返回结果结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'ClassId' => [ 'title' => '课堂唯一标识。', 'description' => '', 'type' => 'string', 'example' => 'A55-****-Y34O', ], 'Title' => [ 'title' => '课堂标题。', 'description' => '', 'type' => 'string', 'example' => 'PPT制作培训', ], 'CreateUserId' => [ 'title' => '创建人ID。', 'description' => '', 'type' => 'string', 'example' => '34***45', ], 'CreateNickname' => [ 'title' => '创建人昵称。', 'description' => '', 'type' => 'string', 'example' => '随风', ], 'Status' => [ 'title' => '课堂状态，0:未开始 1:上课中 2:已下课。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RoomId' => [ 'title' => '房间ID', 'description' => '', 'type' => 'string', 'example' => 'AE35-****-T95F', ], 'LiveId' => [ 'title' => '直播的唯一标识ID。', 'description' => '', 'type' => 'string', 'example' => 'b7f2****ebb3', ], 'ConfId' => [ 'title' => '连麦会议唯一标识。', 'description' => '', 'type' => 'string', 'example' => 'fb0f-****-4cb1', ], 'WhiteboardId' => [ 'title' => '白板ID', 'description' => '', 'type' => 'string', 'example' => 'fgej**2', ], 'WhiteboardRecordId' => [ 'title' => '白板录制ID', 'description' => '', 'type' => 'string', 'example' => 'eofg**rt', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.Live.ConfigNotFound', 'errorMessage' => 'The live push domain and pull domain config not found.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"ClassId\\": \\"A55-****-Y34O\\",\\n \\"Title\\": \\"PPT制作培训\\",\\n \\"CreateUserId\\": \\"34***45\\",\\n \\"CreateNickname\\": \\"随风\\",\\n \\"Status\\": 2,\\n \\"RoomId\\": \\"AE35-****-T95F\\",\\n \\"LiveId\\": \\"b7f2****ebb3\\",\\n \\"ConfId\\": \\"fb0f-****-4cb1\\",\\n \\"WhiteboardId\\": \\"fgej**2\\",\\n \\"WhiteboardRecordId\\": \\"eofg**rt\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n A55-****-Y34O\\n \\n 34***45\\n 随风\\n 2\\n AE35-****-T95F\\n b7f2****ebb3\\n fb0f-****-4cb1\\n fgej**2\\n eofg**rt\\n \\n","errorExample":""}]', ], 'DeleteClass' => [ 'summary' => '删除课堂', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'ClassId', 'in' => 'formData', 'schema' => [ 'title' => '课堂唯一标识。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'A55-****-Y34O', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '操作人用户ID，仅支持中英文数字，下划线，中划线，1~36个字符。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'as****hs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n","errorExample":""}]', ], 'StopClass' => [ 'summary' => '下课', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'ClassId', 'in' => 'formData', 'schema' => [ 'title' => '课堂唯一标识。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'A55-****-Y34O', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '操作者用户ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'as****hs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n","errorExample":""}]', ], 'UpdateClass' => [ 'summary' => '更新课堂', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'ClassId', 'in' => 'formData', 'schema' => [ 'title' => '课堂唯一标识。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'A55-****-Y34O', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => [ 'title' => '课堂标题，1~32个字符。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ClassTitle001', ], ], [ 'name' => 'CreateUserId', 'in' => 'formData', 'schema' => [ 'title' => '创建人用户ID，仅支持中英文数字，下划线，中划线，1~36个字符。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'as****hs', ], ], [ 'name' => 'CreateNickname', 'in' => 'formData', 'schema' => [ 'title' => '创建人用户昵称，1~32个字符。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'nickname001', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n","errorExample":""}]', ], 'GetClassDetail' => [ 'summary' => '获取课堂详情', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'ClassId', 'in' => 'formData', 'schema' => [ 'title' => '课堂唯一标识，由调用CreateClass返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'A55-****-Y34O', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '操作人用户ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'as****hs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => 'API请求的返回结果结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'ClassId' => [ 'title' => '课堂唯一标识，由调用CreateClass返回。', 'description' => '', 'type' => 'string', 'example' => 'A55-****-Y34O', ], 'Title' => [ 'title' => '课堂标题。', 'description' => '', 'type' => 'string', 'example' => 'ClassTitle001', ], 'CreateUserId' => [ 'title' => '创建人ID。', 'description' => '', 'type' => 'string', 'example' => 'as****hs', ], 'CreateNickname' => [ 'title' => '创建人昵称。', 'description' => '', 'type' => 'string', 'example' => 'nickname001', ], 'Status' => [ 'title' => '课堂状态，0:未开始 1:上课中 2:已下课。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'StartTime' => [ 'title' => '开始上课时间戳，毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1632794405000', ], 'EndTime' => [ 'title' => '下课时间戳，毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1632797405000', ], 'RoomId' => [ 'title' => '房间ID', 'description' => '', 'type' => 'string', 'example' => 'AE35-****-T95F', ], 'LiveId' => [ 'title' => '直播的唯一标识ID。', 'description' => '', 'type' => 'string', 'example' => 'b7f2****ebb3', ], 'ConfId' => [ 'title' => '连麦会议唯一标识。', 'description' => '', 'type' => 'string', 'example' => 'fb0f-****-4cb1', ], 'WhiteboardId' => [ 'title' => '白板ID', 'description' => '', 'type' => 'string', 'example' => 'fgej**2', ], 'WhiteboardRecordId' => [ 'title' => '白板录制ID', 'description' => '', 'type' => 'string', 'example' => 'eofg**rt', ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"ClassId\\": \\"A55-****-Y34O\\",\\n \\"Title\\": \\"ClassTitle001\\",\\n \\"CreateUserId\\": \\"as****hs\\",\\n \\"CreateNickname\\": \\"nickname001\\",\\n \\"Status\\": 2,\\n \\"StartTime\\": 1632794405000,\\n \\"EndTime\\": 1632797405000,\\n \\"RoomId\\": \\"AE35-****-T95F\\",\\n \\"LiveId\\": \\"b7f2****ebb3\\",\\n \\"ConfId\\": \\"fb0f-****-4cb1\\",\\n \\"WhiteboardId\\": \\"fgej**2\\",\\n \\"WhiteboardRecordId\\": \\"eofg**rt\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n A55-****-Y34O\\n \\n as****hs\\n nickname001\\n 2\\n 1632794405000\\n 1632797405000\\n AE35-****-T95F\\n b7f2****ebb3\\n fb0f-****-4cb1\\n fgej**2\\n eofg**rt\\n \\n","errorExample":""}]', ], 'ListClasses' => [ 'summary' => '获取课程列表', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'lq****cu', ], ], [ 'name' => 'Status', 'in' => 'formData', 'schema' => [ 'title' => '课程状态，0-未开课 1-上课中 2-已下课，不传则返回所有课程。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'title' => '查询页码，从1开始，传空默认查询第1页。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'title' => '每页显示个数，最大支持50，参数为空默认显示个数为10。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '25', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ER52****O9CA', ], 'Result' => [ 'title' => '创建课程返回的结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '课程总数。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', ], 'PageTotal' => [ 'title' => '课程总页数。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'HasMore' => [ 'title' => '是否还有下一页。', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'ClassList' => [ 'title' => '课程列表信息。', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ClassId' => [ 'title' => '课堂唯一标识，由调用CreateClass返回。', 'description' => '', 'type' => 'string', 'example' => 'AE35****T95F', ], 'Title' => [ 'title' => '课堂标题。', 'description' => '', 'type' => 'string', 'example' => 'PPT制作培训', ], 'CreateUserId' => [ 'title' => '创建人ID。', 'description' => '', 'type' => 'string', 'example' => '34***45', ], 'CreateNickname' => [ 'title' => '创建人昵称。', 'description' => '', 'type' => 'string', 'example' => '随风', ], 'Status' => [ 'title' => '课堂状态，0:未开始 1:上课中 2:已下课。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'StartTime' => [ 'title' => '开始上课时间戳，毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '16****450', ], 'EndTime' => [ 'title' => '下课时间戳，毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '16****950', ], 'RoomId' => [ 'title' => '房间ID', 'description' => '', 'type' => 'string', 'example' => 'AE35-****-T95F', ], 'LiveId' => [ 'title' => '直播的唯一标识ID。', 'description' => '', 'type' => 'string', 'example' => 'b7f2****ebb3', ], 'ConfId' => [ 'title' => '连麦会议唯一标识。', 'description' => '', 'type' => 'string', 'example' => 'fb0f-****-4cb1', ], 'WhiteboardId' => [ 'title' => '白板ID', 'description' => '', 'type' => 'string', 'example' => 'fgej**2', ], 'WhiteboardRecordId' => [ 'title' => '白板录制ID', 'description' => '', 'type' => 'string', 'example' => 'eofg**rt', ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ER52****O9CA\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 1000,\\n \\"PageTotal\\": 100,\\n \\"HasMore\\": true,\\n \\"ClassList\\": [\\n {\\n \\"ClassId\\": \\"AE35****T95F\\",\\n \\"Title\\": \\"PPT制作培训\\",\\n \\"CreateUserId\\": \\"34***45\\",\\n \\"CreateNickname\\": \\"随风\\",\\n \\"Status\\": 2,\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 0,\\n \\"RoomId\\": \\"AE35-****-T95F\\",\\n \\"LiveId\\": \\"b7f2****ebb3\\",\\n \\"ConfId\\": \\"fb0f-****-4cb1\\",\\n \\"WhiteboardId\\": \\"fgej**2\\",\\n \\"WhiteboardRecordId\\": \\"eofg**rt\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n ER52****O9CA\\n \\n 1000\\n 100\\n true\\n \\n AE35****T95F\\n \\n 34***45\\n 随风\\n 2\\n AE35-****-T95F\\n b7f2****ebb3\\n fb0f-****-4cb1\\n fgej**2\\n eofg**rt\\n \\n \\n","errorExample":""}]', ], 'GetClassRecord' => [ 'summary' => '获取课程录制详情', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'lq****cu', ], ], [ 'name' => 'ClassId', 'in' => 'formData', 'schema' => [ 'title' => '课程唯一标识，由调用CreateClass返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '操作人用户ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '34**29', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => 'API请求的返回结果结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'PlaybackUrlMap' => [ 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'array', 'items' => [ 'type' => 'string', 'example' => 'http://***.aliyuncs.com/***8fc5-***f8****.webm?****77650&***xzSQU***', 'description' => '', ], 'description' => '', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"PlaybackUrlMap\\": {\\n \\"key\\": [\\n \\"http://***.aliyuncs.com/***8fc5-***f8****.webm?****77650&***xzSQU***\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n \\n http://***.aliyuncs.com/***8fc5-***f8****.webm?****77650&***xzSQU***\\n \\n \\n","errorExample":""}]', ], 'UpdateShareScreenLayout' => [ 'summary' => '更新共享桌面下叠加画面的布局', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'lq****cu', ], ], [ 'name' => 'ClassId', 'in' => 'formData', 'schema' => [ 'title' => '课堂唯一标识，由调用CreateClass返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'EnableOverlay', 'in' => 'formData', 'schema' => [ 'title' => '是否开启叠加老师画面', 'description' => '', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'OverlayX', 'in' => 'formData', 'schema' => [ 'title' => '叠加画面X坐标，归一化为1', 'description' => '', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], ], [ 'name' => 'OverlayY', 'in' => 'formData', 'schema' => [ 'title' => '叠加画面Y坐标，归一化为1', 'description' => '', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], ], [ 'name' => 'OverlayWidth', 'in' => 'formData', 'schema' => [ 'title' => '叠加画面宽度，归一化为1', 'description' => '', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.2361', ], ], [ 'name' => 'OverlayHeight', 'in' => 'formData', 'schema' => [ 'title' => '叠加画面高度，归一化为1', 'description' => '', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.2361', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n","errorExample":""}]', ], 'CreateRoom' => [ 'summary' => '创建房间', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'TemplateId', 'in' => 'formData', 'schema' => [ 'title' => '房间模板唯一标识，当前支持的取值：default，传空默认为default。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'default', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间唯一标识，由字母、数字、符号.和-组成，最大长度36位，传空则随机生成一个房间id。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'AE35-****-T95F', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => [ 'title' => '房间标题，支持中英文，最大长度32位。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'RoomTitle001', ], ], [ 'name' => 'Notice', 'in' => 'formData', 'schema' => [ 'title' => '房间公告，支持中英文，最大长度256位。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'RoomNotice001', ], ], [ 'name' => 'RoomOwnerId', 'in' => 'formData', 'schema' => [ 'title' => '房主用户id，仅支持英文和数字，最大长度36位。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], [ 'name' => 'Extension', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '拓展字段，按需传递，需要额外记录的房间属性。', 'description' => '', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'required' => false, 'example' => 'test001', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => 'API请求的返回结果结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'RoomId' => [ 'title' => '房间id', 'description' => '', 'type' => 'string', 'example' => 'AE35-****-T95F', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidRoomId.Room.AlreadyExist', 'errorMessage' => 'Room is already exist.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"RoomId\\": \\"AE35-****-T95F\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n AE35-****-T95F\\n \\n","errorExample":""}]', ], 'DeleteRoom' => [ 'summary' => '销毁房间', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间唯一标识，由字母、数字、符号.和-组成，最大长度36位。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidRoomId.Room.NotExist', 'errorMessage' => 'Room does not exist.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n","errorExample":""}]', ], 'UpdateRoom' => [ 'summary' => '更新房间信息', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间唯一标识。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => [ 'title' => '房间标题，支持中英文，最大长度32位。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'RoomTitle001', ], ], [ 'name' => 'Notice', 'in' => 'formData', 'schema' => [ 'title' => '房间公告，支持中英文，最大长度256位。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'RoomNotice001', ], ], [ 'name' => 'RoomOwnerId', 'in' => 'formData', 'schema' => [ 'title' => '房主用户id，仅支持英文和数字，最大长度36位。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'as****hs', ], ], [ 'name' => 'Extension', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '拓展字段，按需传递，需要额外记录的房间属性。', 'description' => '', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'required' => false, 'example' => 'test001', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidRoomId.Room.NotExist', 'errorMessage' => 'Room does not exist.', ], [ 'errorCode' => 'Forbidden.Room.Deleted', 'errorMessage' => 'Room has been deleted.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n","errorExample":""}]', ], 'KickRoomUser' => [ 'summary' => '踢出房间用户', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间唯一标识，由字母、数字、符号.和-组成，最大长度36位，传空则随机生成一个房间id。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '操作人的用户ID，用于表示谁执行了踢人操作。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], [ 'name' => 'KickUser', 'in' => 'formData', 'schema' => [ 'title' => '被踢出房间的用户ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'er****h', ], ], [ 'name' => 'BlockTime', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n","errorExample":""}]', ], 'SetUserAdmin' => [ 'summary' => '设置用户管理员', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间唯一标识，由字母、数字、符号.和-组成，最大长度36位。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '用户ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'er****h', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Forbidden.Room.AdminNumberOverLimit', 'errorMessage' => 'Room admin number exceeds limit.', ], [ 'errorCode' => 'Forbidden.Room.OwnerCannotBeAdmin', 'errorMessage' => 'Room owner cannot be admin.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n","errorExample":""}]', ], 'CancelUserAdmin' => [ 'summary' => '取消用户管理员', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间唯一标识，由字母、数字、符号.和-组成，最大长度36位。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '用户ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'er****h', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n","errorExample":""}]', ], 'GetRoom' => [ 'summary' => '获取房间详情', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间唯一标识，由字母、数字、符号.和-组成，最大长度36位。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '查询房间信息返回结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'RoomInfo' => [ 'title' => '房间信息。', 'description' => '', 'type' => 'object', 'properties' => [ 'RoomId' => [ 'title' => '房间唯一标识。', 'description' => '', 'type' => 'string', 'example' => 'AE35-****-T95F', ], 'Title' => [ 'title' => '房间标题。', 'description' => '', 'type' => 'string', 'example' => 'RoomTitle001', ], 'CreateTime' => [ 'title' => '房间创建时间戳，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624589848000', ], 'Notice' => [ 'title' => '房间公告。', 'description' => '', 'type' => 'string', 'example' => 'RoomNotice001', ], 'RoomOwnerId' => [ 'title' => '房主用户id。', 'description' => '', 'type' => 'string', 'example' => 'as****hs', ], 'Uv' => [ 'title' => '访问用户数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'OnlineCount' => [ 'title' => '在线用户数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'PluginInstanceInfoList' => [ 'title' => '活跃插件列表。', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PluginType' => [ 'title' => '插件唯一标识，取值：live-直播，wb-白板，chat-聊天，rtc。', 'description' => '', 'type' => 'string', 'example' => 'live', ], 'PluginId' => [ 'title' => '插件实例唯一标识。', 'description' => '', 'type' => 'string', 'example' => 'HASU-****-ASHD', ], 'CreateTime' => [ 'title' => '插件实例创建时间戳，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624589848000', ], 'Extension' => [ 'title' => '插件拓展字段。', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'description' => '', 'example' => 'test001', ], ], ], ], ], 'AppId' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'example' => 'lq****cu', ], 'TemplateId' => [ 'title' => '创建房间使用的模板id。', 'description' => '', 'type' => 'string', 'example' => 'default', ], 'Extension' => [ 'title' => '房间拓展字段。', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'test001', 'description' => '', ], ], 'Pv' => [ 'title' => '访问用户人次。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'AdminIdList' => [ 'title' => '管理员ID列表。', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'as****hs', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidRoomId.Room.NotExist', 'errorMessage' => 'Room does not exist.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"RoomInfo\\": {\\n \\"RoomId\\": \\"AE35-****-T95F\\",\\n \\"Title\\": \\"RoomTitle001\\",\\n \\"CreateTime\\": 1624589848000,\\n \\"Notice\\": \\"RoomNotice001\\",\\n \\"RoomOwnerId\\": \\"as****hs\\",\\n \\"Uv\\": 100,\\n \\"OnlineCount\\": 50,\\n \\"PluginInstanceInfoList\\": [\\n {\\n \\"PluginType\\": \\"live\\",\\n \\"PluginId\\": \\"HASU-****-ASHD\\",\\n \\"CreateTime\\": 1624589848000,\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n }\\n }\\n ],\\n \\"AppId\\": \\"lq****cu\\",\\n \\"TemplateId\\": \\"default\\",\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n },\\n \\"Pv\\": 200,\\n \\"AdminIdList\\": [\\n \\"as****hs\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n \\n AE35-****-T95F\\n \\n 1624589848000\\n RoomNotice001\\n as****hs\\n 100\\n 50\\n \\n live\\n HASU-****-ASHD\\n 1624589848000\\n \\n test001\\n \\n \\n lq****cu\\n default\\n \\n test001\\n \\n 200\\n as****hs\\n \\n \\n","errorExample":""}]', ], 'ListRooms' => [ 'summary' => '查询租户下的房间列表', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'title' => '查询页码，从1开始，传空默认查询第1页。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'title' => '每页显示个数，最大支持50，参数为空默认显示个数为10。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'exclusiveMaximum' => false, 'minimum' => '1', 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => 'API请求的返回结果结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '该应用的房间总数。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', ], 'PageTotal' => [ 'title' => '该应用的房间总页数。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'HasMore' => [ 'title' => '是否还有下一页房间列表。', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'RoomInfoList' => [ 'title' => '房间列表信息。', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RoomId' => [ 'title' => '房间唯一标识。', 'description' => '', 'type' => 'string', 'example' => 'AE35-****-T95F', ], 'Title' => [ 'title' => '房间标题。', 'description' => '', 'type' => 'string', 'example' => 'RoomTitle001', ], 'RoomOwnerId' => [ 'title' => '房主用户id。', 'description' => '', 'type' => 'string', 'example' => 'as****hs', ], 'Notice' => [ 'title' => '房间公告。', 'description' => '', 'type' => 'string', 'example' => 'RoomNotice001', ], 'Uv' => [ 'title' => '用户访问数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'OnlineCount' => [ 'title' => '用户在线数。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'PluginInstanceInfoList' => [ 'title' => '活跃插件列表。', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'PluginType' => [ 'title' => '插件唯一标识，取值：live-直播，wb-白板，chat-聊天，rtc。', 'description' => '', 'type' => 'string', 'example' => 'live', ], 'PluginId' => [ 'title' => '插件实例唯一标识。', 'description' => '', 'type' => 'string', 'example' => 'H63U-****-AS7D', ], 'CreateTime' => [ 'title' => '插件实例创建时间戳，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624589848000', ], 'Extension' => [ 'title' => '插件拓展字段。', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'description' => '', 'example' => 'test001', ], ], ], ], ], 'CreateTime' => [ 'title' => '房间创建时间戳，单位：毫秒。', 'description' => '', 'type' => 'string', 'example' => '1624589848000', ], 'AppId' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'example' => '7m***q', ], 'TemplateId' => [ 'title' => '创建房间使用的模板id。', 'description' => '', 'type' => 'string', 'example' => 'default', ], 'Extension' => [ 'title' => '房间拓展字段。', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'description' => '', 'example' => 'test001', ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Forbidden.Room.InvalidPageNumber', 'errorMessage' => 'PageNumber is invalid.', ], [ 'errorCode' => 'Forbidden.Room.InvalidPageSize', 'errorMessage' => 'PageSize exceeds maximum limit.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 1000,\\n \\"PageTotal\\": 100,\\n \\"HasMore\\": true,\\n \\"RoomInfoList\\": [\\n {\\n \\"RoomId\\": \\"AE35-****-T95F\\",\\n \\"Title\\": \\"RoomTitle001\\",\\n \\"RoomOwnerId\\": \\"as****hs\\",\\n \\"Notice\\": \\"RoomNotice001\\",\\n \\"Uv\\": 100,\\n \\"OnlineCount\\": 50,\\n \\"PluginInstanceInfoList\\": [\\n {\\n \\"PluginType\\": \\"live\\",\\n \\"PluginId\\": \\"H63U-****-AS7D\\",\\n \\"CreateTime\\": 1624589848000,\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n }\\n }\\n ],\\n \\"CreateTime\\": \\"1624589848000\\",\\n \\"AppId\\": \\"7m***q\\",\\n \\"TemplateId\\": \\"default\\",\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n 1000\\n 100\\n true\\n \\n AE35-****-T95F\\n \\n as****hs\\n RoomNotice001\\n 100\\n 50\\n \\n live\\n H63U-****-AS7D\\n 1624589848000\\n \\n test001\\n \\n \\n 1624589848000\\n 7m***q\\n default\\n \\n test001\\n \\n \\n \\n","errorExample":""}]', ], 'ListRoomUsers' => [ 'summary' => '查询房间用户列表', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'title' => '查询页码，从1开始，传空默认查询第1页。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'title' => '每页显示个数，最大支持50，参数为空默认显示个数为10。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'exclusiveMaximum' => false, 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间ID，最大长度36个字符。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => 'API请求的返回结果结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '该房间的用户总数。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', ], 'PageTotal' => [ 'title' => '该房间的用户总页数。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'HasMore' => [ 'title' => '是否还有下一页用户列表。', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'RoomUserList' => [ 'title' => '房间用户列表信息。', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户唯一标识。', 'description' => '', 'type' => 'string', 'example' => 'as****hs', ], 'Nick' => [ 'title' => '用户昵称。', 'description' => '', 'type' => 'string', 'example' => 'User001', ], 'Extension' => [ 'title' => '用户拓展字段。', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'test001', 'description' => '', ], ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 1000,\\n \\"PageTotal\\": 100,\\n \\"HasMore\\": true,\\n \\"RoomUserList\\": [\\n {\\n \\"UserId\\": \\"as****hs\\",\\n \\"Nick\\": \\"User001\\",\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n 1000\\n 100\\n true\\n \\n as****hs\\n User001\\n \\n test001\\n \\n \\n \\n","errorExample":""}]', ], 'CreateSensitiveWord' => [ 'summary' => '创建敏感词', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '用户的应用ID，在控制台创建应用时生成。包含小写字母、数字，长度为6个字符。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'WordList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], 'required' => true, 'docRequired' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '调用发送直播间弹幕的返回结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], 'example' => '0io**Fs6Q384', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidAppId.Error', 'errorMessage' => 'The specified AppId is invalid.', ], [ 'errorCode' => 'Forbidden.SensitiveWordCount.ExceedLimit', 'errorMessage' => 'The total count of sensitive word exceeds the limit.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n ER52****O9CA\\n \\n true\\n \\n","errorExample":""}]', ], 'DeleteSensitiveWord' => [ 'summary' => '删除敏感词', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '弹幕发送者的用户ID，最大长度不超过32个字节。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'WordList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '调用发送直播间弹幕的返回结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], 'example' => '0io**Fs6Q384', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n true\\n \\n","errorExample":""}]', ], 'ListSensitiveWord' => [ 'summary' => '获取敏感词列表', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '弹幕发送者的用户ID，最大长度不超过32个字节。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'PageNum', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '100', 'default' => '100', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '调用发送直播间弹幕的返回结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'WordList' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => '', ], ], 'TotalCount' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], ], 'example' => '0io**Fs6Q384', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidAppId.Error', 'errorMessage' => 'The specified AppId is invalid.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"WordList\\": [\\n \\"测试敏感词\\"\\n ],\\n \\"TotalCount\\": 100\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n 测试敏感词\\n 100\\n \\n","errorExample":""}]', ], 'CancelBanAllComment' => [ 'summary' => '取消禁言房间内所有用户', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间唯一标识，由调用CreateRoom返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '用户在房间内的唯一标识', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '操作成功标识', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Forbidden.Chat.NoPermissionToOperate', 'errorMessage' => 'The user has no permission to operate.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n true\\n","errorExample":""}]', ], 'CancelBanComment' => [ 'summary' => '取消禁言房间内用户', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间唯一标识，由调用CreateRoom返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '用户在房间内的唯一标识', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], [ 'name' => 'BanCommentUser', 'in' => 'formData', 'schema' => [ 'title' => '取消禁言的用户唯一标识', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'er****h', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '操作成功标识', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Forbidden.Chat.NoPermissionToOperate', 'errorMessage' => 'The user has no permission to operate.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n true\\n","errorExample":""}]', ], 'BanAllComment' => [ 'summary' => '禁言房间内所有用户', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间唯一标识，由调用CreateRoom返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '用户在房间内的唯一标识', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '操作成功标识', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Forbidden.Chat.NoPermissionToOperate', 'errorMessage' => 'The user has no permission to operate.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n true\\n","errorExample":""}]', ], 'BanComment' => [ 'summary' => '禁言用户', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间唯一标识，由调用CreateRoom返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '用户在房间内的唯一标识', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], [ 'name' => 'BanCommentUser', 'in' => 'formData', 'schema' => [ 'title' => '被禁言的用户在房间内的唯一标识', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'er****h', ], ], [ 'name' => 'BanCommentTime', 'in' => 'formData', 'schema' => [ 'title' => '禁言时长（秒）', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '操作是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Forbidden.Chat.NoPermissionToOperate', 'errorMessage' => 'The user has no permission to operate.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n true\\n","errorExample":""}]', ], 'SendCustomMessageToAll' => [ 'summary' => '对房间中全部成员发送普通自定义消息', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间唯一标识，由调用CreateRoom返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F', ], ], [ 'name' => 'Body', 'in' => 'formData', 'schema' => [ 'title' => '消息体内容。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'Hello, World', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => 'API请求的返回结果结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'MessageId' => [ 'title' => '消息的唯一ID标识。由数字、大小写字母组成，长度不超过20。', 'description' => '', 'type' => 'string', 'example' => '0io**Fs6Q384', ], ], 'example' => '0io**Fs6Q384', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"MessageId\\": \\"0io**Fs6Q384\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n 0io**Fs6Q384\\n \\n","errorExample":""}]', ], 'SendCustomMessageToUsers' => [ 'summary' => '对房间中指定成员发送普通自定义消息', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，由6位小写字母、数字组成。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间唯一标识，由调用CreateRoom返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F', ], ], [ 'name' => 'Body', 'in' => 'formData', 'schema' => [ 'title' => '消息体内容。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'Hello, World', ], ], [ 'name' => 'ReceiverList', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'title' => '消息指定的接收人ID列表。', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '["34**29"]', ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => 'API请求的返回结果结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'MessageId' => [ 'title' => '消息的唯一ID标识。由数字、大小写字母组成，长度不超过20。', 'description' => '', 'type' => 'string', 'example' => '0io**Fs6Q384', ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"MessageId\\": \\"0io**Fs6Q384\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n 0io**Fs6Q384\\n \\n","errorExample":""}]', ], 'SendComment' => [ 'summary' => '发送直播间弹幕', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，可以包含小写字母、数字，长度为6个字符。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '直播间唯一标识，在调用CreateRoom返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'SenderId', 'in' => 'formData', 'schema' => [ 'title' => '弹幕发送者的用户ID，最大长度不超过32个字节。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '62**59', ], ], [ 'name' => 'SenderNick', 'in' => 'formData', 'schema' => [ 'title' => '弹幕消息发送者的昵称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Tom', ], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => [ 'title' => '发送的文本内容。最大的长度不超过256个字节。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'Hello, World', ], ], [ 'name' => 'Extension', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '扩展字段，服务端仅做透传。', 'description' => '', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'example' => 'value', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '调用发送直播间弹幕的返回结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'CommentVO' => [ 'title' => '返回的弹幕数据模型。', 'description' => '', 'type' => 'object', 'properties' => [ 'CommentId' => [ 'title' => '弹幕的唯一ID。', 'description' => '', 'type' => 'string', 'example' => '09***f8', ], 'SenderId' => [ 'title' => '弹幕的发送者ID标识。', 'description' => '', 'type' => 'string', 'example' => '62**59', ], 'SenderNick' => [ 'title' => '弹幕发送者的昵称。', 'description' => '', 'type' => 'string', 'example' => 'Tom', ], 'CreateAt' => [ 'title' => '弹幕的创建时间，Unix时间戳，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1628438400000', ], 'Content' => [ 'title' => '弹幕的内容。', 'description' => '', 'type' => 'string', 'example' => 'Hello,World', ], 'Extension' => [ 'title' => '扩展字段。', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'value', 'description' => '', ], ], ], 'example' => '0io**Fs6Q384', ], ], 'example' => '0io**Fs6Q384', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Forbidden.Chat.HasBeenBanned', 'errorMessage' => 'The user is banned from posting a comment.', ], [ 'errorCode' => 'Forbidden.Chat.SendCommentFrequencyLimited', 'errorMessage' => 'The frequency of SendComment for this user is limited.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"CommentVO\\": {\\n \\"CommentId\\": \\"09***f8\\",\\n \\"SenderId\\": \\"62**59\\",\\n \\"SenderNick\\": \\"Tom\\",\\n \\"CreateAt\\": 1628438400000,\\n \\"Content\\": \\"Hello,World\\",\\n \\"Extension\\": {\\n \\"key\\": \\"value\\"\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n \\n 09***f8\\n 62**59\\n Tom\\n 1628438400000\\n Hello,World\\n \\n value\\n \\n \\n \\n","errorExample":""}]', ], 'DeleteComment' => [ 'summary' => '删除直播间弹幕', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，可以包含小写字母、数字，长度为6个字符。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '直播间唯一标识，在调用CreateRoom返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '删除的操作人ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], [ 'name' => 'CommentIdList', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'title' => '需要删除的弹幕id列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '09***f8', ], 'required' => true, 'example' => 'Hello, World', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '调用删除直播间弹幕的返回结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'DeleteResult' => [ 'title' => '删除的结果', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], 'example' => '0io**Fs6Q384', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"DeleteResult\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n true\\n \\n","errorExample":""}]', ], 'ListComments' => [ 'summary' => '查询弹幕消息列表', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '用户的应用ID，在控制台创建应用时生成。包含小写字母、数字，长度为6个字符。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间的唯一标识，在调用CreateRoom时返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '操作人用户ID，表示谁执行了查询弹幕消息列表的操作。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '62**59', ], ], [ 'name' => 'CreatorId', 'in' => 'formData', 'schema' => [ 'title' => '弹幕创建者ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '10**13', ], ], [ 'name' => 'PageNum', 'in' => 'formData', 'schema' => [ 'title' => '查询弹幕消息列表的分页页数。应该从1开始，每次分页拉取时递增。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'title' => '查询弹幕消息列表的分页大小。最小不得小于1，最大不得超过100。如果超过100，会被截断为前100条。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '50', ], ], [ 'name' => 'SortType', 'in' => 'formData', 'schema' => [ 'title' => '查询弹幕消息列表的排序方式。取值仅限0和1，其中0表示按照弹幕消息创建时间递增的顺序拉取，1表示按照弹幕消息创建时间递减的时间拉取。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'ER52****O9CA', ], 'Result' => [ 'title' => '调用查询弹幕消息列表的返回结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'CommentVOList' => [ 'title' => '弹幕消息列表。', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => '应用ID。', 'description' => '', 'type' => 'string', 'example' => '7m***q', ], 'RoomId' => [ 'title' => '房间ID。', 'description' => '', 'type' => 'string', 'example' => 'AE35****T95F', ], 'CommentId' => [ 'title' => '弹幕消息的唯一ID标识。', 'description' => '', 'type' => 'string', 'example' => '09***f8', ], 'SenderId' => [ 'title' => '弹幕消息的发送者ID标识。', 'description' => '', 'type' => 'string', 'example' => '62**59', ], 'SenderNick' => [ 'title' => '弹幕消息发送者的昵称。', 'description' => '', 'type' => 'string', 'example' => 'Tom', ], 'CreateAt' => [ 'title' => '弹幕消息的创建时间，Unix时间戳，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1628438400000', ], 'Content' => [ 'title' => '弹幕消息的内容。', 'description' => '', 'type' => 'string', 'example' => 'Hello,World', ], 'Extension' => [ 'title' => '扩展字段。', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'value', 'description' => '', ], ], ], ], ], 'HasMore' => [ 'title' => '是否还有下一页数据。true表示还有，false表示没有。', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'TotalCount' => [ 'title' => '弹幕消息的总数。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'PageTotal' => [ 'title' => '分页查询弹幕消息列表的总页数。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], 'example' => '0io**Fs6Q384', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ER52****O9CA\\",\\n \\"Result\\": {\\n \\"CommentVOList\\": [\\n {\\n \\"AppId\\": \\"7m***q\\",\\n \\"RoomId\\": \\"AE35****T95F\\",\\n \\"CommentId\\": \\"09***f8\\",\\n \\"SenderId\\": \\"62**59\\",\\n \\"SenderNick\\": \\"Tom\\",\\n \\"CreateAt\\": 1628438400000,\\n \\"Content\\": \\"Hello,World\\",\\n \\"Extension\\": {\\n \\"key\\": \\"value\\"\\n }\\n }\\n ],\\n \\"HasMore\\": true,\\n \\"TotalCount\\": 100,\\n \\"PageTotal\\": 2\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n ER52****O9CA\\n \\n \\n 7m***q\\n AE35****T95F\\n 09***f8\\n 62**59\\n Tom\\n 1628438400000\\n Hello,World\\n \\n value\\n \\n \\n true\\n 100\\n 2\\n \\n","errorExample":""}]', ], 'DeleteCommentByCreatorId' => [ 'summary' => '根据创建者删除直播间弹幕', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，可以包含小写字母、数字，长度为6个字符。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '直播间唯一标识，在调用CreateRoom返回。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '删除的操作人ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '62**59', ], ], [ 'name' => 'CreatorId', 'in' => 'formData', 'schema' => [ 'title' => '弹幕的创建者ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '12**86', ], ], [ 'name' => 'CommentIdList', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'title' => '需要删除的弹幕id列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '09***f8', ], 'required' => false, 'example' => 'Hello, World', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'ER52****O9CA', ], 'Result' => [ 'title' => '调用删除直播间弹幕的返回结果。', 'description' => '', 'type' => 'object', 'properties' => [ 'DeleteResult' => [ 'title' => '删除的结果', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], 'example' => '0io**Fs6Q384', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ER52****O9CA\\",\\n \\"Result\\": {\\n \\"DeleteResult\\": true\\n }\\n}","type":"json"}]', ], 'DeleteConference' => [ 'summary' => '删除会议记录', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '租户名', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间ID，最大长度36位', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '创建会议用户ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], [ 'name' => 'ConferenceId', 'in' => 'formData', 'schema' => [ 'title' => '会议资源的唯一标识ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'fb0f-****-4cb1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '', 'type' => 'string', 'example' => '16A96B9A-****-CB92E68F4CD8', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidConferenceId.Rtc.DataNotExist', 'errorMessage' => 'The specified parameter conferenceId does not exist in our records.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 16A96B9A-****-CB92E68F4CD8\\n","errorExample":""}]', ], 'RemoveMember' => [ 'summary' => '移除会议成员', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ConferenceId', 'in' => 'formData', 'schema' => [ 'title' => '会议唯一标识', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'fb0f-****-4cb1', ], ], [ 'name' => 'ToUserId', 'in' => 'formData', 'schema' => [ 'title' => '被邀请用户ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '45***9', ], ], [ 'name' => 'FromUserId', 'in' => 'formData', 'schema' => [ 'title' => '邀请者用户ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '23***7', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.Rtc.UserNoPermission', 'errorMessage' => 'The user is not authorized to operate on the specified resource.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n","errorExample":""}]', ], 'GetConference' => [ 'summary' => '获取会议信息', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ConferenceId', 'in' => 'formData', 'schema' => [ 'title' => '会议资源唯一标识。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'fb0f-****-4cb1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '返回结果', 'description' => '', 'type' => 'object', 'properties' => [ 'ConferenceId' => [ 'title' => '会议资源唯一标识。', 'description' => '', 'type' => 'string', 'example' => 'fb0f-****-4cb1', ], 'Title' => [ 'title' => '会议标题。', 'description' => '', 'type' => 'string', 'example' => 'This is a Title', ], 'Status' => [ 'title' => '会议状态。', 'description' => '', 'type' => 'string', 'example' => 'Init', ], 'RoomId' => [ 'title' => '房间ID。', 'description' => '', 'type' => 'string', 'example' => 'AE35-****-T95F', ], 'UserId' => [ 'title' => '创建会议用户。', 'description' => '', 'type' => 'string', 'example' => 'as****hs', ], 'AppId' => [ 'title' => '租户名', 'description' => '', 'type' => 'string', 'example' => '7m***q', ], 'CreateTime' => [ 'title' => '会议创建时间戳，单位：毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624589848000', ], 'PlaybackUrl' => [ 'title' => '录制回放地址，m3u8格式，会议结束后10秒才会生成。', 'description' => '', 'type' => 'string', 'example' => 'http://xxxx.com/b7f29c02-****-40fd-****-e8d06a8aebb3_merged.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], ], 'example' => 'true', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"ConferenceId\\": \\"fb0f-****-4cb1\\",\\n \\"Title\\": \\"This is a Title\\",\\n \\"Status\\": \\"Init\\",\\n \\"RoomId\\": \\"AE35-****-T95F\\",\\n \\"UserId\\": \\"as****hs\\",\\n \\"AppId\\": \\"7m***q\\",\\n \\"CreateTime\\": 1624589848000,\\n \\"PlaybackUrl\\": \\"http://xxxx.com/b7f29c02-****-40fd-****-e8d06a8aebb3_merged.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n fb0f-****-4cb1\\n \\n Init\\n AE35-****-T95F\\n as****hs\\n 7m***q\\n 1624589848000\\n http://xxxx.com/b7f29c02-****-40fd-****-e8d06a8aebb3_merged.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\n \\n","errorExample":""}]', ], 'ListConferenceUsers' => [ 'summary' => '分页查询会议成员列表', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ConferenceId', 'in' => 'formData', 'schema' => [ 'title' => '会议唯一标识符', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'fb0f-****-4cb1', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'title' => '查询页码，从第1页开始。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'title' => '每页显示个数，最大显示个数为100。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'title' => '返回结果', 'description' => '', 'type' => 'object', 'properties' => [ 'ConferenceUserList' => [ 'title' => '会议用户列表。', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID。', 'description' => '', 'type' => 'string', 'example' => '4*****9', ], 'Status' => [ 'title' => '用户状态。', 'description' => '', 'type' => 'string', 'example' => 'active', ], ], ], 'example' => 'myApp', ], 'HasMore' => [ 'title' => '是否还有数据', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'TotalCount' => [ 'title' => '总条目数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'PageTotal' => [ 'title' => '总页数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], ], 'example' => 'true', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"ConferenceUserList\\": [\\n {\\n \\"UserId\\": \\"4*****9\\",\\n \\"Status\\": \\"active\\"\\n }\\n ],\\n \\"HasMore\\": true,\\n \\"TotalCount\\": 100,\\n \\"PageTotal\\": 100\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n \\n 4*****9\\n active\\n \\n true\\n 100\\n 100\\n \\n","errorExample":""}]', ], 'GetStandardRoomJumpUrl' => [ 'summary' => '获取样板间服务跳转链接', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '用户的应用ID，在控制台创建应用时生成', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '用户UserId,在AppId下单独唯一', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], [ 'name' => 'AppKey', 'in' => 'formData', 'schema' => [ 'title' => '终端设备类型,通过控制台创建和查询', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '06***9c', ], ], [ 'name' => 'Platform', 'in' => 'formData', 'schema' => [ 'title' => '平台：win, mac, android, ios, web', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'web', ], ], [ 'name' => 'BizType', 'in' => 'formData', 'schema' => [ 'title' => '业务类型：互动直播live，互动课堂class', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'live', ], ], [ 'name' => 'BizId', 'in' => 'formData', 'schema' => [ 'title' => '资源ID：根据业务类型来定，比如直播ID，课堂ID等', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2-****-ebb3', ], ], [ 'name' => 'UserNick', 'in' => 'formData', 'schema' => [ 'title' => '用户昵称', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'James', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '16A96B9A-****-CB92E68F4CD8', ], 'Result' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'StandardRoomJumpUrl' => [ 'title' => '样板间跳转协议地址', 'description' => '', 'type' => 'string', 'example' => 'http://xxx.com/standard_live?appId=l***u&userId=jm6&userAuthSession=0c179505-6d14-**-88a888d849ec&roomId=b807bd2a-**-96e1-c5753f13a5eb&appKey=63***3d&callback=https%3A%2F%2Fxxx.com%2Fapi%2Flogin%2FcheckUserAuthSession', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter.StandardRoom.LowCodeDomainNotConfig', 'errorMessage' => 'This app is not configured with a low-code domain name.', ], [ 'errorCode' => 'InvalidAppId.StandardRoom.CnameNotConfig', 'errorMessage' => 'The low-code integration service does not have a CNAME configured.', ], [ 'errorCode' => 'InvalidParameter.StandardRoom.AppKeyNotMatch', 'errorMessage' => 'The parameter AppId and the parameter AppKey do not match.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"StandardRoomJumpUrl\\": \\"http://xxx.com/standard_live?appId=l***u&userId=jm6&userAuthSession=0c179505-6d14-**-88a888d849ec&roomId=b807bd2a-**-96e1-c5753f13a5eb&appKey=63***3d&callback=https%3A%2F%2Fxxx.com%2Fapi%2Flogin%2FcheckUserAuthSession\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 16A96B9A-****-CB92E68F4CD8\\n \\n http://xxx.com/standard_live?appId=l***u&userId=jm6&userAuthSession=0c179505-6d14-**-88a888d849ec&roomId=b807bd2a-**-96e1-c5753f13a5eb&appKey=63***3d&callback=https%3A%2F%2Fxxx.com%2Fapi%2Flogin%2FcheckUserAuthSession\\n \\n","errorExample":""}]', ], 'DescribeMeterImpWatchLiveTimeByLiveId' => [ 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'LiveId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Data' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'WatchTimeInLatency' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '32', ], 'WatchTimeInLowLatency' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '43', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Meter.ParamError', 'errorMessage' => 'Param Error:%s,Please Check Again.', ], ], 403 => [ [ 'errorCode' => 'Meter.AuthError', 'errorMessage' => 'Authentication Failed,Please Try Again.', ], ], 500 => [ [ 'errorCode' => 'Meter.ServerInternalError', 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', ], [ 'errorCode' => 'Meter.DataSourceQueryError', 'errorMessage' => 'Data Source Error:%s,Please Try Again.', ], ], 502 => [ [ 'errorCode' => 'Meter.ReadyTsError', 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Data\\": [\\n {\\n \\"WatchTimeInLatency\\": 32,\\n \\"WatchTimeInLowLatency\\": 43\\n }\\n ]\\n}","type":"json"}]', ], 'DescribeMeterImpPlayBackTimeByLiveId' => [ 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'LiveId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], [ 'name' => 'StartTs', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1632153600', ], ], [ 'name' => 'EndTs', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1637302350', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Data' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'WatchTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '32', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Meter.ParamError', 'errorMessage' => 'Param Error:%s,Please Check Again.', ], ], 403 => [ [ 'errorCode' => 'Meter.AuthError', 'errorMessage' => 'Authentication Failed,Please Try Again.', ], ], 500 => [ [ 'errorCode' => 'Meter.ServerInternalError', 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', ], [ 'errorCode' => 'Meter.DataSourceQueryError', 'errorMessage' => 'Data Source Error:%s,Please Try Again.', ], ], 502 => [ [ 'errorCode' => 'Meter.ReadyTsError', 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Data\\": [\\n {\\n \\"WatchTime\\": 32\\n }\\n ]\\n}","type":"json"}]', ], 'CreateLive' => [ 'summary' => '创建直播', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '应用唯一标识，可以包含小写字母、数字，长度为6个字符。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间ID，最大长度36个字符，传空值，则随机生成一个房间ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '创建直播用户。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播资源的唯一标识ID，缺省时系统自动生成36位随机uuid字符串。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'b7f2****ebb3', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => [ 'title' => '直播标题，支持中英文，最大长度256位。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'This is a title.', ], ], [ 'name' => 'Introduction', 'in' => 'formData', 'schema' => [ 'title' => '直播简介，支持中英文，最大长度2048位。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'This is an intro.', ], ], [ 'name' => 'AnchorId', 'in' => 'formData', 'schema' => [ 'title' => '主播ID，支持中英文，最大长度128位，缺省时主播为当前创建直播用户。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'as****hs', ], ], [ 'name' => 'CodeLevel', 'in' => 'formData', 'schema' => [ 'title' => '直播推流码率，缺省时默认为3。取值： -1：流畅lld。 1：标清lsd。 2：高清lhd。 3：超清lud。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'LiveId' => [ 'title' => '直播的唯一标识ID。', 'description' => '', 'type' => 'string', 'example' => 'b7f2****ebb3', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Forbidden.Room.LiveAlreadyExist', 'errorMessage' => 'The live instance already exists.', ], [ 'errorCode' => 'Invalid.Live.ConfigNotFound', 'errorMessage' => 'The live push domain and pull domain config not found.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"LiveId\\": \\"b7f2****ebb3\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n b7f2****ebb3\\n \\n ","errorExample":""}]', ], 'DeleteLive' => [ 'summary' => '删除直播记录', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播资源的唯一标识ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidLiveId.Live.NotFound', 'errorMessage' => 'The live broadcast does not exist.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n ","errorExample":""}]', ], 'PublishLive' => [ 'summary' => '发布直播', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播资源的唯一标识ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '当前用户Id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'LiveId' => [ 'title' => '直播资源的唯一标识ID', 'description' => '', 'type' => 'string', 'example' => 'b7f2****ebb3', ], 'AnchorId' => [ 'title' => '主播ID', 'description' => '', 'type' => 'string', 'example' => 'as****hs', ], 'Status' => [ 'title' => '直播状态：Created-已创建未开播，Living-直播中，End-直播结束', 'description' => '', 'type' => 'string', 'example' => '1', ], 'PushUrl' => [ 'title' => '直播推流地址', 'description' => '', 'type' => 'string', 'example' => 'rtmp://demo-app-push.com/live/b7f2****ebb3?auth_key=e620****a8e3', ], 'LiveUrl' => [ 'title' => '直播拉流地址', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f2****ebb3.flv?auth_key=e620****a8e3', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidLiveId.Live.NotFound', 'errorMessage' => 'The live broadcast does not exist.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"LiveId\\": \\"b7f2****ebb3\\",\\n \\"AnchorId\\": \\"as****hs\\",\\n \\"Status\\": \\"1\\",\\n \\"PushUrl\\": \\"rtmp://demo-app-push.com/live/b7f2****ebb3?auth_key=e620****a8e3\\",\\n \\"LiveUrl\\": \\"http://demo-app-live.com/live/b7f2****ebb3.flv?auth_key=e620****a8e3\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n b7f2****ebb3\\n as****hs\\n 1\\n rtmp://demo-app-push.com/live/b7f2****ebb3?auth_key=e620****a8e3\\n http://demo-app-live.com/live/b7f2****ebb3.flv?auth_key=e620****a8e3\\n \\n","errorExample":""}]', ], 'UpdateLive' => [ 'summary' => '更新直播信息', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播资源的唯一标识ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => [ 'title' => '直播标题，支持中英文，最大长度256位', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'This is a title.', ], ], [ 'name' => 'Introduction', 'in' => 'formData', 'schema' => [ 'title' => '直播简介，支持中英文，最大长度2048位', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'This is an introduction.', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidLiveId.Live.NotFound', 'errorMessage' => 'The live broadcast does not exist.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n ","errorExample":""}]', ], 'StopLive' => [ 'summary' => '停止直播', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'title' => '租户名', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7m***q', ], ], [ 'name' => 'RoomId', 'in' => 'formData', 'schema' => [ 'title' => '房间ID，最大长度36位', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F', ], ], [ 'name' => 'UserId', 'in' => 'formData', 'schema' => [ 'title' => '创建直播用户ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'as****hs', ], ], [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播资源的唯一标识ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidLiveId.Live.NotFound', 'errorMessage' => 'The live broadcast does not exist.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n ","errorExample":""}]', ], 'GetLive' => [ 'summary' => '获取直播详情', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'LiveId', 'in' => 'formData', 'schema' => [ 'title' => '直播资源的唯一标识ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', ], 'Result' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AnchorId' => [ 'title' => '主播ID', 'description' => '', 'type' => 'string', 'example' => 'as****hs', ], 'LiveId' => [ 'title' => '直播资源的唯一标识ID', 'description' => '', 'type' => 'string', 'example' => 'b7f2****ebb3', ], 'Title' => [ 'title' => '直播标题', 'description' => '', 'type' => 'string', 'example' => 'This is a title.', ], 'PlaybackUrl' => [ 'title' => '直播回放地址', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-playback.com/live/b7f2****ebb3.m3u8?auth_key=e620****a8e3', ], 'CreateTime' => [ 'title' => '直播创建时间（毫秒ms）', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000', ], 'EndTime' => [ 'title' => '直播结束时间（毫秒ms）', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000', ], 'Duration' => [ 'title' => '直播持续时间（毫秒ms）', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', ], 'PushUrl' => [ 'title' => '直播推流地址', 'description' => '', 'type' => 'string', 'example' => 'rtmp://demo-app-push.com/live/e620****a8e3?auth_key=e620****a8e3', ], 'LiveUrl' => [ 'title' => '直播拉流地址', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/e620****a8e3.flv?auth_key=e620****a8e3', ], 'Status' => [ 'title' => '直播状态：Created-已创建，未开播，Living-直播中，End-直播结束', 'description' => '', 'type' => 'string', 'example' => 'Created', ], 'Introduction' => [ 'title' => '直播简介', 'description' => '', 'type' => 'string', 'example' => 'This is an introduction.', ], 'RoomId' => [ 'title' => '房间id', 'description' => '', 'type' => 'string', 'example' => 'AE35-****-T95F', ], 'AppId' => [ 'title' => '租户名', 'description' => '', 'type' => 'string', 'example' => '7m***q', ], 'UserId' => [ 'title' => '创建直播用户', 'description' => '', 'type' => 'string', 'example' => 'as****hs', ], 'CodeLevel' => [ 'title' => '直播推送分辨率 -1:lld 1:lsd 2:lhd 3:lud', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PlayUrlInfoList' => [ 'title' => '多分辨率多协议播放信息', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CodeLevel' => [ 'title' => '直播拉取分辨率 -1:lld 1:lsd 2:lhd 3:lud', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'FlvUrl' => [ 'title' => 'flv拉流地址', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f2****ebb3.flv?auth_key=e620****a8e3', ], 'HlsUrl' => [ 'title' => 'hls拉流地址', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f2****ebb3.m3u8?auth_key=e620****a8e3', ], 'RtmpUrl' => [ 'title' => 'rtmp拉流地址', 'description' => '', 'type' => 'string', 'example' => 'rtmp://demo-app-live.com/live/b7f2****ebb3?auth_key=e620****a8e3', ], ], ], ], 'CoverUrl' => [ 'title' => '封面图片', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.png', ], 'UserDefineField' => [ 'title' => '用户自定义数据存储', 'description' => '', 'type' => 'string', 'example' => '{"selfData":"example"}', ], 'HlsUrl' => [ 'title' => 'hls播放地址', 'description' => '', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'ArtcInfo' => [ 'title' => 'rts播流信息', 'description' => '', 'type' => 'object', 'properties' => [ 'ArtcUrl' => [ 'title' => '源码地址', 'description' => '', 'type' => 'string', 'example' => 'artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], 'ArtcH5Url' => [ 'title' => '原画转码地址', 'description' => '', 'type' => 'string', 'example' => 'artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"AnchorId\\": \\"as****hs\\",\\n \\"LiveId\\": \\"b7f2****ebb3\\",\\n \\"Title\\": \\"This is a title.\\",\\n \\"PlaybackUrl\\": \\"http://demo-app-playback.com/live/b7f2****ebb3.m3u8?auth_key=e620****a8e3\\",\\n \\"CreateTime\\": 1624259500000,\\n \\"EndTime\\": 1624259500000,\\n \\"Duration\\": 10000,\\n \\"PushUrl\\": \\"rtmp://demo-app-push.com/live/e620****a8e3?auth_key=e620****a8e3\\",\\n \\"LiveUrl\\": \\"http://demo-app-live.com/live/e620****a8e3.flv?auth_key=e620****a8e3\\",\\n \\"Status\\": \\"Created\\",\\n \\"Introduction\\": \\"This is an introduction.\\",\\n \\"RoomId\\": \\"AE35-****-T95F\\",\\n \\"AppId\\": \\"7m***q\\",\\n \\"UserId\\": \\"as****hs\\",\\n \\"CodeLevel\\": 1,\\n \\"PlayUrlInfoList\\": [\\n {\\n \\"CodeLevel\\": 1,\\n \\"FlvUrl\\": \\"http://demo-app-live.com/live/b7f2****ebb3.flv?auth_key=e620****a8e3\\",\\n \\"HlsUrl\\": \\"http://demo-app-live.com/live/b7f2****ebb3.m3u8?auth_key=e620****a8e3\\",\\n \\"RtmpUrl\\": \\"rtmp://demo-app-live.com/live/b7f2****ebb3?auth_key=e620****a8e3\\"\\n }\\n ],\\n \\"CoverUrl\\": \\"http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.png\\",\\n \\"UserDefineField\\": \\"{\\\\\\"selfData\\\\\\":\\\\\\"example\\\\\\"}\\",\\n \\"HlsUrl\\": \\"http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"ArtcInfo\\": {\\n \\"ArtcUrl\\": \\"artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\",\\n \\"ArtcH5Url\\": \\"artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n \\n as****hs\\n b7f2****ebb3\\n \\n http://demo-app-playback.com/live/b7f2****ebb3.m3u8?auth_key=e620****a8e3\\n 1624259500000\\n 1624259500000\\n 10000\\n rtmp://demo-app-push.com/live/e620****a8e3?auth_key=e620****a8e3\\n http://demo-app-live.com/live/e620****a8e3.flv?auth_key=e620****a8e3\\n Created\\n This is an introduction.\\n AE35-****-T95F\\n 7m***q\\n as****hs\\n 1\\n \\n 1\\n http://demo-app-live.com/live/b7f2****ebb3.flv?auth_key=e620****a8e3\\n http://demo-app-live.com/live/b7f2****ebb3.m3u8?auth_key=e620****a8e3\\n rtmp://demo-app-live.com/live/b7f2****ebb3?auth_key=e620****a8e3\\n \\n \\n ","errorExample":""}]', ], ], 'endpoints' => [ [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'imp.aliyuncs.com', ], ], ];