summaryrefslogtreecommitdiff
path: root/data/en_us/imp/2021-06-30
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/imp/2021-06-30
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/imp/2021-06-30')
-rw-r--r--data/en_us/imp/2021-06-30/api-docs.php10025
1 files changed, 4650 insertions, 5375 deletions
diff --git a/data/en_us/imp/2021-06-30/api-docs.php b/data/en_us/imp/2021-06-30/api-docs.php
index 74c1329..2f25f7b 100644
--- a/data/en_us/imp/2021-06-30/api-docs.php
+++ b/data/en_us/imp/2021-06-30/api-docs.php
@@ -1,52 +1,23 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'imp',
- 'version' => '2021-06-30',
- ],
+ '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,
+ 'children' => ['ListLiveRooms', 'ListLiveRoomsById'],
'type' => 'directory',
- 'children' => [
- 'ListLiveRooms',
- 'ListLiveRoomsById',
- ],
+ 'title' => 'Retrieve live streaming list',
],
[
- 'id' => 167586,
- 'title' => null,
+ 'children' => ['GetLiveRoomStatistics', 'GetLiveRoomUserStatistics'],
'type' => 'directory',
- 'children' => [
- 'GetLiveRoomStatistics',
- 'GetLiveRoomUserStatistics',
- ],
+ 'title' => 'Live streaming statistics',
],
[
- 'id' => 169037,
- 'title' => null,
+ 'children' => ['GetLiveRecord', 'CreateLiveRecordSliceFile', 'ListLiveFiles', 'DeleteLiveFilesById'],
'type' => 'directory',
- 'children' => [
- 'GetLiveRecord',
- 'CreateLiveRecordSliceFile',
- 'ListLiveFiles',
- 'DeleteLiveFilesById',
- ],
+ 'title' => 'Live streaming recording',
],
'CreateLiveRoom',
'DeleteLiveRoom',
@@ -55,676 +26,312 @@
'StopLiveRoom',
'GetLiveRoom',
],
+ 'type' => 'directory',
+ 'title' => 'Live streaming',
],
[
- 'id' => 121846,
- 'title' => null,
+ 'children' => ['CreateClass', 'DeleteClass', 'StopClass', 'UpdateClass', 'GetClassDetail', 'GetClassRecord', 'UpdateShareScreenLayout'],
'type' => 'directory',
- 'children' => [
- 'CreateClass',
- 'DeleteClass',
- 'StopClass',
- 'UpdateClass',
- 'GetClassDetail',
- 'ListClasses',
- 'GetClassRecord',
- 'UpdateShareScreenLayout',
- ],
+ 'title' => 'Classroom',
],
[
- 'id' => 121863,
- 'title' => null,
+ 'children' => ['CreateRoom', 'DeleteRoom', 'UpdateRoom', 'KickRoomUser', 'SetUserAdmin', 'CancelUserAdmin', 'GetRoom', 'ListRooms', 'ListRoomUsers'],
'type' => 'directory',
- 'children' => [
- 'CreateRoom',
- 'DeleteRoom',
- 'UpdateRoom',
- 'KickRoomUser',
- 'SetUserAdmin',
- 'CancelUserAdmin',
- 'GetRoom',
- 'ListRooms',
- 'ListRoomUsers',
- ],
+ 'title' => 'Room',
],
[
- 'id' => 121870,
- 'title' => null,
- 'type' => 'directory',
'children' => [
[
- 'id' => 167432,
- 'title' => null,
+ 'children' => ['CreateSensitiveWord', 'DeleteSensitiveWord', 'ListSensitiveWord'],
'type' => 'directory',
- 'children' => [
- 'CreateSensitiveWord',
- 'DeleteSensitiveWord',
- 'ListSensitiveWord',
- ],
+ 'title' => 'Sensitive word',
],
[
- 'id' => 167433,
- 'title' => null,
+ 'children' => ['CancelBanAllComment', 'CancelBanComment', 'BanAllComment', 'BanComment'],
'type' => 'directory',
- 'children' => [
- 'CancelBanAllComment',
- 'CancelBanComment',
- 'BanAllComment',
- 'BanComment',
- ],
+ 'title' => 'Mute',
],
[
- 'id' => 167434,
- 'title' => null,
+ 'children' => ['SendCustomMessageToAll', 'SendCustomMessageToUsers', 'SendComment', 'DeleteComment', 'ListComments'],
'type' => 'directory',
- 'children' => [
- 'SendCustomMessageToAll',
- 'SendCustomMessageToUsers',
- 'SendComment',
- 'DeleteComment',
- 'ListComments',
- 'DeleteCommentByCreatorId',
- ],
+ 'title' => 'Message management',
],
],
+ 'type' => 'directory',
+ 'title' => 'Message',
],
[
- 'id' => 121880,
- 'title' => null,
+ 'children' => ['DeleteConference', 'GetConference', 'ListConferenceUsers'],
'type' => 'directory',
- 'children' => [
- 'DeleteConference',
- 'RemoveMember',
- 'GetConference',
- 'ListConferenceUsers',
- ],
+ 'title' => 'Co-streaming',
],
[
- 'id' => 121893,
- 'title' => null,
+ 'children' => ['GetStandardRoomJumpUrl'],
'type' => 'directory',
- 'children' => [
- 'GetStandardRoomJumpUrl',
- ],
+ 'title' => 'Low-code service',
],
[
- 'id' => 167286,
- 'title' => null,
+ 'children' => ['DescribeMeterImpWatchLiveTimeByLiveId', 'DescribeMeterImpPlayBackTimeByLiveId'],
'type' => 'directory',
- 'children' => [
- 'DescribeMeterImpWatchLiveTimeByLiveId',
- 'DescribeMeterImpPlayBackTimeByLiveId',
- ],
+ 'title' => 'Usage query',
],
[
- 'id' => 121914,
- 'title' => null,
+ 'children' => ['CreateLive', 'DeleteLive', 'PublishLive', 'UpdateLive', 'StopLive', 'GetLive'],
+ 'type' => 'directory',
+ 'title' => 'Live streaming (legacy)',
+ ],
+ [
+ 'children' => ['GetAuthToken', 'ListClasses', 'RemoveMember'],
+ 'title' => 'Others',
'type' => 'directory',
- 'children' => [
- 'CreateLive',
- 'DeleteLive',
- 'PublishLive',
- 'UpdateLive',
- 'StopLive',
- 'GetLive',
- ],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'GetAuthToken' => [
- 'summary' => '获取登录Token',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'BanAllComment' => [
+ 'summary' => 'Mutes all users in a room by calling the BanAllComment operation.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户的应用ID，在控制台创建应用时生成',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID, which is generated when you create the application in the console. The ID contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'AppKey',
+ 'name' => 'RoomId',
'in' => 'formData',
- 'schema' => [
- 'title' => '终端设备类型,通过控制台创建和查询',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '06***9c',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the room. The ID is returned when you call the CreateRoom operation.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
],
[
'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',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID of the operator, which indicates who performed the mute-all operation.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => ['title' => '', 'description' => 'The result of the mute-all operation.', 'type' => 'boolean', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
- '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":"<GetAuthTokenResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <AccessToken>oauth_cloud_key:***-b0YY5Gy6Q</AccessToken>\\n <RefreshToken>oauth_cloud_key:****-Q62xggOTdgk3gw=</RefreshToken>\\n <AccessTokenExpiredTime>86400000</AccessTokenExpiredTime>\\n </Result>\\n</GetAuthTokenResponse>","errorExample":""}]',
- ],
- 'ListLiveRooms' => [
- 'summary' => '查询场景化直播列表',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Forbidden.Chat.NoPermissionToOperate', 'errorMessage' => 'The user has no permission to operate.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","type":"json"}]',
+ 'title' => 'BanAllComment',
+ 'extraInfo' => 'The system checks whether the user has the permissions to mute all users. If the user does not have the permissions, the Forbidden.Comment.NoPermissionToOperate error is returned.',
+ 'changeSet' => [
+ ['createdAt' => '2021-08-11T08:00:58.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-08-11T08:00:58.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:BanAllComment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BanAllComment'],
+ ],
+ ],
+ ],
+ 'BanComment' => [
+ 'summary' => 'Mutes a specific user in a room.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID. This ID is generated when you create the application in the console. The ID contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'Status',
+ 'name' => 'RoomId',
'in' => 'formData',
- 'schema' => [
- 'title' => '直播状态，0-在播 1-下播，不传则返回所有直播。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the room, returned when you call the CreateRoom operation.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '查询页码，从1开始，传空默认查询第1页。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID of the operator, which indicates who performed the mute operation.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'BanCommentUser',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页显示个数，最大支持50，参数为空默认显示个数为10。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID of the user to be muted.', 'type' => 'string', 'required' => true, 'example' => 'er****h'],
+ ],
+ [
+ 'name' => 'BanCommentTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The mute duration. Unit: seconds.'."\n"
+ ."\n"
+ .'- If this parameter is not specified, the default mute duration is 30 seconds.'."\n"
+ ."\n"
+ .'- A value of 0 indicates a permanent mute.'."\n"
+ ."\n"
+ .'- The maximum value cannot exceed 24 hours. If the value exceeds 24 hours, it is automatically set to 24 hours.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => ['title' => '', 'description' => 'The result of the mute operation. A value of true indicates that the user is muted. A value of false indicates that the mute operation failed.', 'type' => 'boolean', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
- '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":"<ListLiveRoomsResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <TotalCount>100</TotalCount>\\n <PageTotal>10</PageTotal>\\n <HasMore>true</HasMore>\\n <LiveList>\\n <AppId>7m***q</AppId>\\n <LiveId>b7f2****ebb3</LiveId>\\n <Status>1</Status>\\n <RoomId>AE35-****-T95F</RoomId>\\n <ChatId>09***f8</ChatId>\\n <Title>Title001</Title>\\n <Notice>Notice001</Notice>\\n <CoverUrl>http://***.png</CoverUrl>\\n <AnchorId>as****hs</AnchorId>\\n <Uv>100</Uv>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n <AnchorNick>User001</AnchorNick>\\n <Pv>200</Pv>\\n <OnlineCount>50</OnlineCount>\\n </LiveList>\\n </Result>\\n</ListLiveRoomsResponse>","errorExample":""}]',
- ],
- 'ListLiveRoomsById' => [
- 'summary' => '根据直播id批量查询直播信息',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Forbidden.Chat.NoPermissionToOperate', 'errorMessage' => 'The user has no permission to operate.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","type":"json"}]',
+ 'title' => 'Mute a user',
+ 'extraInfo' => 'Only users with the mute permission can call this operation. Otherwise, the error Forbidden.Comment.NoPermissionToOperate is returned.',
+ 'changeSet' => [
+ ['createdAt' => '2021-08-11T08:00:58.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-08-11T08:00:58.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:BanComment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BanComment'],
+ ],
],
+ ],
+ 'CancelBanAllComment' => [
+ 'summary' => 'Cancels the mute-all restriction in a room.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'LiveIdList',
+ 'name' => 'RoomId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '直播ID列表。',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["b7f2****ebb3"]',
- ],
- 'required' => true,
- 'example' => '0',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the room, which is returned when you call CreateRoom.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The user ID of the operator, which indicates who performed the cancel mute-all operation.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => ['title' => '', 'description' => 'The result of the cancel mute-all operation. A value of true indicates that the mute-all restriction was canceled. A value of false indicates that the operation failed.', 'type' => 'boolean', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
- '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":"<ListLiveRoomsByIdResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <LiveList>\\n <AppId>7m***q</AppId>\\n <LiveId>b7f2****ebb3</LiveId>\\n <Status>1</Status>\\n <RoomId>AE35-****-T95F</RoomId>\\n <ChatId>09***f8</ChatId>\\n <Title>RoomTitle001</Title>\\n <Notice>RoomNotice001</Notice>\\n <CoverUrl>http://***.png</CoverUrl>\\n <AnchorId>as****hs</AnchorId>\\n <Uv>100</Uv>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n <AnchorNick>User001</AnchorNick>\\n <Pv>200</Pv>\\n <OnlineCount>50</OnlineCount>\\n </LiveList>\\n </Result>\\n</ListLiveRoomsByIdResponse>","errorExample":""}]',
- ],
- 'GetLiveRoomStatistics' => [
- 'summary' => '获取直播数据统计',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Forbidden.Chat.NoPermissionToOperate', 'errorMessage' => 'The user has no permission to operate.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","type":"json"}]',
+ 'title' => 'Cancel mute-all',
+ 'extraInfo' => 'The system checks whether the user has the permission to cancel the mute-all restriction. If the user does not have the permission, the error Forbidden.Comment.NoPermissionToOperate is returned.',
+ 'changeSet' => [
+ ['createdAt' => '2021-08-11T08:00:58.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-08-11T08:00:58.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelBanAllComment'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:CancelBanAllComment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CancelBanComment' => [
+ 'summary' => 'Cancels the comment ban on a specific user in a room.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -736,521 +343,345 @@
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID. This ID is generated when you create the application in the console. It contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'LiveId',
+ 'name' => 'RoomId',
'in' => 'formData',
- 'schema' => [
- 'title' => '直播ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b7f2****ebb3',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the room, returned when you call the CreateRoom operation.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The user ID of the operator, which indicates who performed the cancel comment ban operation.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
+ ],
+ [
+ 'name' => 'BanCommentUser',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The user ID of the user whose comment ban is to be canceled.', 'type' => 'string', 'required' => true, 'example' => 'er****h'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => ['title' => '', 'description' => 'The result of calling CancelBanComment. A value of true indicates that the comment ban was canceled. A value of false indicates that the operation failed.', 'type' => 'boolean', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
- '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":"<GetLiveRoomStatisticsResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <LiveId>b7f2****ebb3</LiveId>\\n <Status>1</Status>\\n <Uv>100</Uv>\\n <Pv>200</Pv>\\n <MessageCount>500</MessageCount>\\n <StartTime>1624259500000</StartTime>\\n <EndTime>1624259500000</EndTime>\\n <WatchLiveTime>10000000</WatchLiveTime>\\n <LikeCount>100</LikeCount>\\n <OnlineCount>50</OnlineCount>\\n </Result>\\n</GetLiveRoomStatisticsResponse>","errorExample":""}]',
- ],
- 'GetLiveRoomUserStatistics' => [
- 'summary' => '获取直播用户数据统计',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Forbidden.Chat.NoPermissionToOperate', 'errorMessage' => 'The user has no permission to operate.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","type":"json"}]',
+ 'title' => 'Cancel comment ban',
+ 'extraInfo' => 'Only users with the permission to cancel comment bans can call this operation. Otherwise, the error Forbidden.Comment.NoPermissionToOperate is returned.',
+ 'changeSet' => [
+ ['createdAt' => '2021-08-11T08:00:58.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-08-11T08:00:58.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelBanComment'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:CancelBanComment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CancelUserAdmin' => [
+ 'summary' => 'Cancels the administrator role of a specific user in a room, changing the user to a regular viewer.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [],
+ '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',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application, consisting of 6 lowercase letters and digits.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'RoomId',
'in' => 'formData',
- 'schema' => [
- 'title' => '查询页码，从1开始，传空默认查询第1页。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the room, returned when you call CreateRoom.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页显示个数，最大支持50，参数为空默认显示个数为10。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '25',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the user whose administrator role is to be canceled.', 'type' => 'string', 'required' => true, 'example' => 'er****h'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
],
+ 'example' => '',
],
],
],
- '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":"<GetLiveRoomUserStatisticsResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <LiveId>b7f2****ebb3</LiveId>\\n <TotalCount>100</TotalCount>\\n <PageTotal>10</PageTotal>\\n <HasMore>true</HasMore>\\n <UserStatisticsList>\\n <UserId>User001</UserId>\\n <WatchLiveTime>100000</WatchLiveTime>\\n <CommentCount>100</CommentCount>\\n <LikeCount>100</LikeCount>\\n </UserStatisticsList>\\n </Result>\\n</GetLiveRoomUserStatisticsResponse>","errorExample":""}]',
- ],
- 'GetLiveRecord' => [
- 'summary' => '获取直播录制详情',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Cancel user administrator',
+ 'description' => 'The room owner cannot be operated on. If the user does not exist or is already a regular user, a success response is returned by default.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelUserAdmin'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:CancelUserAdmin',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateClass' => [
+ 'summary' => 'Creates a class by calling CreateClass. The class can be used for scenarios such as student learning and workplace training, and provides features such as co-streaming, live streaming, whiteboard, and chat.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'lq****cu',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, which is generated when you create an application in the console. The ID consists of lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'LiveId',
+ 'name' => 'Title',
'in' => 'formData',
- 'schema' => [
- 'title' => '直播唯一标识，由调用CreateLiveRoom返回。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35****T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The class title. Chinese and English characters are supported. The maximum length is 32 characters.', 'type' => 'string', 'required' => true, 'example' => 'ClassTitle001'],
],
[
- 'name' => 'UserId',
+ 'name' => 'CreateUserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作人用户ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '34**29',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID of the creator. Only letters and digits are supported. The maximum length is 36 characters.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
+ ],
+ [
+ 'name' => 'CreateNickname',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The nickname of the creator. Chinese and English characters are supported. The maximum length is 32 characters.', 'type' => 'string', 'required' => true, 'example' => 'nickname001'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => 'API请求的返回结果结构体。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The result of creating the class.',
'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' => '',
- ],
- ],
+ 'ClassId' => ['title' => '', 'description' => 'The unique identifier of the class.', 'type' => 'string', 'example' => 'A55-****-Y34O'],
+ 'Title' => ['title' => '', 'description' => 'The class title.', 'type' => 'string', 'example' => 'PPT制作培训'],
+ 'CreateUserId' => ['title' => '', 'description' => 'The user ID of the creator.', 'type' => 'string', 'example' => '34***45'],
+ 'CreateNickname' => ['title' => '', 'description' => 'The nickname of the creator.', 'type' => 'string', 'example' => '随风'],
+ 'Status' => ['title' => '', 'description' => 'The class status. Valid values:'."\n"
+ .'- 0: not started'."\n"
+ .'- 1: in progress'."\n"
+ .'- 2: ended.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'RoomId' => ['title' => '', 'description' => 'The room ID. You can use this ID to query room details and pass it as a parameter when integrating with the client SDK.', 'type' => 'string', 'example' => 'AE35-****-T95F'],
+ 'LiveId' => ['title' => '', 'description' => 'The live streaming ID. You can use this ID to query live streaming details and pass it as a parameter when calling live streaming-related operations on the client.', 'type' => 'string', 'example' => 'b7f2****ebb3'],
+ 'ConfId' => ['title' => '', 'description' => 'The co-streaming conference ID. You can use this ID to join an RTC conference and retrieve conference details.', 'type' => 'string', 'example' => 'fb0f-****-4cb1'],
+ 'WhiteboardId' => ['title' => '', 'description' => 'The whiteboard ID. You can use this ID to query whiteboard information and pass it as a parameter when integrating with the whiteboard SDK on the client.', 'type' => 'string', 'example' => 'fgej**2'],
+ 'WhiteboardRecordId' => ['title' => '', 'description' => 'The whiteboard recording ID. You can use this ID to retrieve and play back whiteboard recording content on the client.', 'type' => 'string', 'example' => 'eofg**rt'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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":"<GetLiveRecordResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <PlaybackUrlMap>\\n <m3u8>http://***.aliyundoc.nm/***8fc5-***f8****.webm?****77650&amp;***xzSQU***</m3u8>\\n </PlaybackUrlMap>\\n </Result>\\n</GetLiveRecordResponse>","errorExample":""}]',
- ],
- 'CreateLiveRecordSliceFile' => [
- 'summary' => '创建直播录制的片段文件',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Invalid.Live.ConfigNotFound', 'errorMessage' => 'The live push domain and pull domain config not found.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Create a class',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-15T03:18:17.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-10-18T06:21:09.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-09-26T13:08:30.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateClass'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'imp:CreateClass',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateLive' => [
+ 'summary' => 'Creates a live stream with a creation status of not yet started.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'lq****cu',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
+ ],
+ [
+ 'name' => 'RoomId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the room. The value is up to 36 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F'],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The user who creates the live stream. The value must be unique within the specified AppId. The value can contain lowercase letters, digits, underscores (_), and periods (.) and is up to 32 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
],
[
'name' => 'LiveId',
'in' => 'formData',
- 'schema' => [
- 'title' => '直播ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35****T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the live stream resource. If you leave this parameter empty, the system automatically generates a 36-character random UUID string.', 'type' => 'string', 'required' => false, 'example' => 'b7f2****ebb3'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'Title',
'in' => 'formData',
- 'schema' => [
- 'title' => '片段开始时间，时间戳，单位为毫秒。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1577836800000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The title of the live stream. The value can contain Chinese and English characters and is up to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'This is a title.'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'Introduction',
'in' => 'formData',
- 'schema' => [
- 'title' => '片段结束时间，时间戳，单位为毫秒。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1577836800000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The introduction of the live stream. The value can contain Chinese and English characters and is up to 2048 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'This is an intro.'],
],
[
- 'name' => 'FileName',
+ 'name' => 'AnchorId',
'in' => 'formData',
- 'schema' => [
- 'title' => '自定义文件名称。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sliceFile',
- ],
+ 'schema' => ['title' => '', 'description' => 'The anchor ID. The value can contain Chinese and English characters and is up to 128 characters in length. If you leave this parameter empty, the anchor is the user who creates the live stream.', 'type' => 'string', 'required' => false, 'example' => 'as****hs'],
+ ],
+ [
+ 'name' => 'CodeLevel',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The bitrate of the live stream. Default value: 3. Valid values:'."\n"
+ .'* **-1**: smooth (lld).'."\n"
+ .'* **1**: standard definition (lsd).'."\n"
+ .'* **2**: high definition (lhd).'."\n"
+ .'* **3**: ultra-high definition (lud).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ER52****O9CA',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '创建场景化直播返回的结果。',
- 'description' => '',
+ 'description' => 'The result of creating the live stream.',
'type' => 'object',
'properties' => [
- 'SliceRecordUrl' => [
- 'title' => '片段录制文件的地址。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://demo-app-playback.com/**.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3',
- ],
+ 'LiveId' => ['title' => '', 'description' => 'The unique identifier of the live stream.', 'type' => 'string', 'example' => 'b7f2****ebb3'],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'Forbidden.Room.LiveAlreadyExist', 'errorMessage' => 'The live instance already exists.', 'description' => ''],
+ ['errorCode' => 'Invalid.Live.ConfigNotFound', 'errorMessage' => 'The live push domain and pull domain config not found.', 'description' => ''],
],
],
- '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',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"LiveId\\": \\"b7f2****ebb3\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Create a live stream',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-10T03:10:30.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-07-08T11:46:28.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLive'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'imp:CreateLive',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateLiveRecordSliceFile' => [
+ 'summary' => 'Creates a live recording slice file by calling CreateLiveRecordSliceFile.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1262,1712 +693,1399 @@
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'lq**xy',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application, which consists of 6 lowercase letters and digits.', 'type' => 'string', 'required' => true, 'example' => 'lq****cu'],
],
[
'name' => 'LiveId',
'in' => 'formData',
- 'schema' => [
- 'title' => '直播ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'acbder-**-34uh',
- ],
+ 'schema' => ['title' => '', 'description' => 'The live stream ID.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The start time of the slice. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1577836800000'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The end time of the slice. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1577836800000'],
+ ],
+ [
+ 'name' => 'FileName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The custom file name.', 'type' => 'string', 'required' => true, 'example' => 'sliceFile'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ER52****O9CA'],
'Result' => [
- 'title' => '返回结果。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The result returned for creating a scenario-based live stream.',
'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',
- ],
- ],
- ],
- ],
+ 'SliceRecordUrl' => ['title' => '', 'description' => 'The URL of the slice recording file.', 'type' => 'string', 'example' => 'http://demo-app-playback.com/**.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Invalid.Live.RecordContentExceed', 'errorMessage' => 'The record content between StartTime and EndTime is exceeded, please narrow down the range.', 'description' => ''],
+ ['errorCode' => 'Invalid.Live.RecordContentTooShort', 'errorMessage' => 'The record time between StartTime and EndTime is too short, please enlarger the range.', 'description' => ''],
+ ['errorCode' => 'Invalid.Live.RecordEndTimeMismatch', 'errorMessage' => 'Specified end time does not math the specified start time.', 'description' => ''],
+ ['errorCode' => 'Invalid.Live.RecordInvalidBucket', 'errorMessage' => 'The oss bucket is invalid.', 'description' => ''],
+ ['errorCode' => 'Invalid.Live.RecordLiveNotFound', 'errorMessage' => 'The live is not found.', 'description' => ''],
+ ['errorCode' => 'Invalid.Live.RecordLiveStreamNotFound', 'errorMessage' => 'The live stream info is not found.', 'description' => ''],
+ ['errorCode' => 'Invalid.Live.RecordNoContent', 'errorMessage' => 'The record has no content, please check the live record toggle.', 'description' => ''],
+ ['errorCode' => 'Invalid.Live.RecordPlaybackDomainNotFound', 'errorMessage' => 'The record playback domain is not found, please open the liveRecordToggle in imp console and config playback domain.', 'description' => ''],
+ ['errorCode' => 'Invalid.Live.WrongRecordOssConfig', 'errorMessage' => 'Specified oss config is wrong.', 'description' => ''],
+ ['errorCode' => 'Invalid.Scene.LiveNotExist', 'errorMessage' => 'The live record does not exist. Please check again.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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"}]',
+ 'title' => 'Create a live recording slice file',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-19T02:42:38.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-07-05T08:39:43.000Z', 'description' => 'OpenAPI offline'],
],
- 'security' => [
- [
- 'AK' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLiveRecordSliceFile'],
],
],
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
+ 'ramActions' => [
[
- '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',
- ],
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:CreateLiveRecordSliceFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","type":"json"}]',
],
'CreateLiveRoom' => [
- 'summary' => '创建场景化直播',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Invokes CreateLiveRoom to create a live room in the creation status.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
'name' => 'Title',
'in' => 'formData',
- 'schema' => [
- 'title' => '标题，支持中英文，最大长度32位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Title001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The title of the live room. Chinese and English characters are supported. Maximum length: 32 characters.', 'type' => 'string', 'required' => true, 'example' => 'Title001'],
],
[
'name' => 'Notice',
'in' => 'formData',
- 'schema' => [
- 'title' => '公告，支持中英文，最大长度256位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Notice001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The announcement of the live room. Chinese and English characters are supported. Maximum length: 256 characters.', 'type' => 'string', 'required' => false, 'example' => 'Notice001'],
],
[
'name' => 'CoverUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '封面，支持图片地址链接格式',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://***.png',
- ],
+ 'schema' => ['title' => '', 'description' => 'The cover image URL of the live room. Maximum length: 256 characters.', 'type' => 'string', 'required' => false, 'example' => 'http://***.png'],
],
[
'name' => 'Extension',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '拓展字段，按需传递，需要额外记录的房间属性。最大支持4096个字节。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The extension field. Pass this parameter as needed to record additional live room properties. Maximum length: 4,096 characters.',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test001',
- ],
+ 'additionalProperties' => ['type' => 'string', 'required' => false, 'example' => 'test001', 'description' => '', 'title' => ''],
'example' => 'AE35****T95F',
],
],
[
'name' => 'AnchorId',
'in' => 'formData',
- 'schema' => [
- 'title' => '主播id，仅支持英文和数字，最大长度36位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The anchor ID. Only letters and digits are supported. Maximum length: 36 characters.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
],
[
'name' => 'AnchorNick',
'in' => 'formData',
- 'schema' => [
- 'title' => '主播昵称。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'User001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The nickname of the anchor. Chinese and English characters are supported. Maximum length: 32 characters.', 'type' => 'string', 'required' => false, 'example' => 'User001'],
],
[
'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作人ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the operator. Only letters and digits are supported. Maximum length: 36 characters.', 'type' => 'string', 'required' => false, 'example' => 'as****hs'],
],
[
'name' => 'EnableLinkMic',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否开启连麦。',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '', 'description' => 'Specifies whether to enable the co-streaming feature. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '创建场景化直播返回的结果。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The result returned for creating the live room.',
'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',
- ],
+ 'AppId' => ['title' => '', 'description' => 'The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'example' => '7m***q'],
+ 'RoomId' => ['title' => '', 'description' => 'The unique ID of the room. This ID is used in operations such as joining and leaving the room.', 'type' => 'string', 'example' => 'AE35-****-T95F'],
+ 'LiveId' => ['title' => '', 'description' => 'The unique ID of the live stream.', 'type' => 'string', 'example' => 'b7f2****ebb3'],
+ 'ChatId' => ['title' => '', 'description' => 'The unique ID of the chat. This ID is used in operations such as sending messages.', 'type' => 'string', 'example' => '09***f8'],
+ 'Title' => ['title' => '', 'description' => 'The title of the live room.', 'type' => 'string', 'example' => 'Title001'],
+ 'Notice' => ['title' => '', 'description' => 'The announcement of the live room.', 'type' => 'string', 'example' => 'Notice001'],
+ 'CoverUrl' => ['title' => '', 'description' => 'The cover image URL of the live room.', 'type' => 'string', 'example' => 'http://***.png'],
+ 'AnchorId' => ['title' => '', 'description' => 'The anchor ID.', 'type' => 'string', 'example' => 'as****hs'],
+ 'PlaybackUrl' => ['title' => '', 'description' => 'The playback URL of the live stream. This URL is generated when the live stream starts and can be used for playback after the live stream ends.', 'type' => 'string', 'example' => 'http://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'PushUrl' => ['title' => '', 'description' => 'The push URL of the live stream.', 'type' => 'string', 'example' => 'rtmp://demo-app-push.com/live/e620****a8e3?auth_key=e620****a8e3'],
+ 'LiveUrl' => ['title' => '', 'description' => 'The streaming URL of the live stream.', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
'PluginInstanceInfoList' => [
- 'title' => '活跃插件列表。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The list of active plug-ins.',
'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',
- ],
+ 'PluginType' => ['title' => '', 'description' => 'The unique identifier of the plug-in type. Valid values:'."\n"
+ ."\n"
+ .'- **live**: live streaming.'."\n"
+ .'- **wb**: whiteboard.'."\n"
+ .'- **chat**: chat.'."\n"
+ .'- **rtc**: real-time communication.', 'type' => 'string', 'example' => 'live'],
+ 'PluginId' => ['title' => '', 'description' => 'The unique ID of the plug-in instance.', 'type' => 'string', 'example' => 'HASU-****-ASHD'],
+ 'CreateTime' => ['title' => '', 'description' => 'The timestamp when the plug-in instance was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624589848000'],
'Extension' => [
- 'title' => '插件拓展字段。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The extension field of the plug-in.',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'test001',
- 'description' => '',
- ],
+ 'additionalProperties' => ['description' => '插件拓展信息。', 'type' => 'string', 'example' => 'test001', 'title' => ''],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
'Extension' => [
- 'title' => '直播拓展字段。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The extension field of the live room.',
'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',
+ 'additionalProperties' => ['description' => '直播拓展信息。', 'type' => 'string', 'example' => 'test001', 'title' => ''],
+ 'example' => '',
],
+ 'AnchorNick' => ['title' => '', 'description' => 'The nickname of the anchor.', 'type' => 'string', 'example' => 'User001'],
+ 'HlsUrl' => ['title' => '', 'description' => 'The original HLS playback URL.', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
'ArtcInfo' => [
- 'title' => 'RTS低延迟播流信息。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The Real-Time Streaming (RTS) low-latency streaming information.',
'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',
- ],
+ 'ArtcUrl' => ['title' => '', 'description' => 'The RTS original stream URL. We recommend that you use this URL on mobile clients.', 'type' => 'string', 'example' => 'artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'ArtcH5Url' => ['title' => '', 'description' => 'The RTS transcoded stream URL. We recommend that you use this URL on web clients.', 'type' => 'string', 'example' => 'artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Invalid.Live.ConfigNotFound',
- 'errorMessage' => 'The live push domain and pull domain config not found.',
- ],
+ ['errorCode' => 'Invalid.Live.ConfigNotFound', 'errorMessage' => 'The live push domain and pull domain config not found.', 'description' => ''],
],
],
- '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":"<CreateLiveRoomResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <AppId>7m***q</AppId>\\n <RoomId>AE35-****-T95F</RoomId>\\n <LiveId>b7f2****ebb3</LiveId>\\n <ChatId>09***f8</ChatId>\\n <Title>Title001</Title>\\n <Notice>Notice001</Notice>\\n <CoverUrl>http://***.png</CoverUrl>\\n <AnchorId>as****hs</AnchorId>\\n <PlaybackUrl>http://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</PlaybackUrl>\\n <PushUrl>rtmp://demo-app-push.com/live/e620****a8e3?auth_key=e620****a8e3</PushUrl>\\n <LiveUrl>http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</LiveUrl>\\n <PluginInstanceInfoList>\\n <PluginType>live</PluginType>\\n <PluginId>HASU-****-ASHD</PluginId>\\n <CreateTime>1624589848000</CreateTime>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n </PluginInstanceInfoList>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n <AnchorNick>User001</AnchorNick>\\n <HlsUrl>http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</HlsUrl>\\n <ArtcInfo>\\n <ArtcUrl>artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</ArtcUrl>\\n <ArtcH5Url>artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</ArtcH5Url>\\n </ArtcInfo>\\n </Result>\\n</CreateLiveRoomResponse>","errorExample":""}]',
- ],
- 'DeleteLiveRoom' => [
- 'summary' => '删除直播',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Create a live room',
+ 'description' => 'For questions and support regarding the China Short Video China Short Video China Short Video low-code audio factory, search for DingTalk group 10570030108 to consult experts.',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-09T06:16:31.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-09-26T03:45:26.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-09-26T03:45:26.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-09-26T03:45:26.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLiveRoom'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'imp:CreateLiveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateRoom' => [
+ 'summary' => 'Creates a room. Users can use features such as live streaming, whiteboard, and audio and video communication in the room.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'LiveId',
+ 'name' => 'TemplateId',
'in' => 'formData',
- 'schema' => [
- 'title' => '直播ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b7f2****ebb3',
- ],
+ 'schema' => ['title' => '', 'description' => 'The template ID. Valid values:'."\n"
+ ."\n"
+ .'- **default**: the default template.'."\n"
+ ."\n"
+ .'If you leave this parameter empty, the value **default** is used.', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
- 'name' => 'UserId',
+ 'name' => 'RoomId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The room ID. Maximum length: 36 characters. If you leave this parameter empty, a room ID is randomly generated.', 'type' => 'string', 'required' => false, 'example' => 'AE35-****-T95F'],
+ ],
+ [
+ 'name' => 'Title',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The room title. Chinese characters, English characters, and digits are supported. Maximum length: 32 characters.', 'type' => 'string', 'required' => true, 'example' => 'RoomTitle001'],
+ ],
+ [
+ 'name' => 'Notice',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The room notice. Chinese characters, English characters, digits, and common symbols are supported. Maximum length: 256 characters.', 'type' => 'string', 'required' => false, 'example' => 'RoomNotice001'],
+ ],
+ [
+ 'name' => 'RoomOwnerId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ID of the room owner. Only English characters and digits are supported. Maximum length: 36 characters.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
+ ],
+ [
+ 'name' => 'Extension',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '操作人ID。',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The extension field. Pass this parameter as needed to record additional room properties. The total length of all field key-value pairs cannot exceed 2048 bytes.',
+ 'type' => 'object',
'required' => false,
- 'example' => 'as****hs',
+ 'additionalProperties' => ['type' => 'string', 'required' => false, 'example' => 'test001', 'description' => '', 'title' => ''],
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => [
+ 'title' => '',
+ 'description' => 'The result of creating the room.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoomId' => ['title' => '', 'description' => 'The room ID.', 'type' => 'string', 'example' => 'AE35-****-T95F'],
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Forbidden.Scene.LiveStillStreaming',
- 'errorMessage' => 'Live is still streaming and cannot be deleted.',
- ],
+ ['errorCode' => 'InvalidRoomId.Room.AlreadyExist', 'errorMessage' => 'Room is already exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveRoomResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n</DeleteLiveRoomResponse>","errorExample":""}]',
- ],
- 'PublishLiveRoom' => [
- 'summary' => '发布直播',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"RoomId\\": \\"AE35-****-T95F\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Create a room',
+ 'changeSet' => [
+ ['createdAt' => '2021-07-08T11:46:29.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRoom'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'imp:CreateRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateSensitiveWord' => [
+ 'summary' => 'Creates custom sensitive words.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID, which is generated when you create the application in the console. The ID contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'LiveId',
+ 'name' => 'WordList',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '直播ID。',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The list of sensitive words. Sensitive words support Chinese characters, letters, and digits. English sensitive words are not supported. You can create up to 100 sensitive words at a time. Each sensitive word cannot exceed 20 characters in length.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The sensitive word to add. Sensitive words support Chinese characters, letters, and digits. English sensitive words are not supported. You can create up to 100 sensitive words at a time. Each sensitive word cannot exceed 20 characters in length.', 'type' => 'string', 'required' => true, 'example' => '测试敏感词', 'title' => ''],
'required' => true,
- 'example' => 'b7f2****ebb3',
- ],
- ],
- [
- 'name' => 'UserId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '操作人ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'as****hs',
+ 'docRequired' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '创建场景化直播返回的结果。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The result returned for the create sensitive words operation.',
'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',
- ],
+ 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '0io**Fs6Q384',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Invalid.Live.StatusNotMatch',
- 'errorMessage' => 'The live status not match.',
+ ['errorCode' => 'InvalidAppId.Error', 'errorMessage' => 'The specified AppId is invalid.', 'description' => ''],
+ ['errorCode' => 'Forbidden.SensitiveWordCount.ExceedLimit', 'errorMessage' => 'The total count of sensitive word exceeds the limit.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
+ 'title' => 'Create custom sensitive words',
+ 'description' => '## QPS limit'."\n"
+ .'The QPS limit for this operation is 10 calls per second per user.'."\n"
+ ."\n"
+ .'## Limits'."\n"
+ .'You can create up to 1,000 custom sensitive words for each application.',
+ 'changeSet' => [
+ ['createdAt' => '2022-04-18T07:19:56.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2022-04-18T07:19:56.000Z', 'description' => 'Error codes changed, Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSensitiveWord'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:CreateSensitiveWord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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":"<PublishLiveRoomResponse>\\n <RequestId>ER52****O9CA</RequestId>\\n <Result>\\n <LiveId>b7f2****ebb3</LiveId>\\n <LiveUrl>http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</LiveUrl>\\n <PushUrl>rtmp://demo-app-push.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</PushUrl>\\n </Result>\\n</PublishLiveRoomResponse>","errorExample":""}]',
],
- 'UpdateLiveRoom' => [
- 'summary' => '更新直播',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteClass' => [
+ 'summary' => 'Deletes a class by calling DeleteClass.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'Title',
+ 'name' => 'ClassId',
'in' => 'formData',
- 'schema' => [
- 'title' => '标题，支持中英文，最大长度32位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Title001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the class.', 'type' => 'string', 'required' => true, 'example' => 'A55-****-Y34O'],
],
[
- 'name' => 'Notice',
+ 'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '公告，支持中英文，最大长度256位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Notice001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID of the operator. The value can contain letters, digits, underscores (_), and hyphens (-) and is 1 to 36 characters in length.', 'type' => 'string', 'example' => 'as****hs', 'required' => false],
],
- [
- 'name' => 'CoverUrl',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '封面，支持图片地址链接格式',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://***.png',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a class',
+ 'changeSet' => [
+ ['createdAt' => '2021-09-28T06:01:25.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteClass'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Extension',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '拓展字段，按需传递，需要额外记录的房间属性。',
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test001',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteClass',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'example' => 'AE35****T95F',
],
],
+ ],
+ ],
+ 'DeleteComment' => [
+ 'summary' => 'Calls DeleteComment to delete a comment message.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'AnchorId',
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '主播id，仅支持英文和数字，最大长度36位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'AnchorNick',
+ 'name' => 'RoomId',
'in' => 'formData',
- 'schema' => [
- 'title' => '主播昵称。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'User001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the room, returned when you call CreateRoom.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
],
[
'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作人ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID of the operator, which indicates who performed the delete comment message operation.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
],
[
- 'name' => 'LiveId',
+ 'name' => 'CommentIdList',
'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'title' => '直播ID。',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The list of comment message IDs to delete. The maximum length of the list cannot exceed 100.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The comment message ID, returned when you call SendComment.', 'type' => 'string', 'required' => true, 'example' => '09***f8', 'title' => ''],
'required' => true,
- 'example' => 'b7f2****ebb3',
+ 'example' => 'Hello, World',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => [
+ 'title' => '',
+ 'description' => 'The result of deleting the room comment message.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DeleteResult' => ['title' => '', 'description' => 'The deletion result. Valid values:'."\n"
+ .'- true: Deleted.'."\n"
+ .'- false: Failed to delete.', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'example' => '0io**Fs6Q384',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveRoomResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n</UpdateLiveRoomResponse>","errorExample":""}]',
- ],
- 'StopLiveRoom' => [
- 'summary' => '关闭场景化直播',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"DeleteResult\\": true\\n }\\n}","type":"json"}]',
+ 'title' => 'Delete a comment message',
+ 'changeSet' => [
+ ['createdAt' => '2021-10-18T06:31:24.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteComment'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteComment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteConference' => [
+ 'summary' => 'Ends a co-streaming session by calling DeleteConference. This operation is typically used to end a session from the management console or to forcibly end a session that has not been exited for an extended period of time.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'LiveId',
+ 'name' => 'RoomId',
'in' => 'formData',
- 'schema' => [
- 'title' => '直播ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b7f2****ebb3',
- ],
+ 'schema' => ['title' => '', 'description' => 'The room ID. This ID is returned by the room creation operation.', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F'],
],
[
'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作人ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the operator. The value can contain only letters and digits and is up to 36 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
+ ],
+ [
+ 'name' => 'ConferenceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the co-streaming resource.', 'type' => 'string', 'required' => true, 'example' => 'fb0f-****-4cb1'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '16A96B9A-****-CB92E68F4CD8'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'Forbidden.Live.PermissionDenied',
- 'errorMessage' => 'The permission is denied.',
+ 400 => [
+ ['errorCode' => 'InvalidConferenceId.Rtc.DataNotExist', 'errorMessage' => 'The specified parameter conferenceId does not exist in our records.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\"\\n}","type":"json"}]',
+ 'title' => 'End a co-streaming session',
+ 'changeSet' => [
+ ['createdAt' => '2021-08-10T08:32:44.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConference'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteConference',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<StopLiveRoomResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n</StopLiveRoomResponse>","errorExample":""}]',
],
- 'GetLiveRoom' => [
- 'summary' => '查询场景化直播详情',
- 'methods' => [
- 'post',
+ 'DeleteLive' => [
+ 'summary' => 'Deletes a live streaming record.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete'],
+ 'parameters' => [
+ [
+ 'name' => 'LiveId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the live streaming resource.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidLiveId.Live.NotFound', 'errorMessage' => 'The live broadcast does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a live streaming record',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLive'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteLive',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteLiveFilesById' => [
+ 'summary' => 'Calls the DeleteLiveFilesById operation to delete the recording files of a live stream.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'lq**xy'],
],
[
'name' => 'LiveId',
'in' => 'formData',
- 'schema' => [
- 'title' => '直播ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b7f2****ebb3',
- ],
+ 'schema' => ['title' => '', 'description' => 'The live stream ID.', 'type' => 'string', 'required' => true, 'example' => 'acbder-**-34uh'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'boolean', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
- '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":"<GetLiveRoomResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <AppId>7m***q</AppId>\\n <LiveId>b7f2****ebb3</LiveId>\\n <Status>1</Status>\\n <RoomId>AE35-****-T95F</RoomId>\\n <ChatId>09***f8</ChatId>\\n <Title>Title001</Title>\\n <Notice>Notice001</Notice>\\n <CoverUrl>http://***.png</CoverUrl>\\n <AnchorId>as****hs</AnchorId>\\n <Uv>100</Uv>\\n <OnlineCount>50</OnlineCount>\\n <PlaybackUrl>http://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</PlaybackUrl>\\n <PlaybackUrlHttps>https://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</PlaybackUrlHttps>\\n <CreateTime>1624259500000</CreateTime>\\n <EndTime>1624259500000</EndTime>\\n <PushUrl>rtmp://demo-app-push.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</PushUrl>\\n <LiveUrl>http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</LiveUrl>\\n <LiveUrlHttps>https://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</LiveUrlHttps>\\n <PluginInstanceInfoList>\\n <PluginType>live</PluginType>\\n <PluginId>HASU-****-ASHD</PluginId>\\n <CreateTime>1624589848000</CreateTime>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n </PluginInstanceInfoList>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n <Pv>200</Pv>\\n <AnchorNick>User001</AnchorNick>\\n <StartTime>1624259500000</StartTime>\\n <HlsUrl>http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</HlsUrl>\\n <HlsUrlHttps>https://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</HlsUrlHttps>\\n <RtmpUrl>rtmp://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</RtmpUrl>\\n <ArtcInfo>\\n <ArtcUrl>artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</ArtcUrl>\\n <ArtcH5Url>artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</ArtcH5Url>\\n </ArtcInfo>\\n </Result>\\n</GetLiveRoomResponse>","errorExample":""}]',
- ],
- 'CreateClass' => [
- 'summary' => '创建课堂',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","type":"json"}]',
+ 'title' => 'Delete recording files of a live stream by live stream ID',
+ 'description' => 'This operation is applicable to customers who activated the China Short Video SDK (China Short Video and China Interactive Live) after February 18, 2022, and is applicable to scenarios where the live recording feature is enabled and recording files are generated.',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-09T15:17:43.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveFilesById'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteLiveFilesById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DeleteLiveRoom' => [
+ 'summary' => 'Deletes a live streaming record by calling DeleteLiveRoom.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'Title',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '课堂标题',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ClassTitle001',
- ],
- ],
- [
- 'name' => 'CreateUserId',
+ 'name' => 'LiveId',
'in' => 'formData',
- 'schema' => [
- 'title' => '创建人用户ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the live streaming session.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3'],
],
[
- 'name' => 'CreateNickname',
+ 'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '创建人用户昵称。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'nickname001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the operator. The value can contain only letters and digits and is up to 36 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'as****hs'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Invalid.Live.ConfigNotFound',
- 'errorMessage' => 'The live push domain and pull domain config not found.',
- ],
+ ['errorCode' => 'Forbidden.Scene.LiveStillStreaming', 'errorMessage' => 'Live is still streaming and cannot be deleted.', 'description' => ''],
],
],
- '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":"<CreateClassResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <ClassId>A55-****-Y34O</ClassId>\\n <Title>PPT制作培训</Title>\\n <CreateUserId>34***45</CreateUserId>\\n <CreateNickname>随风</CreateNickname>\\n <Status>2</Status>\\n <RoomId>AE35-****-T95F</RoomId>\\n <LiveId>b7f2****ebb3</LiveId>\\n <ConfId>fb0f-****-4cb1</ConfId>\\n <WhiteboardId>fgej**2</WhiteboardId>\\n <WhiteboardRecordId>eofg**rt</WhiteboardRecordId>\\n </Result>\\n</CreateClassResponse>","errorExample":""}]',
- ],
- 'DeleteClass' => [
- 'summary' => '删除课堂',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a live streaming record',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveRoom'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteLiveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteRoom' => [
+ 'summary' => 'Deletes a specified room. After the room is deleted, it can no longer be used.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'ClassId',
+ 'name' => 'RoomId',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The room ID. The value can contain letters, digits, underscores (_), and periods (.), with a maximum length of 36 characters.', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '课堂唯一标识。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A55-****-Y34O',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRoomId.Room.NotExist', 'errorMessage' => 'Room does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a room',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRoom'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'UserId',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DeleteSensitiveWord' => [
+ 'summary' => 'Deletes sensitive words by calling DeleteSensitiveWord.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'AppId',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, which is generated when you create an application in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
+ ],
+ [
+ 'name' => 'WordList',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '操作人用户ID，仅支持中英文数字，下划线，中划线，1~36个字符。',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The list of sensitive words to delete. Only sensitive words that have been previously created can be deleted.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The sensitive word to delete.', 'type' => 'string', 'required' => false, 'example' => '测试敏感词', 'title' => ''],
'required' => false,
- 'example' => 'as****hs',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => [
+ 'title' => '',
+ 'description' => 'The result of the delete sensitive words operation.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'example' => '0io**Fs6Q384',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteClassResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n</DeleteClassResponse>","errorExample":""}]',
- ],
- 'StopClass' => [
- 'summary' => '下课',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
+ 'title' => 'Delete sensitive words',
+ 'description' => '## QPS limit'."\n"
+ .'The QPS limit for this operation is 10 calls per second per user.',
+ 'changeSet' => [
+ ['createdAt' => '2022-04-18T07:19:56.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSensitiveWord'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteSensitiveWord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeMeterImpPlayBackTimeByLiveId' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'AppId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q', 'title' => ''],
],
[
- 'name' => 'ClassId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '课堂唯一标识。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A55-****-Y34O',
- ],
+ 'name' => 'LiveId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unique ID of the live streaming resource. If you leave this parameter empty, the system automatically generates a 36-character random UUID string.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', 'title' => ''],
],
[
- 'name' => 'UserId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '操作者用户ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'as****hs',
- ],
+ 'name' => 'StartTs',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The start time of the query. Specify a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1632153600', 'title' => ''],
+ ],
+ [
+ 'name' => 'EndTs',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The end time of the query. Specify a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1637302350', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Data' => [
+ 'description' => 'The playback duration query result.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'WatchTime' => ['description' => 'The playback duration. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<StopClassResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n</StopClassResponse>","errorExample":""}]',
- ],
- 'UpdateClass' => [
- 'summary' => '更新课堂',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Meter.ParamError', 'errorMessage' => 'Param Error:%s,Please Check Again.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'Meter.AuthError', 'errorMessage' => 'Authentication Failed,Please Try Again.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Meter.ServerInternalError', 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', 'description' => ''],
+ ['errorCode' => 'Meter.DataSourceQueryError', 'errorMessage' => 'Data Source Error:%s,Please Try Again.', 'description' => ''],
+ ],
+ 502 => [
+ ['errorCode' => 'Meter.ReadyTsError', 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Data\\": [\\n {\\n \\"WatchTime\\": 32\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query playback duration of a specified live streaming resource',
+ 'summary' => 'Queries the playback duration of a specified live streaming resource by calling DescribeMeterImpPlayBackTimeByLiveId.',
+ 'description' => 'Retrieves the playback duration based on a time range and the unique ID of a live streaming resource.',
+ 'requestParamsDescription' => 'The maximum query range is 31 days. You can query data within the last 3 months.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImpPlayBackTimeByLiveId'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:DescribeMeterImpPlayBackTimeByLiveId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeMeterImpWatchLiveTimeByLiveId' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'AppId',
- 'in' => 'formData',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q', 'title' => ''],
+ ],
+ [
+ 'name' => 'LiveId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unique ID of the live stream resource. If you leave this parameter empty, the system automatically generates a 36-character random UUID string.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Data' => [
+ 'description' => 'The watch duration query result.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'WatchTimeInLatency' => ['description' => 'The standard-latency watch duration, such as watching over RTMP, FLV, or HLS protocols. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''],
+ 'WatchTimeInLowLatency' => ['description' => 'The low-latency watch duration, such as watching over RTS. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '43', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Meter.ParamError', 'errorMessage' => 'Param Error:%s,Please Check Again.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'Meter.AuthError', 'errorMessage' => 'Authentication Failed,Please Try Again.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Meter.ServerInternalError', 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', 'description' => ''],
+ ['errorCode' => 'Meter.DataSourceQueryError', 'errorMessage' => 'Data Source Error:%s,Please Try Again.', 'description' => ''],
+ ],
+ 502 => [
+ ['errorCode' => 'Meter.ReadyTsError', 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Data\\": [\\n {\\n \\"WatchTimeInLatency\\": 32,\\n \\"WatchTimeInLowLatency\\": 43\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query watch duration by live stream ID',
+ 'summary' => 'Queries watch duration data by live stream ID, including standard-latency watch duration and low-latency watch duration.',
+ 'description' => 'Queries the standard-latency watch duration and low-latency watch duration by the unique ID of a live stream resource.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImpWatchLiveTimeByLiveId'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:DescribeMeterImpWatchLiveTimeByLiveId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'GetAuthToken' => [
+ 'summary' => 'Retrieves a persistent connection token. The client can use this token to communicate with various atomic capabilities through the LWP protocol over persistent connections.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ClassId',
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '课堂唯一标识。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A55-****-Y34O',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits, and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'Title',
+ 'name' => 'AppKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '课堂标题，1~32个字符。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ClassTitle001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application key, created and queried in the console. The value contains lowercase letters and digits, and is 32 characters in length.', 'type' => 'string', 'required' => true, 'example' => '06***9c'],
],
[
- 'name' => 'CreateUserId',
+ 'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '创建人用户ID，仅支持中英文数字，下划线，中划线，1~36个字符。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID, which is user-defined and must be unique within the scope of an AppId. The value contains lowercase letters, digits, underscores (_), and periods (.). Maximum length: 32 characters. Different users must use different UserIds.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
],
[
- 'name' => 'CreateNickname',
+ 'name' => 'DeviceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '创建人用户昵称，1~32个字符。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'nickname001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The device ID that uniquely identifies a user device. This value is user-defined and contains lowercase letters, digits, underscores (_), and hyphens (-). Maximum length: 64 characters. Different devices must use different DeviceIds. We recommend obtaining this value from the device and passing it to the server.', 'type' => 'string', 'required' => true, 'example' => 'a494caec-***-695ef345db77'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => [
+ 'description' => 'The result of the token retrieval.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessToken' => ['title' => '', 'description' => 'The token used to establish a persistent connection.', 'type' => 'string', 'example' => 'oauth_cloud_key:***-b0YY5Gy6Q'],
+ 'RefreshToken' => ['title' => '', 'description' => 'The refresh token. If the AccessToken expires, you can use the RefreshToken to obtain a new token.', 'type' => 'string', 'example' => 'oauth_cloud_key:****-Q62xggOTdgk3gw='],
+ 'AccessTokenExpiredTime' => ['title' => '', 'description' => 'The expiration time of the access token. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '86400000'],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateClassResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n</UpdateClassResponse>","errorExample":""}]',
- ],
- 'GetClassDetail' => [
- 'summary' => '获取课堂详情',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Obtain a persistent connection token',
+ 'description' => 'The typical workflow for this operation is as follows: the client obtains the UserId and DeviceId, passes them to the server, and the server calls this operation to retrieve an authentication token and returns it to the client. Different users must use different UserIds, and different devices must use different DeviceIds.',
+ 'changeSet' => [
+ ['createdAt' => '2021-07-08T11:46:29.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAuthToken'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetAuthToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetClassDetail' => [
+ 'summary' => 'Queries the details of a class by calling GetClassDetail. You can use this operation to query the class status and the IDs of associated resources such as live streaming, co-streaming, and whiteboard. You can use these IDs to further query the details of the corresponding live streaming, co-streaming, and whiteboard resources.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, which is generated when the application is created in the console. The ID consists of lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
'name' => 'ClassId',
'in' => 'formData',
- 'schema' => [
- 'title' => '课堂唯一标识，由调用CreateClass返回。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A55-****-Y34O',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the class, which is returned by the CreateClass operation.', 'type' => 'string', 'required' => true, 'example' => 'A55-****-Y34O'],
],
[
'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作人用户ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID of the operator. The ID can contain only letters and digits and is up to 36 characters in length.', 'type' => 'string', 'example' => 'as****hs', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => 'API请求的返回结果结构体。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The result returned for the class details query.',
'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',
- ],
+ 'ClassId' => ['title' => '', 'description' => 'The unique identifier of the class.', 'type' => 'string', 'example' => 'A55-****-Y34O'],
+ 'Title' => ['title' => '', 'description' => 'The title of the class. The title can contain Chinese and English characters and is up to 32 characters in length.', 'type' => 'string', 'example' => 'ClassTitle001'],
+ 'CreateUserId' => ['title' => '', 'description' => 'The user ID of the creator. The ID can contain only letters and digits and is up to 36 characters in length.', 'type' => 'string', 'example' => 'as****hs'],
+ 'CreateNickname' => ['title' => '', 'description' => 'The nickname of the creator. The nickname can contain Chinese and English characters and is up to 32 characters in length.', 'type' => 'string', 'example' => 'nickname001'],
+ 'Status' => ['title' => '', 'description' => 'The class status. Valid values:'."\n"
+ .'- 0: Not started.'."\n"
+ .'- 1: In progress.'."\n"
+ .'- 2: Ended.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'StartTime' => ['title' => '', 'description' => 'The timestamp when the class started. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1632794405000'],
+ 'EndTime' => ['title' => '', 'description' => 'The timestamp when the class ended. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1632797405000'],
+ 'RoomId' => ['title' => '', 'description' => 'The room ID. You can use this ID to query room details and pass it as a parameter when integrating with the client SDK.', 'type' => 'string', 'example' => 'AE35-****-T95F'],
+ 'LiveId' => ['title' => '', 'description' => 'The live streaming ID. You can use this ID to query live streaming details and pass it as a parameter when calling live streaming-related operations on the client.', 'type' => 'string', 'example' => 'b7f2****ebb3'],
+ 'ConfId' => ['title' => '', 'description' => 'The co-streaming conference ID. You can use this ID to join an RTC conference and query conference details.', 'type' => 'string', 'example' => 'fb0f-****-4cb1'],
+ 'WhiteboardId' => ['title' => '', 'description' => 'The whiteboard ID. You can use this ID to query whiteboard information and pass it as a parameter when integrating with the whiteboard SDK on the client.', 'type' => 'string', 'example' => 'fgej**2'],
+ 'WhiteboardRecordId' => ['title' => '', 'description' => 'The whiteboard recording ID. You can use this ID to retrieve and play back whiteboard recording content on the client.', 'type' => 'string', 'example' => 'eofg**rt'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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":"<GetClassDetailResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <ClassId>A55-****-Y34O</ClassId>\\n <Title>ClassTitle001</Title>\\n <CreateUserId>as****hs</CreateUserId>\\n <CreateNickname>nickname001</CreateNickname>\\n <Status>2</Status>\\n <StartTime>1632794405000</StartTime>\\n <EndTime>1632797405000</EndTime>\\n <RoomId>AE35-****-T95F</RoomId>\\n <LiveId>b7f2****ebb3</LiveId>\\n <ConfId>fb0f-****-4cb1</ConfId>\\n <WhiteboardId>fgej**2</WhiteboardId>\\n <WhiteboardRecordId>eofg**rt</WhiteboardRecordId>\\n </Result>\\n</GetClassDetailResponse>","errorExample":""}]',
- ],
- 'ListClasses' => [
- 'summary' => '获取课程列表',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Get class details',
+ 'changeSet' => [
+ ['createdAt' => '2021-10-18T06:21:09.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-09-26T13:08:30.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClassDetail'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetClassDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetClassRecord' => [
+ 'summary' => 'Calls GetClassRecord to retrieve class recording information. You can use this operation to obtain the playback URL after a class ends. If the class has not ended, the result is empty.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2979,191 +2097,277 @@
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'lq****cu',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'lq****cu'],
],
[
- 'name' => 'Status',
+ 'name' => 'ClassId',
'in' => 'formData',
- 'schema' => [
- 'title' => '课程状态，0-未开课 1-上课中 2-已下课，不传则返回所有课程。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the class, returned by calling CreateClass.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'UserId',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The user ID of the operator. The value can contain only letters and digits and is up to 36 characters in length.', 'type' => 'string', 'example' => '34**29', 'required' => false],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '查询页码，从1开始，传空默认查询第1页。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => [
+ 'title' => '',
+ 'description' => 'The response struct of the API request.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PlaybackUrlMap' => [
+ 'description' => 'The collection of playback URLs. The key indicates the playback video type. Valid values: m3u8, mp4, and flv. Currently, only the m3u8 type is provided.',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => ['description' => '回放URL。', 'type' => 'string', 'example' => 'http://***.aliyuncs.com/***8fc5-***f8****.webm?****77650&***xzSQU***', 'title' => ''],
+ 'description' => '地址列表。',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Retrieve class recording information',
+ 'changeSet' => [
+ ['createdAt' => '2021-12-28T13:01:19.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClassRecord'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:GetClassRecord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'GetConference' => [
+ 'summary' => 'Queries the information about a specified co-streaming session by calling GetConference, including the co-streaming title and status. You can also query the recording URL after the co-streaming session ends.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'PageSize',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'ConferenceId',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the co-streaming session. The value consists of letters, digits, and hyphens (-), and is 36 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'fb0f-****-4cb1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '每页显示个数，最大支持50，参数为空默认显示个数为10。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '25',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => [
+ 'title' => '',
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ConferenceId' => ['title' => '', 'description' => 'The unique identifier of the co-streaming session, returned by calling CreateConference. The value consists of letters, digits, and hyphens (-), and is 36 characters in length.', 'type' => 'string', 'example' => 'fb0f-****-4cb1'],
+ 'Title' => ['title' => '', 'description' => 'The conference title. The title supports both Chinese and English characters and can be up to 128 characters in length.', 'type' => 'string', 'example' => 'This is a Title'],
+ 'Status' => ['title' => '', 'description' => 'The status. Valid values:'."\n"
+ .'- **Init**: Not started. '."\n"
+ .'- **Start**: Co-streaming in progress.'."\n"
+ .'- **End**: Co-streaming ended.', 'type' => 'string', 'example' => 'Init'],
+ 'RoomId' => ['title' => '', 'description' => 'The unique identifier of the room. The value can be up to 36 characters in length.', 'type' => 'string', 'example' => 'AE35-****-T95F'],
+ 'UserId' => ['title' => '', 'description' => 'The user who created the co-streaming session. The value is unique within the AppId. The value consists of letters, digits, underscores (_), hyphens (-), periods (.), and at signs (@), and is 1 to 36 characters in length.', 'type' => 'string', 'example' => 'as****hs'],
+ 'AppId' => ['title' => '', 'description' => 'The unique identifier of the application. The value can contain lowercase letters and digits, and is 6 characters in length.', 'type' => 'string', 'example' => '7m***q'],
+ 'CreateTime' => ['title' => '', 'description' => 'The timestamp when the co-streaming session was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624589848000'],
+ 'PlaybackUrl' => ['title' => '', 'description' => 'The recording playback URL in M3U8 format. The URL is generated 10 seconds after the co-streaming session ends.', 'type' => 'string', 'example' => 'http://xxxx.com/b7f29c02-****-40fd-****-e8d06a8aebb3_merged.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ ],
+ 'example' => 'true',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query co-streaming session details',
+ 'changeSet' => [
+ ['createdAt' => '2021-08-10T08:32:46.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConference'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetConference',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
+ ],
+ 'GetLive' => [
+ 'summary' => 'Queries information associated with a specified live stream.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'LiveId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the live stream resource.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'ER52****O9CA',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '创建课程返回的结果。',
- 'description' => '',
+ 'description' => 'The result of querying the live stream details.',
'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' => '',
+ 'AnchorId' => ['title' => '', 'description' => 'The anchor ID.', 'type' => 'string', 'example' => 'as****hs'],
+ 'LiveId' => ['title' => '', 'description' => 'The unique ID of the live stream resource.', 'type' => 'string', 'example' => 'b7f2****ebb3'],
+ 'Title' => ['title' => '', 'description' => 'The live stream title.', 'type' => 'string', 'example' => 'This is a title.'],
+ 'PlaybackUrl' => ['title' => '', 'description' => 'The playback URL of the live stream. This URL is generated when the live stream starts and can be used for playback after the live stream ends.', 'type' => 'string', 'example' => 'http://demo-app-playback.com/live/b7f2****ebb3.m3u8?auth_key=e620****a8e3'],
+ 'CreateTime' => ['title' => '', 'description' => 'The time when the live stream was created, in milliseconds. This value is generated after the live stream starts.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000'],
+ 'EndTime' => ['title' => '', 'description' => 'The time when the live stream ended, in milliseconds. This value is generated after the live stream ends.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000'],
+ 'Duration' => ['title' => '', 'description' => 'The duration of the live stream, in milliseconds. This value is generated after the live stream ends.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
+ 'PushUrl' => ['title' => '', 'description' => 'The ingest URL of the live stream.', 'type' => 'string', 'example' => 'rtmp://demo-app-push.com/live/e620****a8e3?auth_key=e620****a8e3'],
+ 'LiveUrl' => ['title' => '', 'description' => 'The streaming URL of the live stream.', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/e620****a8e3.flv?auth_key=e620****a8e3'],
+ 'Status' => ['title' => '', 'description' => 'The status of the live stream. Valid values:'."\n"
+ .'* **Created**: The live stream has been created but has not started.'."\n"
+ .'* **Living**: The live stream is in progress.'."\n"
+ .'* **End**: The live stream has ended.', 'type' => 'string', 'example' => 'Created'],
+ 'Introduction' => ['title' => '', 'description' => 'The introduction of the live stream.', 'type' => 'string', 'example' => 'This is an introduction.'],
+ 'RoomId' => ['title' => '', 'description' => 'The room ID.', 'type' => 'string', 'example' => 'AE35-****-T95F'],
+ 'AppId' => ['title' => '', 'description' => 'The tenant name.', 'type' => 'string', 'example' => '7m***q'],
+ 'UserId' => ['title' => '', 'description' => 'The user who created the live stream.', 'type' => 'string', 'example' => 'as****hs'],
+ 'CodeLevel' => ['title' => '', 'description' => 'The bitrate level of the live stream ingest. Valid values:'."\n"
+ .'* **-1**: Smooth. Resolution: adaptive width, height: 360. Encoding format: H.264.'."\n"
+ .'* **1**: Standard definition. Resolution: adaptive width, height: 432. Encoding format: H.264.'."\n"
+ .'* **2**: High definition. Resolution: adaptive width, height: 648. Encoding format: H.264.'."\n"
+ .'* **3**: Ultra-high definition. Resolution: adaptive width, height: 1080. Encoding format: H.264.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PlayUrlInfoList' => [
+ 'title' => '',
+ 'description' => 'The playback information for multiple resolutions and protocols.',
'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',
- ],
+ 'CodeLevel' => ['title' => '', 'description' => 'The bitrate level of the live stream ingest. Valid values:'."\n"
+ .'* **-1**: Smooth. Resolution: adaptive width, height: 360. Encoding format: H.264.'."\n"
+ .'* **1**: Standard definition. Resolution: adaptive width, height: 432. Encoding format: H.264.'."\n"
+ .'* **2**: High definition. Resolution: adaptive width, height: 648. Encoding format: H.264.'."\n"
+ .'* **3**: Ultra-high definition. Resolution: adaptive width, height: 1080. Encoding format: H.264.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'FlvUrl' => ['title' => '', 'description' => 'The FLV streaming URL.', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f2****ebb3.flv?auth_key=e620****a8e3'],
+ 'HlsUrl' => ['title' => '', 'description' => 'The HLS streaming URL.', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f2****ebb3.m3u8?auth_key=e620****a8e3'],
+ 'RtmpUrl' => ['title' => '', 'description' => 'The RTMP streaming URL.', 'type' => 'string', 'example' => 'rtmp://demo-app-live.com/live/b7f2****ebb3?auth_key=e620****a8e3'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
+ ],
+ 'CoverUrl' => ['title' => '', 'description' => 'The cover image URL.', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.png'],
+ 'UserDefineField' => ['title' => '', 'description' => 'The user-defined data storage.', 'type' => 'string', 'example' => '{"selfData":"example"}'],
+ 'HlsUrl' => ['title' => '', 'description' => 'The original HLS playback URL.', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'ArtcInfo' => [
+ 'title' => '',
+ 'description' => 'The RTS low-latency streaming information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ArtcUrl' => ['title' => '', 'description' => 'The RTS original stream URL. We recommend that you use this URL on mobile clients.', 'type' => 'string', 'example' => 'artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'ArtcH5Url' => ['title' => '', 'description' => 'The RTS transcoded stream URL. We recommend that you use this URL on web clients.', 'type' => 'string', 'example' => 'artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ ],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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":"<ListClassesResponse>\\n <RequestId>ER52****O9CA</RequestId>\\n <Result>\\n <TotalCount>1000</TotalCount>\\n <PageTotal>100</PageTotal>\\n <HasMore>true</HasMore>\\n <ClassList>\\n <ClassId>AE35****T95F</ClassId>\\n <Title>PPT制作培训</Title>\\n <CreateUserId>34***45</CreateUserId>\\n <CreateNickname>随风</CreateNickname>\\n <Status>2</Status>\\n <RoomId>AE35-****-T95F</RoomId>\\n <LiveId>b7f2****ebb3</LiveId>\\n <ConfId>fb0f-****-4cb1</ConfId>\\n <WhiteboardId>fgej**2</WhiteboardId>\\n <WhiteboardRecordId>eofg**rt</WhiteboardRecordId>\\n </ClassList>\\n </Result>\\n</ListClassesResponse>","errorExample":""}]',
- ],
- 'GetClassRecord' => [
- 'summary' => '获取课程录制详情',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query live stream details',
+ 'changeSet' => [
+ ['createdAt' => '2021-10-18T12:34:52.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-07-08T11:46:29.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLive'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetLive',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetLiveRecord' => [
+ 'summary' => 'Retrieves live recording information. You can call this operation to obtain the playback URL after a live stream ends. If the live stream has not ended, the result is empty.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3175,1226 +2379,1083 @@
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'lq****cu',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application, which is a 6-character string of lowercase letters and digits. You can obtain this identifier from the console after creating the application.', 'type' => 'string', 'required' => true, 'example' => 'lq****cu'],
],
[
- 'name' => 'ClassId',
+ 'name' => 'LiveId',
'in' => 'formData',
- 'schema' => [
- 'title' => '课程唯一标识，由调用CreateClass返回。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35****T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the live stream, returned by calling CreateLiveRoom.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
],
[
'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作人用户ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '34**29',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID of the operator.', 'type' => 'string', 'example' => '34**29', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08F'],
'Result' => [
- 'title' => 'API请求的返回结果结构体。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response struct of the API request.',
'type' => 'object',
'properties' => [
'PlaybackUrlMap' => [
- 'description' => '',
+ 'description' => 'The collection of playback URLs. The key indicates the playback video type. Valid values: m3u8, mp4, and flv. Currently, only the m3u8 type is provided.',
'type' => 'object',
'additionalProperties' => [
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'example' => 'http://***.aliyuncs.com/***8fc5-***f8****.webm?****77650&***xzSQU***',
- 'description' => '',
- ],
- 'description' => '',
+ 'items' => ['description' => '回放URL。', 'type' => 'string', 'example' => 'http://demo.aliyundoc.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3', 'title' => ''],
+ 'description' => '地址列表。',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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":"<GetClassRecordResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <PlaybackUrlMap>\\n <m3u8>http://***.aliyuncs.com/***8fc5-***f8****.webm?****77650&amp;***xzSQU***</m3u8>\\n </PlaybackUrlMap>\\n </Result>\\n</GetClassRecordResponse>","errorExample":""}]',
- ],
- 'UpdateShareScreenLayout' => [
- 'summary' => '更新共享桌面下叠加画面的布局',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Retrieve live recording information',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveRecord'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:GetLiveRecord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetLiveRoom' => [
+ 'summary' => 'Queries the information about a specified live room by calling GetLiveRoom.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'lq****cu',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, which is generated when the application is created in the console. The ID consists of lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'ClassId',
+ 'name' => 'LiveId',
'in' => 'formData',
- 'schema' => [
- 'title' => '课堂唯一标识，由调用CreateClass返回。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35****T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the live stream.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3'],
],
- [
- 'name' => 'EnableOverlay',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '是否开启叠加老师画面',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => [
+ 'title' => '',
+ 'description' => 'The result returned for querying live room details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppId' => ['title' => '', 'description' => 'The application ID of the user, which is generated when the application is created in the console. The ID consists of lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'example' => '7m***q'],
+ 'LiveId' => ['title' => '', 'description' => 'The unique ID of the live stream.', 'type' => 'string', 'example' => 'b7f2****ebb3'],
+ 'Status' => ['title' => '', 'description' => 'The status of the live stream. Valid values:'."\n"
+ .'* **0**: Created. The live stream has not started.'."\n"
+ .'* **1**: Streaming. The live stream is in progress.'."\n"
+ .'* **2**: Ended. The live stream has ended.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RoomId' => ['title' => '', 'description' => 'The unique ID of the room.', 'type' => 'string', 'example' => 'AE35-****-T95F'],
+ 'ChatId' => ['title' => '', 'description' => 'The unique identifier of the chat.', 'type' => 'string', 'example' => '09***f8'],
+ 'Title' => ['title' => '', 'description' => 'The title of the live stream.', 'type' => 'string', 'example' => 'Title001'],
+ 'Notice' => ['title' => '', 'description' => 'The announcement of the live stream.', 'type' => 'string', 'example' => 'Notice001'],
+ 'CoverUrl' => ['title' => '', 'description' => 'The cover image URL of the live stream.', 'type' => 'string', 'example' => 'http://***.png'],
+ 'AnchorId' => ['title' => '', 'description' => 'The anchor ID.', 'type' => 'string', 'example' => 'as****hs'],
+ 'Uv' => ['title' => '', 'description' => 'The number of unique visitors. Multiple visits by the same visitor to the live room are counted as one UV.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'OnlineCount' => ['title' => '', 'description' => 'The number of online users.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'PlaybackUrl' => ['title' => '', 'description' => 'The playback URL of the live stream. This URL is generated when the live stream starts and can be used for playback after the live stream ends.', 'type' => 'string', 'example' => 'http://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'PlaybackUrlHttps' => ['title' => '', 'description' => 'The HTTPS playback URL of the live stream.', 'type' => 'string', 'example' => 'https://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'CreateTime' => ['title' => '', 'description' => 'The time when the live stream was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000'],
+ 'EndTime' => ['title' => '', 'description' => 'The time when the live stream ended. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000'],
+ 'PushUrl' => ['title' => '', 'description' => 'The ingest URL of the live stream.', 'type' => 'string', 'example' => 'rtmp://demo-app-push.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'LiveUrl' => ['title' => '', 'description' => 'The streaming URL of the live stream.', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'LiveUrlHttps' => ['title' => '', 'description' => 'The HTTPS streaming URL of the live stream.', 'type' => 'string', 'example' => 'https://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'PluginInstanceInfoList' => [
+ 'title' => '',
+ 'description' => 'The list of active plugins.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PluginType' => ['title' => '', 'description' => 'The unique identifier of the plugin type. Valid values:'."\n"
+ .'- **live**: live streaming.'."\n"
+ .'- **wb**: whiteboard.'."\n"
+ .'- **chat**: chat.'."\n"
+ .'- **rtc**: real-time communication.', 'type' => 'string', 'example' => 'live'],
+ 'PluginId' => ['title' => '', 'description' => 'The unique identifier of the plugin instance.', 'type' => 'string', 'example' => 'HASU-****-ASHD'],
+ 'CreateTime' => ['title' => '', 'description' => 'The timestamp when the plugin instance was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624589848000'],
+ 'Extension' => [
+ 'title' => '',
+ 'description' => 'The extension field of the plugin.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '插件拓展信息。', 'type' => 'string', 'example' => 'test001', 'title' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'Extension' => [
+ 'title' => '',
+ 'description' => 'The extension field of the live stream.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '直播拓展信息。', 'type' => 'string', 'example' => 'test001', 'title' => ''],
+ 'example' => '',
+ ],
+ 'Pv' => ['title' => '', 'description' => 'The number of page views. Multiple visits by the same visitor to the live room are accumulated in the PV count.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'AnchorNick' => ['title' => '', 'description' => 'The nickname of the anchor.', 'type' => 'string', 'example' => 'User001'],
+ 'StartTime' => ['title' => '', 'description' => 'The time when the live stream started. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000'],
+ 'HlsUrl' => ['title' => '', 'description' => 'The original-quality HLS playback URL.', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'HlsUrlHttps' => ['title' => '', 'description' => 'The HTTPS original-quality HLS playback URL.', 'type' => 'string', 'example' => 'https://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'RtmpUrl' => ['title' => '', 'description' => 'The RTMP playback URL.', 'type' => 'string', 'example' => 'rtmp://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'ArtcInfo' => [
+ 'title' => '',
+ 'description' => 'The RTS low-latency streaming information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ArtcUrl' => ['title' => '', 'description' => 'The RTS original stream URL. We recommend that you use this URL on mobile clients.', 'type' => 'string', 'example' => 'artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'ArtcH5Url' => ['title' => '', 'description' => 'The RTS transcoded stream URL. We recommend that you use this URL on web clients.', 'type' => 'string', 'example' => 'artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ ],
+ 'example' => '',
+ ],
+ 'EnableLinkMic' => ['title' => '', 'description' => 'Indicates whether co-streaming is enabled.', 'type' => 'boolean', 'example' => 'true:开启连麦。false:未开启连麦。'],
+ 'ConfId' => ['title' => '', 'description' => 'The unique identifier of the co-streaming conference.', 'type' => 'string', 'example' => 'fb0f-****-4cb1'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query live room details',
+ 'changeSet' => [
+ ['createdAt' => '2021-09-26T03:45:26.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-09-26T03:45:26.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-09-26T03:45:26.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveRoom'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'OverlayX',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '叠加画面X坐标，归一化为1',
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '0.7576',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetLiveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'GetLiveRoomStatistics' => [
+ 'summary' => 'Invokes GetLiveRoomStatistics to query the statistics information of a specified live room. This operation is planned to be replaced by a new solution and is not recommended.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'OverlayY',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '叠加画面Y坐标，归一化为1',
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '0.7576',
- ],
+ 'AK' => [],
],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
[
- 'name' => 'OverlayWidth',
+ 'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '叠加画面宽度，归一化为1',
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '0.2361',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID. This ID is generated when you create an application in the console. It consists of 6 lowercase letters and digits.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'OverlayHeight',
+ 'name' => 'LiveId',
'in' => 'formData',
- 'schema' => [
- 'title' => '叠加画面高度，归一化为1',
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '0.2361',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the live room resource.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => [
+ 'title' => '',
+ 'description' => 'The result returned for the live room statistics query.',
+ 'type' => 'object',
+ 'properties' => [
+ 'LiveId' => ['title' => '', 'description' => 'The unique ID of the live room resource.', 'type' => 'string', 'example' => 'b7f2****ebb3'],
+ 'Status' => ['title' => '', 'description' => 'The status of the live room. Valid values:'."\n"
+ .'* **0**: Created but not started.'."\n"
+ .'* **1**: Streaming.'."\n"
+ .'* **2**: Ended.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Uv' => ['title' => '', 'description' => 'The number of unique visitors. Multiple visits by the same visitor to the live room are counted as one UV.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'Pv' => ['title' => '', 'description' => 'The number of page views. Multiple visits by the same visitor to the live room are accumulated in the PV count.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'MessageCount' => ['title' => '', 'description' => 'The number of interactive messages.', 'type' => 'integer', 'format' => 'int64', 'example' => '500'],
+ 'StartTime' => ['title' => '', 'description' => 'The start time of the live room, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000'],
+ 'EndTime' => ['title' => '', 'description' => 'The end time of the live room, in milliseconds. This value is generated after the live room ends.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000'],
+ 'WatchLiveTime' => ['title' => '', 'description' => 'The total watch duration of all users, in milliseconds. This value can be retrieved during the live stream with a data delay of a few minutes. For live rooms created before June 24, 2022 00:00:00, this value is generated only after the live room ends.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000'],
+ 'LikeCount' => ['title' => '', 'description' => 'The number of likes.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'OnlineCount' => ['title' => '', 'description' => 'The number of online users.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateShareScreenLayoutResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n</UpdateShareScreenLayoutResponse>","errorExample":""}]',
- ],
- 'CreateRoom' => [
- 'summary' => '创建房间',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query live room statistics',
+ 'changeSet' => [
+ ['createdAt' => '2021-09-26T03:45:26.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-09-26T03:45:26.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveRoomStatistics'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:GetLiveRoomStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetLiveRoomUserStatistics' => [
+ 'summary' => 'Invokes GetLiveRoomUserStatistics to query user viewing statistics for a specified live room by paging. This operation is planned to be migrated to a new solution and is not recommended.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => [],
'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',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, which is generated when the application is created in the console. The ID consists of lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'Title',
+ 'name' => 'LiveId',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间标题，支持中英文，最大长度32位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RoomTitle001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the live resource.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3'],
],
[
- 'name' => 'Notice',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间公告，支持中英文，最大长度256位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RoomNotice001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The page number to query, starting from 1. If this parameter is left empty, the first page is queried by default.', 'type' => 'string', 'example' => '1', 'required' => false],
],
[
- 'name' => 'RoomOwnerId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '房主用户id，仅支持英文和数字，最大长度36位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'as****hs',
- ],
- ],
- [
- 'name' => 'Extension',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '拓展字段，按需传递，需要额外记录的房间属性。',
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test001',
- ],
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page. Maximum value: 50. If this parameter is left empty, the default value is 10.', 'type' => 'string', 'example' => '25', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => 'API请求的返回结果结构体。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The paging query result of live room user statistics.',
'type' => 'object',
'properties' => [
- 'RoomId' => [
- 'title' => '房间id',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AE35-****-T95F',
+ 'LiveId' => ['title' => '', 'description' => 'The unique ID of the live resource.', 'type' => 'string', 'example' => 'b7f2****ebb3'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of viewers.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageTotal' => ['title' => '', 'description' => 'The total number of pages for viewers.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'HasMore' => ['title' => '', 'description' => 'Indicates whether more pages are available.', 'type' => 'boolean', 'example' => 'true'],
+ 'UserStatisticsList' => [
+ 'title' => '',
+ 'description' => 'The list of user viewing statistics.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => 'User001'],
+ 'WatchLiveTime' => ['title' => '', 'description' => 'The viewing duration, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'],
+ 'CommentCount' => ['description' => 'The number of comments sent by the user.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'LikeCount' => ['description' => 'The number of likes from the user.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '10000000',
],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRoomId.Room.AlreadyExist',
- 'errorMessage' => 'Room is already exist.',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Paged query of live room user statistics',
+ 'description' => 'The viewing duration of a viewer is the cumulative total of the user\'s viewing time, including multiple views and views from multiple devices. If the calculated result exceeds the total live streaming duration, the total live streaming duration is recorded instead.',
+ 'changeSet' => [
+ ['createdAt' => '2021-09-26T03:45:26.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-09-26T03:45:26.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveRoomUserStatistics'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:GetLiveRoomUserStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"RoomId\\": \\"AE35-****-T95F\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateRoomResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <RoomId>AE35-****-T95F</RoomId>\\n </Result>\\n</CreateRoomResponse>","errorExample":""}]',
],
- 'DeleteRoom' => [
- 'summary' => '销毁房间',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetRoom' => [
+ 'summary' => 'Queries the information about a specified room, including room details and active atomic capability information.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
'name' => 'RoomId',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间唯一标识，由字母、数字、符号.和-组成，最大长度36位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35-****-T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The room ID. The value can contain letters, digits, periods (.), and hyphens (-), with a maximum length of 36 characters.', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ 'Result' => [
+ 'title' => '',
+ 'description' => 'The returned result of the room query.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoomInfo' => [
+ 'title' => '',
+ 'description' => 'The room information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoomId' => ['title' => '', 'description' => 'The unique identifier of the room.', 'type' => 'string', 'example' => 'AE35-****-T95F'],
+ 'Title' => ['title' => '', 'description' => 'The title of the room.', 'type' => 'string', 'example' => 'RoomTitle001'],
+ 'CreateTime' => ['title' => '', 'description' => 'The timestamp when the room was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624589848000'],
+ 'Notice' => ['title' => '', 'description' => 'The room notice.', 'type' => 'string', 'example' => 'RoomNotice001'],
+ 'RoomOwnerId' => ['title' => '', 'description' => 'The user ID of the room owner.', 'type' => 'string', 'example' => 'as****hs'],
+ 'Uv' => ['title' => '', 'description' => 'The number of unique visitors.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'OnlineCount' => ['title' => '', 'description' => 'The number of online users.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'PluginInstanceInfoList' => [
+ 'title' => '',
+ 'description' => 'The list of active plug-ins.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PluginType' => ['title' => '', 'description' => 'The unique identifier of the plug-in. Valid values:'."\n"
+ .'- **live**: live streaming.'."\n"
+ .'- **wb**: whiteboard.'."\n"
+ .'- **chat**: chat.'."\n"
+ .'- **RTC**: audio and video communication.', 'type' => 'string', 'example' => 'live'],
+ 'PluginId' => ['title' => '', 'description' => 'The unique identifier of the plug-in instance.', 'type' => 'string', 'example' => 'HASU-****-ASHD'],
+ 'CreateTime' => ['title' => '', 'description' => 'The timestamp when the plug-in instance was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624589848000'],
+ 'Extension' => [
+ 'title' => '',
+ 'description' => 'The extension field of the plug-in.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '插件拓展信息。', 'type' => 'string', 'example' => 'test001', 'title' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'AppId' => ['title' => '', 'description' => 'The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'example' => 'lq****cu'],
+ 'TemplateId' => ['title' => '', 'description' => 'The ID of the template used to create the room.', 'type' => 'string', 'example' => 'default'],
+ 'Extension' => [
+ 'title' => '',
+ 'description' => 'The extension field of the room.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '房间拓展信息。', 'type' => 'string', 'example' => 'test001', 'title' => ''],
+ 'example' => '',
+ ],
+ 'Pv' => ['title' => '', 'description' => 'The total number of page views.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'AdminIdList' => [
+ 'title' => '',
+ 'description' => 'The list of administrator IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The administrator ID.', 'type' => 'string', 'example' => 'as****hs', 'title' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRoomId.Room.NotExist',
- 'errorMessage' => 'Room does not exist.',
- ],
+ ['errorCode' => 'InvalidRoomId.Room.NotExist', 'errorMessage' => 'Room does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteRoomResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n</DeleteRoomResponse>","errorExample":""}]',
- ],
- 'UpdateRoom' => [
- 'summary' => '更新房间信息',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query room details',
+ 'changeSet' => [
+ ['createdAt' => '2021-07-08T11:46:28.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRoom'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetStandardRoomJumpUrl' => [
+ 'summary' => 'Retrieves a redirect URL for the low-code service by calling GetStandardRoomJumpUrl.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits, and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'RoomId',
+ 'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间唯一标识。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35-****-T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID, which is unique within the specified AppId. The value contains lowercase letters, digits, underscores (_), and periods (.). The maximum length is 32 characters.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
],
[
- 'name' => 'Title',
+ 'name' => 'AppKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间标题，支持中英文，最大长度32位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RoomTitle001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The terminal device type, created and queried in the console. The value contains lowercase letters and digits, and is 32 characters in length.', 'type' => 'string', 'required' => true, 'example' => '06***9c'],
],
[
- 'name' => 'Notice',
+ 'name' => 'Platform',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间公告，支持中英文，最大长度256位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RoomNotice001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The platform type for which to retrieve the URL. Valid values:'."\n"
+ ."\n"
+ .'- win: Windows.'."\n"
+ ."\n"
+ .'- web: Web.'."\n"
+ .'- mac: Mac.', 'type' => 'string', 'required' => true, 'example' => 'web'],
],
[
- 'name' => 'RoomOwnerId',
+ 'name' => 'BizType',
'in' => 'formData',
- 'schema' => [
- 'title' => '房主用户id，仅支持英文和数字，最大长度36位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The business scenario type. Valid values:'."\n"
+ ."\n"
+ .'- live: interactive live streaming.'."\n"
+ ."\n"
+ .'- class: interactive classroom.', 'type' => 'string', 'required' => true, 'example' => 'live'],
],
[
- 'name' => 'Extension',
+ 'name' => 'BizId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '拓展字段，按需传递，需要额外记录的房间属性。',
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test001',
- ],
- ],
+ 'schema' => ['title' => '', 'description' => 'The resource ID. The value varies by business scenario type:'."\n"
+ ."\n"
+ .'- For interactive live streaming, specify the live streaming ID (LiveId).'."\n"
+ .'- For interactive classroom, specify the class ID (ClassId).', 'type' => 'string', 'required' => true, 'example' => 'b7f2-****-ebb3'],
+ ],
+ [
+ 'name' => 'UserNick',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The nickname displayed for the user. The value contains uppercase and lowercase letters, Chinese characters, digits, underscores (_), hyphens (-), periods (.), and at signs (@). The length is 1 to 36 characters.', 'type' => 'string', 'required' => true, 'example' => 'James'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '16A96B9A-****-CB92E68F4CD8'],
+ 'Result' => [
+ 'description' => 'The response of the GetStandardRoomJumpUrl operation.',
+ 'type' => 'object',
+ 'properties' => [
+ 'StandardRoomJumpUrl' => ['title' => '', 'description' => 'The redirect URL for the low-code service.', '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'],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRoomId.Room.NotExist',
- 'errorMessage' => 'Room does not exist.',
- ],
- [
- 'errorCode' => 'Forbidden.Room.Deleted',
- 'errorMessage' => 'Room has been deleted.',
+ ['errorCode' => 'InvalidParameter.StandardRoom.LowCodeDomainNotConfig', 'errorMessage' => 'This app is not configured with a low-code domain name.', 'description' => ''],
+ ['errorCode' => 'InvalidAppId.StandardRoom.CnameNotConfig', 'errorMessage' => 'The low-code integration service does not have a CNAME configured.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter.StandardRoom.AppKeyNotMatch', 'errorMessage' => 'The parameter AppId and the parameter AppKey do not match.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Retrieve a redirect URL for the low-code service',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-28T08:57:52.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-09-07T03:50:48.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetStandardRoomJumpUrl'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetStandardRoomJumpUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateRoomResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n</UpdateRoomResponse>","errorExample":""}]',
],
'KickRoomUser' => [
- 'summary' => '踢出房间用户',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Kicks a specific user out of a room by calling the KickRoomUser operation.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application, which consists of 6 lowercase letters and digits.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
'name' => 'RoomId',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间唯一标识，由字母、数字、符号.和-组成，最大长度36位，传空则随机生成一个房间id。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35****T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the room, which is returned when you call the CreateRoom operation.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
],
[
'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作人的用户ID，用于表示谁执行了踢人操作。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID of the operator, which indicates who performed the kick operation.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
],
[
'name' => 'KickUser',
'in' => 'formData',
- 'schema' => [
- 'title' => '被踢出房间的用户ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'er****h',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID of the user to be kicked out of the room.', 'type' => 'string', 'required' => true, 'example' => 'er****h'],
],
[
'name' => 'BlockTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '300',
- ],
+ 'schema' => ['description' => 'The duration for which the user is kicked out of the room. The user cannot re-enter the room within this period. Unit: seconds.'."\n"
+ ."\n"
+ .'- If this parameter is not specified, the default value is 300 seconds.'."\n"
+ ."\n"
+ .'- A value of 0 indicates that the user is permanently kicked out of the room.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<KickRoomUserResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n</KickRoomUserResponse>","errorExample":""}]',
- ],
- 'SetUserAdmin' => [
- 'summary' => '设置用户管理员',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Kick a user out of a room',
+ 'changeSet' => [
+ ['createdAt' => '2022-03-23T02:11:15.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'KickRoomUser'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:KickRoomUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListClasses' => [
+ 'summary' => 'Invokes ListClasses to retrieve a list of classes. You can perform a paged query of all classes for an application by application ID and class status.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application, which consists of 6 lowercase letters and digits.', 'type' => 'string', 'required' => true, 'example' => 'lq****cu'],
],
[
- 'name' => 'RoomId',
+ 'name' => 'Status',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间唯一标识，由字母、数字、符号.和-组成，最大长度36位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35****T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The class status.'."\n"
+ ."\n"
+ .'- 0: not started '."\n"
+ .'- 1: in progress '."\n"
+ .'- 2: ended'."\n"
+ .'- If this parameter is not specified, all classes are returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
- 'name' => 'UserId',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'er****h',
- ],
+ 'schema' => ['title' => '', 'description' => 'The page number, starting from 1. If this parameter is left empty, the first page is queried by default.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page. Maximum value: 50. If this parameter is left empty, the default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ER52****O9CA'],
+ 'Result' => [
+ 'title' => '',
+ 'description' => 'The result returned for the class list query.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of classes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
+ 'PageTotal' => ['title' => '', 'description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'HasMore' => ['title' => '', 'description' => 'Indicates whether there are more pages.', 'type' => 'boolean', 'example' => 'true'],
+ 'ClassList' => [
+ 'title' => '',
+ 'description' => 'The class list information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ClassId' => ['title' => '', 'description' => 'The unique identifier of the class.', 'type' => 'string', 'example' => 'AE35****T95F'],
+ 'Title' => ['title' => '', 'description' => 'The class title. Chinese and English characters are supported. Maximum length: 32 characters.', 'type' => 'string', 'example' => 'PPT制作培训'],
+ 'CreateUserId' => ['title' => '', 'description' => 'The user ID of the creator. Only English characters and digits are supported. Maximum length: 36 characters.', 'type' => 'string', 'example' => '34***45'],
+ 'CreateNickname' => ['title' => '', 'description' => 'The nickname of the creator. Chinese and English characters are supported. Maximum length: 32 characters.', 'type' => 'string', 'example' => '随风'],
+ 'Status' => ['title' => '', 'description' => 'The class status.'."\n"
+ ."\n"
+ .'- 0: not started '."\n"
+ .'- 1: in progress '."\n"
+ .'- 2: ended.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'StartTime' => ['title' => '', 'description' => 'The timestamp when the class started, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '16****450'],
+ 'EndTime' => ['title' => '', 'description' => 'The timestamp when the class ended, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '16****950'],
+ 'RoomId' => ['title' => '', 'description' => 'The room ID. You can use this ID to query room details and pass it as a parameter when integrating with the client SDK.', 'type' => 'string', 'example' => 'AE35-****-T95F'],
+ 'LiveId' => ['title' => '', 'description' => 'The live stream ID. You can use this ID to query live stream details and pass it as a parameter when calling live stream-related operations on the client.', 'type' => 'string', 'example' => 'b7f2****ebb3'],
+ 'ConfId' => ['title' => '', 'description' => 'The co-streaming conference ID. You can use this ID to join an RTC conference and retrieve conference details.', 'type' => 'string', 'example' => 'fb0f-****-4cb1'],
+ 'WhiteboardId' => ['title' => '', 'description' => 'The whiteboard ID. You can use this ID to query whiteboard information and pass it as a parameter when integrating with the whiteboard SDK on the client.', 'type' => 'string', 'example' => 'fgej**2'],
+ 'WhiteboardRecordId' => ['title' => '', 'description' => 'The whiteboard recording ID. You can use this ID to retrieve and play back whiteboard recording content on the client.', 'type' => 'string', 'example' => 'eofg**rt'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Forbidden.Room.AdminNumberOverLimit',
- 'errorMessage' => 'Room admin number exceeds limit.',
- ],
- [
- 'errorCode' => 'Forbidden.Room.OwnerCannotBeAdmin',
- 'errorMessage' => 'Room owner cannot be admin.',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'List classes',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-18T06:15:49.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClasses'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:ListClasses',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<SetUserAdminResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n</SetUserAdminResponse>","errorExample":""}]',
],
- 'CancelUserAdmin' => [
- 'summary' => '取消用户管理员',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListComments' => [
+ 'summary' => 'Queries comment messages in batches by calling ListComments.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
'name' => 'RoomId',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间唯一标识，由字母、数字、符号.和-组成，最大长度36位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35****T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the room, which is returned when you call CreateRoom.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
],
[
'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'er****h',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the operator who performs the batch query operation on comment messages.', 'type' => 'string', 'required' => false, 'example' => '62**59'],
],
- ],
- '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',
- ],
- ],
- ],
+ [
+ 'name' => 'CreatorId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ID of the comment creator.', 'type' => 'string', 'example' => '10**13', 'required' => false],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelUserAdminResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n</CancelUserAdminResponse>","errorExample":""}]',
- ],
- 'GetRoom' => [
- 'summary' => '获取房间详情',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PageNum',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The page number for querying comment messages in batches. The value starts from 1 and increments by 1 for each subsequent page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'AppId',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The page size for querying comment messages in batches. The minimum value is 1 and the maximum value is 100. If the value exceeds 100, only the first 100 records are returned.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '50'],
],
[
- 'name' => 'RoomId',
+ 'name' => 'SortType',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间唯一标识，由字母、数字、符号.和-组成，最大长度36位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35-****-T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The sort order for querying comment messages in batches. Valid values: 0 and 1.'."\n"
+ ."\n"
+ .'- **0**: sorts comment messages by creation time in descending order.'."\n"
+ ."\n"
+ .'- **1**: sorts comment messages by creation time in ascending order.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ER52****O9CA'],
'Result' => [
- 'title' => '查询房间信息返回结果。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The result of the batch query for comment messages.',
'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' => [
+ 'CommentVOList' => [
+ 'title' => '',
+ 'description' => 'The list of comment messages.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The comment message information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => '7m***q'],
+ 'RoomId' => ['title' => '', 'description' => 'The room ID.', 'type' => 'string', 'example' => 'AE35****T95F'],
+ 'CommentId' => ['title' => '', 'description' => 'The unique ID of the comment message.', 'type' => 'string', 'example' => '09***f8'],
+ 'SenderId' => ['title' => '', 'description' => 'The ID of the comment message sender.', 'type' => 'string', 'example' => '62**59'],
+ 'SenderNick' => ['title' => '', 'description' => 'The nickname of the comment message sender.', 'type' => 'string', 'example' => 'Tom'],
+ 'CreateAt' => ['title' => '', 'description' => 'The creation time of the comment message. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1628438400000'],
+ 'Content' => ['title' => '', 'description' => 'The content of the comment message.', 'type' => 'string', 'example' => 'Hello,World'],
+ 'Extension' => [
+ 'title' => '',
+ 'description' => 'The extension field.',
'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',
+ 'additionalProperties' => ['description' => '扩展字段。', 'type' => 'string', 'example' => 'value', 'title' => ''],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
+ 'HasMore' => ['title' => '', 'description' => 'Indicates whether more data is available on the next page. A value of true indicates that more data is available. A value of false indicates that no more data is available.', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of comment messages returned by the batch query.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageTotal' => ['title' => '', 'description' => 'The total number of pages for the paged query of comment messages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
+ 'example' => '0io**Fs6Q384',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRoomId.Room.NotExist',
- 'errorMessage' => 'Room does not exist.',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'List comment messages',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-12T15:45:33.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-10-25T08:50:18.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListComments'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:ListComments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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":"<GetRoomResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <RoomInfo>\\n <RoomId>AE35-****-T95F</RoomId>\\n <Title>RoomTitle001</Title>\\n <CreateTime>1624589848000</CreateTime>\\n <Notice>RoomNotice001</Notice>\\n <RoomOwnerId>as****hs</RoomOwnerId>\\n <Uv>100</Uv>\\n <OnlineCount>50</OnlineCount>\\n <PluginInstanceInfoList>\\n <PluginType>live</PluginType>\\n <PluginId>HASU-****-ASHD</PluginId>\\n <CreateTime>1624589848000</CreateTime>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n </PluginInstanceInfoList>\\n <AppId>lq****cu</AppId>\\n <TemplateId>default</TemplateId>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n <Pv>200</Pv>\\n <AdminIdList>as****hs</AdminIdList>\\n </RoomInfo>\\n </Result>\\n</GetRoomResponse>","errorExample":""}]',
],
- 'ListRooms' => [
- 'summary' => '查询租户下的房间列表',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListConferenceUsers' => [
+ 'summary' => 'Calls ListConferenceUsers to query co-streaming user information by paging.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'AppId',
+ 'name' => 'ConferenceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the co-streaming session. The value consists of letters, digits, and hyphens (-), and is 36 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'fb0f-****-4cb1'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'title' => '查询页码，从1开始，传空默认查询第1页。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The page number, starting from page 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, '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',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => 'API请求的返回结果结构体。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The result of the paged query for co-streaming user information.',
'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' => '',
+ 'ConferenceUserList' => [
+ 'title' => '',
+ 'description' => 'The list of co-streaming users.',
'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',
- ],
- ],
+ 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '4*****9'],
+ 'Status' => ['title' => '', 'description' => 'The user status. Valid values:'."\n"
+ ."\n"
+ .'- **Init**: init.'."\n"
+ ."\n"
+ .'- **OnJoining**: calling.'."\n"
+ ."\n"
+ .'- **Active**: co-streaming in progress.'."\n"
+ ."\n"
+ .'- **JoinFail**: co-streaming failed.'."\n"
+ ."\n"
+ .'- **Kicked**: kicked out.'."\n"
+ ."\n"
+ .'- **Leave**: left the co-streaming session.', 'type' => 'string', 'example' => 'active'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => 'myApp',
],
+ 'HasMore' => ['title' => '', 'description' => 'Indicates whether more data is available.', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageTotal' => ['title' => '', 'description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
+ 'example' => 'true',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Forbidden.Room.InvalidPageNumber',
- 'errorMessage' => 'PageNumber is invalid.',
- ],
- [
- 'errorCode' => 'Forbidden.Room.InvalidPageSize',
- 'errorMessage' => 'PageSize exceeds maximum limit.',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query co-streaming user list',
+ 'changeSet' => [
+ ['createdAt' => '2021-08-10T08:32:44.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConferenceUsers'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:ListConferenceUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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":"<ListRoomsResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <TotalCount>1000</TotalCount>\\n <PageTotal>100</PageTotal>\\n <HasMore>true</HasMore>\\n <RoomInfoList>\\n <RoomId>AE35-****-T95F</RoomId>\\n <Title>RoomTitle001</Title>\\n <RoomOwnerId>as****hs</RoomOwnerId>\\n <Notice>RoomNotice001</Notice>\\n <Uv>100</Uv>\\n <OnlineCount>50</OnlineCount>\\n <PluginInstanceInfoList>\\n <PluginType>live</PluginType>\\n <PluginId>H63U-****-AS7D</PluginId>\\n <CreateTime>1624589848000</CreateTime>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n </PluginInstanceInfoList>\\n <CreateTime>1624589848000</CreateTime>\\n <AppId>7m***q</AppId>\\n <TemplateId>default</TemplateId>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n </RoomInfoList>\\n </Result>\\n</ListRoomsResponse>","errorExample":""}]',
],
- 'ListRoomUsers' => [
- 'summary' => '查询房间用户列表',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListLiveFiles' => [
+ 'summary' => 'Queries the list of live stream recording files by calling ListLiveFiles.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4406,309 +3467,323 @@
[
'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',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'lq**xy'],
],
[
- 'name' => 'RoomId',
+ 'name' => 'LiveId',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间ID，最大长度36个字符。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35-****-T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The live stream ID.', 'type' => 'string', 'required' => true, 'example' => 'acbder-**-34uh'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => 'API请求的返回结果结构体。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The returned result.',
'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' => '',
+ 'FileList' => [
+ 'title' => '',
+ 'description' => 'The file list.',
'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' => '',
- ],
- ],
+ 'FileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'example' => '12345/**/1.ts'],
+ 'Url' => ['title' => '', 'description' => 'The file download URL. The URL is valid for 7 days.', 'type' => 'string', 'example' => 'https://aliyundoc.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3/1.ts'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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":"<ListRoomUsersResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <TotalCount>1000</TotalCount>\\n <PageTotal>100</PageTotal>\\n <HasMore>true</HasMore>\\n <RoomUserList>\\n <UserId>as****hs</UserId>\\n <Nick>User001</Nick>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n </RoomUserList>\\n </Result>\\n</ListRoomUsersResponse>","errorExample":""}]',
- ],
- 'CreateSensitiveWord' => [
- 'summary' => '创建敏感词',
- 'methods' => [
- 'post',
+ '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"}]',
+ 'title' => 'Query live stream recording file list',
+ 'description' => 'This operation is applicable to customers who activated the China Short Video China Short Video SDK (China Short Video China Short Video SDK) after February 18, 2022, and is applicable to scenarios in which the live stream recording feature is enabled and recording files are generated.',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-09T15:17:43.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveFiles'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:ListLiveFiles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListLiveRooms' => [
+ 'summary' => 'Invokes ListLiveRooms to query live room information by using paging.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户的应用ID，在控制台创建应用时生成。包含小写字母、数字，长度为6个字符。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, generated when the application is created in the console. The ID contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'WordList',
+ 'name' => 'Status',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
- 'required' => true,
- 'docRequired' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['title' => '', 'description' => 'The live streaming status. Valid values:'."\n"
+ .'* **0**: created but not started.'."\n"
+ .'* **1**: streaming.'."\n"
+ .'* **2**: ended.'."\n"
+ .'* **3 or empty**: all statuses.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The page number to query, starting from 1. If left empty, page 1 is queried by default.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page. Maximum value: 50. If left empty, the default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '调用发送直播间弹幕的返回结果。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The result returned by the paging query of live room information.',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of live streams.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageTotal' => ['title' => '', 'description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'HasMore' => ['title' => '', 'description' => 'Indicates whether more pages are available.', 'type' => 'boolean', 'example' => 'true'],
+ 'LiveList' => [
+ 'title' => '',
+ 'description' => 'The list of live stream information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AppId' => ['title' => '', 'description' => 'The application ID of the user, generated when the application is created in the console. The ID contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'example' => '7m***q'],
+ 'LiveId' => ['title' => '', 'description' => 'The unique ID of the live stream.', 'type' => 'string', 'example' => 'b7f2****ebb3'],
+ 'Status' => ['title' => '', 'description' => 'The live streaming status. Valid values:'."\n"
+ .'* **0**: created but not started.'."\n"
+ .'* **1**: streaming.'."\n"
+ .'* **2**: ended.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RoomId' => ['title' => '', 'description' => 'The unique identifier of the room.', 'type' => 'string', 'example' => 'AE35-****-T95F'],
+ 'ChatId' => ['title' => '', 'description' => 'The unique identifier of the chat (live comments).', 'type' => 'string', 'example' => '09***f8'],
+ 'Title' => ['title' => '', 'description' => 'The title of the live stream.', 'type' => 'string', 'example' => 'Title001'],
+ 'Notice' => ['title' => '', 'description' => 'The announcement of the live stream.', 'type' => 'string', 'example' => 'Notice001'],
+ 'CoverUrl' => ['title' => '', 'description' => 'The cover image URL of the live stream.', 'type' => 'string', 'example' => 'http://***.png'],
+ 'AnchorId' => ['title' => '', 'description' => 'The ID of the anchor.', 'type' => 'string', 'example' => 'as****hs'],
+ 'Uv' => ['title' => '', 'description' => 'The number of unique visitors. Multiple visits by the same visitor to the live room are counted as one UV.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'Extension' => [
+ 'title' => '',
+ 'description' => 'The extension field of the live stream.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '直播拓展信息。', 'type' => 'string', 'example' => 'test001', 'title' => ''],
+ 'example' => '',
+ ],
+ 'AnchorNick' => ['title' => '', 'description' => 'The nickname of the anchor.', 'type' => 'string', 'example' => 'User001'],
+ 'Pv' => ['title' => '', 'description' => 'The number of page views. Multiple visits by the same visitor to the live room are accumulated in the PV count.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'OnlineCount' => ['title' => '', 'description' => 'The number of online users.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'CreateTime' => ['title' => '', 'description' => 'The creation time of the live stream. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000'],
+ 'StartTime' => ['title' => '', 'description' => 'The start time of the live stream. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259600000'],
+ 'EndTime' => ['title' => '', 'description' => 'The end time of the live stream. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259800000'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
- 'example' => '0io**Fs6Q384',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query live room information in batches',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-28T06:43:00.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-09-26T03:45:26.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveRooms'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'imp:ListLiveRooms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateSensitiveWordResponse>\\n <RequestId>ER52****O9CA</RequestId>\\n <Result>\\n <Success>true</Success>\\n </Result>\\n</CreateSensitiveWordResponse>","errorExample":""}]',
],
- 'DeleteSensitiveWord' => [
- 'summary' => '删除敏感词',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListLiveRoomsById' => [
+ 'summary' => 'Queries the information about specified live rooms in batch by live room ID by calling ListLiveRoomsById.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '弹幕发送者的用户ID，最大长度不超过32个字节。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'WordList',
+ 'name' => 'LiveIdList',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The list of live room IDs.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'required' => false,
+ 'items' => ['description' => 'The live room ID. A maximum of 20 IDs can be specified.', 'type' => 'string', 'required' => false, 'example' => '["b7f2****ebb3"]', 'title' => ''],
+ 'required' => true,
+ 'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '调用发送直播间弹幕的返回结果。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The result returned for the batch query of live room information.',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'LiveList' => [
+ 'title' => '',
+ 'description' => 'The list of live room information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AppId' => ['title' => '', 'description' => 'The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'example' => '7m***q'],
+ 'LiveId' => ['title' => '', 'description' => 'The live room ID.', 'type' => 'string', 'example' => 'b7f2****ebb3'],
+ 'Status' => ['title' => '', 'description' => 'The status of the live room. Valid values:'."\n"
+ .'* **0**: created but not started.'."\n"
+ .'* **1**: streaming.'."\n"
+ .'* **2**: ended.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RoomId' => ['title' => '', 'description' => 'The room ID.', 'type' => 'string', 'example' => 'AE35-****-T95F'],
+ 'ChatId' => ['title' => '', 'description' => 'The chat ID for live comments.', 'type' => 'string', 'example' => '09***f8'],
+ 'Title' => ['title' => '', 'description' => 'The title of the live room.', 'type' => 'string', 'example' => 'Title001'],
+ 'Notice' => ['title' => '', 'description' => 'The announcement of the live room.', 'type' => 'string', 'example' => 'Notice001'],
+ 'CoverUrl' => ['title' => '', 'description' => 'The cover image URL of the live room.', 'type' => 'string', 'example' => 'http://***.png'],
+ 'AnchorId' => ['title' => '', 'description' => 'The ID of the anchor.', 'type' => 'string', 'example' => 'as****hs'],
+ 'Uv' => ['title' => '', 'description' => 'The number of unique visitors. Multiple visits by the same visitor to the live room are counted as one UV.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'Extension' => [
+ 'title' => '',
+ 'description' => 'The extension field of the live room.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '直播拓展信息。', 'type' => 'string', 'example' => 'test001', 'title' => ''],
+ 'example' => '',
+ ],
+ 'AnchorNick' => ['title' => '', 'description' => 'The nickname of the anchor.', 'type' => 'string', 'example' => 'User001'],
+ 'Pv' => ['title' => '', 'description' => 'The number of page views. Multiple visits by the same visitor to the live room are accumulated in the PV count.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'OnlineCount' => ['title' => '', 'description' => 'The number of online users.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'CreateTime' => ['title' => '', 'description' => 'The time when the live room was created. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000'],
+ 'StartTime' => ['title' => '', 'description' => 'The time when the live stream started. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000'],
+ 'EndTime' => ['title' => '', 'description' => 'The time when the live stream ended. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624259500000'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
- 'example' => '0io**Fs6Q384',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteSensitiveWordResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <Success>true</Success>\\n </Result>\\n</DeleteSensitiveWordResponse>","errorExample":""}]',
- ],
- 'ListSensitiveWord' => [
- 'summary' => '获取敏感词列表',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query live room information by live room ID in batch',
+ 'description' => '> You can query up to 20 live room records by calling this operation.',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-14T09:55:28.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveRoomsById'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'imp:ListLiveRoomsById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListRoomUsers' => [
+ 'summary' => 'Invokes ListRoomUsers to query the real-time user list in a room by paging.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4720,186 +3795,237 @@
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '弹幕发送者的用户ID，最大长度不超过32个字节。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, generated when the application is created in the console. The ID contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'PageNum',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The page number to query, starting from 1. If this parameter is left empty, the first page is queried by default.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '100',
- 'default' => '100',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page. Maximum value: 100. If this parameter is left empty, the default value is 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'exclusiveMaximum' => false, 'minimum' => '1', 'example' => '10'],
+ ],
+ [
+ 'name' => 'RoomId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The room ID, consisting of letters, digits, underscores (_), and periods (.). Maximum length: 36 characters.', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '调用发送直播间弹幕的返回结果。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The result returned by the paged query of the room user list.',
'type' => 'object',
'properties' => [
- 'WordList' => [
- 'description' => '',
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of users in the room.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
+ 'PageTotal' => ['title' => '', 'description' => 'The total number of pages of users in the room.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'HasMore' => ['title' => '', 'description' => 'Indicates whether there are more pages of users.', 'type' => 'boolean', 'example' => 'true'],
+ 'RoomUserList' => [
+ 'title' => '',
+ 'description' => 'The room user list information.',
'type' => 'array',
'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => ['title' => '', 'description' => 'The unique identifier of the user.', 'type' => 'string', 'example' => 'as****hs'],
+ 'Nick' => ['title' => '', 'description' => 'The nickname of the user.', 'type' => 'string', 'example' => 'User001'],
+ 'Extension' => [
+ 'title' => '',
+ 'description' => 'The user extension field.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '用户扩展信息。', 'type' => 'string', 'example' => 'test001', 'title' => ''],
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
+ 'example' => '',
],
],
- 'example' => '0io**Fs6Q384',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidAppId.Error',
- 'errorMessage' => 'The specified AppId is invalid.',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query room user list',
+ 'changeSet' => [
+ ['createdAt' => '2021-12-01T08:59:45.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoomUsers'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:ListRoomUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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":"<ListSensitiveWordResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <WordList>测试敏感词</WordList>\\n <TotalCount>100</TotalCount>\\n </Result>\\n</ListSensitiveWordResponse>","errorExample":""}]',
],
- 'CancelBanAllComment' => [
- 'summary' => '取消禁言房间内所有用户',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListRooms' => [
+ 'summary' => 'Queries the list of rooms under an application, including the information about each room and the atomic capabilities in use.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'RoomId',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间唯一标识，由调用CreateRoom返回。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35****T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The page number to query, starting from 1. If this parameter is left empty, the first page is queried by default.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'UserId',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户在房间内的唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page. Maximum value: 50. If this parameter is left empty, the default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'exclusiveMaximum' => false, 'minimum' => '1', 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '操作成功标识',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'description' => 'The result of the room list query.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of rooms.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
+ 'PageTotal' => ['title' => '', 'description' => 'The total number of pages in the room list.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'HasMore' => ['title' => '', 'description' => 'Indicates whether there is a next page.', 'type' => 'boolean', 'example' => 'true'],
+ 'RoomInfoList' => [
+ 'title' => '',
+ 'description' => 'The list of rooms.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The room object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoomId' => ['title' => '', 'description' => 'The room ID, which consists of letters, digits, periods (.), and hyphens (-) and is up to 36 characters in length.', 'type' => 'string', 'example' => 'AE35-****-T95F'],
+ 'Title' => ['title' => '', 'description' => 'The title of the room.', 'type' => 'string', 'example' => 'RoomTitle001'],
+ 'RoomOwnerId' => ['title' => '', 'description' => 'The ID of the room owner.', 'type' => 'string', 'example' => 'as****hs'],
+ 'Notice' => ['title' => '', 'description' => 'The room notice.', 'type' => 'string', 'example' => 'RoomNotice001'],
+ 'Uv' => ['title' => '', 'description' => 'The number of unique visitors.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'OnlineCount' => ['title' => '', 'description' => 'The number of online users.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'PluginInstanceInfoList' => [
+ 'title' => '',
+ 'description' => 'The list of active plug-ins.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The active plug-in object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PluginType' => ['title' => '', 'description' => 'The plug-in type. Valid values:'."\n"
+ .'- **live**: live streaming.'."\n"
+ .'- **chat**: chat.'."\n"
+ .'- **rtc**: real-time communication.'."\n"
+ .'- **wb**: whiteboard.', 'type' => 'string', 'example' => 'live'],
+ 'PluginId' => ['title' => '', 'description' => 'The plug-in instance ID.', 'type' => 'string', 'example' => 'H63U-****-AS7D'],
+ 'CreateTime' => ['title' => '', 'description' => 'The timestamp when the plug-in instance was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624589848000'],
+ 'Extension' => [
+ 'title' => '',
+ 'description' => 'The extension field of the plug-in.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '拓展字段值。', 'type' => 'string', 'example' => 'test001', 'title' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'CreateTime' => ['title' => '', 'description' => 'The timestamp when the room was created.', 'type' => 'string', 'example' => '1624589848000'],
+ 'AppId' => ['title' => '', 'description' => 'The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'example' => '7m***q'],
+ 'TemplateId' => ['title' => '', 'description' => 'The ID of the template used to create the room.', 'type' => 'string', 'example' => 'default'],
+ 'Extension' => [
+ 'title' => '',
+ 'description' => 'The extension field of the room.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '拓展字段值。', 'type' => 'string', 'example' => 'test001', 'title' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Forbidden.Chat.NoPermissionToOperate',
- 'errorMessage' => 'The user has no permission to operate.',
- ],
+ ['errorCode' => 'Forbidden.Room.InvalidPageNumber', 'errorMessage' => 'PageNumber is invalid.', 'description' => ''],
+ ['errorCode' => 'Forbidden.Room.InvalidPageSize', 'errorMessage' => 'PageSize exceeds maximum limit.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<CancelBanAllCommentResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>true</Result>\\n</CancelBanAllCommentResponse>","errorExample":""}]',
- ],
- 'CancelBanComment' => [
- 'summary' => '取消禁言房间内用户',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query room list',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRooms'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:ListRooms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListSensitiveWord' => [
+ 'summary' => 'Queries sensitive words by calling ListSensitiveWord.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4911,467 +4037,313 @@
[
'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',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, which is generated when you create an application in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'UserId',
+ 'name' => 'PageNum',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户在房间内的唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['description' => 'The current page number for the paged query. The value starts from 1 and increments by 1 for each subsequent page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'BanCommentUser',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '取消禁言的用户唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'er****h',
- ],
+ 'schema' => ['description' => 'The size of each paging query. Default value: 100. If the value exceeds 100, it is set to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '100', 'example' => '100', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '操作成功标识',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'description' => 'The result returned by the sensitive word query.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WordList' => [
+ 'description' => 'The list of sensitive words.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A sample sensitive word.', 'type' => 'string', 'example' => '测试敏感词', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TotalCount' => ['description' => 'The total number of sensitive words that have been added.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ ],
+ 'example' => '0io**Fs6Q384',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Forbidden.Chat.NoPermissionToOperate',
- 'errorMessage' => 'The user has no permission to operate.',
- ],
+ ['errorCode' => 'InvalidAppId.Error', 'errorMessage' => 'The specified AppId is invalid.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<CancelBanCommentResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>true</Result>\\n</CancelBanCommentResponse>","errorExample":""}]',
- ],
- 'BanAllComment' => [
- 'summary' => '禁言房间内所有用户',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"WordList\\": [\\n \\"测试敏感词\\"\\n ],\\n \\"TotalCount\\": 100\\n }\\n}","type":"json"}]',
+ 'title' => 'Query sensitive words',
+ 'description' => '## QPS limit'."\n"
+ .'The queries per second (QPS) limit for this operation is 10 per user.',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-30T02:28:22.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-04-18T07:19:56.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSensitiveWord'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:ListSensitiveWord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'PublishLive' => [
+ 'summary' => 'Publishes a live stream, changes the live stream status to streaming, and retrieves the push and pull stream URLs.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'AppId',
+ 'name' => 'LiveId',
'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',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the live stream resource.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3'],
],
[
'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户在房间内的唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID, which must be unique within the AppId. The ID can contain lowercase letters, digits, underscores (_), and periods (.). The maximum length is 32 characters.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '操作成功标识',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => 'The result of publishing the live stream.',
+ 'type' => 'object',
+ 'properties' => [
+ 'LiveId' => ['title' => '', 'description' => 'The unique ID of the live stream resource.', 'type' => 'string', 'example' => 'b7f2****ebb3'],
+ 'AnchorId' => ['title' => '', 'description' => 'The anchor ID.', 'type' => 'string', 'example' => 'as****hs'],
+ 'Status' => ['title' => '', 'description' => 'The live stream status. The value is a string. Valid values:'."\n"
+ .'* **1**: streaming.', 'type' => 'string', 'example' => '1'],
+ 'PushUrl' => ['title' => '', 'description' => 'The push stream URL of the live stream.', 'type' => 'string', 'example' => 'rtmp://demo-app-push.com/live/b7f2****ebb3?auth_key=e620****a8e3'],
+ 'LiveUrl' => ['title' => '', 'description' => 'The pull stream URL of the live stream.', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f2****ebb3.flv?auth_key=e620****a8e3'],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Forbidden.Chat.NoPermissionToOperate',
- 'errorMessage' => 'The user has no permission to operate.',
- ],
+ ['errorCode' => 'InvalidLiveId.Live.NotFound', 'errorMessage' => 'The live broadcast does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<BanAllCommentResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>true</Result>\\n</BanAllCommentResponse>","errorExample":""}]',
- ],
- 'BanComment' => [
- 'summary' => '禁言用户',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Publish a live stream',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishLive'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:PublishLive',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'PublishLiveRoom' => [
+ 'summary' => 'Calls the PublishLiveRoom operation to publish a live room, change the live room status to streaming, and obtain the push and pull stream URLs.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the application. The ID is generated when you create the application in the console. It contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'RoomId',
+ 'name' => 'LiveId',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间唯一标识，由调用CreateRoom返回。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35****T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the live room.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3'],
],
[
'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',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the operator. Only letters and digits are supported. Maximum length: 36 characters.', 'type' => 'string', 'required' => false, 'example' => 'as****hs'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '操作是否成功',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'description' => 'The result returned for publishing the live room.',
+ 'type' => 'object',
+ 'properties' => [
+ 'LiveId' => ['title' => '', 'description' => 'The live room ID.', 'type' => 'string', 'example' => 'b7f2****ebb3'],
+ 'LiveUrl' => ['title' => '', 'description' => 'The live stream playback URL.', 'type' => 'string', 'example' => 'http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ 'PushUrl' => ['title' => '', 'description' => 'The live stream push URL.', 'type' => 'string', 'example' => 'rtmp://demo-app-push.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3'],
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Forbidden.Chat.NoPermissionToOperate',
- 'errorMessage' => 'The user has no permission to operate.',
- ],
+ ['errorCode' => 'Invalid.Live.StatusNotMatch', 'errorMessage' => 'The live status not match.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<BanCommentResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>true</Result>\\n</BanCommentResponse>","errorExample":""}]',
- ],
- 'SendCustomMessageToAll' => [
- 'summary' => '对房间中全部成员发送普通自定义消息',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'PublishLiveRoom',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-30T06:05:13.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishLiveRoom'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:PublishLiveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RemoveMember' => [
+ 'summary' => 'Removes a specified user from a conference call by calling RemoveMember.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'AppId',
+ 'name' => 'ConferenceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，由6位小写字母、数字组成。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the conference call. The value consists of letters, digits, and hyphens (-), and is 36 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'fb0f-****-4cb1'],
],
[
- 'name' => 'RoomId',
+ 'name' => 'ToUserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间唯一标识，由调用CreateRoom返回。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35-****-T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the user to be removed. The ID must be unique within the AppId. The value consists of letters, digits, underscores (_), hyphens (-), periods (.), and at signs (@). The value must be 1 to 36 characters in length.', 'type' => 'string', 'required' => true, 'example' => '45***9'],
],
[
- 'name' => 'Body',
+ 'name' => 'FromUserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '消息体内容。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Hello, World',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the user who initiates the removal. The ID must be unique within the AppId. The value consists of letters, digits, underscores (_), hyphens (-), periods (.), and at signs (@). The value must be 1 to 36 characters in length.', 'type' => 'string', 'required' => true, 'example' => '23***7'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"MessageId\\": \\"0io**Fs6Q384\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SendCustomMessageToAllResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <MessageId>0io**Fs6Q384</MessageId>\\n </Result>\\n</SendCustomMessageToAllResponse>","errorExample":""}]',
- ],
- 'SendCustomMessageToUsers' => [
- 'summary' => '对房间中指定成员发送普通自定义消息',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'Forbidden.Rtc.UserNoPermission', 'errorMessage' => 'The user is not authorized to operate on the specified resource.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Remove a member',
+ 'changeSet' => [
+ ['createdAt' => '2021-08-10T08:32:44.000Z', 'description' => 'OpenAPI offline'],
],
- 'security' => [
- [
- 'AK' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveMember'],
],
],
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
+ 'ramActions' => [
[
- '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"]',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'imp:RemoveMember',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- '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":"<SendCustomMessageToUsersResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <MessageId>0io**Fs6Q384</MessageId>\\n </Result>\\n</SendCustomMessageToUsersResponse>","errorExample":""}]',
],
'SendComment' => [
- 'summary' => '发送直播间弹幕',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Sends a comment message by calling SendComment. The comment message is pushed to all online users in the room.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5383,137 +4355,71 @@
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，可以包含小写字母、数字，长度为6个字符。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the application, which is generated when you create the application in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
'name' => 'RoomId',
'in' => 'formData',
- 'schema' => [
- 'title' => '直播间唯一标识，在调用CreateRoom返回。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35****T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the room, which is returned when you call CreateRoom.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
],
[
'name' => 'SenderId',
'in' => 'formData',
- 'schema' => [
- 'title' => '弹幕发送者的用户ID，最大长度不超过32个字节。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '62**59',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID of the comment message sender. The maximum length is 32 bytes.', 'type' => 'string', 'required' => true, 'example' => '62**59'],
],
[
'name' => 'SenderNick',
'in' => 'formData',
- 'schema' => [
- 'title' => '弹幕消息发送者的昵称。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Tom',
- ],
+ 'schema' => ['title' => '', 'description' => 'The nickname of the comment message sender. The maximum length is 128 bytes. If this parameter is left empty, the nickname that the sender registered when entering the room is used. If the registered nickname is also empty, the nickname is displayed as empty.', 'type' => 'string', 'required' => false, 'example' => 'Tom'],
],
[
'name' => 'Content',
'in' => 'formData',
- 'schema' => [
- 'title' => '发送的文本内容。最大的长度不超过256个字节。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Hello, World',
- ],
+ 'schema' => ['title' => '', 'description' => 'The content of the comment message. The maximum length is 256 bytes.', 'type' => 'string', 'required' => true, 'example' => 'Hello, World'],
],
[
'name' => 'Extension',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '扩展字段，服务端仅做透传。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The extension field in key-value format. The server passes through the extension field information to the client.',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'value',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => 'value', 'description' => '', 'title' => ''],
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '调用发送直播间弹幕的返回结果。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The result of sending the comment message to the room.',
'type' => 'object',
'properties' => [
'CommentVO' => [
- 'title' => '返回的弹幕数据模型。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The data model of the returned comment message.',
'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',
- ],
+ 'CommentId' => ['title' => '', 'description' => 'The unique ID of the comment message.', 'type' => 'string', 'example' => '09***f8'],
+ 'SenderId' => ['title' => '', 'description' => 'The user ID of the comment message sender.', 'type' => 'string', 'example' => '62**59'],
+ 'SenderNick' => ['title' => '', 'description' => 'The nickname of the comment message sender.', 'type' => 'string', 'example' => 'Tom'],
+ 'CreateAt' => ['title' => '', 'description' => 'The creation time of the comment message. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1628438400000'],
+ 'Content' => ['title' => '', 'description' => 'The content of the comment message.', 'type' => 'string', 'example' => 'Hello,World'],
'Extension' => [
- 'title' => '扩展字段。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The extension field in key-value format. The value is the same as the Extension parameter passed in the request.',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'value',
- 'description' => '',
- ],
+ 'additionalProperties' => ['description' => '扩展字段key-value键值对中，value的示例值。', 'type' => 'string', 'example' => 'value', 'title' => ''],
+ 'example' => '',
],
],
'example' => '0io**Fs6Q384',
@@ -5522,32 +4428,45 @@
'example' => '0io**Fs6Q384',
],
],
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'Forbidden.Chat.HasBeenBanned', 'errorMessage' => 'The user is banned from posting a comment.', 'description' => ''],
+ ['errorCode' => 'Forbidden.Chat.SendCommentFrequencyLimited', 'errorMessage' => 'The frequency of SendComment for this user is limited.', 'description' => ''],
],
],
- '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":"<SendCommentResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <CommentVO>\\n <CommentId>09***f8</CommentId>\\n <SenderId>62**59</SenderId>\\n <SenderNick>Tom</SenderNick>\\n <CreateAt>1628438400000</CreateAt>\\n <Content>Hello,World</Content>\\n <Extension>\\n <key>value</key>\\n </Extension>\\n </CommentVO>\\n </Result>\\n</SendCommentResponse>","errorExample":""}]',
- ],
- 'DeleteComment' => [
- 'summary' => '删除直播间弹幕',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Send a comment message',
+ 'changeSet' => [
+ ['createdAt' => '2021-08-11T08:00:58.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-08-11T08:00:58.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendComment'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:SendComment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'SendCustomMessageToAll' => [
+ 'summary' => 'Calls SendCustomMessageToAll to send a custom message to all online members in a room.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5559,97 +4478,69 @@
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，可以包含小写字母、数字，长度为6个字符。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user\'s application ID, generated when creating an application in the console. Contains lowercase letters and digits, with a length of 6 characters.', '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',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the room, returned when calling CreateRoom.', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F'],
],
[
- 'name' => 'CommentIdList',
+ 'name' => 'Body',
'in' => 'formData',
- 'style' => 'flat',
- 'schema' => [
- 'title' => '需要删除的弹幕id列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '09***f8',
- ],
- 'required' => true,
- 'example' => 'Hello, World',
- ],
+ 'schema' => ['title' => '', 'description' => 'The content of the custom message body, with a maximum size of 2048 bytes.', 'type' => 'string', 'required' => true, 'example' => 'Hello, World'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '调用删除直播间弹幕的返回结果。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response result of calling the send custom message API.',
'type' => 'object',
'properties' => [
- 'DeleteResult' => [
- 'title' => '删除的结果',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'MessageId' => ['title' => '', 'description' => 'The unique ID of the custom message. Consists of digits and upper/lowercase letters, with a maximum length of 20 characters.', 'type' => 'string', 'example' => '0io**Fs6Q384'],
],
'example' => '0io**Fs6Q384',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"DeleteResult\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteCommentResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <DeleteResult>true</DeleteResult>\\n </Result>\\n</DeleteCommentResponse>","errorExample":""}]',
- ],
- 'ListComments' => [
- 'summary' => '查询弹幕消息列表',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"MessageId\\": \\"0io**Fs6Q384\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Send Custom Message',
+ 'changeSet' => [
+ ['createdAt' => '2021-08-04T08:35:38.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendCustomMessageToAll'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:SendCustomMessageToAll',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'SendCustomMessageToUsers' => [
+ 'summary' => 'Sends a custom message to specified members in a room by calling SendCustomMessageToUsers.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5661,1808 +4552,2192 @@
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户的应用ID，在控制台创建应用时生成。包含小写字母、数字，长度为6个字符。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the application. This ID is generated when you create the application in the console. The ID contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
'name' => 'RoomId',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间的唯一标识，在调用CreateRoom时返回。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35****T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the room, returned when you call CreateRoom.', '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',
+ 'name' => 'Body',
'in' => 'formData',
- 'schema' => [
- 'title' => '查询弹幕消息列表的分页大小。最小不得小于1，最大不得超过100。如果超过100，会被截断为前100条。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '50',
- ],
+ 'schema' => ['title' => '', 'description' => 'The content of the custom message body. The maximum size is 2048 bytes.', 'type' => 'string', 'required' => true, 'example' => 'Hello, World'],
],
[
- 'name' => 'SortType',
+ 'name' => 'ReceiverList',
'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'title' => '查询弹幕消息列表的排序方式。取值仅限0和1，其中0表示按照弹幕消息创建时间递增的顺序拉取，1表示按照弹幕消息创建时间递减的时间拉取。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'The list of recipient user IDs for the custom message. The maximum length is 100.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The list of recipient user IDs for the custom message. You can specify up to 100 user IDs.', 'type' => 'string', 'required' => true, 'example' => '["34**29"]', 'title' => ''],
'required' => true,
- 'example' => '0',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ER52****O9CA',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
'Result' => [
- 'title' => '调用查询弹幕消息列表的返回结果。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The result of sending a custom message to specified room members.',
'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',
- ],
+ 'MessageId' => ['title' => '', 'description' => 'The unique ID of the custom message. The ID contains digits, uppercase letters, and lowercase letters, with a maximum length of 20 characters.', 'type' => 'string', 'example' => '0io**Fs6Q384'],
],
- 'example' => '0io**Fs6Q384',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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":"<ListCommentsResponse>\\n <RequestId>ER52****O9CA</RequestId>\\n <Result>\\n <CommentVOList>\\n <AppId>7m***q</AppId>\\n <RoomId>AE35****T95F</RoomId>\\n <CommentId>09***f8</CommentId>\\n <SenderId>62**59</SenderId>\\n <SenderNick>Tom</SenderNick>\\n <CreateAt>1628438400000</CreateAt>\\n <Content>Hello,World</Content>\\n <Extension>\\n <key>value</key>\\n </Extension>\\n </CommentVOList>\\n <HasMore>true</HasMore>\\n <TotalCount>100</TotalCount>\\n <PageTotal>2</PageTotal>\\n </Result>\\n</ListCommentsResponse>","errorExample":""}]',
- ],
- 'DeleteCommentByCreatorId' => [
- 'summary' => '根据创建者删除直播间弹幕',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"MessageId\\": \\"0io**Fs6Q384\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Send custom message to specified room members',
+ 'changeSet' => [
+ ['createdAt' => '2021-08-04T08:35:38.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendCustomMessageToUsers'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:SendCustomMessageToUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'SetUserAdmin' => [
+ 'summary' => 'Sets a specific user as an administrator in a room by calling the SetUserAdmin operation.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，可以包含小写字母、数字，长度为6个字符。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application, which consists of 6 lowercase letters and digits.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
'name' => 'RoomId',
'in' => 'formData',
- 'schema' => [
- 'title' => '直播间唯一标识，在调用CreateRoom返回。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35****T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the room, which is returned when you call the CreateRoom operation.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
],
[
'name' => 'UserId',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ID of the user to be set as an administrator.', 'type' => 'string', 'required' => true, 'example' => 'er****h'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '删除的操作人ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '62**59',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Forbidden.Room.AdminNumberOverLimit', 'errorMessage' => 'Room admin number exceeds limit.', 'description' => ''],
+ ['errorCode' => 'Forbidden.Room.OwnerCannotBeAdmin', 'errorMessage' => 'Room owner cannot be admin.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Set user as administrator',
+ 'description' => 'The room owner cannot be operated on. A maximum of 5 administrators can be set per room. Administrators have permissions to kick users, mute or unmute users, and modify room information.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserAdmin'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'CreatorId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '弹幕的创建者ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**86',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:SetUserAdmin',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'StopClass' => [
+ 'summary' => 'Stops a class by calling StopClass, which changes the class status to ended.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'CommentIdList',
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'AppId',
'in' => 'formData',
- 'style' => 'flat',
- 'schema' => [
- 'title' => '需要删除的弹幕id列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '09***f8',
- ],
- 'required' => false,
- 'example' => 'Hello, World',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, generated when the application is created in the console. The ID contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
+ ],
+ [
+ 'name' => 'ClassId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the class.', 'type' => 'string', 'required' => true, 'example' => 'A55-****-Y34O'],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The user ID of the operator. Only letters and digits are supported. Maximum length: 36 characters.', 'type' => 'string', 'example' => 'as****hs', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ER52****O9CA\\",\\n \\"Result\\": {\\n \\"DeleteResult\\": true\\n }\\n}","type":"json"}]',
- ],
- 'DeleteConference' => [
- 'summary' => '删除会议记录',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Stop a class',
+ 'changeSet' => [
+ ['createdAt' => '2021-09-26T13:08:30.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopClass'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:StopClass',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'StopLive' => [
+ 'summary' => 'Stops a specified live stream and changes the live stream status to ended.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户名',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
'name' => 'RoomId',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间ID，最大长度36位',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35-****-T95F',
- ],
+ 'schema' => ['title' => '', 'description' => 'The room ID. The value can contain letters and digits and is up to 36 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F'],
],
[
'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '创建会议用户ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The user ID of the live stream creator. The value must be unique within the AppId. The value can contain lowercase letters, digits, underscores (_), and periods (.) and is up to 32 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'as****hs'],
],
[
- 'name' => 'ConferenceId',
+ 'name' => 'LiveId',
'in' => 'formData',
- 'schema' => [
- 'title' => '会议资源的唯一标识ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fb0f-****-4cb1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the live stream resource.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '16A96B9A-****-CB92E68F4CD8',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidConferenceId.Rtc.DataNotExist',
- 'errorMessage' => 'The specified parameter conferenceId does not exist in our records.',
- ],
+ ['errorCode' => 'InvalidLiveId.Live.NotFound', 'errorMessage' => 'The live broadcast does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteConferenceResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n</DeleteConferenceResponse>","errorExample":""}]',
- ],
- 'RemoveMember' => [
- 'summary' => '移除会议成员',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Stop a live stream',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopLive'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:StopLive',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'StopLiveRoom' => [
+ 'summary' => 'Stops a specified live room by calling StopLiveRoom. The live room status changes to ended.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ConferenceId',
+ 'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '会议唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fb0f-****-4cb1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'ToUserId',
+ 'name' => 'LiveId',
'in' => 'formData',
- 'schema' => [
- 'title' => '被邀请用户ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '45***9',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the live room.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3'],
],
[
- 'name' => 'FromUserId',
+ 'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '邀请者用户ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '23***7',
- ],
+ 'schema' => ['title' => '', 'description' => 'The operator ID. The value can contain only letters and digits and is up to 36 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'as****hs'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'Forbidden.Rtc.UserNoPermission',
- 'errorMessage' => 'The user is not authorized to operate on the specified resource.',
- ],
+ ['errorCode' => 'Forbidden.Live.PermissionDenied', 'errorMessage' => 'The permission is denied.', 'description' => 'Operation denied. Try again later.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveMemberResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n</RemoveMemberResponse>","errorExample":""}]',
- ],
- 'GetConference' => [
- 'summary' => '获取会议信息',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Stop a live room',
+ 'changeSet' => [
+ ['createdAt' => '2021-09-26T03:45:26.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-09-26T03:45:26.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopLiveRoom'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:StopLiveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateClass' => [
+ 'summary' => 'Updates a class by calling UpdateClass.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ConferenceId',
+ 'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '会议资源唯一标识。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fb0f-****-4cb1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
+ ],
+ [
+ 'name' => 'ClassId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the class.', 'type' => 'string', 'required' => true, 'example' => 'A55-****-Y34O'],
+ ],
+ [
+ 'name' => 'Title',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The class title. The value can contain letters and Chinese characters and is up to 32 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'ClassTitle001'],
+ ],
+ [
+ 'name' => 'CreateUserId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The user ID of the creator. The value can contain letters and digits and is up to 36 characters in length.', 'type' => 'string', 'example' => 'as****hs', 'required' => false],
+ ],
+ [
+ 'name' => 'CreateNickname',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The nickname of the creator. The value can contain letters and Chinese characters and is up to 32 characters in length.', 'type' => 'string', 'example' => 'nickname001', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
],
+ 'example' => '',
],
],
],
- '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":"<GetConferenceResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <ConferenceId>fb0f-****-4cb1</ConferenceId>\\n <Title>This is a Title</Title>\\n <Status>Init</Status>\\n <RoomId>AE35-****-T95F</RoomId>\\n <UserId>as****hs</UserId>\\n <AppId>7m***q</AppId>\\n <CreateTime>1624589848000</CreateTime>\\n <PlaybackUrl>http://xxxx.com/b7f29c02-****-40fd-****-e8d06a8aebb3_merged.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</PlaybackUrl>\\n </Result>\\n</GetConferenceResponse>","errorExample":""}]',
- ],
- 'ListConferenceUsers' => [
- 'summary' => '分页查询会议成员列表',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Update a class',
+ 'changeSet' => [
+ ['createdAt' => '2021-09-28T06:01:25.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateClass'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:UpdateClass',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'UpdateLive' => [
+ 'summary' => 'Updates the information of a specified live broadcast.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ConferenceId',
+ 'name' => 'LiveId',
'in' => 'formData',
- 'schema' => [
- 'title' => '会议唯一标识符',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fb0f-****-4cb1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the live broadcast resource.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'Title',
'in' => 'formData',
- 'schema' => [
- 'title' => '查询页码，从第1页开始。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The live broadcast title, which supports both Chinese and English characters with a maximum length of 256 characters.', 'type' => 'string', 'required' => false, 'example' => 'This is a title.'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Introduction',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页显示个数，最大显示个数为100。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '', 'description' => 'The live broadcast introduction, which supports both Chinese and English characters with a maximum length of 2048 characters.', 'type' => 'string', 'required' => false, 'example' => 'This is an introduction.'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
],
+ 'example' => '',
],
],
],
- '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":"<ListConferenceUsersResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <ConferenceUserList>\\n <UserId>4*****9</UserId>\\n <Status>active</Status>\\n </ConferenceUserList>\\n <HasMore>true</HasMore>\\n <TotalCount>100</TotalCount>\\n <PageTotal>100</PageTotal>\\n </Result>\\n</ListConferenceUsersResponse>","errorExample":""}]',
- ],
- 'GetStandardRoomJumpUrl' => [
- 'summary' => '获取样板间服务跳转链接',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidLiveId.Live.NotFound', 'errorMessage' => 'The live broadcast does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Update live broadcast information',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLive'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:UpdateLive',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'UpdateLiveRoom' => [
+ 'summary' => 'Updates the information of a specified live room by calling UpdateLiveRoom.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户的应用ID，在控制台创建应用时生成',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'schema' => ['title' => '', 'description' => 'The application ID of the user, generated when the application is created in the console. The ID contains lowercase letters and digits and is 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'UserId',
+ 'name' => 'Title',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户UserId,在AppId下单独唯一',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'as****hs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The live room title. Supports Chinese and English characters with a maximum length of 32 characters.', 'type' => 'string', 'required' => false, 'example' => 'Title001'],
],
[
- 'name' => 'AppKey',
+ 'name' => 'Notice',
'in' => 'formData',
- 'schema' => [
- 'title' => '终端设备类型,通过控制台创建和查询',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '06***9c',
- ],
+ 'schema' => ['title' => '', 'description' => 'The live room announcement. Supports Chinese and English characters with a maximum length of 256 characters.', 'type' => 'string', 'required' => false, 'example' => 'Notice001'],
],
[
- 'name' => 'Platform',
+ 'name' => 'CoverUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '平台：win, mac, android, ios, web',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'web',
- ],
+ 'schema' => ['title' => '', 'description' => 'The cover image of the live room. Specify the value as an image URL with a maximum length of 256 characters.', 'type' => 'string', 'required' => false, 'example' => 'http://***.png'],
],
[
- 'name' => 'BizType',
+ 'name' => 'Extension',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '业务类型：互动直播live，互动课堂class',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'live',
+ 'title' => '',
+ 'description' => 'The extension field. Pass as needed to record additional room properties.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'required' => false, 'example' => 'test001', 'description' => '', 'title' => ''],
+ 'example' => 'AE35****T95F',
],
],
[
- 'name' => 'BizId',
+ 'name' => 'AnchorId',
'in' => 'formData',
- 'schema' => [
- 'title' => '资源ID：根据业务类型来定，比如直播ID，课堂ID等',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b7f2-****-ebb3',
- ],
+ 'schema' => ['title' => '', 'description' => 'The anchor ID. Supports only letters and digits with a maximum length of 36 characters.', 'type' => 'string', 'required' => false, 'example' => 'as****hs'],
],
[
- 'name' => 'UserNick',
+ 'name' => 'AnchorNick',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户昵称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'James',
- ],
+ 'schema' => ['title' => '', 'description' => 'The anchor nickname. Supports Chinese and English characters with a maximum length of 32 characters.', 'type' => 'string', 'required' => false, 'example' => 'User001'],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The operator ID. Supports only letters and digits with a maximum length of 36 characters.', 'type' => 'string', 'required' => false, 'example' => 'user001'],
+ ],
+ [
+ 'name' => 'LiveId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The unique ID of the live room.', 'type' => 'string', 'required' => true, 'example' => 'b7f2****ebb3'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
],
+ 'example' => '',
],
],
],
- '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Update live room information',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLiveRoom'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:UpdateLiveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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":"<GetStandardRoomJumpUrlResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <StandardRoomJumpUrl>http://xxx.com/standard_live?appId=l***u&amp;userId=jm6&amp;userAuthSession=0c179505-6d14-**-88a888d849ec&amp;roomId=b807bd2a-**-96e1-c5753f13a5eb&amp;appKey=63***3d&amp;callback=https%3A%2F%2Fxxx.com%2Fapi%2Flogin%2FcheckUserAuthSession</StandardRoomJumpUrl>\\n </Result>\\n</GetStandardRoomJumpUrlResponse>","errorExample":""}]',
],
- 'DescribeMeterImpWatchLiveTimeByLiveId' => [
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateRoom' => [
+ 'summary' => 'Calls UpdateRoom to update all modifiable information of a room.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'AppId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application. The value can contain lowercase letters and digits, and must be 6 characters in length.', 'type' => 'string', 'required' => true, 'example' => '7m***q'],
],
[
- 'name' => 'LiveId',
- 'in' => 'query',
+ 'name' => 'RoomId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The room ID. The value can contain letters, digits, underscores (_), and periods (.). The maximum length is 36 characters.', 'type' => 'string', 'required' => true, 'example' => 'AE35-****-T95F'],
+ ],
+ [
+ 'name' => 'Title',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The room title. The value supports both Chinese and English characters, with a maximum length of 32 characters.', 'type' => 'string', 'required' => false, 'example' => 'RoomTitle001'],
+ ],
+ [
+ 'name' => 'Notice',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The room notice. The value supports both Chinese and English characters, with a maximum length of 256 characters.', 'type' => 'string', 'required' => false, 'example' => 'RoomNotice001'],
+ ],
+ [
+ 'name' => 'RoomOwnerId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ID of the room owner. The value can contain only letters and digits, with a maximum length of 36 characters.', 'type' => 'string', 'required' => false, 'example' => 'as****hs'],
+ ],
+ [
+ 'name' => 'Extension',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b7f2****ebb3',
+ 'title' => '',
+ 'description' => 'The extension field. Pass this parameter as needed to record additional room properties.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'required' => false, 'example' => 'test001', 'description' => '', 'title' => ''],
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Meter.ParamError',
- 'errorMessage' => 'Param Error:%s,Please Check Again.',
- ],
+ ['errorCode' => 'InvalidRoomId.Room.NotExist', 'errorMessage' => 'Room does not exist.', 'description' => ''],
+ ['errorCode' => 'Forbidden.Room.Deleted', 'errorMessage' => 'Room has been deleted.', 'description' => ''],
],
- 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.',
- ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Update room information',
+ 'changeSet' => [
+ ['createdAt' => '2021-07-08T11:46:27.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRoom'],
],
- 502 => [
- [
- 'errorCode' => 'Meter.ReadyTsError',
- 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.',
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:UpdateRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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',
- ],
+ 'UpdateShareScreenLayout' => [
+ 'summary' => 'Updates the shared screen layout by calling UpdateShareScreenLayout. This operation can be used in classroom scenarios to overlay the teacher\'s camera feed on the shared screen in a live stream.',
+ 'methods' => ['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',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the application, which consists of 6 lowercase letters and digits.', 'type' => 'string', 'required' => true, 'example' => 'lq****cu'],
],
[
- 'name' => 'LiveId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b7f2****ebb3',
- ],
+ 'name' => 'ClassId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The unique identifier of the classroom, returned by calling CreateClass.', 'type' => 'string', 'required' => true, 'example' => 'AE35****T95F'],
],
[
- 'name' => 'StartTs',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1632153600',
- ],
+ 'name' => 'EnableOverlay',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Specifies whether to enable the teacher\'s camera overlay.', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
],
[
- 'name' => 'EndTs',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1637302350',
- ],
+ 'name' => 'OverlayX',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The X coordinate of the overlay. The origin is the upper-left corner. The value is normalized to 1.', 'type' => 'number', 'format' => 'float', 'example' => '0.7576', 'required' => false],
+ ],
+ [
+ 'name' => 'OverlayY',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The Y coordinate of the overlay. The origin is the upper-left corner. The value is normalized to 1.', 'type' => 'number', 'format' => 'float', 'example' => '0.7576', 'required' => false],
+ ],
+ [
+ 'name' => 'OverlayWidth',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The width of the overlay, normalized to 1.', 'type' => 'number', 'format' => 'float', 'example' => '0.2361', 'required' => false],
+ ],
+ [
+ 'name' => 'OverlayHeight',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The height of the overlay, normalized to 1.', 'type' => 'number', 'format' => 'float', 'example' => '0.2361', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Meter.ParamError',
- 'errorMessage' => 'Param Error:%s,Please Check Again.',
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","type":"json"}]',
+ 'title' => 'Update shared screen layout',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateShareScreenLayout'],
],
- 403 => [
- [
- 'errorCode' => 'Meter.AuthError',
- 'errorMessage' => 'Authentication Failed,Please Try Again.',
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:UpdateShareScreenLayout',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 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.',
+ ],
+ ],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imp.aliyuncs.com', 'endpoint' => 'imp.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'BusinessExist', 'message' => 'Business exist, do not repeated submission.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EntityNotExist.Role', 'message' => 'The role for imp does not exist.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Forbidden.App.Delete', 'message' => 'App is running and cannot be deleted.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Forbidden.AppTemplate.Delete', 'message' => 'AppTemplate is attached and cannot be deleted.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Forbidden.Chat.HasBeenBanned', 'message' => 'The user is banned from posting a comment.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Chat.NoPermissionToOperate', 'message' => 'The user has no permission to operate.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Chat.SendCommentFrequencyLimited', 'message' => 'The frequency of SendComment for this user is limited.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Class.PermissionDenied', 'message' => 'The operation is denied. Please check it again.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.CreateApp.ExceedLimit', 'message' => 'The account has exceeded created app count.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Forbidden.Live.CdnDomainOwnerVerifyFailed', 'message' => 'Owner verification of the live playback CDN domain failed.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Forbidden.Live.DomainMapping', 'message' => 'Push and pull domain does not match.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Forbidden.Live.DomainNotRegistration', 'message' => 'The domain name is not registered.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Forbidden.Live.DomainOverLimit', 'message' => 'The maximum number of domains is exceeded.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Forbidden.Live.DomainOwnerVerifyFailed', 'message' => 'Owner verification of the root domain failed.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Forbidden.Live.IllegalOperation', 'message' => 'This operation is illegal, please ensure that the live domain belongs to you.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Forbidden.Live.PermissionDenied', 'message' => 'The permission is denied.', 'http_code' => 403, 'description' => 'Operation denied. Try again later.'],
+ ['code' => 'Forbidden.PermissionDenied', 'message' => 'User has no permission to operate.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Resource.ExceedLimit', 'message' => 'The resource has exceeded limit.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Room.%sNotOpen', 'message' => 'The %s service has not been activated. Please check again.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Room.%sNumberExceed', 'message' => 'The maximum number of active %s instance is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Room.AdminNumberOverLimit', 'message' => 'Room admin number exceeds limit.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Room.Deleted', 'message' => 'Room has been deleted.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Room.InvalidPageNumber', 'message' => 'PageNumber is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Room.InvalidPageSize', 'message' => 'PageSize exceeds maximum limit.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Room.LiveAlreadyExist', 'message' => 'The live instance already exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Room.OwnerCannotBeAdmin', 'message' => 'Room owner cannot be admin.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Rtc.ApplyOverLimit', 'message' => 'The maximum number of users requesting to enable mic is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Rtc.UserNoPermission', 'message' => 'The user is not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Forbidden.Scene.LiveStillStreaming', 'message' => 'Live is still streaming and cannot be deleted.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.SensitiveWordCount.ExceedLimit', 'message' => 'The total count of sensitive word exceeds the limit.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.Url', 'message' => 'The specified Url is invalid.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Illegal.CloudAccount', 'message' => 'The cloud account is not authorized to perform this operation.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Illegal.CreateSLRPermission', 'message' => 'The cloud account is not authorized to create SLR.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Illegal.RamPermission', 'message' => 'The cloud account is not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'IllegalState.Rtc.ConferenceClosed', 'message' => 'The conference has ended.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'IMPService.NotFound', 'message' => 'Your account has not opened IMP service yet.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'InternalError.StandardRoom.DeleteStandardRoomError', 'message' => 'Failed to delete the standard room.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'InternalError.StandardRoom.DeployStandardRoomError', 'message' => 'Failed to deploy the standard room.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'InternalError.StandardRoom.SetStandardRoomHttpsListenerError', 'message' => 'Failed to set httpsListener for the standard room.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'Invalid.Live.AuditCallbackUrl', 'message' => 'The live audit callback URL is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.AuditOssUrl', 'message' => 'The live audit OSS URL is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.BucketNotFound', 'message' => 'The bucket does not belong to you.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.CdnDomainName', 'message' => 'The live playback CDN domain name is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.ConfigNotFound', 'message' => 'The live push domain and pull domain config not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.DomainNotFound', 'message' => 'Push or pull domain name is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.PlaybackDomainBeenOccupied', 'message' => 'Playback domain has bean occupied by other app or user, please use other domain.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.PlaybackOssUrl', 'message' => 'The live playback OSS URL is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.PullDomainBeenOccupied', 'message' => 'Pull domain has bean occupied by other app or user, please use other domain.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.PullOrPushDomainBeenOccupied', 'message' => 'Pull domain or push domain has bean occupied by other app or user, please use other domains.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.PushDomainBeenOccupied', 'message' => 'Push domain has bean occupied by other app or user, please use other domain.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.RecordContentExceed', 'message' => 'The record content between StartTime and EndTime is exceeded, please narrow down the range.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.RecordContentTooShort', 'message' => 'The record time between StartTime and EndTime is too short, please enlarger the range.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.RecordEndTimeMismatch', 'message' => 'Specified end time does not math the specified start time.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.RecordInvalidBucket', 'message' => 'The oss bucket is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.RecordLiveNotFound', 'message' => 'The live is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.RecordLiveStreamNotFound', 'message' => 'The live stream info is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.RecordNoContent', 'message' => 'The record has no content, please check the live record toggle.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.RecordPlaybackDomainNotFound', 'message' => 'The record playback domain is not found, please open the liveRecordToggle in imp console and config playback domain.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.StatusNotMatch', 'message' => 'The live status not match.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.StreamsCallbackUrl', 'message' => 'The live streams callback URL is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Live.WrongRecordOssConfig', 'message' => 'Specified oss config is wrong.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Scene.ClassNotExist', 'message' => 'Class does not exist. Please check it again.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Scene.LiveNotExist', 'message' => 'The live record does not exist. Please check again.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.SSLPri', 'message' => 'The SSLPri you provided is malformed.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.SSLPub', 'message' => 'The SSLPub you provided is malformed.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAccountType.PartnerNotSupport', 'message' => 'The specified AccountType is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppId.Error', 'message' => 'The specified AppId is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppId.NotFound', 'message' => 'The specified AppId does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidAppId.Rtc.DataNotExist', 'message' => 'The specified parameter appId does not exist in our records.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppId.StandardRoom.CnameNotConfig', 'message' => 'The low-code integration service does not have a CNAME configured.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppId.StandardRoom.StandardRoomNotFound', 'message' => 'The specified parameter appId does not exist in our standard room records.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppTemplateId.App.NotFound', 'message' => 'The specified AppTemplateId does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidCallerType.NotSupport', 'message' => 'The specified CallerType is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidCommonParam.Error', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidConferenceId.Rtc.DataNotExist', 'message' => 'The specified parameter conferenceId does not exist in our records.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidDomain.StandardRoom.DomainNotMatch', 'message' => 'The specified parameter domain does not match the domain bound to the certificate.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidFormat.StandardRoom.CertificateNotFormatted', 'message' => 'The specified parameter ServerCertificate is incorrectly formatted.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidLiveId.Live.NotFound', 'message' => 'The live broadcast does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParam.%s', 'message' => 'The specified %s is invalid. Please check it again.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter.StandardRoom.AppKeyNotMatch', 'message' => 'The parameter AppId and the parameter AppKey do not match.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter.StandardRoom.BatchQueryAllNotFound', 'message' => 'Batch query found no standard room.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter.StandardRoom.DomainNameAlreadyConfig', 'message' => 'The domain name has already been configured.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter.StandardRoom.InvalidICPLicense', 'message' => 'Specified Domain has not got ICP license, or the ICP license does not belong to Aliyun.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter.StandardRoom.LowCodeDomainNotConfig', 'message' => 'This app is not configured with a low-code domain name.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidQuerySize.StandardRoom.BatchQuerySizeExceeded', 'message' => 'The batch query size is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRam.Param', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRoomId.Room.AlreadyExist', 'message' => 'Room is already exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRoomId.Room.NotExist', 'message' => 'Room does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStatus.StandardRoom.StatusNotMatch', 'message' => 'The standard room status is inconsistent with the expected status.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidTemplate.Rtc.DataNotExist', 'message' => 'The recording function is not enabled in the application.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Meter.AuthError', 'message' => 'Authentication Failed,Please Try Again.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Meter.DataSourceQueryError', 'message' => 'Data Source Error:%s,Please Try Again.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'Meter.ParamError', 'message' => 'Param Error:%s,Please Check Again.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Meter.ReadyTsError', 'message' => 'Get ReadyTs Failed,Please Try Again.', 'http_code' => 502, 'description' => ''],
+ ['code' => 'Meter.ServerInternalError', 'message' => 'The Request Processing Has Failed Due To Some Unknown Error.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'MissMatch.Certificate', 'message' => 'The certificate is not match the private key.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'SensitiveContent.%s', 'message' => 'The specified %s contains sensitive contents. Please check.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Unmatched.App.AppTemplateId', 'message' => 'The specified AppTemplateId does not match the template that is attached to the app.', 'http_code' => 400, 'description' => ''],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListLiveRooms'],
+ ],
+ 'createdAt' => '2022-10-17T02:12:12.000Z',
+ 'description' => '增加直播的时间信息。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'GetStandardRoomJumpUrl'],
+ ],
+ 'createdAt' => '2022-10-17T02:12:11.000Z',
+ 'description' => '新增AppId与AppKey不匹配和低代码域名服务未配置CNAME的错误码。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateLive'],
+ ],
+ 'createdAt' => '2022-08-10T03:10:40.000Z',
+ 'description' => '增加错误码。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'DeleteLiveFilesById'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListLiveFiles'],
+ ],
+ 'createdAt' => '2022-08-09T15:18:06.000Z',
+ 'description' => '新增直播录制文件获取和删除接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateLiveRecordSliceFile'],
+ ],
+ 'createdAt' => '2022-07-19T02:42:48.000Z',
+ 'description' => '优化描述',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateClass'],
+ ],
+ 'createdAt' => '2022-07-15T03:18:29.000Z',
+ 'description' => '增加错误码。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListLiveRoomsById'],
+ ],
+ 'createdAt' => '2022-07-14T09:55:42.000Z',
+ 'description' => '增加时间参数',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'DeleteCommentByCreatorId'],
+ ['description' => 'Request parameters changed', 'api' => 'ListComments'],
+ ],
+ 'createdAt' => '2022-07-12T15:45:58.000Z',
+ 'description' => '新增按照创建者查询和删除弹幕接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'CreateLiveRecordSliceFile'],
+ ],
+ 'createdAt' => '2022-07-05T08:40:06.000Z',
+ 'description' => '新增创建直播录制片段文件的接口。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateLiveRoom'],
+ ],
+ 'createdAt' => '2022-06-09T06:17:02.000Z',
+ 'description' => '增加一个错误码',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'CreateShelf'],
+ ],
+ 'createdAt' => '2022-05-31T06:09:49.000Z',
+ 'description' => '商品360°展示创建货架房间插件接口发布',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'PublishLiveRoom'],
+ ],
+ 'createdAt' => '2022-05-30T06:05:52.000Z',
+ 'description' => '增加状态不一致的错误码。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed, Request parameters changed, Response parameters changed', 'api' => 'ListSensitiveWord'],
+ ],
+ 'createdAt' => '2022-05-30T05:57:23.000Z',
+ 'description' => '支持ListSensitiveComment分页查询',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateLiveRoom'],
+ ['description' => 'Response parameters changed', 'api' => 'GetLiveRoom'],
+ ],
+ 'createdAt' => '2022-05-26T03:46:43.000Z',
+ 'description' => '增加直播连麦功能。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'DeleteProductModel'],
+ ],
+ 'createdAt' => '2022-05-25T11:26:25.000Z',
+ 'description' => '商品360°展示服务删除指定商品接口发布',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'BindProductShelf'],
+ ],
+ 'createdAt' => '2022-05-25T11:06:55.000Z',
+ 'description' => '商品360°展示服务上架指定商品接口发布',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'UnbindProductShelf'],
+ ],
+ 'createdAt' => '2022-05-25T11:05:37.000Z',
+ 'description' => '商品360°展示服务下架指定商品接口发布',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'ListProductShelf'],
+ ],
+ 'createdAt' => '2022-05-25T11:02:07.000Z',
+ 'description' => '商品360°展示服务查询货架信息列表接口上线',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'ListProductModel'],
+ ],
+ 'createdAt' => '2022-05-25T11:00:12.000Z',
+ 'description' => '商品360°展示服务查询商品信息列表接口上线',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'StopLiveRoom'],
+ ],
+ 'createdAt' => '2022-05-24T09:44:11.000Z',
+ 'description' => '增加错误码',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'UpdateAppTemplateConfig'],
+ ],
+ 'createdAt' => '2022-05-23T04:52:47.000Z',
+ 'description' => '新增传入证书格式不正确和证书私钥不匹配的错误码。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'UpdateAppTemplateConfig'],
+ ],
+ 'createdAt' => '2022-05-19T02:31:16.000Z',
+ 'description' => 'updateTemplateConfig新增证书不匹配错误码和未获得ICP许可错误码。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateAppTemplate'],
+ ],
+ 'createdAt' => '2022-05-13T03:10:35.000Z',
+ 'description' => '修改场景参数为必填',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed, Request parameters changed', 'api' => 'CreateSensitiveWord'],
+ ],
+ 'createdAt' => '2022-05-13T03:08:46.000Z',
+ 'description' => '扩大了API的使用限制',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetLiveRoomUserStatistics'],
+ ],
+ 'createdAt' => '2022-04-22T07:17:33.000Z',
+ 'description' => '新增用户维度点赞数和弹幕数',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetRoom'],
+ ],
+ 'createdAt' => '2022-04-21T04:07:13.000Z',
+ 'description' => 'GetRoom返回新增管理员id列表信息',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'BanAllComment'],
+ ['description' => 'Error codes changed', 'api' => 'BanComment'],
+ ['description' => 'Error codes changed', 'api' => 'CancelBanAllComment'],
+ ['description' => 'Error codes changed', 'api' => 'CancelBanComment'],
+ ],
+ 'createdAt' => '2022-04-20T06:14:07.000Z',
+ 'description' => '优化了禁言相关的错误码',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'CreateSensitiveWord'],
+ ['description' => 'OpenAPI offline', 'api' => 'DeleteSensitiveWord'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListSensitiveWord'],
+ ],
+ 'createdAt' => '2022-04-19T03:32:36.000Z',
+ 'description' => '新增创建敏感词、删除敏感词、查询敏感词三个OpenAPI接口。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateLiveRoom'],
+ ],
+ 'createdAt' => '2022-04-11T03:35:24.000Z',
+ 'description' => '增加extension限制描述',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'GetDomainCertificateInfo'],
+ ['description' => 'Request parameters changed', 'api' => 'ListApps'],
+ ['description' => 'OpenAPI offline', 'api' => 'SetDomainCertificate'],
+ ],
+ 'createdAt' => '2022-03-30T09:08:50.000Z',
+ 'description' => '新增https证书操作的API',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'KickRoomUser'],
+ ],
+ 'createdAt' => '2022-03-23T02:11:57.000Z',
+ 'description' => '新增房间踢人接口KickRoomUser',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'GetPageConfig'],
+ ['description' => 'Response parameters changed', 'api' => 'GetUserInfo'],
+ ],
+ 'createdAt' => '2022-03-17T09:11:41.000Z',
+ 'description' => '增加应用创建限制新增页面配置接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateApp'],
+ ],
+ 'createdAt' => '2022-03-17T08:48:30.000Z',
+ 'description' => '增加错误码',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetAuthToken'],
+ ],
+ 'createdAt' => '2022-02-23T07:29:37.000Z',
+ 'description' => 'GetAuthToken描述优化',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetUserInfo'],
+ ],
+ 'createdAt' => '2022-02-18T03:00:34.000Z',
+ 'description' => '增加欠费信息字段',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetAppTemplate'],
+ ],
+ 'createdAt' => '2022-01-21T06:06:56.000Z',
+ 'description' => '增加apps字段',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'GetCnameDetail'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetUserInfo'],
+ ],
+ 'createdAt' => '2022-01-21T06:04:59.000Z',
+ 'description' => '新增getUserInfo和getCnameDetail接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetLiveRoom'],
+ ],
+ 'createdAt' => '2022-01-10T12:49:34.000Z',
+ 'description' => '获取直播详情接口新增rtmp协议的返回',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'GetClassRecord'],
+ ],
+ 'createdAt' => '2021-12-29T07:27:36.000Z',
+ 'description' => '新增课堂录制接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'ListRoomUsers'],
+ ],
+ 'createdAt' => '2021-12-01T09:28:07.000Z',
+ 'description' => '新增ListRoomUsers查询房间用户列表接口。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'ListClasses'],
+ ],
+ 'createdAt' => '2021-11-18T06:16:26.000Z',
+ 'description' => '新增获取课程列表接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'UpdateAppTemplateConfig'],
+ ],
+ 'createdAt' => '2021-11-18T05:36:39.000Z',
+ 'description' => 'UpdateAppTemplateConfig新增配置流程状态返回，支持控制台弹窗提示。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetLiveRoomStatistics'],
+ ],
+ 'createdAt' => '2021-11-18T05:35:40.000Z',
+ 'description' => '直播数据统计新增点赞数和在线数。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'SendComment'],
+ ],
+ 'createdAt' => '2021-11-03T13:42:18.000Z',
+ 'description' => 'SendComment接口新增SenderNick字段，支持自定义昵称传入。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'ListComments'],
+ ],
+ 'createdAt' => '2021-10-25T13:06:54.000Z',
+ 'description' => '新增批量查询弹幕消息接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'AttachStandardRoomHttpsCertificate'],
+ ['description' => 'Error codes changed', 'api' => 'DeleteApp'],
+ ['description' => 'Error codes changed', 'api' => 'GetStandardRoomHttpsCertificate'],
+ ['description' => 'Error codes changed', 'api' => 'UpdateApp'],
+ ],
+ 'createdAt' => '2021-10-25T13:05:14.000Z',
+ 'description' => '新增错误码。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'UpdateAppTemplate'],
+ ],
+ 'createdAt' => '2021-10-25T13:04:54.000Z',
+ 'description' => 'UpdateAppTemplate新增可选入参componentList',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetLive'],
+ ],
+ 'createdAt' => '2021-10-20T13:23:02.000Z',
+ 'description' => 'GetLive接口新增hlsUrl和ArtcInfo出参字段',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'DeleteComment'],
+ ],
+ 'createdAt' => '2021-10-20T13:22:43.000Z',
+ 'description' => '新增消息删除的POP接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'CreateClass'],
+ ['description' => 'Response parameters changed', 'api' => 'GetClassDetail'],
+ ],
+ 'createdAt' => '2021-10-20T13:21:31.000Z',
+ 'description' => '创建课程和查询课程详情增加返回字段，包括RoomId，LiveId，ConfId等。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'CreateClass'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetClassDetail'],
+ ['description' => 'OpenAPI offline', 'api' => 'StopClass'],
+ ],
+ 'createdAt' => '2021-09-28T06:40:09.000Z',
+ 'description' => '增加课堂场景化API，支持课堂创建，查询，以及下课动作。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'DeleteClass'],
+ ['description' => 'OpenAPI offline', 'api' => 'UpdateClass'],
+ ],
+ 'createdAt' => '2021-09-28T06:39:28.000Z',
+ 'description' => '新增删除课堂和更新课堂接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'CreateLiveRoom'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetLiveRoom'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetLiveRoomStatistics'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetLiveRoomUserStatistics'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListLiveRooms'],
+ ['description' => 'OpenAPI offline', 'api' => 'StopLiveRoom'],
+ ],
+ 'createdAt' => '2021-09-28T06:38:36.000Z',
+ 'description' => '场景化服务相关接口发布',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateAppTemplate'],
+ ['description' => 'Response parameters changed', 'api' => 'GetApp'],
+ ['description' => 'Response parameters changed', 'api' => 'GetAppTemplate'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListApps'],
+ ['description' => 'Response parameters changed', 'api' => 'ListAppTemplates'],
+ ],
+ 'createdAt' => '2021-09-07T07:57:50.000Z',
+ 'description' => '控制台新增样板间集成方式',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'GetStandardRoomJumpUrl'],
+ ],
+ 'createdAt' => '2021-09-07T03:51:11.000Z',
+ 'description' => '增加GetStandardRoomJumpUrl接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'UpdateRoom'],
+ ],
+ 'createdAt' => '2021-08-18T02:51:00.000Z',
+ 'description' => 'updateRoom接口extension字段正确传递。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetLive'],
+ ],
+ 'createdAt' => '2021-08-17T09:47:16.000Z',
+ 'description' => '获取直播详情返回直播封面和用户自定义属性两个字段。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListRoomLives'],
+ ],
+ 'createdAt' => '2021-08-16T08:22:08.000Z',
+ 'description' => '获取直播列表接口支持批量查询。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateApp'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateAppTemplate'],
+ ['description' => 'Error codes changed', 'api' => 'DeleteAppTemplate'],
+ ['description' => 'Error codes changed', 'api' => 'GetAppTemplate'],
+ ['description' => 'Request parameters changed', 'api' => 'GetLiveDomainStatus'],
+ ],
+ 'createdAt' => '2021-08-13T04:09:08.000Z',
+ 'description' => '控制台相关接口更新',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'BanAllComment'],
+ ['description' => 'OpenAPI offline', 'api' => 'BanComment'],
+ ['description' => 'OpenAPI offline', 'api' => 'CancelBanAllComment'],
+ ['description' => 'OpenAPI offline', 'api' => 'CancelBanComment'],
+ ['description' => 'OpenAPI offline', 'api' => 'SendComment'],
+ ],
+ 'createdAt' => '2021-08-11T08:02:55.000Z',
+ 'description' => '新增禁言/取消禁言接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'ListRoomLives'],
+ ],
+ 'createdAt' => '2021-08-10T09:17:51.000Z',
+ 'description' => '新增获取房间直播列表接口。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'AddMember'],
+ ['description' => 'OpenAPI offline', 'api' => 'AgreeLinkMic'],
+ ['description' => 'OpenAPI offline', 'api' => 'ApplyLinkMic'],
+ ['description' => 'OpenAPI offline', 'api' => 'CancelApplyLinkMic'],
+ ['description' => 'OpenAPI offline', 'api' => 'CreateConference'],
+ ['description' => 'OpenAPI offline', 'api' => 'DeleteConference'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetConference'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListApplyLinkMicUsers'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListConferenceUsers'],
+ ['description' => 'OpenAPI offline', 'api' => 'RejectLinkMic'],
+ ],
+ 'createdAt' => '2021-08-10T08:36:30.000Z',
+ 'description' => '新增会议资源管理、连麦管理接口。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateLive'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateRoom'],
+ ],
+ 'createdAt' => '2021-08-06T04:03:52.000Z',
+ 'description' => '创建房间拓展字段功能修复，创建直播错误码优化',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'SendCustomMessageToAll'],
+ ['description' => 'OpenAPI offline', 'api' => 'SendCustomMessageToUsers'],
+ ],
+ 'createdAt' => '2021-08-06T04:03:24.000Z',
+ 'description' => '新增SendCustomMessageToAll、SendCustomMessageToUsers接口。',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteComment'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveMember'],
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClassDetail'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveRecord'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveRoomUserStatistics'],
+ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRoom'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishLiveRoom'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BanComment'],
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveRoomsById'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteClass'],
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRooms'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopLive'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateClass'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLiveRecordSliceFile'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLive'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'KickRoomUser'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListComments'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSensitiveWord'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendCustomMessageToAll'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateShareScreenLayout'],
+ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAuthToken'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImpPlayBackTimeByLiveId'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRoom'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishLive'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserAdmin'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConference'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveRoom'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveFiles'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImpWatchLiveTimeByLiveId'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLive'],
+ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetStandardRoomJumpUrl'],
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoomUsers'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveFilesById'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRoom'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendComment'],
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConference'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateClass'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLiveRoom'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSensitiveWord'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelBanAllComment'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelBanComment'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConferenceUsers'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCommentByCreatorId'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLive'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLiveRoom'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSensitiveWord'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClassRecord'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelUserAdmin'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClasses'],
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveRooms'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveRoomStatistics'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopLiveRoom'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BanAllComment'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendCustomMessageToUsers'],
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLive'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRoom'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopClass'],
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveRoom'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'IMP',
+ 'productName' => 'Apsara Video SDK',
+ 'ramCodes' => ['imp'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'BanAllComment',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:BanAllComment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetLiveRoom',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetLiveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- 502 => [
- [
- 'errorCode' => 'Meter.ReadyTsError',
- 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.',
+ ],
+ [
+ 'apiName' => 'ListLiveRoomsById',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'imp:ListLiveRoomsById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- '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' => [],
+ [
+ 'apiName' => 'ListRooms',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:ListRooms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
+ [
+ 'apiName' => 'GetLiveRoomStatistics',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:GetLiveRoomStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'parameters' => [
- [
- 'name' => 'AppId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '应用唯一标识，可以包含小写字母、数字，长度为6个字符。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
+ [
+ 'apiName' => 'GetLive',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetLive',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'RoomId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '房间ID，最大长度36个字符，传空值，则随机生成一个房间ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35-****-T95F',
+ ],
+ [
+ 'apiName' => 'RemoveMember',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'imp:RemoveMember',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'UserId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '创建直播用户。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'as****hs',
+ ],
+ [
+ 'apiName' => 'GetLiveRoomUserStatistics',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:GetLiveRoomUserStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'LiveId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '直播资源的唯一标识ID，缺省时系统自动生成36位随机uuid字符串。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'b7f2****ebb3',
+ ],
+ [
+ 'apiName' => 'DeleteLive',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteLive',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'Title',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '直播标题，支持中英文，最大长度256位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This is a title.',
+ ],
+ [
+ 'apiName' => 'DeleteSensitiveWord',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteSensitiveWord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'Introduction',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '直播简介，支持中英文，最大长度2048位。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This is an intro.',
+ ],
+ [
+ 'apiName' => 'GetClassDetail',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetClassDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'AnchorId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '主播ID，支持中英文，最大长度128位，缺省时主播为当前创建直播用户。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'as****hs',
+ ],
+ [
+ 'apiName' => 'GetLiveRecord',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:GetLiveRecord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'CodeLevel',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '直播推流码率，缺省时默认为3。取值： -1：流畅lld。 1：标清lsd。 2：高清lhd。 3：超清lud。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
+ ],
+ [
+ 'apiName' => 'DeleteConference',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteConference',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- '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',
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'ListRoomUsers',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:ListRoomUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Forbidden.Room.LiveAlreadyExist',
- 'errorMessage' => 'The live instance already exists.',
+ [
+ 'apiName' => 'DescribeMeterImpPlayBackTimeByLiveId',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:DescribeMeterImpPlayBackTimeByLiveId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'Invalid.Live.ConfigNotFound',
- 'errorMessage' => 'The live push domain and pull domain config not found.',
+ ],
+ ],
+ [
+ 'apiName' => 'GetConference',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetConference',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"Result\\": {\\n \\"LiveId\\": \\"b7f2****ebb3\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateLiveResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <LiveId>b7f2****ebb3</LiveId>\\n </Result>\\n </CreateLiveResponse>","errorExample":""}]',
- ],
- 'DeleteLive' => [
- 'summary' => '删除直播记录',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'SendCustomMessageToUsers',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:SendCustomMessageToUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'CreateLiveRoom',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'imp:CreateLiveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'CreateRoom',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'imp:CreateRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
+ [
+ 'apiName' => 'GetRoom',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'parameters' => [
- [
- 'name' => 'LiveId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '直播资源的唯一标识ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b7f2****ebb3',
+ [
+ 'apiName' => 'BanComment',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:BanComment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- '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',
- ],
- ],
+ [
+ 'apiName' => 'PublishLive',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:PublishLive',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidLiveId.Live.NotFound',
- 'errorMessage' => 'The live broadcast does not exist.',
+ [
+ 'apiName' => 'CreateSensitiveWord',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:CreateSensitiveWord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n </DeleteLiveResponse>","errorExample":""}]',
- ],
- 'PublishLive' => [
- 'summary' => '发布直播',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'UpdateRoom',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:UpdateRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'DescribeMeterImpWatchLiveTimeByLiveId',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:DescribeMeterImpWatchLiveTimeByLiveId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DeleteClass',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteClass',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'UpdateClass',
+ 'description' => '',
'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:UpdateClass',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'parameters' => [
- [
- 'name' => 'LiveId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '直播资源的唯一标识ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b7f2****ebb3',
+ [
+ 'apiName' => 'ListLiveFiles',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:ListLiveFiles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'UserId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '当前用户Id',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'as****hs',
+ ],
+ [
+ 'apiName' => 'GetStandardRoomJumpUrl',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetStandardRoomJumpUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- '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',
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'GetClassRecord',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:GetClassRecord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidLiveId.Live.NotFound',
- 'errorMessage' => 'The live broadcast does not exist.',
+ [
+ 'apiName' => 'SendCustomMessageToAll',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:SendCustomMessageToAll',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- '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":"<PublishLiveResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <LiveId>b7f2****ebb3</LiveId>\\n <AnchorId>as****hs</AnchorId>\\n <Status>1</Status>\\n <PushUrl>rtmp://demo-app-push.com/live/b7f2****ebb3?auth_key=e620****a8e3</PushUrl>\\n <LiveUrl>http://demo-app-live.com/live/b7f2****ebb3.flv?auth_key=e620****a8e3</LiveUrl>\\n </Result>\\n</PublishLiveResponse>","errorExample":""}]',
- ],
- 'UpdateLive' => [
- 'summary' => '更新直播信息',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'ListComments',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:ListComments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'StopLive',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:StopLive',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'CreateLive',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'imp:CreateLive',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
+ [
+ 'apiName' => 'DeleteLiveFilesById',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteLiveFilesById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'parameters' => [
- [
- 'name' => 'LiveId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '直播资源的唯一标识ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b7f2****ebb3',
+ [
+ 'apiName' => 'CreateLiveRecordSliceFile',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:CreateLiveRecordSliceFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'Title',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '直播标题，支持中英文，最大长度256位',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This is a title.',
+ ],
+ [
+ 'apiName' => 'KickRoomUser',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:KickRoomUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'Introduction',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '直播简介，支持中英文，最大长度2048位',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This is an introduction.',
+ ],
+ [
+ 'apiName' => 'CreateClass',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'imp:CreateClass',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- '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',
- ],
- ],
+ [
+ 'apiName' => 'DeleteLiveRoom',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteLiveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidLiveId.Live.NotFound',
- 'errorMessage' => 'The live broadcast does not exist.',
+ [
+ 'apiName' => 'DeleteComment',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteComment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n </UpdateLiveResponse>","errorExample":""}]',
- ],
- 'StopLive' => [
- 'summary' => '停止直播',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'UpdateLiveRoom',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:UpdateLiveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'CancelBanComment',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:CancelBanComment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'PublishLiveRoom',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:PublishLiveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'CancelUserAdmin',
+ 'description' => '',
'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:CancelUserAdmin',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'parameters' => [
- [
- 'name' => 'AppId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '租户名',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7m***q',
+ [
+ 'apiName' => 'GetAuthToken',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:GetAuthToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'RoomId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '房间ID，最大长度36位',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AE35-****-T95F',
+ ],
+ [
+ 'apiName' => 'StopLiveRoom',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:StopLiveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'UserId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '创建直播用户ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'as****hs',
+ ],
+ [
+ 'apiName' => 'UpdateLive',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:UpdateLive',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'LiveId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '直播资源的唯一标识ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b7f2****ebb3',
+ ],
+ [
+ 'apiName' => 'ListLiveRooms',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'imp:ListLiveRooms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- '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',
- ],
- ],
+ [
+ 'apiName' => 'DeleteRoom',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'imp:DeleteRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidLiveId.Live.NotFound',
- 'errorMessage' => 'The live broadcast does not exist.',
+ [
+ 'apiName' => 'StopClass',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:StopClass',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\"\\n}","errorExample":""},{"type":"xml","example":"<StopLiveResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n </StopLiveResponse>","errorExample":""}]',
- ],
- 'GetLive' => [
- 'summary' => '获取直播详情',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'SetUserAdmin',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'imp:SetUserAdmin',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'ListClasses',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:ListClasses',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'SendComment',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:SendComment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'ListConferenceUsers',
+ 'description' => '',
'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'imp:ListConferenceUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'parameters' => [
- [
- 'name' => 'LiveId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '直播资源的唯一标识ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b7f2****ebb3',
+ [
+ 'apiName' => 'CancelBanAllComment',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:CancelBanAllComment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- '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',
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'UpdateShareScreenLayout',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:UpdateShareScreenLayout',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSensitiveWord',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imp:ListSensitiveWord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'IMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- '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":"<GetLiveResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <Result>\\n <AnchorId>as****hs</AnchorId>\\n <LiveId>b7f2****ebb3</LiveId>\\n <Title>This is a title.</Title>\\n <PlaybackUrl>http://demo-app-playback.com/live/b7f2****ebb3.m3u8?auth_key=e620****a8e3</PlaybackUrl>\\n <CreateTime>1624259500000</CreateTime>\\n <EndTime>1624259500000</EndTime>\\n <Duration>10000</Duration>\\n <PushUrl>rtmp://demo-app-push.com/live/e620****a8e3?auth_key=e620****a8e3</PushUrl>\\n <LiveUrl>http://demo-app-live.com/live/e620****a8e3.flv?auth_key=e620****a8e3</LiveUrl>\\n <Status>Created</Status>\\n <Introduction>This is an introduction.</Introduction>\\n <RoomId>AE35-****-T95F</RoomId>\\n <AppId>7m***q</AppId>\\n <UserId>as****hs</UserId>\\n <CodeLevel>1</CodeLevel>\\n <PlayUrlInfoList>\\n <CodeLevel>1</CodeLevel>\\n <FlvUrl>http://demo-app-live.com/live/b7f2****ebb3.flv?auth_key=e620****a8e3</FlvUrl>\\n <HlsUrl>http://demo-app-live.com/live/b7f2****ebb3.m3u8?auth_key=e620****a8e3</HlsUrl>\\n <RtmpUrl>rtmp://demo-app-live.com/live/b7f2****ebb3?auth_key=e620****a8e3</RtmpUrl>\\n </PlayUrlInfoList>\\n </Result>\\n </GetLiveResponse>","errorExample":""}]',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'imp.aliyuncs.com',
],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 21:27:55 +0000