'1.0',
'info' => [
'style' => 'RPC',
'product' => 'rtc-white-board',
'version' => '2020-12-14',
],
'directories' => [
[
'id' => 71443,
'title' => null,
'type' => 'directory',
'children' => [
'CreateApp',
'SetAppCallbackUrl',
'SetAppDomainNames',
'SetAppName',
'SetAppStatus',
'SetAppCallbackType',
'DescribeApps',
],
],
[
'id' => 71451,
'title' => null,
'type' => 'directory',
'children' => [
'CreateWhiteBoard',
'StartWhiteBoardRecording',
'StopWhiteBoardRecording',
'PauseWhiteBoardRecording',
'ResumeWhiteBoardRecording',
'DescribeWhiteBoards',
'OpenWhiteBoard',
'DescribeWhiteBoardRecordings',
],
],
[
'id' => 71460,
'title' => null,
'type' => 'directory',
'children' => [
'SetUsersPermissions',
'RefreshUsersPermissions',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateApp' => [
'summary' => '创建白板应用',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
'schema' => [
'title' => '白板应用名，由不超过32位的中文、英文、数字或下划线组成',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'new_whiteboard_app',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'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',
],
'Result' => [
'title' => '返回结果体',
'description' => '',
'type' => 'object',
'properties' => [
'AppID' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'example' => '7mbj****',
],
],
],
],
],
],
],
'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":"\\n 0E2ECCA1-5340-43AE-A1DC-EBD17D3CCE92\\n true\\n \\n 7mbj****\\n \\n","errorExample":""}]',
'title' => 'CreateApp',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetAppCallbackUrl' => [
'summary' => '设置白板应用回调地址',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
[
'name' => 'AppCallbackUrl',
'in' => 'formData',
'schema' => [
'title' => '白板应用回调地址URL',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'http://www.example.com/callback',
],
],
[
'name' => 'AppCallbackAuthKey',
'in' => 'formData',
'schema' => [
'title' => '白板应用回调鉴权码，由8~20位大小写字母、数字或下划线组成',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'CallbackSecret123',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'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',
],
'Result' => [
'title' => '返回结果',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'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":"\\n CFB5E6AA-823B-415B-AA03-4B9892049B68\\n true\\n true\\n","errorExample":""}]',
'title' => 'SetAppCallbackUrl',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetAppDomainNames' => [
'summary' => '设置白板应用合法域名',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
[
'name' => 'AppDomainNames',
'in' => 'formData',
'schema' => [
'title' => '所有会使用到白板应用的客户网站域名，多个使用英文逗号(,)分隔，最多传10个',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'www.example.com',
],
],
],
'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":"\\n D8F8BAFF-B677-4D6A-ADA1-CDB4A2C23330\\n true\\n true\\n","errorExample":""}]',
'title' => 'SetAppDomainNames',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetAppName' => [
'summary' => '设置白板应用名',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
[
'name' => 'AppName',
'in' => 'formData',
'schema' => [
'title' => '白板应用名，由不超过32位的中文、英文、数字或下划线组成',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'new_whiteboard_app',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'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',
],
'Result' => [
'title' => '返回结果',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'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":"\\n C7B4A941-3DC0-4002-95F4-7A7D14A64992\\n true\\n true\\n","errorExample":""}]',
'title' => 'SetAppName',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetAppStatus' => [
'summary' => '设置白板应用状态',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
[
'name' => 'AppStatus',
'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',
],
],
],
],
],
'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":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n true\\n true\\n","errorExample":""}]',
'title' => 'SetAppStatus',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetAppCallbackType' => [
'summary' => '设置白板应用回调类型',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
[
'name' => 'AppCallbackType',
'in' => 'formData',
'schema' => [
'title' => '白板应用回调类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'userPermissionCallback,whiteBoardProfileCallback,userProfileCallback,hostCheckCallback',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'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',
],
'Result' => [
'title' => '返回结果',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'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":"\\n CFB5E6AA-823B-415B-AA03-4B9892049B68\\n true\\n true\\n","errorExample":""}]',
'title' => 'SetAppCallbackType',
],
'DescribeApps' => [
'summary' => '查询应用列表',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符，默认查询所有应用ID',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '7mbj****',
],
],
[
'name' => 'AppStatus',
'in' => 'formData',
'schema' => [
'title' => '白板应用状态，默认查询所有状态。（取值：1:启用，2:停用）',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageNum',
'in' => 'formData',
'schema' => [
'title' => '第几页，默认查询第1页。',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'title' => '每页显示个数，默认为10。',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
],
'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' => 'object',
'properties' => [
'TotalNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '15',
],
'TotalPage' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'AppList' => [
'title' => 'App信息列表',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'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',
],
],
],
],
],
],
],
],
],
],
'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":"\\n 29D20DA7-985D-425E-89BD-26594D327DCC\\n true\\n \\n \\n \\n 15\\n 5\\n \\n http://www.example.com/callback\\n 1\\n zt87****\\n 2021-04-10 16:10:57.217\\n www.example.com\\n 我的APP1\\n userPermissionCallback\\n \\n \\n http://www.example.com/callback\\n 1\\n sf1g****\\n 2021-04-12 15:29:27.315\\n www.example.com\\n 我的APP2\\n userPermissionCallback,whiteBoardProfileCallback\\n \\n \\n http://www.example.com/callback\\n 1\\n 5s77****\\n 2021-04-12 17:00:39.325\\n www.example.com\\n 我的APP3\\n userPermissionCallback,userProfileCallback\\n \\n \\n","errorExample":""}]',
'title' => 'DescribeApps',
],
'CreateWhiteBoard' => [
'summary' => '创建白板文档',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'UserId',
'in' => 'formData',
'schema' => [
'title' => '创建白板的用户ID（客户业务用户），由1~32位大小写字母、数字、下划线、短划线（-）组成',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123456',
],
],
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'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',
],
'Result' => [
'title' => '返回结果体',
'description' => '',
'type' => 'object',
'properties' => [
'DocKey' => [
'title' => '文档唯一标识符，由大小写字母和数字组成',
'description' => '',
'type' => 'string',
'example' => '4EZlwmRW0gDG****',
],
],
],
],
],
],
],
'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":"\\n B29ADDF9-D089-460A-AF7D-BDE5DA112E4E\\n true\\n \\n 4EZlwmRW0gDG****\\n \\n","errorExample":""}]',
'title' => 'CreateWhiteBoard',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'StartWhiteBoardRecording' => [
'summary' => '启动白板录制',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
[
'name' => 'UserId',
'in' => 'formData',
'schema' => [
'title' => '启动白板录制的用户ID（客户业务用户），由1~32位大小写字母、数字、下划线、短划线（-）组成',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123456',
],
],
[
'name' => 'DocKey',
'in' => 'formData',
'schema' => [
'title' => '白板文档唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '4EZlwmRW0gDG****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'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',
],
'Result' => [
'title' => '返回结果体',
'description' => '',
'type' => 'object',
'properties' => [
'RecordId' => [
'title' => '白板录制Session的唯一标识',
'description' => '',
'type' => 'string',
'example' => '05157a01cb1d4aca97704fc7a473****',
],
'StartTime' => [
'title' => '录制开始的UNIX时间戳',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1622173517031',
],
],
],
],
],
],
],
'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":"\\n FFE713C6-BBA9-457B-AF9D-F6584279A790\\n true\\n \\n \\n \\n 1622173517031\\n 05157a01cb1d4aca97704fc7a473****\\n \\n","errorExample":""}]',
'title' => 'StartWhiteBoardRecording',
],
'StopWhiteBoardRecording' => [
'summary' => '结束白板录制',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
[
'name' => 'UserId',
'in' => 'formData',
'schema' => [
'title' => '结束白板录制的用户ID（客户业务用户），由1~32位大小写字母、数字、下划线、短划线（-）组成',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123456',
],
],
[
'name' => 'DocKey',
'in' => 'formData',
'schema' => [
'title' => '白板文档唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '4EZlwmRW0gDG****',
],
],
[
'name' => 'RecordId',
'in' => 'formData',
'schema' => [
'title' => '白板录制Session的唯一标识',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '8a4556336bc6456b918e8eedbed6****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'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',
],
],
],
],
],
],
],
'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":"\\n C4670A7A-CF1F-4223-BA18-6778FFB2A9E1\\n true\\n \\n \\n \\n 1622173532900\\n \\n","errorExample":""}]',
'title' => 'StopWhiteBoardRecording',
],
'PauseWhiteBoardRecording' => [
'summary' => '暂停白板录制',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
[
'name' => 'UserId',
'in' => 'formData',
'schema' => [
'title' => '结束白板录制的用户ID（客户业务用户），由1~32位大小写字母、数字、下划线、短划线（-）组成',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123456',
],
],
[
'name' => 'DocKey',
'in' => 'formData',
'schema' => [
'title' => '白板文档唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '4EZlwmRW0gDG****',
],
],
[
'name' => 'RecordId',
'in' => 'formData',
'schema' => [
'title' => '白板录制Session的唯一标识',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '8a4556336bc6456b918e8eedbed6****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'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',
],
'Result' => [
'title' => '返回结果体',
'description' => '',
'type' => 'object',
'properties' => [
'PauseTime' => [
'title' => '录制结束的UNIX时间戳',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1622173522279',
],
],
],
],
],
],
],
'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":"\\n B62D36BC-C41E-4436-B74B-2D0DB2E9E338\\n true\\n \\n \\n \\n 1622173522279\\n \\n","errorExample":""}]',
'title' => 'PauseWhiteBoardRecording',
],
'ResumeWhiteBoardRecording' => [
'summary' => '恢复白板录制',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
[
'name' => 'UserId',
'in' => 'formData',
'schema' => [
'title' => '结束白板录制的用户ID（客户业务用户），由1~32位大小写字母、数字、下划线、短划线（-）组成',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123456',
],
],
[
'name' => 'DocKey',
'in' => 'formData',
'schema' => [
'title' => '白板文档唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '4EZlwmRW0gDG****',
],
],
[
'name' => 'RecordId',
'in' => 'formData',
'schema' => [
'title' => '白板录制Session的唯一标识',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '8a4556336bc6456b918e8eedbed6****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'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',
],
],
],
],
],
],
],
'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":"\\n ECC1446C-0B06-4A5B-9D5D-0FE60343DA66\\n true\\n \\n \\n \\n 1622173527622\\n \\n","errorExample":""}]',
'title' => 'ResumeWhiteBoardRecording',
],
'DescribeWhiteBoards' => [
'summary' => '查询白板列表',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
[
'name' => 'DocStatus',
'in' => 'formData',
'schema' => [
'title' => '白板文档状态，默认查询所有状态。（取值：1:启用，2:停用）',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageNum',
'in' => 'formData',
'schema' => [
'title' => '第几页，默认查询第1页',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'title' => '每页显示个数，默认为10',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
],
'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' => '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',
],
],
],
],
],
],
],
],
],
],
'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":"\\n AEBD21E4-85D7-4B8D-A51E-F9E01AEEB682\\n true\\n \\n \\n \\n 33\\n 11\\n \\n 1\\n 4j7OJzVEKR8J****\\n p9an****\\n 2021-04-10 14:22:13.647\\n 123456\\n \\n \\n 1\\n XN94MkAb63Bm****\\n p9an****\\n 2021-04-12 14:22:21.492\\n 123456\\n \\n \\n 1\\n 5VLqX472M3Dw****\\n p9an****\\n 2021-04-12 15:07:37.069\\n 123456\\n \\n \\n","errorExample":""}]',
'title' => 'DescribeWhiteBoards',
],
'OpenWhiteBoard' => [
'summary' => '打开白板文档',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
[
'name' => 'UserId',
'in' => 'formData',
'schema' => [
'title' => '打开白板的用户ID（客户业务用户），由1~32位大小写字母、数字、下划线、短划线（-）组成',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123456',
],
],
[
'name' => 'DocKey',
'in' => 'formData',
'schema' => [
'title' => '白板文档唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '4EZlwmRW0gDG****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'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',
],
],
],
],
],
],
],
],
],
],
],
'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":"\\n CE47143D-9700-4756-856A-BB22FEBE4DAE\\n true\\n \\n \\n qbFPTqipwQZqkGitAoAGbNHuHREm****\\n collab-cn-shanghai.****.com\\n 2\\n \\n http://www.avatarset/****.jpg\\n 123456\\n Mary\\n Pinyin_Mary\\n \\n \\n \\n","errorExample":""}]',
'title' => 'OpenWhiteBoard',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeWhiteBoardRecordings' => [
'summary' => '分页查询白板录制信息',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
[
'name' => 'DocKey',
'in' => 'formData',
'schema' => [
'title' => '文档唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '4EZlwmRW0gDG****',
],
],
[
'name' => 'PageNum',
'in' => 'formData',
'schema' => [
'title' => '第几页，默认查询第1页',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'title' => '每页显示个数，默认为10',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
],
'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' => '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',
],
],
],
],
],
],
],
],
],
],
'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":"\\n FE22D613-D3C6-4A58-87CA-F21FC85AA08E\\n true\\n null\\n null\\n \\n 10\\n 1\\n \\n 7mbj****\\n 4EZlwmRW0gDG****\\n 8a4556336bc6456b918e8eedbed6****\\n 123456\\n start@1631686505500\\n \\n \\n","errorExample":""}]',
'title' => 'DescribeWhiteBoardRecordings',
],
'SetUsersPermissions' => [
'summary' => '设置用户权限',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserIds',
'in' => 'formData',
'schema' => [
'title' => '需要设置权限的用户ID，多个用英文逗号（,）分隔，最多30个，每个ID由纯数字组成',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '100001,100002',
],
],
[
'name' => 'DocKey',
'in' => 'formData',
'schema' => [
'title' => '白板文档唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '4EZlwmRW0gDG****',
],
],
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
[
'name' => 'PermissionType',
'in' => 'formData',
'schema' => [
'title' => '用户白板权限类型，可选值：ban/read/edit',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'edit',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'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',
],
'Result' => [
'title' => '返回结果',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'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":"\\n CFB5E6AA-823B-415B-AA03-4B9892049B68\\n true\\n true\\n","errorExample":""}]',
'title' => 'SetUsersPermissions',
],
'RefreshUsersPermissions' => [
'summary' => '刷新用户权限',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserIds',
'in' => 'formData',
'schema' => [
'title' => '需要刷新权限的用户ID，多个用英文逗号（,）分隔，最多30个，每个ID由纯数字组成',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '100001,100002',
],
],
[
'name' => 'DocKey',
'in' => 'formData',
'schema' => [
'title' => '白板文档唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '4EZlwmRW0gDG****',
],
],
[
'name' => 'AppID',
'in' => 'formData',
'schema' => [
'title' => '白板应用唯一标识符',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '7mbj****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'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',
],
'Result' => [
'title' => '返回结果',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'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":"\\n 0E85E1C9-4A68-49E5-965A-22F628B209C6\\n true\\n true\\n","errorExample":""}]',
'title' => 'RefreshUsersPermissions',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
],
'endpoints' => [
[
'regionId' => 'cn-shanghai',
'endpoint' => 'rtc-white-board.cn-shanghai.aliyuncs.com',
],
],
];