diff options
Diffstat (limited to 'data/en_us/rtc-white-board')
| -rw-r--r-- | data/en_us/rtc-white-board/2020-12-14/api-docs.php | 2799 |
1 files changed, 1292 insertions, 1507 deletions
diff --git a/data/en_us/rtc-white-board/2020-12-14/api-docs.php b/data/en_us/rtc-white-board/2020-12-14/api-docs.php index 51d2e01..bc13e86 100644 --- a/data/en_us/rtc-white-board/2020-12-14/api-docs.php +++ b/data/en_us/rtc-white-board/2020-12-14/api-docs.php @@ -1,48 +1,21 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'rtc-white-board', - 'version' => '2020-12-14', - ], + 'info' => ['style' => 'RPC', 'product' => 'rtc-white-board', 'version' => '2020-12-14'], 'directories' => [ [ - 'id' => 71443, - 'title' => null, + 'children' => ['CreateApp', 'SetAppCallbackUrl', 'SetAppDomainNames', 'SetAppName', 'SetAppStatus', 'SetAppCallbackType', 'DescribeApps'], 'type' => 'directory', - 'children' => [ - 'CreateApp', - 'SetAppCallbackUrl', - 'SetAppDomainNames', - 'SetAppName', - 'SetAppStatus', - 'SetAppCallbackType', - 'DescribeApps', - ], + 'title' => 'Application', ], [ - 'id' => 71451, - 'title' => null, + 'children' => ['CreateWhiteBoard', 'StartWhiteBoardRecording', 'StopWhiteBoardRecording', 'PauseWhiteBoardRecording', 'ResumeWhiteBoardRecording', 'DescribeWhiteBoards', 'OpenWhiteBoard', 'DescribeWhiteBoardRecordings'], 'type' => 'directory', - 'children' => [ - 'CreateWhiteBoard', - 'StartWhiteBoardRecording', - 'StopWhiteBoardRecording', - 'PauseWhiteBoardRecording', - 'ResumeWhiteBoardRecording', - 'DescribeWhiteBoards', - 'OpenWhiteBoard', - 'DescribeWhiteBoardRecordings', - ], + 'title' => 'Whiteboard', ], [ - 'id' => 71460, - 'title' => null, + 'children' => ['SetUsersPermissions', 'RefreshUsersPermissions'], 'type' => 'directory', - 'children' => [ - 'SetUsersPermissions', - 'RefreshUsersPermissions', - ], + 'title' => 'User Permission', ], ], 'components' => [ @@ -50,1983 +23,1795 @@ ], 'apis' => [ 'CreateApp' => [ - 'summary' => '创建白板应用', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Creates a whiteboard application. You can set the application name and obtain the AppID at the same time.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用名，由不超过32位的中文、英文、数字或下划线组成', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'new_whiteboard_app', - ], + 'schema' => ['title' => '', 'description' => 'The application name that you set in the console when creating a whiteboard application. The name must be 1 to 32 characters in length and can contain Chinese characters, letters, digits, and underscores.', 'type' => 'string', 'required' => true, 'example' => 'new_whiteboard_app'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '0E2ECCA1-5340-43AE-A1DC-EBD17D3CCE92', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0E2ECCA1-5340-43AE-A1DC-EBD17D3CCE92'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The call result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], 'Result' => [ - 'title' => '返回结果体', - 'description' => '', + 'title' => '', + 'description' => 'The result information.', 'type' => 'object', 'properties' => [ - 'AppID' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'example' => '7mbj****', - ], + 'AppID' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => '7mbj****'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0E2ECCA1-5340-43AE-A1DC-EBD17D3CCE92\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"AppID\\": \\"7mbj****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateAppResponse>\\n <RequestId>0E2ECCA1-5340-43AE-A1DC-EBD17D3CCE92</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <Result>\\n <AppID>7mbj****</AppID>\\n </Result>\\n</CreateAppResponse>","errorExample":""}]', - 'title' => 'CreateApp', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0E2ECCA1-5340-43AE-A1DC-EBD17D3CCE92\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"AppID\\": \\"7mbj****\\"\\n }\\n}","type":"json"}]', + 'title' => 'Create a whiteboard application', + 'description' => '# Operation description'."\n" + ."\n" + .'- This operation is used to create a whiteboard application.'."\n" + .'- The interactive whiteboard console is not yet officially online. Use the interactive whiteboard server SDK to perform related operations on whiteboard applications.'."\n" + ."\n" + .'# QPS limit'."\n" + .'The single-user QPS limit for this operation is 100 calls per second. If the limit is exceeded, the API invocation is throttled, which may affect your business. Invoke this operation properly. For more information, see [QPS limit](~~342798~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SetAppCallbackUrl' => [ - 'summary' => '设置白板应用回调地址', - 'methods' => [ - 'post', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rtc-white-board:CreateApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApp'], + ], ], + ], + 'CreateWhiteBoard' => [ + 'summary' => 'Creates a whiteboard document and retrieves the document identifier (DocKey).', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'AppID', - 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], - ], - [ - 'name' => 'AppCallbackUrl', + 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用回调地址URL', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'http://www.example.com/callback', - ], + 'schema' => ['title' => '', 'description' => 'The user ID (business user) who creates the whiteboard. The value is 1 to 32 characters in length and can contain uppercase and lowercase letters, digits, underscores, and hyphens (-).', 'type' => 'string', 'required' => true, 'example' => '123456'], ], [ - 'name' => 'AppCallbackAuthKey', + 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用回调鉴权码，由8~20位大小写字母、数字或下划线组成', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CallbackSecret123', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the AppID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'CFB5E6AA-823B-415B-AA03-4B9892049B68', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B29ADDF9-D089-460A-AF7D-BDE5DA112E4E'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], 'Result' => [ - 'title' => '返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'description' => 'The result information.', + 'type' => 'object', + 'properties' => [ + 'DocKey' => ['title' => '', 'description' => 'The identifier of the document, consisting of uppercase and lowercase letters and digits.', 'type' => 'string', 'example' => '4EZlwmRW0gDG****'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CFB5E6AA-823B-415B-AA03-4B9892049B68\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetAppCallbackUrlResponse>\\n <RequestId>CFB5E6AA-823B-415B-AA03-4B9892049B68</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <Result>true</Result>\\n</SetAppCallbackUrlResponse>","errorExample":""}]', - 'title' => 'SetAppCallbackUrl', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B29ADDF9-D089-460A-AF7D-BDE5DA112E4E\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"DocKey\\": \\"4EZlwmRW0gDG****\\"\\n }\\n}","type":"json"}]', + 'title' => 'Create a whiteboard document', + 'description' => '# Operation description'."\n" + ."\n" + .'Before you call this operation, you must have already called [CreateApp](~~204234~~) to create a whiteboard application.'."\n" + ."\n" + .'# QPS limit'."\n" + .'The single-user QPS limit for this operation is 200 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately. For more information, see [QPS limit](~~342798~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SetAppDomainNames' => [ - 'summary' => '设置白板应用合法域名', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2021-01-20T07:34:24.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rtc-white-board:CreateWhiteBoard', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWhiteBoard'], + ], ], + ], + 'DescribeApps' => [ + 'summary' => 'Queries whiteboard application information under a cloud account by using paged query. Paging is supported.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. If this parameter is left empty, all application IDs are queried by default. To obtain the AppID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => false, 'example' => '7mbj****'], ], [ - 'name' => 'AppDomainNames', + 'name' => 'AppStatus', 'in' => 'formData', - 'schema' => [ - 'title' => '所有会使用到白板应用的客户网站域名，多个使用英文逗号(,)分隔，最多传10个', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'www.example.com', - ], + 'schema' => ['title' => '', 'description' => 'The status of the whiteboard application. If this parameter is left empty, all statuses are queried by default. Valid values:'."\n" + ."\n" + .'- **1**: Enabled.'."\n" + .'- **2**: Disabled.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'D8F8BAFF-B677-4D6A-ADA1-CDB4A2C23330', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Result' => [ - 'title' => '返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D8F8BAFF-B677-4D6A-ADA1-CDB4A2C23330\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetAppDomainNamesResponse>\\n <RequestId>D8F8BAFF-B677-4D6A-ADA1-CDB4A2C23330</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <Result>true</Result>\\n</SetAppDomainNamesResponse>","errorExample":""}]', - 'title' => 'SetAppDomainNames', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SetAppName' => [ - 'summary' => '设置白板应用名', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'AppID', + 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The page number. If this parameter is left empty, the first page is queried by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'AppName', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用名，由不超过32位的中文、英文、数字或下划线组成', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'new_whiteboard_app', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page. If this parameter is left empty, the default value is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'C7B4A941-3DC0-4002-95F4-7A7D14A64992', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The call result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], 'Result' => [ - 'title' => '返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'TotalNum' => ['description' => 'The total number of applications.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'AppList' => [ + 'title' => '', + 'description' => 'The list of application details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The application details.', + 'type' => 'object', + 'properties' => [ + 'AppID' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application.', 'type' => 'string', 'example' => '7mbj****'], + 'AppName' => ['title' => '', 'description' => 'The name of the whiteboard application.', 'type' => 'string', 'example' => 'my_white_board'], + 'Status' => ['title' => '', 'description' => 'The status of the whiteboard application. Valid values:'."\n" + ."\n" + .'- **1**: Enabled.'."\n" + .'- **2**: Disabled.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CallbackUrl' => ['title' => '', 'description' => 'The callback URL of the whiteboard application.', 'type' => 'string', 'example' => 'http://www.example.com/callback'], + 'DomainNames' => ['title' => '', 'description' => 'The list of valid domain names, separated by commas (,).', 'type' => 'string', 'example' => 'www.example.com'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the whiteboard application was created.', 'type' => 'string', 'example' => '2020-04-10 12:20:30.567'], + 'CallbackType' => ['title' => '', 'description' => 'The callback types of the whiteboard application, separated by commas (,). A value of all indicates that all callback types are configured.', 'type' => 'string', 'example' => 'userPermissionCallback,whiteBoardProfileCallback,userProfileCallback,hostCheckCallback'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"TotalNum\\": 15,\\n \\"TotalPage\\": 5,\\n \\"AppList\\": [\\n {\\n \\"AppID\\": \\"7mbj****\\",\\n \\"AppName\\": \\"my_white_board\\",\\n \\"Status\\": 1,\\n \\"CallbackUrl\\": \\"http://www.example.com/callback\\",\\n \\"DomainNames\\": \\"www.example.com\\",\\n \\"CreateTime\\": \\"2020-04-10 12:20:30.567\\",\\n \\"CallbackType\\": \\"userPermissionCallback,whiteBoardProfileCallback,userProfileCallback,hostCheckCallback\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query application list', + 'description' => '# Operation description'."\n" + ."\n" + .'Before you call this operation, you must have created a whiteboard application by calling [CreateApp](~~204234~~).'."\n" + ."\n" + .'# QPS limit'."\n" + .'The single-user QPS limit for this operation is 100 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation as needed. For more information, see [QPS limit](~~342798~~).', + 'changeSet' => [ + ['createdAt' => '2021-04-15T06:50:51.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-04-15T06:50:51.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rtc-white-board:DescribeApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C7B4A941-3DC0-4002-95F4-7A7D14A64992\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetAppNameResponse>\\n <RequestId>C7B4A941-3DC0-4002-95F4-7A7D14A64992</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <Result>true</Result>\\n</SetAppNameResponse>","errorExample":""}]', - 'title' => 'SetAppName', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SetAppStatus' => [ - 'summary' => '设置白板应用状态', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApps'], + ], ], + ], + 'DescribeWhiteBoardRecordings' => [ + 'summary' => 'Queries the recording list and operation sequences of a whiteboard by paging.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the AppID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], ], [ - 'name' => 'AppStatus', + 'name' => 'DocKey', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用状态（取值：1:启用，2:停用）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Result' => [ - 'title' => '返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard document. To obtain the DocKey, see [CreateWhiteBoard](~~204299~~).', 'type' => 'string', 'required' => true, 'example' => '4EZlwmRW0gDG****'], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetAppStatusResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <Result>true</Result>\\n</SetAppStatusResponse>","errorExample":""}]', - 'title' => 'SetAppStatus', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SetAppCallbackType' => [ - 'summary' => '设置白板应用回调类型', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'AppID', + 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The page number. If this parameter is left empty, the first page is queried by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'AppCallbackType', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用回调类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'userPermissionCallback,whiteBoardProfileCallback,userProfileCallback,hostCheckCallback', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page. If this parameter is left empty, the default value is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'CFB5E6AA-823B-415B-AA03-4B9892049B68', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], 'Result' => [ - 'title' => '返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'description' => 'The result information.', + 'type' => 'object', + 'properties' => [ + 'TotalNum' => ['description' => 'The total number of documents.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RecordingList' => [ + 'title' => '', + 'description' => 'The list of recording information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The recording details.', + 'type' => 'object', + 'properties' => [ + 'AppID' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application.', 'type' => 'string', 'example' => '7mbj****'], + 'DocKey' => ['title' => '', 'description' => 'The unique identifier of the whiteboard document.', 'type' => 'string', 'example' => '4EZlwmRW0gDG****'], + 'RecordId' => ['title' => '', 'description' => 'The unique identifier of the whiteboard recording session.', 'type' => 'string', 'example' => '8a4556336bc6456b918e8eedbed6****'], + 'UserId' => ['title' => '', 'description' => 'The user ID of the user who created the whiteboard recording.', 'type' => 'string', 'example' => '123456'], + 'OperateList' => [ + 'title' => '', + 'description' => 'The list of whiteboard recording operations.', + 'type' => 'array', + 'items' => ['description' => 'The whiteboard recording operation in the format of operate@UNIX timestamp. Valid values of operate:'."\n" + ."\n" + .'- **start**: Starts whiteboard recording.'."\n" + .'- **stop**: Stops whiteboard recording.'."\n" + .'- **pause**: Pauses whiteboard recording.'."\n" + .'- **resume**: Resumes whiteboard recording.', 'type' => 'string', 'example' => 'start@1631686505500', 'title' => ''], + 'example' => '2020-04-10 12:20:30.567', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"TotalNum\\": 10,\\n \\"TotalPage\\": 1,\\n \\"RecordingList\\": [\\n {\\n \\"AppID\\": \\"7mbj****\\",\\n \\"DocKey\\": \\"4EZlwmRW0gDG****\\",\\n \\"RecordId\\": \\"8a4556336bc6456b918e8eedbed6****\\",\\n \\"UserId\\": \\"123456\\",\\n \\"OperateList\\": [\\n \\"start@1631686505500\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query whiteboard recording list', + 'description' => '# Operation description'."\n" + ."\n" + .'Before you call this operation, you must have called [StartWhiteBoardRecording](~~253300~~) to start whiteboard recording.'."\n" + ."\n" + .'# QPS limit'."\n" + .'The single-user QPS limit for this operation is 200 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation as needed. For more information, see [QPS limit](~~342798~~).', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rtc-white-board:DescribeWhiteBoardRecordings', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CFB5E6AA-823B-415B-AA03-4B9892049B68\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetAppCallbackTypeResponse>\\n <RequestId>CFB5E6AA-823B-415B-AA03-4B9892049B68</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <Result>true</Result>\\n</SetAppCallbackTypeResponse>","errorExample":""}]', - 'title' => 'SetAppCallbackType', - ], - 'DescribeApps' => [ - 'summary' => '查询应用列表', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWhiteBoardRecordings'], + ], ], + ], + 'DescribeWhiteBoards' => [ + 'summary' => 'Queries whiteboard document information under a specified AppID by paging.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符，默认查询所有应用ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the AppID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], ], [ - 'name' => 'AppStatus', + 'name' => 'DocStatus', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用状态，默认查询所有状态。（取值：1:启用，2:停用）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The status of the whiteboard document. If this parameter is left empty, all statuses are queried by default. Valid values:'."\n" + ."\n" + .'- **1**: Enabled.'."\n" + .'- **2**: Disabled.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'title' => '第几页，默认查询第1页。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number. If this parameter is left empty, the first page is queried by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'title' => '每页显示个数，默认为10。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page. If this parameter is left empty, the default value is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The call result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], 'Result' => [ - 'title' => '返回结果体', - 'description' => '', + 'title' => '', + 'description' => 'The result information.', 'type' => 'object', 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'AppList' => [ - 'title' => 'App信息列表', - 'description' => '', + 'TotalNum' => ['description' => 'The total number of documents.', 'type' => 'integer', 'format' => 'int64', 'example' => '33', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '11', 'title' => ''], + 'DocList' => [ + 'title' => '', + 'description' => 'The list of document details.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The document details.', 'type' => 'object', 'properties' => [ - 'AppID' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'example' => '7mbj****', - ], - 'AppName' => [ - 'title' => '白板应用名', - 'description' => '', - 'type' => 'string', - 'example' => 'my_white_board', - ], - 'Status' => [ - 'title' => '白板应用状态（取值：1:启用，2:停用）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CallbackUrl' => [ - 'title' => '白板应用回调地址URL', - 'description' => '', - 'type' => 'string', - 'example' => 'http://www.example.com/callback', - ], - 'DomainNames' => [ - 'title' => '合法域名列表，使用英文逗号(,)分隔', - 'description' => '', - 'type' => 'string', - 'example' => 'www.example.com', - ], - 'CreateTime' => [ - 'title' => '白板应用创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2020-04-10 12:20:30.567', - ], - 'CallbackType' => [ - 'title' => '白板应用回调类型', - 'description' => '', - 'type' => 'string', - 'example' => 'userPermissionCallback,whiteBoardProfileCallback,userProfileCallback,hostCheckCallback', - ], + 'AppID' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application.', 'type' => 'string', 'example' => '7mbj****'], + 'DocKey' => ['title' => '', 'description' => 'The unique identifier of the whiteboard document.', 'type' => 'string', 'example' => '4EZlwmRW0gDG****'], + 'Status' => ['title' => '', 'description' => 'The status of the whiteboard document. Valid values:'."\n" + ."\n" + .'- **1**: Enabled.'."\n" + .'- **2**: Disabled.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CreateUserId' => ['title' => '', 'description' => 'The ID of the user who created the whiteboard.', 'type' => 'string', 'example' => '123456'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the whiteboard document was created.', 'type' => 'string', 'example' => '2020-04-10 12:20:30.567'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"TotalNum\\": 15,\\n \\"TotalPage\\": 5,\\n \\"AppList\\": [\\n {\\n \\"AppID\\": \\"7mbj****\\",\\n \\"AppName\\": \\"my_white_board\\",\\n \\"Status\\": 1,\\n \\"CallbackUrl\\": \\"http://www.example.com/callback\\",\\n \\"DomainNames\\": \\"www.example.com\\",\\n \\"CreateTime\\": \\"2020-04-10 12:20:30.567\\",\\n \\"CallbackType\\": \\"userPermissionCallback,whiteBoardProfileCallback,userProfileCallback,hostCheckCallback\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAppsResponse>\\n <RequestId>29D20DA7-985D-425E-89BD-26594D327DCC</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <ErrorMsg/>\\n <ErrorCode/>\\n <Result>\\n <TotalNum>15</TotalNum>\\n <TotalPage>5</TotalPage>\\n <AppList>\\n <CallbackUrl>http://www.example.com/callback</CallbackUrl>\\n <Status>1</Status>\\n <AppID>zt87****</AppID>\\n <CreateTime>2021-04-10 16:10:57.217</CreateTime>\\n <DomainNames>www.example.com</DomainNames>\\n <AppName>我的APP1</AppName>\\n <CallbackType>userPermissionCallback</CallbackType>\\n </AppList>\\n <AppList>\\n <CallbackUrl>http://www.example.com/callback</CallbackUrl>\\n <Status>1</Status>\\n <AppID>sf1g****</AppID>\\n <CreateTime>2021-04-12 15:29:27.315</CreateTime>\\n <DomainNames>www.example.com</DomainNames>\\n <AppName>我的APP2</AppName>\\n <CallbackType>userPermissionCallback,whiteBoardProfileCallback</CallbackType>\\n </AppList>\\n <AppList>\\n <CallbackUrl>http://www.example.com/callback</CallbackUrl>\\n <Status>1</Status>\\n <AppID>5s77****</AppID>\\n <CreateTime>2021-04-12 17:00:39.325</CreateTime>\\n <DomainNames>www.example.com</DomainNames>\\n <AppName>我的APP3</AppName>\\n <CallbackType>userPermissionCallback,userProfileCallback</CallbackType>\\n </AppList>\\n </Result>\\n</DescribeAppsResponse>","errorExample":""}]', - 'title' => 'DescribeApps', - ], - 'CreateWhiteBoard' => [ - 'summary' => '创建白板文档', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"TotalNum\\": 33,\\n \\"TotalPage\\": 11,\\n \\"DocList\\": [\\n {\\n \\"AppID\\": \\"7mbj****\\",\\n \\"DocKey\\": \\"4EZlwmRW0gDG****\\",\\n \\"Status\\": 1,\\n \\"CreateUserId\\": \\"123456\\",\\n \\"CreateTime\\": \\"2020-04-10 12:20:30.567\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query whiteboard document list', + 'description' => '# Operation description'."\n" + ."\n" + .'Before you call this operation, you must have called [CreateApp](~~204234~~) to create a whiteboard application.'."\n" + ."\n" + .'# QPS limit'."\n" + .'The single-user QPS limit for this operation is 200 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation as needed. For more information, see [QPS limit](~~342798~~).', + 'changeSet' => [ + ['createdAt' => '2021-04-15T06:50:51.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWhiteBoards'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rtc-white-board:DescribeWhiteBoards', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'OpenWhiteBoard' => [ + 'summary' => 'Opens an existing whiteboard document and retrieves the connection information for the whiteboard document.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ + 'name' => 'AppID', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the AppID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], + ], + [ 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'title' => '创建白板的用户ID（客户业务用户），由1~32位大小写字母、数字、下划线、短划线（-）组成', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the user who opens the whiteboard (business user), consisting of 1 to 32 characters including uppercase and lowercase letters, digits, underscores, and hyphens (-).', 'type' => 'string', 'required' => true, 'example' => '123456'], ], [ - 'name' => 'AppID', + 'name' => 'DocKey', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard document. To obtain the DocKey, see [CreateWhiteBoard](~~204299~~).', 'type' => 'string', 'required' => true, 'example' => '4EZlwmRW0gDG****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'B29ADDF9-D089-460A-AF7D-BDE5DA112E4E', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CE47143D-9700-4756-856A-BB22FEBE4DAE'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], 'Result' => [ - 'title' => '返回结果体', - 'description' => '', + 'title' => '', + 'description' => 'The result information.', 'type' => 'object', 'properties' => [ - 'DocKey' => [ - 'title' => '文档唯一标识符，由大小写字母和数字组成', - 'description' => '', - 'type' => 'string', - 'example' => '4EZlwmRW0gDG****', + 'DocumentAccessInfo' => [ + 'title' => '', + 'description' => 'The whiteboard connection information.', + 'type' => 'object', + 'properties' => [ + 'AccessToken' => ['title' => '', 'description' => 'The connection signature.', 'type' => 'string', 'example' => 'qbFPTqipwQZqkGitAoAGbNHuHREm****'], + 'CollabHost' => ['title' => '', 'description' => 'The persistent endpoint of the whiteboard.', 'type' => 'string', 'example' => 'collab-cn-shanghai.****.com'], + 'Permission' => ['title' => '', 'description' => 'The permission code. Valid values:'."\n" + ."\n" + .'- **0**: no permission.'."\n" + .'- **1**: read-only.'."\n" + .'- **2**: read and write.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'UserInfo' => [ + 'title' => '', + 'description' => 'The user information.', + 'type' => 'object', + 'properties' => [ + 'AvatarUrl' => ['title' => '', 'description' => 'The URL of the user profile picture.', 'type' => 'string', 'example' => 'http://www.avatarset/****.jpg'], + 'Nick' => ['title' => '', 'description' => 'The nickname of the user.', 'type' => 'string', 'example' => 'Mary'], + 'NickPinyin' => ['title' => '', 'description' => 'The pinyin nickname of the user.', 'type' => 'string', 'example' => 'Pinyin_Mary'], + 'UserId' => ['title' => '', 'description' => 'The ID of the user who opens the whiteboard.', 'type' => 'string', 'example' => '123456'], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B29ADDF9-D089-460A-AF7D-BDE5DA112E4E\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"DocKey\\": \\"4EZlwmRW0gDG****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateWhiteBoardResponse>\\n <RequestId>B29ADDF9-D089-460A-AF7D-BDE5DA112E4E</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <Result>\\n <DocKey>4EZlwmRW0gDG****</DocKey>\\n </Result>\\n</CreateWhiteBoardResponse>","errorExample":""}]', - 'title' => 'CreateWhiteBoard', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE47143D-9700-4756-856A-BB22FEBE4DAE\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"DocumentAccessInfo\\": {\\n \\"AccessToken\\": \\"qbFPTqipwQZqkGitAoAGbNHuHREm****\\",\\n \\"CollabHost\\": \\"collab-cn-shanghai.****.com\\",\\n \\"Permission\\": 2,\\n \\"UserInfo\\": {\\n \\"AvatarUrl\\": \\"http://www.avatarset/****.jpg\\",\\n \\"Nick\\": \\"Mary\\",\\n \\"NickPinyin\\": \\"Pinyin_Mary\\",\\n \\"UserId\\": \\"123456\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Open a whiteboard document', + 'description' => '# Operation description'."\n" + ."\n" + .'- Before calling this operation, you must have called [CreateApp](~~204234~~) and [CreateWhiteBoard](~~204299~~) to create a whiteboard application and a whiteboard document.'."\n" + .'- This operation sends user authentication callback and user information callback requests to the customer server to obtain user permissions and basic user information. Make sure that the application callback URL is correctly configured.'."\n" + ."\n" + .'# QPS limit'."\n" + .'The single-user QPS limit for this operation is 200 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately. For more information, see [QPS limit](~~342798~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'StartWhiteBoardRecording' => [ - 'summary' => '启动白板录制', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-07-07T01:34:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-01-20T07:33:45.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rtc-white-board:OpenWhiteBoard', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenWhiteBoard'], + ], ], + ], + 'PauseWhiteBoardRecording' => [ + 'summary' => 'Pauses the recording of whiteboard operation sequences.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the AppID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], ], [ 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'title' => '启动白板录制的用户ID（客户业务用户），由1~32位大小写字母、数字、下划线、短划线（-）组成', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the user (business user) who pauses the whiteboard recording. The value consists of 1 to 32 characters including uppercase and lowercase letters, digits, underscores, and hyphens (-).', 'type' => 'string', 'required' => true, 'example' => '123456'], ], [ 'name' => 'DocKey', 'in' => 'formData', - 'schema' => [ - 'title' => '白板文档唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4EZlwmRW0gDG****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard document. To obtain the DocKey, see [CreateWhiteBoard](~~204299~~).', 'type' => 'string', 'required' => true, 'example' => '4EZlwmRW0gDG****'], + ], + [ + 'name' => 'RecordId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard recording session. To obtain the RecordId, see [StartWhiteBoardRecording](~~253300~~).', 'type' => 'string', 'required' => true, 'example' => '8a4556336bc6456b918e8eedbed6****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'FFE713C6-BBA9-457B-AF9D-F6584279A790', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B62D36BC-C41E-4436-B74B-2D0DB2E9E338'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], 'Result' => [ - 'title' => '返回结果体', - 'description' => '', + 'title' => '', + 'description' => 'The result information.', 'type' => 'object', 'properties' => [ - 'RecordId' => [ - 'title' => '白板录制Session的唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => '05157a01cb1d4aca97704fc7a473****', - ], - 'StartTime' => [ - 'title' => '录制开始的UNIX时间戳', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1622173517031', - ], + 'PauseTime' => ['title' => '', 'description' => 'The time when the recording was paused, represented as a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1622173522279'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FFE713C6-BBA9-457B-AF9D-F6584279A790\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"RecordId\\": \\"05157a01cb1d4aca97704fc7a473****\\",\\n \\"StartTime\\": 1622173517031\\n }\\n}","errorExample":""},{"type":"xml","example":"<StartWhiteBoardRecordingResponse>\\n <RequestId>FFE713C6-BBA9-457B-AF9D-F6584279A790</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <ErrorMsg/>\\n <ErrorCode/>\\n <Result>\\n <StartTime>1622173517031</StartTime>\\n <RecordId>05157a01cb1d4aca97704fc7a473****</RecordId>\\n </Result>\\n</StartWhiteBoardRecordingResponse>","errorExample":""}]', - 'title' => 'StartWhiteBoardRecording', - ], - 'StopWhiteBoardRecording' => [ - 'summary' => '结束白板录制', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B62D36BC-C41E-4436-B74B-2D0DB2E9E338\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"PauseTime\\": 1622173522279\\n }\\n}","type":"json"}]', + 'title' => 'Pause whiteboard recording', + 'description' => '# Usage notes'."\n" + .'Before calling this operation, you must have already called [StartWhiteBoardRecording](~~253300~~) to start whiteboard recording.'."\n" + .'# QPS limit'."\n" + .'A single user can call this operation up to 200 times per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately. For more information, see [QPS limit](~~342798~~).', + 'changeSet' => [ + ['createdAt' => '2021-05-28T02:32:09.000Z', 'description' => 'OpenAPI offline'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:PauseWhiteBoardRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseWhiteBoardRecording'], + ], ], + ], + 'RefreshUsersPermissions' => [ + 'summary' => 'Refreshes the permission cache of whiteboard document users. When a user accesses the whiteboard again, the user permissions are confirmed through a callback.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'AppID', - 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], - ], - [ - 'name' => 'UserId', + 'name' => 'UserIds', 'in' => 'formData', - 'schema' => [ - 'title' => '结束白板录制的用户ID（客户业务用户），由1~32位大小写字母、数字、下划线、短划线（-）组成', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['title' => '', 'description' => 'The IDs of users whose permissions you want to refresh, separated by commas (,). You can specify up to 30 IDs. Each ID consists of digits only.', 'type' => 'string', 'required' => true, 'example' => '100001,100002'], ], [ 'name' => 'DocKey', 'in' => 'formData', - 'schema' => [ - 'title' => '白板文档唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4EZlwmRW0gDG****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard document. To obtain the DocKey, see [CreateWhiteBoard](~~204299~~).', 'type' => 'string', 'required' => true, 'example' => '4EZlwmRW0gDG****'], ], [ - 'name' => 'RecordId', + 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '白板录制Session的唯一标识', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '8a4556336bc6456b918e8eedbed6****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the AppID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'C4670A7A-CF1F-4223-BA18-6778FFB2A9E1', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Result' => [ - 'title' => '返回结果体', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StopTime' => [ - 'title' => '录制结束的UNIX时间戳', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1622173532900', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0E85E1C9-4A68-49E5-965A-22F628B209C6'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The call result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], + 'Result' => ['title' => '', 'description' => 'The result information.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C4670A7A-CF1F-4223-BA18-6778FFB2A9E1\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"StopTime\\": 1622173532900\\n }\\n}","errorExample":""},{"type":"xml","example":"<StopWhiteBoardRecordingResponse>\\n <RequestId>C4670A7A-CF1F-4223-BA18-6778FFB2A9E1</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <ErrorMsg/>\\n <ErrorCode/>\\n <Result>\\n <StopTime>1622173532900</StopTime>\\n </Result>\\n</StopWhiteBoardRecordingResponse>","errorExample":""}]', - 'title' => 'StopWhiteBoardRecording', - ], - 'PauseWhiteBoardRecording' => [ - 'summary' => '暂停白板录制', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0E85E1C9-4A68-49E5-965A-22F628B209C6\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Refresh user permissions', + 'description' => '# Operation description'."\n" + .'Before you call this operation, you must have called [CreateApp](~~204234~~) and [CreateWhiteBoard](~~204299~~) to create a whiteboard application and a whiteboard document.'."\n" + .'# QPS limit'."\n" + .'The single-user QPS limit for this operation is 200 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation as needed. For more information, see [QPS limit](~~342798~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:RefreshUsersPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshUsersPermissions'], + ], ], + ], + 'ResumeWhiteBoardRecording' => [ + 'summary' => 'Resumes whiteboard operation sequence recording from a paused state.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the AppID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], ], [ 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'title' => '结束白板录制的用户ID（客户业务用户），由1~32位大小写字母、数字、下划线、短划线（-）组成', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the user (business user) who resumes whiteboard recording. The ID is 1 to 32 characters in length and can contain letters, digits, underscores, and hyphens (-).', 'type' => 'string', 'required' => true, 'example' => '123456'], ], [ 'name' => 'DocKey', 'in' => 'formData', - 'schema' => [ - 'title' => '白板文档唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4EZlwmRW0gDG****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard document. To obtain the DocKey, see [CreateWhiteBoard](~~204299~~).', 'type' => 'string', 'required' => true, 'example' => '4EZlwmRW0gDG****'], ], [ 'name' => 'RecordId', 'in' => 'formData', - 'schema' => [ - 'title' => '白板录制Session的唯一标识', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '8a4556336bc6456b918e8eedbed6****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard recording session. To obtain the RecordId, see [StartWhiteBoardRecording](~~253300~~).', 'type' => 'string', 'required' => true, 'example' => '8a4556336bc6456b918e8eedbed6****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'B62D36BC-C41E-4436-B74B-2D0DB2E9E338', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ECC1446C-0B06-4A5B-9D5D-0FE60343DA66'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], 'Result' => [ - 'title' => '返回结果体', - 'description' => '', + 'title' => '', + 'description' => 'The result information.', 'type' => 'object', 'properties' => [ - 'PauseTime' => [ - 'title' => '录制结束的UNIX时间戳', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1622173522279', - ], + 'ResumeTime' => ['title' => '', 'description' => 'The time when recording is resumed. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1622173527622'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B62D36BC-C41E-4436-B74B-2D0DB2E9E338\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"PauseTime\\": 1622173522279\\n }\\n}","errorExample":""},{"type":"xml","example":"<PauseWhiteBoardRecordingResponse>\\n <RequestId>B62D36BC-C41E-4436-B74B-2D0DB2E9E338</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <ErrorMsg/>\\n <ErrorCode/>\\n <Result>\\n <PauseTime>1622173522279</PauseTime>\\n </Result>\\n</PauseWhiteBoardRecordingResponse>","errorExample":""}]', - 'title' => 'PauseWhiteBoardRecording', - ], - 'ResumeWhiteBoardRecording' => [ - 'summary' => '恢复白板录制', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ECC1446C-0B06-4A5B-9D5D-0FE60343DA66\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"ResumeTime\\": 1622173527622\\n }\\n}","type":"json"}]', + 'title' => 'Resume whiteboard recording', + 'description' => '# Operation description'."\n" + .'Before calling this operation, you must have already called [PauseWhiteBoardRecording](~~253330~~) to pause whiteboard recording.'."\n" + .'# QPS limit'."\n" + .'A single user can call this operation up to 200 times per second. If the number of calls exceeds the limit, throttling is triggered, which may affect your business. Properly plan your calls. For more information, see [QPS limit](~~342798~~).', + 'changeSet' => [ + ['createdAt' => '2021-05-28T02:32:09.000Z', 'description' => 'OpenAPI offline'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:ResumeWhiteBoardRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeWhiteBoardRecording'], + ], ], + ], + 'SetAppCallbackType' => [ + 'summary' => 'Sets the callback type for a whiteboard application.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the AppID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], ], [ - 'name' => 'UserId', + 'name' => 'AppCallbackType', 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The callback type of the whiteboard application. Separate multiple values with commas (,). Valid values:'."\n" + ."\n" + .'- **userPermissionCallback**: User permission callback.'."\n" + .'- **whiteBoardProfileCallback**: Whiteboard metadata callback.'."\n" + .'- **userProfileCallback**: User metadata callback.'."\n" + .'- **hostCheckCallback**: Valid domain name verification failure callback.', 'type' => 'string', 'required' => true, 'example' => 'userPermissionCallback,whiteBoardProfileCallback,userProfileCallback,hostCheckCallback'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '结束白板录制的用户ID（客户业务用户），由1~32位大小写字母、数字、下划线、短划线（-）组成', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123456', + 'title' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CFB5E6AA-823B-415B-AA03-4B9892049B68'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], + 'Result' => ['title' => '', 'description' => 'The response result.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CFB5E6AA-823B-415B-AA03-4B9892049B68\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Set whiteboard application callback type', + 'description' => '# Operation description'."\n" + ."\n" + .'Before you call this operation, you must have created a whiteboard application by calling [CreateApp](~~204234~~).'."\n" + ."\n" + .'# QPS limit'."\n" + .'The single-user QPS limit for this operation is 100 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation as needed. For more information, see [QPS limit](~~342798~~).', + 'changeSet' => [ + ['createdAt' => '2021-05-06T08:18:53.000Z', 'description' => 'OpenAPI offline'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:SetAppCallbackType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppCallbackType'], + ], + ], + ], + 'SetAppCallbackUrl' => [ + 'summary' => 'Sets the callback URL and callback authentication code for a whiteboard application.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DocKey', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '白板文档唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4EZlwmRW0gDG****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the whiteboard application ID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], ], [ - 'name' => 'RecordId', + 'name' => 'AppCallbackUrl', 'in' => 'formData', - 'schema' => [ - 'title' => '白板录制Session的唯一标识', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '8a4556336bc6456b918e8eedbed6****', - ], + 'schema' => ['title' => '', 'description' => 'The callback URL of the whiteboard application.', 'type' => 'string', 'required' => true, 'example' => 'http://www.example.com/callback'], + ], + [ + 'name' => 'AppCallbackAuthKey', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The callback authentication code of the whiteboard application, consisting of 8 to 20 characters including uppercase letters, lowercase letters, digits, or underscores.', 'type' => 'string', 'required' => true, 'example' => 'CallbackSecret123'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'ECC1446C-0B06-4A5B-9D5D-0FE60343DA66', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Result' => [ - 'title' => '返回结果体', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ResumeTime' => [ - 'title' => '录制结束的UNIX时间戳', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1622173527622', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CFB5E6AA-823B-415B-AA03-4B9892049B68'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The call result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], + 'Result' => ['title' => '', 'description' => 'The result information.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ECC1446C-0B06-4A5B-9D5D-0FE60343DA66\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"ResumeTime\\": 1622173527622\\n }\\n}","errorExample":""},{"type":"xml","example":"<ResumeWhiteBoardRecordingResponse>\\n <RequestId>ECC1446C-0B06-4A5B-9D5D-0FE60343DA66</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <ErrorMsg/>\\n <ErrorCode/>\\n <Result>\\n <ResumeTime>1622173527622</ResumeTime>\\n </Result>\\n</ResumeWhiteBoardRecordingResponse>","errorExample":""}]', - 'title' => 'ResumeWhiteBoardRecording', - ], - 'DescribeWhiteBoards' => [ - 'summary' => '查询白板列表', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CFB5E6AA-823B-415B-AA03-4B9892049B68\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Set whiteboard application callback URL', + 'description' => '# Usage notes'."\n" + ."\n" + .'- Before invoking this operation, you must have already created a whiteboard application by calling [CreateApp](~~204234~~).'."\n" + .'- The Interactive Whiteboard console is not yet officially online. Use the Interactive Whiteboard server SDK to perform related operations on whiteboard applications.'."\n" + ."\n" + .'# QPS limit'."\n" + .'The single-user QPS limit for this operation is 100 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Invoke this operation appropriately. For more information, see [QPS limit](~~342798~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-01-20T07:34:24.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:SetAppCallbackUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppCallbackUrl'], + ], ], + ], + 'SetAppDomainNames' => [ + 'summary' => 'Sets the list of authorized domain names for a whiteboard application, which are the domain names that need to access the whiteboard service.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the whiteboard application ID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], ], [ - 'name' => 'DocStatus', + 'name' => 'AppDomainNames', 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The domain names of all customer websites that use the whiteboard application. Separate multiple domain names with commas (,). You can specify up to 10 domain names.', 'type' => 'string', 'required' => true, 'example' => 'www.example.com'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '白板文档状态，默认查询所有状态。（取值：1:启用，2:停用）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'title' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D8F8BAFF-B677-4D6A-ADA1-CDB4A2C23330'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The call result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], + 'Result' => ['title' => '', 'description' => 'The result information.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8F8BAFF-B677-4D6A-ADA1-CDB4A2C23330\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Set authorized domain names for a whiteboard application', + 'description' => '# Usage notes'."\n" + ."\n" + .'- Before invoking this operation, you must have already created a whiteboard application by invoking [CreateApp](~~204234~~).'."\n" + .'- The Interactive Whiteboard console is not yet officially online. Use the Interactive Whiteboard server SDK to perform related operations on whiteboard applications.'."\n" + ."\n" + .'# QPS limit'."\n" + .'The single-user QPS limit for this operation is 100 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Invoke this operation appropriately. For more information, see [QPS limit](~~342798~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:SetAppDomainNames', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppDomainNames'], + ], + ], + ], + 'SetAppName' => [ + 'summary' => 'Renames a whiteboard application.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNum', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '第几页，默认查询第1页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the whiteboard application ID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], ], [ - 'name' => 'PageSize', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'title' => '每页显示个数，默认为10', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'The name of the whiteboard application. The name must be 1 to 32 characters in length and can contain Chinese characters, letters, digits, and underscores.', 'type' => 'string', 'required' => true, 'example' => 'new_whiteboard_app'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Result' => [ - 'title' => '返回结果体', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33', - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'DocList' => [ - 'title' => 'App信息列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AppID' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'example' => '7mbj****', - ], - 'DocKey' => [ - 'title' => '文档唯一标识符', - 'description' => '', - 'type' => 'string', - 'example' => '4EZlwmRW0gDG****', - ], - 'Status' => [ - 'title' => '文档状态（取值：1:启用，2:停用）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CreateUserId' => [ - 'title' => '创建白板的用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '123456', - ], - 'CreateTime' => [ - 'title' => '白板应用创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2020-04-10 12:20:30.567', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C7B4A941-3DC0-4002-95F4-7A7D14A64992'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The call result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], + 'Result' => ['title' => '', 'description' => 'The result information.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"TotalNum\\": 33,\\n \\"TotalPage\\": 11,\\n \\"DocList\\": [\\n {\\n \\"AppID\\": \\"7mbj****\\",\\n \\"DocKey\\": \\"4EZlwmRW0gDG****\\",\\n \\"Status\\": 1,\\n \\"CreateUserId\\": \\"123456\\",\\n \\"CreateTime\\": \\"2020-04-10 12:20:30.567\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeWhiteBoardsResponse>\\n <RequestId>AEBD21E4-85D7-4B8D-A51E-F9E01AEEB682</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <ErrorMsg/>\\n <ErrorCode/>\\n <Result>\\n <TotalNum>33</TotalNum>\\n <TotalPage>11</TotalPage>\\n <DocList>\\n <Status>1</Status>\\n <DocKey>4j7OJzVEKR8J****</DocKey>\\n <AppID>p9an****</AppID>\\n <CreateTime>2021-04-10 14:22:13.647</CreateTime>\\n <CreateUserId>123456</CreateUserId>\\n </DocList>\\n <DocList>\\n <Status>1</Status>\\n <DocKey>XN94MkAb63Bm****</DocKey>\\n <AppID>p9an****</AppID>\\n <CreateTime>2021-04-12 14:22:21.492</CreateTime>\\n <CreateUserId>123456</CreateUserId>\\n </DocList>\\n <DocList>\\n <Status>1</Status>\\n <DocKey>5VLqX472M3Dw****</DocKey>\\n <AppID>p9an****</AppID>\\n <CreateTime>2021-04-12 15:07:37.069</CreateTime>\\n <CreateUserId>123456</CreateUserId>\\n </DocList>\\n </Result>\\n</DescribeWhiteBoardsResponse>","errorExample":""}]', - 'title' => 'DescribeWhiteBoards', - ], - 'OpenWhiteBoard' => [ - 'summary' => '打开白板文档', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7B4A941-3DC0-4002-95F4-7A7D14A64992\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Set whiteboard application name', + 'description' => '# Operation description'."\n" + ."\n" + .'- Before you invoke this operation, you must have created a whiteboard application by calling [CreateApp](~~204234~~).'."\n" + .'- The interactive whiteboard console is not yet online. Use the interactive whiteboard server SDK for related operations on whiteboard applications.'."\n" + ."\n" + .'# QPS limit'."\n" + .'The single-user QPS limit for this operation is 100 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Invoke this operation as needed. For more information, see [QPS limit](~~342798~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:SetAppName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppName'], + ], ], + ], + 'SetAppStatus' => [ + 'summary' => 'Sets the status of a whiteboard application. Valid values: 1 (enabled) and 2 (disabled).', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the whiteboard application ID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], ], [ - 'name' => 'UserId', - 'in' => 'formData', - 'schema' => [ - 'title' => '打开白板的用户ID（客户业务用户），由1~32位大小写字母、数字、下划线、短划线（-）组成', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123456', - ], - ], - [ - 'name' => 'DocKey', + 'name' => 'AppStatus', 'in' => 'formData', - 'schema' => [ - 'title' => '白板文档唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4EZlwmRW0gDG****', - ], + 'schema' => ['title' => '', 'description' => 'The status of the whiteboard application. Valid values:'."\n" + ."\n" + .'- **1**: Enabled.'."\n" + .'- **2**: Disabled.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'CE47143D-9700-4756-856A-BB22FEBE4DAE', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Result' => [ - 'title' => '返回结果体', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DocumentAccessInfo' => [ - 'title' => '白板连接信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AccessToken' => [ - 'title' => '连接签名', - 'description' => '', - 'type' => 'string', - 'example' => 'qbFPTqipwQZqkGitAoAGbNHuHREm****', - ], - 'CollabHost' => [ - 'title' => '白板长连接地址', - 'description' => '', - 'type' => 'string', - 'example' => 'collab-cn-shanghai.****.com', - ], - 'Permission' => [ - 'title' => '权限码，取值：0:无权限，1:只读，2:读写', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'UserInfo' => [ - 'title' => '用户信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AvatarUrl' => [ - 'title' => '用户头像的URL', - 'description' => '', - 'type' => 'string', - 'example' => 'http://www.avatarset/****.jpg', - ], - 'Nick' => [ - 'title' => '用户昵称', - 'description' => '', - 'type' => 'string', - 'example' => 'Mary', - ], - 'NickPinyin' => [ - 'title' => '用户的拼音昵称', - 'description' => '', - 'type' => 'string', - 'example' => 'Pinyin_Mary', - ], - 'UserId' => [ - 'title' => '打开白板的用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '123456', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], + 'Result' => ['title' => '', 'description' => 'The result information.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CE47143D-9700-4756-856A-BB22FEBE4DAE\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"DocumentAccessInfo\\": {\\n \\"AccessToken\\": \\"qbFPTqipwQZqkGitAoAGbNHuHREm****\\",\\n \\"CollabHost\\": \\"collab-cn-shanghai.****.com\\",\\n \\"Permission\\": 2,\\n \\"UserInfo\\": {\\n \\"AvatarUrl\\": \\"http://www.avatarset/****.jpg\\",\\n \\"Nick\\": \\"Mary\\",\\n \\"NickPinyin\\": \\"Pinyin_Mary\\",\\n \\"UserId\\": \\"123456\\"\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<OpenWhiteBoardResponse>\\n <RequestId>CE47143D-9700-4756-856A-BB22FEBE4DAE</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <Result>\\n <DocumentAccessInfo>\\n <AccessToken>qbFPTqipwQZqkGitAoAGbNHuHREm****</AccessToken>\\n <CollabHost>collab-cn-shanghai.****.com</CollabHost>\\n <Permission>2</Permission>\\n <UserInfo>\\n <AvatarUrl>http://www.avatarset/****.jpg</AvatarUrl>\\n <UserId>123456</UserId>\\n <Nick>Mary</Nick>\\n <NickPinyin>Pinyin_Mary</NickPinyin>\\n </UserInfo>\\n </DocumentAccessInfo>\\n </Result>\\n</OpenWhiteBoardResponse>","errorExample":""}]', - 'title' => 'OpenWhiteBoard', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Set whiteboard application status', + 'description' => '# Operation description'."\n" + ."\n" + .'- Before you invoke this operation, you must have created a whiteboard application by calling [CreateApp](~~204234~~).'."\n" + .'- The interactive whiteboard console is not yet officially online. Use the interactive whiteboard server SDK for related operations on whiteboard applications.'."\n" + ."\n" + .'# QPS limit'."\n" + .'The single-user QPS limit for this operation is 100 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately. For more information, see [QPS limit](~~342798~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeWhiteBoardRecordings' => [ - 'summary' => '分页查询白板录制信息', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2021-01-20T07:34:24.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:SetAppStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppStatus'], + ], ], + ], + 'SetUsersPermissions' => [ + 'summary' => 'Sets long-term permissions for users of a whiteboard document.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'AppID', + 'name' => 'UserIds', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The IDs of the users for whom you want to set permissions. Separate multiple IDs with commas (,). You can specify up to 30 IDs. Each ID consists of digits only.', 'type' => 'string', 'required' => true, 'example' => '100001,100002'], ], [ 'name' => 'DocKey', 'in' => 'formData', - 'schema' => [ - 'title' => '文档唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4EZlwmRW0gDG****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard document. To obtain the DocKey, see [CreateWhiteBoard](~~204299~~).', 'type' => 'string', 'required' => true, 'example' => '4EZlwmRW0gDG****'], ], [ - 'name' => 'PageNum', + 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '第几页，默认查询第1页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the AppID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], ], [ - 'name' => 'PageSize', + 'name' => 'PermissionType', 'in' => 'formData', - 'schema' => [ - 'title' => '每页显示个数，默认为10', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'The user whiteboard permission type. Valid values:'."\n" + ."\n" + .'- **ban**: No permissions.'."\n" + ."\n" + .'- **read**: Read-only.'."\n" + ."\n" + .'- **edit**: Read and write.', 'type' => 'string', 'required' => true, 'example' => 'edit'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'FE22D613-D3C6-4A58-87CA-F21FC85AA08E', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Result' => [ - 'title' => '返回结果体', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RecordingList' => [ - 'title' => '录制信息列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AppID' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'example' => '7mbj****', - ], - 'DocKey' => [ - 'title' => '文档唯一标识符', - 'description' => '', - 'type' => 'string', - 'example' => '4EZlwmRW0gDG****', - ], - 'RecordId' => [ - 'title' => '白板录制Session的唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => '8a4556336bc6456b918e8eedbed6****', - ], - 'UserId' => [ - 'title' => '创建录制的用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '123456', - ], - 'OperateList' => [ - 'title' => '白板录制操作列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'start@1631686505500', - ], - 'example' => '2020-04-10 12:20:30.567', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CFB5E6AA-823B-415B-AA03-4B9892049B68'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], + 'Result' => ['title' => '', 'description' => 'The response result.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"TotalNum\\": 10,\\n \\"TotalPage\\": 1,\\n \\"RecordingList\\": [\\n {\\n \\"AppID\\": \\"7mbj****\\",\\n \\"DocKey\\": \\"4EZlwmRW0gDG****\\",\\n \\"RecordId\\": \\"8a4556336bc6456b918e8eedbed6****\\",\\n \\"UserId\\": \\"123456\\",\\n \\"OperateList\\": [\\n \\"start@1631686505500\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeWhiteBoardRecordingsResponse>\\n <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <ErrorCode>null</ErrorCode>\\n <ErrorMsg>null</ErrorMsg>\\n <Result>\\n <TotalNum>10</TotalNum>\\n <TotalPage>1</TotalPage>\\n <RecordingList>\\n <AppID>7mbj****</AppID>\\n <DocKey>4EZlwmRW0gDG****</DocKey>\\n <RecordId>8a4556336bc6456b918e8eedbed6****</RecordId>\\n <UserId>123456</UserId>\\n <OperateList>start@1631686505500</OperateList>\\n </RecordingList>\\n </Result>\\n</DescribeWhiteBoardRecordingsResponse>","errorExample":""}]', - 'title' => 'DescribeWhiteBoardRecordings', - ], - 'SetUsersPermissions' => [ - 'summary' => '设置用户权限', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CFB5E6AA-823B-415B-AA03-4B9892049B68\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Set user permissions', + 'description' => '# Operation description'."\n" + .'Before you call this operation, you must have called [CreateApp](~~204234~~) and [CreateWhiteBoard](~~204299~~) to create a whiteboard application and a whiteboard document.'."\n" + .'# QPS limit'."\n" + .'The single-user QPS limit for this operation is 200 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately. For more information, see [QPS limit](~~342798~~).', + 'changeSet' => [ + ['createdAt' => '2021-04-21T01:57:09.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:SetUsersPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUsersPermissions'], + ], ], + ], + 'StartWhiteBoardRecording' => [ + 'summary' => 'Starts recording the operation sequence of a whiteboard.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'UserIds', - 'in' => 'formData', - 'schema' => [ - 'title' => '需要设置权限的用户ID，多个用英文逗号（,）分隔，最多30个，每个ID由纯数字组成', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '100001,100002', - ], - ], - [ - 'name' => 'DocKey', + 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '白板文档唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4EZlwmRW0gDG****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the AppID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], ], [ - 'name' => 'AppID', + 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the user (business user) who starts the whiteboard recording. The value is 1 to 32 characters in length and can contain uppercase and lowercase letters, digits, underscores, and hyphens (-).', 'type' => 'string', 'required' => true, 'example' => '123456'], ], [ - 'name' => 'PermissionType', + 'name' => 'DocKey', 'in' => 'formData', - 'schema' => [ - 'title' => '用户白板权限类型，可选值：ban/read/edit', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'edit', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard document. To obtain the DocKey, see [CreateWhiteBoard](~~204299~~).', 'type' => 'string', 'required' => true, 'example' => '4EZlwmRW0gDG****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'CFB5E6AA-823B-415B-AA03-4B9892049B68', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FFE713C6-BBA9-457B-AF9D-F6584279A790'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], 'Result' => [ - 'title' => '返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'RecordId' => ['title' => '', 'description' => 'The unique identifier of the whiteboard recording session.', 'type' => 'string', 'example' => '05157a01cb1d4aca97704fc7a473****'], + 'StartTime' => ['title' => '', 'description' => 'The start time of the recording, represented as a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1622173517031'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CFB5E6AA-823B-415B-AA03-4B9892049B68\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetUsersPermissionsResponse>\\n <RequestId>CFB5E6AA-823B-415B-AA03-4B9892049B68</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <Result>true</Result>\\n</SetUsersPermissionsResponse>","errorExample":""}]', - 'title' => 'SetUsersPermissions', - ], - 'RefreshUsersPermissions' => [ - 'summary' => '刷新用户权限', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FFE713C6-BBA9-457B-AF9D-F6584279A790\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"RecordId\\": \\"05157a01cb1d4aca97704fc7a473****\\",\\n \\"StartTime\\": 1622173517031\\n }\\n}","type":"json"}]', + 'title' => 'Start whiteboard recording', + 'description' => '# Operation description'."\n" + .'Before you call this operation, you must have called [CreateApp](~~204234~~) and [CreateWhiteBoard](~~204299~~) to create a whiteboard application and a whiteboard document.'."\n" + .'# QPS limit'."\n" + .'A single user can call this operation up to 200 times per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation properly. For more information, see [QPS limit](~~342798~~).', + 'changeSet' => [ + ['createdAt' => '2021-05-14T08:47:13.000Z', 'description' => 'OpenAPI offline'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:StartWhiteBoardRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartWhiteBoardRecording'], + ], ], + ], + 'StopWhiteBoardRecording' => [ + 'summary' => 'Stops recording a whiteboard operation sequence.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'UserIds', + 'name' => 'AppID', 'in' => 'formData', - 'schema' => [ - 'title' => '需要刷新权限的用户ID，多个用英文逗号（,）分隔，最多30个，每个ID由纯数字组成', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '100001,100002', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard application. To obtain the AppID, see [CreateApp](~~204234~~).', 'type' => 'string', 'required' => true, 'example' => '7mbj****'], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the user (business user) who stops the whiteboard recording. The value is 1 to 32 characters in length and can contain uppercase letters, lowercase letters, digits, underscores, and hyphens (-).', 'type' => 'string', 'required' => true, 'example' => '123456'], ], [ 'name' => 'DocKey', 'in' => 'formData', - 'schema' => [ - 'title' => '白板文档唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4EZlwmRW0gDG****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard document. To obtain the DocKey, see [CreateWhiteBoard](~~204299~~).', 'type' => 'string', 'required' => true, 'example' => '4EZlwmRW0gDG****'], ], [ - 'name' => 'AppID', + 'name' => 'RecordId', 'in' => 'formData', - 'schema' => [ - 'title' => '白板应用唯一标识符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7mbj****', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the whiteboard recording session. To obtain the RecordId, see [StartWhiteBoardRecording](~~253300~~).', 'type' => 'string', 'required' => true, 'example' => '8a4556336bc6456b918e8eedbed6****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '0E85E1C9-4A68-49E5-965A-22F628B209C6', - ], - 'ResponseSuccess' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C4670A7A-CF1F-4223-BA18-6778FFB2A9E1'], + 'ResponseSuccess' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'null'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'null'], 'Result' => [ - 'title' => '返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'description' => 'The result information.', + 'type' => 'object', + 'properties' => [ + 'StopTime' => ['title' => '', 'description' => 'The time when the recording stopped, expressed as a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1622173532900'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0E85E1C9-4A68-49E5-965A-22F628B209C6\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<RefreshUsersPermissionsResponse>\\n <RequestId>0E85E1C9-4A68-49E5-965A-22F628B209C6</RequestId>\\n <ResponseSuccess>true</ResponseSuccess>\\n <Result>true</Result>\\n</RefreshUsersPermissionsResponse>","errorExample":""}]', - 'title' => 'RefreshUsersPermissions', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C4670A7A-CF1F-4223-BA18-6778FFB2A9E1\\",\\n \\"ResponseSuccess\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMsg\\": \\"null\\",\\n \\"Result\\": {\\n \\"StopTime\\": 1622173532900\\n }\\n}","type":"json"}]', + 'title' => 'Stop whiteboard recording', + 'description' => '# Operation description'."\n" + .'Before you call this operation, you must have called [StartWhiteBoardRecording](~~253300~~) to start whiteboard recording.'."\n" + .'# QPS limit'."\n" + .'A single user can call this operation up to 200 times per second. If the number of calls exceeds the limit, throttling is triggered, which may affect your business. Use this operation as appropriate. For more information, see [QPS limit](~~342798~~).', + 'changeSet' => [ + ['createdAt' => '2021-05-14T08:47:13.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-05-14T08:47:13.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:StopWhiteBoardRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopWhiteBoardRecording'], + ], + ], ], ], - 'endpoints' => [ + 'endpoints' => [], + 'errorCodes' => [], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'OpenWhiteBoard'], + ], + 'createdAt' => '2022-07-07T01:35:21.000Z', + 'description' => 'wsDomain返回值已废弃', + ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'rtc-white-board.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateWhiteBoard'], + ['description' => 'Request parameters changed', 'api' => 'OpenWhiteBoard'], + ['description' => 'OpenAPI offline', 'api' => 'PauseWhiteBoardRecording'], + ['description' => 'OpenAPI offline', 'api' => 'ResumeWhiteBoardRecording'], + ['description' => 'Request parameters changed', 'api' => 'SetAppCallbackUrl'], + ], + 'createdAt' => '2021-05-28T02:35:11.000Z', + 'description' => '支持STS，新增白板操作序列录制暂停/恢复接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'StartWhiteBoardRecording'], + ['description' => 'OpenAPI offline', 'api' => 'StopWhiteBoardRecording'], + ], + 'createdAt' => '2021-05-14T08:48:00.000Z', + 'description' => '增加白板操作录制接口', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeApps'], + ['description' => 'OpenAPI offline', 'api' => 'SetAppCallbackType'], + ], + 'createdAt' => '2021-05-06T08:24:36.000Z', + 'description' => '新增API: SetAppCallbackType', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeApps'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeWhiteBoards'], + ['description' => 'Request parameters changed', 'api' => 'SetAppStatus'], + ], + 'createdAt' => '2021-04-15T06:52:33.000Z', + 'description' => '新增DescribeApps和DescribeWhiteBoards两个查询接口', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApps'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseWhiteBoardRecording'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppCallbackUrl'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartWhiteBoardRecording'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWhiteBoards'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppName'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeWhiteBoardRecording'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppDomainNames'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenWhiteBoard'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshUsersPermissions'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppCallbackType'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApp'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUsersPermissions'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWhiteBoard'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWhiteBoardRecordings'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppStatus'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopWhiteBoardRecording'], + ], + ], + 'ram' => [ + 'productCode' => 'RTC', + 'productName' => 'Real-Time Communication', + 'ramCodes' => ['rtc', 'rtc-white-board'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'CreateApp', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rtc-white-board:CreateApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopWhiteBoardRecording', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:StopWhiteBoardRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartWhiteBoardRecording', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:StartWhiteBoardRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResumeWhiteBoardRecording', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:ResumeWhiteBoardRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetUsersPermissions', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:SetUsersPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeWhiteBoardRecordings', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rtc-white-board:DescribeWhiteBoardRecordings', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateWhiteBoard', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rtc-white-board:CreateWhiteBoard', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OpenWhiteBoard', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rtc-white-board:OpenWhiteBoard', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetAppDomainNames', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:SetAppDomainNames', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetAppCallbackType', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:SetAppCallbackType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RefreshUsersPermissions', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:RefreshUsersPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PauseWhiteBoardRecording', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:PauseWhiteBoardRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetAppName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:SetAppName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeWhiteBoards', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rtc-white-board:DescribeWhiteBoards', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeApps', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rtc-white-board:DescribeApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetAppCallbackUrl', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:SetAppCallbackUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetAppStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rtc-white-board:SetAppStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RTC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; |