diff options
Diffstat (limited to 'data/en_us/rtc/2018-01-11')
| -rw-r--r-- | data/en_us/rtc/2018-01-11/api-docs.php | 29902 |
1 files changed, 29902 insertions, 0 deletions
diff --git a/data/en_us/rtc/2018-01-11/api-docs.php b/data/en_us/rtc/2018-01-11/api-docs.php new file mode 100644 index 0000000..27cc854 --- /dev/null +++ b/data/en_us/rtc/2018-01-11/api-docs.php @@ -0,0 +1,29902 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'rtc', + 'version' => '2018-01-11', + ], + 'directories' => [ + [ + 'id' => 122646, + 'title' => 'Application Management', + 'type' => 'directory', + 'children' => [ + 'ModifyApp', + 'DescribeApps', + 'DescribeAppKey', + ], + ], + [ + 'id' => 194657, + 'title' => 'Layout', + 'type' => 'directory', + 'children' => [ + 'CreateAppLayout', + 'ModifyAppLayout', + 'DeleteAppLayout', + 'DescribeAppLayouts', + 'DescribeSystemLayoutList', + ], + ], + [ + 'id' => 194660, + 'title' => 'Callback Management', + 'type' => 'directory', + 'children' => [ + 'DescribeAppCallStatus', + 'ModifyAppCallbackStatus', + 'DescribeAllCallback', + 'DescribeCallbacks', + 'DescribeAppCallbackSecretKey', + 'ModifyCallbackMeta', + 'StartCategoryCallback', + 'StopCategoryCallback', + ], + ], + [ + 'id' => 189626, + 'title' => 'Channel Management', + 'type' => 'directory', + 'children' => [ + 'DescribeChannels', + 'StopChannel', + 'DescribeChannelAllUsers', + 'DescribeChannelUser', + 'DescribeChannel', + 'RemoveUsers', + ], + ], + [ + 'id' => 189635, + 'title' => 'Cloud Recording', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 194671, + 'title' => 'Recording Template Management', + 'type' => 'directory', + 'children' => [ + 'DescribeAppRecordStatus', + 'ModifyAppRecordStatus', + 'CreateAppRecordTemplate', + 'ModifyAppRecordTemplate', + 'DeleteAppRecordTemplate', + 'DescribeAppRecordTemplates', + ], + ], + [ + 'id' => 199232, + 'title' => 'cloud recording interface', + 'type' => 'directory', + 'children' => [ + 'DescribeCloudRecordStatus', + 'DescribeAppRecordingFiles', + 'StartCloudRecord', + 'UpdateCloudRecord', + 'StopCloudRecord', + ], + ], + ], + ], + [ + 'id' => 189637, + 'title' => 'Bypass Tweet', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 188586, + 'title' => 'Push Flow Template Management', + 'type' => 'directory', + 'children' => [ + 'DescribeAppLiveStreamStatus', + 'ModifyAppLiveStreamStatus', + 'CreateAppStreamingOutTemplate', + 'ModifyAppStreamingOutTemplate', + 'DeleteAppStreamingOutTemplate', + 'DescribeAppStreamingOutTemplates', + ], + ], + [ + 'id' => 199233, + 'title' => 'Bypass push flow interface', + 'type' => 'directory', + 'children' => [ + 'DescribeStreamingOutStatus', + 'StartStreamingOut', + 'UpdateStreamingOut', + 'StopStreamingOut', + ], + ], + ], + ], + [ + 'id' => 199894, + 'title' => 'Minutes', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 208922, + 'title' => 'hot word list', + 'type' => 'directory', + 'children' => [ + 'CreateCloudNotePhrases', + 'ModifyCloudNotePhrases', + 'DescribeCloudNotePhrases', + 'DeleteCloudNotePhrases', + ], + ], + 'StartCloudNote', + 'StartCloudNote', + 'StopCloudNote', + 'DescribeCloudNotes', + ], + ], + [ + 'id' => 223803, + 'title' => 'agent', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 223804, + 'title' => 'Agent Template Management', + 'type' => 'directory', + 'children' => [ + 'DescribeAppAgentFunctionStatus', + 'ModifyAppAgentFunctionStatus', + 'ModifyAppAgentTemplate', + 'DescribeAppAgentTemplates', + 'DeleteAppAgentTemplate', + 'CreateAppAgentTemplate', + ], + ], + [ + 'id' => 223819, + 'title' => 'agent interface', + 'type' => 'directory', + 'children' => [ + 'StartAgent', + 'GetAgent', + 'UpdateAgent', + 'NotifyAgent', + 'StopAgent', + ], + ], + ], + ], + [ + 'id' => 248556, + 'title' => 'SIP', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 309819, + 'title' => 'combined template management', + 'type' => 'directory', + 'children' => [ + 'DescribeAppViewStatus', + 'ModifyAppViewStatus', + 'CreateAppViewTemplate', + 'ModifyAppViewTemplate', + 'DescribeAppViewTemplates', + 'DeleteAppViewTemplate', + ], + ], + [ + 'id' => 321878, + 'title' => 'Task Interface', + 'type' => 'directory', + 'children' => [ + 'RtcSipInviteMember', + 'RtcCancelSipInvite', + 'StartView', + 'StopView', + 'RtcSipMute', + 'ModifyViewLayout', + 'ModifyStreamingProperty', + ], + ], + ], + ], + [ + 'id' => 188246, + 'title' => 'Data Services', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 188247, + 'title' => 'Communication monitoring', + 'type' => 'directory', + 'children' => [ + 'DescribeCallList', + 'DescribeCall', + 'DescribePubUserListBySubUser', + 'DescribeEndPointEventList', + 'DescribeEndPointMetricData', + 'DescribeQoeMetricData', + ], + ], + [ + 'id' => 188544, + 'title' => 'Channel Data', + 'type' => 'directory', + 'children' => [ + 'DescribeChannelOverallData', + 'DescribeChannelDistributionStatData', + 'DescribeChannelAreaDistributionStatData', + 'DescribeChannelTopPubUserList', + 'DescribeChannelUserMetrics', + ], + ], + [ + 'id' => 188550, + 'title' => 'Dosage Statistics', + 'type' => 'directory', + 'children' => [ + 'DescribeUsageOverallData', + 'DescribeUsageDistributionStatData', + 'DescribeUsageAreaDistributionStatData', + 'DescribeUsageOsSdkVersionDistributionStatData', + ], + ], + [ + 'id' => 188555, + 'title' => 'Quality Statistics', + 'type' => 'directory', + 'children' => [ + 'DescribeQualityOverallData', + 'DescribeQualityDistributionStatData', + 'DescribeQualityAreaDistributionStatData', + 'DescribeQualityOsSdkVersionDistributionStatData', + ], + ], + [ + 'id' => 188536, + 'title' => 'Abnormal diagnosis', + 'type' => 'directory', + 'children' => [ + 'DescribeFaultDiagnosisOverallData', + 'DescribeFaultDiagnosisFactorDistributionStat', + 'DescribeFaultDiagnosisUserList', + 'DescribeFaultDiagnosisUserDetail', + ], + ], + ], + ], + [ + 'id' => 190479, + 'title' => 'RTC (Legacy)', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 122624, + 'title' => 'Event Callback (Legacy)', + 'type' => 'directory', + 'children' => [ + 'CreateEventSubscribe', + 'DeleteEventSubscribe', + ], + ], + [ + 'id' => 122600, + 'title' => 'Automatic Bypass One-Way Repush Rule (Old Version)', + 'type' => 'directory', + 'children' => [ + 'CreateAutoLiveStreamRule', + 'DeleteAutoLiveStreamRule', + 'DisableAutoLiveStreamRule', + 'EnableAutoLiveStreamRule', + 'UpdateAutoLiveStreamRule', + 'DescribeAutoLiveStreamRule', + ], + ], + [ + 'id' => 122656, + 'title' => 'Channel Management (Legacy)', + 'type' => 'directory', + 'children' => [ + 'DeleteChannel', + 'DescribeChannelParticipants', + 'DescribeUserInfoInChannel', + 'DescribeChannelUsers', + 'RemoveTerminals', + ], + ], + [ + 'id' => 122762, + 'title' => 'Cloud Recording (Legacy)', + 'type' => 'directory', + 'children' => [ + 'AddRecordTemplate', + 'DeleteRecordTemplate', + 'UpdateRecordTemplate', + 'StartRecordTask', + 'StopRecordTask', + 'UpdateRecordTask', + 'DescribeRecordTemplates', + 'DescribeRecordFiles', + ], + ], + [ + 'id' => 122730, + 'title' => 'Bypass Retro (Legacy)', + 'type' => 'directory', + 'children' => [ + 'StartMPUTask', + 'StopMPUTask', + 'UpdateMPUTask', + 'GetMPUTaskStatus', + ], + ], + [ + 'id' => 122750, + 'title' => 'Layout Management (Legacy)', + 'type' => 'directory', + 'children' => [ + 'CreateMPULayout', + 'DeleteMPULayout', + 'ModifyMPULayout', + 'DescribeMPULayoutInfoList', + ], + ], + [ + 'id' => 122702, + 'title' => 'Data Services (Legacy)', + 'type' => 'directory', + 'children' => [ + 'DescribeRtcDurationData', + 'DescribeRtcUserCntData', + 'DescribeRtcPeakChannelCntData', + 'DescribeRtcChannelList', + 'DescribeRtcChannelMetric', + ], + ], + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ModifyApp' => [ + 'summary' => '修改App信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ioeh****', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'defaultName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidAppId.NotFound', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAppResponse>\\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</ModifyAppResponse>","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"AppId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880exxxx\\"\\n}"}]', + 'title' => 'ModifyApp', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeApps' => [ + 'summary' => 'App列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'AppVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '应用版本。', + 'type' => 'string', + 'example' => '3.0', + 'enum' => [ + '2.0', + '3.0', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6159ba01-6687-4fb2-a831-f0cd8d188648', + ], + 'TotalNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AppList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'App' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AppName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Default AppName', + ], + 'AppId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rgf1****"', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-01-09T02:02:29Z', + ], + 'BillType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'paybyduration', + ], + 'AppType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'universal', + ], + 'ServiceAreas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ServiceArea' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CN', + ], + ], + ], + ], + 'Version' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidAppId.NotFound', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalPage\\": 1,\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C6\\",\\n \\"TotalNum\\": 1,\\n \\"AppList\\": {\\n \\"App\\": [\\n {\\n \\"Status\\": 1,\\n \\"AppName\\": \\"Default AppName\\",\\n \\"AppId\\": \\"rgf1****\\\\\\"\\",\\n \\"CreateTime\\": \\"2020-01-09T02:02:29Z\\",\\n \\"BillType\\": \\"PayByCR\\",\\n \\"AppType\\": \\"universal\\",\\n \\"ServiceAreas\\": {\\n \\"ServiceArea\\": [\\n \\"CN\\"\\n ]\\n },\\n \\"Version\\": \\"3.0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeApps', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAppKey' => [ + 'summary' => '查看AppKey', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '0cho****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '154EF5DE-3D08-1F2C-A482-281F78D74B7C', + ], + 'AppKey' => [ + 'description' => 'AppKey。', + 'type' => 'string', + 'example' => 'ba133b2cee4ab9be424674892c33****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidAppId.NotFound', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"154EF5DE-3D08-1F2C-A482-281F78D74B7C\\",\\n \\"AppKey\\": \\"ba133b2cee4ab9be424674892c33****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeAppKeyResponse>\\n <RequestId>154EF5DE-3D08-1F2C-A482-281F78D74B7C</RequestId>\\n <AppKey>ba133b2cee4ab9be424674892c33****</AppKey>\\n</DescribeAppKeyResponse>","errorExample":""}]', + 'title' => 'DescribeAppKey', + ], + 'CreateAppLayout' => [ + 'summary' => '新增app自定义布局', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '53200b81-b761-4c10-842a-a0726d97xxxx', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'Layout', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '布局', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '布局名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '布局', + 'maxLength' => 100, + ], + 'Panes' => [ + 'title' => '窗格列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体窗格信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ZOrder' => [ + 'title' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'X' => [ + 'title' => '坐标X，归一化百分比。坐标X取值范围：0.0≤X≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.25', + 'default' => '0.25', + ], + 'Y' => [ + 'title' => '坐标Y，归一化百分比。坐标Y取值范围：0.0≤Y≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.25', + 'default' => '0.25', + ], + 'Height' => [ + 'title' => '窗格高，归一化百分比。Height取值范围：0.0<Height≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.25', + 'default' => '0.25', + ], + 'Width' => [ + 'title' => '窗格宽，归一化百分比。Width取值范围：0.0<Width≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.25', + 'default' => '0.25', + ], + 'PaneId' => [ + 'title' => '窗格ID，从0开始。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '15', + 'minimum' => '0', + 'example' => '0', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 16, + 'minItems' => 1, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '20A6D1E3-1F5F-5440-A4F1-EC7831646FE4', + ], + 'LayoutId' => [ + 'title' => '布局ID', + 'description' => '', + 'type' => 'string', + 'example' => '167466539798442****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Quota.Invalid', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20A6D1E3-1F5F-5440-A4F1-EC7831646FE4\\",\\n \\"LayoutId\\": \\"167466539798442****\\"\\n}","type":"json"}]', + ], + 'ModifyAppLayout' => [ + 'summary' => '修改app自定义布局', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '53200b81-b761-4c10-842a-a0726d97xxxx', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'Layout', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '布局', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '布局名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '测试', + 'maxLength' => 100, + ], + 'Panes' => [ + 'title' => '窗格列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '待修改的格子信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ZOrder' => [ + 'title' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'X' => [ + 'title' => '坐标X，归一化百分比。坐标X取值范围：0.0≤X≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.25', + 'default' => '0.25', + ], + 'Y' => [ + 'title' => '坐标Y，归一化百分比。坐标Y取值范围：0.0≤Y≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.25', + 'default' => '0.25', + ], + 'Height' => [ + 'title' => '窗格高，归一化百分比。Height取值范围：0.0<Height≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.25', + 'default' => '0.25', + ], + 'Width' => [ + 'title' => '窗格宽，归一化百分比。Width取值范围：0.0<Width≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.25', + 'default' => '0.25', + ], + 'PaneId' => [ + 'title' => '窗格ID，从0开始。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '15', + 'minimum' => '0', + 'example' => '0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + 'minItems' => 1, + ], + 'LayoutId' => [ + 'title' => '布局ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123121231313', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'LayoutId' => [ + 'title' => '布局ID', + 'description' => '', + 'type' => 'string', + 'example' => '167466539798442****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"LayoutId\\": \\"167466539798442****\\"\\n}","type":"json"}]', + ], + 'DeleteAppLayout' => [ + 'summary' => '删除app自定义布局', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'Layout', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '布局信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LayoutId' => [ + 'title' => '布局ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '167466539798442****', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2DCE8D7E-BE3B-54AB-8DAC-32F34BED0763', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DCE8D7E-BE3B-54AB-8DAC-32F34BED0763\\"\\n}","type":"json"}]', + ], + 'DescribeAppLayouts' => [ + 'summary' => '查询app自定义布局', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'title' => '页码，默认1。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页数量，默认10。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Condition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '查询条件。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LayoutId' => [ + 'title' => '布局ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '167466539798442****', + ], + 'Name' => [ + 'title' => '布局名称。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalPage' => [ + 'title' => '总页数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'TotalNum' => [ + 'title' => '总数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Layouts' => [ + 'title' => '布局列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LayoutId' => [ + 'title' => '布局ID。', + 'description' => '', + 'type' => 'string', + 'example' => '167466539798442****', + ], + 'Name' => [ + 'title' => '布局名称。', + 'description' => '', + 'type' => 'string', + 'example' => '测试', + ], + 'Panes' => [ + 'title' => '窗格列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'title' => '窗格宽，归一化百分比。Width取值范围：0.0<Width≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.25', + ], + 'Height' => [ + 'title' => '窗格高，归一化百分比。Height取值范围：0.0<Height≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.25', + ], + 'Y' => [ + 'title' => '坐标Y，归一化百分比。坐标Y取值范围：0.0≤Y≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.25', + ], + 'PaneId' => [ + 'title' => '窗格ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ZOrder' => [ + 'title' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'X' => [ + 'title' => '坐标X，归一化百分比。坐标X取值范围：0.0≤X≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.25', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalPage\\": 1,\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"TotalNum\\": 10,\\n \\"Layouts\\": [\\n {\\n \\"LayoutId\\": \\"167466539798442****\\",\\n \\"Name\\": \\"测试\\",\\n \\"Panes\\": [\\n {\\n \\"Width\\": 0.25,\\n \\"Height\\": 0.25,\\n \\"Y\\": 0.25,\\n \\"PaneId\\": 0,\\n \\"ZOrder\\": 0,\\n \\"X\\": 0.25\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeSystemLayoutList' => [ + 'summary' => '系统内置布局', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'title' => '页码。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页总数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalPage' => [ + 'title' => '总数目。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'TotalNum' => [ + 'title' => '总页数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'Layouts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Layout' => [ + 'title' => '布局列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LayoutId' => [ + 'title' => '布局ID。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'Name' => [ + 'title' => '布局名称。', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'AudioMixCount' => [ + 'description' => 'AudioMixCount。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Panes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Panes' => [ + 'title' => '窗格列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MajorPane' => [ + 'description' => 'MajorPane。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Width' => [ + 'title' => '窗格宽，归一化百分比。Width取值范围：0.0<Width≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.25', + ], + 'Height' => [ + 'title' => '窗格高，归一化百分比。Height取值范围：0.0<Height≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.25', + ], + 'Y' => [ + 'title' => '坐标Y，归一化百分比。坐标Y取值范围：0.0≤Y≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.25', + ], + 'PaneId' => [ + 'title' => '窗格ID。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ZOrder' => [ + 'title' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'X' => [ + 'title' => '坐标X，归一化百分比。坐标X取值范围：0.0≤X≤1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.25', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalPage\\": 2,\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"TotalNum\\": 6,\\n \\"Layouts\\": {\\n \\"Layout\\": [\\n {\\n \\"LayoutId\\": 22,\\n \\"Name\\": \\"评标录屏模板\\",\\n \\"AudioMixCount\\": 3,\\n \\"Panes\\": {\\n \\"Panes\\": [\\n {\\n \\"MajorPane\\": 0,\\n \\"Width\\": 0.25,\\n \\"Height\\": 0.25,\\n \\"Y\\": 0.25,\\n \\"PaneId\\": 0,\\n \\"ZOrder\\": 0,\\n \\"X\\": 0.25\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeAppCallStatus' => [ + 'summary' => '查看app回调开关', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '223***JQb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '20A6D1E3-1F5F-5440-A4F1-EC7831646FE4', + ], + 'Result' => [ + 'title' => '回调状态；enable-开启 disable-关闭。', + 'description' => '', + 'type' => 'string', + 'example' => 'enable', + 'enum' => [], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20A6D1E3-1F5F-5440-A4F1-EC7831646FE4\\",\\n \\"Result\\": \\"enable\\"\\n}","type":"json"}]', + ], + 'ModifyAppCallbackStatus' => [ + 'summary' => '更新app回调事件开关', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '223***JQb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F80AAC02-87BD-5D9C-B925-8AB40171BA1A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F80AAC02-87BD-5D9C-B925-8AB40171BA1A\\"\\n}","type":"json"}]', + ], + 'DescribeAllCallback' => [ + 'summary' => '列出系统支持的事件回调', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'Callbacks' => [ + 'title' => '回调事件列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '事件名称。', + 'description' => '', + 'type' => 'string', + 'example' => '录制回调', + ], + 'Category' => [ + 'title' => '事件Code。', + 'description' => '', + 'type' => 'string', + 'example' => 'RecordEvent', + ], + 'SubEvent' => [ + 'title' => '订阅的子事件列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Event' => [ + 'title' => '订阅子事件代号。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'Type' => [ + 'title' => '订阅事件类型：0-系统 1-自定义。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EventName' => [ + 'title' => '订阅子事件名称。', + 'description' => '', + 'type' => 'string', + 'example' => '录制开始', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"Callbacks\\": [\\n {\\n \\"Name\\": \\"录制回调\\",\\n \\"Category\\": \\"RecordEvent\\",\\n \\"SubEvent\\": [\\n {\\n \\"Event\\": 2000,\\n \\"Type\\": 0,\\n \\"EventName\\": \\"录制开始\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeCallbacks' => [ + 'summary' => 'app事件回调列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '223***JQb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'Callbacks' => [ + 'title' => '应用订阅事件列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Conf' => [ + 'title' => '回调地址。', + 'description' => '', + 'type' => 'string', + 'example' => 'https://www.aliyun.com', + ], + 'Status' => [ + 'title' => '回调状态；0-启用 1-不启用。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'enum' => [], + ], + 'Category' => [ + 'title' => '回调code。', + 'description' => '', + 'type' => 'string', + 'example' => 'RecordEvent', + ], + 'Code' => [ + 'title' => '回调验证code。', + 'description' => '', + 'type' => 'string', + 'example' => 'RESPONSE_INVALID', + ], + 'Msg' => [ + 'title' => '回调验证message。', + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'CheckStatus' => [ + 'title' => '回调验证状态：0-验证中 1-验证成功 2-验证失败。', + 'description' => '', + 'type' => 'string', + 'example' => '1', + 'enum' => [], + ], + 'SubEvent' => [ + 'title' => '子事件，具体可参考回调概述。'."\n" + .'录制事件：'."\n" + .'- **2010**：录制服务状态变化。'."\n" + .'- **2011**：录制音频流状态变化。'."\n" + .'- **2012**：录制视频流状态变化。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2010', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"Callbacks\\": [\\n {\\n \\"Conf\\": \\"https://www.aliyun.com\\",\\n \\"Status\\": 1,\\n \\"Category\\": \\"RecordEvent\\",\\n \\"Code\\": \\"RESPONSE_INVALID\\",\\n \\"Msg\\": \\"Success\\",\\n \\"CheckStatus\\": \\"1\\",\\n \\"SubEvent\\": [\\n 2010\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAppCallbackSecretKey' => [ + 'summary' => '获取app回调密钥', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '9qb1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'CallbackSecretKey' => [ + 'title' => '回调密钥。', + 'description' => '', + 'type' => 'string', + 'example' => 'a656b296a30xxxxxxxxxx1cd4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"CallbackSecretKey\\": \\"a656b296a30xxxxxxxxxx1cd4\\"\\n}","type":"json"}]', + ], + 'ModifyCallbackMeta' => [ + 'summary' => '更新app回调', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '223***JQb', + ], + ], + [ + 'name' => 'Callback', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '回调配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => '回调code。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'RecordEvent', + ], + 'Conf' => [ + 'title' => '回调地址。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'https://www.aliyun.com', + ], + 'SubEvent' => [ + 'title' => '子事件。'."\n" + .'录制事件：'."\n" + .'- **2010**：录制服务状态变化。'."\n" + .'- **2011**：录制音频流状态变化。'."\n" + .'- **2012**：录制视频流状态变化。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体订阅子事件code。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2011', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => 'message', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'requestId', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + 'HttpStatusCode' => [ + 'title' => 'httpStatusCode', + 'description' => 'httpStatusCode', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Code' => [ + 'title' => 'code', + 'description' => 'code', + 'type' => 'string', + 'example' => '0', + ], + 'Success' => [ + 'title' => 'success', + 'description' => 'success', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'StartCategoryCallback' => [ + 'summary' => '开启某个事件回调', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '223***JQb', + ], + ], + [ + 'name' => 'Callback', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => '回调code。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'RecordEvent', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', + ], + 'StopCategoryCallback' => [ + 'summary' => '关闭某个事件回调', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '223***JQb', + ], + ], + [ + 'name' => 'Callback', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => '回调code。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'RecordEvent', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2DCE8D7E-BE3B-54AB-8DAC-32F34BED0763', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DCE8D7E-BE3B-54AB-8DAC-32F34BED0763\\"\\n}","type":"json"}]', + ], + 'DescribeChannels' => [ + 'summary' => '查询在线频道列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'AppID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + 'maxLength' => 11, + 'minLength' => 8, + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页数量。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + 'PageNo' => [ + 'title' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + 'PageSize' => [ + 'title' => '每页数量。', + 'type' => 'integer', + 'format' => 'int32', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + 'TotalCnt' => [ + 'title' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Records' => [ + 'title' => '在线频道列表。', + 'type' => 'array', + 'items' => [ + 'title' => '具体的在线频道列表。', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCnt\\": 1,\\n \\"Records\\": [\\n \\"test\\"\\n ]\\n}","type":"json"}]', + ], + 'StopChannel' => [ + 'summary' => '删除频道', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', + ], + 'DescribeChannelAllUsers' => [ + 'summary' => '查询频道的所有参会者', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '待查询的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + 'Users' => [ + 'title' => '频道内在线的用户列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'example' => '1811****', + ], + ], + ], + ], + 'ChannelExist' => [ + 'title' => '频道是否存在，取值：'."\n" + .'● true：存在。'."\n" + .'● false：不存在。', + 'description' => '', + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\",\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"1811****\\"\\n }\\n ],\\n \\"ChannelExist\\": true\\n}","type":"json"}]', + ], + 'DescribeChannelUser' => [ + 'summary' => 'DescribeChannelUser', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '待查询的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1811****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + 'InChannel' => [ + 'title' => '用户当前是否在频道内，取值：'."\n" + .'● true：在频道内。'."\n" + .'● false：不在频道内。', + 'description' => '', + 'type' => 'boolean', + ], + 'Sessions' => [ + 'title' => '会话信息列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'example' => '1811****', + ], + 'SessionId' => [ + 'title' => '会话ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'xa744sxx8rtobgj****', + ], + 'Joined' => [ + 'title' => '用户进入频道的秒级时间戳（UTC时间）。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1557909133', + ], + ], + ], + ], + 'ChannelExist' => [ + 'title' => '频道是否存在，取值：'."\n" + .'● true：存在。'."\n" + .'● false：不存在。', + 'description' => '', + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\",\\n \\"InChannel\\": true,\\n \\"Sessions\\": [\\n {\\n \\"UserId\\": \\"1811****\\",\\n \\"SessionId\\": \\"xa744sxx8rtobgj****\\",\\n \\"Joined\\": 1557909133\\n }\\n ],\\n \\"ChannelExist\\": true\\n}","type":"json"}]', + ], + 'DescribeChannel' => [ + 'summary' => 'DescribeChannel', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '待查询的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + 'Channel' => [ + 'title' => 'channel', + 'description' => 'channel', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'title' => '频道开始的秒级时间戳（UTC时间）。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1557909133', + ], + 'ChannelId' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'testid', + ], + ], + ], + 'ChannelExist' => [ + 'title' => '频道是否存在，取值：'."\n" + .'● true：存在。'."\n" + .'● false：不存在。', + 'description' => '', + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\",\\n \\"Channel\\": {\\n \\"StartTime\\": 1557909133,\\n \\"ChannelId\\": \\"testid\\"\\n },\\n \\"ChannelExist\\": true\\n}","type":"json"}]', + ], + 'RemoveUsers' => [ + 'summary' => 'RemoveUsers', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已加入的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'Users', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '用户列表，N的取值：1～30。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1811****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 30, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + 'Users' => [ + 'title' => '用户列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '状态码，成功返回0，失败返回错误码描述。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'UserId' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'example' => '1811****', + ], + 'Message' => [ + 'title' => '删除终端操作结果。取值：'."\n" + .'● Success：成功。'."\n" + .'● Failed：失败。', + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\",\\n \\"Users\\": [\\n {\\n \\"Code\\": 0,\\n \\"UserId\\": \\"1811****\\",\\n \\"Message\\": \\"Success\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAppRecordStatus' => [ + 'summary' => '查询应用录制开关', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'Result' => [ + 'title' => '开关状态；enable-开启 disable-关闭。', + 'description' => '', + 'type' => 'string', + 'example' => 'disable', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"Result\\": \\"disable\\"\\n}","type":"json"}]', + ], + 'ModifyAppRecordStatus' => [ + 'summary' => '修改应用录制开关', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '53200b81-b761-4c10-842a-a0726xxxx', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'D53303DB-AA68-5D09-90C2-A345072DCC5A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D53303DB-AA68-5D09-90C2-A345072DCC5A\\"\\n}","type":"json"}]', + ], + 'CreateAppRecordTemplate' => [ + 'summary' => '增加应用录制模版', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'RecordTemplate', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '模版', + ], + 'FilePrefix' => [ + 'title' => '录制文件命名规则。'."\n" + .'> 为确保录制的文件名称唯一，目前录制文件的命名规则为record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}', + 'default' => 'record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}', + ], + 'FileSplitInterval' => [ + 'title' => '录制文件切割时长（大于等于1800）。单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '20000', + 'minimum' => '1800', + 'example' => '1800', + 'default' => '1800', + ], + 'DelayStopTime' => [ + 'title' => '延时停止录制的时间。单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '300', + 'minimum' => '180', + 'example' => '180', + 'default' => '180', + ], + 'MediaEncode' => [ + 'title' => '编码选项。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'default' => '1', + 'enum' => [ + '1', + '54', + '53', + '52', + '10', + '20', + '22', + '23', + '30', + '31', + '24', + '25', + '26', + '27', + '28', + '32', + '33', + '34', + '35', + '36', + '37', + '38', + '39', + '40', + '41', + '42', + '43', + '0', + ], + ], + 'Formats' => [ + 'title' => '录制文件格式。当前文件格式仅支持：.m3u8、.mp4、.flv。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mp4', + ], + 'required' => true, + 'maxItems' => 1, + 'minItems' => 1, + ], + 'LayoutIds' => [ + 'title' => '布局ID列表，最多16个。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 16, + 'minItems' => 1, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + 'TemplateId' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'lD7muaxx', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Function.Disable', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Quota.Invalid', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\",\\n \\"TemplateId\\": \\"lD7muaxx\\"\\n}","type":"json"}]', + ], + 'ModifyAppRecordTemplate' => [ + 'summary' => '修改应用录制模版', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '53200b81-b761-4c10-842a-a0726d97xxxx', + ], + ], + [ + 'name' => 'RecordTemplate', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '模版', + ], + 'FilePrefix' => [ + 'title' => '录制文件命名规则。'."\n" + .'> 为确保录制的文件名称唯一，目前录制文件的命名规则为record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}', + 'default' => 'record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}', + ], + 'FileSplitInterval' => [ + 'title' => '录制文件切割时长（大于等于1800）。单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '20000', + 'minimum' => '1800', + 'example' => '1800', + ], + 'DelayStopTime' => [ + 'title' => '延时停止录制的时间。单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '300', + 'minimum' => '180', + 'example' => '180', + 'default' => '180', + ], + 'MediaEncode' => [ + 'title' => '编码选项。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'default' => '1', + 'enum' => [ + '1', + '54', + '53', + '52', + '10', + '20', + '22', + '23', + '30', + '31', + '24', + '25', + '26', + '27', + '28', + '32', + '33', + '34', + '35', + '36', + '37', + '38', + '39', + '40', + '41', + '42', + '43', + '0', + ], + ], + 'Formats' => [ + 'title' => '录制文件格式。当前文件格式仅支持：.m3u8、.mp4、.flv。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mp4', + ], + 'required' => true, + 'maxItems' => 1, + 'minItems' => 1, + ], + 'LayoutIds' => [ + 'title' => '布局ID列表，最多16个。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + 'required' => true, + 'maxItems' => 16, + 'minItems' => 1, + ], + 'TemplateId' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2xh6****', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Function.Disable', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Quota.Invalid', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","type":"json"}]', + ], + 'DeleteAppRecordTemplate' => [ + 'summary' => '删除应用录制模版', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '53200b81-b761-4c10-842a-a0726d97xxxx', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2xh6****', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Function.Disable', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Quota.Invalid', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","type":"json"}]', + ], + 'DescribeAppRecordTemplates' => [ + 'summary' => '应用录制模版列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，默认查询第1页。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页显示个数，默认为10。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Condition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '查询条件。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ac7N****', + ], + 'Name' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2A7497D0-BEAE-58E7-B13A-751BD8EAE4C6', + ], + 'TotalNum' => [ + 'title' => '记录数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalPage' => [ + 'title' => '分页数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Templates' => [ + 'title' => '模版列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'wv7N****', + ], + 'Name' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'example' => '测试', + ], + 'FilePrefix' => [ + 'title' => '录制文件命名规则。'."\n" + .'> 为确保录制的文件名称唯一，目前录制文件的命名规则为record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}。', + 'description' => '', + 'type' => 'string', + 'example' => 'record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}', + ], + 'FileSplitInterval' => [ + 'title' => '录制文件切割时长（大于等于1800）单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1800', + ], + 'DelayStopTime' => [ + 'title' => '延时停止录制的时间单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '180', + 'default' => '180', + ], + 'CreateTime' => [ + 'title' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'description' => '', + 'type' => 'string', + 'format' => 'byte', + 'example' => '2020-09-04T06:22:15Z', + ], + 'MediaEncode' => [ + 'title' => '编码选项。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LayoutIds' => [ + 'title' => '布局ID列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'format' => 'int64', + 'example' => '22', + ], + ], + 'Formats' => [ + 'title' => '录制文件格式。当前文件格式仅支持：.m3u8、.mp4、.flv。'."\n" + .'> 文件格式仅支持小写。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mp4', + ], + 'minItems' => 1, + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A7497D0-BEAE-58E7-B13A-751BD8EAE4C6\\",\\n \\"TotalNum\\": 10,\\n \\"TotalPage\\": 1,\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"wv7N****\\",\\n \\"Name\\": \\"测试\\",\\n \\"FilePrefix\\": \\"record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"FileSplitInterval\\": 1800,\\n \\"DelayStopTime\\": 180,\\n \\"CreateTime\\": \\"2020-09-04T06:22:15Z\\",\\n \\"MediaEncode\\": 1,\\n \\"LayoutIds\\": [\\n \\"22\\"\\n ],\\n \\"Formats\\": [\\n \\"mp4\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeCloudRecordStatus' => [ + 'summary' => '查询录制任务状态', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1qaz***x', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道名。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testChannel', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'taskId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + 'Status' => [ + 'title' => '- 100: 任务暂未开始'."\n" + .'- 101: 录制中'."\n" + .'- 102: 录制文件上传中'."\n" + .'- 200: 录制完成（频道结束）'."\n" + .'- 201: 录制完成（用户停止）'."\n" + .'- 400: 录制失败（服务器内部错误）'."\n" + .'- 401: 录制失败（写入用户存储失败）'."\n" + .'- 402: 录制失败（启动用户存储失败）'."\n" + .'- 403: 录制失败（录制时间过短）'."\n" + .'- 404: 录制失败（用户存储密钥错误）'."\n" + .'- 405: 录制失败（bucket不存在）'."\n" + .'- 406: 录制失败（访问用户存储被拒绝）'."\n" + ."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\",\\n \\"Status\\": 1\\n}","type":"json"}]', + ], + 'DescribeAppRecordingFiles' => [ + 'summary' => '查询录制列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testappid', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '311', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '页码。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'title' => '查询范围，录制任务开始时间开区间，单位：ms。如果不传，默认查询3天内，最长查询过去一年的录制文件。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1712376032000', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'title' => '查询范围，录制任务开始时间闭区间，单位：ms。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1712376532000', + ], + ], + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '录制任务TaskId列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体任务ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'task001', + ], + 'required' => false, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + 'PageNo' => [ + 'title' => '页码。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'example' => '10', + 'default' => '10', + ], + 'TotalCnt' => [ + 'title' => '总数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Items' => [ + 'title' => '录制文件列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'testchannelId', + ], + 'TaskId' => [ + 'title' => '录制任务ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'test001', + ], + 'FilePath' => [ + 'title' => '录制文件存放路径。', + 'description' => '', + 'type' => 'string', + 'example' => 'record/appid/12_task_local1/1712279809158_1712279844691/playlist.mp4', + ], + 'FileSize' => [ + 'title' => '录制文件大小，单位：Byte。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'FileDuration' => [ + 'title' => '录制文件时长，单位：ms。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Vendor' => [ + 'title' => '参考开启录制任务vendor。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Region' => [ + 'title' => '参考录制任务region。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Bucket' => [ + 'title' => '用户自定义的bucket。', + 'description' => '', + 'type' => 'string', + 'example' => 'rtc-bucket', + ], + 'StartTs' => [ + 'title' => '录制任务开始时间戳，单位：ms。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1712376012000', + ], + 'FileCreateTs' => [ + 'title' => '录制文件生成时间戳，单位：ms。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1712376032000', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCnt\\": 10,\\n \\"Items\\": [\\n {\\n \\"ChannelId\\": \\"testchannelId\\",\\n \\"TaskId\\": \\"test001\\",\\n \\"FilePath\\": \\"record/appid/12_task_local1/1712279809158_1712279844691/playlist.mp4\\",\\n \\"FileSize\\": 10000,\\n \\"FileDuration\\": 200,\\n \\"Vendor\\": 1,\\n \\"Region\\": 1,\\n \\"Bucket\\": \\"rtc-bucket\\",\\n \\"StartTs\\": 1712376012000,\\n \\"FileCreateTs\\": 1712376032000\\n }\\n ]\\n}","type":"json"}]', + ], + 'StartCloudRecord' => [ + 'summary' => 'StartCloudRecord', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => 'appId', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的频道ID，仅支持传单个ID。', + 'description' => 'channelName', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模版ID，最长128位。', + 'description' => 'templateId', + 'type' => 'string', + 'required' => true, + 'example' => '567', + 'maxLength' => 128, + 'minLength' => 1, + 'pattern' => '^[\\w.-]+$', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '本次云端录制的任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', + 'description' => 'taskId', + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 55, + 'minLength' => 1, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + [ + 'name' => 'CropMode', + 'in' => 'query', + 'schema' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边（默认值）。'."\n" + .'- **3**：拉伸铺满。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'default' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'ReservePaneForNoCameraUser', + 'in' => 'query', + 'schema' => [ + 'title' => '未推摄像头流用户窗格占位。'."\n" + .'默认为true，表示用户未推摄像头流时保留一个窗格。'."\n" + .'为false时，表示用户未推摄像头流时不保留窗格。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'ShowDefaultBackgroundOnMute', + 'in' => 'query', + 'schema' => [ + 'title' => 'mute时是否显示窗格默认底图。'."\n" + .'- true: 显示（默认值）'."\n" + .'- false: 不显示（设置的局部窗格底图依然显示）', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'SubHighResolutionStream', + 'in' => 'query', + 'schema' => [ + 'title' => '订阅高分辨率流。'."\n" + .'- false：根据窗格面积订阅不同分辨率的流。（默认值）'."\n" + .'- true：默认用客户端推的最高分辨率的流进行填充。', + 'type' => 'boolean', + 'default' => 'false', + ], + ], + [ + 'name' => 'StartWithoutChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '是否允许频道不存在时开启任务。'."\n" + ."\n" + .'- true: 是'."\n" + .'- false: 否（默认值）', + 'type' => 'boolean', + 'default' => 'false', + ], + ], + [ + 'name' => 'StartWithoutChannelWaitTime', + 'in' => 'query', + 'schema' => [ + 'title' => '当StartWithoutChannel参数为true的时候，设置该值才有意义，表示房间未开启时，任务等待时长，单位为秒，区间限制为[30,120]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'Annotation', + 'in' => 'query', + 'schema' => [ + 'title' => '标注开关。', + 'type' => 'string', + 'example' => 'disable', + 'default' => 'enable', + 'enum' => [ + 'disable', + 'enable', + ], + ], + ], + [ + 'name' => 'StorageConfig', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '存储配置', + 'description' => 'storageConfig', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'title' => '存储平台。取值：'."\n" + ."\n" + .'| vendor | 对象存储产品 | 备注 |'."\n" + .'|--------|---------|---------|'."\n" + .'| 1 | AliYun OSS | 阿里云 |'."\n" + .'| 2| AliYun 专有云OSS | 阿里云专有云 |', + 'description' => 'vendor', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + 'Region' => [ + 'title' => '存储地域。'."\n" + ."\n" + .'| Region | AliYun OSS |'."\n" + .'|--------|------------|'."\n" + .'| 0 | CN_Hangzhou |'."\n" + .'| 1 | CN_Shanghai |'."\n" + .'| 2 | CN_Qingdao |'."\n" + .'| 3 | CN_Beijing |'."\n" + .'| 4 | CN_Zhangjiakou |'."\n" + .'| 5 | CN_Huhehaote |'."\n" + .'| 6 | CN_Shenzhen |'."\n" + .'| 7 | CN_Hongkong |'."\n" + .'| 8 | US_West_1 |'."\n" + .'| 9 | US_East_1 |'."\n" + .'| 10 | AP_Southeast_1 |'."\n" + .'| 11 | AP_Southeast_2 |'."\n" + .'| 12 | AP_Southeast_3 |'."\n" + .'| 13 | AP_Southeast_5 |'."\n" + .'| 14 | AP_Northeast_1 |'."\n" + .'| 15 | AP_South_1 |'."\n" + .'| 16 | EU_Central_1 |'."\n" + .'| 17 | EU_West_1 |'."\n" + .'| 18 | EU_East_1(ME_East_1) |'."\n" + .'| 19 | AP_Southeast_6 |'."\n" + .'| 20 | CN_Heyuan |'."\n" + .'| 21 | CN_Guangzhou |'."\n" + .'| 22 | CN_Chengdu |'."\n" + .'| 23 | CN_Nanjing |'."\n" + .'| 24 | CN_Fuzhou |'."\n" + .'| 25 | CN_Wulanchabu |'."\n" + .'| 26 | CN_Northeast_2 |'."\n" + .'| 27 | CN_Southeast_7 |'."\n" + ."\n\n" + .'| Region | AliYun 专有云OSS |'."\n" + .'|--------|------------|'."\n" + .'| 0 | default|'."\n", + 'description' => 'region', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + 'Bucket' => [ + 'title' => '存储桶名称', + 'description' => 'bucket', + 'type' => 'string', + 'required' => true, + 'example' => 'test-bucket-for-recording', + 'minLength' => 1, + ], + 'AccessKey' => [ + 'title' => 'accessKey', + 'description' => 'accessKey', + 'type' => 'string', + 'required' => true, + 'example' => 'LTAX***', + 'minLength' => 1, + ], + 'SecretKey' => [ + 'title' => 'secretKey', + 'description' => 'secretKey', + 'type' => 'string', + 'required' => true, + 'example' => 'APb6qWYEzKtYxE***', + 'minLength' => 1, + ], + 'Endpoint' => [ + 'title' => '专有云时，私网连接地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://aliyuns.dalian.oss.com', + 'minLength' => 1, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Panes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '单元格设置，做多设置16个。', + 'description' => 'panes', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VideoOrder' => [ + 'title' => 'SourceType为video时，填充顺序。'."\n" + ."\n" + .'- screenFirst，屏幕共享优先（默认值）'."\n" + .'- cameraFirst，摄像头优先', + 'type' => 'string', + 'required' => false, + 'example' => 'cameraFirst', + 'default' => 'screenFirst', + 'enum' => [ + 'cameraFirst', + 'screenFirst', + ], + ], + 'SourceType' => [ + 'title' => '单元格媒体类型。取值：'."\n" + .'- **video**：用户摄像头或者屏幕共享流（默认值）。'."\n" + .'- **camera**：摄像头流。'."\n" + .'- **screen**：共享屏幕流。'."\n" + .'- **whiteboard**：白板。', + 'description' => 'sourceType', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + 'default' => 'video', + 'enum' => [ + 'video', + 'camera', + 'screen', + 'whiteboard', + ], + ], + 'Images' => [ + 'title' => '窗格局部图片水印。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PaneImageCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Height' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Width' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123xx.jpg', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'Display' => [ + 'title' => '水印显示时机。'."\n" + .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" + .'- backup：当前用户无视频流时显示。'."\n" + .'- always：总是显示。', + 'type' => 'string', + 'example' => 'backup', + 'default' => 'streamOnly', + 'enum' => [ + 'streamOnly', + 'backup', + 'always', + ], + ], + ], + ], + 'maxItems' => 3, + ], + 'Texts' => [ + 'title' => '窗格局部文字水印。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'default' => '5', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + ], + ], + 'Texture' => [ + 'title' => '水印内容。', + 'type' => 'string', + 'required' => true, + 'example' => '文字水印', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + ], + ], + 'FontSize' => [ + 'title' => '字体大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '36', + 'default' => '30', + ], + 'Alpha' => [ + 'title' => '水印透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + 'default' => '1', + ], + 'X' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'type' => 'boolean', + 'default' => 'false', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.6', + 'default' => '0.6', + ], + 'Display' => [ + 'title' => '水印显示时机。'."\n" + .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" + .'- backup：当前用户无视频流时显示。'."\n" + .'- always：总是显示。', + 'type' => 'string', + 'example' => 'backup', + 'default' => 'streamOnly', + 'enum' => [ + 'streamOnly', + 'backup', + 'always', + ], + ], + ], + ], + 'maxItems' => 3, + ], + 'PaneCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'PaneId' => [ + 'title' => '窗格ID，从0开始。', + 'description' => 'paneId', + 'type' => 'integer', + 'required' => true, + 'format' => 'int32', + 'example' => '0', + ], + 'Source' => [ + 'title' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" + .' - ** $ActiveSpeaker**：当前频道发言人'."\n" + .' - **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', + 'description' => 'source', + 'type' => 'string', + 'required' => false, + ], + 'Backgrounds' => [ + 'title' => '窗格局部背景图片。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'PaneBackgroundCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Height' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Width' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123xx.jpg', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'Display' => [ + 'title' => '水印显示时机。'."\n" + .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" + .'- backup：当前用户无视频流时显示。'."\n" + .'- always：总是显示。', + 'type' => 'string', + 'example' => 'backup', + 'default' => 'streamOnly', + 'enum' => [ + 'streamOnly', + 'backup', + 'always', + ], + ], + ], + ], + 'maxItems' => 3, + ], + 'Whiteboard' => [ + 'title' => '白板设置。', + 'type' => 'object', + 'properties' => [ + 'WhiteboardId' => [ + 'title' => '白板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'default' => 'default', + ], + ], + ], + 'ReservePaneForOfflineUser' => [ + 'title' => '未入会用户窗格占位。'."\n" + .'默认为true，表示宫格指定的具体用户或通配符用户离线时，窗格强制占位。'."\n" + .'为false时，表示宫格指定的具体用户或通配符用户离线时，将按自动填充顺序显示视频流。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'Images', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局图片水印。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.3', + ], + 'Height' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'ImageCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Width' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123xxx.jpg', + 'maxLength' => 1024, + 'minLength' => 1, + ], + ], + ], + 'maxItems' => 3, + ], + ], + [ + 'name' => 'Backgrounds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '背景图片。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackgroundCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '横坐标。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'title' => '纵坐标。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Height' => [ + 'title' => '高。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Width' => [ + 'title' => '宽。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123.jpg', + 'maxLength' => 1024, + 'minLength' => 1, + ], + ], + ], + 'maxItems' => 3, + ], + ], + [ + 'name' => 'Texts', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局文字水印。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'default' => '5', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + ], + ], + 'FontSize' => [ + 'title' => '字体大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '36', + 'default' => '30', + ], + 'Alpha' => [ + 'title' => '水印透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.1', + 'default' => '1', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + ], + ], + 'X' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'type' => 'boolean', + 'default' => 'false', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Texture' => [ + 'title' => '水印内容。', + 'type' => 'string', + 'required' => true, + 'example' => '文字水印', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.6', + 'default' => '0.6', + ], + ], + ], + 'maxItems' => 3, + ], + ], + [ + 'name' => 'ClockWidgets', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局时钟水印。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'default' => '5', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + ], + ], + 'FontSize' => [ + 'title' => '时钟字体大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'default' => '30', + ], + 'Zone' => [ + 'title' => '时区。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + 'default' => '8', + ], + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + 'default' => '1', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + ], + ], + 'X' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'type' => 'boolean', + 'default' => 'false', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.6', + 'default' => '0.6', + ], + ], + ], + 'maxItems' => 3, + ], + ], + [ + 'name' => 'RegionColor', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局框格底色', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'title' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + 'G' => [ + 'title' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + 'B' => [ + 'title' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + ], + ], + ], + [ + 'name' => 'BgColor', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局背景色', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'title' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '0', + ], + 'G' => [ + 'title' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '0', + ], + 'B' => [ + 'title' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '0', + ], + ], + ], + ], + [ + 'name' => 'LayoutSpecifiedUsers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '黑白名单设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '用户名单类型，黑名单：black，白名单：white。', + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'white', + 'black', + ], + ], + 'Ids' => [ + 'title' => '指定用户ID列表。', + 'type' => 'array', + 'items' => [ + 'title' => '具体用户ID。', + 'type' => 'string', + 'required' => true, + ], + 'required' => true, + 'maxItems' => 16, + 'minItems' => 1, + ], + ], + ], + ], + [ + 'name' => 'RecordMode', + 'in' => 'query', + 'schema' => [ + 'title' => ' 0: 合流录制（默认值）'."\n" + .' 1: 单流录制 （单流录制不支持更新）', + 'type' => 'integer', + 'format' => 'int32', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'SingleStreamingRecord', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '单流录制参数。', + 'type' => 'object', + 'properties' => [ + 'AvMerge' => [ + 'title' => '音频文件是否合并到视频文件，默认false。', + 'type' => 'boolean', + 'default' => 'false', + ], + 'SpecifiedStreams' => [ + 'title' => '单流录制指定的流。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StreamType' => [ + 'title' => '流类型，取值：'."\n" + .'- mic: 音频流'."\n" + .'- camera：摄像头流'."\n" + .'- screen-cast：屏幕共享流', + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'mic', + 'camera', + 'screen-cast', + ], + ], + 'Type' => [ + 'title' => '单流录制流黑白名单类型'."\n" + .'- white: 白名单，表示录制该流', + 'type' => 'string', + 'example' => 'white', + 'default' => 'white', + 'enum' => [ + 'white', + ], + ], + 'Ids' => [ + 'title' => '用户ID列表。', + 'type' => 'array', + 'items' => [ + 'title' => '用户ID。', + 'type' => 'string', + 'required' => true, + ], + 'required' => true, + 'maxItems' => 16, + 'minItems' => 1, + ], + ], + ], + 'required' => true, + 'maxItems' => 3, + 'minItems' => 1, + ], + 'TranscodingParameters' => [ + 'title' => '单流录制默认写入为mp3格式，如需转码需指定该参数。', + 'type' => 'object', + 'properties' => [ + 'Audio' => [ + 'title' => '音频编码。', + 'type' => 'object', + 'properties' => [ + 'Bitrate' => [ + 'title' => '码率，单位kbps。', + 'type' => 'integer', + 'format' => 'int32', + 'default' => '128', + 'enum' => [ + '64', + '128', + '192', + ], + ], + 'Codec' => [ + 'title' => '音频编解码格式，可选:'."\n" + .'- mp3'."\n" + .'- aac', + 'type' => 'string', + 'default' => 'mp3', + 'enum' => [ + 'mp3', + 'aac', + ], + ], + 'SampleRate' => [ + 'title' => '采样率，可选：'."\n" + .'- 8000'."\n" + .'- 16000'."\n" + .'- 32000'."\n" + .'- 44100'."\n" + .'- 48000', + 'type' => 'integer', + 'format' => 'int32', + 'default' => '48000', + 'enum' => [ + '16000', + '32000', + '48000', + '8000', + '44100', + ], + ], + ], + ], + 'Container' => [ + 'title' => '录制文件容器。'."\n" + .'- mp3'."\n" + .'- aac'."\n" + .'- mp4'."\n" + .'- ts', + 'type' => 'string', + 'example' => 'aac', + 'default' => 'mp3', + 'enum' => [ + 'mp3', + 'aac', + 'mp4', + 'ts', + ], + ], + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '本次云端录制的任务ID。', + 'description' => 'taskId', + 'type' => 'string', + 'example' => '123', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'requestId', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', + ], + 'UpdateCloudRecord' => [ + 'summary' => '更新云端录制任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '567', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '本次云端录制的任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + 'maxLength' => 55, + 'minLength' => 1, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + [ + 'name' => 'Panes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '单元格设置。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceType' => [ + 'title' => '单元格媒体类型。取值：'."\n" + .'- **video**：用户摄像头或者屏幕共享流（默认值）。'."\n" + .'- **camera**：摄像头流。'."\n" + .'- **screen**：共享屏幕流。'."\n" + .'- **whiteboard**：白板。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + 'default' => 'video', + 'enum' => [ + 'video', + 'camera', + 'screen', + ], + ], + 'VideoOrder' => [ + 'title' => 'SourceType为video时，填充顺序。'."\n" + ."\n" + .'- screenFirst，屏幕共享优先（默认值）'."\n" + .'- cameraFirst，摄像头优先', + 'type' => 'string', + 'required' => false, + 'example' => 'cameraFirst', + 'default' => 'screenFirst', + 'enum' => [ + 'cameraFirst', + 'screenFirst', + ], + ], + 'PaneId' => [ + 'title' => '窗格ID，从0开始。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '15', + 'minimum' => '0', + 'example' => '0', + ], + 'Source' => [ + 'title' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" + .' - **$ActiveSpeaker**：当前频道发言人'."\n" + .' - **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '22', + ], + 'PaneCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'ReservePaneForOfflineUser' => [ + 'title' => '未入会用户窗格占位。'."\n" + .'默认为true，表示宫格指定的具体用户或通配符用户离线时，窗格强制占位。'."\n" + .'为false时，表示宫格指定的具体用户或通配符用户离线时，将按自动填充顺序显示视频流。', + 'type' => 'boolean', + 'default' => 'true', + ], + 'Images' => [ + 'title' => '窗格局部图片水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'title' => '图片地址。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123xxx.jpg', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'Alpha' => [ + 'title' => '透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.9', + 'default' => '1.0', + ], + 'PaneImageCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'X' => [ + 'title' => '横坐标。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + 'title' => '纵坐标。', + ], + 'Width' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + 'title' => '宽。', + ], + 'Height' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + 'title' => '高。', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'Display' => [ + 'title' => '水印显示时机。'."\n" + .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" + .'- backup：当前用户无视频流时显示。'."\n" + .'- always：总是显示。', + 'type' => 'string', + 'example' => 'backup', + 'default' => 'streamOnly', + 'enum' => [ + 'streamOnly', + 'backup', + 'always', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + 'Backgrounds' => [ + 'title' => '窗格局部背景图片。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'title' => '图片地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123xx.jpg', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.9', + 'default' => '1.0', + ], + 'PaneBackgroundCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'X' => [ + 'title' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Width' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Height' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'Display' => [ + 'title' => '水印显示时机。'."\n" + .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" + .'- backup：当前用户无视频流时显示。'."\n" + .'- always：总是显示。', + 'type' => 'string', + 'example' => 'backup', + 'default' => 'streamOnly', + 'enum' => [ + 'streamOnly', + 'backup', + 'always', + ], + ], + ], + ], + 'maxItems' => 3, + ], + 'Texts' => [ + 'title' => '窗格局部文字水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Texture' => [ + 'title' => '水印内容。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '文字水印', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'FontSize' => [ + 'title' => '字体大小。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '72', + 'minimum' => '0', + 'example' => '36', + 'default' => '30', + ], + 'Alpha' => [ + 'title' => '水印透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.9', + 'default' => '1', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'R。', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'G。', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'B。', + ], + ], + 'required' => false, + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'X' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.2', + 'title' => '横坐标。', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.2', + 'title' => '纵坐标。', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'R。', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'G。', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'B。', + ], + ], + 'required' => false, + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.6', + 'default' => '0.6', + ], + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '5', + 'default' => '5', + ], + 'Display' => [ + 'title' => '水印显示时机。'."\n" + .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" + .'- backup：当前用户无视频流时显示。'."\n" + .'- always：总是显示。', + 'type' => 'string', + 'example' => 'backup', + 'default' => 'streamOnly', + 'enum' => [ + 'streamOnly', + 'backup', + 'always', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + 'Whiteboard' => [ + 'title' => '白板设置。', + 'type' => 'object', + 'properties' => [ + 'WhiteboardId' => [ + 'title' => '白板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'default' => 'default', + ], + ], + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'Images', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局图片水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'title' => '图片地址。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123.jpg', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'Alpha' => [ + 'title' => '透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.9', + 'default' => '1.0', + ], + 'ImageCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'X' => [ + 'title' => '横坐标。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + 'title' => '纵坐标。', + ], + 'Width' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + 'title' => '宽。', + ], + 'Height' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + 'title' => '高。', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'Backgrounds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '背景图片。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'title' => '图片地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123.jpg', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.9', + 'default' => '1.0', + ], + 'BackgroundCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'X' => [ + 'title' => '横坐标。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'title' => '纵坐标。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Width' => [ + 'title' => '宽。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Height' => [ + 'title' => '高。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + ], + ], + 'maxItems' => 3, + ], + ], + [ + 'name' => 'Texts', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局文字水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Texture' => [ + 'title' => '水印内容。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '文字水印', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'FontSize' => [ + 'title' => '字体大小。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '72', + 'minimum' => '0', + 'example' => '36', + 'default' => '30', + ], + 'Alpha' => [ + 'title' => '水印透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.1', + 'default' => '1', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'R。', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'G。', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'B。', + ], + ], + 'required' => false, + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'X' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.2', + 'title' => '横坐标。', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.2', + 'title' => '纵坐标。', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'R。', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'G。', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'B。', + ], + ], + 'required' => false, + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.6', + 'default' => '0.6', + ], + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '5', + 'default' => '5', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'ClockWidgets', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局时钟水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Zone' => [ + 'title' => '时区。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '12', + 'exclusiveMaximum' => true, + 'minimum' => '-12', + 'example' => '8', + 'default' => '8', + ], + 'FontSize' => [ + 'title' => '时钟字体大小。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '72', + 'minimum' => '0', + 'example' => '30', + 'default' => '30', + ], + 'Alpha' => [ + 'title' => '透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.9', + 'default' => '1', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'R。', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'G。', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'B。', + ], + ], + 'required' => false, + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'X' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.2', + 'title' => '横坐标。', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.2', + 'title' => '纵坐标。', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'R。', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'G。', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'B。', + ], + ], + 'required' => false, + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.6', + 'default' => '0.6', + ], + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '5', + 'default' => '5', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'LayoutSpecifiedUsers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '黑白名单设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '用户名单类型，黑名单：black，白名单：white。', + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'white', + 'black', + ], + ], + 'Ids' => [ + 'title' => '指定用户ID列表。', + 'type' => 'array', + 'items' => [ + 'title' => '具体用户ID。', + 'type' => 'string', + 'required' => true, + ], + 'required' => true, + 'maxItems' => 16, + 'minItems' => 1, + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '本次云端录制的任务ID。', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', + ], + 'StopCloudRecord' => [ + 'summary' => 'StopCloudRecord', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的云端录制的任务ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + 'maxLength' => 55, + 'minLength' => 1, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '本次云端录制的任务ID。', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', + ], + 'DescribeAppLiveStreamStatus' => [ + 'summary' => '查看应用旁路开关', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + 'Result' => [ + 'title' => '开关状态；enable-开启 disable-关闭。', + 'description' => '', + 'type' => 'string', + 'example' => 'disable', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\",\\n \\"Result\\": \\"disable\\"\\n}","type":"json"}]', + ], + 'ModifyAppLiveStreamStatus' => [ + 'summary' => '修改应用旁路开关', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '53200b81-b761-4c10-842a-a0726xxxx', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","type":"json"}]', + ], + 'CreateAppStreamingOutTemplate' => [ + 'summary' => '创建应用推流模版', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'StreamingOutTemplate', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '模版。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '模版', + ], + 'LayoutIds' => [ + 'title' => '布局ID列表，最多16个。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体的布局ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '22', + 'pattern' => '^\\d+$', + ], + 'required' => true, + 'maxItems' => 16, + 'minItems' => 1, + ], + 'MediaEncode' => [ + 'title' => '编码选项。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'enum' => [ + '0', + '1', + '54', + '53', + '52', + '10', + '20', + '22', + '23', + '30', + '31', + '24', + '25', + '26', + '27', + '28', + '32', + '33', + '34', + '35', + '36', + '37', + '38', + '39', + '40', + '41', + '42', + '43', + ], + 'default' => '1', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '30D41049-D02D-1C21-86AE-B3E5FD805C27', + ], + 'TemplateId' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'bc5v****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Function.Disable', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Quota.Invalid', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30D41049-D02D-1C21-86AE-B3E5FD805C27\\",\\n \\"TemplateId\\": \\"bc5v****\\"\\n}","type":"json"}]', + ], + 'ModifyAppStreamingOutTemplate' => [ + 'summary' => '更新应用推流模版', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'wv7N****', + ], + ], + [ + 'name' => 'StreamingOutTemplate', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '模版。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '模版', + ], + 'LayoutIds' => [ + 'title' => '布局ID列表，最多16个。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体的布局ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '22', + 'pattern' => '^\\d+$', + ], + 'required' => true, + 'minItems' => 1, + 'maxItems' => 16, + ], + 'MediaEncode' => [ + 'title' => '编码选项。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'enum' => [ + '0', + '1', + '54', + '53', + '52', + '10', + '20', + '22', + '23', + '30', + '31', + '24', + '25', + '26', + '27', + '28', + '32', + '33', + '34', + '35', + '36', + '37', + '38', + '39', + '40', + '41', + '42', + '43', + ], + 'default' => '1', + ], + 'TemplateId' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '30D41049-D02D-1C21-86AE-B3E5FD805C27', + ], + 'TemplateId' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'ac7N****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Function.Disable', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30D41049-D02D-1C21-86AE-B3E5FD805C27\\",\\n \\"TemplateId\\": \\"ac7N****\\"\\n}","type":"json"}]', + ], + 'DeleteAppStreamingOutTemplate' => [ + 'summary' => '删除应用推流模版', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'wv7N****', + ], + ], + [ + 'name' => 'StreamingOutTemplate', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '模版信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模版ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'xd4c****', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '30D41049-D02D-1C21-86AE-B3E5FD825C17', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Function.Disable', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30D41049-D02D-1C21-86AE-B3E5FD825C17\\"\\n}","type":"json"}]', + ], + 'DescribeAppStreamingOutTemplates' => [ + 'summary' => '应用推流模版列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ioeh****', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，默认查询第1页。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页显示个数，默认为10。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Condition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '搜索条件', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模版ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Bj6D****', + ], + 'Name' => [ + 'title' => '模版名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'B0A2FCBC-43A4-428F-BC1D-3F4F85837F76', + ], + 'TotalNum' => [ + 'title' => '记录数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalPage' => [ + 'title' => '分页数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Templates' => [ + 'title' => '模版列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模版ID', + 'description' => '', + 'type' => 'string', + 'example' => 'Bj6D****', + ], + 'Name' => [ + 'title' => '模版名称', + 'description' => '', + 'type' => 'string', + 'example' => '模版名称', + ], + 'CreateTime' => [ + 'title' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'description' => '', + 'type' => 'string', + 'example' => '2020-09-04T06:22:15Z', + ], + 'MediaEncode' => [ + 'title' => '编码选项。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LayoutIds' => [ + 'title' => '布局ID列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体的布局ID。', + 'description' => '', + 'type' => 'string', + 'example' => '22', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B0A2FCBC-43A4-428F-BC1D-3F4F85837F76\\",\\n \\"TotalNum\\": 10,\\n \\"TotalPage\\": 1,\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"Bj6D****\\",\\n \\"Name\\": \\"模板名称\\",\\n \\"CreateTime\\": \\"2020-09-04T06:22:15Z\\",\\n \\"MediaEncode\\": 1,\\n \\"LayoutIds\\": [\\n \\"22\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeStreamingOutStatus' => [ + 'summary' => '查询旁路推流状态', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1qaz***x', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道名。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testChannel', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'taskId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + 'Status' => [ + 'title' => '- 1：正在推流'."\n" + .'- 2：推流异常，直播停止', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\",\\n \\"Status\\": 1\\n}","type":"json"}]', + ], + 'StartStreamingOut' => [ + 'summary' => 'StartStreamingOut', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '567', + 'maxLength' => 128, + 'minLength' => 1, + 'pattern' => '^[\\w.-]+$', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'title' => '直播推流地址，仅支持传单个地址，最长1024。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://example.com/live/stream', + 'maxLength' => 1024, + 'minLength' => 1, + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '本次旁路推流的任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节，不填，则由系统自动生成。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 55, + 'minLength' => 1, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + [ + 'name' => 'CropMode', + 'in' => 'query', + 'schema' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边（默认值）。'."\n" + .'- **3**：拉伸铺满。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'default' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'ReservePaneForNoCameraUser', + 'in' => 'query', + 'schema' => [ + 'title' => '未推摄像头流用户窗格占位。'."\n" + .'默认为true，表示用户未推摄像头流时保留一个窗格。'."\n" + .'为false时，表示用户未推摄像头流时不保留窗格。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'ShowDefaultBackgroundOnMute', + 'in' => 'query', + 'schema' => [ + 'title' => 'mute时是否显示窗格默认底图。'."\n" + .'- true: 显示（默认值）'."\n" + .'- false: 不显示（设置的局部窗格底图依然显示）', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'SubHighResolutionStream', + 'in' => 'query', + 'schema' => [ + 'title' => '订阅高分辨率流。'."\n" + .'- false：根据窗格面积订阅不同分辨率的流。（默认值）'."\n" + .'- true：默认用客户端推的最高分辨率的流进行填充。', + 'type' => 'boolean', + 'default' => 'false', + ], + ], + [ + 'name' => 'StartWithoutChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '是否允许频道不存在时开启任务。'."\n" + ."\n" + .'- true: 是'."\n" + .'- false: 否（默认值）', + 'type' => 'boolean', + 'default' => 'false', + ], + ], + [ + 'name' => 'StartWithoutChannelWaitTime', + 'in' => 'query', + 'schema' => [ + 'title' => '当StartWithoutChannel参数为true的时候，设置该值才有意义，表示房间未开启时，任务等待时长，单位为秒，区间限制为[30,120]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'Annotation', + 'in' => 'query', + 'schema' => [ + 'title' => '标注开关。', + 'type' => 'string', + 'example' => 'disable', + 'default' => 'enable', + 'enum' => [ + 'disable', + 'enable', + ], + ], + ], + [ + 'name' => 'Panes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '单元格设置，做多设置16个。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VideoOrder' => [ + 'title' => 'SourceType为video时，填充顺序。'."\n" + ."\n" + .'- screenFirst，屏幕共享优先（默认值）'."\n" + .'- cameraFirst，摄像头优先', + 'type' => 'string', + 'example' => 'cameraFirst', + 'default' => 'screenFirst', + 'enum' => [ + 'cameraFirst', + 'screenFirst', + ], + ], + 'SourceType' => [ + 'title' => '单元格媒体类型。取值：'."\n" + .'- **video**：用户摄像头或者屏幕共享流（默认值）。'."\n" + .'- **camera**：摄像头流。'."\n" + .'- **screen**：共享屏幕流。'."\n" + .'- **whiteboard**：白板。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Video', + 'default' => 'video', + 'enum' => [], + ], + 'Images' => [ + 'title' => '窗格局部图片水印。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PaneImageCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.3', + ], + 'Height' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Width' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123xxx.jpg', + ], + 'Display' => [ + 'title' => '水印显示时机。'."\n" + .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" + .'- backup：当前用户无视频流时显示。'."\n" + .'- always：总是显示。', + 'type' => 'string', + 'example' => 'backup', + 'default' => 'streamOnly', + 'enum' => [ + 'streamOnly', + 'backup', + 'always', + ], + ], + ], + ], + 'maxItems' => 3, + ], + 'Texts' => [ + 'title' => '窗格局部文字水印。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'default' => '5', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + ], + ], + 'Texture' => [ + 'title' => '水印内容。', + 'type' => 'string', + 'required' => true, + 'example' => '文字水印', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + ], + ], + 'FontSize' => [ + 'title' => '字体大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '36', + 'default' => '30', + ], + 'Alpha' => [ + 'title' => '水印透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + 'default' => '1', + ], + 'X' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'type' => 'boolean', + 'default' => 'false', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.6', + 'default' => '0.6', + ], + 'Display' => [ + 'title' => '水印显示时机。'."\n" + .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" + .'- backup：当前用户无视频流时显示。'."\n" + .'- always：总是显示。', + 'type' => 'string', + 'example' => 'backup', + 'default' => 'streamOnly', + 'enum' => [ + 'streamOnly', + 'backup', + 'always', + ], + ], + ], + ], + 'maxItems' => 3, + ], + 'PaneCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'PaneId' => [ + 'title' => '窗格ID，从0开始。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '0', + 'pattern' => '^\\d+$', + 'enum' => [], + ], + 'Source' => [ + 'title' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" + .' - **$ActiveSpeaker**：当前频道发言人'."\n" + .' - **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1811****', + ], + 'Backgrounds' => [ + 'title' => '窗格局部背景图片。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'PaneBackgroundCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Height' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Width' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123xx.jpg', + ], + 'Display' => [ + 'title' => '水印显示时机。'."\n" + .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" + .'- backup：当前用户无视频流时显示。'."\n" + .'- always：总是显示。', + 'type' => 'string', + 'example' => 'backup', + 'default' => 'streamOnly', + 'enum' => [ + 'streamOnly', + 'backup', + 'always', + ], + ], + ], + ], + 'maxItems' => 3, + ], + 'Whiteboard' => [ + 'title' => '白板设置。', + 'type' => 'object', + 'properties' => [ + 'WhiteboardId' => [ + 'title' => '白板ID。', + 'type' => 'string', + 'example' => 'default', + 'default' => 'default', + ], + ], + ], + 'ReservePaneForOfflineUser' => [ + 'title' => '未入会用户窗格占位。'."\n" + .'默认为true，表示宫格指定的具体用户或通配符用户离线时，窗格强制占位。'."\n" + .'为false时，表示宫格指定的具体用户或通配符用户离线时，将按自动填充顺序显示视频流。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'Backgrounds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '背景图片。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackgroundCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '横坐标。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'title' => '纵坐标。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Height' => [ + 'title' => '高。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Width' => [ + 'title' => '宽。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123.jpg', + ], + ], + ], + 'maxItems' => 3, + ], + ], + [ + 'name' => 'Images', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局图片水印。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Height' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'ImageCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Width' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123xxx.jpg', + ], + ], + ], + 'maxItems' => 3, + ], + ], + [ + 'name' => 'Texts', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局文字水印。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'default' => '5', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + ], + ], + 'FontSize' => [ + 'title' => '字体大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '36', + 'default' => '30', + ], + 'Alpha' => [ + 'title' => '水印透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.1', + 'default' => '1', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + ], + ], + 'X' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'type' => 'boolean', + 'default' => 'false', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Texture' => [ + 'title' => '水印内容。', + 'type' => 'string', + 'required' => true, + 'example' => '文字水印', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.6', + 'default' => '0.6', + ], + ], + ], + 'maxItems' => 3, + ], + ], + [ + 'name' => 'ClockWidgets', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局时钟水印。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'default' => '5', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '30', + ], + ], + ], + 'FontSize' => [ + 'title' => '时钟字体大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'default' => '30', + ], + 'Zone' => [ + 'title' => '时区。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + 'default' => '8', + ], + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + 'default' => '1', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + 'default' => '255', + ], + ], + ], + 'X' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'type' => 'boolean', + 'default' => 'false', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'default' => '0', + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.6', + 'default' => '0.6', + ], + ], + ], + 'maxItems' => 3, + ], + ], + [ + 'name' => 'RegionColor', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局框格底色', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'title' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + 'G' => [ + 'title' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + 'B' => [ + 'title' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + ], + ], + ], + [ + 'name' => 'BgColor', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局背景色', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'title' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '0', + ], + 'G' => [ + 'title' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '0', + ], + 'B' => [ + 'title' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '0', + ], + ], + ], + ], + [ + 'name' => 'LayoutSpecifiedUsers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '黑白名单设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '用户名单类型，黑名单：black，白名单：white。', + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'white', + 'black', + ], + ], + 'Ids' => [ + 'title' => '指定用户ID列表。', + 'type' => 'array', + 'items' => [ + 'title' => '具体用户ID。', + 'type' => 'string', + 'required' => true, + ], + 'required' => true, + 'maxItems' => 16, + 'minItems' => 1, + ], + ], + ], + ], + [ + 'name' => 'SpecMixedUserList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '指定需要被混音的用户列表。', + 'type' => 'array', + 'items' => [ + 'title' => '用户ID。', + 'type' => 'string', + ], + 'maxItems' => 25, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '本次旁路推流的任务ID。', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', + ], + 'UpdateStreamingOut' => [ + 'summary' => '更新旁路推流任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '567', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '本次旁路推流的任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + 'maxLength' => 55, + 'minLength' => 1, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + [ + 'name' => 'CropMode', + 'in' => 'query', + 'schema' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'Panes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '单元格设置，做多设置16个。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VideoOrder' => [ + 'title' => 'SourceType为video时，填充顺序。'."\n" + ."\n" + .'- screenFirst，屏幕共享优先（默认值）'."\n" + .'- cameraFirst，摄像头优先', + 'type' => 'string', + 'required' => false, + 'example' => 'cameraFirst', + 'default' => 'screenFirst', + 'enum' => [ + 'cameraFirst', + 'screenFirst', + ], + ], + 'SourceType' => [ + 'title' => '单元格媒体类型。取值：'."\n" + .'- **video**：用户摄像头或者屏幕共享流（默认值）。'."\n" + .'- **camera**：摄像头流。'."\n" + .'- **screen**：共享屏幕流。'."\n" + .'- **whiteboard**：白板。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + 'default' => 'video', + 'enum' => [ + 'video', + 'camera', + 'screen', + ], + ], + 'Images' => [ + 'title' => '窗格局部图片水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PaneImageCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Alpha' => [ + 'title' => '透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '横坐标。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + 'title' => '纵坐标。', + ], + 'Height' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + 'title' => '高。', + ], + 'Width' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + 'title' => '宽。', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123.jpg', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'Display' => [ + 'title' => '水印显示时机。'."\n" + .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" + .'- backup：当前用户无视频流时显示。'."\n" + .'- always：总是显示。', + 'type' => 'string', + 'example' => 'backup', + 'default' => 'streamOnly', + 'enum' => [ + 'streamOnly', + 'backup', + 'always', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + 'Texts' => [ + 'title' => '窗格局部文字水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '5', + 'default' => '5', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'R。', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'B。', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'G。', + ], + ], + 'required' => false, + ], + 'Texture' => [ + 'title' => '水印内容。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '文字水印', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'R。', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'B。', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'G。', + ], + ], + 'required' => false, + ], + 'FontSize' => [ + 'title' => '字体大小。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '72', + 'minimum' => '0', + 'example' => '36', + 'default' => '30', + ], + 'Alpha' => [ + 'title' => '水印透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.9', + 'default' => '1', + ], + 'X' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.2', + 'title' => '横坐标。', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.2', + 'title' => '纵坐标。', + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.6', + 'default' => '0.6', + ], + 'Display' => [ + 'title' => '水印显示时机。'."\n" + .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" + .'- backup：当前用户无视频流时显示。'."\n" + .'- always：总是显示。', + 'type' => 'string', + 'example' => 'backup', + 'default' => 'streamOnly', + 'enum' => [ + 'streamOnly', + 'backup', + 'always', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + 'PaneCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'PaneId' => [ + 'title' => '布局ID。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '15', + 'minimum' => '0', + 'example' => '1', + ], + 'Source' => [ + 'title' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" + .' - **$ActiveSpeaker**：当前频道发言人'."\n" + .' - **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '22', + ], + 'Backgrounds' => [ + 'title' => '窗格局部背景图片。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'PaneBackgroundCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Height' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Width' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123xx.jpg', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'Display' => [ + 'title' => '水印显示时机。'."\n" + .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" + .'- backup：当前用户无视频流时显示。'."\n" + .'- always：总是显示。', + 'type' => 'string', + 'example' => 'backup', + 'default' => 'streamOnly', + 'enum' => [ + 'streamOnly', + 'backup', + 'always', + ], + ], + ], + ], + 'maxItems' => 3, + ], + 'Whiteboard' => [ + 'title' => '白板设置。', + 'type' => 'object', + 'properties' => [ + 'WhiteboardId' => [ + 'title' => '白板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'default' => 'default', + ], + ], + ], + 'ReservePaneForOfflineUser' => [ + 'title' => '未入会用户窗格占位。'."\n" + .'默认为true，表示宫格指定的具体用户或通配符用户离线时，窗格强制占位。'."\n" + .'为false时，表示宫格指定的具体用户或通配符用户离线时，将按自动填充顺序显示视频流。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'Images', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局图片水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Alpha' => [ + 'title' => '透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '横坐标。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + 'title' => '纵坐标。', + ], + 'Height' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + 'title' => '高。', + ], + 'ImageCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Width' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + 'title' => '宽。', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123.jpg', + 'maxLength' => 1024, + 'minLength' => 1, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'Backgrounds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '背景图片。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackgroundCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Alpha' => [ + 'title' => '透明度。', + 'type' => 'number', + 'format' => 'double', + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '横坐标。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'title' => '纵坐标。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Height' => [ + 'title' => '高。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Width' => [ + 'title' => '宽。', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123.jpg', + 'maxLength' => 1024, + 'minLength' => 1, + ], + ], + ], + 'maxItems' => 3, + ], + ], + [ + 'name' => 'Texts', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局文字水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '5', + 'default' => '5', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'R。', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'B。', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'G。', + ], + ], + 'required' => false, + ], + 'FontSize' => [ + 'title' => '字体大小。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '72', + 'minimum' => '0', + 'example' => '36', + 'default' => '30', + ], + 'Alpha' => [ + 'title' => '水印透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.1', + 'default' => '1', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'R。', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'B。', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'G。', + ], + ], + 'required' => false, + ], + 'X' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.2', + 'title' => '横坐标。', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.2', + 'title' => '纵坐标。', + ], + 'Texture' => [ + 'title' => '水印内容。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '文字水印', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.6', + 'default' => '0.6', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'ClockWidgets', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局时钟水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '5', + 'default' => '5', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'R。', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'B。', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '30', + 'title' => 'G。', + ], + ], + 'required' => false, + ], + 'FontSize' => [ + 'title' => '时钟字体大小。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '72', + 'minimum' => '0', + 'example' => '30', + 'default' => '30', + ], + 'Zone' => [ + 'title' => '时区。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '12', + 'exclusiveMaximum' => true, + 'minimum' => '-12', + 'example' => '8', + 'default' => '8', + ], + 'Alpha' => [ + 'title' => '透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.9', + 'default' => '1', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'R。', + ], + 'B' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'B。', + ], + 'G' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '255', + 'title' => 'G。', + ], + ], + 'required' => false, + ], + 'X' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.2', + 'title' => '横坐标。', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'Y' => [ + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.2', + 'title' => '纵坐标。', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.6', + 'default' => '0.6', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'RegionColor', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局框格底色', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'title' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + 'G' => [ + 'title' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + 'B' => [ + 'title' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + ], + ], + ], + [ + 'name' => 'BgColor', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局背景色', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'title' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + 'G' => [ + 'title' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + 'B' => [ + 'title' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + ], + ], + ], + [ + 'name' => 'LayoutSpecifiedUsers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '黑白名单设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '用户名单类型，黑名单：black，白名单：white。', + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'white', + 'black', + ], + ], + 'Ids' => [ + 'title' => '指定用户ID列表。', + 'type' => 'array', + 'items' => [ + 'title' => '具体用户ID。', + 'type' => 'string', + 'required' => true, + ], + 'required' => true, + 'maxItems' => 16, + 'minItems' => 1, + ], + ], + ], + ], + [ + 'name' => 'SpecMixedUserList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '指定需要被混音的用户列表。', + 'type' => 'array', + 'items' => [ + 'title' => '用户ID。', + 'type' => 'string', + ], + 'maxItems' => 25, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '本次旁路推流的任务ID。', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', + ], + 'StopStreamingOut' => [ + 'summary' => 'StopStreamingOut', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的旁路推流的任务ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + 'maxLength' => 55, + 'minLength' => 1, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '本次旁路推流的任务ID。', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', + ], + 'CreateCloudNotePhrases' => [ + 'summary' => '增加纪要热词表', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'Phrase', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '热词参数。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '热词表名称。UTF-8 编码，长度范围[1,30]', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '水果', + 'maxLength' => 30, + 'minLength' => 1, + ], + 'Description' => [ + 'title' => '描述。UTF-8编码，长度[1,200]。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '水果描述', + 'maxLength' => 200, + 'minLength' => 1, + ], + 'WordWeights' => [ + 'title' => '每个词表最多包含300个热词，每个热词中文长度不超过10个字符。'."\n" + ."\n" + .'热词必须为UTF-8编码，不能包含标点、特殊字符，不符合的情况下，无热词效果。'."\n" + ."\n" + .'热词对应的权重取值范围为[-6,5]之间的整数。'."\n" + ."\n" + .'文本中的数字需要按照发音替换为对应的汉字。例如：“59.9元”需要替换为“五十九点九元”。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '热词权重。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Word' => [ + 'title' => '热词。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '苹果', + ], + 'Weight' => [ + 'title' => '权重取值范围为[-6,5]之间的整数。'."\n" + .'- 取值大于0会增大该词语被识别的概率，小于0会减小该词语被识别的概率。'."\n" + .'- 取值为-6：表示尽量不要识别出该词语。'."\n" + .'- 取值为2：常用值。'."\n" + .'如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 300, + 'minItems' => 1, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'Id' => [ + 'title' => '热词表ID。', + 'description' => '', + 'type' => 'string', + 'example' => '21088b2617489486958531017d0b19', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Function.Disable', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Quota.Invalid', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"Id\\": \\"21088b2617489486958531017d0b19\\"\\n}","type":"json"}]', + ], + 'ModifyCloudNotePhrases' => [ + 'summary' => '更新纪要热词表', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'Phrase', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '热词参数。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '热词表ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1qasw23ezcsrfsawq', + ], + 'Name' => [ + 'title' => '热词表名称。UTF-8 编码，长度范围[1,30]', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '水果', + 'maxLength' => 30, + 'minLength' => 1, + ], + 'Description' => [ + 'title' => '描述。UTF-8编码，长度[1,200]。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '水果描述', + 'maxLength' => 200, + 'minLength' => 1, + ], + 'WordWeights' => [ + 'title' => '每个词表最多包含300个热词，每个热词中文长度不超过10个字符，英文不超过5个单词。'."\n" + ."\n" + .'热词必须为UTF-8编码，不能包含标点、特殊字符，不符合的情况下，无热词效果。'."\n" + ."\n" + .'热词对应的权重取值范围为[-6,5]之间的整数。'."\n" + ."\n" + .'文本中的数字需要按照发音替换为对应的汉字。例如：“59.9元”需要替换为“五十九点九元”。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '热词权重。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Word' => [ + 'title' => '热词。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '苹果', + 'minLength' => 1, + ], + 'Weight' => [ + 'title' => '权重取值范围为[-6,5]之间的整数。'."\n" + .'- 取值大于0会增大该词语被识别的概率，小于0会减小该词语被识别的概率。'."\n" + .'- 取值为-6：表示尽量不要识别出该词语。'."\n" + .'- 取值为2：常用值。'."\n" + .'如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '5', + 'minimum' => '-6', + 'example' => '0', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 300, + 'minItems' => 1, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'Id' => [ + 'title' => '热词表ID。', + 'description' => '', + 'type' => 'string', + 'example' => '21088b2617489486958531017d0b19', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Function.Disable', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Quota.Invalid', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"Id\\": \\"21088b2617489486958531017d0b19\\"\\n}","type":"json"}]', + ], + 'DescribeCloudNotePhrases' => [ + 'summary' => '纪要热词列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，默认查询第1页。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页显示个数，默认为10。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Condition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '查询条件。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '热词表ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ac7N****112121', + ], + 'Name' => [ + 'title' => '热词表名称。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + 'maxLength' => 30, + 'minLength' => 1, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response。', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request。', + 'description' => 'Id of the request。', + 'type' => 'string', + 'example' => '3A26E1E3-3CBB-599E-AD68-CB78F5A42FA1', + ], + 'TotalNum' => [ + 'title' => '记录数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalPage' => [ + 'title' => '分页数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Phrases' => [ + 'title' => '热词列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '热词配置。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '描述。', + 'description' => '', + 'type' => 'string', + 'example' => '水果描述', + 'maxLength' => 200, + 'minLength' => 1, + ], + 'CreateTime' => [ + 'title' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'description' => '', + 'type' => 'string', + 'example' => '2025-03-04T06:22:15Z', + ], + 'Id' => [ + 'title' => '热词表ID。', + 'description' => '', + 'type' => 'string', + 'example' => '1qweadca332121212', + ], + 'WordWeights' => [ + 'title' => '热词权重。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '热词权重。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Word' => [ + 'title' => '热词。', + 'description' => '', + 'type' => 'string', + 'example' => '苹果', + 'maxLength' => 10, + 'minLength' => 1, + ], + 'Weight' => [ + 'title' => '权重取值。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '5', + 'minimum' => '-6', + 'example' => '0', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 300, + 'minItems' => 1, + ], + 'Name' => [ + 'title' => '热词表名称。', + 'description' => '', + 'type' => 'string', + 'example' => '水果', + 'maxLength' => 30, + 'minLength' => 1, + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Function.Disable', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Quota.Invalid', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A26E1E3-3CBB-599E-AD68-CB78F5A42FA1\\",\\n \\"TotalNum\\": 10,\\n \\"TotalPage\\": 1,\\n \\"Phrases\\": [\\n {\\n \\"Description\\": \\"水果描述\\",\\n \\"CreateTime\\": \\"2025-03-04T06:22:15Z\\",\\n \\"Id\\": \\"1qweadca332121212\\",\\n \\"WordWeights\\": [\\n {\\n \\"Word\\": \\"苹果\\",\\n \\"Weight\\": 0\\n }\\n ],\\n \\"Name\\": \\"水果\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DeleteCloudNotePhrases' => [ + 'summary' => '删除纪要热词表', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'Phrase', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '热词表参数。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '热词表ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1qasw23ezcsrfsawq', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'Id' => [ + 'title' => '热词表ID。', + 'description' => '', + 'type' => 'string', + 'example' => '21088b2617489486958531017d0b19', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Function.Disable', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Quota.Invalid', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"Id\\": \\"21088b2617489486958531017d0b19\\"\\n}","type":"json"}]', + ], + 'StartCloudNote' => [ + 'summary' => '开启智能纪要', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2ws***z3', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rtc', + 'maxLength' => 55, + 'minLength' => 1, + 'pattern' => '^[\\w.-]+$', + ], + ], + [ + 'name' => 'StorageConfig', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '存储配置。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'title' => '存储平台。取值：'."\n" + ."\n" + .'| vendor | 对象存储产品 | 备注 |'."\n" + .'|--------|---------|---------|'."\n" + .'| 1 | AliYun OSS | 阿里云 |', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + 'Region' => [ + 'title' => '存储地域。'."\n" + ."\n" + .'| Region | AliYun OSS |'."\n" + .'|--------|------------|'."\n" + .'| 0 | CN_Hangzhou |'."\n" + .'| 1 | CN_Shanghai |'."\n" + .'| 2 | CN_Qingdao |'."\n" + .'| 3 | CN_Beijing |'."\n" + .'| 4 | CN_Zhangjiakou |'."\n" + .'| 5 | CN_Huhehaote |'."\n" + .'| 6 | CN_Shenzhen |'."\n" + .'| 7 | CN_Hongkong |'."\n" + .'| 8 | US_West_1 |'."\n" + .'| 9 | US_East_1 |'."\n" + .'| 10 | AP_Southeast_1 |'."\n" + .'| 11 | AP_Southeast_2 |'."\n" + .'| 12 | AP_Southeast_3 |'."\n" + .'| 13 | AP_Southeast_5 |'."\n" + .'| 14 | AP_Northeast_1 |'."\n" + .'| 15 | AP_South_1 |'."\n" + .'| 16 | EU_Central_1 |'."\n" + .'| 17 | EU_West_1 |'."\n" + .'| 18 | EU_East_1(ME_East_1) |'."\n" + .'| 19 | AP_Southeast_6 |'."\n" + .'| 20 | CN_Heyuan |'."\n" + .'| 21 | CN_Guangzhou |'."\n" + .'| 22 | CN_Chengdu |'."\n" + .'| 23 | CN_Nanjing |'."\n" + .'| 24 | CN_Fuzhou |'."\n" + .'| 25 | CN_Wulanchabu |'."\n" + .'| 26 | AP_Northeast_2 |'."\n" + .'| 27 | AP_Southeast_7 |'."\n" + ."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + 'Bucket' => [ + 'title' => '存储桶名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test-bucket-for-recording', + 'minLength' => 1, + ], + 'AccessKey' => [ + 'title' => 'accessKey', + 'description' => 'accessKey。', + 'type' => 'string', + 'required' => true, + 'example' => 'LTAX***', + 'minLength' => 1, + ], + 'SecretKey' => [ + 'title' => 'secretKey', + 'description' => 'secretKey。', + 'type' => 'string', + 'required' => true, + 'example' => 'APb6qWYEzKtYxE***', + 'minLength' => 1, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'SourceLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '频道使用的源语言模型。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn', + 'default' => 'cn', + 'enum' => [ + 'cn', + 'en', + 'ja', + 'yue', + 'ko', + 'de', + 'fr', + 'ru', + 'multilingual', + 'es', + 'vi', + 'it', + 'sv', + 'cs', + 'pl', + 'th', + 'fi', + 'hi', + 'id', + 'pt', + 'ar', + 'fil', + 'ms', + 'tr', + 'hu', + 'lo', + 'pt-br', + 'es-ar', + 'es-mx', + ], + ], + ], + [ + 'name' => 'LanguageHints', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '语音中非单语种，但是已知语种的范围是确定的，直接识别对应语种，避免识别错误。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ko', + 'enum' => [ + 'cn', + 'en', + 'ja', + 'ko', + 'de', + 'fr', + 'ru', + 'es', + 'vi', + 'it', + 'sv', + 'cs', + 'pl', + 'th', + 'fi', + 'hi', + 'id', + 'pt', + 'ar', + 'fil', + 'ms', + 'tr', + 'hu', + 'lo', + 'pt-br', + 'es-ar', + 'es-mx', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Transcription', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '转写功能，默认开启。', + 'type' => 'object', + 'properties' => [ + 'DiarizationEnabled' => [ + 'title' => '是否开启说话人分离功能。', + 'type' => 'boolean', + 'default' => 'false', + ], + 'SpeakerCount' => [ + 'title' => '设置说话人分离参数，默认0。'."\n" + .'0：说话人角色区分结果为不定人数。'."\n" + .'2：说话人角色区分结果为 2 人。', + 'type' => 'integer', + 'format' => 'int32', + 'default' => '0', + 'enum' => [ + '0', + '2', + ], + ], + 'TranscriptionLevel' => [ + 'title' => '语音识别结果返回等级，默认2。'."\n" + .'1：识别出完整句子时返回识别结果；'."\n" + .'2：识别出中间结果及完整句子时返回识别结果；', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '2', + 'enum' => [ + '1', + '2', + ], + ], + 'PhraseId' => [ + 'title' => '热词表ID。', + 'type' => 'string', + 'example' => 'b401a5da78e94xxxxc3129425c78b6a5', + 'maxLength' => 50, + 'minLength' => 1, + ], + ], + ], + ], + [ + 'name' => 'AutoChapters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '章节速览功能，开启后会生成章节标题和章节摘要结果。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'title' => '是否开启。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'MeetingAssistance', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '智能纪要功能，开启后会生成关键词、重点内容、待办等结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'title' => '是否开启。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'MeetingAssistanceType' => [ + 'title' => '设置智能纪要功能的算法类型。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体算法。\\n Actions：待办事项。\\n'."\n" + .'KeyInformation：关键信息(含关键词和重点内容)。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Actions', + 'enum' => [ + 'Actions', + 'KeyInformation', + ], + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Summarization', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '摘要功能，开启后会可以生成全文摘要、发言人总结等结果。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'title' => '是否开启。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'Type' => [ + 'title' => '具体类型。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '开启摘要功能时，需传入期望的摘要类型。\\n \\n'."\n" + ."\n" + .'Paragraph：全文摘要 \\n'."\n" + .'Conversational：发言人总结摘要 \\n'."\n" + .'QuestionsAnswering：问答回顾摘要 \\n', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Conversational', + 'enum' => [ + 'Paragraph', + 'Conversational', + 'QuestionsAnswering', + ], + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'TextPolish', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '口语书面化功能。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'title' => '是否开启。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ServiceInspection', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '服务质检功能。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'title' => '是否开启。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'SceneIntroduction' => [ + 'title' => '服务质检对话场景介绍。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '汽车门店线下销售场景', + 'maxLength' => 1024, + ], + 'InspectionIntroduction' => [ + 'title' => '服务质检的检测目标和侧重点描述。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '请监测对话中销售人员表现是否接待热情、态度良好', + 'maxLength' => 1024, + ], + 'InspectionContents' => [ + 'title' => '服务质检的质检维度列表，包含质检维度名称和定义，即需要大模型以什么样的标准判断该维度是否命中。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体规则。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'title' => '服务质检的质检维度名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '到店欢迎-欢迎语', + ], + 'Content' => [ + 'title' => '服务质检的质检维度定义。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '销售在开场白的时候主动向客户打招呼进行欢迎', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CustomPrompt', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '自定义Prompt控制参数对象。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'title' => '是否开启。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'CustomPromptContents' => [ + 'title' => '自定义Prompt的参数列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体Prompt。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'Prompt的自定义名称，用于匹配输出结果。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'split-summary-demo', + ], + 'Prompt' => [ + 'title' => 'Prompt的自定义内容，需要包含{Transcription}标签，{Transcription}会被自动替换为语音转写结果来作为模型输入。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '请帮我将下面的对话进行总结，根据发言人来总结:\\n {Transcription}', + ], + 'Model' => [ + 'title' => '指定Prompt的模型，目前可选择tingwu-turbo、tingwu-plus和qwen-max。如果不填写该参数，会默认设置为tingwu-turbo。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'tingwu-turbo', + 'default' => 'tingwu-turbo', + 'enum' => [ + 'tingwu-turbo', + 'tingwu-plus', + 'qwen-max', + ], + ], + 'TransType' => [ + 'title' => '指定{Transcription}标签格式，目前可选chat和default。\\n'."\n" + ."\n" + .'\\n chat: 转写结果包含发言人信息。'."\n" + ."\n" + .'\\n default: 转写结果为纯文本格式。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'chat', + 'default' => 'default', + 'enum' => [ + 'default', + 'chat', + ], + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 3, + 'minItems' => 1, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'RealtimeSubtitle', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '实时字幕。', + 'type' => 'object', + 'properties' => [ + 'AsrCallback' => [ + 'title' => '是否开启服务端回调。', + 'type' => 'boolean', + ], + 'Enabled' => [ + 'title' => '是否开启。', + 'type' => 'boolean', + 'default' => 'false', + ], + 'Translation' => [ + 'title' => '翻译参数，具体翻译目标语言可以通过SDK设置。', + 'type' => 'object', + 'properties' => [ + 'TranslateLevel' => [ + 'title' => '翻译文本输出等级 ，默认2。'."\n" + ."\n" + .'1: 识别完整句子时返回结果。'."\n" + ."\n" + .'2: 识别中间结果及完整句子时返回结果。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '2', + 'enum' => [ + '1', + '2', + ], + ], + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '本次任务ID。', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', + ], + 'StopCloudNote' => [ + 'summary' => '停止智能纪要', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'qwsz1234', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rtc', + 'maxLength' => 55, + 'minLength' => 1, + 'pattern' => '^[\\w.-]+$', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '本次任务ID。', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', + ], + 'DescribeCloudNotes' => [ + 'summary' => '纪要列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testappid', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '311', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '页码。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'title' => '查询范围，任务开始时间开区间，单位：ms。如果不传，默认查询3天内，最长查询过去一年的录制文件。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1712376032000', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'title' => '查询范围，任务开始时间闭区间，单位：ms。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1712376532000', + ], + ], + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '任务TaskId列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体任务ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'task001', + 'maxLength' => 55, + 'minLength' => 1, + 'pattern' => '^[\\w.-]+$', + ], + 'required' => false, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '154EF5DE-3D08-1F2C-A482-281F78D74B7C', + ], + 'PageNo' => [ + 'title' => '页码。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'example' => '10', + 'default' => '10', + ], + 'TotalCnt' => [ + 'title' => '总数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Items' => [ + 'title' => '纪要结果列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'testchannelId', + ], + 'TaskId' => [ + 'title' => '任务ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'test001', + ], + 'TranscriptionFilePath' => [ + 'title' => '转写结果文件存放路径。', + 'description' => '', + 'type' => 'string', + 'example' => 'cloudNote/ksvxxppi/88_12/transcription_1724914365173.json', + ], + 'AutoChaptersFilePath' => [ + 'title' => '章节速览结果文件存放路径。', + 'description' => '', + 'type' => 'string', + 'example' => 'cloudNote/ksvxxppi/88_12/autoChapters_1724914365173.json', + ], + 'MeetingAssistanceFilePath' => [ + 'title' => '要点提炼结果文件存放路径。', + 'description' => '', + 'type' => 'string', + 'example' => 'cloudNote/ksvxxppi/88_12/meetingAssistance_1724914365173.json', + ], + 'SummarizationFilePath' => [ + 'title' => '摘要总结结果文件存放路径。', + 'description' => '', + 'type' => 'string', + 'example' => 'cloudNote/ksvxxppi/88_12/summarization_1724914365173.json', + ], + 'TextPolishFilePath' => [ + 'title' => '口语书面化结果文件存放路径。', + 'description' => '', + 'type' => 'string', + 'example' => 'cloudNote/ksvxxppi/88_12/textPolish_1724914365173.json', + ], + 'ServiceInspectionFilePath' => [ + 'title' => '服务质检结果文件存放路径。', + 'description' => '', + 'type' => 'string', + 'example' => 'cloudNote/ksvxxppi/88_12/serviceInspection_1724914365173.json', + ], + 'CustomPromptFilePath' => [ + 'title' => '自定义prompt结果文件存放路径。', + 'description' => '', + 'type' => 'string', + 'example' => 'cloudNote/ksvxxppi/88_12/customPrompt_1724914365173.json', + ], + 'Vendor' => [ + 'title' => '参考开启任务vendor。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Region' => [ + 'title' => '参考任务region。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Bucket' => [ + 'title' => '用户自定义的bucket。', + 'description' => '', + 'type' => 'string', + 'example' => 'sample-bucket', + ], + 'StartTs' => [ + 'title' => '纪要任务开始时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1731939816837', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"154EF5DE-3D08-1F2C-A482-281F78D74B7C\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCnt\\": 10,\\n \\"Items\\": [\\n {\\n \\"ChannelId\\": \\"testchannelId\\",\\n \\"TaskId\\": \\"test001\\",\\n \\"TranscriptionFilePath\\": \\"cloudNote/ksvxxppi/88_12/transcription_1724914365173.json\\",\\n \\"AutoChaptersFilePath\\": \\"cloudNote/ksvxxppi/88_12/autoChapters_1724914365173.json\\",\\n \\"MeetingAssistanceFilePath\\": \\"cloudNote/ksvxxppi/88_12/meetingAssistance_1724914365173.json\\",\\n \\"SummarizationFilePath\\": \\"cloudNote/ksvxxppi/88_12/summarization_1724914365173.json\\",\\n \\"TextPolishFilePath\\": \\"cloudNote/ksvxxppi/88_12/textPolish_1724914365173.json\\",\\n \\"ServiceInspectionFilePath\\": \\"cloudNote/ksvxxppi/88_12/serviceInspection_1724914365173.json\\",\\n \\"CustomPromptFilePath\\": \\"cloudNote/ksvxxppi/88_12/customPrompt_1724914365173.json\\",\\n \\"Vendor\\": 1,\\n \\"Region\\": 1,\\n \\"Bucket\\": \\"sample-bucket\\",\\n \\"StartTs\\": 1731939816837\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAppAgentFunctionStatus' => [ + 'summary' => '查询应用智能体开关', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + 'Result' => [ + 'title' => '开关状态；enable-开启 disable-关闭。', + 'description' => '', + 'type' => 'string', + 'example' => 'disable', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\",\\n \\"Result\\": \\"disable\\"\\n}","type":"json"}]', + ], + 'ModifyAppAgentFunctionStatus' => [ + 'summary' => '修改应用智能体开关', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '6159ba01-6687-4fb2-a831-f0cd8d188648', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6159ba01-6687-4fb2-a831-f0cd8d188648\\"\\n}","type":"json"}]', + ], + 'ModifyAppAgentTemplate' => [ + 'summary' => '更新应用智能体模版', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1231231312312131231', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '智能体模版', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '智能体类型：'."\n" + .'- 1: 语音通话（默认）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + 'enum' => [ + '1', + ], + ], + ], + [ + 'name' => 'ChatMode', + 'in' => 'query', + 'schema' => [ + 'title' => '对话模式：'."\n" + .'- 1: 自然对话模式（默认）'."\n" + .'- 2: 对讲机模式', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'InterruptMode', + 'in' => 'query', + 'schema' => [ + 'title' => '打断方式：'."\n" + .'- 1: 支持打断（默认）'."\n" + .'- 2: 禁止打断', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'Greeting', + 'in' => 'query', + 'schema' => [ + 'title' => '问候语，最大长度不超过500。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'AsrConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '语音转文字设置。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'STT', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'VocabularyId' => [ + 'title' => '热词ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0bb1776b1745123332074d1b6b', + 'maxLength' => 100, + ], + 'WordWeights' => [ + 'title' => '每个词表最多包含500个热词，每个热词中文长度不超过10个字符。'."\n" + .'热词必须为UTF-8编码，不能包含标点、特殊字符，不符合的情况下，无热词效果。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '热词权重。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Word' => [ + 'title' => '热词文本，每个词语最长10个汉字或英文单词。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '苹果', + 'minLength' => 1, + ], + 'Lang' => [ + 'title' => '语言代码。可不写，大模型会自动设别。'."\n" + .'- zh: 中文'."\n" + .'- en: 英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + 'Weight' => [ + 'title' => '热词权重，取值范围为[1, 5]之间的整数。'."\n" + .'常用值：4。'."\n" + .'如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '4', + 'default' => '4', + ], + ], + 'required' => true, + ], + 'required' => false, + ], + 'MaxSentenceSilence' => [ + 'title' => '语音断句检测阈值，默认500ms，允许范围[200，6000]。如果设置VadConfig，建议该值大于VadConfig.interruptSpeechDuration，小于1500ms。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '500', + 'default' => '500', + ], + 'VadConfig' => [ + 'title' => 'vad配置。', + 'type' => 'object', + 'properties' => [ + 'InterruptSpeechDuration' => [ + 'title' => '人声持续阈值 (ms)，取值范围为[0,3000]。持续检测到人声信号的最小时间长度，避免误打断。默认300ms', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '3000', + 'minimum' => '0', + 'example' => '1000', + 'default' => '300', + ], + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'LlmConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '大模型设置。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'llm', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'Vendor' => [ + 'title' => '提供方，目前支持阿里云-百炼和第三方配置（符合OpenAI接口规范）。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'thirdparty', + 'default' => 'aliyun', + 'enum' => [ + 'aliyun', + 'thirdparty', + ], + ], + 'Url' => [ + 'title' => '接入第三方大模型时，该字段表示接入的endpoint。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://llm.example.aliyuns.com', + 'maxLength' => 100, + ], + 'ApiKey' => [ + 'title' => '大模型服务商需要的apikey。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ak-1213123123132123131', + 'maxLength' => 200, + 'minLength' => 1, + ], + 'Temperature' => [ + 'title' => '采样温度，取值范围[0,2)，默认值0.7。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7', + 'default' => '0.7', + ], + 'TopP' => [ + 'title' => '采样的选择范围(0,1]，默认值0.8', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.8', + 'default' => '0.8', + ], + 'MaxToken' => [ + 'title' => '输出文本的最大限制，默认值8192。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1024', + 'default' => '8192', + ], + 'HistoryDepth' => [ + 'title' => '给大模型提供多少历史对话轮次，最大100，默认值3。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8', + 'default' => '50', + ], + 'Prompt' => [ + 'title' => '大模型提示词，最大长度为5000。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + 'maxLength' => 5000, + 'minLength' => 1, + ], + 'AgentAppId' => [ + 'title' => '百炼智能体ID。', + 'type' => 'string', + 'maxLength' => 500, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'TtsConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '文字转语音设置。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Tts', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'Vendor' => [ + 'title' => '提供方，目前支持阿里云-百炼。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun', + 'default' => 'aliyun', + 'enum' => [ + 'aliyun', + ], + ], + 'ApiKey' => [ + 'title' => '大模型服务商需要的apikey。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ak-1213123123132123131', + 'maxLength' => 200, + 'minLength' => 1, + ], + 'Voice' => [ + 'title' => '音色，默认音色是longxiaoxia。'."\n" + .'- longwan'."\n" + .'- longcheng'."\n" + .'- longhua'."\n" + .'- longxiaochun'."\n" + .'- longxiaoxia'."\n" + .'- longxiaocheng'."\n" + .'- longxiaobai'."\n" + .'- longlaotie'."\n" + .'- longshu'."\n" + .'- longshuo'."\n" + .'- longjing'."\n" + .'- longmiao'."\n" + .'- longyue'."\n" + .'- longyuan'."\n" + .'- longfei'."\n" + .'- longjielidou'."\n" + .'- longtong'."\n" + .'- longxiang'."\n" + .'- loongstella'."\n" + .'- loongbella', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'longwan', + 'default' => 'longxiaoxia', + 'enum' => [ + 'longwan', + 'longcheng', + 'longhua', + 'longxiaochun', + 'longxiaoxia', + 'longxiaocheng', + 'longxiaobai', + 'longlaotie', + 'longshu', + 'longshuo', + 'longjing', + 'longmiao', + 'longyue', + 'longyuan', + 'longfei', + 'longjielidou', + 'longtong', + 'longxiang', + 'loongstella', + 'loongbella', + ], + ], + 'Volume' => [ + 'title' => '音量，取值范围[0~100]，默认50。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + 'default' => '50', + ], + 'Rate' => [ + 'title' => '语速，取值范围[0.5~2.0]，默认1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.8', + 'default' => '1.0', + ], + 'Pitch' => [ + 'title' => '音调，取值范围[0.5~2.0]，默认1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.8', + 'default' => '1.0', + ], + 'FilterBrackets' => [ + 'title' => '过滤设置。'."\n" + .'- 1-中文刮号（）'."\n" + .'- 2-英文刮号()'."\n" + .'- 3-中文方刮号【】'."\n" + .'- 4-英文方刮号[]'."\n" + .'- 5-英文花刮号{}', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体字段。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [ + '1', + '2', + '3', + '4', + '5', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'AgentSilenceConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '智能体静默配置。', + 'type' => 'object', + 'properties' => [ + 'AlertTimeout' => [ + 'title' => '静默提醒的超时时间（单位：秒）。'."\n" + .'可能多次触发，若智能体静默提醒超时后依然静默，则再超时还会继续触发，取值范围：[5, 600]，默认值0，0表示不提醒', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'default' => '0', + ], + 'WebhookTriggerTimeout' => [ + 'title' => '触发智能体静默超时webhook的静默超时时间（单位：秒）。可能多次触发，若智能体webhook静默超时后依然静默，则再超时还会继续触发，取值范围：[10, 600]，默认值0，0表示不触发', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'default' => '0', + ], + 'Strategy' => [ + 'title' => '静默超时处理策略。'."\n" + .'1 - 向用户语音播报content指定的提示消息'."\n" + .'2 - 把content指定的提示消息和历史对话发送给LLM，并播报模型生成的回复'."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '2', + 'minimum' => '1', + 'example' => '2', + 'default' => '1', + ], + 'Content' => [ + 'title' => '静默提示消息的内容。', + 'type' => 'string', + 'maxLength' => 2500, + ], + ], + ], + ], + [ + 'name' => 'AmbientSoundConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '智能体环境音配置。不传表示不使用环境配置。', + 'type' => 'object', + 'properties' => [ + 'SoundId' => [ + 'title' => 'agent提供以下默认环境音：'."\n" + .' - white_noise '."\n" + .' - office', + 'type' => 'string', + 'example' => 'white_noise', + 'maxLength' => 30, + ], + 'Volume' => [ + 'title' => '音量大小。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '0', + 'example' => '100', + ], + ], + ], + ], + [ + 'name' => 'InterruptConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '智能体打断配置。', + 'type' => 'object', + 'properties' => [ + 'SemanticsInterrupt' => [ + 'title' => '按语义打断。', + 'type' => 'boolean', + ], + ], + ], + ], + [ + 'name' => 'BackChannelConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '智能体承接词配置。', + 'type' => 'object', + 'properties' => [ + 'UserTurnEnd' => [ + 'title' => '是否开启承接词。', + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + 'Id' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'example' => '1223131213231313213', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\",\\n \\"Id\\": \\"1223131213231313213\\"\\n}","type":"json"}]', + ], + 'DescribeAppAgentTemplates' => [ + 'summary' => '应用智能体模版列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '智能体模版', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123121414122313121313', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '30D41049-D02D-1C21-86AE-B3E5FD805C27', + ], + 'TotalNum' => [ + 'title' => '记录数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalPage' => [ + 'title' => '分页数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Templates' => [ + 'title' => '模版列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Greeting' => [ + 'title' => '问候语。', + 'description' => '', + 'type' => 'string', + 'example' => '你好，机器人。', + ], + 'CreateTime' => [ + 'title' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'description' => '', + 'type' => 'string', + 'example' => '2020-09-04T06:22:15Z', + ], + 'AgentSilenceConfig' => [ + 'title' => '智能体静默配置。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '静默提示消息的内容。', + 'type' => 'string', + ], + 'WebhookTriggerTimeout' => [ + 'title' => '触发智能体静默超时webhook的静默超时时间（单位：秒）。可能多次触发，若智能体webhook静默超时后依然静默，则再超时还会继续触发。', + 'type' => 'integer', + 'format' => 'int32', + ], + 'Strategy' => [ + 'title' => '静默超时处理策略。'."\n" + .'1 - 向用户语音播报content指定的提示消息'."\n" + .'2 - 把content指定的提示消息和历史对话发送给LLM，并播报模型生成的回复'."\n", + 'type' => 'integer', + 'format' => 'int32', + ], + 'AlertTimeout' => [ + 'title' => '静默提醒的超时时间（单位：秒）。'."\n" + .'可能多次触发，若智能体静默提醒超时后依然静默，则再超时还会继续触发。', + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'AmbientSoundConfig' => [ + 'title' => '环境音配置。', + 'type' => 'object', + 'properties' => [ + 'SoundId' => [ + 'title' => '环境音ID。', + 'type' => 'string', + 'example' => 'office', + ], + 'Volume' => [ + 'title' => '环境音音量大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + ], + ], + 'InterruptConfig' => [ + 'title' => '打断配置。', + 'type' => 'object', + 'properties' => [ + 'SemanticsInterrupt' => [ + 'title' => '是否开启语义打断。', + 'type' => 'boolean', + ], + ], + ], + 'BackChannelConfig' => [ + 'title' => '承接词配置。', + 'type' => 'object', + 'properties' => [ + 'UserTurnEnd' => [ + 'title' => '用户说完话之后，是否开启承接词。', + 'type' => 'boolean', + ], + ], + ], + 'InterruptMode' => [ + 'title' => '打断方式：'."\n" + .'- 1: 支持打断（默认）'."\n" + .'- 2: 禁止打断', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Name' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'example' => '测试', + ], + 'AsrConfig' => [ + 'title' => '语音转文字配置。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VocabularyId' => [ + 'title' => '热词ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'ecfadace11114cf08a7f07aceee798ad', + ], + 'MaxSentenceSilence' => [ + 'title' => '语音断句检测阈值，默认500ms，允许范围[200，6000]。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'VadConfig' => [ + 'title' => 'vad配置。', + 'type' => 'object', + 'properties' => [ + 'InterruptSpeechDuration' => [ + 'title' => '人声持续阈值 (ms)，取值范围为[0,3000]。持续检测到人声信号的最小时间长度，避免误打断。', + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'WordWeights' => [ + 'title' => '每个词表最多包含500个热词，每个热词中文长度不超过10个字符。'."\n" + .'热词必须为UTF-8编码，不能包含标点、特殊字符，不符合的情况下，无热词效果。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '热词权重。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Word' => [ + 'title' => '热词文本，每个词语最长10个汉字或英文单词。', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Lang' => [ + 'title' => '语言代码。', + 'description' => '', + 'type' => 'string', + 'example' => 'zh', + ], + 'Weight' => [ + 'title' => '热词权重，取值范围为[1, 5]之间的整数。'."\n" + .'常用值：4。'."\n" + .'如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'required' => true, + ], + ], + 'Name' => [ + 'title' => '名称。', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + 'Type' => [ + 'title' => '智能体类型：'."\n" + .'- 1: 语音通话（默认）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LlmConfig' => [ + 'title' => '大模型设置。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Temperature' => [ + 'title' => '采样温度，取值范围[0,2)，默认值0.7。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + ], + 'ApiKey' => [ + 'title' => '大模型服务商需要的apikey。', + 'description' => '', + 'type' => 'string', + 'example' => 'qW8GpBOdHK/pv9gdUSVLvQ==', + ], + 'MaxToken' => [ + 'title' => '输出文本的最大限制，默认值8192。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'Model' => [ + 'title' => '模型，阿里云百炼，目前支持模型为qwen-plus和deepseek-r1，bailianAgent。', + 'description' => '', + 'type' => 'string', + 'example' => 'deepseek-r1', + ], + 'HistoryDepth' => [ + 'title' => '给大模型提供多少历史对话轮次，最大100，默认值3。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'Prompt' => [ + 'title' => '大模型提示词，最大长度为5000。', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'AgentAppId' => [ + 'title' => '当model是百炼智能体时，标识智能体AppId。', + 'type' => 'string', + ], + 'Vendor' => [ + 'title' => '提供方，目前支持阿里云-百炼和第三方配置（符合OpenAI接口规范）。', + 'description' => '', + 'type' => 'string', + 'example' => 'aliyun', + ], + 'TopP' => [ + 'title' => '采样的选择范围(0,1]，默认值0.8', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + ], + 'Url' => [ + 'title' => '接入第三方大模型时，该字段表示接入的endpoint。', + 'description' => '', + 'type' => 'string', + 'example' => 'https://test.com', + ], + 'Name' => [ + 'title' => '名称。', + 'description' => '', + 'type' => 'string', + 'example' => 'llm', + ], + ], + ], + 'TtsConfig' => [ + 'title' => '文字转语音设置。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ApiKey' => [ + 'title' => '大模型服务商需要的apikey。', + 'description' => '', + 'type' => 'string', + 'example' => 'N5448VFGI2mXJU8a/A03VQ==', + ], + 'FilterBrackets' => [ + 'title' => '过滤设置。'."\n" + .'- 1-中文刮号（）'."\n" + .'- 2-英文刮号()'."\n" + .'- 3-中文方刮号【】'."\n" + .'- 4-英文方刮号[]'."\n" + .'- 5-英文花刮号{}', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体字段。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'Volume' => [ + 'title' => '音量，取值范围[0~100]，默认50。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Rate' => [ + 'title' => '语速，取值范围[0.5~2.0]，默认1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '50', + ], + 'Model' => [ + 'title' => '模型，阿里云百炼，目前支持模型为cosyvoice-v1。', + 'description' => '', + 'type' => 'string', + 'example' => 'cosyvoice-v1', + ], + 'Pitch' => [ + 'title' => '音调，取值范围[0.5~2.0]，默认1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + ], + 'Vendor' => [ + 'title' => '提供方，目前支持阿里云-百炼。', + 'description' => '', + 'type' => 'string', + 'example' => 'aliyun', + ], + 'Voice' => [ + 'title' => '音色，默认音色是longxiaoxia。'."\n" + .'- longwan'."\n" + .'- longcheng'."\n" + .'- longhua'."\n" + .'- longxiaochun'."\n" + .'- longxiaoxia'."\n" + .'- longxiaocheng'."\n" + .'- longxiaobai'."\n" + .'- longlaotie'."\n" + .'- longshu'."\n" + .'- longshuo'."\n" + .'- longjing'."\n" + .'- longmiao'."\n" + .'- longyue'."\n" + .'- longyuan'."\n" + .'- longfei'."\n" + .'- longjielidou'."\n" + .'- longtong'."\n" + .'- longxiang'."\n" + .'- loongstella'."\n" + .'- loongbella', + 'description' => '', + 'type' => 'string', + 'example' => 'longwan', + ], + 'Name' => [ + 'title' => '名称。', + 'description' => '', + 'type' => 'string', + 'example' => 'Tts', + ], + ], + ], + 'Id' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'wv7N****', + ], + 'ChatMode' => [ + 'title' => '对话模式：'."\n" + .'- 1: 自然对话模式（默认）'."\n" + .'- 2: 对讲机模式', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30D41049-D02D-1C21-86AE-B3E5FD805C27\\",\\n \\"TotalNum\\": 10,\\n \\"TotalPage\\": 1,\\n \\"Templates\\": [\\n {\\n \\"Greeting\\": \\"你好，机器人。\\",\\n \\"CreateTime\\": \\"2020-09-04T06:22:15Z\\",\\n \\"AgentSilenceConfig\\": {\\n \\"Content\\": \\"你好，还在吗？\\",\\n \\"WebhookTriggerTimeout\\": 50,\\n \\"Strategy\\": 1,\\n \\"AlertTimeout\\": 60\\n },\\n \\"AmbientSoundConfig\\": {\\n \\"SoundId\\": \\"office\\",\\n \\"Volume\\": 50\\n },\\n \\"InterruptConfig\\": {\\n \\"SemanticsInterrupt\\": true\\n },\\n \\"BackChannelConfig\\": {\\n \\"UserTurnEnd\\": true\\n },\\n \\"InterruptMode\\": 1,\\n \\"Name\\": \\"测试\\",\\n \\"AsrConfig\\": {\\n \\"VocabularyId\\": \\"ecfadace11114cf08a7f07aceee798ad\\",\\n \\"MaxSentenceSilence\\": 300,\\n \\"VadConfig\\": {\\n \\"InterruptSpeechDuration\\": 1200\\n },\\n \\"WordWeights\\": [\\n {\\n \\"Word\\": \\"德州\\",\\n \\"Lang\\": \\"zh\\",\\n \\"Weight\\": 1\\n }\\n ],\\n \\"Name\\": \\"Asr配置\\"\\n },\\n \\"Type\\": 1,\\n \\"LlmConfig\\": {\\n \\"Temperature\\": 0.8,\\n \\"ApiKey\\": \\"qW8GpBOdHK/pv9gdUSVLvQ==\\",\\n \\"MaxToken\\": 1024,\\n \\"Model\\": \\"deepseek-r1\\",\\n \\"HistoryDepth\\": 8,\\n \\"Prompt\\": \\"你是一个高级心理医生\\",\\n \\"AgentAppId\\": \\"1233312\\",\\n \\"Vendor\\": \\"aliyun\\",\\n \\"TopP\\": 0.8,\\n \\"Url\\": \\"https://test.com\\",\\n \\"Name\\": \\"llm\\"\\n },\\n \\"TtsConfig\\": {\\n \\"ApiKey\\": \\"N5448VFGI2mXJU8a/A03VQ==\\",\\n \\"FilterBrackets\\": [\\n 1\\n ],\\n \\"Volume\\": 50,\\n \\"Rate\\": 50,\\n \\"Model\\": \\"cosyvoice-v1\\",\\n \\"Pitch\\": 0.8,\\n \\"Vendor\\": \\"aliyun\\",\\n \\"Voice\\": \\"longwan\\",\\n \\"Name\\": \\"Tts\\"\\n },\\n \\"Id\\": \\"wv7N****\\",\\n \\"ChatMode\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'DeleteAppAgentTemplate' => [ + 'summary' => '删除应用智能体模版', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1213123142124124124214', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + 'Id' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'example' => '1223131213231313213', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\",\\n \\"Id\\": \\"1223131213231313213\\"\\n}","type":"json"}]', + ], + 'CreateAppAgentTemplate' => [ + 'summary' => '创建应用智能体模版', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '智能体模版', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '智能体类型：'."\n" + .'- 1: 语音通话（默认）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + 'enum' => [ + '1', + ], + ], + ], + [ + 'name' => 'ChatMode', + 'in' => 'query', + 'schema' => [ + 'title' => '对话模式：'."\n" + .'- 1: 自然对话模式（默认）'."\n" + .'- 2: 对讲机模式', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'InterruptMode', + 'in' => 'query', + 'schema' => [ + 'title' => '打断方式：'."\n" + .'- 1: 支持打断（默认）'."\n" + .'- 2: 禁止打断', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'Greeting', + 'in' => 'query', + 'schema' => [ + 'title' => '问候语，最大长度不超过500。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'AsrConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '语音转文字设置。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'STT', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'MaxSentenceSilence' => [ + 'title' => '语音断句检测阈值，默认500ms，允许范围[200，6000]。如果设置VadConfig，建议该值大于VadConfig.interruptSpeechDuration，小于1500ms。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + 'default' => '500', + ], + 'WordWeights' => [ + 'title' => '每个词表最多包含500个热词，每个热词中文长度不超过10个字符。'."\n" + .'热词必须为UTF-8编码，不能包含标点、特殊字符，不符合的情况下，无热词效果。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '热词权重。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Word' => [ + 'title' => '热词文本，每个词语最长10个汉字或英文单词。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '苹果', + 'minLength' => 1, + ], + 'Lang' => [ + 'title' => '语言代码。可不写，大模型会自动设别。'."\n" + .'- zh: 中文'."\n" + .'- en: 英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + 'Weight' => [ + 'title' => '热词权重，取值范围为[1, 5]之间的整数。'."\n" + .'常用值：4。'."\n" + .'如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '4', + 'default' => '4', + ], + ], + 'required' => true, + ], + 'required' => false, + ], + 'VadConfig' => [ + 'title' => 'vad配置。', + 'type' => 'object', + 'properties' => [ + 'InterruptSpeechDuration' => [ + 'title' => '人声持续阈值 (ms)，取值范围为[0,3000]。持续检测到人声信号的最小时间长度，避免误打断。默认300ms', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '3000', + 'minimum' => '0', + 'example' => '1000', + 'default' => '300', + ], + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'LlmConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '大模型设置。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'llm', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'Vendor' => [ + 'title' => '提供方，目前支持阿里云-百炼和第三方配置（符合OpenAI接口规范）。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'thirdparty', + 'default' => 'aliyun', + 'enum' => [ + 'aliyun', + 'thirdparty', + ], + ], + 'Url' => [ + 'title' => '接入第三方大模型时，该字段表示接入的endpoint。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://llm.example.aliyuns.com', + 'maxLength' => 100, + ], + 'ApiKey' => [ + 'title' => '大模型服务商需要的apikey。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ak-1213123123132123131', + 'maxLength' => 200, + 'minLength' => 1, + ], + 'Temperature' => [ + 'title' => '采样温度，取值范围[0,2)，默认值0.7。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.9', + 'default' => '0.7', + ], + 'TopP' => [ + 'title' => '采样的选择范围(0,1]，默认值0.8', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.8', + 'default' => '0.8', + ], + 'MaxToken' => [ + 'title' => '输出文本的最大限制，默认值8192。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1024', + 'default' => '8192', + ], + 'HistoryDepth' => [ + 'title' => '给大模型提供多少历史对话轮次，最大100，默认值3。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'default' => '50', + ], + 'Prompt' => [ + 'title' => '大模型提示词，最大长度为5000。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + 'maxLength' => 5000, + 'minLength' => 1, + ], + 'AgentAppId' => [ + 'title' => '百炼智能体ID。', + 'type' => 'string', + 'maxLength' => 500, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'TtsConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '文字转语音设置。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Tts', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'Vendor' => [ + 'title' => '提供方，目前支持阿里云-百炼。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun', + 'default' => 'aliyun', + 'enum' => [ + 'aliyun', + ], + ], + 'ApiKey' => [ + 'title' => '大模型服务商需要的apikey。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ak-1213123123132123131', + 'maxLength' => 200, + 'minLength' => 1, + ], + 'Voice' => [ + 'title' => '音色，默认音色是longxiaoxia。'."\n" + .'- longwan'."\n" + .'- longcheng'."\n" + .'- longhua'."\n" + .'- longxiaochun'."\n" + .'- longxiaoxia'."\n" + .'- longxiaocheng'."\n" + .'- longxiaobai'."\n" + .'- longlaotie'."\n" + .'- longshu'."\n" + .'- longshuo'."\n" + .'- longjing'."\n" + .'- longmiao'."\n" + .'- longyue'."\n" + .'- longyuan'."\n" + .'- longfei'."\n" + .'- longjielidou'."\n" + .'- longtong'."\n" + .'- longxiang'."\n" + .'- loongstella'."\n" + .'- loongbella', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'longcheng', + 'default' => 'longxiaoxia', + 'enum' => [ + 'longcheng', + 'longhua', + 'longxiaochun', + 'longxiaoxia', + 'longxiaocheng', + 'longxiaobai', + 'longlaotie', + 'longshu', + 'longshuo', + 'longjing', + 'longmiao', + 'longyue', + 'longyuan', + 'longfei', + 'longjielidou', + 'longtong', + 'longxiang', + 'loongstella', + 'loongbella', + 'longwan', + ], + ], + 'Volume' => [ + 'title' => '音量，取值范围[0~100]，默认50。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '70', + 'default' => '50', + ], + 'Rate' => [ + 'title' => '语速，取值范围[0.5~2.0]，默认1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.8', + 'default' => '1.0', + ], + 'Pitch' => [ + 'title' => '音调，取值范围[0.5~2.0]，默认1.0。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.8', + 'default' => '1.0', + ], + 'FilterBrackets' => [ + 'title' => '过滤设置。'."\n" + .'- 1-中文刮号（）'."\n" + .'- 2-英文刮号()'."\n" + .'- 3-中文方刮号【】'."\n" + .'- 4-英文方刮号[]'."\n" + .'- 5-英文花刮号{}', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体字段。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [ + '1', + '2', + '3', + '4', + '5', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'AgentSilenceConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '智能体静默配置。', + 'type' => 'object', + 'properties' => [ + 'AlertTimeout' => [ + 'title' => '静默提醒的超时时间（单位：秒）。'."\n" + .'可能多次触发，若智能体静默提醒超时后依然静默，则再超时还会继续触发，取值范围：[5, 600]，默认值0，0表示不提醒', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'default' => '0', + ], + 'WebhookTriggerTimeout' => [ + 'title' => '触发智能体静默超时webhook的静默超时时间（单位：秒）。可能多次触发，若智能体webhook静默超时后依然静默，则再超时还会继续触发，取值范围：[10, 600]，默认值0，0表示不触发', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'default' => '0', + ], + 'Strategy' => [ + 'title' => '静默超时处理策略。'."\n" + .'1 - 向用户语音播报content指定的提示消息'."\n" + .'2 - 把content指定的提示消息和历史对话发送给LLM，并播报模型生成的回复'."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '2', + 'minimum' => '1', + 'example' => '2', + 'default' => '1', + ], + 'Content' => [ + 'title' => '静默提示消息的内容。', + 'type' => 'string', + 'maxLength' => 2500, + ], + ], + ], + ], + [ + 'name' => 'AmbientSoundConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '智能体环境音配置。不传表示不使用环境配置。', + 'type' => 'object', + 'properties' => [ + 'SoundId' => [ + 'title' => 'agent提供以下默认环境音：'."\n" + .' - white_noise '."\n" + .' - office', + 'type' => 'string', + 'example' => 'white_noise', + 'maxLength' => 30, + ], + 'Volume' => [ + 'title' => '音量大小。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '0', + 'example' => '100', + ], + ], + ], + ], + [ + 'name' => 'InterruptConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '智能体打断配置。', + 'type' => 'object', + 'properties' => [ + 'SemanticsInterrupt' => [ + 'title' => '按语义打断。', + 'type' => 'boolean', + ], + ], + ], + ], + [ + 'name' => 'BackChannelConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '智能体承接词配置。', + 'type' => 'object', + 'properties' => [ + 'UserTurnEnd' => [ + 'title' => '是否开启承接词。', + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '6159ba01-6687-4fb2-a831-f0cd8d188648', + ], + 'Id' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'example' => '1223131213231313213', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6159ba01-6687-4fb2-a831-f0cd8d188648\\",\\n \\"Id\\": \\"1223131213231313213\\"\\n}","type":"json"}]', + ], + 'StartAgent' => [ + 'summary' => '启动AI Agent', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'aoe****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourChannelId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourTaskId', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '76dasgb****', + ], + ], + [ + 'name' => 'RtcConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '智能体在rtc频道中的userId', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '423341', + ], + 'TargetUserIds' => [ + 'title' => '智能体订阅的用户userId列表，目前仅支持一个', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'userId', + 'type' => 'string', + 'required' => false, + 'example' => '41411', + ], + 'required' => false, + ], + 'UserInactivityTimeout' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'VoiceChatConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ChatMode' => [ + 'title' => '1-自然对话模式 (默认值); 2-对讲机模式', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'InterruptMode' => [ + 'title' => '1-支持语音打断 (默认值)，2-禁用语音打断', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Greeting' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'ASRConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SourceLanguage' => [ + 'title' => '语种', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + 'SemanticPunctuationEnabled' => [ + 'title' => '语义断句/语音断句', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'MaxSentenceSilence' => [ + 'title' => '语音断句检测阈值，默认800ms，参考范围[200,6000]', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '800', + ], + 'VocabularyId' => [ + 'title' => 'paraformer-realtime-v2支持的热词ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vocab-xxx-24ee19fa8cfb4d52902170a0xxxxxxxx', + ], + 'LanguageHints' => [ + 'title' => '指定识别语音中语言的代码列表。支持的语言代码：zh: 中文（包含中文普通话和各种方言）;en: 英文;ja: 日语;yue: 粤语;ko: 韩语。如果不填写则模型会自动识别语种。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + 'required' => false, + ], + 'VadConfig' => [ + 'type' => 'object', + 'properties' => [ + 'InterruptSpeechDuration' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + 'required' => false, + ], + 'LLMConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'title' => '服务提供商。如果服务商是云平台，示例：aliyun，microsoft，volcano；如果服务商是模型开发商，示例：openai, deepseek', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun', + ], + 'Model' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'qwen-plus', + ], + 'ApiKey' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxxxxxxx', + ], + 'Temperature' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.7', + ], + 'TopP' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.8', + ], + 'MaxToken' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '500', + ], + 'HistoryDepth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Prompt' => [ + 'title' => '用于告知模型要扮演的角色或行为', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxxxx', + ], + 'Params' => [ + 'type' => 'object', + ], + 'AppId' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + 'TTSConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun', + ], + 'Model' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cosyvoice-v1', + ], + 'ApiKey' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxx', + ], + 'Voice' => [ + 'title' => '音色，选择定制模型支持的音色', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'longxiaoxia', + ], + 'Volume' => [ + 'title' => '音量（int），[0~100]，默认50', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'Rate' => [ + 'title' => '语速（float）[0.5~2.0]，默认1.0', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '1', + ], + 'Pitch' => [ + 'title' => '音调（float）[0.5~2.0]，默认1.0', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '1', + ], + 'FilterBrackets' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '[1,2]', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'AgentSilenceConfig' => [ + 'title' => '智能体静默超时处理配置', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '是否启用智能体静默超时处理机制。'."\n" + .'当用户加入频道后，但未与智能体进行有效交互（用户未发言），此时智能体处于静默状态，当静默时间超过设置的阈值后，会通过语音定期提醒用户。定期通知时间间隔和设置的阈值一样。'."\n" + .'默认值：false', + 'type' => 'boolean', + ], + 'AlertTimeout' => [ + 'title' => '智能体最大静默时间阈值（单位：秒）。'."\n" + .'取值范围：[5, 60]，默认值', + 'type' => 'integer', + 'format' => 'int32', + ], + 'Strategy' => [ + 'title' => '静默超时处理策略。'."\n" + .'1 - 向用户语音播报content指定的提示消息'."\n" + .'2 - 把content指定的提示消息和历史对话发送给LLM，并播报模型生成的回复'."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + ], + 'Content' => [ + 'title' => '静默提示消息的内容', + 'type' => 'string', + ], + 'WebhookTriggerTimeout' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'AmbientSoundConfig' => [ + 'title' => '环境音配置', + 'type' => 'object', + 'properties' => [ + 'SoundId' => [ + 'title' => '静默提示消息的内容', + 'type' => 'string', + 'example' => 'office', + ], + 'Volume' => [ + 'title' => '音量大小。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '0', + 'example' => '100', + ], + ], + ], + 'InterruptConfig' => [ + 'title' => '打断配置', + 'type' => 'object', + 'properties' => [ + 'SemanticsInterrupt' => [ + 'title' => '智能语义打断', + 'type' => 'boolean', + ], + ], + ], + 'BackChannelConfig' => [ + 'title' => '打断配置', + 'type' => 'object', + 'properties' => [ + 'UserTurnEnd' => [ + 'title' => '智能语义打断', + 'type' => 'boolean', + ], + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '6159ba01-6687-4fb2-a831-f0cd8d188648', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6159ba01-6687-4fb2-a831-f0cd8d188648\\"\\n}","type":"json"}]', + ], + 'GetAgent' => [ + 'summary' => 'GetAgent。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aec****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'yourTaskId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '6159ba01-6687-4fb2-a831-f0cd8d188648', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1751513144838', + ], + 'StopTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1751513144838', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6159ba01-6687-4fb2-a831-f0cd8d188648\\",\\n \\"StartTime\\": \\"1751513144838\\",\\n \\"StopTime\\": \\"1751513144838\\",\\n \\"Status\\": \\"1\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]', + ], + 'UpdateAgent' => [ + 'summary' => '更新AI Agent', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '4eah****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourChannelId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourTaskId', + ], + ], + [ + 'name' => 'VoiceChatConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InterruptMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'ChatMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","type":"json"}]', + ], + 'NotifyAgent' => [ + 'summary' => 'NotifyAgent', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aec****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'yourChannelId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'yourTaskId', + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Interruptable', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'CustomAttribute', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"color\\":\\"blue\\"}', + ], + ], + [ + 'name' => 'BackgroundMusic', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '背景音。', + 'type' => 'object', + 'properties' => [ + 'format' => [ + 'title' => '格式。'."\n" + .'- wav', + 'type' => 'string', + 'example' => 'wav', + 'default' => 'wav', + 'enum' => [ + 'wav', + ], + ], + 'url' => [ + 'title' => '资源地址。', + 'type' => 'string', + 'maxLength' => 1000, + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","type":"json"}]', + ], + 'StopAgent' => [ + 'summary' => '停止AI Agent', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'aec****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourChannelId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourTaskId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","type":"json"}]', + ], + 'DescribeAppViewStatus' => [ + 'summary' => '查看合流开关', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + 'Result' => [ + 'title' => '开关状态；enable-开启 disable-关闭。', + 'description' => '', + 'type' => 'string', + 'example' => 'disable', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\",\\n \\"Result\\": \\"disable\\"\\n}","type":"json"}]', + ], + 'ModifyAppViewStatus' => [ + 'summary' => '修改合流开关', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '94D9A316-9750-5928-B18C-59DF182F6BF7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94D9A316-9750-5928-B18C-59DF182F6BF7\\"\\n}","type":"json"}]', + ], + 'CreateAppViewTemplate' => [ + 'summary' => '创建应用合流模版', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '模版。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '模版', + ], + 'LayoutIds' => [ + 'title' => '布局ID列表，最多16个。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体的布局ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '22', + 'pattern' => '^\\d+$', + ], + 'required' => true, + 'pattern' => '^\\d+$', + 'maxItems' => 16, + 'minItems' => 1, + ], + 'MediaEncode' => [ + 'title' => '编码选项。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'default' => '1', + 'enum' => [ + '1', + '54', + '53', + '52', + '10', + '20', + '22', + '23', + '30', + '31', + '24', + '25', + '26', + '27', + '28', + '32', + '33', + '34', + '35', + '36', + '37', + '38', + '39', + '40', + '41', + '42', + '43', + '0', + '60', + '61', + ], + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '30D41049-D02D-1C21-86AE-B3E5FD805C27', + ], + 'TemplateId' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'bc5v****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Function.Disable', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Quota.Invalid', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30D41049-D02D-1C21-86AE-B3E5FD805C27\\",\\n \\"TemplateId\\": \\"bc5v****\\"\\n}","type":"json"}]', + ], + 'ModifyAppViewTemplate' => [ + 'summary' => '更新应用合流模版', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'wv7N****', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '模版。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '模版', + ], + 'LayoutIds' => [ + 'title' => '布局ID列表，最多16个。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体的布局ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '22', + 'pattern' => '^\\d+$', + ], + 'required' => true, + 'pattern' => '^\\d+$', + 'maxItems' => 16, + 'minItems' => 1, + ], + 'MediaEncode' => [ + 'title' => '编码选项。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'default' => '1', + 'enum' => [ + '1', + '54', + '53', + '52', + '10', + '20', + '22', + '23', + '30', + '31', + '24', + '25', + '26', + '27', + '28', + '32', + '33', + '34', + '35', + '36', + '37', + '38', + '39', + '40', + '41', + '42', + '43', + '0', + '60', + '61', + ], + ], + 'TemplateId' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac7N****', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '30D41049-D02D-1C21-86AE-B3E5FD805C27', + ], + 'TemplateId' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'ac7N****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Function.Disable', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30D41049-D02D-1C21-86AE-B3E5FD805C27\\",\\n \\"TemplateId\\": \\"ac7N****\\"\\n}","type":"json"}]', + ], + 'DescribeAppViewTemplates' => [ + 'summary' => '应用合流模版列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ioeh****', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，默认查询第1页。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页显示个数，默认为10。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Condition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '搜索条件。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Bj6D****', + ], + 'Name' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'B0A2FCBC-43A4-428F-BC1D-3F4F85837F76', + ], + 'TotalNum' => [ + 'title' => '记录数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalPage' => [ + 'title' => '分页数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Templates' => [ + 'title' => '模版列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'description' => '', + 'type' => 'string', + 'example' => '2020-09-04T06:22:15Z', + ], + 'MediaEncode' => [ + 'title' => '编码选项。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LayoutIds' => [ + 'title' => '布局ID列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体的布局ID。', + 'description' => '', + 'type' => 'string', + 'example' => '22', + ], + ], + 'TemplateId' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'Bj6D****', + ], + 'Name' => [ + 'title' => '模版名称。', + 'description' => '', + 'type' => 'string', + 'example' => '模版名称', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B0A2FCBC-43A4-428F-BC1D-3F4F85837F76\\",\\n \\"TotalNum\\": 10,\\n \\"TotalPage\\": 1,\\n \\"Templates\\": [\\n {\\n \\"CreateTime\\": \\"2020-09-04T06:22:15Z\\",\\n \\"MediaEncode\\": 1,\\n \\"LayoutIds\\": [\\n \\"22\\"\\n ],\\n \\"TemplateId\\": \\"Bj6D****\\",\\n \\"Name\\": \\"模板名称\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DeleteAppViewTemplate' => [ + 'summary' => '删除应用合流模版', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'wv7N****', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '模版信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模版ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'xd4c****', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '30D41049-D02D-1C21-86AE-B3E5FD825C17', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'Function.Disable', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30D41049-D02D-1C21-86AE-B3E5FD825C17\\"\\n}","type":"json"}]', + ], + 'RtcSipInviteMember' => [ + 'summary' => '邀请SIP加入频道', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'DeviceType', + 'in' => 'query', + 'schema' => [ + 'title' => '呼叫第三方sip的设备类型：'."\n" + .'- sip_device'."\n" + .'- mcu'."\n" + .'- phone', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'mcu', + 'enum' => [ + 'sip_device', + 'mcu', + 'phone', + ], + ], + ], + [ + 'name' => 'ServerAddress', + 'in' => 'query', + 'schema' => [ + 'title' => '就近接入 rtc sip 服务器IP地址。用户通过本地进行解析域名:sip.dingtalk.com获取到就近接入地址。'."\n" + .'比如dig sip.dingtalk.com获取', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.116.80.180', + ], + ], + [ + 'name' => 'AppToken', + 'in' => 'query', + 'schema' => [ + 'title' => '入会token。生成代码参考https://help.aliyun.com/document_detail/2689025.html', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '000qaaasas……b', + ], + ], + [ + 'name' => 'Registered', + 'in' => 'query', + 'schema' => [ + 'title' => '第三方会议系统是否要注册呼入。', + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'SipDisplayName', + 'in' => 'query', + 'schema' => [ + 'title' => '在第三方显示的user名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ceo', + 'maxLength' => 200, + 'minLength' => 1, + ], + ], + [ + 'name' => 'SipUserId', + 'in' => 'query', + 'schema' => [ + 'title' => '当DeviceType = mcu ，代表第三方会议系统'."\n" + .'当DeviceType = sip_device 代表注册设备'."\n" + .'如果第三方会议系统要求注册呼入，则为第三方系统提供的注册账号'."\n" + .'如果不需要注册呼叫，则为呼入第三方的sip用户名rtc userid', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'SipUserPassword', + 'in' => 'query', + 'schema' => [ + 'title' => '如果第三方要注册呼入，匹配SipUserId的注册密码。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'SipRoomId', + 'in' => 'query', + 'schema' => [ + 'title' => '当设备是mcu时，表示呼入的第三方会议系统的频道号码'."\n" + ."\n" + .'当设备是sip_device时，表示要邀请的注册设备的注册号码'."\n" + ."\n" + .'当设备是phone时，表示被叫的电话号码', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'SipUri', + 'in' => 'query', + 'schema' => [ + 'title' => '当设备是mcu 表示第三方会议系统的地址信息ip:port;transport=tcp/udp/tls'."\n" + .'如："30.240.160.66:5060;transport=tcp"'."\n" + ."\n" + .'当设备是sip_device 表示要邀请的注册设备的注册地址'."\n" + .'如: 47.116.80.116'."\n" + ."\n" + .'当设备是phone 表示电话网关的地址信息'."\n" + .'如："30.240.160.66:5060;transport=tcp"', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30.240.160.66:5060;transport=tcp', + ], + ], + [ + 'name' => 'SipUserAgent', + 'in' => 'query', + 'schema' => [ + 'title' => '呼叫第三方sip的品牌型号 如polycom/cisco/tencent/zoom/pstn', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pstn', + 'enum' => [ + 'polycom', + 'cisco', + 'tencent', + 'zoom', + 'pstn', + ], + ], + ], + [ + 'name' => 'CallNumber', + 'in' => 'query', + 'schema' => [ + 'title' => 'pstn场景下自定义线路号码。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '055112345678', + 'maxLength' => 30, + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID。', + 'type' => 'string', + 'example' => 'taskId', + 'maxLength' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', + ], + 'RtcCancelSipInvite' => [ + 'summary' => '取消Sip邀请', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + 'maxLength' => 120, + 'minLength' => 1, + ], + ], + [ + 'name' => 'DeviceType', + 'in' => 'query', + 'schema' => [ + 'title' => '第三方sip的设备类型：'."\n" + .'- sip_device'."\n" + .'- mcu'."\n" + .'- phone', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'mcu', + 'enum' => [ + 'sip_device', + 'mcu', + 'phone', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EB3C3C75-74D5-5F01-9F3C-9974261BAED4', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB3C3C75-74D5-5F01-9F3C-9974261BAED4\\"\\n}","type":"json"}]', + ], + 'StartView' => [ + 'summary' => '开始合流', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '567', + 'maxLength' => 128, + 'minLength' => 1, + 'pattern' => '^[\\w.-]+$', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '本次任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + 'maxLength' => 55, + 'minLength' => 1, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + [ + 'name' => 'CropMode', + 'in' => 'query', + 'schema' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边（默认值）。'."\n" + .'- **3**：拉伸铺满。'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'StartWithoutChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '是否允许频道不存在时开启任务。'."\n" + ."\n" + .'- true: 是'."\n" + .'- false: 否（默认值）', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + [ + 'name' => 'StartWithoutChannelWaitTime', + 'in' => 'query', + 'schema' => [ + 'title' => '当StartWithoutChannel参数为true的时候，设置该值才有意义，表示房间未开启时，任务等待时长，单位为秒，区间限制为[30,120]。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'RegionColor', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局框格底色', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'title' => 'R。', + 'description' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + 'G' => [ + 'title' => 'G。', + 'description' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + 'B' => [ + 'title' => 'B。', + 'description' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '-1', + 'example' => '255', + 'default' => '0', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'BgColor', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局背景色', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'title' => 'R。', + 'description' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '0', + ], + 'G' => [ + 'title' => 'G。', + 'description' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '0', + ], + 'B' => [ + 'title' => 'B。', + 'description' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '255', + 'minimum' => '0', + 'example' => '255', + 'default' => '0', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ViewSubscribers', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'title' => '允许看主流或者共享流画面的SIP设备的用户ID列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体用户ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ViewContent', + 'in' => 'query', + 'schema' => [ + 'title' => '流属性'."\n" + .'- main: 主流画面'."\n" + .'- screen-cast: 共享画面', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'main', + 'default' => 'main', + 'enum' => [ + 'main', + 'screen-cast', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'FA2F9DE9-8EAD-580E-87DF-A3D25EE87C37', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"FA2F9DE9-8EAD-580E-87DF-A3D25EE87C37\\"\\n}","type":"json"}]', + ], + 'StopView' => [ + 'summary' => '停止合流', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存的任务ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + 'maxLength' => 55, + 'minLength' => 1, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '任务ID。', + 'description' => '', + 'type' => 'string', + 'example' => '2bd80921b81e4d4289f696606885606b', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'E8236D21-B690-5251-A361-5971FBF552BA', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"2bd80921b81e4d4289f696606885606b\\",\\n \\"RequestId\\": \\"E8236D21-B690-5251-A361-5971FBF552BA\\"\\n}","type":"json"}]', + ], + 'RtcSipMute' => [ + 'summary' => 'Mute操作', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'Operations', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '操作。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体操作。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'title' => '操作范围。'."\n" + .'- /media/audio/status 修改该用户音频流状态', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '/media/audio/status', + 'default' => '/media/audio/status', + 'enum' => [ + '/media/audio/status', + ], + ], + 'Op' => [ + 'title' => '操作类型。'."\n" + .'- replace', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'replace', + 'default' => 'replace', + ], + 'OperationId' => [ + 'title' => '操作ID，当部分操作失败时，可以排查对应ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12122121', + ], + 'Value' => [ + 'title' => '操作值。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '实际值。'."\n" + .'- active 开麦'."\n" + .'- inactive 闭麦', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'inactive', + 'enum' => [ + 'inactive', + 'active', + ], + ], + ], + 'required' => true, + ], + 'Ids' => [ + 'title' => '用户ID列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体用户ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12', + ], + 'required' => true, + 'maxItems' => 16, + 'minItems' => 1, + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 5, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'E7997404-5858-5C4D-94E4-33677412ACDC', + ], + 'ErrTracks' => [ + 'title' => '错误跟踪。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体错误。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'Id。', + 'description' => '', + 'type' => 'string', + 'example' => '12', + ], + 'OperationId' => [ + 'title' => 'OperationId。', + 'description' => 'OperationId。', + 'type' => 'string', + 'example' => '12122121', + ], + 'ErrMsg' => [ + 'title' => 'ErrMsg。', + 'description' => 'ErrMsg。', + 'type' => 'string', + 'example' => 'participant does not existed.', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7997404-5858-5C4D-94E4-33677412ACDC\\",\\n \\"ErrTracks\\": [\\n {\\n \\"Id\\": \\"12\\",\\n \\"OperationId\\": \\"12122121\\",\\n \\"ErrMsg\\": \\"participant does not existed.\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ModifyViewLayout' => [ + 'summary' => '设置合流布局', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模版ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '567', + 'maxLength' => 128, + 'minLength' => 1, + 'pattern' => '^[\\w.-]+$', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + 'maxLength' => 55, + 'minLength' => 1, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + [ + 'name' => 'Panes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '单元格设置，做多设置16个。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceType' => [ + 'title' => '单元格媒体类型。取值：'."\n" + .'- **video**：用户摄像头或者屏幕共享流（默认值）。'."\n" + .'- **camera**：摄像头流。'."\n" + .'- **screen**：共享屏幕流。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + 'default' => 'video', + 'enum' => [], + ], + 'Images' => [ + 'title' => '窗格局部图片水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PaneImageCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Alpha' => [ + 'title' => '透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.3', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123xxx.jpg', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + 'Texts' => [ + 'title' => '窗格局部文字水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'default' => '5', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'description' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '30', + ], + 'B' => [ + 'description' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '30', + ], + 'G' => [ + 'description' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '30', + ], + ], + 'required' => false, + ], + 'FontSize' => [ + 'title' => '字体大小。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '36', + 'default' => '30', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'description' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '255', + ], + 'B' => [ + 'description' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '255', + ], + 'G' => [ + 'description' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '255', + ], + ], + 'required' => false, + ], + 'Alpha' => [ + 'title' => '水印透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.9', + 'default' => '1', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Texture' => [ + 'title' => '水印内容。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '文字水印', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.6', + 'default' => '0.6', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + 'PaneCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'PaneId' => [ + 'title' => '窗格ID，从0开始。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '0', + 'pattern' => '^\\d+$', + 'enum' => [], + ], + 'Source' => [ + 'title' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" + .' - **$ActiveSpeaker**：当前频道发言人'."\n" + .' - **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '22', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'Backgrounds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '背景图片。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BackgroundCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Alpha' => [ + 'title' => '透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '横坐标。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'title' => '纵坐标。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123.jpg', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'Images', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局图片水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Alpha' => [ + 'title' => '透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.9', + 'default' => '1.0', + ], + 'X' => [ + 'title' => '', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'ImageCropMode' => [ + 'title' => '裁剪方式。取值：'."\n" + .'- **1**：保持比例裁剪。'."\n" + .'- **2**：保持比例留边。'."\n" + .'- **3**：拉伸铺满。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'Url' => [ + 'title' => '图片地址。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/123xxx.jpg', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'Texts', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局文字水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'default' => '5', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'description' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '30', + ], + 'B' => [ + 'description' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '30', + ], + 'G' => [ + 'description' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '30', + ], + ], + 'required' => false, + ], + 'FontSize' => [ + 'title' => '字体大小。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '36', + 'default' => '30', + ], + 'Alpha' => [ + 'title' => '水印透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.1', + 'default' => '1', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'description' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '255', + ], + 'B' => [ + 'description' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '255', + ], + 'G' => [ + 'description' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '255', + ], + ], + 'required' => false, + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Texture' => [ + 'title' => '水印内容。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '文字水印', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.6', + 'default' => '0.6', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'ClockWidgets', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '全局时钟水印。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BoxBorderw' => [ + 'title' => '矩形框线宽。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'default' => '5', + ], + 'BoxColor' => [ + 'title' => '矩形框颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'description' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '30', + ], + 'B' => [ + 'description' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '30', + ], + 'G' => [ + 'description' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '30', + ], + ], + 'required' => false, + ], + 'FontSize' => [ + 'title' => '时钟字体大小。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + 'Zone' => [ + 'title' => '时区。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8', + 'default' => '8', + ], + 'Alpha' => [ + 'title' => '透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.9', + 'default' => '1', + ], + 'FontColor' => [ + 'title' => '字体颜色。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'R' => [ + 'description' => 'R。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '255', + ], + 'B' => [ + 'description' => 'B。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '255', + ], + 'G' => [ + 'description' => 'G。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + 'default' => '255', + ], + ], + 'required' => false, + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'HasBox' => [ + 'title' => '是否需要矩形框。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '0.2', + ], + 'Layer' => [ + 'title' => 'z轴层级。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'Font' => [ + 'title' => '字体。'."\n" + .'- **0**：阿里巴巴普惠体 Regular'."\n" + .'- **1**：阿里巴巴普惠体 Light'."\n" + .'- **2**：阿里巴巴普惠体Medium'."\n" + .'- **3**：阿里巴巴普惠体 Bold'."\n" + .'- **4**：阿里巴巴普惠体 Heavy'."\n" + .'- **5**：阿里妈妈数黑体'."\n" + .'- **6**：钉钉进步体'."\n" + .'- **7**：阿里妈妈刀隶体'."\n" + .'- **8**：阿里妈妈东方大楷'."\n" + .'- **9**：阿里妈妈方圆体'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'BoxAlpha' => [ + 'title' => '矩形框透明度。', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.6', + 'default' => '0.6', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'LayoutSpecifiedUsers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '黑白名单设置。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '用户名单类型，黑名单：black，白名单：white。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'white', + 'enum' => [ + 'white', + 'black', + ], + ], + 'Ids' => [ + 'title' => '指定用户ID列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '具体用户ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + 'required' => true, + 'maxItems' => 16, + 'minItems' => 1, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '任务ID。', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'ModifyStreamingProperty' => [ + 'summary' => '设置流属性', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '已存在的频道ID，仅支持传单个ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '合流任务ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + [ + 'name' => 'ViewSubscribers', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'title' => 'ViewSubscribers。', + 'description' => 'ViewSubscribers。', + 'type' => 'array', + 'items' => [ + 'description' => 'userId。', + 'type' => 'string', + 'required' => false, + 'example' => '12', + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'ViewContent', + 'in' => 'query', + 'schema' => [ + 'title' => '合流内容。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'main' => 'main', + 'content' => 'content', + ], + 'example' => 'main', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'E7C44674-9065-5BBA-AB77-A5F20908E73B', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C44674-9065-5BBA-AB77-A5F20908E73B\\"\\n}","type":"json"}]', + ], + 'DescribeCallList' => [ + 'summary' => '调用DescribeCallList分页查询时间范围内创建的通信信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testappid', + ], + ], + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'title' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615806196', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'title' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615892596', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '311', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'c906531af5f9****', + ], + ], + [ + 'name' => 'CallStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '通信状态。取值：IN：进行中。OUT：已结束。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'OUT', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段。取值：BAD_EXP_USER_COUNT_DESC：按体验欠佳人数降序。BAD_EXP_USER_COUNT_ASC：按体验欠佳人数升序', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'BAD_EXP_USER_COUNT_DESC', + ], + ], + [ + 'name' => 'QueryMode', + 'in' => 'query', + 'schema' => [ + 'title' => '查询模式。取值：ALL：全部通话。FOLLOW：关注通话。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'title' => '页码。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'title' => '每页数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCnt' => [ + 'title' => '总数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'CallList' => [ + 'title' => '通信列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'title' => 'App ID。', + 'description' => 'App ID。', + 'type' => 'string', + 'example' => '9qb1****', + ], + 'ChannelId' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'example' => '904', + ], + 'CallStatus' => [ + 'title' => '通信状态，IN：进行中，OUT：已结束', + 'description' => '', + 'type' => 'string', + 'example' => 'OUT', + ], + 'CreatedTs' => [ + 'title' => '通信的创建时间戳，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'DestroyedTs' => [ + 'title' => '通信的释放时间戳，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'Duration' => [ + 'title' => '通信持续时长，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UserCnt' => [ + 'title' => '通信用户数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'BadExpUserCnt' => [ + 'title' => '通信体验差的用户数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCnt\\": 1,\\n \\"CallList\\": [\\n {\\n \\"AppId\\": \\"testappid\\",\\n \\"ChannelId\\": \\"311\\",\\n \\"CallStatus\\": \\"OUT\\",\\n \\"CreatedTs\\": 1615806196,\\n \\"DestroyedTs\\": 1615806296,\\n \\"Duration\\": 100,\\n \\"UserCnt\\": 5,\\n \\"BadExpUserCnt\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeCall' => [ + 'summary' => '调用DescribeCall获取单次通信详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testappid', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'CreatedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '创建频道时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'DestroyedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'ExtDataType', + 'in' => 'query', + 'schema' => [ + 'title' => '查询的扩展。取值：USER_DURATION_STAT：用户时长统计数据类型。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'USER_DURATION_STAT', + ], + ], + [ + 'name' => 'QueryExpInfo', + 'in' => 'query', + 'schema' => [ + 'title' => '是否查询通信体验信息，不传默认是true', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CallInfo' => [ + 'title' => '通信基本信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'title' => 'App ID。', + 'description' => 'App ID。', + 'type' => 'string', + 'example' => 'xxxxxxxx', + ], + 'ChannelId' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'example' => '123456', + ], + 'CallStatus' => [ + 'title' => '通信状态。取值：IN：进行中。OUT：已结束。', + 'description' => '', + 'type' => 'string', + 'example' => 'IN', + ], + 'CreatedTs' => [ + 'title' => '创建通信时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1615860711', + ], + 'DestroyedTs' => [ + 'title' => '释放通信时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1615860811', + ], + 'Duration' => [ + 'title' => '通信持续时长，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + 'UserDetailList' => [ + 'title' => '用户详情列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'testuserid', + ], + 'Roles' => [ + 'title' => '用户角色，取值：SENDER：发布端。RECEIVER：订阅端。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SENDER', + ], + ], + 'Location' => [ + 'title' => '地理位置信息，例如：北京市-北京市', + 'description' => '', + 'type' => 'string', + 'example' => '浙江省-杭州市', + ], + 'OnlinePeriods' => [ + 'title' => '在线时段信息。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JoinTs' => [ + 'title' => '加入通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'LeaveTs' => [ + 'title' => '离开通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + ], + ], + ], + 'CreatedTs' => [ + 'title' => '创建通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'DestroyedTs' => [ + 'title' => '释放通话时间，使用UNIX时间戳表示，单位：秒。通话未结束时值为0。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'OnlineDuration' => [ + 'title' => '在线时长，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Duration' => [ + 'title' => '通话时长，首次进入到最后离开，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SdkVersion' => [ + 'title' => 'SDK版本，如1.0.0、1.1.1等', + 'description' => '', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'SdkVersionList' => [ + 'title' => 'SDK版本列表，如1.0.0、1.1.1等', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["1.0.0", "1.1.1"]', + ], + ], + 'Os' => [ + 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', + 'description' => '', + 'type' => 'string', + 'example' => 'iOS', + ], + 'OsList' => [ + 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["iOS", "Chrome"]', + ], + ], + 'Network' => [ + 'title' => '网络类型，如WiFi，4G等', + 'description' => '', + 'type' => 'string', + 'example' => '4G', + ], + 'NetworkList' => [ + 'title' => '网络类型，如WiFi，4G等', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["4G", "WiFi"]', + ], + ], + 'CallExp' => [ + 'title' => '通话体验，取值：GOOD:优良，BAD:欠佳。', + 'description' => '', + 'type' => 'string', + 'example' => 'GOOD', + ], + 'DurMetricStatData' => [ + 'title' => '时长统计数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PubAudio' => [ + 'title' => '发布音频时长，单位秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SubAudio' => [ + 'title' => '订阅音频时长，单位秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'PubVideo360' => [ + 'title' => '发布360P视频时长，单位秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SubVideo360' => [ + 'title' => '订阅360P视频时长，单位：秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'PubVideo720' => [ + 'title' => '发布720P视频时长，单位：秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SubVideo720' => [ + 'title' => '订阅720P视频时长，单位：秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'PubVideo1080' => [ + 'title' => '发布1080P视频时长，单位：秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SubVideo1080' => [ + 'title' => '订阅1080P视频时长，单位：秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'PubVideoScreenShare' => [ + 'title' => '发布屏幕共享时长，单位：秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SubVideoScreenShare' => [ + 'title' => '订阅屏幕共享时长，单位：秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizCreatedTsError', + 'errorMessage' => 'A business CreatedTs error occurred.', + ], + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CallInfo\\": {\\n \\"AppId\\": \\"testappid\\",\\n \\"ChannelId\\": \\"123456\\",\\n \\"CallStatus\\": \\"IN\\",\\n \\"CreatedTs\\": 1615860711,\\n \\"DestroyedTs\\": 1615860811,\\n \\"Duration\\": 100\\n },\\n \\"UserDetailList\\": [\\n {\\n \\"UserId\\": \\"testuserid\\",\\n \\"Roles\\": [\\n \\"SENDER\\"\\n ],\\n \\"Location\\": \\"浙江省-杭州市\\",\\n \\"OnlinePeriods\\": [\\n {\\n \\"JoinTs\\": 1614936817,\\n \\"LeaveTs\\": 1614936817\\n }\\n ],\\n \\"CreatedTs\\": 1614936817,\\n \\"DestroyedTs\\": 1614936817,\\n \\"OnlineDuration\\": 0,\\n \\"Duration\\": 0,\\n \\"SdkVersion\\": \\"1.0.0\\",\\n \\"SdkVersionList\\": [\\n \\"1.0.0\\"\\n ],\\n \\"Os\\": \\"iOS\\",\\n \\"OsList\\": [\\n \\"iOS\\"\\n ],\\n \\"Network\\": \\"4G\\",\\n \\"NetworkList\\": [\\n \\"4G\\"\\n ],\\n \\"CallExp\\": \\"GOOD\\",\\n \\"DurMetricStatData\\": {\\n \\"PubAudio\\": 0,\\n \\"SubAudio\\": 0,\\n \\"PubVideo360\\": 0,\\n \\"SubVideo360\\": 0,\\n \\"PubVideo720\\": 0,\\n \\"SubVideo720\\": 0,\\n \\"PubVideo1080\\": 0,\\n \\"SubVideo1080\\": 0,\\n \\"PubVideoScreenShare\\": 0,\\n \\"SubVideoScreenShare\\": 0\\n }\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribePubUserListBySubUser' => [ + 'summary' => '调用DescribePubUserListBySubUser根据订阅端获取通信中发布端用户列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testappid', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'CreatedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '频道创建时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'DestroyedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'SubUserId', + 'in' => 'query', + 'schema' => [ + 'title' => '订阅端用户ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testuserid', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SubUserDetail' => [ + 'title' => '订阅端用户详细信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'testuserid', + ], + 'UserIdAlias' => [ + 'title' => '用户ID别称', + 'description' => '', + 'type' => 'string', + 'example' => '旁路转推', + ], + 'Roles' => [ + 'title' => '用户角色，取值：SENDER：发布端。RECEIVER：订阅端。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SENDER', + ], + ], + 'Location' => [ + 'title' => '地理位置信息，例如：浙江省-杭州市。', + 'description' => '', + 'type' => 'string', + 'example' => '浙江省-杭州市', + ], + 'OnlinePeriods' => [ + 'title' => '在线时段信息。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'JoinTs' => [ + 'title' => '加入通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'LeaveTs' => [ + 'title' => '离开通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + ], + ], + ], + 'CreatedTs' => [ + 'title' => '第一次加入通话的时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'DestroyedTs' => [ + 'title' => '最后一次离开通话的时间，使用UNIX时间戳表示，单位：秒。通话未结束时值为0。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'OnlineDuration' => [ + 'title' => '在线时长，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Duration' => [ + 'title' => '通话时长，首次进入到最后离开，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SdkVersion' => [ + 'title' => 'SDK版本。', + 'description' => '', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'SdkVersionList' => [ + 'title' => 'SDK版本列表，如1.0.0、1.1.1等', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["1.0.0", "1.1.1"]', + ], + ], + 'Os' => [ + 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', + 'description' => '', + 'type' => 'string', + 'example' => 'iOS', + ], + 'OsList' => [ + 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["iOS", "Chrome"]', + ], + ], + 'Network' => [ + 'title' => '网络类型，如WiFi，4G等', + 'description' => '', + 'type' => 'string', + 'example' => '4G', + ], + 'NetworkList' => [ + 'title' => '网络类型，如WiFi，4G等', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["4G", "WiFi"]', + ], + ], + 'ClientType' => [ + 'title' => '端类型，取值：WEB：Web端。NATIVE：本地端。', + 'description' => '', + 'type' => 'string', + 'example' => 'NATIVE', + ], + ], + ], + 'PubUserDetailList' => [ + 'title' => '发布端用户详情信息。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'testuserid', + ], + 'UserIdAlias' => [ + 'title' => '用户ID别称', + 'description' => '', + 'type' => 'string', + 'example' => '旁路转推', + ], + 'Roles' => [ + 'title' => '用户角色，取值：SENDER：发起者。RECEIVER：接收者。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SENDER', + ], + ], + 'Location' => [ + 'title' => '地理位置信息，例如：浙江省-杭州市。', + 'description' => '', + 'type' => 'string', + 'example' => '浙江省-杭州市', + ], + 'OnlinePeriods' => [ + 'title' => '在线时段信息。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'JoinTs' => [ + 'title' => '加入通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'LeaveTs' => [ + 'title' => '离开通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + ], + ], + ], + 'CreatedTs' => [ + 'title' => '第一次加入通话的时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'DestroyedTs' => [ + 'title' => '最后一次离开通话的时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'OnlineDuration' => [ + 'title' => '在线时长，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Duration' => [ + 'title' => '通话时长，首次进入到最后离开，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SdkVersion' => [ + 'title' => 'SDK版本。', + 'description' => '', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'SdkVersionList' => [ + 'title' => 'SDK版本列表，如1.0.0、1.1.1等', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["1.0.0", "1.1.1"]', + ], + ], + 'Os' => [ + 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', + 'description' => '', + 'type' => 'string', + 'example' => 'iOS', + ], + 'OsList' => [ + 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["iOS", "Chrome"]', + ], + ], + 'Network' => [ + 'title' => '网络类型，如WiFi，4G等', + 'description' => '', + 'type' => 'string', + 'example' => '4G', + ], + 'NetworkList' => [ + 'title' => '网络类型，如WiFi，4G等', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["4G", "WiFi"]', + ], + ], + 'ClientType' => [ + 'title' => '端类型，取值：WEB：Web端。NATIVE：本地端。', + 'description' => '', + 'type' => 'string', + 'example' => 'NATIVE', + ], + 'CallIdList' => [ + 'title' => '用户通信流的Call ID。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'testcallid', + ], + ], + ], + ], + ], + 'CallStatus' => [ + 'title' => '通信状态。取值：IN：进行中。OUT：已结束。', + 'description' => '', + 'type' => 'string', + 'example' => 'IN', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizCreatedTsError', + 'errorMessage' => 'A business CreatedTs error occurred.', + ], + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SubUserDetail\\": {\\n \\"UserId\\": \\"testuserid\\",\\n \\"UserIdAlias\\": \\"yi****\\",\\n \\"Roles\\": [\\n \\"SENDER\\"\\n ],\\n \\"Location\\": \\"浙江省-杭州市\\",\\n \\"OnlinePeriods\\": [\\n {\\n \\"JoinTs\\": 1614936817,\\n \\"LeaveTs\\": 1614936817\\n }\\n ],\\n \\"CreatedTs\\": 1614936817,\\n \\"DestroyedTs\\": 1614936817,\\n \\"OnlineDuration\\": 0,\\n \\"Duration\\": 0,\\n \\"SdkVersion\\": \\"1.0.0\\",\\n \\"SdkVersionList\\": [\\n \\"1.0.0\\"\\n ],\\n \\"Os\\": \\"iOS\\",\\n \\"OsList\\": [\\n \\"iOS\\"\\n ],\\n \\"Network\\": \\"4G\\",\\n \\"NetworkList\\": [\\n \\"4G\\"\\n ],\\n \\"ClientType\\": \\"NATIVE\\"\\n },\\n \\"PubUserDetailList\\": [\\n {\\n \\"UserId\\": \\"testuserid2\\",\\n \\"UserIdAlias\\": \\"yi****\\",\\n \\"Roles\\": [\\n \\"SENDER\\"\\n ],\\n \\"Location\\": \\"浙江省-杭州市\\",\\n \\"OnlinePeriods\\": [\\n {\\n \\"JoinTs\\": 1614936817,\\n \\"LeaveTs\\": 1614936817\\n }\\n ],\\n \\"CreatedTs\\": 1614936817,\\n \\"DestroyedTs\\": 1614936817,\\n \\"OnlineDuration\\": 0,\\n \\"Duration\\": 0,\\n \\"SdkVersion\\": \\"1.0.0\\",\\n \\"SdkVersionList\\": [\\n \\"1.0.0\\"\\n ],\\n \\"Os\\": \\"iOS\\",\\n \\"OsList\\": [\\n \\"iOS\\"\\n ],\\n \\"Network\\": \\"4G\\",\\n \\"NetworkList\\": [\\n \\"4G\\"\\n ],\\n \\"ClientType\\": \\"NATIVE\\",\\n \\"CallIdList\\": [\\n \\"testcallid\\"\\n ]\\n }\\n ],\\n \\"CallStatus\\": \\"IN\\",\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeEndPointEventList' => [ + 'summary' => '调用DescribeEndPointEventList获取端对端用户事件列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testappid', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'CreatedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '事件查询时间区间的开始时间，该时间不得早于频道实际的创建时间，不得早于30天之前。使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'DestroyedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '事件查询时间区间的结束时间，该时间不得晚于频道释放时间。使用UNIX时间戳表示，单位：秒。参数为空，表示获取当前时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'UserIdList', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID列表，多个用英文逗号（,）分隔。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testuserid1,testuserid2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'title' => '用户基本信息列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户ID', + 'description' => '', + 'type' => 'string', + 'example' => 'testuserid', + ], + 'EventDataItems' => [ + 'title' => '事件数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Ts' => [ + 'title' => '第一个事件发生的时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'EventList' => [ + 'title' => '事件列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventName' => [ + 'title' => '事件名称。', + 'description' => '', + 'type' => 'string', + 'example' => '开始发布', + ], + 'EventType' => [ + 'title' => '事件类型，取值：USER：用户事件。SYSTEM：系统事件。', + 'description' => '', + 'type' => 'string', + 'example' => 'USER', + ], + 'Ts' => [ + 'title' => '事件发生的时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'TsInMs' => [ + 'title' => '事件发生的时间，使用UNIX时间戳表示，单位：毫秒。', + 'description' => '', + 'type' => 'string', + 'example' => '1614936817123', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + [ + 'errorCode' => 'BizCreatedTsError', + 'errorMessage' => 'A business CreatedTs error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Nodes\\": [\\n {\\n \\"UserId\\": \\"testuserid\\",\\n \\"EventDataItems\\": [\\n {\\n \\"Ts\\": 1614936817,\\n \\"EventList\\": [\\n {\\n \\"EventName\\": \\"开始发布\\",\\n \\"EventType\\": \\"USER\\",\\n \\"Ts\\": 1614936817,\\n \\"TsInMs\\": \\"1614936817123\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeEndPointMetricData' => [ + 'summary' => '调用DescribeEndPointMetricData获取端对端指标数据。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testappid', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'CreatedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '事件查询时间区间的开始时间，该时间不得早于频道实际的创建时间，不得早于30天之前。使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'DestroyedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '事件查询时间区间的结束时间，该时间不得晚于频道释放时间。使用UNIX时间戳表示，单位：秒。参数为空，表示获取当前时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'SubUserId', + 'in' => 'query', + 'schema' => [ + 'title' => '订阅端用户ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'testuserid', + ], + ], + [ + 'name' => 'PubUserId', + 'in' => 'query', + 'schema' => [ + 'title' => '发布端用户ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'testuserid', + ], + ], + [ + 'name' => 'PubCallIdList', + 'in' => 'query', + 'schema' => [ + 'title' => '发布端用户通信流的Call ID，多个用英文逗号（,）分隔。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'testcall1,testcall2', + ], + ], + [ + 'name' => 'Metrics', + 'in' => 'query', + 'schema' => [ + 'title' => '指标枚举列表，以半角逗号分隔，包括以下类型APP_CPU APPCPU SYSTEM_CPU 系统CPU APP_MEMORY APP内存 SYSTEM_MEMORY 系统占用内存 SYSTEM_TOTAL_MEMORY 系统总内存 AUDIO_LOST_RATE 音频丢包率 VIDEO_LOST_RATE 视频丢包率 AUDIO_RTT 音频延时 VIDEO_RTT 视频延时 AUDIO_END_TO_END_RTT 音频端到端延时 VIDEO_END_TO_END_RTT 视频端到端延时 AUDIO_BIT_RATE 音频码率 AUDIO_STUCK 音频卡顿 AUDIO_LEVEL 音量 VIDEO_BIT_RATE_CAMERA 视频码率 VIDEO_BIT_RATE_LARGE 视频码率（大画面） VIDEO_BIT_RATE_SMALL 视频码率（小画面） VIDEO_BIT_RATE_SUPER 视频码率（超大屏幕） VIDEO_BIT_RATE_SHARE 视频码率（屏幕分享） VIDEO_STUCK_CAMERA 视频卡顿 VIDEO_STUCK_LARGE 视频卡顿（大画面） VIDEO_STUCK_SMALL 视频卡顿（小画面） VIDEO_STUCK_SUPER 视频卡顿（超大屏幕） VIDEO_STUCK_SHARE 视频卡顿（屏幕分享） VIDEO_RESOLUTION_CAMERA 视频分辨率 VIDEO_RESOLUTION_LARGE 视频分辨率（大画面） VIDEO_RESOLUTION_SMALL 视频分辨率（小画面） VIDEO_RESOLUTION_SUPER 视频分辨率（超大屏幕） VIDEO_RESOLUTION_SHARE 视频分辨率（屏幕分享） VIDEO_FPS_CAMERA 视频帧率 VIDEO_FPS_LARGE 视频帧率（大画面） VIDEO_FPS_SMALL 视频帧率（小画面） VIDEO_FPS_SUPER 视频帧率（超大屏幕） VIDEO_FPS_SHARE 视频帧率（屏幕分享）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'VIDEO_STUCK_CAMERA', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SubMetrics' => [ + 'title' => '订阅端用户指标数据。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '对应入参Metrics中的类型', + 'description' => '', + 'type' => 'string', + 'example' => 'VIDEO_STUCK_CAMERA', + ], + 'UserId' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'testuserid', + ], + 'Nodes' => [ + 'title' => '订阅端指标趋势图坐标点列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'title' => '订阅端指标趋势图中x轴横坐标。', + 'description' => '', + 'type' => 'string', + 'example' => '1548670257', + ], + 'Y' => [ + 'title' => '订阅端指标趋势图y轴纵坐标。', + 'description' => '', + 'type' => 'string', + 'example' => '230100', + ], + 'Ext' => [ + 'title' => '拓展属性', + 'description' => '', + 'type' => 'object', + ], + ], + ], + ], + ], + ], + ], + 'PubMetrics' => [ + 'title' => '发布端用户指标数据。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '对应入参Metrics中的类型', + 'description' => '', + 'type' => 'string', + 'example' => 'VIDEO_STUCK_CAMERA', + ], + 'UserId' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'testuserid', + ], + 'Nodes' => [ + 'title' => '坐标点列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'title' => '发布端指标趋势图中x轴横坐标。', + 'description' => '', + 'type' => 'string', + 'example' => '1548670257', + ], + 'Y' => [ + 'title' => '发布端指标趋势图中y轴纵坐标。', + 'description' => '', + 'type' => 'string', + 'example' => '230100', + ], + 'Ext' => [ + 'title' => '拓展属性', + 'description' => '', + 'type' => 'object', + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + [ + 'errorCode' => 'BizCreatedTsError', + 'errorMessage' => 'A business CreatedTs error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SubMetrics\\": [\\n {\\n \\"Type\\": \\"VIDEO_STUCK_CAMERA\\",\\n \\"UserId\\": \\"testuserid\\",\\n \\"Nodes\\": [\\n {\\n \\"X\\": \\"1548670257\\",\\n \\"Y\\": \\"230100\\",\\n \\"Ext\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n }\\n ],\\n \\"PubMetrics\\": [\\n {\\n \\"Type\\": \\"VIDEO_STUCK_CAMERA\\",\\n \\"UserId\\": \\"testuserid\\",\\n \\"Nodes\\": [\\n {\\n \\"X\\": \\"1548670257\\",\\n \\"Y\\": \\"230100\\",\\n \\"Ext\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeQoeMetricData' => [ + 'summary' => '调用DescribeQoeMetricData获取单次通信中用户的下行体验质量指标。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testappid', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'CreatedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '创建频道时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'DestroyedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testuserid', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VideoData' => [ + 'title' => '视频数据。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '通信体验，取值：VIDEO_CAMERA：摄像头码率。VIDEO_CAMERA_LARGE：摄像头大流码率。VIDEO_CAMERA_SMALL：摄像头小流码率。VIDEO_CAMERA_SUPER：摄像头超大流码率。VIDEO_SCREEN_SHARE：共享屏幕流码率。VIDEO_STUCK_CAMERA：摄像头卡顿。VIDEO_STUCK_CAMERA_LARGE：摄像头大流卡顿。VIDEO_STUCK_CAMERA_SMALL：摄像头小流卡顿。VIDEO_STUCK_CAMERA_SUPER：摄像头超大流卡顿。VIDEO_STUCK_SCREEN_SHARE：屏幕共享卡顿。VIDEO_VAGUE_CAMERA：摄像头模糊。VIDEO_VAGUE_CAMERA_LARGE：摄像头大流模糊。VIDEO_VAGUE_CAMERA_SMALL：摄像头小流模糊。VIDEO_VAGUE_CAMERA_SUPER：摄像头超大流模糊。VIDEO_VAGUE_SCREEN_SHARE：屏幕共享模糊。', + 'description' => '', + 'type' => 'string', + 'example' => 'VIDEO_CAMERA', + ], + 'UserId' => [ + 'title' => '用户ID', + 'description' => '', + 'type' => 'string', + 'example' => 'testuserid', + ], + 'Nodes' => [ + 'title' => '视频指标趋势图坐标点列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'title' => '视频指标趋势图中x轴横坐标。', + 'description' => '', + 'type' => 'string', + 'example' => '1548670256', + ], + 'Y' => [ + 'title' => '视频指标趋势图中y轴纵坐标。', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + 'AudioData' => [ + 'title' => '音频数据。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '通信体验，取值：AUDIO：音频码率。AUDIO_STUCK：音频下行卡顿。', + 'description' => '', + 'type' => 'string', + 'example' => 'AUDIO', + ], + 'UserId' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'testuserid', + ], + 'Nodes' => [ + 'title' => '音频指标趋势图坐标点列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'title' => '音频指标趋势图中x轴横坐标。', + 'description' => '', + 'type' => 'string', + 'example' => '1548670256', + ], + 'Y' => [ + 'title' => '音频指标趋势图中y轴纵坐标。', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizCreatedTsError', + 'errorMessage' => 'A business CreatedTs error occurred.', + ], + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VideoData\\": [\\n {\\n \\"Type\\": \\"VIDEO_CAMERA\\",\\n \\"UserId\\": \\"testuserid2\\",\\n \\"Nodes\\": [\\n {\\n \\"X\\": \\"1548670256\\",\\n \\"Y\\": \\"123\\"\\n }\\n ]\\n }\\n ],\\n \\"AudioData\\": [\\n {\\n \\"Type\\": \\"AUDIO\\",\\n \\"UserId\\": \\"testuserid2\\",\\n \\"Nodes\\": [\\n {\\n \\"X\\": \\"1548670256\\",\\n \\"Y\\": \\"123\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeChannelOverallData' => [ + 'summary' => '调用DescribeChannelOverallData查询频道概览数据。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testappid', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'CreatedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '创建频道的时间戳，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615893133', + ], + ], + [ + 'name' => 'DestroyedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1615893757', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MetricDatas' => [ + 'title' => '指标数据列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '指标类型，取值：CALL_QUALITY：通信质量。CONN_NUM：通信次数。', + 'description' => '', + 'type' => 'string', + 'example' => 'CALL_QUALITY', + ], + 'Nodes' => [ + 'title' => '指标趋势图坐标点列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'title' => '指标趋势图中x轴横坐标。', + 'description' => '', + 'type' => 'string', + 'example' => '1612418625', + ], + 'Y' => [ + 'title' => '指标趋势图中y轴纵坐标。', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'Ext' => [ + 'title' => '扩展数据', + 'description' => '', + 'type' => 'object', + ], + ], + ], + ], + ], + ], + ], + 'OverallData' => [ + 'title' => '概览数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ConnAvgTime' => [ + 'title' => '平均通信连接的用时，单位：秒。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'FiveSecJoinRate' => [ + 'title' => '5秒内连通成功率，用小数表示，例如1.0表示连通成功率为100%。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.91', + ], + 'TotalAudioStuckRate' => [ + 'title' => '整体音频卡顿率，用小数表示，例如0.02表示音频卡顿率为2%。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.02', + ], + 'TotalVideoStuckRate' => [ + 'title' => '整体视频卡顿率，用小数表示，例如0.02表示视频卡顿率为2%。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.02', + ], + 'TotalVideoVagueRate' => [ + 'title' => '整体视频模糊率，用小数表示，例如0.02表示视频模糊率为2%。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.02', + ], + ], + ], + 'CallInfo' => [ + 'title' => '通信基本信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'rjdhtnqy', + ], + 'ChannelId' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'example' => '123456', + ], + 'CallStatus' => [ + 'title' => '通信状态，取值：IN：进行中。OUT：已结束', + 'description' => '', + 'type' => 'string', + 'example' => 'IN', + ], + 'CreatedTs' => [ + 'title' => '创建通信的时间戳，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1615860711', + ], + 'DestroyedTs' => [ + 'title' => '释放通信的时间戳，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1615860811', + ], + 'Duration' => [ + 'title' => '通信时长，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizCreatedTsError', + 'errorMessage' => 'A business CreatedTs error occurred.', + ], + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MetricDatas\\": [\\n {\\n \\"Type\\": \\"CALL_QUALITY\\",\\n \\"Nodes\\": [\\n {\\n \\"X\\": \\"1612418625\\",\\n \\"Y\\": \\"123\\",\\n \\"Ext\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n }\\n ],\\n \\"OverallData\\": {\\n \\"ConnAvgTime\\": 0.5,\\n \\"FiveSecJoinRate\\": 0.91,\\n \\"TotalAudioStuckRate\\": 0.02,\\n \\"TotalVideoStuckRate\\": 0.02,\\n \\"TotalVideoVagueRate\\": 0.02\\n },\\n \\"CallInfo\\": {\\n \\"AppId\\": \\"testappid\\",\\n \\"ChannelId\\": \\"testid\\",\\n \\"CallStatus\\": \\"IN\\",\\n \\"CreatedTs\\": 1615860711,\\n \\"DestroyedTs\\": 1615860811,\\n \\"Duration\\": 100\\n },\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeChannelDistributionStatData' => [ + 'summary' => '调用DescribeChannelDistributionStatData获取频道分布统计数据。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testappid', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'CreatedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '创建频道的时间戳，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'DestroyedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'StatDim', + 'in' => 'query', + 'schema' => [ + 'title' => '统计维度，取值：OS：按照系统统计。SDK_VERSION：按照SDK版本统计。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'StatList' => [ + 'title' => '频道分布统计列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '统计维度。', + 'description' => '', + 'type' => 'string', + 'example' => 'OS', + ], + 'CallUserCount' => [ + 'title' => '通信人数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CallUserRatio' => [ + 'title' => '通信人数占比，用小数表示，例如1.0000表示通信人数占比为100%。', + 'description' => '', + 'type' => 'string', + 'example' => '1.0000', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizCreatedTsError', + 'errorMessage' => 'A business CreatedTs error occurred.', + ], + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatList\\": [\\n {\\n \\"Name\\": \\"OS\\",\\n \\"CallUserCount\\": 1,\\n \\"CallUserRatio\\": \\"1.0000\\"\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeChannelAreaDistributionStatData' => [ + 'summary' => '调用DescribeChannelAreaDistributionStatData获取频道地区分布统计数据。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testappid', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'CreatedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '频道创建时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'DestroyedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'ParentArea', + 'in' => 'query', + 'schema' => [ + 'title' => '父级地区名称，例如：深圳市的父级为广东省。参数为空表示世界范围（国家维度）的统计，例如：中国、英国。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AreaStatList' => [ + 'title' => '地域统计列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AreaName' => [ + 'title' => '地域名称，例如：中国_浙江省_杭州市。', + 'description' => '', + 'type' => 'string', + 'example' => '浙江省', + ], + 'CallUserCount' => [ + 'title' => '通信人数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PubUserCount' => [ + 'title' => '发布端人数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SubUserCount' => [ + 'title' => '订阅端人数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HighQualityTransmissionRate' => [ + 'title' => '优质传输率，用小数表示，例如0.9999表示优质传输率为99.99%。', + 'description' => '', + 'type' => 'string', + 'example' => '0.9999', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizCreatedTsError', + 'errorMessage' => 'A business CreatedTs error occurred.', + ], + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AreaStatList\\": [\\n {\\n \\"AreaName\\": \\"中国_浙江省_杭州市\\",\\n \\"CallUserCount\\": 1,\\n \\"PubUserCount\\": 1,\\n \\"SubUserCount\\": 1,\\n \\"HighQualityTransmissionRate\\": \\"0.9999\\"\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeChannelTopPubUserList' => [ + 'summary' => '调用DescribeChannelTopPubUserList获取频道内发布端的用户列表（按用户在线时长降序）。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testappid', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'CreatedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '创建频道的时间戳，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615893133', + ], + ], + [ + 'name' => 'DestroyedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1615893757', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TopPubUserDetailList' => [ + 'title' => 'Top发布用户详情列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'testuserid', + ], + 'Location' => [ + 'title' => '地域位置，例如：北京市-北京市', + 'description' => '', + 'type' => 'string', + 'example' => '浙江省-杭州市', + ], + 'OnlinePeriods' => [ + 'title' => '在线期间用户列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JoinTs' => [ + 'title' => '加入通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1615893327', + ], + 'LeaveTs' => [ + 'title' => '离开通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1615893442', + ], + ], + ], + ], + 'CreatedTs' => [ + 'title' => '第一次加入通话的时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1615893327', + ], + 'DestroyedTs' => [ + 'title' => '最后一次离开通话的时间，使用UNIX时间戳表示，单位：秒。通话未结束时值为0。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1615893442', + ], + 'OnlineDuration' => [ + 'title' => '通信时长，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Duration' => [ + 'title' => '总时长，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizCreatedTsError', + 'errorMessage' => 'A business CreatedTs error occurred.', + ], + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TopPubUserDetailList\\": [\\n {\\n \\"UserId\\": \\"testuserid\\",\\n \\"Location\\": \\"浙江省-杭州市\\",\\n \\"OnlinePeriods\\": [\\n {\\n \\"JoinTs\\": 1615893327,\\n \\"LeaveTs\\": 1615893442\\n }\\n ],\\n \\"CreatedTs\\": 1615893327,\\n \\"DestroyedTs\\": 1615893442,\\n \\"OnlineDuration\\": 115,\\n \\"Duration\\": 115\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeChannelUserMetrics' => [ + 'summary' => '调用DescribeChannelUserMetrics查询频道总览中的用户数据。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testappid', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'CreatedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '频道的创建时间戳，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1614936817', + ], + ], + [ + 'name' => 'DestroyedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1614936817', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'MetricDatas' => [ + 'title' => '指标数据列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '指标类型，取值：ALL_NUM：累计用户数量。PUB_NUM：累计发布用户数量。SUB_NUM：累计订阅用户数量。JOIN_FAIL_NUM：累计加入频道异常用户数量。BAD_EXP_NUM：累计通信体验异常用户。', + 'description' => '', + 'type' => 'string', + 'example' => 'ALL_NUM', + ], + 'Nodes' => [ + 'title' => '指标趋势图坐标点列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'title' => '指标趋势图中x轴横坐标。', + 'description' => '', + 'type' => 'string', + 'example' => '1612418625', + ], + 'Y' => [ + 'title' => '指标趋势图中y轴纵坐标。', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'Ext' => [ + 'title' => '拓展属性', + 'description' => '', + 'type' => 'object', + ], + ], + ], + ], + ], + ], + ], + 'OverallData' => [ + 'title' => '总览数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalUserNum' => [ + 'title' => '累计用户数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'TotalPubUserNum' => [ + 'title' => '累计发布端用户数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalSubUserNum' => [ + 'title' => '累计订阅端用户数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'TotalJoinFailNum' => [ + 'title' => '累计加入频道异常用户数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TotalBadExpNum' => [ + 'title' => '累计通信体验异常用户数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizCreatedTsError', + 'errorMessage' => 'A business CreatedTs error occurred.', + ], + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MetricDatas\\": [\\n {\\n \\"Type\\": \\"ALL_NUM\\",\\n \\"Nodes\\": [\\n {\\n \\"X\\": \\"1612418625\\",\\n \\"Y\\": \\"123\\",\\n \\"Ext\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n }\\n ],\\n \\"OverallData\\": {\\n \\"TotalUserNum\\": 5,\\n \\"TotalPubUserNum\\": 1,\\n \\"TotalSubUserNum\\": 3,\\n \\"TotalJoinFailNum\\": 0,\\n \\"TotalBadExpNum\\": 0\\n },\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeUsageOverallData' => [ + 'summary' => '获取用量统计概览数据', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间，秒级时间戳：1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615824000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间，秒级时间戳：1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615910399', + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'schema' => [ + 'title' => '类型，半角逗号分隔 总时长：TOTAL_CALL_DURATION 视频通信时长：VIDEO_CALL_DURATION 音频通信时长：AUDIO_CALL_DURATION 通信频道数：CALL_CHANNEL_COUNT 高并发通信频道数： HIGHLY_CONCURRENT_CHANNEL_COUNT 并发频道数峰值： CHANNEL_CONCURRENT_PEAK 在线人数峰值：ONLINE_USER_PEAK 累计通话人数： TOTAL_CALL_USER 累计进出人次： TOTAL_INOUT_NUM', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'ONLINE_USER_PEAK', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID', + 'description' => 'APP ID', + 'type' => 'string', + 'required' => true, + 'example' => 'a2hz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'UsageOverallData' => [ + 'title' => '用量概览数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型，半角逗号分隔 总时长：TOTAL_CALL_DURATION 视频通信时长：VIDEO_CALL_DURATION 音频通信时长：AUDIO_CALL_DURATION 通信频道数：CALL_CHANNEL_COUNT 高并发通信频道数： HIGHLY_CONCURRENT_CHANNEL_COUNT 并发频道数峰值： CHANNEL_CONCURRENT_PEAK 在线人数峰值：ONLINE_USER_PEAK 累计通话人数： TOTAL_CALL_USER 累计进出人次： TOTAL_INOUT_NUM', + 'description' => '', + 'type' => 'string', + 'example' => 'ONLINE_USER_PEAK', + ], + 'Nodes' => [ + 'title' => '坐标点列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'title' => 'x轴横坐标', + 'description' => '', + 'type' => 'string', + 'example' => '1615824000', + ], + 'Y' => [ + 'title' => 'y轴横坐标', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UsageOverallData\\": [\\n {\\n \\"Type\\": \\"ONLINE_USER_PEAK\\",\\n \\"Nodes\\": [\\n {\\n \\"X\\": \\"1615824000\\",\\n \\"Y\\": \\"1\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeUsageDistributionStatData' => [ + 'summary' => '获取用量统计分布数据', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间，秒级时间戳：如1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615824000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间，秒级时间戳：如1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615910399', + ], + ], + [ + 'name' => 'StatDim', + 'in' => 'query', + 'schema' => [ + 'title' => '统计维度，支持最多填入一个 CHANNEL_ONLINE, NETWORK, OS', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'CHANNEL_ONLINE', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID', + 'description' => 'APP ID', + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'UsageStatList' => [ + 'title' => '用量统计数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '统计名称， 当StatDim=CHANNEL_ONLINE： ONE_TO_FIVE：1-5人 SIX_TO_TEN：6-10人 ELEVEN_TO_TWENTY：11-20人 TWENTY_ONE_TO_FIFTY: 21-50人 ABOVE_FIFTY：50人以上 当StatDim=NETWORK： WiFi，4G等 当StatDim=OS： iOS、android等', + 'description' => '', + 'type' => 'string', + 'example' => 'ONE_TO_FIVE', + ], + 'AudioCallDuration' => [ + 'title' => '音频通话时长，单位分钟', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '51', + ], + 'VideoCallDuration' => [ + 'title' => '视频通话时长，单位分钟', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10585', + ], + 'TotalCallDuration' => [ + 'title' => '总通话时长，单位分钟', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10636', + ], + 'CallDurationRatio' => [ + 'title' => '通话时长占比，四位小数表示，如1.0000', + 'description' => '', + 'type' => 'string', + 'example' => '0.9782', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UsageStatList\\": [\\n {\\n \\"Name\\": \\"ONE_TO_FIVE\\",\\n \\"AudioCallDuration\\": 51,\\n \\"VideoCallDuration\\": 10585,\\n \\"TotalCallDuration\\": 10636,\\n \\"CallDurationRatio\\": \\"0.9782\\"\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeUsageAreaDistributionStatData' => [ + 'summary' => '获取用量统计地域分布数据', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间，秒级时间戳，如1609344000', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1615824000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间，秒级时间戳，如1609344000', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1615910399', + ], + ], + [ + 'name' => 'ParentArea', + 'in' => 'query', + 'schema' => [ + 'title' => '父级地区名称，为空取世界范围（国家维度）的统计，如： ""->中国、英国 "中国"->北京市、广东省 "广东省"->广州市、深圳市、佛山市 "北京市"->北京市', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID', + 'description' => 'APP ID', + 'type' => 'string', + 'required' => true, + 'example' => '0rbd****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'UsageAreaStatList' => [ + 'title' => '用量统计地域分布数据', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '地域名称，如中国', + 'description' => '', + 'type' => 'string', + 'example' => '中国', + ], + 'AudioCallDuration' => [ + 'title' => '音频通话时长，单位分钟', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '45', + ], + 'VideoCallDuration' => [ + 'title' => '视频通话时长，单位分钟', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4776', + ], + 'TotalCallDuration' => [ + 'title' => '总通话时长，单位分钟', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4821', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UsageAreaStatList\\": [\\n {\\n \\"Name\\": \\"中国_浙江省\\",\\n \\"AudioCallDuration\\": 45,\\n \\"VideoCallDuration\\": 4776,\\n \\"TotalCallDuration\\": 4821\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeUsageOsSdkVersionDistributionStatData' => [ + 'summary' => '获取用量统计各操作系统下SDK版本分布数据', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间，秒级时间戳：1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615824000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间，秒级时间戳：1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615910399', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID', + 'description' => 'APP ID', + 'type' => 'string', + 'required' => true, + 'example' => '0rbd****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UsageOsSdkVersionStatList' => [ + 'title' => '用量统计SDK版本数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'SDK版本名称，1.0.0、1.1.1等', + 'description' => '', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'Os' => [ + 'title' => '操作系统，如iOS、android等', + 'description' => '', + 'type' => 'string', + 'example' => 'macOS', + ], + 'AudioCallDuration' => [ + 'title' => '音频通话时长，单位分钟', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'VideoCallDuration' => [ + 'title' => '视频通话时长，单位分钟', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '473', + ], + 'TotalCallDuration' => [ + 'title' => '总通话时长，单位分钟', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '476', + ], + 'CallDurationRatio' => [ + 'title' => '通话时长占比，四位小数表示，如1.0000', + 'description' => '', + 'type' => 'string', + 'example' => '0.0984', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UsageOsSdkVersionStatList\\": [\\n {\\n \\"Name\\": \\"1.0.0\\",\\n \\"Os\\": \\"macOS\\",\\n \\"AudioCallDuration\\": 3,\\n \\"VideoCallDuration\\": 473,\\n \\"TotalCallDuration\\": 476,\\n \\"CallDurationRatio\\": \\"0.0984\\"\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeQualityOverallData' => [ + 'summary' => '获取质量统计概览数据', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间，秒级时间戳，如1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615824000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间，秒级时间戳，如1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615910399', + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'schema' => [ + 'title' => '类型，以半角逗号分隔 加入频道成功率： JOIN_CHANNEL_SUC_RATE 五秒加入频道成功率： JOIN_CHANNEL_SUC_FIVE_SEC_RATE 首次出声时间： AUDIO_SPEAK_OUT_DUR 首次出图时间： VIDEO_FIRST_PIC_DUR 音频卡顿率： AUDIO_STUCK_RATE 视频卡顿率： VIDEO_STUCK_RATE 音频延时： AUDIO_DELAY 视频延时： AUDIO_DELAY 音频优质传输率： AUDIO_HIGH_QUALITY_TRANSMISSION_RATE 视频优质传输率： VIDEO_HIGH_QUALITY_TRANSMISSION_RATE', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'JOIN_CHANNEL_SUC_RATE', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID', + 'description' => 'APP ID', + 'type' => 'string', + 'required' => true, + 'example' => '0rbd****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'QualityOverallData' => [ + 'title' => '概览数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '概览数据类型，加入频道成功率： JOIN_CHANNEL_SUC_RATE 五秒加入频道成功率： JOIN_CHANNEL_SUC_FIVE_SEC_RATE 首次出声时间： AUDIO_SPEAK_OUT_DUR 首次出图时间： VIDEO_FIRST_PIC_DUR 音频卡顿率： AUDIO_STUCK_RATE 视频卡顿率： VIDEO_STUCK_RATE 音频延时： AUDIO_DELAY 视频延时： AUDIO_DELAY 音频优质传输率： AUDIO_HIGH_QUALITY_TRANSMISSION_RATE 视频优质传输率： VIDEO_HIGH_QUALITY_TRANSMISSION_RATE', + 'description' => '', + 'type' => 'string', + 'example' => 'JOIN_CHANNEL_SUC_RATE', + ], + 'Nodes' => [ + 'title' => '坐标点列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'title' => 'x轴横坐标', + 'description' => '', + 'type' => 'string', + 'example' => '1615831200', + ], + 'Y' => [ + 'title' => 'y轴纵坐标', + 'description' => '', + 'type' => 'string', + 'example' => '1.0000', + ], + ], + ], + ], + 'Average' => [ + 'title' => '平均值', + 'description' => '', + 'type' => 'string', + 'example' => '0.9376', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"QualityOverallData\\": [\\n {\\n \\"Type\\": \\"JOIN_CHANNEL_SUC_RATE\\",\\n \\"Nodes\\": [\\n {\\n \\"X\\": \\"1615831200\\",\\n \\"Y\\": \\"1.0000\\"\\n }\\n ],\\n \\"Average\\": \\"0.9376\\"\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeQualityDistributionStatData' => [ + 'summary' => '获取质量统计分布数据', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间，秒级时间戳，如1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615824000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间，秒级时间戳，如1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615910399', + ], + ], + [ + 'name' => 'StatDim', + 'in' => 'query', + 'schema' => [ + 'title' => '统计维度，支持最多填入一个 CHANNEL_ONLINE, NETWORK, OS', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'CHANNEL_ONLINE', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID', + 'description' => 'APP ID', + 'type' => 'string', + 'required' => true, + 'example' => '0rbd****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'QualityStatDataList' => [ + 'title' => '分布数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '统计名称， 当StatDim=CHANNEL_ONLINE： ONE_TO_FIVE：1-5人 SIX_TO_TEN：6-10人 ELEVEN_TO_TWENTY：11-20人 TWENTY_ONE_TO_FIFTY: 21-50人 ABOVE_FIFTY：50人以上 当StatDim=NETWORK： WiFi，4G等 当StatDim=OS： iOS、android等', + 'description' => '', + 'type' => 'string', + 'example' => 'ONE_TO_FIVE', + ], + 'CallDurationRatio' => [ + 'title' => '通话时长用量占比，四位小数表示，如1.0000', + 'description' => '', + 'type' => 'string', + 'example' => '1.0000', + ], + 'JoinChannelSucRate' => [ + 'title' => '加入频道成功率， 四位小数表示，如1.0000', + 'description' => '', + 'type' => 'string', + 'example' => '0.9575', + ], + 'JoinChannelSucFiveSecRate' => [ + 'title' => '5秒加入频道成功率， 四位小数表示，如1.0000', + 'description' => '', + 'type' => 'string', + 'example' => '0.9560', + ], + 'VideoFirstPicDuration' => [ + 'title' => '视频首次出图时间，单位毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1299', + ], + 'AudioStuckRate' => [ + 'title' => '音频卡顿率， 四位小数表示，如0.0034', + 'description' => '', + 'type' => 'string', + 'example' => '0.0014', + ], + 'VideoStuckRate' => [ + 'title' => '视频卡顿率， 四位小数表示，如0.0038', + 'description' => '', + 'type' => 'string', + 'example' => '0.0264', + ], + 'AudioDelay' => [ + 'title' => '音频延时，单位毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '554', + ], + 'VideoDelay' => [ + 'title' => '视频延时，单位毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '517', + ], + 'AudioHighQualityTransmissionRate' => [ + 'title' => '音频优质传输率， 四位小数表示，如0.9927', + 'description' => '', + 'type' => 'string', + 'example' => '0.9953', + ], + 'VideoHighQualityTransmissionRate' => [ + 'title' => '视频优质传输率，四位小数表示，如0.9965', + 'description' => '', + 'type' => 'string', + 'example' => '0.9981', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"QualityStatDataList\\": [\\n {\\n \\"Name\\": \\"ONE_TO_FIVE\\",\\n \\"CallDurationRatio\\": \\"1.0000\\",\\n \\"JoinChannelSucRate\\": \\"0.9575\\",\\n \\"JoinChannelSucFiveSecRate\\": \\"0.9560\\",\\n \\"VideoFirstPicDuration\\": 1299,\\n \\"AudioStuckRate\\": \\"0.0014\\",\\n \\"VideoStuckRate\\": \\"0.0264\\",\\n \\"AudioDelay\\": 554,\\n \\"VideoDelay\\": 517,\\n \\"AudioHighQualityTransmissionRate\\": \\"0.9953\\",\\n \\"VideoHighQualityTransmissionRate\\": \\"0.9981\\"\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeQualityAreaDistributionStatData' => [ + 'summary' => '获取质量统计区域分布统计数据', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间，秒级时间戳，如1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615824000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间，秒级时间戳，如1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615910399', + ], + ], + [ + 'name' => 'ParentArea', + 'in' => 'query', + 'schema' => [ + 'title' => '父级地区名称，为空取世界范围（国家维度）的统计，如： ""->中国、英国 "中国"->北京市、广东省 "广东省"->广州市、深圳市、佛山市 "北京市"->北京市', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '中国', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID', + 'description' => 'APP ID', + 'type' => 'string', + 'required' => true, + 'example' => '0rbd****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'QualityStatDataList' => [ + 'title' => '质量分布数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '区域名称，如广东省', + 'description' => '', + 'type' => 'string', + 'example' => '中国_浙江省', + ], + 'CallDurationRatio' => [ + 'title' => '通话时长用量占比，四位小数表示，如1.0000', + 'description' => '', + 'type' => 'string', + 'example' => '0.6654', + ], + 'JoinChannelSucRate' => [ + 'title' => '加入频道成功率， 四位小数表示，如1.0000', + 'description' => '', + 'type' => 'string', + 'example' => '0.9356', + ], + 'JoinChannelSucFiveSecRate' => [ + 'title' => '5秒加入频道成功率， 四位小数表示，如1.0000', + 'description' => '', + 'type' => 'string', + 'example' => '0.9338', + ], + 'VideoFirstPicDuration' => [ + 'title' => '视频首次出图时间，单位毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1363', + ], + 'AudioStuckRate' => [ + 'title' => '音频卡顿率， 四位小数表示，如0.0034', + 'description' => '', + 'type' => 'string', + 'example' => '0.0021', + ], + 'VideoStuckRate' => [ + 'title' => '视频卡顿率， 四位小数表示，如0.0038', + 'description' => '', + 'type' => 'string', + 'example' => '0.0058', + ], + 'AudioDelay' => [ + 'title' => '音频延时，单位毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '347', + ], + 'VideoDelay' => [ + 'title' => '视频延时，单位毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '291', + ], + 'AudioHighQualityTransmissionRate' => [ + 'title' => '音频优质传输率， 四位小数表示，如0.9927', + 'description' => '', + 'type' => 'string', + 'example' => '0.9933', + ], + 'VideoHighQualityTransmissionRate' => [ + 'title' => '视频优质传输率，四位小数表示，如0.9965', + 'description' => '', + 'type' => 'string', + 'example' => '0.9967', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"QualityStatDataList\\": [\\n {\\n \\"Name\\": \\"中国_浙江省\\",\\n \\"CallDurationRatio\\": \\"0.6654\\",\\n \\"JoinChannelSucRate\\": \\"0.9356\\",\\n \\"JoinChannelSucFiveSecRate\\": \\"0.9338\\",\\n \\"VideoFirstPicDuration\\": 1363,\\n \\"AudioStuckRate\\": \\"0.0021\\",\\n \\"VideoStuckRate\\": \\"0.0058\\",\\n \\"AudioDelay\\": 347,\\n \\"VideoDelay\\": 291,\\n \\"AudioHighQualityTransmissionRate\\": \\"0.9933\\",\\n \\"VideoHighQualityTransmissionRate\\": \\"0.9967\\"\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeQualityOsSdkVersionDistributionStatData' => [ + 'summary' => '获取质量统计各操作系统下SDK版本分布数据', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间，秒级时间戳，如1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615824000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间，秒级时间戳，如1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615910399', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID', + 'description' => 'APP ID', + 'type' => 'string', + 'required' => true, + 'example' => '0rbd****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'QualityOsSdkVersionStatDataList' => [ + 'title' => '分布数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'SDK版本名称，1.0.0、1.1.1等', + 'description' => '', + 'type' => 'string', + 'example' => '2.1.0.210316.dev--release/rtcsdk_v2.1', + ], + 'Os' => [ + 'title' => '操作系统名称，iOS、android等', + 'description' => '', + 'type' => 'string', + 'example' => 'macOS', + ], + 'CallDurationRatio' => [ + 'title' => '通话时长用量占比，四位小数表示，如1.0000', + 'description' => '', + 'type' => 'string', + 'example' => '0.0984', + ], + 'JoinChannelSucRate' => [ + 'title' => '加入频道成功率， 四位小数表示，如1.0000', + 'description' => '', + 'type' => 'string', + 'example' => '0.8276', + ], + 'JoinChannelSucFiveSecRate' => [ + 'title' => '5秒加入频道成功率， 四位小数表示，如1.0000', + 'description' => '', + 'type' => 'string', + 'example' => '0.8276', + ], + 'VideoFirstPicDuration' => [ + 'title' => '视频首次出图时间，单位毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5643', + ], + 'AudioStuckRate' => [ + 'title' => '音频卡顿率， 四位小数表示，如0.0034', + 'description' => '', + 'type' => 'string', + 'example' => '0.0011', + ], + 'VideoStuckRate' => [ + 'title' => '视频卡顿率， 四位小数表示，如0.0038', + 'description' => '', + 'type' => 'string', + 'example' => '0.0054', + ], + 'AudioDelay' => [ + 'title' => '音频延时，单位毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '248', + ], + 'VideoDelay' => [ + 'title' => '视频延时，单位毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '333', + ], + 'AudioHighQualityTransmissionRate' => [ + 'title' => '音频优质传输率， 四位小数表示，如0.9927', + 'description' => '', + 'type' => 'string', + 'example' => '0.9987', + ], + 'VideoHighQualityTransmissionRate' => [ + 'title' => '视频优质传输率，四位小数表示，如0.9965', + 'description' => '', + 'type' => 'string', + 'example' => '0.9997', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"QualityOsSdkVersionStatDataList\\": [\\n {\\n \\"Name\\": \\"2.1.0.210316.dev--release/rtcsdk_v2.1\\",\\n \\"Os\\": \\"macOS\\",\\n \\"CallDurationRatio\\": \\"0.0984\\",\\n \\"JoinChannelSucRate\\": \\"0.8276\\",\\n \\"JoinChannelSucFiveSecRate\\": \\"0.8276\\",\\n \\"VideoFirstPicDuration\\": 5643,\\n \\"AudioStuckRate\\": \\"0.0011\\",\\n \\"VideoStuckRate\\": \\"0.0054\\",\\n \\"AudioDelay\\": 248,\\n \\"VideoDelay\\": 333,\\n \\"AudioHighQualityTransmissionRate\\": \\"0.9987\\",\\n \\"VideoHighQualityTransmissionRate\\": \\"0.9997\\"\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeFaultDiagnosisOverallData' => [ + 'summary' => '获取异常诊断总览数据', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID', + 'description' => 'APP ID', + 'type' => 'string', + 'required' => true, + 'example' => '4eah****', + ], + ], + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间，秒级时间戳：1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615824000', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间，秒级时间戳：1609344000', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615910399', + ], + ], + [ + 'name' => 'StatDim', + 'in' => 'query', + 'schema' => [ + 'title' => '获取数据统计维度： JOIN_SLOW_USER：进频道慢用户数 AUDIO_STUCK_USER：音频卡顿用户数 VIDEO_STUCK_USER：视频卡顿用户数 VIDEO_VAGUE_USER：视频模糊用户数 HIGH_DELAY_USER：通话延迟高用户数 FIRST_SCREEN_SLOW_USER：接收首屏慢用户数', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'JOIN_SLOW_USER', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OverallData' => [ + 'title' => '总览数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FaultUserCount' => [ + 'title' => '异常用户数/人次', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalUserCount' => [ + 'title' => '用户总数/人次', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'FaultUserRatio' => [ + 'title' => '异常用户总占比', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + ], + ], + 'MetricData' => [ + 'title' => '异常指标数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'title' => '指标坐标点列表，单位时间为1分钟的异常用户数据', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'title' => 'x轴横坐标，秒级时间戳', + 'description' => '', + 'type' => 'string', + 'example' => '1615824000', + ], + 'Y' => [ + 'title' => 'y轴横坐标，单位数据异常用户数', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Ext' => [ + 'title' => '拓展属性，ratio：单位时间内异常用户占比，totalCount：单位时间内用户总数', + 'description' => '', + 'type' => 'object', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OverallData\\": {\\n \\"FaultUserCount\\": 20,\\n \\"TotalUserCount\\": 40,\\n \\"FaultUserRatio\\": 0.5\\n },\\n \\"MetricData\\": {\\n \\"Nodes\\": [\\n {\\n \\"X\\": \\"1615824000\\",\\n \\"Y\\": \\"1\\",\\n \\"Ext\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeFaultDiagnosisFactorDistributionStat' => [ + 'summary' => '获取异常诊断影响因素分布', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => '0rbd****'."\n", + ], + ], + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'title' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615892596', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'title' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615892596****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'StatList' => [ + 'title' => '影响因素分布统计数据', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FactorId' => [ + 'title' => '影响因素ID： 1：发布端网络差 2：订阅端网络差 3：发布端设备性能差 4：发布端关闭摄像头 5：发布端切到后台运行，UNKNOWN：未知', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'UserCount' => [ + 'title' => '影响用户数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'UserRatio' => [ + 'title' => '影响用户占比', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9239', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatList\\": [\\n {\\n \\"FactorId\\": \\"1\\",\\n \\"UserCount\\": 100,\\n \\"UserRatio\\": 0.9239\\n }\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeFaultDiagnosisUserList' => [ + 'summary' => '获取异常诊断用户明细列表', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => '0rbd****'."\n", + ], + ], + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'title' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615806196', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'title' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615892596', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索的频道ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '311', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索的用户ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'c906531af5f9****', + ], + ], + [ + 'name' => 'FaultTypes', + 'in' => 'query', + 'schema' => [ + 'title' => '过滤的异常类型，多个使用半角逗号分隔 JOIN_SLOW：进频道慢 AUDIO_STUCK：音频卡顿 VIDEO_STUCK：视频卡顿 VIDEO_VAGUE：视频模糊 HIGH_DELAY：通话延迟高 FIRST_FRAME_SLOW：接收首屏慢', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'JOIN_SLOW,AUDIO_STUCK', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'UserList' => [ + 'title' => '异常用户明细列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'example' => '904', + ], + 'UserId' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'example' => '123456', + ], + 'CreatedTs' => [ + 'title' => '用户首次进入通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'DestroyedTs' => [ + 'title' => '用户最后一次离开通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'ChannelCreatedTs' => [ + 'title' => '通信的创建时间戳，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'FaultList' => [ + 'title' => '异常列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaultType' => [ + 'title' => '异常类型 JOIN_SLOW：进频道慢 AUDIO_STUCK：音频卡顿 VIDEO_STUCK：视频卡顿 VIDEO_VAGUE：视频模糊 HIGH_DELAY：通话延迟高 FIRST_FRAME_SLOW：接收首屏慢', + 'description' => '', + 'type' => 'string', + 'example' => 'JOIN_SLOW', + ], + ], + ], + ], + ], + ], + ], + 'PageNo' => [ + 'title' => '页码。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'title' => '每页数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCnt' => [ + 'title' => '总数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UserList\\": [\\n {\\n \\"ChannelId\\": \\"904\\",\\n \\"UserId\\": \\"testuserid\\",\\n \\"CreatedTs\\": 1614936817,\\n \\"DestroyedTs\\": 1614936817,\\n \\"ChannelCreatedTs\\": 1614936817,\\n \\"FaultList\\": [\\n {\\n \\"FaultType\\": \\"JOIN_SLOW\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCnt\\": 1,\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'DescribeFaultDiagnosisUserDetail' => [ + 'summary' => '获取异常诊断用户详情', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP ID。', + 'description' => 'APP ID。', + 'type' => 'string', + 'required' => true, + 'example' => '0rbd****'."\n", + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '311', + ], + ], + [ + 'name' => 'CreatedTs', + 'in' => 'query', + 'schema' => [ + 'title' => '频道创建时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615892596', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'c906531af5f9****', + ], + ], + [ + 'name' => 'FaultType', + 'in' => 'query', + 'schema' => [ + 'title' => '异常类型 JOIN_SLOW：进频道慢 AUDIO_STUCK：音频卡顿 VIDEO_STUCK：视频卡顿 VIDEO_VAGUE：视频模糊 HIGH_DELAY：通话延迟高 FIRST_FRAME_SLOW：接收首屏慢', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'JOIN_SLOW', + ], + ], + [ + 'name' => 'QueryCallUserInfo', + 'in' => 'query', + 'schema' => [ + 'title' => '是否查询通话用户信息，为空默认是false', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CallInfo' => [ + 'title' => '通信基本信息，QueryCallUserInfo=false是返回。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'title' => 'App ID。', + 'description' => 'App ID。', + 'type' => 'string', + 'example' => '0rbd****'."\n", + ], + 'ChannelId' => [ + 'title' => '频道ID。', + 'description' => '', + 'type' => 'string', + 'example' => '311', + ], + 'CallStatus' => [ + 'title' => '通信状态。取值：IN：进行中。OUT：已结束。', + 'description' => '', + 'type' => 'string', + 'example' => 'IN', + ], + 'CreatedTs' => [ + 'title' => '创建通信时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620957905', + ], + 'DestroyedTs' => [ + 'title' => '释放通信时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620958150', + ], + 'Duration' => [ + 'title' => '通信持续时长，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + 'UserDetail' => [ + 'title' => '诊断用户详细信，QueryCallUserInfo=false是返回息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户ID。', + 'description' => '', + 'type' => 'string', + 'example' => '0a497933****'."\n", + ], + 'Location' => [ + 'title' => '地理位置信息，例如：北京市-北京市', + 'description' => '', + 'type' => 'string', + 'example' => '浙江省-杭州市', + ], + 'OnlinePeriods' => [ + 'title' => '在线时段信息。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JoinTs' => [ + 'title' => '加入通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620957919', + ], + 'LeaveTs' => [ + 'title' => '离开通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620958150', + ], + ], + ], + ], + 'CreatedTs' => [ + 'title' => '创建通话时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620957919'."\n", + ], + 'DestroyedTs' => [ + 'title' => '释放通话时间，使用UNIX时间戳表示，单位：秒。通话未结束时值为0。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620958150', + ], + 'OnlineDuration' => [ + 'title' => '在线时长，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '231', + ], + 'Duration' => [ + 'title' => '通话时长，首次进入到最后离开，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '231', + ], + 'SdkVersion' => [ + 'title' => 'SDK版本，如1.0.0、1.1.1等', + 'description' => '', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'Os' => [ + 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', + 'description' => '', + 'type' => 'string', + 'example' => 'iOS', + ], + 'Network' => [ + 'title' => '网络类型，如WiFi，4G等', + 'description' => '', + 'type' => 'string', + 'example' => '4G', + ], + ], + ], + 'FaultMetricData' => [ + 'title' => '异常指标', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'title' => '指标坐标点列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'title' => 'x轴坐标值，秒级时间戳，单位时间为分钟', + 'description' => '', + 'type' => 'string', + 'example' => '1620957900', + ], + 'Y' => [ + 'title' => 'y轴坐标值，异常指标的值', + 'description' => '', + 'type' => 'string', + 'example' => '0.4540'."\n", + ], + ], + ], + ], + ], + ], + 'FactorList' => [ + 'title' => '影响因素列表，空表示影响因素未知', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FactorId' => [ + 'title' => '影响因素ID： 1：发布端网络差 2：订阅端网络差 3：发布端设备性能差 4：发布端关闭摄像头 5：发布端切到后台运行', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'FaultSource' => [ + 'title' => '异常来源 LOCAL：本端 REMOTE：远端', + 'description' => '', + 'type' => 'string', + 'example' => 'LOCAL', + ], + 'RelatedMetricDatas' => [ + 'title' => '关联的指标，坐标数据，当FaultType为AUDIO_STUCK、VIDEO_STUCK、VIDEO_VAGUE、HIGH_DELAY时返回', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'title' => '来源角色： SENDER：发布端，即上行 RECEIVER：订阅端，即下行', + 'description' => '', + 'type' => 'string', + 'example' => 'SENDER', + ], + 'UserId' => [ + 'title' => '数据来自对应发布端的用户ID', + 'description' => '', + 'type' => 'string', + 'example' => '0a497933****'."\n", + ], + 'Type' => [ + 'title' => '指标类型，参照端到端指标接口的指标类型', + 'description' => '', + 'type' => 'string', + 'example' => 'AUDIO_STUCK'."\n", + ], + 'Nodes' => [ + 'title' => '坐标数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'title' => 'X坐标值，秒级时间戳', + 'description' => '', + 'type' => 'string', + 'example' => '1615892596', + ], + 'Y' => [ + 'title' => 'Y坐标值，指标值', + 'description' => '', + 'type' => 'string', + 'example' => '20', + ], + 'Ext' => [ + 'title' => '扩展数据', + 'description' => '', + 'type' => 'object', + ], + ], + ], + ], + ], + ], + ], + 'RelatedEventDatas' => [ + 'title' => '关联的事件，按时间分组，当FaultType为AUDIO_STUCK、VIDEO_STUCK、VIDEO_VAGUE、HIGH_DELAY时返回', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户ID', + 'description' => '', + 'type' => 'string', + 'example' => '0a497933****', + ], + 'Role' => [ + 'title' => '来源角色： SENDER：发布端，即上行 RECEIVER：订阅端，即下行', + 'description' => '', + 'type' => 'string', + 'example' => 'SENDER', + ], + 'EventDataItems' => [ + 'title' => '事件数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Ts' => [ + 'title' => '第一个事件发生的时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + 'EventList' => [ + 'title' => '事件列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventName' => [ + 'title' => '事件名称。', + 'description' => '', + 'type' => 'string', + 'example' => '开始发布', + ], + 'EventType' => [ + 'title' => '事件类型，取值：USER：用户事件。SYSTEM：系统事件。', + 'description' => '', + 'type' => 'string', + 'example' => 'USER', + ], + 'Ts' => [ + 'title' => '事件发生的时间，使用UNIX时间戳表示，单位：秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614936817', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'NetworkOperators' => [ + 'title' => '网络运营商列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '移动', + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiParamError', + 'errorMessage' => 'API %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BizCreatedTsError', + 'errorMessage' => 'A business CreatedTs error occurred.', + ], + [ + 'errorCode' => 'BizAppError', + 'errorMessage' => 'A business application permission error occurred.', + ], + [ + 'errorCode' => 'BizUidError', + 'errorMessage' => 'A business UID error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerInternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CallInfo\\": {\\n \\"AppId\\": \\"testappid\\",\\n \\"ChannelId\\": \\"311\\",\\n \\"CallStatus\\": \\"IN\\",\\n \\"CreatedTs\\": 1620957905,\\n \\"DestroyedTs\\": 1620958150,\\n \\"Duration\\": 100\\n },\\n \\"UserDetail\\": {\\n \\"UserId\\": \\"testuserid\\",\\n \\"Location\\": \\"浙江省-杭州市\\",\\n \\"OnlinePeriods\\": [\\n {\\n \\"JoinTs\\": 1620957919,\\n \\"LeaveTs\\": 1620958150\\n }\\n ],\\n \\"CreatedTs\\": 1620957919,\\n \\"DestroyedTs\\": 1620958150,\\n \\"OnlineDuration\\": 231,\\n \\"Duration\\": 231,\\n \\"SdkVersion\\": \\"1.0.0\\",\\n \\"Os\\": \\"iOS\\",\\n \\"Network\\": \\"4G\\"\\n },\\n \\"FaultMetricData\\": {\\n \\"Nodes\\": [\\n {\\n \\"X\\": \\"1620957900\\",\\n \\"Y\\": \\"0.4540\\"\\n }\\n ]\\n },\\n \\"FactorList\\": [\\n {\\n \\"FactorId\\": \\"1\\",\\n \\"FaultSource\\": \\"LOCAL\\",\\n \\"RelatedMetricDatas\\": [\\n {\\n \\"Role\\": \\"SENDER\\",\\n \\"UserId\\": \\"testuserid2\\",\\n \\"Type\\": \\"AUDIO_STUCK\\",\\n \\"Nodes\\": [\\n {\\n \\"X\\": \\"1615892596\\",\\n \\"Y\\": \\"20\\",\\n \\"Ext\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n }\\n ],\\n \\"RelatedEventDatas\\": [\\n {\\n \\"UserId\\": \\"0a497933****\\",\\n \\"Role\\": \\"SENDER\\",\\n \\"EventDataItems\\": [\\n {\\n \\"Ts\\": 1614936817,\\n \\"EventList\\": [\\n {\\n \\"EventName\\": \\"开始发布\\",\\n \\"EventType\\": \\"USER\\",\\n \\"Ts\\": 1614936817\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"NetworkOperators\\": [\\n \\"移动\\"\\n ],\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', + ], + 'CreateEventSubscribe' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Users', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + 'required' => false, + 'example' => 'user1', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'Events', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ChannelEvent', + ], + 'required' => true, + 'example' => 'ChannelEvent', + 'maxItems' => 16, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '9qb1****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123333', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'http://****.com/callback', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'NeedCallbackAuth', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SubscribeId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ad53276431c****', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorIdempotent', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorAPIQueryRow', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ErrorAPINoAppId', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ErrorInvalidCallBackURL', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ErrorIdempotentParameterMismatch', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SubscribeId\\": \\"ad53276431c****\\",\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateEventSubscribeResponse>\\n<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n<SubscribeId>ad53276431c****</SubscribeId>\\n</CreateEventSubscribeResponse>","errorExample":""}]', + 'title' => 'CreateEventSubscribe', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteEventSubscribe' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '9qb1****', + ], + ], + [ + 'name' => 'SubscribeId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ad53276431c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAPIQueryRow', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ErrorAPIInvalidSubscribeId', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEventSubscribeResponse>\\r\\n<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\r\\n</DeleteEventSubscribeResponse>","errorExample":""}]', + 'title' => 'DeleteEventSubscribe', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateAutoLiveStreamRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ChannelIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12333', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'ChannelIdPrefixes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'PlayDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rtmp://${domain}/${app}/${stream}', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'testRule', + ], + ], + [ + 'name' => 'CallBack', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example.com/callback', + ], + ], + [ + 'name' => 'MediaEncode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAPIInvalidAppID', + 'errorMessage' => 'The AppID API request is invalid: %s', + ], + [ + 'errorCode' => 'ErrorAPIQueryRow', + 'errorMessage' => 'The QueryRow request is invalid: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RuleId\\": 12,\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAutoLiveStreamRuleResponse>\\n <RuleId>12</RuleId>\\n <RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n</CreateAutoLiveStreamRuleResponse>","errorExample":""}]', + 'title' => 'CreateAutoLiveStreamRule', + ], + 'DeleteAutoLiveStreamRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAPIInvalidAppID', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ErrorAPINoRuleId', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ErrorNotMatchRuleId', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ErrorAPINoSignature', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'ErrorAPIIllegalSignature', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAutoLiveStreamRuleResponse>\\n <RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n</DeleteAutoLiveStreamRuleResponse>","errorExample":""}]', + 'title' => 'DeleteAutoLiveStreamRule', + ], + 'DisableAutoLiveStreamRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAPIInvalidAppID', + 'errorMessage' => 'The AppID API request is invalid: %s', + ], + [ + 'errorCode' => 'ErrorAPIQueryRow', + 'errorMessage' => 'The QueryRow request is invalid: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableAutoLiveStreamRuleResponse>\\n <RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n</DisableAutoLiveStreamRuleResponse>","errorExample":""}]', + 'title' => 'DisableAutoLiveStreamRule', + ], + 'EnableAutoLiveStreamRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAPIInvalidAppID', + 'errorMessage' => 'The AppID API request is invalid: %s', + ], + [ + 'errorCode' => 'ErrorAPIQueryRow', + 'errorMessage' => 'The QueryRow request is invalid: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableAutoLiveStreamRuleResponse>\\n <RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n</EnableAutoLiveStreamRuleResponse>","errorExample":""}]', + 'title' => 'EnableAutoLiveStreamRule', + ], + 'UpdateAutoLiveStreamRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ChannelIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12333', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'ChannelIdPrefixes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'PlayDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rtmp://${domain}/${app}/${stream}', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'testRule', + ], + ], + [ + 'name' => 'CallBack', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example.com/callback', + ], + ], + [ + 'name' => 'MediaEncode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '12', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAPIInvalidAppID', + 'errorMessage' => 'The AppID API request is invalid: %s', + ], + [ + 'errorCode' => 'ErrorAPIQueryRow', + 'errorMessage' => 'The QueryRow request is invalid: %s', + ], + [ + 'errorCode' => 'InvalidParameter.Format', + 'errorMessage' => 'The request parameter is invalid: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAutoLiveStreamRuleResponse>\\n <RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n</UpdateAutoLiveStreamRuleResponse>","errorExample":""}]', + 'title' => 'UpdateAutoLiveStreamRule', + ], + 'DescribeAutoLiveStreamRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eo85****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '069BCB66-CD80-11E8-A82B-A70F78BBDC00', + ], + 'Rules' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'disable', + ], + 'MediaEncode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PlayDomain' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rtmp://${domain}/${app}/${stream}', + ], + 'CallBack' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://example.com/callBack', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-08-19T02:53:07Z', + ], + 'RuleId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'RuleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'testRule', + ], + 'ChannelIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '12333', + ], + ], + 'ChannelIdPrefixes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '12', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAPIInvalidAppID', + 'errorMessage' => 'The AppID API request is invalid: %s', + ], + [ + 'errorCode' => 'ErrorAPIQueryRow', + 'errorMessage' => 'The QueryRow request is invalid: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"069BCB66-CD80-11E8-A82B-A70F78BBDC00\\",\\n \\"Rules\\": [\\n {\\n \\"Status\\": \\"disable\\",\\n \\"MediaEncode\\": 20,\\n \\"PlayDomain\\": \\"rtmp://${domain}/${app}/${stream}\\",\\n \\"CallBack\\": \\"http://example.com/callBack\\",\\n \\"CreateTime\\": \\"2021-08-19T02:53:07Z\\",\\n \\"RuleId\\": 12,\\n \\"RuleName\\": \\"testRule\\",\\n \\"ChannelIds\\": [\\n \\"12333\\"\\n ],\\n \\"ChannelIdPrefixes\\": [\\n \\"12\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAutoLiveStreamRuleResponse>\\n <RequestId>069BCB66-CD80-11E8-A82B-A70F78BBDC00</RequestId>\\n <Rules>\\n <Status>disable</Status>\\n <CallBack/>\\n <PlayDomain>rtmp://${domain}/${app}/${stream}</PlayDomain>\\n <RuleId>12</RuleId>\\n <CreateTime>2021-08-19T02:53:07Z</CreateTime>\\n <MediaEncode/>\\n <RuleName>testRule</RuleName>\\n </Rules>\\n</DescribeAutoLiveStreamRuleResponse>","errorExample":""}]', + 'title' => 'DescribeAutoLiveStreamRule', + ], + 'DeleteChannel' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'App.Stop', + 'errorMessage' => 'App stopped', + ], + ], + 404 => [ + [ + 'errorCode' => 'App.NotExist', + 'errorMessage' => 'App not existed', + ], + [ + 'errorCode' => 'Channel.NotExist', + 'errorMessage' => 'Channel not existed', + ], + [ + 'errorCode' => 'Service.NoSignaling', + 'errorMessage' => 'service no signaling', + ], + ], + 500 => [ + [ + 'errorCode' => 'App.InternalError', + 'errorMessage' => 'App operate internal error', + ], + [ + 'errorCode' => 'Channel.InternalError', + 'errorMessage' => 'Channel operate internal error', + ], + [ + 'errorCode' => 'Service.InternalError', + 'errorMessage' => 'service internal error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"rtc.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<DeleteChannelResesponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CF8</RequestId>\\n</DeleteChannelResesponse>\\n\\t\\n","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}"}]', + 'title' => 'DeleteChannel', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeChannelParticipants' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'aec****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testId', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6159ba01-6687-4fb2-a831-f0cd8d188648', + ], + 'Timestamp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1557909133', + ], + 'TotalNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'UserList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'User' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '27f9****,bb87****,df82****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'Channel.NotExist', + 'errorMessage' => 'Channel not existed', + ], + [ + 'errorCode' => 'Service.NoSignaling', + 'errorMessage' => 'service no signaling', + ], + ], + 500 => [ + [ + 'errorCode' => 'Channel.InternalError', + 'errorMessage' => 'Channel operate internal error', + ], + [ + 'errorCode' => 'Service.InternalError', + 'errorMessage' => 'service internal error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalPage\\": 1,\\n \\"RequestId\\": \\"6159ba01-6687-4fb2-a831-f0cd8d188648\\",\\n \\"Timestamp\\": 1557909133,\\n \\"TotalNum\\": 3,\\n \\"UserList\\": {\\n \\"User\\": [\\n \\"27f9****,bb87****,df82****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeChannelParticipantsResponse>\\n<RequestId>6159ba01-6687-4fb2-a831-f0cd8d188648</RequestId>\\n<Timestamp>1557909133</Timestamp>\\n<TotalNum>3</TotalNum>\\n<TotalPage>1</TotalPage>\\n<UserList>\\n <User>27f9****</User>\\n <User>bb87****</User>\\n <User>df82****</User>\\n</UserList>\\n</DescribeChannelParticipantsResponse>","errorExample":""}]', + 'title' => 'DescribeChannelParticipants', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeUserInfoInChannel' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '4eah****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6159ba01-6687-4fb2-a831-f0cd8d188648', + ], + 'Timestamp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1557909133', + ], + 'IsInChannel' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsChannelExist' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Property' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Session' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xa744sxx8rtobgj****', + ], + 'Role' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Join' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1557909133', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'request.norequestid', + 'errorMessage' => 'no request', + ], + [ + 'errorCode' => 'request.noaliuid', + 'errorMessage' => 'no aliuid', + ], + [ + 'errorCode' => 'request.noappid', + 'errorMessage' => 'no appid', + ], + [ + 'errorCode' => 'request.nochannelid', + 'errorMessage' => 'no channelid', + ], + [ + 'errorCode' => 'request.nouserid', + 'errorMessage' => 'no userid', + ], + [ + 'errorCode' => 'service.signalrequesterror', + 'errorMessage' => 'signal request error', + ], + ], + [ + [ + 'errorCode' => 'request.illegalauth', + 'errorMessage' => 'illegal auth', + ], + [ + 'errorCode' => 'request.authinvalid', + 'errorMessage' => 'auth invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'service.signalrequesterror', + 'errorMessage' => 'signal send msg error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6159ba01-6687-4fb2-a831-f0cd8d188648\\",\\n \\"Timestamp\\": 1557909133,\\n \\"IsInChannel\\": true,\\n \\"IsChannelExist\\": true,\\n \\"Property\\": [\\n {\\n \\"Session\\": \\"xa744sxx8rtobgj****\\",\\n \\"Role\\": 1,\\n \\"Join\\": 1557909133\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeUserInfoInChannelResponse>\\n<RequestId>6159ba01-6687-4fb2-a831-f0cd8d188648</RequestId>\\n<TimeStamp>1557909133</TimeStamp>\\n<IsChannelExist>true</IsChannelExist>\\n<IsInChannel>true</IsInChannel>\\n<Property>\\n <Join>1557909133</Join>\\n <Session>xa744sxx8rtobgj****</Session>\\n <Role>1</Role>\\n</Property>\\n</DescribeUserInfoInChannelResponse>","errorExample":""}]', + 'title' => 'DescribeUserInfoInChannel', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeChannelUsers' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'a2hz****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CommTotalNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6159ba01-6687-4fb2-a831-f0cd8d188648', + ], + 'IsChannelExist' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'LiveUserNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Timestamp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1557909133', + ], + 'ChannelProfile' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InteractiveUserNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'UserList' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[]', + ], + ], + 'InteractiveUserList' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["4455****", "3267****", "efbc****"]', + ], + ], + 'LiveUserList' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["4455****", "3267****", "efbc****"]', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'request.norequestid', + 'errorMessage' => 'no request', + ], + [ + 'errorCode' => 'request.noaliuid', + 'errorMessage' => 'no aliuid', + ], + [ + 'errorCode' => 'request.noappid', + 'errorMessage' => 'no appid', + ], + [ + 'errorCode' => 'request.nochannelid', + 'errorMessage' => 'no channelid', + ], + [ + 'errorCode' => 'service.signalrequesterror', + 'errorMessage' => 'signal request error', + ], + ], + [ + [ + 'errorCode' => 'request.illegalauth', + 'errorMessage' => 'illegal auth', + ], + [ + 'errorCode' => 'request.authinvalid', + 'errorMessage' => 'auth invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'service.signalrequesterror', + 'errorMessage' => 'signal send msg error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CommTotalNum\\": 100,\\n \\"RequestId\\": \\"6159ba01-6687-4fb2-a831-f0cd8d188648\\",\\n \\"IsChannelExist\\": true,\\n \\"LiveUserNum\\": 0,\\n \\"Timestamp\\": 1557909133,\\n \\"ChannelProfile\\": 1,\\n \\"InteractiveUserNum\\": 0,\\n \\"UserList\\": [\\n \\"[]\\"\\n ],\\n \\"InteractiveUserList\\": [\\n \\"[\\\\\\"4455****\\\\\\", \\\\\\"3267****\\\\\\", \\\\\\"efbc****\\\\\\"]\\"\\n ],\\n \\"LiveUserList\\": [\\n \\"[\\\\\\"4455****\\\\\\", \\\\\\"3267****\\\\\\", \\\\\\"efbc****\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeChannelUsersResponse>\\n<RequestId>6159ba01-6687-4fb2-a831-f0cd8d188648</RequestId>\\n<TimeStamp>1557909133</TimeStamp>\\n<IsChannelExist>true</IsChannelExist>\\n<ChannelProfile>1</ChannelProfile>\\n<CommTotalNum>100</CommTotalNum>\\n<InteractiveUserNum>0</InteractiveUserNum>\\n<LiveUserNum>0</LiveUserNum>\\n<UserList>4455****</UserList>\\n<UserList>3267****</UserList>\\n<UserList>efbc****</UserList>\\n</DescribeChannelUsersResponse>\\n","errorExample":""}]', + 'title' => 'DescribeChannelUsers', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveTerminals' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TerminalIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1811****', + ], + 'required' => true, + 'example' => '1811xxxx', + 'maxItems' => 30, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourChannelId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'Terminals' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Terminal' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1811****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'Channel.NotExist', + 'errorMessage' => 'Channel not existed', + ], + [ + 'errorCode' => 'Service.NoSignaling', + 'errorMessage' => 'service no signaling', + ], + ], + 500 => [ + [ + 'errorCode' => 'Channel.InternalError', + 'errorMessage' => 'Channel operate internal error', + ], + [ + 'errorCode' => 'Service.InternalError', + 'errorMessage' => 'service internal error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"Terminals\\": {\\n \\"Terminal\\": [\\n {\\n \\"Code\\": 0,\\n \\"Message\\": \\"Success\\",\\n \\"Id\\": \\"1811****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RemoveTerminalsResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n <Terminals>\\n <Id>1811****</Id>\\n <Code>0</Code>\\n <Message>Success</Message>\\n </Terminals>\\n <Terminals>\\n <Id>1811****</Id>\\n <Code>0</Code>\\n <Message>Success</Message>\\n </Terminals>\\n</RemoveTerminalsResponse>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddRecordTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'LayoutIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'required' => true, + 'example' => '2', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'Formats', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mp4', + ], + 'required' => true, + 'example' => 'mp4', + 'maxItems' => 3, + ], + ], + [ + 'name' => 'Backgrounds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'Watermarks', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Alpha' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'ClockWidgets', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FontType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'FontColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'FontSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'TaskProfile', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '4IN_1080P', + ], + ], + [ + 'name' => 'MediaEncode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'BackgroundColor', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'OssBucket', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rtc-record-oss', + ], + ], + [ + 'name' => 'OssFilePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}', + ], + ], + [ + 'name' => 'FileSplitInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1800', + ], + ], + [ + 'name' => 'DelayStopTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '86400', + 'minimum' => '5', + 'example' => '180', + 'default' => '180', + ], + ], + [ + 'name' => 'MnsQueue', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'record-callback-queue', + ], + ], + [ + 'name' => 'HttpCallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example.com/callback', + ], + ], + [ + 'name' => 'EnableM3u8DateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '76dasgb****', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SLR.NoPermission', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TemplateId\\": \\"76dasgb****\\",\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<AddRecordTemplateResponse>\\n<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n<TemplateId>76dasgb****</TemplateId>\\n</AddRecordTemplateResponse>","errorExample":""}]', + 'title' => 'AddRecordTemplate', + 'responseParamsDescription' => ' ', + ], + 'DeleteRecordTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '76dasgb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'TaskExisted', + 'errorMessage' => 'the task is existed', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteRecordTemplateResponse>\\r\\n<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\r\\n</DeleteRecordTemplateResponse>","errorExample":""}]', + 'title' => 'DeleteRecordTemplate', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'UpdateRecordTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'LayoutIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'required' => true, + 'example' => '1111', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'Formats', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mp4', + ], + 'required' => true, + 'example' => 'mp4', + 'maxItems' => 3, + ], + ], + [ + 'name' => 'Backgrounds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'Watermarks', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Alpha' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'ClockWidgets', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FontType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'FontColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'FontSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '76dasgb****', + ], + ], + [ + 'name' => 'TaskProfile', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '4IN_1080P', + ], + ], + [ + 'name' => 'MediaEncode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'BackgroundColor', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'OssBucket', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rtc-record-pre', + ], + ], + [ + 'name' => 'OssFilePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}', + ], + ], + [ + 'name' => 'MnsQueue', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'record-callback-queue', + ], + ], + [ + 'name' => 'HttpCallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example.com/callback', + ], + ], + [ + 'name' => 'FileSplitInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1800', + ], + ], + [ + 'name' => 'DelayStopTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '86400', + 'minimum' => '5', + 'example' => '180', + 'default' => '180', + ], + ], + [ + 'name' => 'EnableM3u8DateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '76dasgb****', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'TaskExisted', + 'errorMessage' => 'the task is existed', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TemplateId\\": \\"76dasgb****\\",\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateRecordTemplateResponse>\\n<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n<TemplateId>76dasgb****</TemplateId>\\n</UpdateRecordTemplateResponse>","errorExample":""}]', + 'title' => 'UpdateRecordTemplate', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'StartRecordTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'SubSpecUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'userID', + ], + 'required' => false, + 'example' => 'userID', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'SubSpecAudioUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'audioUserID', + ], + 'required' => false, + 'example' => '1', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'SubSpecShareScreenUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'videoUserID', + ], + 'required' => false, + 'example' => '1', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'SubSpecCameraUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cameraUserID', + ], + 'required' => false, + 'example' => '1', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UnsubSpecAudioUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'audioUserID2', + ], + 'required' => false, + 'example' => '1', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UnsubSpecShareScreenUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'videoUserID2', + ], + 'required' => false, + 'example' => '1', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UnsubSpecCameraUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cameraUserID2', + ], + 'required' => false, + 'example' => '1', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UserPanes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Images' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + 'UserId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'TestId', + ], + 'Texts' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FontType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'FontColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Text' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'FontSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + ], + 'PaneId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'LayoutIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'example' => '1111', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'yourChannelId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'yourTaskId', + ], + ], + [ + 'name' => 'TaskProfile', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '4IN_1080P', + ], + ], + [ + 'name' => 'MediaEncode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '76dasgb****', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'MixMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CropMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'TaskExisted', + 'errorMessage' => 'the task is existed', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartRecordTaskResponse>\\r\\n<RequestId>760bad53276431c499e30dc36f6b****</RequestId>\\r\\n</StartRecordTaskResponse>","errorExample":""}]', + 'title' => 'StartRecordTask', + ], + 'StopRecordTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourTaskId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<StopRecordTaskResponse>\\r\\n<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\r\\n</StopRecordTaskResponse>","errorExample":""}]', + 'title' => 'StopRecordTask', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'UpdateRecordTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'SubSpecUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'userID', + ], + 'required' => false, + 'example' => 'userID', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'SubSpecAudioUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'audioUserID', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'SubSpecShareScreenUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'videoUserID', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'SubSpecCameraUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cameraUserID', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UnsubSpecAudioUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'audioUserID2', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UnsubSpecShareScreenUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'videoUserID2', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UnsubSpecCameraUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cameraUserID2', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UserPanes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Images' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + 'UserId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'TestId', + ], + 'Texts' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FontType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'FontColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Text' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'FontSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + ], + 'PaneId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'LayoutIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'yourChannelId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'yourTaskId', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '76dasgb****', + ], + ], + [ + 'name' => 'TaskProfile', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CropMode', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'MediaEncode', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateRecordTaskResponse>\\r\\n<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\r\\n</UpdateRecordTaskResponse>","errorExample":""}]', + 'title' => 'UpdateRecordTask', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeRecordTemplates' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TemplateIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'example' => '76dasgb****', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C292B80E-5175-4BA4-8CC292B80E-5175-4BA4-8C1E-2ABEC4D7C2FE1E-2ABEC4D7****', + ], + 'TotalNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Templates' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MnsQueue' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'record-callback-queue', + ], + 'OssFilePrefix' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'record/pre/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-09-04T06:22:15Z', + ], + 'OssBucket' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rtc-record-oss', + ], + 'DelayStopTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '180', + ], + 'MediaEncode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'FileSplitInterval' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1800', + ], + 'HttpCallbackUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://example.com/callback', + ], + 'EnableM3u8DateTime' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'BackgroundColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'TemplateId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1ca698e2-57fa-4314-8e11-00d950d4****', + ], + 'TaskProfile' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4IN_1080P', + ], + 'Backgrounds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7576', + ], + ], + ], + ], + 'Watermarks' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Alpha' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7576', + ], + ], + ], + ], + 'ClockWidgets' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FontType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FontColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7576', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7576', + ], + 'FontSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'LayoutIds' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'example' => '2', + 'format' => 'int64', + ], + ], + 'Formats' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'M3U8', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'TaskExisted', + 'errorMessage' => 'the task is existed', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalPage\\": 1,\\n \\"RequestId\\": \\"C292B80E-5175-4BA4-8CC292B80E-5175-4BA4-8C1E-2ABEC4D7C2FE1E-2ABEC4D7****\\",\\n \\"TotalNum\\": 1,\\n \\"Templates\\": [\\n {\\n \\"MnsQueue\\": \\"record-callback-queue\\",\\n \\"OssFilePrefix\\": \\"record/pre/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"CreateTime\\": \\"2020-09-04T06:22:15Z\\",\\n \\"OssBucket\\": \\"rtc-record-oss\\",\\n \\"DelayStopTime\\": 180,\\n \\"MediaEncode\\": 50,\\n \\"FileSplitInterval\\": 1800,\\n \\"HttpCallbackUrl\\": \\"http://example.com/callback\\",\\n \\"EnableM3u8DateTime\\": false,\\n \\"BackgroundColor\\": 0,\\n \\"Name\\": \\"模板-demo\\",\\n \\"TemplateId\\": \\"1ca698e2-57fa-4314-8e11-00d950d4****\\",\\n \\"TaskProfile\\": \\"4IN_1080P\\",\\n \\"Backgrounds\\": [\\n {\\n \\"Width\\": 0.2456,\\n \\"Height\\": 0.2456,\\n \\"Y\\": 0.7576,\\n \\"Url\\": \\"https://www.example.com/image.jpg\\",\\n \\"Display\\": 0,\\n \\"ZOrder\\": 0,\\n \\"X\\": 0.7576\\n }\\n ],\\n \\"Watermarks\\": [\\n {\\n \\"Alpha\\": 0,\\n \\"Width\\": 0.2456,\\n \\"Height\\": 0.2456,\\n \\"Y\\": 0.7576,\\n \\"Url\\": \\"https://www.example.com/image.jpg\\",\\n \\"Display\\": 0,\\n \\"ZOrder\\": 0,\\n \\"X\\": 0.7576\\n }\\n ],\\n \\"ClockWidgets\\": [\\n {\\n \\"FontType\\": 0,\\n \\"FontColor\\": 0,\\n \\"Y\\": 0.7576,\\n \\"ZOrder\\": 0,\\n \\"X\\": 0.7576,\\n \\"FontSize\\": 1\\n }\\n ],\\n \\"LayoutIds\\": [\\n \\"2\\"\\n ],\\n \\"Formats\\": [\\n \\"M3U8\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeRecordTemplatesResponse>\\r\\n<TotalNum>1</TotalNum>\\r\\n\\t<RequestId>C292B80E-5175-4BA4-8C1E-2ABEC4D7C2FE</RequestId>\\r\\n\\t<TotalPage>1</TotalPage>\\r\\n\\t<Templates>\\r\\n\\t\\t<FileSplitInterval>1800</FileSplitInterval>\\r\\n<OssFilePrefix>record/pre/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}</OssFilePrefix>\\r\\n\\t\\t<TaskProfile>4IN_1080P</TaskProfile>\\r\\n\\t\\t<OssBucket>rtc-record-pre</OssBucket>\\r\\n\\t\\t<MediaEncode>50</MediaEncode>\\r\\n\\t\\t<LayoutIds>2</LayoutIds>\\r\\n\\t\\t<Formats>m3u8</Formats>\\r\\n\\t\\t<TemplateId>1ca698e2-57fa-4314-8e11-00d950d4****</TemplateId>\\r\\n\\t\\t<MnsQueue>record-callback-queue</MnsQueue>\\r\\n\\t\\t<Name>模板-demo</Name>\\r\\n\\t\\t<BackgroundColor>0</BackgroundColor>\\r\\n\\t</Templates>\\r\\n </DescribeRecordTemplatesResponse>","errorExample":""}]', + 'title' => 'DescribeRecordTemplates', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRecordFiles' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'yourTaskId', + ], + 'required' => false, + 'example' => 'yourTaskId', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'yourChannelId', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-01T17:36:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-02T17:36:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b****', + ], + 'TotalNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RecordFiles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-01T17:36:00Z', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-10-02T17:36:00Z', + ], + 'AppId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'yourAppId', + ], + 'ChannelId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'yourChannelId', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://rtc-demo.oss-cn-****.aliyuncs.com/record/10-15-1/****/record-002_yourTaskId/example.m3u8', + ], + 'Duration' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '1800', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'yourTaskId', + ], + 'StopTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-02T17:36:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalPage\\": 1,\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b****\\",\\n \\"TotalNum\\": 1,\\n \\"RecordFiles\\": [\\n {\\n \\"StartTime\\": \\"2020-11-01T17:36:00Z\\",\\n \\"CreateTime\\": \\"2020-10-02T17:36:00Z\\",\\n \\"AppId\\": \\"yourAppId\\",\\n \\"ChannelId\\": \\"yourChannelId\\",\\n \\"Url\\": \\"http://rtc-demo.oss-cn-****.aliyuncs.com/record/10-15-1/****/record-002_yourTaskId/example.m3u8\\",\\n \\"Duration\\": 1800,\\n \\"TaskId\\": \\"yourTaskId\\",\\n \\"StopTime\\": \\"2020-11-02T17:36:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeRecordFilesResponse>\\r\\n<TotalNum>3</TotalNum>\\r\\n\\t<RequestId>AB2D3461-2F88-43DC-B60F-2F4C9BDB6522</RequestId>\\r\\n\\t<TotalPage>1</TotalPage>\\r\\n\\t<RecordFiles>\\r\\n\\t\\t<TaskId>yourTaskId</TaskId>\\r\\n\\t\\t<AppId>9qb1zcyc</AppId>\\r\\n\\t\\t<CreateTime>2020-11-17T05:08:12Z</CreateTime>\\r\\n\\t\\t<StartTime>2020-11-17T04:40:28Z</StartTime>\\r\\n\\t\\t<Duration>1482.29</Duration>\\r\\n\\t\\t<ChannelId>record-002</ChannelId>\\r\\n\\t\\t<Url>http://rtc-demo.oss-cn-****.aliyuncs.com/record/10-15-1/****/record-002_yourTaskId/2020-11-17-12-40-28_2020-11-17-13-05-10.m3u8</Url>\\r\\n\\t\\t<StopTime>2020-11-17T05:05:11Z</StopTime>\\r\\n\\t</RecordFiles>\\r\\n\\t<RecordFiles>\\r\\n\\t\\t<TaskId>yourTaskId</TaskId>\\r\\n\\t\\t<AppId>9qb1zcyc</AppId>\\r\\n\\t\\t<CreateTime>2020-11-17T04:40:37Z</CreateTime>\\r\\n\\t\\t<StartTime>2020-11-17T04:10:27Z</StartTime>\\r\\n\\t\\t<Duration>1800.01</Duration>\\r\\n\\t\\t<ChannelId>record-002</ChannelId>\\r\\n\\t\\t<Url>http://rtc-demo.oss-cn-****.aliyuncs.com/record/10-15-1/****/record-002_yourTaskId/2020-11-17-12-10-28_2020-11-17-12-40-28.m3u8</Url>\\r\\n\\t\\t<StopTime>2020-11-17T04:40:28Z</StopTime>\\r\\n\\t</RecordFiles>\\r\\n\\t<RecordFiles>\\r\\n\\t\\t<TaskId>yourTaskId</TaskId>\\r\\n\\t\\t<AppId>9qb1zcyc</AppId>\\r\\n\\t\\t<CreateTime>2020-11-17T04:10:34Z</CreateTime>\\r\\n\\t\\t<StartTime>2020-11-17T03:40:28Z</StartTime>\\r\\n\\t\\t<Duration>1799.95</Duration>\\r\\n\\t\\t<ChannelId>record-002</ChannelId>\\r\\n\\t\\t<Url>http://rtc-demo.oss-cn-****.aliyuncs.com/record/10-15-1/****/record-002_yourTaskId/2020-11-17-11-40-28_2020-11-17-12-10-28.m3u8</Url>\\r\\n\\t\\t<StopTime>2020-11-17T04:10:28Z</StopTime>\\r\\n\\t</RecordFiles>\\r\\n </DescribeRecordFilesResponse>","errorExample":""}]', + 'title' => 'DescribeRecordFiles', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'StartMPUTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'SubSpecUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'userID', + ], + 'required' => false, + 'example' => 'userID', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'SubSpecAudioUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'audioUserID', + ], + 'required' => false, + 'example' => 'audioUserID', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'SubSpecShareScreenUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'videoUserID', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'SubSpecCameraUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cameraUserID', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UnsubSpecAudioUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'audioUserID2', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UnsubSpecShareScreenUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'videoUserID2', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UnsubSpecCameraUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cameraUserID2', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'LayoutIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'example' => '1', + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UserPanes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Images' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + 'SegmentType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'UserId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'TestId', + ], + 'Texts' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FontType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'FontColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Text' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'FontSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'BorderWidth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '1', + ], + 'BorderColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + 'Box' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'BoxColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + 'BoxBorderWidth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + 'Alpha' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + ], + 'PaneId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'Backgrounds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'Watermarks', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Alpha' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ClockWidgets', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FontType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'FontColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'FontSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'BorderWidth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '1', + ], + 'BorderColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + 'Box' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'BoxColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + 'BoxBorderWidth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + 'Alpha' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'yourChannelId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'yourTaskId', + ], + ], + [ + 'name' => 'MixMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'CropMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MediaEncode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'BackgroundColor', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'StreamURL', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'rtmp://example.com/live/stream', + ], + ], + [ + 'name' => 'PayloadType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ReportVad', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RtpExtInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'TimeStampRef', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '15273582735', + ], + ], + [ + 'name' => 'VadInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '86400', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'EnhancedParam', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EnablePortraitSegmentation' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'TaskExisted', + 'errorMessage' => 'the task is existed', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidParameter.Format', + 'errorMessage' => 'The mediaEncode is illegal:%s.', + ], + [ + 'errorCode' => 'IllegalBackgroundColor', + 'errorMessage' => 'strconv background_color', + ], + [ + 'errorCode' => 'InvalidLayoutID.Malformed', + 'errorMessage' => 'Failed to parse layout ID.', + ], + [ + 'errorCode' => 'InvalidAppID.AliveTaskExceedLimit', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidLiveURL', + 'errorMessage' => 'InvalidLiveURL.%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.%s', + ], + [ + 'errorCode' => 'InternalError.', + 'errorMessage' => 'InternalError.%s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<StartMPUTaskResponse>\\r\\n\\t<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\r\\n</StartMPUTaskResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopMPUTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourTaskId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<StopMPUTaskResponse>\\n\\t<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n</StopMPUTaskResponse>\\n\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\", \\n}"}]', + 'title' => 'StopMPUTask', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateMPUTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'LayoutIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'SubSpecUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'userID', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'SubSpecAudioUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'audioUserID', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'SubSpecShareScreenUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'videoUserID', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'SubSpecCameraUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cameraUserID', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UnsubSpecAudioUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'audioUserID2', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UnsubSpecShareScreenUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'videoUserID2', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UnsubSpecCameraUsers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cameraUserID2', + ], + 'required' => false, + 'maxItems' => 64, + ], + ], + [ + 'name' => 'UserPanes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Images' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + 'SegmentType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'UserId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'TestUserID', + ], + 'Texts' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FontType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'FontColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Text' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'FontSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'BorderWidth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '1', + ], + 'BorderColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + 'Box' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'BoxColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + 'BoxBorderWidth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + 'Alpha' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + ], + 'PaneId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'Backgrounds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'Watermarks', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Alpha' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.example.com/image.jpg', + ], + 'Display' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ClockWidgets', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FontType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'FontColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'FontSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'BorderWidth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '1', + ], + 'BorderColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'Box' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'BoxColor' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + 'BoxBorderWidth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + 'Alpha' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'minimum' => '0', + 'example' => '0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testId', + ], + ], + [ + 'name' => 'CropMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MediaEncode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'MixMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'BackgroundColor', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalBackgroundColor', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidLayoutID.Malformed', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateMPUTaskResponse>\\n <RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n</UpdateMPUTaskResponse>","errorExample":""}]', + ], + 'GetMPUTaskStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourTaskId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTask.IDError', + 'errorMessage' => 'taskid is invalid', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidTask.NotFound', + 'errorMessage' => 'no such task', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": 0,\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<GetMPUTaskStatusResponse>\\n\\t<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n\\t<Status>0</Status>\\n</GetMPUTaskStatusResponse>\\n\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\", \\n \\"Status\\":0\\n} "}]', + 'title' => 'GetMPUTaskStatus', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateMPULayout' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Panes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MajorPane' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.25', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.25', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.25', + ], + 'PaneId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.25', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'LayoutName', + ], + ], + [ + 'name' => 'AudioMixCount', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LayoutId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCropMode.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidAudioMixCount.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidPane.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IllegalAliUId', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LayoutId\\": 2,\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateMPULayoutResponse>\\n<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n<LayoutId>2</LayoutId>\\n</CreateMPULayoutResponse>\\n","errorExample":""}]', + 'title' => 'CreateMPULayout', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteMPULayout' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'LayoutId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalLayoutID', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ErrorNoSuchLayout', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteMPULayoutResponse>\\r\\n<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\r\\n</DeleteMPULayoutResponse>\\r\\n","errorExample":""}]', + 'title' => 'DeleteMPULayout', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyMPULayout' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Panes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MajorPane' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + 'PaneId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7576', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'LayoutName', + ], + ], + [ + 'name' => 'LayoutId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10117', + ], + ], + [ + 'name' => 'AudioMixCount', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalAliUId', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidCropMode.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidAudioMixCount.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidPane.Malformed', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyMPULayoutResponse>\\r\\n<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\r\\n</ModifyMPULayoutResponse>","errorExample":""}]', + 'title' => 'ModifyMPULayout', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMPULayoutInfoList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'LayoutId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '2', + 'default' => '0', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'LayoutName', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + 'TotalNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Layouts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Layout' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LayoutId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'LayoutName', + ], + 'AudioMixCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Panes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Panes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MajorPane' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Width' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'Height' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'Y' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'PaneId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ZOrder' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'X' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalLayoutID', + 'errorMessage' => '%s', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidLayout.NotFound', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalPage\\": 1,\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\",\\n \\"TotalNum\\": 1,\\n \\"Layouts\\": {\\n \\"Layout\\": [\\n {\\n \\"LayoutId\\": 2,\\n \\"Name\\": \\"LayoutName\\",\\n \\"AudioMixCount\\": 3,\\n \\"Panes\\": {\\n \\"Panes\\": [\\n {\\n \\"MajorPane\\": 0,\\n \\"Width\\": 0.5,\\n \\"Height\\": 0.5,\\n \\"Y\\": 0.5,\\n \\"PaneId\\": 0,\\n \\"ZOrder\\": 0,\\n \\"X\\": 0.5\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMPULayoutInfoListResponse>\\n<TotalNum>1</TotalNum>\\n<TotalPage>1</TotalPage>\\n<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n<Layouts>\\n <AudioMixCount>3</AudioMixCount>\\n <LayoutId>2</LayoutId>\\n <Name>LayoutName</Name>\\n <Panes>\\n <MajorPane>0</MajorPane>\\n <ZOrder>0</ZOrder>\\n <X>0.5</X>\\n <Y>0.5</Y>\\n <Height>0.5</Height>\\n <Width>0.5</Width>\\n <PaneId>0</PaneId>\\n </Panes>\\n</Layouts>\\n</DescribeMPULayoutInfoListResponse>","errorExample":""}]', + 'title' => 'DescribeMPULayoutInfoList', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRtcDurationData' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-04T05:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-04T07:00:00Z', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'ServiceArea', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + 'enum' => [ + '86400', + '3600', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'DurationDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DurationModule' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContentDuration' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'V720Duration' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'V360Duration' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'AudioDuration' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'TimeStamp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-02-04T05:00:00Z', + ], + 'V1080Duration' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'TotalDuration' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"DurationDataPerInterval\\": {\\n \\"DurationModule\\": [\\n {\\n \\"ContentDuration\\": 200,\\n \\"V720Duration\\": 200,\\n \\"V360Duration\\": 300,\\n \\"AudioDuration\\": 200,\\n \\"TimeStamp\\": \\"2020-02-04T05:00:00Z\\",\\n \\"V1080Duration\\": 300,\\n \\"TotalDuration\\": 1000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRtcDurationDataResponse>\\n<RequestId>8D49CBEB-84E5-4847-AD5E-1EE4B235034E</RequestId>\\n<DurationDataPerInterval>\\n <DurationModule>\\n <ContentDuration>0</ContentDuration>\\n <V360Duration>0</V360Duration>\\n <V720Duration>0</V720Duration>\\n <V1080Duration>0</V1080Duration>\\n <TimeStamp>2020-02-04T05:00:00Z</TimeStamp>\\n <TotalDuration>0</TotalDuration>\\n <AudioDuration>0</AudioDuration>\\n </DurationModule>\\n <DurationModule>\\n <ContentDuration>0</ContentDuration>\\n <V360Duration>0</V360Duration>\\n <V720Duration>0</V720Duration>\\n <V1080Duration>0</V1080Duration>\\n <TimeStamp>2020-02-04T06:00:00Z</TimeStamp>\\n <TotalDuration>0</TotalDuration>\\n <AudioDuration>0</AudioDuration>\\n </DurationModule>\\n</DurationDataPerInterval>\\n</DescribeRtcDurationDataResponse>\\n","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"DurationDataPerInterval\\": [\\n {\\n \\"TimeStamp\\": \\"2018-01-29T00:00:00Z\\",\\n \\"TotalDuration\\": 1000,\\n \\"AudioDuration\\": 200, \\n \\"V360Duration\\": 300,\\n \\"V720Duration\\": 300,\\n \\"V1080Duration\\": 300,\\n \\"ContentDuration\\": 200\\n }\\n ]\\n}"}]', + 'title' => 'DescribeRtcDurationData', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRtcUserCntData' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2018-01-29T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2018-01-29T01:00:00Z', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'ServiceArea', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + 'enum' => [ + '86400', + '3600', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'UserCntDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UserCntModule' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ActiveUserCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TimeStamp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2018-01-29T00:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"UserCntDataPerInterval\\": {\\n \\"UserCntModule\\": [\\n {\\n \\"ActiveUserCnt\\": 10,\\n \\"TimeStamp\\": \\"2018-01-29T00:00:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRtcUserCntDataResponse>\\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n<UserCntDataPerInterval>\\n <UserCntModule>\\n <TimeStamp>2018-01-29T00:00:00Z</TimeStamp>\\n <ActiveUserCnt>10</ActiveUserCnt>\\n </UserCntModule>\\n</UserCntDataPerInterval>\\n</DescribeRtcUserCntDataResponse>","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"UserCntDataPerInterval\\": [ \\n { \\n \\"TimeStamp\\": \\"2018-01-29T00:00:00Z\\",\\n \\"ActiveUserCnt\\": 10\\n }\\n ]\\n}"}]', + 'title' => 'DescribeRtcUserCntData', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRtcPeakChannelCntData' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2018-01-29T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2018-01-29T00:00:00Z', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'ServiceArea', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + 'enum' => [ + '86400', + '3600', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'PeakChannelCntDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PeakChannelCntModule' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ActiveChannelPeakTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2018-01-29T00:01:00Z', + ], + 'TimeStamp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2018-01-29T00:00:00Z', + ], + 'ActiveChannelPeak' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"PeakChannelCntDataPerInterval\\": {\\n \\"PeakChannelCntModule\\": [\\n {\\n \\"ActiveChannelPeakTime\\": \\"2018-01-29T00:01:00Z\\",\\n \\"TimeStamp\\": \\"2018-01-29T00:00:00Z\\",\\n \\"ActiveChannelPeak\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRtcPeakChannelCntDataResesponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n\\t<PeakChannelCntDataPerInterval>\\n\\t\\t<TimeStamp>2018-01-29T00:00:00Z</TimeStamp>\\n\\t\\t<ActiveChannelPeak>10</ActiveChannelPeak>\\n\\t\\t<ActiveChannelPeakTime>2018-01-29T00:01:00Z</ActiveChannelPeakTime>\\n\\t</PeakChannelCntDataPerInterval>\\n</DescribeRtcPeakChannelCntDataResesponse>\\n\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"PeakChannelCntDataPerInterval\\": [ \\n { \\n \\"TimeStamp\\": \\"2018-01-29T00:00:00Z\\",\\n \\"ActiveChannelPeak\\": 10,\\n \\"ActiveChannelPeakTime\\": \\"2018-01-29T00:01:00Z\\"\\n }\\n ]\\n} "}]', + 'title' => 'DescribeRtcPeakChannelCntData', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRtcChannelList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aoe****', + ], + ], + [ + 'name' => 'TimePoint', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2018-01-29T00:00:00Z', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'enum' => [ + 'sortByStartTime', + 'sortByStartTimeDesc', + 'sortByEndTime', + 'sortByEndTimeDesc', + ], + ], + ], + [ + 'name' => 'ServiceArea', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'testUser', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'testChannel', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ChannelList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ChannelList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'testChannel', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2018-01-29T02:00:00Z', + ], + 'TotalUserCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2018-01-29T01:00:00Z', + ], + 'CallArea' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CallArea' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCnt\\": 1000,\\n \\"PageNo\\": 1,\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"PageSize\\": 100,\\n \\"ChannelList\\": {\\n \\"ChannelList\\": [\\n {\\n \\"ChannelId\\": \\"testChannel\\",\\n \\"EndTime\\": \\"2018-01-29T02:00:00Z\\",\\n \\"TotalUserCnt\\": 2,\\n \\"StartTime\\": \\"2018-01-29T01:00:00Z\\",\\n \\"CallArea\\": {\\n \\"CallArea\\": [\\n \\"cn\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRtcChannelListResponse>\\n<PageSize>1</PageSize>\\n<RequestId>68F57D4C-557B-44FB-A0B7-D002E153555E</RequestId>\\n<TotalCnt>24</TotalCnt>\\n<PageNo>1</PageNo>\\n<ChannelList>\\n <ChannelList>\\n <TotalUserCnt>2</TotalUserCnt>\\n <EndTime>2020-04-14T13:09:00+08:00</EndTime>\\n <StartTime>2020-04-14T13:08:00+08:00</StartTime>\\n <ChannelId>testChannel</ChannelId>\\n <CallArea>\\n <CallArea>cn</CallArea>\\n </CallArea>\\n </ChannelList>\\n</ChannelList>\\n</DescribeRtcChannelListResponse>","errorExample":""}]', + 'title' => 'DescribeRtcChannelList', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRtcChannelMetric' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TimePoint', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2018-01-29T00:00:00Z', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'aoe****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'ChannelMetricInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ChannelMetric' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2019-06-06T18:57:00Z', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2019-06-06T17:57:00Z', + ], + 'SubUserCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + 'ChannelId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'example_channel', + ], + 'UserCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PubUserCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'Duration' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PubDuration' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Video720' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Video360' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Content' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Audio' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Video1080' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + 'SubDuration' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Video720' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Video360' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Content' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Audio' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Video1080' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"ChannelMetricInfo\\": {\\n \\"ChannelMetric\\": {\\n \\"EndTime\\": \\"2019-06-06T18:57:00Z\\",\\n \\"StartTime\\": \\"2019-06-06T17:57:00Z\\",\\n \\"SubUserCount\\": 25,\\n \\"ChannelId\\": \\"example_channel\\",\\n \\"UserCount\\": 30,\\n \\"PubUserCount\\": 10\\n },\\n \\"Duration\\": {\\n \\"PubDuration\\": {\\n \\"Video720\\": 100,\\n \\"Video360\\": 100,\\n \\"Content\\": 100,\\n \\"Audio\\": 100,\\n \\"Video1080\\": 100\\n },\\n \\"SubDuration\\": {\\n \\"Video720\\": 100,\\n \\"Video360\\": 100,\\n \\"Content\\": 100,\\n \\"Audio\\": 100,\\n \\"Video1080\\": 100\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRtcChannelMetricResponse>\\n<RequestId>F7748E0F-1FC6-4410-9799-19757EF3C837</RequestId>\\n<ChannelMetricInfo>\\n <ChannelMetric>\\n <EndTime>2020-04-14T14:04:00+08:00</EndTime>\\n <UserCount>2</UserCount>\\n <StartTime>2020-04-14T14:04:00+08:00</StartTime>\\n <SubUserCount>2</SubUserCount>\\n <ChannelId>example_channel</ChannelId>\\n <PubUserCount>2</PubUserCount>\\n </ChannelMetric>\\n <Duration>\\n <SubDuration>\\n <Video720>2</Video720>\\n <Video1080>0</Video1080>\\n <Content>0</Content>\\n <Video360>0</Video360>\\n <Audio>0</Audio>\\n </SubDuration>\\n <PubDuration>\\n <Video720>2</Video720>\\n <Video1080>0</Video1080>\\n <Content>0</Content>\\n <Video360>0</Video360>\\n <Audio>2</Audio>\\n </PubDuration>\\n </Duration>\\n</ChannelMetricInfo>\\n</DescribeRtcChannelMetricResponse>\\n","errorExample":""}]', + 'title' => 'DescribeRtcChannelMetric', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-northeast-2-pop', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-pop', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-gov-1', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-nu16-b01', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-edge-1', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fujian', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-haidian-cm12-c01', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-bj-b01', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-prod-1', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-1', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-2', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-3', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-test-306', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong-finance-pop', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao-nebula', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et15-b01', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et2-b01', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-inner', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-internal-test-1', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-inner', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-st4-d01', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-su18-b01', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-yushanfang', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei-na61-b01', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou-na62-a01', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-nebula-1', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1-oxs', + 'endpoint' => 'rtc.aliyuncs.com', + ], + [ + 'regionId' => 'rus-west-1-pop', + 'endpoint' => 'rtc.aliyuncs.com', + ], + ], +]; |