'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'rtc', 'version' => '2018-01-11', ], 'directories' => [ [ 'id' => 122646, 'title' => '应用管理', 'type' => 'directory', 'children' => [ 'ModifyApp', 'DescribeApps', 'DescribeAppKey', ], ], [ 'id' => 194657, 'title' => '布局', 'type' => 'directory', 'children' => [ 'CreateAppLayout', 'ModifyAppLayout', 'DeleteAppLayout', 'DescribeAppLayouts', 'DescribeSystemLayoutList', ], ], [ 'id' => 194660, 'title' => '回调管理', 'type' => 'directory', 'children' => [ 'DescribeAppCallStatus', 'ModifyAppCallbackStatus', 'DescribeAllCallback', 'DescribeCallbacks', 'DescribeAppCallbackSecretKey', 'ModifyCallbackMeta', 'StartCategoryCallback', 'StopCategoryCallback', ], ], [ 'id' => 189626, 'title' => '频道管理', 'type' => 'directory', 'children' => [ 'DescribeChannels', 'StopChannel', 'DescribeChannelAllUsers', 'DescribeChannelUser', 'DescribeChannel', 'RemoveUsers', ], ], [ 'id' => 189635, 'title' => '云端录制', 'type' => 'directory', 'children' => [ [ 'id' => 194671, 'title' => '录制模板管理', 'type' => 'directory', 'children' => [ 'DescribeAppRecordStatus', 'ModifyAppRecordStatus', 'CreateAppRecordTemplate', 'ModifyAppRecordTemplate', 'DeleteAppRecordTemplate', 'DescribeAppRecordTemplates', ], ], [ 'id' => 199232, 'title' => '云端录制接口', 'type' => 'directory', 'children' => [ 'DescribeCloudRecordStatus', 'DescribeAppRecordingFiles', 'StartCloudRecord', 'UpdateCloudRecord', 'StopCloudRecord', ], ], ], ], [ 'id' => 189637, 'title' => '旁路推流', 'type' => 'directory', 'children' => [ [ 'id' => 188586, 'title' => '推流模板管理', 'type' => 'directory', 'children' => [ 'DescribeAppLiveStreamStatus', 'ModifyAppLiveStreamStatus', 'CreateAppStreamingOutTemplate', 'ModifyAppStreamingOutTemplate', 'DeleteAppStreamingOutTemplate', 'DescribeAppStreamingOutTemplates', ], ], [ 'id' => 199233, 'title' => '旁路推流接口', 'type' => 'directory', 'children' => [ 'DescribeStreamingOutStatus', 'StartStreamingOut', 'UpdateStreamingOut', 'StopStreamingOut', ], ], ], ], [ 'id' => 199894, 'title' => '纪要', 'type' => 'directory', 'children' => [ [ 'id' => 208922, 'title' => '热词表', 'type' => 'directory', 'children' => [ 'CreateCloudNotePhrases', 'ModifyCloudNotePhrases', 'DescribeCloudNotePhrases', 'DeleteCloudNotePhrases', ], ], 'StartCloudNote', 'StartCloudNote', 'StopCloudNote', 'DescribeCloudNotes', ], ], [ 'id' => 223803, 'title' => '智能体', 'type' => 'directory', 'children' => [ [ 'id' => 223804, 'title' => '智能体模版管理', 'type' => 'directory', 'children' => [ 'DescribeAppAgentFunctionStatus', 'ModifyAppAgentFunctionStatus', 'ModifyAppAgentTemplate', 'DescribeAppAgentTemplates', 'DeleteAppAgentTemplate', 'CreateAppAgentTemplate', ], ], [ 'id' => 223819, 'title' => '智能体接口', 'type' => 'directory', 'children' => [ 'StartAgent', 'GetAgent', 'UpdateAgent', 'NotifyAgent', 'StopAgent', ], ], ], ], [ 'id' => 248556, 'title' => 'SIP', 'type' => 'directory', 'children' => [ [ 'id' => 309819, 'title' => '合流模版管理', 'type' => 'directory', 'children' => [ 'DescribeAppViewStatus', 'ModifyAppViewStatus', 'CreateAppViewTemplate', 'ModifyAppViewTemplate', 'DescribeAppViewTemplates', 'DeleteAppViewTemplate', ], ], [ 'id' => 321878, 'title' => '任务接口', 'type' => 'directory', 'children' => [ 'RtcSipInviteMember', 'RtcCancelSipInvite', 'StartView', 'StopView', 'RtcSipMute', 'ModifyViewLayout', 'ModifyStreamingProperty', ], ], ], ], [ 'id' => 188246, 'title' => '数据服务', 'type' => 'directory', 'children' => [ [ 'id' => 188247, 'title' => '通信监测', 'type' => 'directory', 'children' => [ 'DescribeCallList', 'DescribeCall', 'DescribePubUserListBySubUser', 'DescribeEndPointEventList', 'DescribeEndPointMetricData', 'DescribeQoeMetricData', ], ], [ 'id' => 188544, 'title' => '频道数据', 'type' => 'directory', 'children' => [ 'DescribeChannelOverallData', 'DescribeChannelDistributionStatData', 'DescribeChannelAreaDistributionStatData', 'DescribeChannelTopPubUserList', 'DescribeChannelUserMetrics', ], ], [ 'id' => 188550, 'title' => '用量统计', 'type' => 'directory', 'children' => [ 'DescribeUsageOverallData', 'DescribeUsageDistributionStatData', 'DescribeUsageAreaDistributionStatData', 'DescribeUsageOsSdkVersionDistributionStatData', ], ], [ 'id' => 188555, 'title' => '质量统计', 'type' => 'directory', 'children' => [ 'DescribeQualityOverallData', 'DescribeQualityDistributionStatData', 'DescribeQualityAreaDistributionStatData', 'DescribeQualityOsSdkVersionDistributionStatData', ], ], [ 'id' => 188536, 'title' => '异常诊断', 'type' => 'directory', 'children' => [ 'DescribeFaultDiagnosisOverallData', 'DescribeFaultDiagnosisFactorDistributionStat', 'DescribeFaultDiagnosisUserList', 'DescribeFaultDiagnosisUserDetail', ], ], ], ], [ 'id' => 190479, 'title' => 'RTC（旧版）', 'type' => 'directory', 'children' => [ [ 'id' => 122624, 'title' => '事件回调（旧版)', 'type' => 'directory', 'children' => [ 'CreateEventSubscribe', 'DeleteEventSubscribe', ], ], [ 'id' => 122600, 'title' => '自动旁路单路转推规则（旧版）', 'type' => 'directory', 'children' => [ 'CreateAutoLiveStreamRule', 'DeleteAutoLiveStreamRule', 'DisableAutoLiveStreamRule', 'EnableAutoLiveStreamRule', 'UpdateAutoLiveStreamRule', 'DescribeAutoLiveStreamRule', ], ], [ 'id' => 122656, 'title' => '频道管理（旧版）', 'type' => 'directory', 'children' => [ 'DeleteChannel', 'DescribeChannelParticipants', 'DescribeUserInfoInChannel', 'DescribeChannelUsers', 'RemoveTerminals', ], ], [ 'id' => 122762, 'title' => '云端录制（旧版）', 'type' => 'directory', 'children' => [ 'AddRecordTemplate', 'DeleteRecordTemplate', 'UpdateRecordTemplate', 'StartRecordTask', 'StopRecordTask', 'UpdateRecordTask', 'DescribeRecordTemplates', 'DescribeRecordFiles', ], ], [ 'id' => 122730, 'title' => '旁路转推（旧版）', 'type' => 'directory', 'children' => [ 'StartMPUTask', 'StopMPUTask', 'UpdateMPUTask', 'GetMPUTaskStatus', ], ], [ 'id' => 122750, 'title' => '布局管理（旧版）', 'type' => 'directory', 'children' => [ 'CreateMPULayout', 'DeleteMPULayout', 'ModifyMPULayout', 'DescribeMPULayoutInfoList', ], ], [ 'id' => 122702, 'title' => '数据服务（旧版）', 'type' => 'directory', 'children' => [ 'DescribeRtcDurationData', 'DescribeRtcUserCntData', 'DescribeRtcPeakChannelCntData', 'DescribeRtcChannelList', 'DescribeRtcChannelMetric', ], ], ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'ModifyApp' => [ 'summary' => '调用ModifyApp修改指定应用的名称。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', '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' => '请求ID。', '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":"\\n16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\n","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"AppId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880exxxx\\"\\n}"}]', 'title' => '修改指定应用名称', 'description' => '#### 使用说明'."\n" .'本接口用于修改指定应用的名称。'."\n" .'#### QPS限制'."\n" .'本接口的单用户QPS限制为200次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeApps' => [ 'summary' => '调用DescribeApps查询应用列表。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。'."\n" ."\n" .'参数为空表示查询所有应用ID。', 'type' => 'string', 'required' => false, 'example' => 'yourAppId', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '应用状态，参数为空表示查询所有状态。取值：'."\n" .'- **1**：可用。'."\n" ."\n" .'- **2**：停用。'."\n" ."\n" .'- **3**：欠费停用。', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'description' => '排序方式。取值：'."\n" ."\n" .'- **asc**：递增。'."\n" .' '."\n" .'- **desc**（默认值）：递减。', 'type' => 'string', 'required' => false, 'example' => 'asc', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几页，默认查询第**1**页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页显示个数，默认为**10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '2', ], ], [ 'name' => 'AppVersion', 'in' => 'query', 'schema' => [ 'title' => '应用版本。', 'description' => '应用版本。', 'type' => 'string', 'required' => false, 'example' => '3.0', 'enum' => [ '2.0', '3.0', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalPage' => [ 'description' => '返回分页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => '请求id。', 'type' => 'string', 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C6', ], 'TotalNum' => [ 'description' => '返回结果数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AppList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'App' => [ 'description' => '应用列表。', 'type' => 'array', 'items' => [ 'description' => '应用', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '应用状态。取值：'."\n" .'- **1**：可用。 '."\n" .' '."\n" .'- **2**：停用。'."\n" ."\n" .'- **3**：欠费停用。 ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AppName' => [ 'description' => '应用名称。', 'type' => 'string', 'example' => 'Default AppName', ], 'AppId' => [ 'description' => '应用ID。', 'type' => 'string', 'example' => 'rgf1****"', ], 'CreateTime' => [ 'description' => '创建时间', 'type' => 'string', 'example' => '2020-01-09T02:02:29Z', ], 'BillType' => [ 'description' => '计费类型。', 'type' => 'string', 'example' => 'PayByCR', ], 'AppType' => [ 'description' => '应用类型。取值：'."\n" ."\n" .'- **conference**：会议。'."\n" ."\n" .'- **universal**：通用型。 ', 'type' => 'string', 'example' => 'universal', ], 'ServiceAreas' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ServiceArea' => [ 'description' => '服务区域：CN（中国）。', 'type' => 'array', 'items' => [ 'description' => '服务区域：CN（中国）。', 'type' => 'string', 'example' => 'CN', ], ], ], ], 'Version' => [ 'description' => '版本。', 'type' => 'string', 'example' => '3.0', ], ], ], ], ], ], ], ], ], ], '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' => '查询应用列表', 'description' => '### 使用说明'."\n" .'本接口用于查询应用列表。例如：在查询列表中您可以获取应用ID、应用名称、应用类型等数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为200次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeAppKey' => [ 'summary' => '调用DescribeAppKey查询指定应用的AppKey。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => '0cho****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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":"\\n 154EF5DE-3D08-1F2C-A482-281F78D74B7C\\n ba133b2cee4ab9be424674892c33****\\n","errorExample":""}]', 'title' => '查询指定应用AppKey', 'description' => '### 使用说明'."\n" .'调用本接口前，您必须已经在RTC控制台创建了应用。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为200次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '0', 'example' => '0', 'default' => '0', ], 'X' => [ 'title' => '坐标X，归一化百分比。坐标X取值范围：0.0≤X≤1.0。', 'description' => '坐标X，归一化百分比。坐标X取值范围：0.0≤X≤1.0。', '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' => '坐标Y，归一化百分比。坐标Y取值范围：0.0≤Y≤1.0。', 'type' => 'number', 'format' => 'double', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'example' => '0.25', 'default' => '0.25', ], 'Height' => [ 'title' => '窗格高，归一化百分比。Height取值范围：0.0 '窗格高，归一化百分比。Height取值范围：0.0 'number', 'format' => 'double', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'example' => '0.25', 'default' => '0.25', ], 'Width' => [ 'title' => '窗格宽，归一化百分比。Width取值范围：0.0 '窗格宽，归一化百分比。Width取值范围：0.0 'number', 'format' => 'double', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'example' => '0.25', 'default' => '0.25', ], 'PaneId' => [ 'title' => '窗格ID，从0开始。', 'description' => '窗格ID，从0开始。', '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' => '布局ID。', '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"}]', 'title' => '新增自定义布局', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '0', 'example' => '0', 'default' => '0', ], 'X' => [ 'title' => '坐标X，归一化百分比。坐标X取值范围：0.0≤X≤1.0。', 'description' => '坐标X，归一化百分比。坐标X取值范围：0.0≤X≤1.0。', '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' => '坐标Y，归一化百分比。坐标Y取值范围：0.0≤Y≤1.0。', 'type' => 'number', 'format' => 'double', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'example' => '0.25', 'default' => '0.25', ], 'Height' => [ 'title' => '窗格高，归一化百分比。Height取值范围：0.0 '窗格高，归一化百分比。Height取值范围：0.0 'number', 'format' => 'double', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'example' => '0.25', 'default' => '0.25', ], 'Width' => [ 'title' => '窗格宽，归一化百分比。Width取值范围：0.0 '窗格宽，归一化百分比。Width取值范围：0.0 'number', 'format' => 'double', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'example' => '0.25', 'default' => '0.25', ], 'PaneId' => [ 'title' => '窗格ID，从0开始。', 'description' => '窗格ID，从0开始。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '15', 'minimum' => '0', 'example' => '0', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 16, 'minItems' => 1, ], 'LayoutId' => [ 'title' => '布局ID。', 'description' => '布局ID。', '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' => '布局ID。', '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"}]', 'title' => '修改自定义布局', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'ac7N****', ], ], [ 'name' => 'Layout', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '布局信息。', 'description' => '布局信息。', 'type' => 'object', 'properties' => [ 'LayoutId' => [ 'title' => '布局ID', 'description' => '布局ID', '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"}]', 'title' => '删除自定义布局', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeAppLayouts' => [ 'summary' => '查询app自定义布局', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'description' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'ac7N****', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'title' => '页码，默认1。', 'description' => '页码，默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页数量，默认10。', 'description' => '每页数量，默认10。', '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' => '布局ID。', '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' => '本次请求的ID。', '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' => '布局ID。', '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取值范围：0.0 'number', 'format' => 'float', 'example' => '0.25', ], 'Height' => [ 'title' => '窗格高，归一化百分比。Height取值范围：0.0 '窗格高，归一化百分比。Height取值范围：0.0 'number', 'format' => 'float', 'example' => '0.25', ], 'Y' => [ 'title' => '坐标Y，归一化百分比。坐标Y取值范围：0.0≤Y≤1.0。', 'description' => '坐标Y，归一化百分比。坐标Y取值范围：0.0≤Y≤1.0。', 'type' => 'number', 'format' => 'float', 'example' => '0.25', ], 'PaneId' => [ 'title' => '窗格ID', 'description' => '窗格ID', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ZOrder' => [ 'title' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'X' => [ 'title' => '坐标X，归一化百分比。坐标X取值范围：0.0≤X≤1.0。', 'description' => '坐标X，归一化百分比。坐标X取值范围：0.0≤X≤1.0。', '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"}]', 'title' => '查询自定义布局列表', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '请求ID。', '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' => '布局ID。', '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取值范围：0.0 'number', 'format' => 'float', 'example' => '0.25', ], 'Height' => [ 'title' => '窗格高，归一化百分比。Height取值范围：0.0 '窗格高，归一化百分比。Height取值范围：0.0 'number', 'format' => 'float', 'example' => '0.25', ], 'Y' => [ 'title' => '坐标Y，归一化百分比。坐标Y取值范围：0.0≤Y≤1.0。', 'description' => '坐标Y，归一化百分比。坐标Y取值范围：0.0≤Y≤1.0。', 'type' => 'number', 'format' => 'float', 'example' => '0.25', ], 'PaneId' => [ 'title' => '窗格ID。', 'description' => '窗格ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ZOrder' => [ 'title' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'X' => [ 'title' => '坐标X，归一化百分比。坐标X取值范围：0.0≤X≤1.0。', 'description' => '坐标X，归一化百分比。坐标X取值范围：0.0≤X≤1.0。', '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"}]', 'title' => '查询系统内置布局列表', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeAppCallStatus' => [ 'summary' => '查看app回调开关', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID。', 'description' => '应用ID。', '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' => '回调状态；enable-开启 disable-关闭。', '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"}]', 'title' => '查询应用回调状态', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'ModifyAppCallbackStatus' => [ 'summary' => '更新app回调事件开关', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID。', 'description' => '应用ID。', '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"}]', 'title' => '修改应用回调状态', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '事件Code。', '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' => '订阅事件类型：0-系统 1-自定义。', '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"}]', 'title' => '系统回调支持的所有事件', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeCallbacks' => [ 'summary' => 'app事件回调列表', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID。', 'description' => '应用ID。', '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' => '回调状态；0-启用 1-不启用。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => [], ], 'Category' => [ 'title' => '回调code。', 'description' => '回调code。', 'type' => 'string', 'example' => 'RecordEvent', ], 'Code' => [ 'title' => '回调验证code。', 'description' => '回调验证code。', 'type' => 'string', 'example' => 'RESPONSE_INVALID', ], 'Msg' => [ 'title' => '回调验证message。', 'description' => '回调验证message。', 'type' => 'string', 'example' => 'Success', ], 'CheckStatus' => [ 'title' => '回调验证状态：0-验证中 1-验证成功 2-验证失败。', 'description' => '回调验证状态：0-验证中 1-验证成功 2-验证失败。', 'type' => 'string', 'example' => '1', 'enum' => [], ], 'SubEvent' => [ 'title' => '子事件，具体可参考回调概述。'."\n" .'录制事件：'."\n" .'- **2010**：录制服务状态变化。'."\n" .'- **2011**：录制音频流状态变化。'."\n" .'- **2012**：录制视频流状态变化。', 'description' => '子事件，具体可参考回调概述。'."\n" .'录制事件：'."\n" .'- **2010**：录制服务状态变化。'."\n" .'- **2011**：录制音频流状态变化。'."\n" .'- **2012**：录制视频流状态变化。', '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"}]', 'title' => '查询应用回调列表', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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"}]', 'title' => '查询回调密钥', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'ModifyCallbackMeta' => [ 'summary' => '更新app回调', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID。', 'description' => '应用ID。', 'type' => 'string', 'required' => true, 'example' => '223***JQb', ], ], [ 'name' => 'Callback', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '回调配置', 'description' => '回调配置。', 'type' => 'object', 'properties' => [ 'Category' => [ 'title' => '回调code。', 'description' => '回调code。', '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' => '子事件。'."\n" .'录制事件：'."\n" .'- **2010**：录制服务状态变化。'."\n" .'- **2011**：录制音频流状态变化。'."\n" .'- **2012**：录制视频流状态变化。', 'type' => 'array', 'items' => [ 'title' => '具体订阅子事件code。', 'description' => '具体订阅子事件code。', '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"}]', 'title' => '修改应用回调', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'StartCategoryCallback' => [ 'summary' => '开启某个事件回调', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID。', 'description' => '应用ID。', 'type' => 'string', 'required' => true, 'example' => '223***JQb', ], ], [ 'name' => 'Callback', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '回调。', 'type' => 'object', 'properties' => [ 'Category' => [ 'title' => '回调code。', 'description' => '回调code。', '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"}]', 'title' => '开启某个事件回调', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'StopCategoryCallback' => [ 'summary' => '关闭某个事件回调', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID。', 'description' => '应用ID。', 'type' => 'string', 'required' => true, 'example' => '223***JQb', ], ], [ 'name' => 'Callback', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '回调。', 'type' => 'object', 'properties' => [ 'Category' => [ 'title' => '回调code。', 'description' => '回调code。', '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"}]', 'title' => '关闭某个事件回调', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeChannels' => [ 'summary' => '本接口用于查询单AppId下的全部进行中的频道列表。', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => 'AppID。', 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', 'maxLength' => 11, 'minLength' => 8, ], ], [ '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', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', ], 'PageNo' => [ 'title' => '页码。', 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', ], 'PageSize' => [ 'title' => '每页数量。', 'description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '10', 'default' => '10', ], 'TotalCnt' => [ 'title' => '总数。', 'description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Records' => [ 'title' => '在线频道列表。', 'description' => '在线频道列表。', 'type' => 'array', 'items' => [ 'title' => '具体的在线频道列表。', 'description' => '具体的在线频道列表。', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], '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"}]', 'title' => '查询在线频道列表', 'description' => '### 使用说明'."\n" .'本接口用于查询单AppId下的全部进行中的频道列表。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'StopChannel' => [ 'summary' => '本接口用于服务端主动关闭频道。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已存在的频道ID，仅支持传单个ID。', 'description' => '已存在的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', 'title' => '关闭频道', 'description' => '### 使用说明'."\n" .'本接口用于服务端主动关闭在线频道。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeChannelAllUsers' => [ 'summary' => '本接口用于查询频道内的用户列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '待查询的频道ID，仅支持传单个ID。', 'description' => '待查询的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', ], 'Users' => [ 'title' => '频道内在线的用户列表', 'description' => '频道内在线的用户列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => '1811****', ], ], ], ], 'ChannelExist' => [ 'title' => '频道是否存在，取值：'."\n" .'● true：存在。'."\n" .'● false：不存在。', 'description' => '频道是否存在。取值：'."\n" .'- **true**：存在。'."\n" .'- **false**：不存在。', '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"}]', 'title' => '查询频道内在线用户', 'description' => '### 使用说明'."\n" .'本接口用于查询在线频道内的用户列表。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeChannelUser' => [ 'summary' => '本接口用于查询用户在频道内的信息。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '待查询的频道ID，仅支持传单个ID。', 'description' => '待查询的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'required' => true, 'example' => '1811****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', ], 'InChannel' => [ 'title' => '用户当前是否在频道内，取值：'."\n" .'● true：在频道内。'."\n" .'● false：不在频道内。', 'description' => '用户当前是否在频道内。取值：'."\n" .'- **true**：在频道内。'."\n" .'- **false**：不在频道内。', 'type' => 'boolean', ], 'Sessions' => [ 'title' => '会话信息列表。', 'description' => '会话信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => '1811****', ], 'SessionId' => [ 'title' => '会话ID。', 'description' => '会话ID。', 'type' => 'string', 'example' => 'xa744sxx8rtobgj****', ], 'Joined' => [ 'title' => '用户进入频道的秒级时间戳（UTC时间）。', 'description' => '用户进入频道的秒级时间戳（UTC时间）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1557909133', ], ], ], ], 'ChannelExist' => [ 'title' => '频道是否存在，取值：'."\n" .'● true：存在。'."\n" .'● false：不存在。', 'description' => '频道是否存在。取值：'."\n" .'- **true**：存在。'."\n" .'- **false**：不存在。', '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"}]', 'title' => '查询用户在频道内的信息', 'description' => '### 使用说明'."\n" .'本接口用于查询用户在在线频道内的信息。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeChannel' => [ 'summary' => '本接口用于查询在线频道信息。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '待查询的频道ID，仅支持传单个ID。', 'description' => '待查询的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', ], 'Channel' => [ 'title' => 'channel', 'description' => '频道信息。', 'type' => 'object', 'properties' => [ 'StartTime' => [ 'title' => '频道开始的秒级时间戳（UTC时间）。', 'description' => '频道开始的秒级时间戳（UTC时间）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1557909133', ], 'ChannelId' => [ 'title' => '频道ID。', 'description' => '频道ID。', 'type' => 'string', 'example' => 'testid', ], ], ], 'ChannelExist' => [ 'title' => '频道是否存在，取值：'."\n" .'● true：存在。'."\n" .'● false：不存在。', 'description' => '频道是否存在。取值：'."\n" .'- **true**：存在。'."\n" .'- **false**：不存在。', '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"}]', 'title' => '查询在线频道信息', 'description' => '### 使用说明'."\n" .'本接口用于查询在线频道信息。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'RemoveUsers' => [ 'summary' => '本接口用于踢出频道内的用户。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已加入的频道ID，仅支持传单个ID。', 'description' => '已加入的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'Users', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'title' => '用户列表，N的取值：1～30。', 'description' => '用户列表，N的取值：1～30。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'required' => true, 'example' => '1811****', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 30, 'minItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', ], 'Users' => [ 'title' => '用户列表', 'description' => '用户列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'title' => '状态码，成功返回0，失败返回错误码描述。', 'description' => '状态码，成功返回0，失败返回错误码描述。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'UserId' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => '1811****', ], 'Message' => [ 'title' => '删除终端操作结果。取值：'."\n" .'● Success：成功。'."\n" .'● Failed：失败。', 'description' => '删除终端操作结果。取值：'."\n" .'- **Success**：成功。'."\n" .'- **Failed**：失败。', '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"}]', 'title' => '踢出用户', 'description' => '### 使用说明'."\n" .'本接口用于踢出在线频道内的用户。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '开关状态；enable-开启 disable-关闭。', '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"}]', 'title' => '查询录制功能状态', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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"}]', 'title' => '修改录制功能状态', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '录制文件命名规则。'."\n" .'> 为确保录制的文件名称唯一，目前录制文件的命名规则为record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}。', 'type' => 'string', 'required' => true, 'example' => 'record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}', 'default' => 'record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}', ], 'FileSplitInterval' => [ 'title' => '录制文件切割时长（大于等于1800）。单位：秒。', 'description' => '录制文件切割时长（大于等于1800）。单位：秒。', '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', '60', '61', ], ], 'Formats' => [ 'title' => '录制文件格式。当前文件格式仅支持：.m3u8、.mp4、.flv。', 'description' => '录制文件格式。当前文件格式仅支持：.m3u8、.mp4、.flv。', 'type' => 'array', 'items' => [ 'description' => '具体格式。', 'type' => 'string', 'required' => false, 'example' => 'mp4', ], 'required' => true, 'maxItems' => 1, 'minItems' => 1, ], 'LayoutIds' => [ 'title' => '布局ID列表，最多16个。', 'description' => '布局ID列表，最多16个。'."\n" ."\n" .'注意：列表中的布局对应的数据源数量不能相同。', 'type' => 'array', 'items' => [ 'description' => '具体布局ID。', 'type' => 'string', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 16, 'minItems' => 1, ], ], 'required' => true, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'description' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '模板ID。', '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"}]', 'title' => '新增录制模板', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'requestParamsDescription' => '**MediaEncode**枚举值如下所示。'."\n" ."\n" .'| ID | 宽 | 高 | 码流（Kps） | 帧率（FPS） | 备注'."\n" .'| ----------- | ----- | ------ | ----------- | --- |---'."\n" .'| 0 | 0 | 0 | 64 | 0 |纯音频'."\n" .'| 1 | 640 | 360 | 500 | 15 '."\n" .'| 10 | 960 | 540 | 700 | 24 '."\n" .'| 20 | 1280 | 720 | 1024 | 24 '."\n" .'| 22 | 720 | 1280 | 1024 | 30 '."\n" .'| 23 | 800 | 600 | 1024 | 30 '."\n" .'| 24 | 750 | 780 | 1024 | 30 '."\n" .'| 25 | 750 | 540 | 700 | 30 '."\n" .'| 26 | 720 | 1280 | 2048 | 30 '."\n" .'| 27 | 1280 | 720 | 2048 | 30 '."\n" .'| 28 | 1280 | 720 | 3096 | 30 '."\n" .'| 30 | 1920 | 1080 | 2048 | 30 '."\n" .'| 31 | 1080 | 1920 | 2048 | 30 '."\n" .'| 32 | 1024 | 768 | 1024 | 24 '."\n" .'| 33 | 1280 | 960 | 1024 | 24 '."\n" .'| 34 | 1024 | 768 | 2048 | 24 '."\n" .'| 35 | 1280 | 960 | 2048 | 24 '."\n" .'| 36 | 1280 | 720 | 1024 | 24 '."\n" .'| 37 | 1280 | 720 | 2048 | 24 '."\n" .'| 38 | 540 | 960 | 750 | 15 '."\n" .'| 39 | 540 | 960 | 1500 | 30 '."\n" .'| 40 | 1280 | 720 | 1200 | 15 '."\n" .'| 41 | 720 | 1280 | 1200 | 15 '."\n" .'| 42 | 720 | 1280 | 1500 | 15 '."\n" .'| 43 | 540 | 960 | 1200 | 15'."\n" .'| 52 | 640 | 360 | 500 | 30 '."\n" .'| 53 | 360 | 640 | 500 | 15 '."\n" .'| 54 | 360 | 640 | 500 | 30 '."\n" .'| 60 | 1920 | 1080 | 4096 | 30'."\n" .'| 61 | 1080 | 1920 | 4096 | 30', ], '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' => '录制文件命名规则。'."\n" .'> 为确保录制的文件名称唯一，目前录制文件的命名规则为record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}。', 'type' => 'string', 'required' => true, 'example' => 'record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}', 'default' => 'record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}', ], 'FileSplitInterval' => [ 'title' => '录制文件切割时长（大于等于1800）。单位：秒。', 'description' => '录制文件切割时长（大于等于1800）。单位：秒。', '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', '60', '61', ], ], 'Formats' => [ 'title' => '录制文件格式。当前文件格式仅支持：.m3u8、.mp4、.flv。', 'description' => '录制文件格式。当前文件格式仅支持：.m3u8、.mp4、.flv。', 'type' => 'array', 'items' => [ 'description' => '录制文件格式。', 'type' => 'string', 'required' => false, 'example' => 'mp4', ], 'required' => true, 'maxItems' => 1, 'minItems' => 1, ], 'LayoutIds' => [ 'title' => '布局ID列表，最多16个。', 'description' => '布局ID列表，最多16个。'."\n" ."\n" .'注意：列表中的布局对应的数据源数量不能相同。', 'type' => 'array', 'items' => [ 'description' => '具体的布局ID。', 'type' => 'string', 'required' => false, 'example' => '2', ], 'required' => true, 'maxItems' => 16, 'minItems' => 1, ], 'TemplateId' => [ 'title' => '模版ID。', 'description' => '模板ID。', 'type' => 'string', 'required' => true, 'example' => '2xh6****', ], ], 'required' => true, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'description' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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"}]', 'title' => '修改录制模板', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'requestParamsDescription' => '**MediaEncode**枚举值如下所示。'."\n" ."\n" .'| ID | 宽 | 高 | 码流（Kps） | 帧率（FPS） | 备注'."\n" .'| ----------- | ----- | ------ | ----------- | --- |---'."\n" .'| 0 | 0 | 0 | 64 | 0 |纯音频'."\n" .'| 1 | 640 | 360 | 500 | 15 '."\n" .'| 10 | 960 | 540 | 700 | 24 '."\n" .'| 20 | 1280 | 720 | 1024 | 24 '."\n" .'| 22 | 720 | 1280 | 1024 | 30 '."\n" .'| 23 | 800 | 600 | 1024 | 30 '."\n" .'| 24 | 750 | 780 | 1024 | 30 '."\n" .'| 25 | 750 | 540 | 700 | 30 '."\n" .'| 26 | 720 | 1280 | 2048 | 30 '."\n" .'| 27 | 1280 | 720 | 2048 | 30 '."\n" .'| 28 | 1280 | 720 | 3096 | 30 '."\n" .'| 30 | 1920 | 1080 | 2048 | 30 '."\n" .'| 31 | 1080 | 1920 | 2048 | 30 '."\n" .'| 32 | 1024 | 768 | 1024 | 24 '."\n" .'| 33 | 1280 | 960 | 1024 | 24 '."\n" .'| 34 | 1024 | 768 | 2048 | 24 '."\n" .'| 35 | 1280 | 960 | 2048 | 24 '."\n" .'| 36 | 1280 | 720 | 1024 | 24 '."\n" .'| 37 | 1280 | 720 | 2048 | 24 '."\n" .'| 38 | 540 | 960 | 750 | 15 '."\n" .'| 39 | 540 | 960 | 1500 | 30 '."\n" .'| 40 | 1280 | 720 | 1200 | 15 '."\n" .'| 41 | 720 | 1280 | 1200 | 15 '."\n" .'| 42 | 720 | 1280 | 1500 | 15 '."\n" .'| 43 | 540 | 960 | 1200 | 15'."\n" .'| 52 | 640 | 360 | 500 | 30 '."\n" .'| 53 | 360 | 640 | 500 | 15 '."\n" .'| 54 | 360 | 640 | 500 | 30 '."\n" .'| 60 | 1920 | 1080 | 4096 | 30'."\n" .'| 61 | 1080 | 1920 | 4096 | 30', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'ac7N****', ], ], [ 'name' => 'Template', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '模板信息', 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'title' => '模版ID。', 'description' => '模板ID。', '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"}]', 'title' => '删除录制模板', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'ac7N****', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'title' => '第几页，默认查询第1页。', 'description' => '第几页，默认查询第1页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页显示个数，默认为10。', 'description' => '每页显示个数，默认为10。', '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' => '模板ID。', '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' => '模版ID。', 'type' => 'string', 'example' => 'wv7N****', ], 'Name' => [ 'title' => '模版名称。', 'description' => '模版名称。', 'type' => 'string', 'example' => '测试', ], 'FilePrefix' => [ 'title' => '录制文件命名规则。'."\n" .'> 为确保录制的文件名称唯一，目前录制文件的命名规则为record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}。', 'description' => '录制文件命名规则。'."\n" .'> 为确保录制的文件名称唯一，目前录制文件的命名规则为record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}。', 'type' => 'string', 'example' => 'record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}', ], 'FileSplitInterval' => [ 'title' => '录制文件切割时长（大于等于1800）单位：秒。', 'description' => '录制文件切割时长（大于等于1800）单位：秒。', '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' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2020-09-04T06:22:15Z', ], 'MediaEncode' => [ 'title' => '编码选项。', 'description' => '编码选项。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'LayoutIds' => [ 'title' => '布局ID列表。', 'description' => '布局ID列表。', 'type' => 'array', 'items' => [ 'description' => '具体布局ID。', 'type' => 'string', 'example' => '22', ], ], 'Formats' => [ 'title' => '录制文件格式。当前文件格式仅支持：.m3u8、.mp4、.flv。'."\n" .'> 文件格式仅支持小写。', 'description' => '录制文件格式。当前文件格式仅支持：.m3u8、.mp4、.flv。'."\n" .'> 文件格式仅支持小写。', '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"}]', 'title' => '查询录制模板列表', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。', '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' => '任务ID。', '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' => '- 0: 任务已开始，等待用户加入'."\n" .'- 100: 任务暂未开始'."\n" .'- 101: 录制中'."\n" .'- 102: 录制文件上传中'."\n" .'- 200: 录制完成（频道结束）'."\n" .'- 201: 录制完成（用户停止）'."\n" .'- 400: 录制失败（服务器内部错误）'."\n" .'- 401: 录制失败（写入用户存储失败）'."\n" .'- 402: 录制失败（启动用户存储失败）'."\n" .'- 403: 录制失败（录制时间过短）'."\n" .'- 404: 录制失败（用户存储密钥错误）'."\n" .'- 405: 录制失败（bucket不存在）'."\n" .'- 406: 录制失败（访问用户存储被拒绝）', '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"}]', 'title' => '查询录制状态', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '频道ID。', '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' => '查询范围，录制任务开始时间开区间，单位：ms。如果不传，默认查询3天内，最长查询过去一年的录制文件。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1712376032000', ], ], [ 'name' => 'EndTs', 'in' => 'query', 'schema' => [ 'title' => '查询范围，录制任务开始时间闭区间，单位：ms。', 'description' => '查询范围，录制任务开始时间闭区间，单位：ms。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1712376532000', ], ], [ 'name' => 'TaskIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '录制任务TaskId列表。', 'description' => '录制任务TaskId列表。', 'type' => 'array', 'items' => [ 'title' => '具体任务ID。', 'description' => '具体任务ID。', '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' => '频道ID。', 'type' => 'string', 'example' => 'testchannelId', ], 'TaskId' => [ 'title' => '录制任务ID。', 'description' => '录制任务ID。', 'type' => 'string', 'example' => 'test001', ], 'FilePath' => [ 'title' => '录制文件存放路径。', 'description' => '录制文件存放路径。请通过云厂商对应的对象存储产品sdk获取录制文件。比如阿里云OSS，请参考[这里](https://help.aliyun.com/zh/oss/user-guide/how-to-obtain-the-url-of-a-single-object-or-the-urls-of-multiple-objects)。', 'type' => 'string', 'example' => 'record/appid/12_task_local1/1712279809158_1712279844691/playlist.mp4', ], 'FileSize' => [ 'title' => '录制文件大小，单位：Byte。', 'description' => '录制文件大小，单位：Byte。', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', ], 'FileDuration' => [ 'title' => '录制文件时长，单位：ms。', 'description' => '录制文件时长，单位：ms。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Vendor' => [ 'title' => '参考开启录制任务vendor。', 'description' => '参考开启录制任务vendor。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Region' => [ 'title' => '参考录制任务region。', 'description' => '参考录制任务region。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Bucket' => [ 'title' => '用户自定义的bucket。', 'description' => '用户自定义的bucket。', 'type' => 'string', 'example' => 'rtc-bucket', ], 'StartTs' => [ 'title' => '录制任务开始时间戳，单位：ms。', 'description' => '录制任务开始时间戳，单位：ms。', 'type' => 'integer', 'format' => 'int64', 'example' => '1712376012000', ], 'FileCreateTs' => [ 'title' => '录制文件生成时间戳，单位：ms。', 'description' => '录制文件生成时间戳，单位：ms。', '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"}]', 'title' => '录制文件列表', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'StartCloudRecord' => [ 'summary' => '本接口用于开始云端录制任务。', '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' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已存在的频道ID，仅支持传单个ID。', 'description' => '已存在的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'title' => '模版ID，最长128位。', 'description' => '模版ID。', 'type' => 'string', 'required' => true, 'example' => '567', 'maxLength' => 128, 'minLength' => 1, 'pattern' => '^[\\w.-]+$', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '本次云端录制的任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', 'description' => '本次云端录制的任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', '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", 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边（默认值）。'."\n" .'- **3**：拉伸铺满。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '2', 'enum' => [ '1', '2', '3', ], ], ], [ 'name' => 'ReservePaneForNoCameraUser', 'in' => 'query', 'schema' => [ 'title' => '未推摄像头流用户窗格占位。'."\n" .'默认为true，表示用户未推摄像头流时保留一个窗格。'."\n" .'为false时，表示用户未推摄像头流时不保留窗格。', 'description' => '未推摄像头流用户窗格占位。'."\n" .'默认为true，表示用户未推摄像头流时保留一个窗格。'."\n" .'为false时，表示用户未推摄像头流时不保留窗格。', 'type' => 'boolean', 'required' => false, 'default' => 'true', ], ], [ 'name' => 'ShowDefaultBackgroundOnMute', 'in' => 'query', 'schema' => [ 'title' => 'mute时是否显示窗格默认底图。'."\n" .'- true: 显示（默认值）'."\n" .'- false: 不显示（设置的局部窗格底图依然显示）', 'description' => 'mute时是否显示窗格默认底图。'."\n" .'- true: 显示（默认值）'."\n" .'- false: 不显示（设置的局部窗格底图依然显示）', 'type' => 'boolean', 'required' => false, 'default' => 'true', ], ], [ 'name' => 'SubHighResolutionStream', 'in' => 'query', 'schema' => [ 'title' => '订阅高分辨率流。'."\n" .'- false：根据窗格面积订阅不同分辨率的流。（默认值）'."\n" .'- true：默认用客户端推的最高分辨率的流进行填充。', 'description' => '订阅高分辨率流。'."\n" .'- false：根据窗格面积订阅不同分辨率的流。（默认值）'."\n" .'- true：默认用客户端推的最高分辨率的流进行填充。', 'type' => 'boolean', 'required' => false, 'default' => 'false', ], ], [ 'name' => 'StartWithoutChannel', 'in' => 'query', 'schema' => [ 'title' => '是否允许频道不存在时开启任务。'."\n" ."\n" .'- true: 是'."\n" .'- false: 否（默认值）', 'description' => '是否允许频道不存在时开启任务。'."\n" ."\n" .'- true: 是'."\n" .'- false: 否（默认值）', 'type' => 'boolean', 'required' => false, 'default' => 'false', ], ], [ 'name' => 'StartWithoutChannelWaitTime', 'in' => 'query', 'schema' => [ 'title' => '当StartWithoutChannel参数为true的时候，设置该值才有意义，表示房间未开启时，任务等待时长，单位为秒，区间限制为[30,120]。', 'description' => '当StartWithoutChannel参数为true的时候，设置该值才有意义，表示房间未开启时，任务等待时长，单位为秒，区间限制为[30,120]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', ], ], [ 'name' => 'Annotation', 'in' => 'query', 'schema' => [ 'title' => '标注开关。', 'description' => '标注开关。', 'type' => 'string', 'required' => false, 'example' => 'disable', 'default' => 'enable', 'enum' => [ 'disable', 'enable', ], ], ], [ 'name' => 'StorageConfig', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'title' => '存储配置', 'description' => '存储配置', 'type' => 'object', 'properties' => [ 'Vendor' => [ 'title' => '存储平台。取值：'."\n" ."\n" .'| vendor | 对象存储产品 | 备注 |'."\n" .'|--------|---------|---------|'."\n" .'| 1 | AliYun OSS | 阿里云 |'."\n" .'| 2| AliYun 专有云OSS | 阿里云专有云 |', 'description' => '存储平台。取值：'."\n" ."\n" .'| vendor | 对象存储产品 | 备注 |'."\n" .'|--------|---------|---------|'."\n" .'| 1 | AliYun OSS | 阿里云 |'."\n" .'| 2| AliYun 专有云OSS | 阿里云专有云 |', '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' => '存储地域。'."\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" .'| 28 | CN_Wuhan_LR |'."\n" .'| 100 | oss-cn-hzjbp |'."\n" .'| 101 | oss-cn-shanghai-finance-1 |'."\n" .'| 102 | oss-cn-shenzhen-finance-1 |'."\n" .'| 103 | oss-cn-beijing-finance-1 |'."\n" .'| 104 | oss-cn-hzfinance |'."\n" .'| 105 | oss-cn-shanghai-finance-1-pub |'."\n" .'| 106 | oss-cn-szfinance |'."\n" .'| 107 | oss-cn-beijing-finance-1-pub |'."\n" ."\n" .'| Region | AliYun 专有云OSS |'."\n" .'|--------|------------|'."\n" .'| 0 | default|', '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, ], 'Endpoint' => [ 'title' => '专有云时，私网连接地址。', 'description' => '专有云时，私网连接地址。', 'type' => 'string', 'required' => false, 'example' => 'https://aliyuns.dalian.oss.com', 'minLength' => 1, ], ], 'required' => true, 'example' => 'testid', ], ], [ '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，摄像头优先', 'description' => 'SourceType为video时，填充顺序。'."\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' => '单元格媒体类型。取值：'."\n" .'- **video**：用户摄像头或者屏幕共享流（默认值）。'."\n" .'- **camera**：摄像头流。'."\n" .'- **screen**：共享屏幕流。'."\n" .'- **whiteboard**：白板。', 'type' => 'string', 'required' => false, 'example' => 'video', 'default' => 'video', 'enum' => [ 'video', 'camera', 'screen', 'whiteboard', ], ], 'Images' => [ 'title' => '窗格局部图片水印。', 'description' => '窗格局部图片水印。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PaneImageCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', '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.2', ], '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' => 'z轴层级。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', ], 'Url' => [ 'title' => '图片地址。', 'description' => '对应的图片内容在推流期间不支持更新', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com/123xx.jpg', 'maxLength' => 1024, 'minLength' => 1, ], 'Display' => [ 'title' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'description' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'type' => 'string', 'required' => false, '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, 'example' => '5', 'default' => '5', ], '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, ], 'Texture' => [ 'title' => '水印内容。', 'description' => '水印内容。', 'type' => 'string', 'required' => true, 'example' => '文字水印', 'maxLength' => 128, 'minLength' => 1, ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', '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' => '字体。'."\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', 'required' => false, 'example' => '0', 'default' => '0', ], '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.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', ], 'BoxAlpha' => [ 'title' => '矩形框透明度。', 'description' => '矩形框透明度。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.6', 'default' => '0.6', ], 'Display' => [ 'title' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'description' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'type' => 'string', 'required' => false, 'example' => 'backup', 'default' => 'streamOnly', 'enum' => [ 'streamOnly', 'backup', 'always', ], ], ], 'required' => false, ], 'required' => false, 'maxItems' => 3, ], 'PaneCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'enum' => [ '1', '2', '3', ], ], 'PaneId' => [ 'title' => '窗格ID，从0开始。', 'description' => '布局ID，从0开始。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], 'Source' => [ 'title' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" .' - ** $ActiveSpeaker**：当前频道发言人'."\n" .' - **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', 'description' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" ."\n" .'- **$ActiveSpeaker**：当前频道发言人'."\n" .'- **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', 'type' => 'string', 'required' => false, 'example' => '22', ], 'Backgrounds' => [ 'title' => '窗格局部背景图片。', 'description' => '背景图片。', 'type' => 'array', 'items' => [ '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', ], 'PaneBackgroundCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', '3', ], ], 'Height' => [ 'description' => '高。', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.2', ], 'Width' => [ 'description' => '宽。', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.3', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', ], 'Url' => [ 'title' => '图片地址。', 'description' => '图片地址。', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com/123xx.jpg', 'maxLength' => 1024, 'minLength' => 1, ], 'Display' => [ 'title' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'description' => '显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'type' => 'string', 'required' => false, 'example' => 'backup', 'default' => 'streamOnly', 'enum' => [ 'streamOnly', 'backup', 'always', ], ], ], 'required' => false, ], 'required' => false, 'maxItems' => 3, ], 'Whiteboard' => [ 'title' => '白板设置。', 'description' => '白板配置。', 'type' => 'object', 'properties' => [ 'WhiteboardId' => [ 'title' => '白板ID。', 'description' => '白板ID，默认为default。', 'type' => 'string', 'required' => false, 'example' => 'default', 'default' => 'default', ], ], 'required' => false, ], 'ReservePaneForOfflineUser' => [ 'title' => '未入会用户窗格占位。'."\n" .'默认为true，表示宫格指定的具体用户或通配符用户离线时，窗格强制占位。'."\n" .'为false时，表示宫格指定的具体用户或通配符用户离线时，将按自动填充顺序显示视频流。', 'description' => '未入会用户窗格占位。'."\n" ."\n" .'默认为true，表示宫格指定的具体用户或通配符用户离线时，窗格强制占位。'."\n" .'为false时，表示宫格指定的具体用户或通配符用户离线时，将按自动填充顺序显示视频流。', 'type' => 'boolean', 'required' => false, 'default' => 'true', ], ], 'required' => false, ], 'required' => false, 'example' => 'eo85****', '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, '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', ], 'ImageCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', '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' => 'z轴层级。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', ], 'Url' => [ 'title' => '图片地址。', 'description' => '图片地址。对应的图片内容在推流期间不支持更新。', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com/123xxx.jpg', 'maxLength' => 1024, 'minLength' => 1, ], ], 'required' => false, ], 'required' => false, 'example' => 'disable', 'maxItems' => 3, ], ], [ 'name' => 'Backgrounds', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'title' => '背景图片。', 'description' => '背景图片。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BackgroundCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', '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' => 'z轴层级。', 'type' => 'integer', 'format' => 'int32', 'required' => false, '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' => 'Texts', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'title' => '全局文字水印。', 'description' => '全局文字水印。', 'type' => 'array', 'items' => [ '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' => '文字水印', 'maxLength' => 128, 'minLength' => 1, ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', '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' => '字体。'."\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', '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' => [ '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' => 'z轴层级。', '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' => '字体。'."\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', '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' => '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' => 'LayoutSpecifiedUsers', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '黑白名单设置。', 'description' => '布局生成用户指定列表，包括黑/白名单两种。'."\n" ."\n" .'白名单，指定订阅房间里哪些用户视频流。'."\n" .'* 设置后自动填充根据该列表进行顺序填充'."\n" .'* 模版多布局切换时只计算白名单中的人'."\n" ."\n" .'黑名单，指定不订阅房间里哪些用户视频流。'."\n" .'* 模版多布局切换时只计算非黑名单中的人', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '用户名单类型，黑名单：black，白名单：white。', 'description' => '用户名单类型，黑名单：black，白名单：white。', 'type' => 'string', 'required' => true, 'example' => 'white', 'enum' => [ 'white', 'black', ], ], 'Ids' => [ 'title' => '指定用户ID列表。', 'description' => '指定用户ID列表。', 'type' => 'array', 'items' => [ 'title' => '具体用户ID。', 'description' => '具体用户ID。', 'type' => 'string', 'required' => true, 'example' => '123', ], 'required' => true, 'maxItems' => 16, 'minItems' => 1, ], ], 'required' => false, ], ], [ 'name' => 'RecordMode', 'in' => 'query', 'schema' => [ 'title' => ' 0: 合流录制（默认值）'."\n" .' 1: 单流录制 （单流录制不支持更新）', 'description' => ' 0: 合流录制（默认值）'."\n" .' 1: 单流录制 （单流录制不支持更新）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'enum' => [ '0', '1', ], ], ], [ 'name' => 'SingleStreamingRecord', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '单流录制参数。', 'description' => '单流录制参数。', 'type' => 'object', 'properties' => [ 'AvMerge' => [ 'title' => '音频文件是否合并到视频文件，默认false。', 'description' => '音频文件是否合并到视频文件，默认false。', 'type' => 'boolean', 'required' => false, 'default' => 'false', ], 'SpecifiedStreams' => [ 'title' => '单流录制指定的流。', 'description' => '单流录制指定的流。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StreamType' => [ 'title' => '流类型，取值：'."\n" .'- mic: 音频流'."\n" .'- camera：摄像头流'."\n" .'- screen-cast：屏幕共享流', 'description' => '流类型，取值：'."\n" .'- mic: 音频流', 'type' => 'string', 'required' => true, 'enum' => [ 'mic', 'camera', 'screen-cast', ], ], 'Type' => [ 'title' => '单流录制流黑白名单类型'."\n" .'- white: 白名单，表示录制该流', 'description' => '单流录制流黑白名单类型'."\n" .'- white: 白名单，表示录制该流', 'type' => 'string', 'required' => false, 'example' => 'white', 'default' => 'white', 'enum' => [ 'white', ], ], 'Ids' => [ 'title' => '用户ID列表。', 'description' => '用户ID列表。', 'type' => 'array', 'items' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'required' => true, ], 'required' => true, 'maxItems' => 16, 'minItems' => 1, ], ], 'required' => false, ], 'required' => true, 'maxItems' => 3, 'minItems' => 1, ], 'TranscodingParameters' => [ 'title' => '单流录制默认写入为mp3格式，如需转码需指定该参数。', 'description' => '单流录制默认写入为mp3格式，如需转码需指定该参数。', 'type' => 'object', 'properties' => [ 'Audio' => [ 'title' => '音频编码。', 'description' => '音频编码。', 'type' => 'object', 'properties' => [ 'Bitrate' => [ 'title' => '码率，单位kbps。', 'description' => '码率，单位kbps。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '128', 'enum' => [ '64', '128', '192', ], ], 'Codec' => [ 'title' => '音频编解码格式，可选:'."\n" .'- mp3'."\n" .'- aac', 'description' => '音频编解码格式，可选:'."\n" .'- mp3'."\n" .'- aac', 'type' => 'string', 'required' => false, 'default' => 'mp3', 'enum' => [ 'mp3', 'aac', ], ], 'SampleRate' => [ 'title' => '采样率，可选：'."\n" .'- 8000'."\n" .'- 16000'."\n" .'- 32000'."\n" .'- 44100'."\n" .'- 48000', 'description' => '采样率，可选：'."\n" .'- 8000'."\n" .'- 16000'."\n" .'- 32000'."\n" .'- 44100'."\n" .'- 48000', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '48000', 'enum' => [ '16000', '32000', '48000', '8000', '44100', ], ], ], 'required' => false, ], 'Container' => [ 'title' => '录制文件容器。'."\n" .'- mp3'."\n" .'- aac'."\n" .'- mp4'."\n" .'- ts', 'description' => '录制文件容器。'."\n" .'- mp3'."\n" .'- aac'."\n" .'- mp4'."\n" .'- ts', 'type' => 'string', 'required' => false, 'example' => 'aac', 'default' => 'mp3', 'enum' => [ 'mp3', 'aac', 'mp4', 'ts', ], ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'result', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '本次云端录制的任务ID。', 'description' => '本次云端录制的任务ID。', 'type' => 'string', 'example' => '123', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', 'title' => '开始云端录制任务', 'description' => '### 使用说明'."\n" .'本接口用于开始在线频道的云端录制任务。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'requestParamsDescription' => '>相关补充>'."\n" ."\n" .'局部图片水印数量、局部背景图片水印、全局图片水印数量和全局背景图数量的总和不能超过16。'."\n" ."\n" .'

'."\n" .'

高级水印层次说明

'."\n" .'RTC 媒体服务器 生成的画面会分成以下几个步骤：'."\n" ."\n" .'绘制视频 -> 绘制图片 -> 绘制文字'."\n" ."\n" .'视频、图片、文字是完全分开的，从整个画面来看 文字优先级 > 图片 > 视频 '."\n" .'1. 绘制视频：'."\n" .' 根据客户定义的布局对视频画面进行布局 '."\n" ."\n" .' a. 宫格中的图片和全局图片的layer统一排列。'."\n" ."\n" .' b. layer 0位于最底层，layer越大越位于上方，layer 的取值范围为[0,100] 。'."\n" ."\n" .'2. 绘制图片'."\n" .' 图片包括用户自定义的png/jpg图片。'."\n" ."\n" .' a. 根据用户配置宽高、位置、透明度等信息进行绘制。'."\n" ."\n" .' b. layer 0位于最底层，layer越大越位于上方，layer 的取值范围为[0,100] 。'."\n" ."\n" .'3. 绘制文字'."\n" .' 文字分为3个类型 ： 区域文字 全局文字和时间戳文字 。'."\n" ."\n" .' a. 同一类型文字根据layer顺序绘制，layer 0位于最底层，layer越大越位于上方，layer 的取值范围为[0,100] 。'."\n" ."\n" .' b. 不同类型文字优先级为 ： 时间戳文字 > 全局文字 > 区域文字 。处于重叠位置时，优先级较低的将被覆盖。'."\n" ."\n\n" .'重叠部分的显示：'."\n" .'1. 重叠部分，如果没有特别配置，高优先级将覆盖低优先级 。'."\n" .'2. 低优先级内容如果不想被高优先级内容覆盖，可以设置高优先级内容的透明度属性为0。'."\n" .'

'."\n" .'

单流录制容器及音频编码格式校验规则

'."\n" .'单流录制允许用户指定录制文件的编码格式及容器格式，不同容器格式支持的流类型、编码格式并不一致。单流录制接口会校验相关参数，不支持的组合会被拒绝。'."\n" ."\n" .'**规则一：流类型及支持的容器格式**'."\n" ."\n" .'| 流类型 | 容器格式 |'."\n" .'| --- | --- |'."\n" .'| 纯音频流 （流类型只有mic） | aac、mp3、mp4、ts |'."\n" .'| 纯视频流 or 音视频流 （流类型出现camera 或screen-cast） | mp4、ts |'."\n" ."\n" .'**规则二：容器格式及支持的音频编码格式**'."\n" ."\n" .'| 容器格式 | 音频编码格式 |'."\n" .'| --- | --- |'."\n" .'| mp3 | mp3 |'."\n" .'| aac | aac |'."\n" .'| ts | mp3、aac |'."\n" .'| mp4 | aac |'."\n" .'

', ], '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' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已存在的频道ID，仅支持传单个ID。', 'description' => '已存在的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'title' => '模版ID。', 'description' => '模版ID。'."\n" .'>更新模版ID，仅可以更新布局，不支持更新分辨率。>', 'type' => 'string', 'required' => true, 'example' => '567', 'maxLength' => 128, 'minLength' => 1, ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '本次云端录制的任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', 'description' => '本次云端录制的任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', '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' => '单元格媒体类型。取值：'."\n" .'- **video**：用户摄像头或者屏幕共享流（默认值）。'."\n" .'- **camera**：摄像头流。'."\n" .'- **screen**：共享屏幕流。'."\n" .'- **whiteboard**：白板。', 'type' => 'string', 'required' => false, 'example' => 'video', 'default' => 'video', 'enum' => [ 'video', 'camera', 'screen', 'whiteboard', ], ], 'VideoOrder' => [ 'title' => 'SourceType为video时，填充顺序。'."\n" ."\n" .'- screenFirst，屏幕共享优先（默认值）'."\n" .'- cameraFirst，摄像头优先', 'description' => 'SourceType为video时，填充顺序。'."\n" .'- screenFirst，屏幕共享优先（默认值）'."\n" .'- cameraFirst，摄像头优先', 'type' => 'string', 'required' => false, 'example' => 'cameraFirst', 'default' => 'screenFirst', 'enum' => [ 'cameraFirst', 'screenFirst', ], ], 'PaneId' => [ 'title' => '窗格ID，从0开始。', 'description' => '窗格ID，从0开始。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '15', 'minimum' => '0', 'example' => '0', ], 'Source' => [ 'title' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" .' - **$ActiveSpeaker**：当前频道发言人'."\n" .' - **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', 'description' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" ."\n" .'- **$ActiveSpeaker**：当前频道发言人'."\n" .'- **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', 'type' => 'string', 'required' => false, 'example' => '22', ], 'PaneCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', '3', ], ], 'ReservePaneForOfflineUser' => [ 'title' => '未入会用户窗格占位。'."\n" .'默认为true，表示宫格指定的具体用户或通配符用户离线时，窗格强制占位。'."\n" .'为false时，表示宫格指定的具体用户或通配符用户离线时，将按自动填充顺序显示视频流。', 'description' => '未入会用户窗格占位。'."\n" .'默认为true，表示宫格指定的具体用户或通配符用户离线时，窗格强制占位。'."\n" .'为false时，表示宫格指定的具体用户或通配符用户离线时，将按自动填充顺序显示视频流。', 'type' => 'boolean', 'required' => false, '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' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', '3', ], ], 'X' => [ 'title' => '横坐标。', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Y' => [ 'title' => '纵坐标。', 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Width' => [ 'title' => '宽。', 'description' => '宽。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Height' => [ 'title' => '高。', 'description' => '高。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '0', 'default' => '0', ], 'Display' => [ 'title' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'description' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'type' => 'string', 'required' => false, 'example' => 'backup', 'default' => 'streamOnly', 'enum' => [ 'streamOnly', 'backup', 'always', ], ], ], 'required' => false, ], 'required' => false, 'maxItems' => 3, ], 'Backgrounds' => [ 'title' => '窗格局部背景图片。', 'description' => '背景图片。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Url' => [ 'title' => '图片地址。', 'description' => '背景图地址。', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com/123xx.jpg', 'maxLength' => 1024, 'minLength' => 1, ], 'Alpha' => [ 'title' => '透明度。', 'description' => '透明度。', 'type' => 'number', 'format' => 'double', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'example' => '0.9', 'default' => '1.0', ], 'PaneBackgroundCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', '3', ], ], 'X' => [ 'title' => '', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Y' => [ 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Width' => [ 'description' => '宽。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Height' => [ 'description' => '高。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '0', 'default' => '0', ], 'Display' => [ 'title' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'description' => '显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'type' => 'string', 'required' => false, 'example' => 'backup', 'default' => 'streamOnly', 'enum' => [ 'streamOnly', 'backup', 'always', ], ], ], 'required' => false, ], 'required' => false, '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' => [ 'title' => 'R。', 'description' => 'R。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], 'G' => [ 'title' => 'G。', 'description' => 'G。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], 'B' => [ 'title' => 'B。', 'description' => 'B。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], ], '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' => '字体。'."\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', 'required' => false, 'maximum' => '9', 'minimum' => '0', 'example' => '0', 'default' => '0', ], 'X' => [ 'title' => '横坐标。', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '0.2', ], 'Y' => [ 'title' => '纵坐标。', 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '0.2', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', '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' => [ 'title' => 'R。', 'description' => 'R。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], 'G' => [ 'title' => 'G。', 'description' => 'G。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], 'B' => [ 'title' => 'B。', 'description' => 'B。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], ], '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：总是显示。', 'description' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'type' => 'string', 'required' => false, 'example' => 'backup', 'default' => 'streamOnly', 'enum' => [ 'streamOnly', 'backup', 'always', ], ], ], 'required' => false, ], 'required' => false, 'maxItems' => 3, ], 'Whiteboard' => [ 'title' => '白板设置。', 'description' => '白板配置。', 'type' => 'object', 'properties' => [ 'WhiteboardId' => [ 'title' => '白板ID。', 'description' => '白板ID，默认为default。', 'type' => 'string', 'required' => false, 'example' => 'default', 'default' => 'default', ], ], 'required' => false, ], ], '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' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', '3', ], ], 'X' => [ 'title' => '横坐标。', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Y' => [ 'title' => '纵坐标。', 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Width' => [ 'title' => '宽。', 'description' => '宽。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Height' => [ 'title' => '高。', 'description' => '高。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', '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' => '背景图片。', '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', ], 'BackgroundCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', '3', ], ], 'X' => [ 'title' => '横坐标。', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Y' => [ 'title' => '纵坐标。', 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Width' => [ 'title' => '宽。', 'description' => '宽。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Height' => [ 'title' => '高。', 'description' => '高。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '0', 'default' => '0', ], ], 'required' => false, ], 'required' => false, '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' => [ 'title' => 'R。', 'description' => 'R。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], 'G' => [ 'title' => 'G。', 'description' => 'G。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], 'B' => [ 'title' => 'B。', 'description' => 'B。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], ], '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' => '字体。'."\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', 'required' => false, 'maximum' => '9', 'minimum' => '0', 'example' => '0', 'default' => '0', ], 'X' => [ 'title' => '横坐标。', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '0.2', ], 'Y' => [ 'title' => '纵坐标。', 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '0.2', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', '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' => [ 'title' => 'R。', 'description' => 'R。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], 'G' => [ 'title' => 'G。', 'description' => 'G。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], 'B' => [ 'title' => 'B。', 'description' => 'B。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], ], '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' => [ 'title' => 'R。', 'description' => 'R。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], 'G' => [ 'title' => 'G。', 'description' => 'G。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], 'B' => [ 'title' => 'B。', 'description' => 'B。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], ], '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' => '字体。'."\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', 'required' => false, 'maximum' => '9', 'minimum' => '0', 'example' => '0', 'default' => '0', ], 'X' => [ 'title' => '横坐标。', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '0.2', ], 'Y' => [ 'title' => '纵坐标。', 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '0.2', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', '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' => [ 'title' => 'R。', 'description' => 'R。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], 'G' => [ 'title' => 'G。', 'description' => 'G。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], 'B' => [ 'title' => 'B。', 'description' => 'B。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], ], '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' => '黑白名单设置。', 'description' => '布局生成用户指定列表，包括黑/白名单两种。'."\n" ."\n" .'白名单，指定订阅房间里哪些用户视频流。'."\n" .'* 设置后自动填充根据该列表进行顺序填充'."\n" .'* 模版多布局切换时只计算白名单中的人'."\n" ."\n" .'黑名单，指定不订阅房间里哪些用户视频流。'."\n" .'* 模版多布局切换时只计算非黑名单中的人', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '用户名单类型，黑名单：black，白名单：white。', 'description' => '用户名单类型，黑名单：black，白名单：white。', 'type' => 'string', 'required' => true, 'example' => 'white', 'enum' => [ 'white', 'black', ], ], 'Ids' => [ 'title' => '指定用户ID列表。', 'description' => '指定用户ID列表。', 'type' => 'array', 'items' => [ 'title' => '具体用户ID。', 'description' => '具体用户ID。', 'type' => 'string', 'required' => true, 'example' => '123', ], 'required' => true, 'maxItems' => 16, 'minItems' => 1, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'result', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '本次云端录制的任务ID。', 'description' => '本次云端录制的任务ID。', 'type' => 'string', 'example' => '123', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', 'title' => '更新云端录制任务', 'description' => '### 使用说明'."\n" .'本接口用于更新在线频道的云端录制任务。'."\n" ."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'requestParamsDescription' => '>相关补充>'."\n" ."\n" .'局部图片水印数量、局部背景图片水印、全局图片水印数量和全局背景图数量的总和不能超过16。'."\n" ."\n" .'

'."\n" .'

高级水印层次说明

'."\n" .'RTC 媒体服务器 生成的画面会分成以下几个步骤：'."\n" ."\n" .'绘制视频 -> 绘制图片 -> 绘制文字'."\n" ."\n" .'视频、图片、文字是完全分开的，从整个画面来看 文字优先级 > 图片 > 视频 '."\n" .'1. 绘制视频：'."\n" .' 根据客户定义的布局对视频画面进行布局 '."\n" ."\n" .' a. 宫格中的图片和全局图片的layer统一排列。'."\n" ."\n" .' b. layer 0位于最底层，layer越大越位于上方，layer 的取值范围为[0,100] 。'."\n" ."\n" .'2. 绘制图片'."\n" .' 图片包括用户自定义的png/jpg图片。'."\n" ."\n" .' a. 根据用户配置宽高、位置、透明度等信息进行绘制。'."\n" ."\n" .' b. layer 0位于最底层，layer越大越位于上方，layer 的取值范围为[0,100] 。'."\n" ."\n" .'3. 绘制文字'."\n" .' 文字分为3个类型 ： 区域文字 全局文字和时间戳文字 。'."\n" ."\n" .' a. 同一类型文字根据layer顺序绘制，layer 0位于最底层，layer越大越位于上方，layer 的取值范围为[0,100] 。'."\n" ."\n" .' b. 不同类型文字优先级为 ： 时间戳文字 > 全局文字 > 区域文字 。处于重叠位置时，优先级较低的将被覆盖。'."\n" ."\n\n" .'重叠部分的显示：'."\n" .'1. 重叠部分，如果没有特别配置，高优先级将覆盖低优先级 。'."\n" .'2. 低优先级内容如果不想被高优先级内容覆盖，可以设置高优先级内容的透明度属性为0。'."\n" .'

', ], 'StopCloudRecord' => [ 'summary' => '本接口用于停止云端录制任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已存在的频道ID，仅支持传单个ID。', 'description' => '已存在的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '已存在的云端录制的任务ID，仅支持传单个ID。', 'description' => '已存在的云端录制的任务ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => '123', 'maxLength' => 55, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '本次云端录制的任务ID。', 'description' => '本次云端录制的任务ID。', 'type' => 'string', 'example' => '123', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '停止云端录制任务', 'description' => '### 使用说明'."\n" .'本接口用于停止在线频道云端录制任务。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '开关状态；enable-开启 disable-关闭。', '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"}]', 'title' => '查询旁路推流功能状态', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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"}]', 'title' => '修改旁路推流功能状态', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'CreateAppStreamingOutTemplate' => [ 'summary' => '创建 RTC 3.0 应用推流模板。', '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '布局ID列表，最多16个。'."\n" ."\n" .'注意：列表中的布局对应的数据源数量不能相同。', 'type' => 'array', 'items' => [ 'title' => '具体的布局ID。', 'description' => '具体的布局ID。', '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', '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, 'example' => 'ac7N****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30D41049-D02D-1C21-86AE-B3E5FD805C27', ], 'TemplateId' => [ 'title' => '模版ID。', 'description' => '模板ID。', '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"}]', 'title' => '创建推流模板', 'description' => '### 使用说明'."\n" .'本接口用于 RTC 3.0 的应用创建推流模板。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'requestParamsDescription' => '**MediaEncode**枚举值如下所示。'."\n" ."\n" .'| ID | 宽 | 高 | 码流（Kps） | 帧率（FPS） | 备注'."\n" .'| ----------- | ----- | ------ | ----------- | --- |---'."\n" .'| 0 | 0 | 0 | 64 | 0 |纯音频'."\n" .'| 1 | 640 | 360 | 500 | 15 '."\n" .'| 10 | 960 | 540 | 700 | 24 '."\n" .'| 20 | 1280 | 720 | 1024 | 24 '."\n" .'| 22 | 720 | 1280 | 1024 | 30 '."\n" .'| 23 | 800 | 600 | 1024 | 30 '."\n" .'| 24 | 750 | 780 | 1024 | 30 '."\n" .'| 25 | 750 | 540 | 700 | 30 '."\n" .'| 26 | 720 | 1280 | 2048 | 30 '."\n" .'| 27 | 1280 | 720 | 2048 | 30 '."\n" .'| 28 | 1280 | 720 | 3096 | 30 '."\n" .'| 30 | 1920 | 1080 | 2048 | 30 '."\n" .'| 31 | 1080 | 1920 | 2048 | 30 '."\n" .'| 32 | 1024 | 768 | 1024 | 24 '."\n" .'| 33 | 1280 | 960 | 1024 | 24 '."\n" .'| 34 | 1024 | 768 | 2048 | 24 '."\n" .'| 35 | 1280 | 960 | 2048 | 24 '."\n" .'| 36 | 1280 | 720 | 1024 | 24 '."\n" .'| 37 | 1280 | 720 | 2048 | 24 '."\n" .'| 38 | 540 | 960 | 750 | 15 '."\n" .'| 39 | 540 | 960 | 1500 | 30 '."\n" .'| 40 | 1280 | 720 | 1200 | 15 '."\n" .'| 41 | 720 | 1280 | 1200 | 15 '."\n" .'| 42 | 720 | 1280 | 1500 | 15 '."\n" .'| 43 | 540 | 960 | 1200 | 15'."\n" .'| 52 | 640 | 360 | 500 | 30 '."\n" .'| 53 | 360 | 640 | 500 | 15 '."\n" .'| 54 | 360 | 640 | 500 | 30 '."\n" .'| 60 | 1920 | 1080 | 4096 | 30'."\n" .'| 61 | 1080 | 1920 | 4096 | 30', ], 'ModifyAppStreamingOutTemplate' => [ 'summary' => '修改 RTC 3.0 应用推流模板。', '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '布局ID列表，最多16个。'."\n" ."\n" .'注意：列表中的布局对应的数据源数量不能相同。', 'type' => 'array', 'items' => [ 'title' => '具体的布局ID。', 'description' => '具体的布局ID。', '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', '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' => '模板ID。', 'type' => 'string', 'required' => true, 'example' => 'ac7N****', ], ], 'required' => true, 'example' => 'wv7N****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30D41049-D02D-1C21-86AE-B3E5FD805C27', ], 'TemplateId' => [ 'title' => '模版ID。', 'description' => '模板ID。', '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"}]', 'title' => '修改推流模板', 'description' => '### 使用说明'."\n" .'本接口用于RTC 3.0的应用修改推流模板。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'requestParamsDescription' => '**MediaEncode**枚举值如下所示。'."\n" ."\n" .'| ID | 宽 | 高 | 码流（Kps） | 帧率（FPS） | 备注'."\n" .'| ----------- | ----- | ------ | ----------- | --- |---'."\n" .'| 0 | 0 | 0 | 64 | 0 |纯音频'."\n" .'| 1 | 640 | 360 | 500 | 15 '."\n" .'| 10 | 960 | 540 | 700 | 24 '."\n" .'| 20 | 1280 | 720 | 1024 | 24 '."\n" .'| 22 | 720 | 1280 | 1024 | 30 '."\n" .'| 23 | 800 | 600 | 1024 | 30 '."\n" .'| 24 | 750 | 780 | 1024 | 30 '."\n" .'| 25 | 750 | 540 | 700 | 30 '."\n" .'| 26 | 720 | 1280 | 2048 | 30 '."\n" .'| 27 | 1280 | 720 | 2048 | 30 '."\n" .'| 28 | 1280 | 720 | 3096 | 30 '."\n" .'| 30 | 1920 | 1080 | 2048 | 30 '."\n" .'| 31 | 1080 | 1920 | 2048 | 30 '."\n" .'| 32 | 1024 | 768 | 1024 | 24 '."\n" .'| 33 | 1280 | 960 | 1024 | 24 '."\n" .'| 34 | 1024 | 768 | 2048 | 24 '."\n" .'| 35 | 1280 | 960 | 2048 | 24 '."\n" .'| 36 | 1280 | 720 | 1024 | 24 '."\n" .'| 37 | 1280 | 720 | 2048 | 24 '."\n" .'| 38 | 540 | 960 | 750 | 15 '."\n" .'| 39 | 540 | 960 | 1500 | 30 '."\n" .'| 40 | 1280 | 720 | 1200 | 15 '."\n" .'| 41 | 720 | 1280 | 1200 | 15 '."\n" .'| 42 | 720 | 1280 | 1500 | 15 '."\n" .'| 43 | 540 | 960 | 1200 | 15'."\n" .'| 52 | 640 | 360 | 500 | 30 '."\n" .'| 53 | 360 | 640 | 500 | 15 '."\n" .'| 54 | 360 | 640 | 500 | 30 '."\n" .'| 60 | 1920 | 1080 | 4096 | 30'."\n" .'| 61 | 1080 | 1920 | 4096 | 30', ], 'DeleteAppStreamingOutTemplate' => [ 'summary' => '删除 RTC 3.0 应用推流模板。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'description' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'wv7N****', ], ], [ 'name' => 'StreamingOutTemplate', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '模版信息。', 'description' => '模板信息。', 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'title' => '模版ID', 'description' => '模板ID。', 'type' => 'string', 'required' => true, 'example' => 'xd4c****', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', '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"}]', 'title' => '删除推流模板', 'description' => '### 使用说明'."\n" .'本接口用于 RTC 3.0 的应用删除推流模板。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeAppStreamingOutTemplates' => [ 'summary' => '查询 RTC 3.0 应用下的推流模板列表。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'ioeh****', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'title' => '第几页，默认查询第1页。', 'description' => '第几页，默认查询第1页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页显示个数，默认为10。', 'description' => '每页显示个数，默认为10。', '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' => '模板ID。', 'type' => 'string', 'required' => false, 'example' => 'Bj6D****', ], 'Name' => [ 'title' => '模版名称', 'description' => '模板名称。', 'type' => 'string', 'required' => false, 'example' => '测试', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', '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' => '模板ID。', 'type' => 'string', 'example' => 'Bj6D****', ], 'Name' => [ 'title' => '模版名称', 'description' => '模板名称。', 'type' => 'string', 'example' => '模板名称', ], 'CreateTime' => [ 'title' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'description' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2020-09-04T06:22:15Z', ], 'MediaEncode' => [ 'title' => '编码选项。', 'description' => '编码选项。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'LayoutIds' => [ 'title' => '布局ID列表', 'description' => '布局ID列表。', 'type' => 'array', 'items' => [ 'title' => '具体的布局ID。', 'description' => '具体的布局ID。', '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"}]', 'title' => '查询推流模板列表', 'description' => '### 使用说明'."\n" .'本接口用于查看 RTC 3.0 的应用推流模板列表。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。', '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' => '任务ID。', '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' => '异常任务RTC会主动结束并通过回调通知给用户服务端，详见[回调](https://help.aliyun.com/document_detail/2709168.html?spm=a2c4g.11186623.help-menu-61399.d_2_0_0_0.49be1761tge4EX#6211464494udk)。'."\n" .'- 0: 任务已开启，等待用户加入'."\n" .'- 1：正在推流'."\n" .'- 2：推流异常，直播停止', '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"}]', 'title' => '查询旁路推流状态', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'StartStreamingOut' => [ 'summary' => '本接口用于开始旁路推流任务。', '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' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已存在的频道ID，仅支持传单个ID。', 'description' => '已存在的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'title' => '模版ID。', 'description' => '模版ID。', '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' => '本次旁路推流的任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节，不填，则由系统自动生成。', '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", 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边（默认值）。'."\n" .'- **3**：拉伸铺满。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '2', 'enum' => [ '1', '2', '3', ], ], ], [ 'name' => 'ReservePaneForNoCameraUser', 'in' => 'query', 'schema' => [ 'title' => '未推摄像头流用户窗格占位。'."\n" .'默认为true，表示用户未推摄像头流时保留一个窗格。'."\n" .'为false时，表示用户未推摄像头流时不保留窗格。', 'description' => '未推摄像头流用户窗格占位。'."\n" .'默认为true，表示用户未推摄像头流时保留一个窗格。'."\n" .'为false时，表示用户未推摄像头流时不保留窗格。', 'type' => 'boolean', 'required' => false, 'default' => 'true', ], ], [ 'name' => 'ShowDefaultBackgroundOnMute', 'in' => 'query', 'schema' => [ 'title' => 'mute时是否显示窗格默认底图。'."\n" .'- true: 显示（默认值）'."\n" .'- false: 不显示（设置的局部窗格底图依然显示）', 'description' => 'mute时是否显示窗格默认底图。'."\n" .'- true: 显示（默认值）'."\n" .'- false: 不显示（设置的局部窗格底图依然显示）', 'type' => 'boolean', 'required' => false, 'default' => 'true', ], ], [ 'name' => 'SubHighResolutionStream', 'in' => 'query', 'schema' => [ 'title' => '订阅高分辨率流。'."\n" .'- false：根据窗格面积订阅不同分辨率的流。（默认值）'."\n" .'- true：默认用客户端推的最高分辨率的流进行填充。', 'description' => '订阅高分辨率流。'."\n" .'- false：根据窗格面积订阅不同分辨率的流。（默认值）'."\n" .'- true：默认用客户端推的最高分辨率的流进行填充。', 'type' => 'boolean', 'required' => false, 'default' => 'false', ], ], [ 'name' => 'StartWithoutChannel', 'in' => 'query', 'schema' => [ 'title' => '是否允许频道不存在时开启任务。'."\n" ."\n" .'- true: 是'."\n" .'- false: 否（默认值）', 'description' => '是否允许频道不存在时开启任务。'."\n" ."\n" .'- true: 是'."\n" .'- false: 否（默认值）', 'type' => 'boolean', 'required' => false, 'default' => 'false', ], ], [ 'name' => 'StartWithoutChannelWaitTime', 'in' => 'query', 'schema' => [ 'title' => '当StartWithoutChannel参数为true的时候，设置该值才有意义，表示房间未开启时，任务等待时长，单位为秒，区间限制为[30,120]。', 'description' => '当StartWithoutChannel参数为true的时候，设置该值才有意义，表示房间未开启时，任务等待时长，单位为秒，区间限制为[30,120]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', ], ], [ 'name' => 'Annotation', 'in' => 'query', 'schema' => [ 'title' => '标注开关。', 'description' => '标注开关。', 'type' => 'string', 'required' => false, '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，摄像头优先', 'description' => 'SourceType为video时，填充顺序。'."\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' => '单元格媒体类型。取值：'."\n" .'- **video**：用户摄像头或者屏幕共享流（默认值）。'."\n" .'- **camera**：摄像头流。'."\n" .'- **screen**：共享屏幕流。'."\n" .'- **whiteboard**：白板。', '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' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', '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' => 'z轴层级。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', ], 'Url' => [ 'title' => '图片地址。', 'description' => '对应的图片内容在推流期间不支持更新。', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com/123xxx.jpg', ], 'Display' => [ 'title' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'description' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'type' => 'string', 'required' => false, '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, 'example' => '5', 'default' => '5', ], '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, ], 'Texture' => [ 'title' => '水印内容。', 'description' => '水印内容。', 'type' => 'string', 'required' => true, 'example' => '文字水印', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', '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' => '字体。'."\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', 'required' => false, 'example' => '0', 'default' => '0', ], '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.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', ], 'BoxAlpha' => [ 'title' => '矩形框透明度。', 'description' => '矩形框透明度。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.6', 'default' => '0.6', ], 'Display' => [ 'title' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'description' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'type' => 'string', 'required' => false, 'example' => 'backup', 'default' => 'streamOnly', 'enum' => [ 'streamOnly', 'backup', 'always', ], ], ], 'required' => false, ], 'required' => false, 'maxItems' => 3, ], 'PaneCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', '3', ], ], 'PaneId' => [ 'title' => '窗格ID，从0开始。', 'description' => '窗格ID，从0开始。', 'type' => 'string', 'required' => true, 'example' => '0', 'pattern' => '^\\d+$', 'enum' => [], ], 'Source' => [ 'title' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" .' - **$ActiveSpeaker**：当前频道发言人'."\n" .' - **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', 'description' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" ."\n" .'- **$ActiveSpeaker**：当前频道发言人'."\n" .'- **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', 'type' => 'string', 'required' => false, 'example' => '22', ], 'Backgrounds' => [ 'title' => '窗格局部背景图片。', 'description' => '局部背景图片', 'type' => 'array', 'items' => [ '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', ], 'PaneBackgroundCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', '3', ], ], 'Height' => [ 'description' => '高。', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.2', ], 'Width' => [ 'description' => '宽。', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.3', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', ], 'Url' => [ 'title' => '图片地址。', 'description' => '图片地址。', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com/123xx.jpg', ], 'Display' => [ 'title' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'description' => '显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'type' => 'string', 'required' => false, 'example' => 'backup', 'default' => 'streamOnly', 'enum' => [ 'streamOnly', 'backup', 'always', ], ], ], 'required' => false, ], 'required' => false, 'maxItems' => 3, ], 'Whiteboard' => [ 'title' => '白板设置。', 'description' => '白板配置。', 'type' => 'object', 'properties' => [ 'WhiteboardId' => [ 'title' => '白板ID。', 'description' => '白板ID，默认为default。', 'type' => 'string', 'required' => false, 'example' => 'default', 'default' => 'default', ], ], 'required' => false, ], 'ReservePaneForOfflineUser' => [ 'title' => '未入会用户窗格占位。'."\n" .'默认为true，表示宫格指定的具体用户或通配符用户离线时，窗格强制占位。'."\n" .'为false时，表示宫格指定的具体用户或通配符用户离线时，将按自动填充顺序显示视频流。', 'description' => '未入会用户窗格占位。'."\n" .'默认为true，表示宫格指定的具体用户或通配符用户离线时，窗格强制占位。'."\n" .'为false时，表示宫格指定的具体用户或通配符用户离线时，将按自动填充顺序显示视频流。', 'type' => 'boolean', 'required' => false, 'default' => 'true', ], ], 'required' => false, ], 'required' => false, 'example' => 'eo85****', 'maxItems' => 16, ], ], [ 'name' => 'Backgrounds', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'title' => '背景图片。', 'description' => '背景图片。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BackgroundCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', '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' => 'z轴层级。', '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' => [ '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' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', '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' => 'z轴层级。', '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, 'example' => '30', '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, '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' => 'z轴层级。', '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' => '字体。'."\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', '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' => [ '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' => 'z轴层级。', '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' => '字体。'."\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', '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' => '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' => 'LayoutSpecifiedUsers', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '黑白名单设置。', 'description' => '布局生成用户指定列表，包括黑/白名单两种。'."\n" ."\n" .'白名单，指定订阅房间里哪些用户视频流。'."\n" .'* 设置后自动填充根据该列表进行顺序填充'."\n" .'* 模版多布局切换时只计算白名单中的人'."\n" ."\n" .'黑名单，指定不订阅房间里哪些用户视频流。'."\n" .'* 模版多布局切换时只计算非黑名单中的人', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '用户名单类型，黑名单：black，白名单：white。', 'description' => '用户名单类型，黑名单：black，白名单：white。', 'type' => 'string', 'required' => true, 'example' => 'white', 'enum' => [ 'white', 'black', ], ], 'Ids' => [ 'title' => '指定用户ID列表。', 'description' => '指定用户ID列表。', 'type' => 'array', 'items' => [ 'title' => '具体用户ID。', 'description' => '具体用户ID。', 'type' => 'string', 'required' => true, 'example' => '123', ], 'required' => true, 'maxItems' => 16, 'minItems' => 1, ], ], 'required' => false, ], ], [ 'name' => 'SpecMixedUserList', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'title' => '指定需要被混音的用户列表。', 'description' => '指定需要被混音的用户列表。', 'type' => 'array', 'items' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => '456', ], 'required' => false, 'maxItems' => 25, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '本次旁路推流的任务ID。', 'description' => '本次旁路推流的任务ID。', 'type' => 'string', 'example' => '123', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', 'title' => '开始旁路推流任务', 'description' => '### 使用说明'."\n" .'本接口用于开始在线频道旁路推流任务。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'requestParamsDescription' => '>相关补充>'."\n" ."\n" .'局部图片水印数量、局部背景图片水印、全局图片水印数量和全局背景图数量的总和不能超过16。'."\n" ."\n" .'

'."\n" .'

高级水印层次说明

'."\n" .'RTC 媒体服务器 生成的画面会分成以下几个步骤：'."\n" ."\n" .'绘制视频 -> 绘制图片 -> 绘制文字'."\n" ."\n" .'视频、图片、文字是完全分开的，从整个画面来看 文字优先级 > 图片 > 视频 '."\n" .'1. 绘制视频：'."\n" .' 根据客户定义的布局对视频画面进行布局 '."\n" ."\n" .' a. 宫格中的图片和全局图片的layer统一排列。'."\n" ."\n" .' b. layer 0位于最底层，layer越大越位于上方，layer 的取值范围为[0,100] 。'."\n" ."\n" .'2. 绘制图片'."\n" .' 图片包括用户自定义的png/jpg图片。'."\n" ."\n" .' a. 根据用户配置宽高、位置、透明度等信息进行绘制。'."\n" ."\n" .' b. layer 0位于最底层，layer越大越位于上方，layer 的取值范围为[0,100] 。'."\n" ."\n" .'3. 绘制文字'."\n" .' 文字分为3个类型 ： 区域文字 全局文字和时间戳文字 。'."\n" ."\n" .' a. 同一类型文字根据layer顺序绘制，layer 0位于最底层，layer越大越位于上方，layer 的取值范围为[0,100] 。'."\n" ."\n" .' b. 不同类型文字优先级为 ： 时间戳文字 > 全局文字 > 区域文字 。处于重叠位置时，优先级较低的将被覆盖。'."\n" ."\n\n" .'重叠部分的显示：'."\n" .'1. 重叠部分，如果没有特别配置，高优先级将覆盖低优先级 。'."\n" .'2. 低优先级内容如果不想被高优先级内容覆盖，可以设置高优先级内容的透明度属性为0。'."\n" .'

', ], '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' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已存在的频道ID，仅支持传单个ID。', 'description' => '已存在的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'title' => '模版ID。', 'description' => '模版ID。'."\n" .'>更新模版ID，仅可以更新布局，不支持更新分辨率。>', 'type' => 'string', 'required' => true, 'example' => '567', 'maxLength' => 128, 'minLength' => 1, ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '本次旁路推流的任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', 'description' => '本次旁路推流的任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', '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' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', '3', ], ], ], [ 'name' => 'Panes', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'title' => '单元格设置，做多设置16个。', 'description' => '单元格设置，做多设置16个。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VideoOrder' => [ 'title' => 'SourceType为video时，填充顺序。'."\n" ."\n" .'- screenFirst，屏幕共享优先（默认值）'."\n" .'- cameraFirst，摄像头优先', 'description' => 'SourceType为video时，填充顺序。'."\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' => '单元格媒体类型。取值：'."\n" .'- **video**：用户摄像头或者屏幕共享流（默认值）。'."\n" .'- **camera**：摄像头流。'."\n" .'- **screen**：共享屏幕流。'."\n" .'- **whiteboard**：白板。', 'type' => 'string', 'required' => false, 'example' => 'video', 'default' => 'video', 'enum' => [ 'video', 'camera', 'screen', 'whiteboard', ], ], 'Images' => [ 'title' => '窗格局部图片水印。', 'description' => '窗格局部图片水印。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PaneImageCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', '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' => '横坐标。', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Y' => [ 'title' => '纵坐标。', 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Height' => [ 'title' => '高。', 'description' => '高。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Width' => [ 'title' => '宽。', 'description' => '宽。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', '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：总是显示。', 'description' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'type' => 'string', 'required' => false, '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' => [ 'title' => 'R。', 'description' => 'R。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], 'B' => [ 'title' => 'B。', 'description' => 'B。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], 'G' => [ 'title' => 'G。', 'description' => 'G。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], ], 'required' => false, ], 'Texture' => [ 'title' => '水印内容。', 'description' => '水印内容。', 'type' => 'string', 'required' => true, 'example' => '文字水印', 'maxLength' => 128, 'minLength' => 1, ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', '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' => '字体。'."\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', 'required' => false, 'maximum' => '9', 'minimum' => '0', 'example' => '0', 'default' => '0', ], 'BoxColor' => [ 'title' => '矩形框颜色。', 'description' => '矩形框颜色。', 'type' => 'object', 'properties' => [ 'R' => [ 'title' => 'R。', 'description' => 'R。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], 'B' => [ 'title' => 'B。', 'description' => 'B。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], 'G' => [ 'title' => 'G。', 'description' => 'G。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], ], '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' => [ 'title' => '横坐标。', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '0.2', ], 'HasBox' => [ 'title' => '是否需要矩形框。', 'description' => '是否需要矩形框。', 'type' => 'boolean', 'required' => false, 'default' => 'false', ], 'Y' => [ 'title' => '纵坐标。', 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '0.2', ], '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：总是显示。', 'description' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'type' => 'string', 'required' => false, 'example' => 'always', 'default' => 'streamOnly', 'enum' => [ 'streamOnly', 'backup', 'always', ], ], ], 'required' => false, ], 'required' => false, 'maxItems' => 3, ], 'PaneCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', '3', ], ], 'PaneId' => [ 'title' => '布局ID。', 'description' => '布局ID。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '15', 'minimum' => '0', 'example' => '1', ], 'Source' => [ 'title' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" .' - **$ActiveSpeaker**：当前频道发言人'."\n" .' - **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', 'description' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" ."\n" .'- **$ActiveSpeaker**：当前频道发言人'."\n" .'- **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', 'type' => 'string', 'required' => false, 'example' => '22', ], 'Backgrounds' => [ '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' => '', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Y' => [ 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.95', ], 'PaneBackgroundCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'enum' => [ '1', '2', '3', ], ], 'Height' => [ 'description' => '高。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.79', ], 'Width' => [ 'description' => '宽。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.3', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '1', 'default' => '0', ], 'Url' => [ 'title' => '图片地址。', 'description' => '图片地址。', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com/123xx.jpg', 'maxLength' => 1024, 'minLength' => 1, ], 'Display' => [ 'title' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'description' => '水印显示时机。'."\n" .'- streamOnly：当前用户有视频流时显示（默认值）。'."\n" .'- backup：当前用户无视频流时显示。'."\n" .'- always：总是显示。', 'type' => 'string', 'required' => false, 'example' => 'backup', 'default' => 'streamOnly', 'enum' => [ 'streamOnly', 'backup', 'always', ], ], ], 'required' => false, ], 'required' => false, 'maxItems' => 3, ], 'Whiteboard' => [ 'title' => '白板设置。', 'description' => '白板配置。', 'type' => 'object', 'properties' => [ 'WhiteboardId' => [ 'title' => '白板ID。', 'description' => '白板ID，默认为default。', 'type' => 'string', 'required' => false, 'example' => 'default', 'default' => 'default', ], ], 'required' => false, ], 'ReservePaneForOfflineUser' => [ 'title' => '未入会用户窗格占位。'."\n" .'默认为true，表示宫格指定的具体用户或通配符用户离线时，窗格强制占位。'."\n" .'为false时，表示宫格指定的具体用户或通配符用户离线时，将按自动填充顺序显示视频流。', 'description' => '未入会用户窗格占位。'."\n" .'默认为true，表示宫格指定的具体用户或通配符用户离线时，窗格强制占位。'."\n" .'为false时，表示宫格指定的具体用户或通配符用户离线时，将按自动填充顺序显示视频流。', 'type' => 'boolean', 'required' => false, 'default' => 'true', ], ], 'required' => false, ], 'required' => false, 'example' => '2', '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' => '横坐标。', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Y' => [ 'title' => '纵坐标。', 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Height' => [ 'title' => '高。', 'description' => '高。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'ImageCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', '3', ], ], 'Width' => [ 'title' => '宽。', 'description' => '宽。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', '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' => '背景图片。', 'description' => '背景图片。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BackgroundCropMode' => [ 'title' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'description' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', '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' => '横坐标。', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Y' => [ 'title' => '纵坐标。', 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Height' => [ 'title' => '高。', 'description' => '高。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Width' => [ 'title' => '宽。', 'description' => '宽。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', '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' => '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' => [ 'title' => 'R。', 'description' => 'R。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], 'B' => [ 'title' => 'B。', 'description' => 'B。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], 'G' => [ 'title' => 'G。', 'description' => 'G。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], ], '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' => [ 'title' => 'R。', 'description' => 'R。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], 'B' => [ 'title' => 'B。', 'description' => 'B。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], 'G' => [ 'title' => 'G。', 'description' => 'G。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], ], 'required' => false, ], 'X' => [ 'title' => '横坐标。', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '0.2', ], 'HasBox' => [ 'title' => '是否需要矩形框。', 'description' => '是否需要矩形框。', 'type' => 'boolean', 'required' => false, 'default' => 'false', ], 'Y' => [ 'title' => '纵坐标。', 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '0.2', ], 'Texture' => [ 'title' => '水印内容。', 'description' => '水印内容。', 'type' => 'string', 'required' => true, 'example' => '文字水印', 'maxLength' => 128, 'minLength' => 1, ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', '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' => '字体。'."\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', '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' => [ 'title' => 'R。', 'description' => 'R。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], 'B' => [ 'title' => 'B。', 'description' => 'B。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], 'G' => [ 'title' => 'G。', 'description' => 'G。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '30', ], ], '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' => [ 'title' => 'R。', 'description' => 'R。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], 'B' => [ 'title' => 'B。', 'description' => 'B。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], 'G' => [ 'title' => 'G。', 'description' => 'G。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '255', 'default' => '255', ], ], 'required' => false, ], 'X' => [ 'title' => '横坐标。', 'description' => '横坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '0.2', ], 'HasBox' => [ 'title' => '是否需要矩形框。', 'description' => '是否需要矩形框。', 'type' => 'boolean', 'required' => false, 'default' => 'false', ], 'Y' => [ 'title' => '纵坐标。', 'description' => '纵坐标。', 'type' => 'number', 'format' => 'double', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '0.2', ], 'Layer' => [ 'title' => 'z轴层级。', 'description' => 'z轴层级。', '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' => '字体。'."\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', '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' => '全局框格底色', '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' => '-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' => 'LayoutSpecifiedUsers', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '黑白名单设置。', 'description' => '布局生成用户指定列表，包括黑/白名单两种。'."\n" ."\n" .'白名单，指定订阅房间里哪些用户视频流。'."\n" .'* 设置后自动填充根据该列表进行顺序填充'."\n" .'* 模版多布局切换时只计算白名单中的人'."\n" ."\n" .'黑名单，指定不订阅房间里哪些用户视频流。'."\n" .'* 模版多布局切换时只计算非黑名单中的人', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '用户名单类型，黑名单：black，白名单：white。', 'description' => '用户名单类型，黑名单：black，白名单：white。', 'type' => 'string', 'required' => true, 'example' => 'white', 'enum' => [ 'white', 'black', ], ], 'Ids' => [ 'title' => '指定用户ID列表。', 'description' => '指定用户ID列表。', 'type' => 'array', 'items' => [ 'title' => '具体用户ID。', 'description' => '具体用户ID。', 'type' => 'string', 'required' => true, 'example' => '123', ], 'required' => true, 'maxItems' => 16, 'minItems' => 1, ], ], 'required' => false, ], ], [ 'name' => 'SpecMixedUserList', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'title' => '指定需要被混音的用户列表。', 'description' => '指定需要被混音的用户列表。', 'type' => 'array', 'items' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'required' => false, ], 'required' => false, 'maxItems' => 25, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'result', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '本次旁路推流的任务ID。', 'description' => '本次旁路推流的任务ID。', 'type' => 'string', 'example' => '123', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', 'title' => '更新旁路推流任务', 'description' => '### 使用说明'."\n" .'本接口用于更新在线频道旁路推流任务。'."\n" ."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'requestParamsDescription' => '>相关补充>'."\n" ."\n" .'局部图片水印数量、局部背景图片水印、全局图片水印数量和全局背景图数量的总和不能超过16。'."\n" ."\n" .'

'."\n" .'

高级水印层次说明

'."\n" .'RTC 媒体服务器 生成的画面会分成以下几个步骤：'."\n" ."\n" .'绘制视频 -> 绘制图片 -> 绘制文字'."\n" ."\n" .'视频、图片、文字是完全分开的，从整个画面来看 文字优先级 > 图片 > 视频 '."\n" .'1. 绘制视频：'."\n" .' 根据客户定义的布局对视频画面进行布局 '."\n" ."\n" .' a. 宫格中的图片和全局图片的layer统一排列。'."\n" ."\n" .' b. layer 0位于最底层，layer越大越位于上方，layer 的取值范围为[0,100] 。'."\n" ."\n" .'2. 绘制图片'."\n" .' 图片包括用户自定义的png/jpg图片。'."\n" ."\n" .' a. 根据用户配置宽高、位置、透明度等信息进行绘制。'."\n" ."\n" .' b. layer 0位于最底层，layer越大越位于上方，layer 的取值范围为[0,100] 。'."\n" ."\n" .'3. 绘制文字'."\n" .' 文字分为3个类型 ： 区域文字 全局文字和时间戳文字 。'."\n" ."\n" .' a. 同一类型文字根据layer顺序绘制，layer 0位于最底层，layer越大越位于上方，layer 的取值范围为[0,100] 。'."\n" ."\n" .' b. 不同类型文字优先级为 ： 时间戳文字 > 全局文字 > 区域文字 。处于重叠位置时，优先级较低的将被覆盖。'."\n" ."\n\n" .'重叠部分的显示：'."\n" .'1. 重叠部分，如果没有特别配置，高优先级将覆盖低优先级 。'."\n" .'2. 低优先级内容如果不想被高优先级内容覆盖，可以设置高优先级内容的透明度属性为0。'."\n" .'

', ], 'StopStreamingOut' => [ 'summary' => '本接口用于停止旁路推流任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已存在的频道ID，仅支持传单个ID。', 'description' => '已存在的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '已存在的旁路推流的任务ID，仅支持传单个ID。', 'description' => '已存在的旁路推流的任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。不填，则由系统自动生成。', 'type' => 'string', 'required' => true, 'example' => '123', 'maxLength' => 55, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '本次旁路推流的任务ID。', 'description' => '本次旁路推流的任务ID。', 'type' => 'string', 'example' => '123', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '停止旁路推流任务', 'description' => '### 使用说明'."\n" .'本接口用于停止在线频道旁路推流任务。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '热词表名称。UTF-8 编码，长度范围[1,30]', 'type' => 'string', 'required' => true, 'example' => '水果', 'maxLength' => 30, 'minLength' => 1, ], 'Description' => [ 'title' => '描述。UTF-8编码，长度[1,200]。', 'description' => '描述。UTF-8编码，长度[1,200]。', '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' => '每个词表最多包含300个热词，每个热词中文长度不超过10个字符。'."\n" ."\n" .'热词必须为UTF-8编码，不能包含标点、特殊字符，不符合的情况下，无热词效果。'."\n" ."\n" .'热词对应的权重取值范围为[-6,5]之间的整数。'."\n" ."\n" .'文本中的数字需要按照发音替换为对应的汉字。例如：“59.9元”需要替换为“五十九点九元”。', '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' => '权重取值范围为[-6,5]之间的整数。'."\n" .'- 取值大于0会增大该词语被识别的概率，小于0会减小该词语被识别的概率。'."\n" .'- 取值为-6：表示尽量不要识别出该词语。'."\n" .'- 取值为2：常用值。'."\n" .'如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。', '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' => '热词表ID。', '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"}]', 'title' => '创建热词表', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'ac7N****', ], ], [ 'name' => 'Phrase', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '热词参数。', 'description' => '热词参数。', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '热词表ID。', 'description' => '热词表ID。', 'type' => 'string', 'required' => true, 'example' => '1qasw23ezcsrfsawq', ], 'Name' => [ 'title' => '热词表名称。UTF-8 编码，长度范围[1,30]', 'description' => '热词表名称。UTF-8 编码，长度范围[1,30]', 'type' => 'string', 'required' => true, 'example' => '水果', 'maxLength' => 30, 'minLength' => 1, ], 'Description' => [ 'title' => '描述。UTF-8编码，长度[1,200]。', 'description' => '描述。UTF-8编码，长度[1,200]。', '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' => '每个词表最多包含300个热词，每个热词中文长度不超过10个字符，英文不超过5个单词。'."\n" ."\n" .'热词必须为UTF-8编码，不能包含标点、特殊字符，不符合的情况下，无热词效果。'."\n" ."\n" .'热词对应的权重取值范围为[-6,5]之间的整数。'."\n" ."\n" .'文本中的数字需要按照发音替换为对应的汉字。例如：“59.9元”需要替换为“五十九点九元”。', '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' => '权重取值范围为[-6,5]之间的整数。'."\n" .'- 取值大于0会增大该词语被识别的概率，小于0会减小该词语被识别的概率。'."\n" .'- 取值为-6：表示尽量不要识别出该词语。'."\n" .'- 取值为2：常用值。'."\n" .'如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。', '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' => '热词表ID。', '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"}]', 'title' => '修改热词表', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'ac7N****', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'title' => '第几页，默认查询第1页。', 'description' => '第几页，默认查询第1页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页显示个数，默认为10。', 'description' => '每页显示个数，默认为10。', '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' => '热词表ID。', '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' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2025-03-04T06:22:15Z', ], 'Id' => [ 'title' => '热词表ID。', 'description' => '热词表ID。', '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"}]', 'title' => '热词表列表', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'ac7N****', ], ], [ 'name' => 'Phrase', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '热词表参数。', 'description' => '热词表参数。', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '热词表ID。', 'description' => '热词表ID。', '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' => '热词表ID。', '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"}]', 'title' => '删除热词表', ], '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' => '应用ID。', 'type' => 'string', 'required' => true, 'example' => '2ws***z3', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '频道ID。', 'description' => '频道ID。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务ID。', 'description' => '任务ID。', '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' => '存储平台。取值：'."\n" ."\n" .'| vendor | 对象存储产品 | 备注 |'."\n" .'|--------|---------|---------|'."\n" .'| 1 | AliYun OSS | 阿里云 |', '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' => '存储地域。'."\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 |', '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' => '频道使用的源语言模型。'."\n" .'- cn 中文'."\n" .'- yue 粤语'."\n" .'- en 英文'."\n" .'- multilingual 多语种'."\n" .'- ja 日语'."\n" .'- ko 韩语'."\n" .'- de 德语'."\n" .'- fr 法语'."\n" .'- ru 俄语'."\n" .'- es 西班牙语'."\n" .'- vi 越南语'."\n" .'- it 意大利语'."\n" .'- sv 瑞典语'."\n" .'- cs 捷克语'."\n" .'- pl 波兰语'."\n" .'- th 泰语'."\n" .'- fi 芬兰语'."\n" .'- hi 印地语'."\n" .'- id 印尼语(印度尼西亚)'."\n" .'- pt 葡萄牙语'."\n" .'- ar 阿拉伯语'."\n" .'- fil 菲律宾语'."\n" .'- ms 马来语'."\n" .'- tr 土耳其语'."\n" .'- hu 匈牙利语'."\n" .'- lo 老挝语'."\n" .'- pt-br 葡萄牙语(巴西)'."\n" .'- es-ar 西班牙语(阿根廷)'."\n" .'- es-mx 西班牙语(墨西哥)', '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' => '语音中非单语种，但是已知语种的范围是确定的，直接识别对应语种，避免识别错误。源语言的值是multilingual的情况下，辅助提高识别语言精确度。', 'type' => 'array', 'items' => [ 'description' => '- cn 中文'."\n" .'- en 英文'."\n" .'- ja 日语'."\n" .'- ko 韩语'."\n" .'- de 德语'."\n" .'- fr 法语'."\n" .'- ru 俄语'."\n" .'- es 西班牙语'."\n" .'- vi 越南语'."\n" .'- it 意大利语'."\n" .'- sv 瑞典语'."\n" .'- cs 捷克语'."\n" .'- pl 波兰语'."\n" .'- th 泰语'."\n" .'- fi 芬兰语'."\n" .'- hi 印地语'."\n" .'- id 印尼语(印度尼西亚)'."\n" .'- pt 葡萄牙语'."\n" .'- ar 阿拉伯语'."\n" .'- fil 菲律宾语'."\n" .'- ms 马来语'."\n" .'- tr 土耳其语'."\n" .'- hu 匈牙利语'."\n" .'- lo 老挝语'."\n" .'- pt-br 葡萄牙语(巴西)'."\n" .'- es-ar 西班牙语(阿根廷)'."\n" .'- es-mx 西班牙语(墨西哥)', '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' => '转写功能，默认开启。', 'description' => '转写功能，默认开启。', 'type' => 'object', 'properties' => [ 'DiarizationEnabled' => [ 'title' => '是否开启说话人分离功能。', 'description' => '是否开启说话人分离功能。', 'type' => 'boolean', 'required' => false, 'default' => 'false', ], 'SpeakerCount' => [ 'title' => '设置说话人分离参数，默认0。'."\n" .'0：说话人角色区分结果为不定人数。'."\n" .'2：说话人角色区分结果为 2 人。', 'description' => '设置说话人分离参数，默认0。'."\n" .'0：说话人角色区分结果为不定人数。'."\n" .'2：说话人角色区分结果为 2 人。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '0', 'enum' => [ '0', '2', ], ], 'TranscriptionLevel' => [ 'title' => '语音识别结果返回等级，默认2。'."\n" .'1：识别出完整句子时返回识别结果；'."\n" .'2：识别出中间结果及完整句子时返回识别结果；', 'description' => '语音识别结果返回等级，默认2。'."\n" .'1：识别出完整句子时返回识别结果；'."\n" .'2：识别出中间结果及完整句子时返回识别结果；', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '2', 'enum' => [ '1', '2', ], ], 'PhraseId' => [ 'title' => '热词表ID。', 'description' => '热词表ID。', 'type' => 'string', 'required' => false, 'example' => 'b27cb31b8ca24c5b8e664e0387bac573', 'maxLength' => 50, 'minLength' => 1, ], ], 'required' => false, ], ], [ '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' => '具体算法。'."\n" ."\n" .'Actions：待办事项。'."\n" ."\n" .'KeyInformation：关键信息(含关键词和重点内容)。', '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' => '开启摘要功能时，需传入期望的摘要类型。'."\n" ."\n" .'Paragraph：全文摘要 '."\n" ."\n" .'Conversational：发言人总结摘要 '."\n" ."\n" .'QuestionsAnswering：问答回顾摘要', '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' => '自定义Prompt控制参数对象。', 'type' => 'object', 'properties' => [ 'Enabled' => [ 'title' => '是否开启。', 'description' => '是否开启。', 'type' => 'boolean', 'required' => false, 'default' => 'false', ], 'CustomPromptContents' => [ 'title' => '自定义Prompt的参数列表。', 'description' => '自定义Prompt的参数列表。', 'type' => 'array', 'items' => [ 'title' => '具体Prompt。', 'description' => '具体Prompt。', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => 'Prompt的自定义名称，用于匹配输出结果。', 'description' => 'Prompt的自定义名称，用于匹配输出结果。', 'type' => 'string', 'required' => true, 'example' => 'split-summary-demo', ], 'Prompt' => [ 'title' => 'Prompt的自定义内容，需要包含{Transcription}标签，{Transcription}会被自动替换为语音转写结果来作为模型输入。', 'description' => 'Prompt的自定义内容，需要包含{Transcription}标签，{Transcription}会被自动替换为语音转写结果来作为模型输入。', 'type' => 'string', 'required' => true, 'example' => '请帮我将下面的对话进行总结，根据发言人来总结:\\n {Transcription}', ], 'Model' => [ 'title' => '指定Prompt的模型，目前可选择tingwu-turbo、tingwu-plus和qwen-max。如果不填写该参数，会默认设置为tingwu-turbo。', 'description' => '指定Prompt的模型，目前可选择tingwu-turbo、tingwu-plus和qwen-max。如果不填写该参数，会默认设置为tingwu-turbo。', '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' => '指定{Transcription}标签格式，目前可选chat和default。'."\n" ."\n" .'chat: 转写结果包含发言人信息。'."\n" ."\n" .'default: 转写结果为纯文本格式。', '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' => '实时字幕。', 'description' => '实时字幕。', 'type' => 'object', 'properties' => [ 'AsrCallback' => [ 'title' => '是否开启服务端回调。', 'description' => '是否同时回传给服务端。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'Enabled' => [ 'title' => '是否开启。', 'description' => '是否开启。', 'type' => 'boolean', 'required' => false, 'default' => 'false', ], 'Translation' => [ 'title' => '翻译参数，具体翻译目标语言可以通过SDK设置。', 'description' => '翻译参数，具体翻译目标语言可以通过SDK设置。', 'type' => 'object', 'properties' => [ 'TranslateLevel' => [ 'title' => '翻译文本输出等级 ，默认2。'."\n" ."\n" .'1: 识别完整句子时返回结果。'."\n" ."\n" .'2: 识别中间结果及完整句子时返回结果。', 'description' => '翻译文本输出等级 ，默认2。'."\n" ."\n" .'1: 识别完整句子时返回结果。'."\n" ."\n" .'2: 识别中间结果及完整句子时返回结果。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '2', 'enum' => [ '1', '2', ], ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'result', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '本次任务ID。', 'description' => '本次任务ID。', 'type' => 'string', 'example' => '123', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', 'title' => '开始纪要任务', 'description' => '### 使用说明'."\n" .'本接口用于开始在线频道的纪要任务。如果需要纪要和字幕，建议把所有功能都启用。'."\n" ."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" ."\n\n" .'> 并发限制'."\n" .'> - 同一频道同时只允许一个纪要任务存在。'."\n" .'> - 同一频道可以多次发起开启和停止纪要任务，但是每次TaskId需要不同。', ], '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, 'example' => '53200b81-b761-4c10-842a-a0726d97xxxx', ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '应用ID。', 'description' => '应用ID。', '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' => '任务ID。', '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' => '本次任务ID。', 'type' => 'string', 'example' => '123', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', 'title' => '停止纪要任务', 'description' => '### 使用说明'."\n" .'本接口用于停止在线频道的纪要任务。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '频道ID。', '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' => '查询范围，任务开始时间开区间，单位：ms。如果不传，默认查询3天内，最长查询过去一年的录制文件。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1712376032000', ], ], [ 'name' => 'EndTs', 'in' => 'query', 'schema' => [ 'title' => '查询范围，任务开始时间闭区间，单位：ms。', 'description' => '查询范围，任务开始时间闭区间，单位：ms。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1712376532000', ], ], [ 'name' => 'TaskIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '任务TaskId列表。', 'description' => '任务TaskId列表。', 'type' => 'array', 'items' => [ 'title' => '具体任务ID。', 'description' => '具体任务ID。', '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' => '频道ID。', 'type' => 'string', 'example' => 'testchannelId', ], 'TaskId' => [ 'title' => '任务ID。', 'description' => '任务ID。', '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' => '自定义prompt结果文件存放路径。', 'type' => 'string', 'example' => 'cloudNote/ksvxxppi/88_12/customPrompt_1724914365173.json', ], 'Vendor' => [ 'title' => '参考开启任务vendor。', 'description' => '参考开启任务vendor。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Region' => [ 'title' => '参考任务region。', 'description' => '参考任务region。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Bucket' => [ 'title' => '用户自定义的bucket。', 'description' => '用户自定义的bucket。', '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"}]', 'title' => '纪要文件列表', 'description' => '### 使用说明'."\n" .'本接口用于查询有纪要结果的纪要任务文件列表。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'responseParamsDescription' => '纪要结果文件格式内容请参考[回调页面](https://help.aliyun.com/document_detail/2709168.html#e1a04a3879sbk)。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '开关状态；enable-开启 disable-关闭。', '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"}]', 'title' => '查询智能体功能开关', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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"}]', 'title' => '修改智能体功能开关', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'ac7N****', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '模版ID。', 'description' => '模版ID。', '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' => '智能体类型：'."\n" .'- 1: 语音通话（默认）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', 'enum' => [ '1', ], ], ], [ 'name' => 'ChatMode', 'in' => 'query', 'schema' => [ 'title' => '对话模式：'."\n" .'- 1: 自然对话模式（默认）'."\n" .'- 2: 对讲机模式', 'description' => '对话模式：'."\n" .'- 1: 自然对话模式（默认）'."\n" .'- 2: 对讲机模式', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '1', 'enum' => [ '1', '2', ], ], ], [ 'name' => 'InterruptMode', 'in' => 'query', 'schema' => [ 'title' => '打断方式：'."\n" .'- 1: 支持打断（默认）'."\n" .'- 2: 禁止打断', 'description' => '打断方式：'."\n" .'- 1: 支持打断（默认）'."\n" .'- 2: 禁止打断', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '1', 'enum' => [ '1', '2', ], ], ], [ 'name' => 'Greeting', 'in' => 'query', 'schema' => [ 'title' => '问候语，最大长度不超过500。', 'description' => '问候语，最大长度不超过500。', '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' => '热词ID。', 'type' => 'string', 'required' => false, 'example' => '0bb1776b1745123332074d1b6b', 'maxLength' => 100, ], 'WordWeights' => [ 'title' => '每个词表最多包含500个热词，每个热词中文长度不超过10个字符。'."\n" .'热词必须为UTF-8编码，不能包含标点、特殊字符，不符合的情况下，无热词效果。', 'description' => '每个词表最多包含500个热词，每个热词中文长度不超过10个字符。'."\n" .'热词必须为UTF-8编码，不能包含标点、特殊字符，不符合的情况下，无热词效果。', 'type' => 'array', 'items' => [ 'title' => '热词权重。', 'description' => '热词权重。', 'type' => 'object', 'properties' => [ 'Word' => [ 'title' => '热词文本，每个词语最长10个汉字或英文单词。', 'description' => '热词文本，每个词语最长10个汉字或英文单词。', 'type' => 'string', 'required' => true, 'example' => '苹果', ], 'Lang' => [ 'title' => '语言代码。可不写，大模型会自动设别。'."\n" .'- zh: 中文'."\n" .'- en: 英文', 'description' => '语言代码。可不写，大模型会自动设别。'."\n" .'- zh: 中文'."\n" .'- en: 英文', 'type' => 'string', 'required' => false, 'example' => 'zh', ], 'Weight' => [ 'title' => '热词权重，取值范围为[1, 5]之间的整数。'."\n" .'常用值：4。'."\n" .'如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。', 'description' => '热词权重，取值范围为[1, 5]之间的整数。'."\n" .'常用值：4。'."\n" .'如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '4', 'default' => '4', ], ], 'required' => true, ], 'required' => false, ], 'MaxSentenceSilence' => [ 'title' => '语音断句检测阈值，默认500ms，允许范围[200，6000]。如果设置VadConfig，建议该值大于VadConfig.interruptSpeechDuration，小于1500ms。', 'description' => '语音断句检测阈值，默认500ms，允许范围[200，6000]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '500', 'default' => '500', ], 'VadConfig' => [ 'title' => 'vad配置。', 'description' => 'vad配置。', 'type' => 'object', 'properties' => [ 'InterruptSpeechDuration' => [ 'title' => '人声持续阈值 (ms)，取值范围为[0,3000]。持续检测到人声信号的最小时间长度，避免误打断。默认300ms', 'description' => '人声持续阈值 (ms)，取值范围为[0,3000]。持续检测到人声信号的最小时间长度，避免误打断。默认300ms', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3000', 'minimum' => '0', 'example' => '1000', 'default' => '300', ], ], 'required' => false, ], ], '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' => '提供方，目前支持阿里云-百炼和第三方配置（符合OpenAI接口规范）。', 'type' => 'string', 'required' => false, 'example' => 'thirdparty', 'default' => 'aliyun', 'enum' => [ 'aliyun', 'thirdparty', ], ], 'Url' => [ 'title' => '接入第三方大模型时，该字段表示接入的endpoint。', 'description' => '接入第三方大模型时，该字段表示接入的endpoint。', 'type' => 'string', 'required' => false, 'example' => 'https://llm.example.aliyuns.com', 'maxLength' => 100, ], 'ApiKey' => [ 'title' => '大模型服务商需要的apikey。', 'description' => '大模型服务商需要的apikey。', 'type' => 'string', 'required' => true, 'example' => 'ak-1213123123132123131', 'maxLength' => 200, 'minLength' => 1, ], 'Temperature' => [ 'title' => '采样温度，取值范围[0,2)，默认值0.7。', 'description' => '采样温度，取值范围[0,2)，默认值0.7。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7', 'default' => '0.7', ], 'TopP' => [ 'title' => '采样的选择范围(0,1]，默认值0.8', 'description' => '采样的选择范围(0,1]，默认值0.8', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.8', 'default' => '0.8', ], 'MaxToken' => [ 'title' => '输出文本的最大限制，默认值8192。', 'description' => '输出文本的最大限制，默认值8192。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'default' => '8192', ], 'HistoryDepth' => [ 'title' => '给大模型提供多少历史对话轮次，最大100，默认值3。', 'description' => '给大模型提供多少历史对话轮次，最大100，默认值50。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'default' => '50', ], 'Prompt' => [ 'title' => '大模型提示词，最大长度为5000。', 'description' => '大模型提示词，最大长度为5000。', 'type' => 'string', 'required' => false, 'example' => '你好，小叮当', ], 'AgentAppId' => [ 'title' => '百炼智能体ID。', 'description' => '百炼智能体ID。', 'type' => 'string', 'required' => false, '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', 'customized', 'dingmaas', ], ], 'ApiKey' => [ 'title' => '大模型服务商需要的apikey。', 'description' => '大模型服务商需要的apikey。', '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' => '音色，默认音色是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', 'type' => 'string', 'required' => false, 'example' => 'longwan', 'default' => 'longxiaoxia', ], 'Volume' => [ 'title' => '音量，取值范围[0~100]，默认50。', 'description' => '音量，取值范围[0~100]，默认50。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'default' => '50', ], 'Rate' => [ 'title' => '语速，取值范围[0.5~2.0]，默认1.0。', 'description' => '语速，取值范围[0.5~2.0]，默认1.0。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.8', 'default' => '1.0', ], 'Pitch' => [ 'title' => '音调，取值范围[0.5~2.0]，默认1.0。', 'description' => '音调，取值范围[0.5~2.0]，默认1.0。', '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' => '过滤设置。'."\n" .'- 1-中文刮号（）'."\n" .'- 2-英文刮号()'."\n" .'- 3-中文方刮号【】'."\n" .'- 4-英文方刮号[]'."\n" .'- 5-英文花刮号{}', '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' => '智能体静默配置。', 'description' => '智能体静默配置。', 'type' => 'object', 'properties' => [ 'AlertTimeout' => [ 'title' => '静默提醒的超时时间（单位：秒）。'."\n" .'可能多次触发，若智能体静默提醒超时后依然静默，则再超时还会继续触发，取值范围：[5, 600]，默认值0，0表示不提醒', 'description' => '静默提醒的超时时间（单位：秒）。'."\n" .'可能多次触发，若智能体静默提醒超时后依然静默，则再超时还会继续触发，取值范围：[5, 600]，默认值0，0表示不提醒', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '0', ], 'WebhookTriggerTimeout' => [ 'title' => '触发智能体静默超时webhook的静默超时时间（单位：秒）。可能多次触发，若智能体webhook静默超时后依然静默，则再超时还会继续触发，取值范围：[10, 600]，默认值0，0表示不触发', 'description' => '触发智能体静默超时webhook的静默超时时间（单位：秒）。可能多次触发，若智能体webhook静默超时后依然静默，则再超时还会继续触发，取值范围：[10, 600]，默认值0，0表示不触发', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '0', ], 'Strategy' => [ 'title' => '静默超时处理策略。'."\n" .'1 - 向用户语音播报content指定的提示消息'."\n" .'2 - 把content指定的提示消息和历史对话发送给LLM，并播报模型生成的回复'."\n" .'默认值：1', 'description' => '静默超时处理策略。'."\n" .'1 - 向用户语音播报content指定的提示消息'."\n" .'2 - 把content指定的提示消息和历史对话发送给LLM，并播报模型生成的回复'."\n" .'默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '1', 'example' => '2', 'default' => '1', ], 'Content' => [ 'title' => '静默提示消息的内容。', 'description' => '静默提示消息的内容。', 'type' => 'string', 'required' => false, 'maxLength' => 2500, ], ], 'required' => false, ], ], [ 'name' => 'AmbientSoundConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '智能体环境音配置。不传表示不使用环境配置。', 'description' => '智能体环境音配置。不传表示不使用环境配置。', 'type' => 'object', 'properties' => [ 'SoundId' => [ 'title' => 'agent提供以下默认环境音：'."\n" .' - white_noise '."\n" .' - office', 'description' => 'agent提供以下默认环境音：'."\n" .' - white_noise '."\n" .' - office', 'type' => 'string', 'required' => false, 'example' => 'white_noise', 'maxLength' => 30, ], 'Volume' => [ 'title' => '音量大小。', 'description' => '音量大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '100', ], ], 'required' => false, ], ], [ 'name' => 'InterruptConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '智能体打断配置。', 'description' => '智能体打断配置。', 'type' => 'object', 'properties' => [ 'SemanticsInterrupt' => [ 'title' => '按语义打断。', 'description' => '按语义打断。', 'type' => 'boolean', 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'BackChannelConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '智能体承接词配置。', 'description' => '智能体承接词配置。', 'type' => 'object', 'properties' => [ 'UserTurnEnd' => [ 'title' => '是否开启承接词。', 'description' => '是否开启承接词。', 'type' => 'boolean', 'required' => false, ], ], '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' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', ], 'Id' => [ 'title' => '模版ID。', 'description' => '模版ID。', '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"}]', 'title' => '修改智能体模板', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '模版ID。', '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' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2020-09-04T06:22:15Z', ], 'AgentSilenceConfig' => [ 'title' => '智能体静默配置。', 'description' => '智能体静默配置。', 'type' => 'object', 'properties' => [ 'Content' => [ 'title' => '静默提示消息的内容。', 'description' => '静默提示消息的内容。', 'type' => 'string', 'example' => '你好，还在吗？', ], 'WebhookTriggerTimeout' => [ 'title' => '触发智能体静默超时webhook的静默超时时间（单位：秒）。可能多次触发，若智能体webhook静默超时后依然静默，则再超时还会继续触发。', 'description' => '触发智能体静默超时webhook的静默超时时间（单位：秒）。可能多次触发，若智能体webhook静默超时后依然静默，则再超时还会继续触发。', 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'Strategy' => [ 'title' => '静默超时处理策略。'."\n" .'1 - 向用户语音播报content指定的提示消息'."\n" .'2 - 把content指定的提示消息和历史对话发送给LLM，并播报模型生成的回复'."\n", 'description' => '静默超时处理策略。'."\n" .'1 - 向用户语音播报content指定的提示消息'."\n" .'2 - 把content指定的提示消息和历史对话发送给LLM，并播报模型生成的回复'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AlertTimeout' => [ 'title' => '静默提醒的超时时间（单位：秒）。'."\n" .'可能多次触发，若智能体静默提醒超时后依然静默，则再超时还会继续触发。', 'description' => '静默提醒的超时时间（单位：秒）。'."\n" .'可能多次触发，若智能体静默提醒超时后依然静默，则再超时还会继续触发。', 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], ], ], 'AmbientSoundConfig' => [ 'title' => '环境音配置。', 'description' => '环境音配置。', 'type' => 'object', 'properties' => [ 'SoundId' => [ 'title' => '环境音ID。', 'description' => '环境音ID。', 'type' => 'string', 'example' => 'office', ], 'Volume' => [ 'title' => '环境音音量大小。', 'description' => '环境音音量大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], ], ], 'InterruptConfig' => [ 'title' => '打断配置。', 'description' => '打断配置。', 'type' => 'object', 'properties' => [ 'SemanticsInterrupt' => [ 'title' => '是否开启语义打断。', 'description' => '是否开启语义打断。', 'type' => 'boolean', ], ], ], 'BackChannelConfig' => [ 'title' => '承接词配置。', 'description' => '承接词配置。', 'type' => 'object', 'properties' => [ 'UserTurnEnd' => [ 'title' => '用户说完话之后，是否开启承接词。', 'description' => '用户说完话之后，是否开启承接词。', 'type' => 'boolean', ], ], ], 'InterruptMode' => [ 'title' => '打断方式：'."\n" .'- 1: 支持打断（默认）'."\n" .'- 2: 禁止打断', 'description' => '打断方式：'."\n" .'- 1: 支持打断（默认）'."\n" .'- 2: 禁止打断', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Name' => [ 'title' => '模版名称。', 'description' => '模版名称。', 'type' => 'string', 'example' => '测试', ], 'AsrConfig' => [ 'title' => '语音转文字配置。', 'description' => '语音转文字配置。', 'type' => 'object', 'properties' => [ 'VocabularyId' => [ 'title' => '热词ID。', 'description' => '热词ID。', 'type' => 'string', 'example' => 'ecfadace11114cf08a7f07aceee798ad', ], 'MaxSentenceSilence' => [ 'title' => '语音断句检测阈值，默认500ms，允许范围[200，6000]。', 'description' => '语音断句检测阈值，默认500ms，允许范围[200，6000]。', 'type' => 'integer', 'format' => 'int32', 'example' => '300', ], 'VadConfig' => [ 'title' => 'vad配置。', 'description' => 'vad配置。', 'type' => 'object', 'properties' => [ 'InterruptSpeechDuration' => [ 'title' => '人声持续阈值 (ms)，取值范围为[0,3000]。持续检测到人声信号的最小时间长度，避免误打断。', 'description' => '人声持续阈值 (ms)，取值范围为[0,3000]。持续检测到人声信号的最小时间长度，避免误打断。', 'type' => 'integer', 'format' => 'int32', 'example' => '1200', ], ], ], 'WordWeights' => [ 'title' => '每个词表最多包含500个热词，每个热词中文长度不超过10个字符。'."\n" .'热词必须为UTF-8编码，不能包含标点、特殊字符，不符合的情况下，无热词效果。', 'description' => '每个词表最多包含500个热词，每个热词中文长度不超过10个字符。'."\n" .'热词必须为UTF-8编码，不能包含标点、特殊字符，不符合的情况下，无热词效果。', 'type' => 'array', 'items' => [ 'title' => '热词权重。', 'description' => '热词权重。', 'type' => 'object', 'properties' => [ 'Word' => [ 'title' => '热词文本，每个词语最长10个汉字或英文单词。', 'description' => '热词文本，每个词语最长10个汉字或英文单词。', 'type' => 'string', 'example' => '德州', ], 'Lang' => [ 'title' => '语言代码。', 'description' => '语言代码。', 'type' => 'string', 'example' => 'zh', ], 'Weight' => [ 'title' => '热词权重，取值范围为[1, 5]之间的整数。'."\n" .'常用值：4。'."\n" .'如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。', 'description' => '热词权重，取值范围为[1, 5]之间的整数。'."\n" .'常用值：4。'."\n" .'如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'required' => true, ], ], 'Name' => [ 'title' => '名称。', 'description' => '名称。', 'type' => 'string', 'example' => 'Asr配置', ], ], ], 'Type' => [ 'title' => '智能体类型：'."\n" .'- 1: 语音通话（默认）', 'description' => '智能体类型：'."\n" .'- 1: 语音通话（默认）', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'LlmConfig' => [ 'title' => '大模型设置。', 'description' => '大模型设置。', 'type' => 'object', 'properties' => [ 'Temperature' => [ 'title' => '采样温度，取值范围[0,2)，默认值0.7。', 'description' => '采样温度，取值范围[0,2)，默认值0.7。', 'type' => 'number', 'format' => 'float', 'example' => '0.8', ], 'ApiKey' => [ 'title' => '大模型服务商需要的apikey。', 'description' => '大模型服务商需要的apikey。', 'type' => 'string', 'example' => 'qW8GpBOdHK/pv9gdUSVLvQ==', ], 'MaxToken' => [ 'title' => '输出文本的最大限制，默认值8192。', 'description' => '输出文本的最大限制，默认值8192。', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', ], 'Model' => [ 'title' => '模型，阿里云百炼，目前支持模型为qwen-plus和deepseek-r1，bailianAgent。', 'description' => '模型，阿里云百炼，目前支持模型为qwen-plus和deepseek-r1。', 'type' => 'string', 'example' => 'deepseek-r1', ], 'HistoryDepth' => [ 'title' => '给大模型提供多少历史对话轮次，最大100，默认值3。', 'description' => '给大模型提供多少历史对话轮次，最大100，默认值3。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'Prompt' => [ 'title' => '大模型提示词，最大长度为5000。', 'description' => '大模型提示词，最大长度为5000。', 'type' => 'string', 'example' => '你是一个高级心理医生', ], 'AgentAppId' => [ 'title' => '当model是百炼智能体时，标识智能体AppId。', 'description' => '当model是百炼智能体时，标识智能体AppId。', 'type' => 'string', 'example' => '1233312', ], 'Vendor' => [ 'title' => '提供方，目前支持阿里云-百炼和第三方配置（符合OpenAI接口规范）。', 'description' => '提供方，目前支持阿里云-百炼和第三方配置（符合OpenAI接口规范）。', 'type' => 'string', 'example' => 'aliyun', ], 'TopP' => [ 'title' => '采样的选择范围(0,1]，默认值0.8', 'description' => '采样的选择范围(0,1]，默认值0.8', 'type' => 'number', 'format' => 'float', 'example' => '0.8', ], 'Url' => [ 'title' => '接入第三方大模型时，该字段表示接入的endpoint。', 'description' => '接入第三方大模型时，该字段表示接入的endpoint。', 'type' => 'string', 'example' => 'https://test.com', ], 'Name' => [ 'title' => '名称。', 'description' => '名称。', 'type' => 'string', 'example' => 'llm', ], ], ], 'TtsConfig' => [ 'title' => '文字转语音设置。', 'description' => '文字转语音设置。', 'type' => 'object', 'properties' => [ 'ApiKey' => [ 'title' => '大模型服务商需要的apikey。', 'description' => '大模型服务商需要的apikey。', 'type' => 'string', 'example' => 'N5448VFGI2mXJU8a/A03VQ==', ], 'FilterBrackets' => [ 'title' => '过滤设置。'."\n" .'- 1-中文刮号（）'."\n" .'- 2-英文刮号()'."\n" .'- 3-中文方刮号【】'."\n" .'- 4-英文方刮号[]'."\n" .'- 5-英文花刮号{}', 'description' => '过滤设置。'."\n" .'- 1-中文刮号（）'."\n" .'- 2-英文刮号()'."\n" .'- 3-中文方刮号【】'."\n" .'- 4-英文方刮号[]'."\n" .'- 5-英文花刮号{}', 'type' => 'array', 'items' => [ 'title' => '具体字段。', 'description' => '具体字段。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'Volume' => [ 'title' => '音量，取值范围[0~100]，默认50。', 'description' => '音量，取值范围[0~100]，默认50。', 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'Rate' => [ 'title' => '语速，取值范围[0.5~2.0]，默认1.0。', 'description' => '语速，取值范围[0.5~2.0]，默认1.0。', 'type' => 'number', 'format' => 'float', 'example' => '50', ], 'Model' => [ 'title' => '模型，阿里云百炼，目前支持模型为cosyvoice-v1。', 'description' => '模型，阿里云百炼，目前支持模型为cosyvoice-v1。', 'type' => 'string', 'example' => 'cosyvoice-v1', ], 'Pitch' => [ 'title' => '音调，取值范围[0.5~2.0]，默认1.0。', 'description' => '音调，取值范围[0.5~2.0]，默认1.0。', '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' => '音色，默认音色是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', 'type' => 'string', 'example' => 'longwan', ], 'Name' => [ 'title' => '名称。', 'description' => '名称。', 'type' => 'string', 'example' => 'Tts', ], ], ], 'Id' => [ 'title' => '模版ID。', 'description' => '模版ID。', 'type' => 'string', 'example' => 'wv7N****', ], 'ChatMode' => [ 'title' => '对话模式：'."\n" .'- 1: 自然对话模式（默认）'."\n" .'- 2: 对讲机模式', 'description' => '对话模式：'."\n" .'- 1: 自然对话模式（默认）'."\n" .'- 2: 对讲机模式', '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"}]', 'title' => '查询智能体模版列表', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'ac7N****', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '模版ID。', 'description' => '模版ID。', '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' => '模版ID。', '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"}]', 'title' => '删除智能体模版', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '智能体类型：'."\n" .'- 1: 语音通话（默认）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', 'enum' => [ '1', ], ], ], [ 'name' => 'ChatMode', 'in' => 'query', 'schema' => [ 'title' => '对话模式：'."\n" .'- 1: 自然对话模式（默认）'."\n" .'- 2: 对讲机模式', 'description' => '对话模式：'."\n" .'- 1: 自然对话模式（默认）'."\n" .'- 2: 对讲机模式', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '1', 'enum' => [ '1', '2', ], ], ], [ 'name' => 'InterruptMode', 'in' => 'query', 'schema' => [ 'title' => '打断方式：'."\n" .'- 1: 支持打断（默认）'."\n" .'- 2: 禁止打断', 'description' => '打断方式：'."\n" .'- 1: 支持打断（默认）'."\n" .'- 2: 禁止打断', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '1', 'enum' => [ '1', '2', ], ], ], [ 'name' => 'Greeting', 'in' => 'query', 'schema' => [ 'title' => '问候语，最大长度不超过500。', 'description' => '问候语，最大长度不超过500。', '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' => '语音断句检测阈值，默认500ms，允许范围[200，6000]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', 'default' => '500', ], 'WordWeights' => [ 'title' => '每个词表最多包含500个热词，每个热词中文长度不超过10个字符。'."\n" .'热词必须为UTF-8编码，不能包含标点、特殊字符，不符合的情况下，无热词效果。', 'description' => '每个词表最多包含500个热词，每个热词中文长度不超过10个字符。'."\n" .'热词必须为UTF-8编码，不能包含标点、特殊字符，不符合的情况下，无热词效果。', 'type' => 'array', 'items' => [ 'title' => '热词权重。', 'description' => '热词权重。', 'type' => 'object', 'properties' => [ 'Word' => [ 'title' => '热词文本，每个词语最长10个汉字或英文单词。', 'description' => '热词文本，每个词语最长10个汉字或英文单词。', 'type' => 'string', 'required' => true, 'example' => '苹果', ], 'Lang' => [ 'title' => '语言代码。可不写，大模型会自动设别。'."\n" .'- zh: 中文'."\n" .'- en: 英文', 'description' => '语言代码。可不写，大模型会自动设别。'."\n" .'- zh: 中文'."\n" .'- en: 英文', 'type' => 'string', 'required' => false, 'example' => 'zh', ], 'Weight' => [ 'title' => '热词权重，取值范围为[1, 5]之间的整数。'."\n" .'常用值：4。'."\n" .'如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。', 'description' => '热词权重，取值范围为[1, 5]之间的整数。'."\n" .'常用值：4。'."\n" .'如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '4', 'default' => '4', ], ], 'required' => true, ], 'required' => false, ], 'VadConfig' => [ 'title' => 'vad配置。', 'description' => 'vad配置。', 'type' => 'object', 'properties' => [ 'InterruptSpeechDuration' => [ 'title' => '人声持续阈值 (ms)，取值范围为[0,3000]。持续检测到人声信号的最小时间长度，避免误打断。默认300ms', 'description' => '人声持续阈值 (ms)，取值范围为[0,3000]。持续检测到人声信号的最小时间长度，避免误打断。默认300ms', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3000', 'minimum' => '0', 'example' => '1000', 'default' => '300', ], ], 'required' => false, ], ], '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' => '提供方，目前支持阿里云-百炼和第三方配置（符合OpenAI接口规范）。', 'type' => 'string', 'required' => true, 'example' => 'thirdparty', 'default' => 'aliyun', 'enum' => [ 'aliyun', 'thirdparty', ], ], 'Url' => [ 'title' => '接入第三方大模型时，该字段表示接入的endpoint。', 'description' => '接入第三方大模型时，该字段表示接入的endpoint。', 'type' => 'string', 'required' => false, 'example' => 'https://llm.example.aliyuns.com', 'maxLength' => 100, ], 'ApiKey' => [ 'title' => '大模型服务商需要的apikey。', 'description' => '大模型服务商需要的apikey。', 'type' => 'string', 'required' => true, 'example' => 'ak-1213123123132123131', 'maxLength' => 200, 'minLength' => 1, ], 'Temperature' => [ 'title' => '采样温度，取值范围[0,2)，默认值0.7。', 'description' => '采样温度，取值范围[0,2)，默认值0.7。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.9', 'default' => '0.7', ], 'TopP' => [ 'title' => '采样的选择范围(0,1]，默认值0.8', 'description' => '采样的选择范围(0,1]，默认值0.8', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.8', 'default' => '0.8', ], 'MaxToken' => [ 'title' => '输出文本的最大限制，默认值8192。', 'description' => '输出文本的最大限制，默认值8192。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'default' => '8192', ], 'HistoryDepth' => [ 'title' => '给大模型提供多少历史对话轮次，最大100，默认值3。', 'description' => '给大模型提供多少历史对话轮次，最大100，默认值50。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'default' => '50', ], 'Prompt' => [ 'title' => '大模型提示词，最大长度为5000。', 'description' => '大模型提示词，最大长度为5000。', 'type' => 'string', 'required' => false, 'example' => '你是一个高级心理医生。', ], 'AgentAppId' => [ 'title' => '百炼智能体ID。', 'description' => '百炼智能体ID。', 'type' => 'string', 'required' => false, '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', 'customized', 'dingmaas', ], ], 'ApiKey' => [ 'title' => '大模型服务商需要的apikey。', 'description' => '大模型服务商需要的apikey。', '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' => '音色，默认音色是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', 'type' => 'string', 'required' => false, 'example' => 'longcheng', 'default' => 'longxiaoxia', ], 'Volume' => [ 'title' => '音量，取值范围[0~100]，默认50。', 'description' => '音量，取值范围[0~100]，默认50。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70', 'default' => '50', ], 'Rate' => [ 'title' => '语速，取值范围[0.5~2.0]，默认1.0。', 'description' => '语速，取值范围[0.5~2.0]，默认1.0。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.8', 'default' => '1.0', ], 'Pitch' => [ 'title' => '音调，取值范围[0.5~2.0]，默认1.0。', 'description' => '音调，取值范围[0.5~2.0]，默认1.0。', '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' => '过滤设置。'."\n" .'- 1-中文刮号（）'."\n" .'- 2-英文刮号()'."\n" .'- 3-中文方刮号【】'."\n" .'- 4-英文方刮号[]'."\n" .'- 5-英文花刮号{}', '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' => '智能体静默配置。', 'description' => '智能体静默配置。', 'type' => 'object', 'properties' => [ 'AlertTimeout' => [ 'title' => '静默提醒的超时时间（单位：秒）。'."\n" .'可能多次触发，若智能体静默提醒超时后依然静默，则再超时还会继续触发，取值范围：[5, 600]，默认值0，0表示不提醒', 'description' => '静默提醒的超时时间（单位：秒）。'."\n" .'可能多次触发，若智能体静默提醒超时后依然静默，则再超时还会继续触发，取值范围：[5, 600]，默认值0，0表示不提醒', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '0', ], 'WebhookTriggerTimeout' => [ 'title' => '触发智能体静默超时webhook的静默超时时间（单位：秒）。可能多次触发，若智能体webhook静默超时后依然静默，则再超时还会继续触发，取值范围：[10, 600]，默认值0，0表示不触发', 'description' => '触发智能体静默超时webhook的静默超时时间（单位：秒）。可能多次触发，若智能体webhook静默超时后依然静默，则再超时还会继续触发，取值范围：[10, 600]，默认值0，0表示不触发', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '0', ], 'Strategy' => [ 'title' => '静默超时处理策略。'."\n" .'1 - 向用户语音播报content指定的提示消息'."\n" .'2 - 把content指定的提示消息和历史对话发送给LLM，并播报模型生成的回复'."\n" .'默认值：1', 'description' => '静默超时处理策略。'."\n" .'1 - 向用户语音播报content指定的提示消息'."\n" .'2 - 把content指定的提示消息和历史对话发送给LLM，并播报模型生成的回复'."\n" .'默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '1', 'example' => '2', 'default' => '1', ], 'Content' => [ 'title' => '静默提示消息的内容。', 'description' => '静默提示消息的内容。', 'type' => 'string', 'required' => false, 'maxLength' => 2500, ], ], 'required' => false, ], ], [ 'name' => 'AmbientSoundConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '智能体环境音配置。不传表示不使用环境配置。', 'description' => '智能体环境音配置。不传表示不使用环境配置。', 'type' => 'object', 'properties' => [ 'SoundId' => [ 'title' => 'agent提供以下默认环境音：'."\n" .' - white_noise '."\n" .' - office', 'description' => 'agent提供以下默认环境音：'."\n" .' - white_noise '."\n" .' - office', 'type' => 'string', 'required' => false, 'example' => 'white_noise', 'maxLength' => 30, ], 'Volume' => [ 'title' => '音量大小。', 'description' => '音量大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '100', ], ], 'required' => false, ], ], [ 'name' => 'InterruptConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '智能体打断配置。', 'description' => '智能体打断配置。', 'type' => 'object', 'properties' => [ 'SemanticsInterrupt' => [ 'title' => '按语义打断。', 'description' => '按语义打断。', 'type' => 'boolean', 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'BackChannelConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '智能体承接词配置。', 'description' => '智能体承接词配置。', 'type' => 'object', 'properties' => [ 'UserTurnEnd' => [ 'title' => '是否开启承接词。', 'description' => '是否开启承接词。', 'type' => 'boolean', 'required' => false, ], ], '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', ], 'Id' => [ 'title' => '模版ID。', 'description' => '模版ID。', '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"}]', 'title' => '创建智能体模版', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID，可通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'aoe****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '加入的频道，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'yourChannelId', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务id', 'description' => '任务id', 'type' => 'string', 'required' => true, 'example' => 'yourTaskId', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => '模版ID。', 'type' => 'string', 'required' => true, 'example' => '76dasgb****', ], ], [ 'name' => 'RtcConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '智能体加入rtc频道的配置', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '智能体在rtc频道中的userId', 'description' => '智能体在rtc频道中的userId', 'type' => 'string', 'required' => true, 'example' => '423341', ], 'TargetUserIds' => [ 'title' => '智能体订阅的用户userId列表，目前仅支持一个', 'description' => '智能体订阅的用户userId列表，目前仅支持一个', 'type' => 'array', 'items' => [ 'description' => 'userId', 'type' => 'string', 'required' => false, 'example' => '41411', ], 'required' => false, ], 'UserInactivityTimeout' => [ 'description' => '定义用户无活动状态的最大持续时间阈值（单位：秒）'."\n" .'当检测到以下任一状态持续时间达到该阈值时，智能体将自动停止并退出频道：'."\n" .'1. targetUserIds列表中的所有用户已全部离开频道'."\n" .'2. targetUserIds列表未加入频道'."\n" ."\n" .'默认值：30'."\n" .'取值范围：[5, 180]', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], 'required' => true, 'example' => '2', ], ], [ 'name' => 'VoiceChatConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'AI语音对话的配置', 'type' => 'object', 'properties' => [ 'ChatMode' => [ 'title' => '1-自然对话模式 (默认值); 2-对讲机模式', 'description' => '1-自然对话模式 (默认值); 2-对讲机模式', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'InterruptMode' => [ 'title' => '1-支持语音打断 (默认值)，2-禁用语音打断', 'description' => '1-支持语音打断 (默认值)，2-禁用语音打断', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Greeting' => [ 'description' => '问候语', 'type' => 'string', 'required' => false, 'example' => '早上好，我的朋友', ], 'ASRConfig' => [ 'description' => 'ASR配置', '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' => '语音断句检测阈值，默认800ms，参考范围[200,6000]', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '800', ], 'VocabularyId' => [ 'title' => 'paraformer-realtime-v2支持的热词ID', 'description' => '支持的热词ID', 'type' => 'string', 'required' => false, 'example' => 'vocab-xxx-24ee19fa8cfb4d52902170a0xxxxxxxx', ], 'LanguageHints' => [ 'title' => '指定识别语音中语言的代码列表。支持的语言代码：zh: 中文（包含中文普通话和各种方言）;en: 英文;ja: 日语;yue: 粤语;ko: 韩语。如果不填写则模型会自动识别语种。', 'description' => '不设置，模型会自动识别语种。'."\n" .'目前支持的语言代码：'."\n" .'zh: 中文（支持方言：上海话、吴语、闽南语、东北话、甘肃话、贵州话、河南话、湖北话、湖南话、江西话、宁夏话、山西话、陕西话、山东话、四川话、天津话、云南话、粤语）'."\n" .'en: 英文'."\n" .'ja: 日语'."\n" .'yue: 粤语'."\n" .'ko: 韩语', 'type' => 'array', 'items' => [ 'description' => '语言代码', 'type' => 'string', 'required' => false, 'example' => 'zh', ], 'required' => false, ], 'VadConfig' => [ 'description' => 'vad配置。', 'type' => 'object', 'properties' => [ 'InterruptSpeechDuration' => [ 'description' => '人声持续阈值 (ms)，取值范围为[0,3000]。持续检测到人声信号的最小时间长度，避免误打断。'."\n" .'默认300ms', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', ], ], 'required' => false, ], ], 'required' => false, ], 'LLMConfig' => [ 'description' => 'LLM配置', 'type' => 'object', 'properties' => [ 'Vendor' => [ 'title' => '服务提供商。如果服务商是云平台，示例：aliyun，microsoft，volcano；如果服务商是模型开发商，示例：openai, deepseek', 'description' => '接入云服务提供商时，此字段表示服务商的名称。示例：aliyun[百炼]、thirdparty', 'type' => 'string', 'required' => false, 'example' => 'aliyun', ], 'Model' => [ 'description' => '模型名称'."\n" .'aliyun服务商下支持模型:'."\n" .'["qwen-plus", "deepseek-r1", "qwen-omni-turbo"]', 'type' => 'string', 'required' => false, 'example' => 'qwen-plus', ], 'ApiKey' => [ 'description' => '服务商apikey', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxxxx', ], 'Temperature' => [ 'description' => '采样温度，用于控制生成文本的随机性和创造性，值越大随机性越高。'."\n" .'默认值0.7'."\n" .'取值范围[0,2)'."\n" .'deepseek-r1设置该参数不生效', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.7', ], 'TopP' => [ 'description' => '采样的选择范围，控制输出 token 的多样性。模型将从概率分布中累计概率超过该取值的标记中进行采样，以确保采样的选择范围不会过宽，值越大输出的 token 类型越丰富。'."\n" .'取值范围(0,1]，默认值0.8', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.8', ], 'MaxToken' => [ 'description' => '输出文本的最大限制，默认值8192'."\n" .'deepseek qwen模型最大值为8192', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '500', ], 'HistoryDepth' => [ 'description' => '给大模型提供多少历史对话轮次。'."\n" .'默认值3', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], 'Prompt' => [ 'title' => '用于告知模型要扮演的角色或行为', 'description' => '用于告知模型要扮演的角色或行为', 'type' => 'string', 'required' => false, 'example' => 'xxxx', ], 'Url' => [ 'description' => '接入第三方的大模型时，此字段表示大模型的接入url', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxx', ], 'Params' => [ 'description' => '用户自定义参数，键值对', 'type' => 'object', 'required' => false, 'example' => '{\\"verification_code\\": \\"xxx\\"}', ], 'AppId' => [ 'description' => '智能体应用ID'."\n" .'model，appId二选一即可。如果model，appId都填写了，优先使用appId', 'type' => 'string', 'required' => false, 'example' => 'e****', ], ], 'required' => false, ], 'TTSConfig' => [ 'description' => 'TTS配置', 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => '服务提供商 【aliyun【百炼】】', 'type' => 'string', 'required' => false, 'example' => 'aliyun', ], 'Model' => [ 'description' => '模型名称【cosyvoice-v1】', 'type' => 'string', 'required' => false, 'example' => 'cosyvoice-v1', ], 'ApiKey' => [ 'description' => '服务商apikey', 'type' => 'string', 'required' => false, 'example' => 'xxxxxx', ], 'Voice' => [ 'title' => '音色，选择定制模型支持的音色', 'description' => '音色。如果选择阿里云cosyvoice-v1，默认音色是longxiaoxia'."\n" .'可选音色：'."\n" .'longwan、longcheng、longhua、longxiaochun、longxiaoxia、longxiaocheng、longxiaobai、longlaotie、longshu、longshuo、longjing、longmiao、longyue、longyuan、longfei、longjielidou、longtong、longxiang、loongstella、loongbella', 'type' => 'string', 'required' => false, 'example' => 'longxiaoxia', ], 'Volume' => [ 'title' => '音量（int），[0~100]，默认50', 'description' => '音量（int），[0~100]，默认50', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', ], 'Rate' => [ 'title' => '语速（float）[0.5~2.0]，默认1.0', 'description' => '语速（float）[0.5~2.0]，默认1.0', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1', ], 'Pitch' => [ 'title' => '音调（float）[0.5~2.0]，默认1.0', 'description' => '音调（float）[0.5~2.0]，默认1.0', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1', ], 'FilterBrackets' => [ 'description' => '过滤设定符号范围内的字符不被转成语音', 'type' => 'array', 'items' => [ 'description' => '1-中文刮号（），2-英文刮号()，3-中文方头刮号【】，4-英文方刮号[]，5-英文花刮号{}', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[1,2]', ], 'required' => false, ], ], 'required' => false, ], 'AgentSilenceConfig' => [ 'title' => '智能体静默超时处理配置', 'description' => '当用户加入频道后，但未与智能体进行有效交互（用户未发言），此时智能体处于静默状态，可以配置智能体在静默状态下的行为：播报静默语音消息提醒或webhook通知。', 'type' => 'object', 'properties' => [ 'Enable' => [ 'title' => '是否启用智能体静默超时处理机制。'."\n" .'当用户加入频道后，但未与智能体进行有效交互（用户未发言），此时智能体处于静默状态，当静默时间超过设置的阈值后，会通过语音定期提醒用户。定期通知时间间隔和设置的阈值一样。'."\n" .'默认值：false', 'description' => '开关', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'AlertTimeout' => [ 'title' => '智能体最大静默时间阈值（单位：秒）。'."\n" .'取值范围：[5, 60]，默认值', 'description' => '静默提醒的超时时间（单位：秒）。'."\n" .'可能多次触发，若智能体静默提醒超时后依然静默，则再超时还会继续触发'."\n" .'取值范围：[5, 600]，默认值0，0表示不提醒', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Strategy' => [ 'title' => '静默超时处理策略。'."\n" .'1 - 向用户语音播报content指定的提示消息'."\n" .'2 - 把content指定的提示消息和历史对话发送给LLM，并播报模型生成的回复'."\n" .'默认值：1', 'description' => '静默提醒的话术策略。'."\n" .'1 - 向用户语音播报content指定的提示消息'."\n" .'2 - 把content指定的提示消息和历史对话发送给LLM，并播报模型生成的回复'."\n" .'默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Content' => [ 'title' => '静默提示消息的内容', 'description' => '静默提示消息的内容', 'type' => 'string', 'required' => false, 'example' => '**', ], 'WebhookTriggerTimeout' => [ 'description' => '触发智能体静默超时webhook的静默超时时间（单位：秒）。可能多次触发，若智能体webhook静默超时后依然静默，则再超时还会继续触发'."\n" .'取值范围：[10, 600]，默认值0，0表示不触发', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], 'required' => false, ], 'AmbientSoundConfig' => [ 'title' => '环境音配置', 'description' => '环境音设置', 'type' => 'object', 'properties' => [ 'SoundId' => [ 'title' => '静默提示消息的内容', 'description' => '环境音计划支持内置与下载（后续），当前先实现内置模式'."\n" .'- 当不传字段或者字段为空时，表示不开启环境音'."\n" .'- 内置模式：agent提供以下默认环境音：white_noise（白噪声）office（办公室）'."\n" .'- 下载模式：支持客户在控制台填写soundId（不可与内置id相同），并填写url，agent内部会进行下载并绑定。', 'type' => 'string', 'required' => false, 'example' => 'white_noise', ], 'Volume' => [ 'title' => '音量大小。', 'description' => '环境音音量，默认50（原声）。范围【0 - 100】', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '50', ], ], 'required' => false, ], 'InterruptConfig' => [ 'title' => '打断配置', 'description' => '打断设置', 'type' => 'object', 'properties' => [ 'SemanticsInterrupt' => [ 'title' => '智能语义打断', 'description' => '是否开启语义打断。默认值是true', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], 'required' => false, ], 'BackChannelConfig' => [ 'title' => '打断配置', 'description' => '承接词设置', 'type' => 'object', 'properties' => [ 'UserTurnEnd' => [ 'title' => '智能语义打断', 'description' => '用户说完话后，是否开启承接词。默认值是false', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], ], '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"}]', 'title' => '启动智能体', ], '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' => '应用ID。仅支持传单个ID，您可以在控制台创建和查询。', 'type' => 'string', 'required' => false, 'example' => 'aec****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '频道id', 'type' => 'string', 'required' => false, 'example' => '1234', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务id', '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' => '创建时间戳，Unix 时间，单位为毫秒', 'type' => 'string', 'example' => '1751513144838', ], 'StopTime' => [ 'description' => '结束时间戳，Unix 时间，单位为毫秒', 'type' => 'string', 'example' => '1751513144838', ], 'Status' => [ 'description' => '智能体状态, 0-未启动，1-正在启动，2-正在运行，3-正在停止，4-已经结束，5-运行失败', '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"}]', 'title' => '查询智能体状态', ], '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' => '应用ID，仅支持传单个ID。您可以在控制台创建和查询。', 'type' => 'string', 'required' => true, 'example' => '4eah****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '已存在的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'yourChannelId', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'yourTaskId', ], ], [ 'name' => 'VoiceChatConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'AI语音对话的配置', 'type' => 'object', 'properties' => [ 'InterruptMode' => [ 'description' => '1-支持语音打断 ; 2-禁用语音打断'."\n" .'如果没有该字段，则不更新', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], 'ChatMode' => [ 'description' => '1-自然对话模式 ; 2-对讲机模式'."\n" .'如果没有该字段，则不更新', '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"}]', 'title' => '更新智能体', ], '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' => '应用ID，可通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => false, 'example' => 'aec****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '加入的频道，仅支持传单个ID。', 'type' => 'string', 'required' => false, 'example' => 'yourChannelId', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。', 'type' => 'string', 'required' => false, 'example' => 'yourTaskId', ], ], [ 'name' => 'Message', 'in' => 'query', 'schema' => [ 'description' => '播报文本内容', 'type' => 'string', 'required' => false, 'example' => '您好，现在是2025年4月16日，请问需要什么帮助', ], ], [ 'name' => 'Priority', 'in' => 'query', 'schema' => [ 'description' => 'priority 表示播报插入等级：'."\n" .'1——打断当前交互立即播报'."\n" .'2——等待当前交互结束后播报'."\n" .'3——如果当前不在交互则播报', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Interruptable', 'in' => 'query', 'schema' => [ 'description' => '表示播报消息是否允许被打断，如为false，则播报消息不能被语音打断、按键打断等方式打断', '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' => '背景音。', 'description' => '背景音。', 'type' => 'object', 'properties' => [ 'format' => [ 'title' => '格式。'."\n" .'- wav', 'description' => '格式。'."\n" .'- wav', 'type' => 'string', 'required' => false, 'example' => 'wav', 'default' => 'wav', 'enum' => [ 'wav', ], ], 'url' => [ 'title' => '资源地址。', 'description' => '资源地址。', 'type' => 'string', 'required' => false, 'maxLength' => 1000, ], ], '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"}]', 'title' => '自定义消息播报', ], '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' => '应用ID，仅支持传单个ID。您可以在控制台创建和查询。', 'type' => 'string', 'required' => true, 'example' => 'aec****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '加入的频道，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'yourChannelId', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID，仅支持传单个ID。', '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"}]', 'title' => '关闭智能体', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '开关状态；enable-开启 disable-关闭。', '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"}]', 'title' => '查询合流功能状态', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'ac7N****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '修改合流功能状态', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '布局ID列表，最多16个。', 'type' => 'array', 'items' => [ 'title' => '具体的布局ID。', 'description' => '具体的布局ID。', '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' => '模板ID。', '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"}]', 'title' => '创建合流模版', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'requestParamsDescription' => '**MediaEncode**枚举值如下所示。'."\n" ."\n" .'| ID | 宽 | 高 | 码流（Kps） | 帧率（FPS） | 备注'."\n" .'| ----------- | ----- | ------ | ----------- | --- |---'."\n" .'| 0 | 0 | 0 | 64 | 0 |纯音频'."\n" .'| 1 | 640 | 360 | 500 | 15 '."\n" .'| 10 | 960 | 540 | 700 | 24 '."\n" .'| 20 | 1280 | 720 | 1024 | 24 '."\n" .'| 22 | 720 | 1280 | 1024 | 30 '."\n" .'| 23 | 800 | 600 | 1024 | 30 '."\n" .'| 24 | 750 | 780 | 1024 | 30 '."\n" .'| 25 | 750 | 540 | 700 | 30 '."\n" .'| 26 | 720 | 1280 | 2048 | 30 '."\n" .'| 27 | 1280 | 720 | 2048 | 30 '."\n" .'| 28 | 1280 | 720 | 3096 | 30 '."\n" .'| 30 | 1920 | 1080 | 2048 | 30 '."\n" .'| 31 | 1080 | 1920 | 2048 | 30 '."\n" .'| 32 | 1024 | 768 | 1024 | 24 '."\n" .'| 33 | 1280 | 960 | 1024 | 24 '."\n" .'| 34 | 1024 | 768 | 2048 | 24 '."\n" .'| 35 | 1280 | 960 | 2048 | 24 '."\n" .'| 36 | 1280 | 720 | 1024 | 24 '."\n" .'| 37 | 1280 | 720 | 2048 | 24 '."\n" .'| 38 | 540 | 960 | 750 | 15 '."\n" .'| 39 | 540 | 960 | 1500 | 30 '."\n" .'| 40 | 1280 | 720 | 1200 | 15 '."\n" .'| 41 | 720 | 1280 | 1200 | 15 '."\n" .'| 42 | 720 | 1280 | 1500 | 15 '."\n" .'| 43 | 540 | 960 | 1200 | 15'."\n" .'| 52 | 640 | 360 | 500 | 30 '."\n" .'| 53 | 360 | 640 | 500 | 15 '."\n" .'| 54 | 360 | 640 | 500 | 30 '."\n" .'| 60 | 1920 | 1080 | 4096 | 30'."\n" .'| 61 | 1080 | 1920 | 4096 | 30', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '布局ID列表，最多16个。', 'type' => 'array', 'items' => [ 'title' => '具体的布局ID。', 'description' => '具体的布局ID。', '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' => '模板ID。', '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' => '模板ID。', '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"}]', 'title' => '修改合流模板', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'requestParamsDescription' => '**MediaEncode**枚举值如下所示。'."\n" ."\n" .'| ID | 宽 | 高 | 码流（Kps） | 帧率（FPS） | 备注'."\n" .'| ----------- | ----- | ------ | ----------- | --- |---'."\n" .'| 0 | 0 | 0 | 64 | 0 |纯音频'."\n" .'| 1 | 640 | 360 | 500 | 15 '."\n" .'| 10 | 960 | 540 | 700 | 24 '."\n" .'| 20 | 1280 | 720 | 1024 | 24 '."\n" .'| 22 | 720 | 1280 | 1024 | 30 '."\n" .'| 23 | 800 | 600 | 1024 | 30 '."\n" .'| 24 | 750 | 780 | 1024 | 30 '."\n" .'| 25 | 750 | 540 | 700 | 30 '."\n" .'| 26 | 720 | 1280 | 2048 | 30 '."\n" .'| 27 | 1280 | 720 | 2048 | 30 '."\n" .'| 28 | 1280 | 720 | 3096 | 30 '."\n" .'| 30 | 1920 | 1080 | 2048 | 30 '."\n" .'| 31 | 1080 | 1920 | 2048 | 30 '."\n" .'| 32 | 1024 | 768 | 1024 | 24 '."\n" .'| 33 | 1280 | 960 | 1024 | 24 '."\n" .'| 34 | 1024 | 768 | 2048 | 24 '."\n" .'| 35 | 1280 | 960 | 2048 | 24 '."\n" .'| 36 | 1280 | 720 | 1024 | 24 '."\n" .'| 37 | 1280 | 720 | 2048 | 24 '."\n" .'| 38 | 540 | 960 | 750 | 15 '."\n" .'| 39 | 540 | 960 | 1500 | 30 '."\n" .'| 40 | 1280 | 720 | 1200 | 15 '."\n" .'| 41 | 720 | 1280 | 1200 | 15 '."\n" .'| 42 | 720 | 1280 | 1500 | 15 '."\n" .'| 43 | 540 | 960 | 1200 | 15'."\n" .'| 52 | 640 | 360 | 500 | 30 '."\n" .'| 53 | 360 | 640 | 500 | 15 '."\n" .'| 54 | 360 | 640 | 500 | 30 '."\n" .'| 60 | 1920 | 1080 | 4096 | 30'."\n" .'| 61 | 1080 | 1920 | 4096 | 30', ], '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' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'ioeh****', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'title' => '第几页，默认查询第1页。', 'description' => '第几页，默认查询第1页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页显示个数，默认为10。', 'description' => '每页显示个数，默认为10。', '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' => '模板ID。', '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' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2020-09-04T06:22:15Z', ], 'MediaEncode' => [ 'title' => '编码选项。', 'description' => '编码选项。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'LayoutIds' => [ 'title' => '布局ID列表。', 'description' => '布局ID列表。', 'type' => 'array', 'items' => [ 'title' => '具体的布局ID。', 'description' => '具体的布局ID。', 'type' => 'string', 'example' => '22', ], ], 'TemplateId' => [ 'title' => '模版ID。', 'description' => '模板ID。', '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"}]', 'title' => '合流模板列表', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'wv7N****', ], ], [ 'name' => 'Template', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '模版信息。', 'description' => '模板信息。', 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'title' => '模版ID', 'description' => '模板ID。', '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"}]', 'title' => '删除合流模板', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '频道ID，仅支持传单个ID。', 'description' => '频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => '$rtc_channelid', ], ], [ 'name' => 'Uid', 'in' => 'query', 'schema' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'required' => true, 'example' => '$rtc_userid', ], ], [ 'name' => 'DeviceType', 'in' => 'query', 'schema' => [ 'title' => '呼叫第三方sip的设备类型：'."\n" .'- sip_device'."\n" .'- mcu'."\n" .'- phone', 'description' => '呼叫第三方sip的设备类型：'."\n" .'- sip_device'."\n" .'- mcu'."\n" .'- phone'."\n" ."\n" .'备注：当前阶段，仅支持phone类型', 'type' => 'string', 'required' => true, 'example' => 'phone', 'enum' => [ 'sip_device', 'mcu', 'phone', ], ], ], [ 'name' => 'ServerAddress', 'in' => 'query', 'schema' => [ 'title' => '就近接入 rtc sip 服务器IP地址。用户通过本地进行解析域名:sip.dingtalk.com获取到就近接入地址。'."\n" .'比如dig sip.dingtalk.com获取', 'description' => '1. 就近接入 rtc sip 服务器IP地址。'."\n" .'2. 用户通过本地进行解析域名:rtcsip.dingtalk.com获取到就近接入地址。'."\n" .'如: dig rtcsip.dingtalk.com获取', 'type' => 'string', 'required' => false, 'example' => '39.101.232.13', ], ], [ 'name' => 'AppToken', 'in' => 'query', 'schema' => [ 'title' => '入会token。生成代码参考https://help.aliyun.com/document_detail/2689025.html', 'description' => '入会token。生成代码参考https://help.aliyun.com/document_detail/2689025.html', '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' => '在第三方显示的user名称。', 'type' => 'string', 'required' => true, 'example' => 'testdevice', 'maxLength' => 200, 'minLength' => 1, ], ], [ 'name' => 'SipUserId', 'in' => 'query', 'schema' => [ 'title' => '当DeviceType = mcu ，代表第三方会议系统'."\n" .'当DeviceType = sip_device 代表注册设备'."\n" .'如果第三方会议系统要求注册呼入，则为第三方系统提供的注册账号'."\n" .'如果不需要注册呼叫，则为呼入第三方的sip用户名rtc userid', 'description' => '1. 当DeviceType = mcu ，代表第三方会议系统'."\n" .'2. 当DeviceType = sip_device 代表注册设备'."\n" .'3. 如果第三方会议系统要求注册呼入，则为第三方系统提供的注册账号'."\n" .'4. 如果不需要注册呼叫，则为呼入第三方的sip用户名rtc userid', 'type' => 'string', 'required' => true, 'example' => '$reg_userid', ], ], [ 'name' => 'SipUserPassword', 'in' => 'query', 'schema' => [ 'title' => '如果第三方要注册呼入，匹配SipUserId的注册密码。', 'description' => '如果第三方要注册呼入，匹配SipUserId的注册密码。', 'type' => 'string', 'required' => false, 'example' => '654321', ], ], [ 'name' => 'SipRoomId', 'in' => 'query', 'schema' => [ 'title' => '当设备是mcu时，表示呼入的第三方会议系统的频道号码'."\n" ."\n" .'当设备是sip_device时，表示要邀请的注册设备的注册号码'."\n" ."\n" .'当设备是phone时，表示被叫的电话号码', 'description' => '1. 当设备是mcu时，表示呼入的第三方会议系统的频道号码'."\n" .'2. 当设备是sip_device时，表示要邀请的注册设备的注册号码'."\n" .'3. 当设备是phone时，表示被叫的电话号码', 'type' => 'string', 'required' => true, 'example' => '18512514528', ], ], [ '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' => '1. 当设备是mcu 表示第三方会议系统的地址信息ip:port;transport=tcp/udp/tls'."\n" .'如："30.240.160.66:5060;transport=tcp"'."\n" .'2. 当设备是sip_device 表示要邀请的注册设备的注册地址'."\n" .'如: 39.101.232.13'."\n" .'3. 当设备是phone 表示电话网关的地址信息'."\n" .'如："30.240.160.66:5060;transport=tcp"', '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' => '呼叫第三方sip的品牌型号 如polycom/cisco/tencent/zoom/pstn', 'type' => 'string', 'required' => false, 'example' => 'pstn', 'enum' => [ 'polycom', 'cisco', 'tencent', 'zoom', 'pstn', ], ], ], [ 'name' => 'CallNumber', 'in' => 'query', 'schema' => [ 'title' => 'pstn场景下自定义线路号码。', 'description' => 'pstn场景下自定义线路号码。', 'type' => 'string', 'required' => false, 'example' => '055112345678', 'maxLength' => 30, ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务ID。', 'description' => '任务ID。', 'type' => 'string', 'required' => false, 'example' => 'taskId', 'maxLength' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","type":"json"}]', 'title' => 'Sip邀请入会', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已存在的频道ID，仅支持传单个ID。', 'description' => '已存在的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => '$rtc_channelid', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'required' => true, 'example' => '$rtc_userid', 'maxLength' => 120, 'minLength' => 1, ], ], [ 'name' => 'DeviceType', 'in' => 'query', 'schema' => [ 'title' => '第三方sip的设备类型：'."\n" .'- sip_device'."\n" .'- mcu'."\n" .'- phone', 'description' => '第三方sip的设备类型：'."\n" .'- sip_device'."\n" .'- mcu'."\n" .'- phone'."\n" ."\n" .'备注：当前阶段，仅支持phone类型', 'type' => 'string', 'required' => true, 'example' => 'phone', 'enum' => [ 'sip_device', 'mcu', 'phone', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => 'EB3C3C75-74D5-5F01-9F3C-9974261BAED4', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB3C3C75-74D5-5F01-9F3C-9974261BAED4\\"\\n}","type":"json"}]', 'title' => 'Sip取消外呼', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已存在的频道ID，仅支持传单个ID。', 'description' => '已存在的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'title' => '模版ID。', 'description' => '模版ID。', 'type' => 'string', 'required' => true, 'example' => '567', 'maxLength' => 128, 'minLength' => 1, 'pattern' => '^[\\w.-]+$', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '本次任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', 'description' => '本次任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', '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' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边（默认值）。'."\n" .'- **3**：拉伸铺满。'."\n", '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' => '是否允许频道不存在时开启任务。'."\n" ."\n" .'- true: 是'."\n" .'- false: 否（默认值）', 'type' => 'boolean', 'required' => false, 'default' => 'false', ], ], [ 'name' => 'StartWithoutChannelWaitTime', 'in' => 'query', 'schema' => [ 'title' => '当StartWithoutChannel参数为true的时候，设置该值才有意义，表示房间未开启时，任务等待时长，单位为秒，区间限制为[30,120]。', 'description' => '当StartWithoutChannel参数为true的时候，设置该值才有意义，表示房间未开启时，任务等待时长，单位为秒，区间限制为[30,120]。', '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' => '允许看主流或者共享流画面的SIP设备的用户ID列表。', 'type' => 'array', 'items' => [ 'title' => '具体用户ID。', 'description' => '具体用户ID。', 'type' => 'string', 'required' => false, 'example' => '12', ], 'required' => false, ], ], [ 'name' => 'ViewContent', 'in' => 'query', 'schema' => [ 'title' => '流属性'."\n" .'- main: 主流画面'."\n" .'- screen-cast: 共享画面', 'description' => '流属性'."\n" .'- main: 主流画面'."\n" .'- screen-cast: 共享画面', 'type' => 'string', 'required' => false, 'example' => 'main', 'default' => 'main', 'enum' => [ 'main', 'screen-cast', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => '本次任务ID。', 'type' => 'string', 'example' => '123', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FA2F9DE9-8EAD-580E-87DF-A3D25EE87C37', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"FA2F9DE9-8EAD-580E-87DF-A3D25EE87C37\\"\\n}","type":"json"}]', 'title' => '开启合流', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已存在的频道ID，仅支持传单个ID。', 'description' => '已存在的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '已存的任务ID，仅支持传单个ID。', 'description' => '已存的任务ID，仅支持传单个ID。', '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' => '任务ID。', 'type' => 'string', 'example' => '2bd80921b81e4d4289f696606885606b', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '停止合流', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已存在的频道ID，仅支持传单个ID。', 'description' => '已存在的频道ID，仅支持传单个ID。', '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' => '操作范围。'."\n" .'- /media/audio/status 修改该用户音频流状态', 'type' => 'string', 'required' => true, 'example' => '/media/audio/status', 'default' => '/media/audio/status', 'enum' => [ '/media/audio/status', ], ], 'Op' => [ 'title' => '操作类型。'."\n" .'- replace', 'description' => '操作类型。'."\n" .'- replace', 'type' => 'string', 'required' => true, 'example' => 'replace', 'default' => 'replace', ], 'OperationId' => [ 'title' => '操作ID，当部分操作失败时，可以排查对应ID。', 'description' => '操作ID，当部分操作失败时，可以排查对应ID。', 'type' => 'string', 'required' => true, 'example' => '12122121', ], 'Value' => [ 'title' => '操作值。', 'description' => '操作值。', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '实际值。'."\n" .'- active 开麦'."\n" .'- inactive 闭麦', 'description' => '实际值。'."\n" .'- active 开麦'."\n" .'- inactive 闭麦', 'type' => 'string', 'required' => true, 'example' => 'inactive', 'enum' => [ 'inactive', 'active', ], ], ], 'required' => true, ], 'Ids' => [ 'title' => '用户ID列表。', 'description' => '用户ID列表。', 'type' => 'array', 'items' => [ 'title' => '具体用户ID。', 'description' => '具体用户ID。', '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' => '请求ID。', 'type' => 'string', 'example' => 'E7997404-5858-5C4D-94E4-33677412ACDC', ], 'ErrTracks' => [ 'title' => '错误跟踪。', 'description' => '错误跟踪。', 'type' => 'array', 'items' => [ 'title' => '具体错误。', 'description' => '具体错误。', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => 'Id。', 'description' => '用户ID。', '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"}]', 'title' => 'Sip端开关麦克风控制', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已存在的频道ID，仅支持传单个ID。', 'description' => '已存在的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'title' => '模版ID。', 'description' => '模版ID。', 'type' => 'string', 'required' => true, 'example' => '567', 'maxLength' => 128, 'minLength' => 1, 'pattern' => '^[\\w.-]+$', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', 'description' => '任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。', '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' => '单元格设置，做多设置16个。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SourceType' => [ 'title' => '单元格媒体类型。取值：'."\n" .'- **video**：用户摄像头或者屏幕共享流（默认值）。'."\n" .'- **camera**：摄像头流。'."\n" .'- **screen**：共享屏幕流。', 'description' => '单元格媒体类型。取值：'."\n" .'- **video**：用户摄像头或者屏幕共享流（默认值）。'."\n" .'- **camera**：摄像头流。'."\n" .'- **screen**：共享屏幕流。', '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' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', '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' => 'z轴层级。', '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' => 'z轴层级。', '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' => '字体。'."\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', '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' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', '3', ], ], 'PaneId' => [ 'title' => '窗格ID，从0开始。', 'description' => '窗格ID，从0开始。', 'type' => 'string', 'required' => true, 'example' => '0', 'pattern' => '^\\d+$', 'enum' => [], ], 'Source' => [ 'title' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" .' - **$ActiveSpeaker**：当前频道发言人'."\n" .' - **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', 'description' => '单元格媒体源。可指定userId，如需指定特定用户类型。可使用通配符配置，支持以下类型。'."\n" .' - **$ActiveSpeaker**：当前频道发言人'."\n" .' - **$ScreenShare**： 屏幕共享用户，当频道中有多个屏幕共享时，将按照先后顺序依次填充', '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' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', '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' => 'z轴层级。', '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' => '裁剪方式。取值：'."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边。'."\n" .'- **3**：拉伸铺满。', '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' => 'z轴层级。', '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' => 'z轴层级。', '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' => '字体。'."\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', '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' => 'z轴层级。', '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' => '字体。'."\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', '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' => '用户名单类型，黑名单：black，白名单：white。', 'type' => 'string', 'required' => true, 'example' => 'white', 'enum' => [ 'white', 'black', ], ], 'Ids' => [ 'title' => '指定用户ID列表。', 'description' => '指定用户ID列表。', 'type' => 'array', 'items' => [ 'title' => '具体用户ID。', 'description' => '具体用户ID。', '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' => '任务ID。', 'type' => 'string', 'example' => '123', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '231470C1-ACFB-4C9F-844F-4CFE1E3804C5', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"123\\",\\n \\"RequestId\\": \\"231470C1-ACFB-4C9F-844F-4CFE1E3804C5\\"\\n}","type":"json"}]', 'title' => '编辑合流布局', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '已存在的频道ID，仅支持传单个ID。', 'description' => '已存在的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '合流任务ID。', 'description' => '合流任务ID。', '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' => [ 'screen-cast' => 'screen-cast', 'main' => 'main', ], 'example' => 'main', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E7C44674-9065-5BBA-AB77-A5F20908E73B', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C44674-9065-5BBA-AB77-A5F20908E73B\\"\\n}","type":"json"}]', 'title' => '修改Sip流配置', 'description' => '### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615806196', ], ], [ 'name' => 'EndTs', 'in' => 'query', 'schema' => [ 'title' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', 'description' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615892596', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '频道ID', 'description' => '频道ID。', 'type' => 'string', 'required' => false, 'example' => '311', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'title' => '用户ID', 'description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => 'c906531af5f9****', ], ], [ 'name' => 'CallStatus', 'in' => 'query', 'schema' => [ 'title' => '通信状态。取值：IN：进行中。OUT：已结束。', 'description' => '通信状态。取值：'."\n" .'- **IN**：进行中。'."\n" .'- **OUT**：已结束。', 'type' => 'string', 'required' => false, 'example' => 'OUT', ], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ 'title' => '排序字段。取值：BAD_EXP_USER_COUNT_DESC：按体验欠佳人数降序。BAD_EXP_USER_COUNT_ASC：按体验欠佳人数升序', 'description' => '排序字段。取值：'."\n" .'- **BAD_EXP_USER_COUNT_DESC**：按体验欠佳人数降序。'."\n" .'- **BAD_EXP_USER_COUNT_ASC**：按体验欠佳人数升序。', 'type' => 'string', 'required' => false, 'example' => 'BAD_EXP_USER_COUNT_DESC', ], ], [ 'name' => 'QueryMode', 'in' => 'query', 'schema' => [ 'title' => '查询模式。取值：ALL：全部通话。FOLLOW：关注通话。', 'description' => '查询模式。取值：'."\n" .'- **ALL**：全部通话。'."\n" .'- **FOLLOW**：关注通话。', 'type' => 'string', 'required' => false, 'example' => 'ALL', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'title' => '页码', 'description' => '页码。最小1， 最大200。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页数量', 'description' => '每页数量，最小1， 最大200。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNo' => [ 'title' => '页码。', 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '每页数量。', 'description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCnt' => [ 'title' => '总数量。', 'description' => '总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CallList' => [ 'title' => '通信列表。', 'description' => '通信列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => 'App ID。', 'description' => 'App ID。', 'type' => 'string', 'example' => 'testappid', ], 'ChannelId' => [ 'title' => '频道ID。', 'description' => '频道ID。', 'type' => 'string', 'example' => '311', ], 'CallStatus' => [ 'title' => '通信状态，IN：进行中，OUT：已结束', 'description' => '通信状态。取值：'."\n" .'- **IN**：进行中。'."\n" .'- **OUT**：已结束。', 'type' => 'string', 'example' => 'OUT', ], 'CreatedTs' => [ 'title' => '通信的创建时间戳，使用UNIX时间戳表示，单位：秒。', 'description' => '通信的创建时间戳，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1615806196', ], 'DestroyedTs' => [ 'title' => '通信的释放时间戳，使用UNIX时间戳表示，单位：秒。', 'description' => '通信的释放时间戳，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1615806296', ], 'Duration' => [ 'title' => '通信持续时长，单位：秒。', 'description' => '通信持续时长，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'UserCnt' => [ 'title' => '通信用户数。', 'description' => '通信用户数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'BadExpUserCnt' => [ 'title' => '通信体验差的用户数。', 'description' => '通信体验差的用户数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '分页查询时间范围内通信信息', 'description' => '### 使用说明'."\n" .'本接口用于查询时间范围内创建的通信信息。例如：您可以查询通讯时长、状态、用户数等信息。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeCall' => [ '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' => 'testappid', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '频道ID。', 'description' => '频道ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'CreatedTs', 'in' => 'query', 'schema' => [ 'title' => '创建频道时间，使用UNIX时间戳表示，单位：秒。', 'description' => '创建频道时间，支持查询最近30天的数据。使用UNIX时间戳表示，单位：秒。'."\n" .'> 创建频道时间必须与实际创建时间完全一致（精确到秒）。您可以通过调用接口[DescribeCallList](~~2655884~~)查看创建频道时间（返回的CreatedTS参数）。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1614936817', ], ], [ 'name' => 'DestroyedTs', 'in' => 'query', 'schema' => [ 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', 'description' => '释放频道时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。'."\n" .'> 如果传入的频道释放时间超过真实的释放时间，将返回从创建时间开始到真实释放时间之间的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614936817', ], ], [ 'name' => 'ExtDataType', 'in' => 'query', 'schema' => [ 'title' => '查询的扩展。取值：USER_DURATION_STAT：用户时长统计数据类型。', 'description' => '查询的扩展。取值：USER_DURATION_STAT：用户时长统计数据类型。', 'type' => 'string', 'required' => false, 'example' => 'USER_DURATION_STAT', ], ], [ 'name' => 'QueryExpInfo', 'in' => 'query', 'schema' => [ 'title' => '是否查询通信体验信息，不传默认是true', 'description' => '是否查询通信体验信息，不传默认是true。', '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' => 'testappid', ], 'ChannelId' => [ 'title' => '频道ID。', 'description' => '频道ID。', 'type' => 'string', 'example' => '123456', ], 'CallStatus' => [ 'title' => '通信状态。取值：IN：进行中。OUT：已结束。', 'description' => '通信状态。取值：'."\n" .'- **IN**：进行中。'."\n" .'- **OUT**：已结束。', 'type' => 'string', 'example' => 'IN', ], 'CreatedTs' => [ 'title' => '创建通信时间，使用UNIX时间戳表示，单位：秒。', 'description' => '创建频道时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1615860711', ], 'DestroyedTs' => [ 'title' => '释放通信时间，使用UNIX时间戳表示，单位：秒。', 'description' => '释放频道时间，使用UNIX时间戳表示，单位：秒。', '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' => '用户ID。', 'type' => 'string', 'example' => 'testuserid', ], 'Roles' => [ 'title' => '用户角色，取值：SENDER：发布端。RECEIVER：订阅端。', 'description' => '用户角色。', 'type' => 'array', 'items' => [ 'description' => '用户角色，取值：'."\n" .'- **SENDER**：发布端。'."\n" .'- **RECEIVER**：订阅端。', 'type' => 'string', 'example' => 'SENDER', ], ], 'Location' => [ 'title' => '地理位置信息，例如：北京市-北京市', 'description' => '地理位置信息，例如：北京市-北京市。', 'type' => 'string', 'example' => '浙江省-杭州市', ], 'OnlinePeriods' => [ 'title' => '在线时段信息。', 'description' => '在线时段信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'JoinTs' => [ 'title' => '加入通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '加入频道时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614936817', ], 'LeaveTs' => [ 'title' => '离开通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '离开频道时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614936817', ], ], ], ], 'CreatedTs' => [ 'title' => '创建通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '第一次加入频道的时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614936817', ], 'DestroyedTs' => [ 'title' => '释放通话时间，使用UNIX时间戳表示，单位：秒。通话未结束时值为0。', 'description' => '最后一次离开频道的时间，使用UNIX时间戳表示，单位：秒。通信未结束时值为空。', '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' => 'SDK版本，如1.0.0、1.1.1等', 'type' => 'string', 'example' => '1.0.0', ], 'SdkVersionList' => [ 'title' => 'SDK版本列表，如1.0.0、1.1.1等', 'description' => 'SDK版本列表，如1.0.0、1.1.1等', 'type' => 'array', 'items' => [ 'description' => 'SDK版本列表，例如1.0.0、1.1.1等。', 'type' => 'string', 'enumValueTitles' => [], 'example' => '1.0.0', ], ], 'Os' => [ 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', 'description' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型。', 'type' => 'string', 'example' => 'iOS', ], 'OsList' => [ 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', 'description' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型。', 'type' => 'array', 'items' => [ 'description' => '浏览器或操作系统类型，例如Chrome、iOS、Android等。', 'type' => 'string', 'example' => 'iOS', ], ], 'Network' => [ 'title' => '网络类型，如WiFi，4G等', 'description' => '网络类型，如WiFi，4G等。', 'type' => 'string', 'example' => '4G', ], 'NetworkList' => [ 'title' => '网络类型，如WiFi，4G等', 'description' => '网络类型，如WiFi，4G等。', 'type' => 'array', 'items' => [ 'description' => '网络类型，例如WiFi，4G等。', 'type' => 'string', 'example' => '4G', ], ], 'CallExp' => [ 'title' => '通话体验，取值：GOOD:优良，BAD:欠佳。', 'description' => '通话体验。取值：'."\n" .'- **GOOD**：良好。'."\n" .'- **BAD**：欠佳。', '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' => '发布360P视频时长，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SubVideo360' => [ 'title' => '订阅360P视频时长，单位：秒', 'description' => '订阅360P视频时长，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'PubVideo720' => [ 'title' => '发布720P视频时长，单位：秒', 'description' => '发布720P视频时长，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SubVideo720' => [ 'title' => '订阅720P视频时长，单位：秒', 'description' => '订阅720P视频时长，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'PubVideo1080' => [ 'title' => '发布1080P视频时长，单位：秒', 'description' => '发布1080P视频时长，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SubVideo1080' => [ 'title' => '订阅1080P视频时长，单位：秒', 'description' => '订阅1080P视频时长，单位：秒。', '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' => '请求ID。', '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"}]', 'title' => '查询单次通信详情', 'description' => '### 使用说明'."\n" .'本接口用于查询单次通信详情。例如：您可以查询通讯状态、用户详情等信息。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribePubUserListBySubUser' => [ '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' => 'testappid', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '频道ID。', 'description' => '频道ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'CreatedTs', 'in' => 'query', 'schema' => [ 'title' => '频道创建时间，使用UNIX时间戳表示，单位：秒。', 'description' => '频道创建时间，支持查询最近30天的数据。使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1614936817', ], ], [ 'name' => 'DestroyedTs', 'in' => 'query', 'schema' => [ 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', 'description' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。'."\n" .'> 如果传入的频道释放时间超过真实的释放时间，将返回从创建时间开始到真实释放时间之间的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614936817', ], ], [ 'name' => 'SubUserId', 'in' => 'query', 'schema' => [ 'title' => '订阅端用户ID。', 'description' => '订阅端用户ID。', 'type' => 'string', 'required' => true, 'example' => 'testuserid', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'SubUserDetail' => [ 'title' => '订阅端用户详细信息。', 'description' => '订阅端用户详细信息。', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => 'testuserid', ], 'UserIdAlias' => [ 'title' => '用户ID别称', 'description' => '用户ID别称。', 'type' => 'string', 'example' => 'yi****', ], 'Roles' => [ 'title' => '用户角色，取值：SENDER：发布端。RECEIVER：订阅端。', 'description' => '用户角色。', 'type' => 'array', 'items' => [ 'description' => '用户角色。取值：'."\n" .'- **SENDER**：发布端。'."\n" .'- **RECEIVER**：订阅端。', 'type' => 'string', 'example' => 'SENDER', ], ], 'Location' => [ 'title' => '地理位置信息，例如：浙江省-杭州市。', 'description' => '地理位置信息，例如：浙江省-杭州市。', 'type' => 'string', 'example' => '浙江省-杭州市', ], 'OnlinePeriods' => [ 'title' => '在线时段信息。', 'description' => '在线时段信息。', 'type' => 'array', 'items' => [ 'description' => '在线时段信息数据。', 'type' => 'object', 'properties' => [ 'JoinTs' => [ 'title' => '加入通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '加入频道时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614936817', ], 'LeaveTs' => [ 'title' => '离开通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '离开频道时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614936817', ], ], ], ], 'CreatedTs' => [ 'title' => '第一次加入通话的时间，使用UNIX时间戳表示，单位：秒。', 'description' => '第一次加入频道的时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614936817', ], 'DestroyedTs' => [ 'title' => '最后一次离开通话的时间，使用UNIX时间戳表示，单位：秒。通话未结束时值为0。', 'description' => '最后一次离开频道的时间，使用UNIX时间戳表示，单位：秒。', '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' => 'SDK版本。', 'type' => 'string', 'example' => '1.0.0', ], 'SdkVersionList' => [ 'title' => 'SDK版本列表，如1.0.0、1.1.1等', 'description' => 'SDK版本列表，如1.0.0、1.1.1等。', 'type' => 'array', 'items' => [ 'description' => 'SDK版本列表，例如：1.0.0、1.1.1等。', 'type' => 'string', 'example' => '1.0.0', ], ], 'Os' => [ 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', 'description' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型。', 'type' => 'string', 'example' => 'iOS', ], 'OsList' => [ 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', 'description' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型。', 'type' => 'array', 'items' => [ 'description' => '浏览器或操作系统类型，例如Chrome、iOS、Android等。', 'type' => 'string', 'example' => 'iOS', ], ], 'Network' => [ 'title' => '网络类型，如WiFi，4G等', 'description' => '网络类型，如WiFi，4G等。', 'type' => 'string', 'example' => '4G', ], 'NetworkList' => [ 'title' => '网络类型，如WiFi，4G等', 'description' => '网络类型，如WiFi，4G等。', 'type' => 'array', 'items' => [ 'description' => '网络类型，例如WiFi、4G等。', 'type' => 'string', 'example' => '4G', ], ], 'ClientType' => [ 'title' => '端类型，取值：WEB：Web端。NATIVE：本地端。', 'description' => '端类型，取值：WEB：Web端。NATIVE：本地端。', 'type' => 'string', 'example' => 'NATIVE', ], ], ], 'PubUserDetailList' => [ 'title' => '发布端用户详情信息。', 'description' => '发布端用户详情信息。', 'type' => 'array', 'items' => [ 'description' => '发布端用户详情信息。', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => 'testuserid2', ], 'UserIdAlias' => [ 'title' => '用户ID别称', 'description' => '用户ID别称。', 'type' => 'string', 'example' => 'yi****', ], 'Roles' => [ 'title' => '用户角色，取值：SENDER：发起者。RECEIVER：接收者。', 'description' => '用户角色，取值：SENDER：发起者。RECEIVER：接收者。', 'type' => 'array', 'items' => [ 'description' => '用户角色。取值：'."\n" .'- **SENDER**：发起者。'."\n" .'- **RECEIVER**：接收者。', 'type' => 'string', 'example' => 'SENDER', ], ], 'Location' => [ 'title' => '地理位置信息，例如：浙江省-杭州市。', 'description' => '地理位置信息，例如：浙江省-杭州市。', 'type' => 'string', 'example' => '浙江省-杭州市', ], 'OnlinePeriods' => [ 'title' => '在线时段信息。', 'description' => '在线时段信息。', 'type' => 'array', 'items' => [ 'description' => '在线时段信息。', 'type' => 'object', 'properties' => [ 'JoinTs' => [ 'title' => '加入通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '加入频道时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614936817', ], 'LeaveTs' => [ 'title' => '离开通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '离开频道时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614936817', ], ], ], ], 'CreatedTs' => [ 'title' => '第一次加入通话的时间，使用UNIX时间戳表示，单位：秒。', 'description' => '第一次加入频道的时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614936817', ], 'DestroyedTs' => [ 'title' => '最后一次离开通话的时间，使用UNIX时间戳表示，单位：秒。', 'description' => '最后一次离开频道的时间，使用UNIX时间戳表示，单位：秒。', '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' => 'SDK版本。', 'type' => 'string', 'example' => '1.0.0', ], 'SdkVersionList' => [ 'title' => 'SDK版本列表，如1.0.0、1.1.1等', 'description' => 'SDK版本列表，如1.0.0、1.1.1等。', 'type' => 'array', 'items' => [ 'description' => 'SDK版本列表，例如：1.0.0、1.1.1等。', 'type' => 'string', 'example' => '1.0.0', ], ], 'Os' => [ 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', 'description' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型。', 'type' => 'string', 'example' => 'iOS', ], 'OsList' => [ 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', 'description' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型。', 'type' => 'array', 'items' => [ 'description' => '浏览器或操作系统类型，例如Chrome、iOS、Android等。', 'type' => 'string', 'example' => 'iOS', ], ], 'Network' => [ 'title' => '网络类型，如WiFi，4G等', 'description' => '网络类型，如WiFi，4G等。', 'type' => 'string', 'example' => '4G', ], 'NetworkList' => [ 'title' => '网络类型，如WiFi，4G等', 'description' => '网络类型，如WiFi，4G等。', 'type' => 'array', 'items' => [ 'description' => '网络类型，例如WiFi、4G等。', 'type' => 'string', 'example' => '4G', ], ], 'ClientType' => [ 'title' => '端类型，取值：WEB：Web端。NATIVE：本地端。', 'description' => '端类型，取值：WEB：Web端。NATIVE：本地端。', 'type' => 'string', 'example' => 'NATIVE', ], 'CallIdList' => [ 'title' => '用户通信流的Call ID。', 'description' => '用户通信流的Call ID。', 'type' => 'array', 'items' => [ 'description' => '用户通信流的Call ID。'."\n" ."\n" .'> 当订阅端有订阅的下行数据并且对应发布端的上行数据缺失时返回该字段，同时，PubUserDetailList中对象的其他字段（例如UserId、Roles等）不会返回。', 'type' => 'string', 'example' => 'testcallid', ], ], ], ], ], 'CallStatus' => [ 'title' => '通信状态。取值：IN：进行中。OUT：已结束。', 'description' => '通信状态。取值：'."\n" .'- **IN**：进行中。'."\n" .'- **OUT**：已结束。', 'type' => 'string', 'example' => 'IN', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '订阅端获取通信中发布端用户列表', 'description' => '### 使用说明'."\n" .'本接口用于根据订阅端获取通信中发布端用户列表。例如：您可以获取订阅端和发布端用户详情信息。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeEndPointEventList' => [ 'summary' => '本接口用于获取端对端用户事件列表。', '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' => '频道ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'CreatedTs', 'in' => 'query', 'schema' => [ 'title' => '事件查询时间区间的开始时间，该时间不得早于频道实际的创建时间，不得早于30天之前。使用UNIX时间戳表示，单位：秒。', 'description' => '事件查询时间区间的开始时间，该时间不得早于频道实际的创建时间，不得早于30天之前。使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1614936817', ], ], [ 'name' => 'DestroyedTs', 'in' => 'query', 'schema' => [ 'title' => '事件查询时间区间的结束时间，该时间不得晚于频道释放时间。使用UNIX时间戳表示，单位：秒。参数为空，表示获取当前时间。', 'description' => '事件查询时间区间的结束时间，该时间不得晚于频道释放时间。使用UNIX时间戳表示，单位：秒。参数为空，表示获取当前时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614936817', ], ], [ 'name' => 'UserIdList', 'in' => 'query', 'schema' => [ 'title' => '用户ID列表，多个用英文逗号（,）分隔。', 'description' => '用户ID列表，多个用英文逗号（,）分隔。', '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' => '用户ID。', 'type' => 'string', 'example' => 'testuserid', ], 'EventDataItems' => [ 'title' => '事件数据列表', 'description' => '事件数据列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Ts' => [ 'title' => '第一个事件发生的时间，使用UNIX时间戳表示，单位：秒。', 'description' => '第一个事件发生的时间，使用UNIX时间戳表示，单位：秒。', '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' => '事件类型。取值：'."\n" .'- **USER**：用户事件。'."\n" .'- **SYSTEM**：系统事件。', 'type' => 'string', 'example' => 'USER', ], 'Ts' => [ 'title' => '事件发生的时间，使用UNIX时间戳表示，单位：秒。', 'description' => '事件发生的时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614936817', ], 'TsInMs' => [ 'title' => '事件发生的时间，使用UNIX时间戳表示，单位：毫秒。', 'description' => '事件发生的时间，使用UNIX时间戳表示，单位：毫秒。', 'type' => 'string', 'example' => '1614936817123', ], ], ], ], ], ], ], ], ], ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '获取端对端用户事件列表', 'description' => '### 使用说明'."\n" .'本接口用于获取端对端用户事件列表。例如：在事件列表中您可以获取事件名称、事件类型等信息。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeEndPointMetricData' => [ 'summary' => '本接口用于获取端对端指标数据。', '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' => '频道ID', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'CreatedTs', 'in' => 'query', 'schema' => [ 'title' => '事件查询时间区间的开始时间，该时间不得早于频道实际的创建时间，不得早于30天之前。使用UNIX时间戳表示，单位：秒。', 'description' => '查询时间区间的开始时间，该时间不得早于频道实际的创建时间，不得早于30天之前。使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1614936817', ], ], [ 'name' => 'DestroyedTs', 'in' => 'query', 'schema' => [ 'title' => '事件查询时间区间的结束时间，该时间不得晚于频道释放时间。使用UNIX时间戳表示，单位：秒。参数为空，表示获取当前时间。', 'description' => '查询时间区间的结束时间，该时间不得晚于频道释放时间。使用UNIX时间戳表示，单位：秒。参数为空，表示获取当前时间。'."\n" ."\n" .'> 如果传入的结束时间超过频道的释放时间，将返回从开始时间开始到频道释放时间之间的数据，且最多返回最近3个小时的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614936817', ], ], [ 'name' => 'SubUserId', 'in' => 'query', 'schema' => [ 'title' => '订阅端用户ID。', 'description' => '订阅端用户ID。', 'type' => 'string', 'required' => false, 'example' => 'testuserid', ], ], [ 'name' => 'PubUserId', 'in' => 'query', 'schema' => [ 'title' => '发布端用户ID。', 'description' => '发布端用户ID。'."\n" .'> PubUserId和PubCallIdList参数只能二选一输入。', 'type' => 'string', 'required' => false, 'example' => 'testuserid2', ], ], [ 'name' => 'PubCallIdList', 'in' => 'query', 'schema' => [ 'title' => '发布端用户通信流的Call ID，多个用英文逗号（,）分隔。', 'description' => '发布端用户通信流的Call ID，多个用英文逗号（,）分隔。'."\n" .'> PubUserId和PubCallIdList参数只能二选一输入。', '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' => '对应入参Metrics中的类型。', 'type' => 'string', 'example' => 'VIDEO_STUCK_CAMERA', ], 'UserId' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => 'testuserid', ], 'Nodes' => [ 'title' => '订阅端指标趋势图坐标点列表。', 'description' => '订阅端指标趋势图坐标点列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'X' => [ 'title' => '订阅端指标趋势图中x轴横坐标。', 'description' => '订阅端指标趋势图中x轴横坐标。', 'type' => 'string', 'example' => '1548670257', ], 'Y' => [ 'title' => '订阅端指标趋势图y轴纵坐标。', 'description' => '订阅端指标趋势图y轴纵坐标。', 'type' => 'string', 'example' => '230100', ], 'Ext' => [ 'title' => '拓展属性', 'description' => '拓展属性。', 'type' => 'object', ], ], ], ], ], ], ], 'PubMetrics' => [ 'title' => '发布端用户指标数据。', 'description' => '发布端用户指标数据。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '对应入参Metrics中的类型', 'description' => '对应入参Metrics中的类型。', 'type' => 'string', 'example' => 'VIDEO_STUCK_CAMERA', ], 'UserId' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => 'testuserid', ], 'Nodes' => [ 'title' => '坐标点列表', 'description' => '坐标点列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'X' => [ 'title' => '发布端指标趋势图中x轴横坐标。', 'description' => '发布端指标趋势图中x轴横坐标。', 'type' => 'string', 'example' => '1548670257', ], 'Y' => [ 'title' => '发布端指标趋势图中y轴纵坐标。', 'description' => '发布端指标趋势图中y轴纵坐标。', 'type' => 'string', 'example' => '230100', ], 'Ext' => [ 'title' => '拓展属性', 'description' => '拓展属性。', 'type' => 'object', ], ], ], ], ], ], ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '获取端对端指标数据', 'description' => '### 使用说明'."\n" .'本接口用于获取端对端指标数据。例如：您可以获取订阅端和发布端的指标信息。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'requestParamsDescription' => '指标如下所示：'."\n" ."\n" .'| 名称 | 说明 |'."\n" .'|---------------|--------|'."\n" .'| APP_CPU | APP占用CPU。 |'."\n" .'| SYSTEM_CPU | 系统占用CPU。 |'."\n" .'| APP_MEMORY | APP占用内存。 |'."\n" .'| SYSTEM_MEMORY | 系统占用内存。 |'."\n" .'| SYSTEM_TOTAL_MEMORY | 系统总内存。 |'."\n" .'| AUDIO_LOST_RATE | 音频丢包率。 |'."\n" .'| VIDEO_LOST_RATE | 视频丢包率。 |'."\n" .'| AUDIO_RTT | 音频延时。 |'."\n" .'| VIDEO_RTT | 视频延时。 |'."\n" .'| AUDIO_BIT_RATE | 音频码率。 |'."\n" .'| AUDIO_STUCK | 音频卡顿。 |'."\n" .'| AUDIO_LEVEL | 音量。 |'."\n" .'| VIDEO_BIT_RATE_CAMERA | 摄像头视频码率。 |'."\n" .'| VIDEO_BIT_RATE_SHARE | 视频码率（屏幕分享）。 |'."\n" .'| VIDEO_STUCK_CAMERA | 摄像头视频卡顿。 |'."\n" .'| VIDEO_STUCK_SHARE | 视频卡顿（屏幕分享）。 |'."\n" .'| VIDEO_RESOLUTION_CAMERA | 摄像头视频分辨率。 |'."\n" .'| VIDEO_RESOLUTION_SHARE | 视频分辨率（屏幕分享）。 |'."\n" .'| VIDEO_FPS_CAMERA | 摄像头视频帧率。 |'."\n" .'| VIDEO_FPS_SHARE | 视频帧率（屏幕分享）。 |', ], 'DescribeQoeMetricData' => [ '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' => 'testappid', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '频道ID。', 'description' => '频道ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'CreatedTs', 'in' => 'query', 'schema' => [ 'title' => '创建频道时间，使用UNIX时间戳表示，单位：秒。', 'description' => '创建频道时间，支持查询最近30天的数据。使用UNIX时间戳表示，单位：秒', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1614936817', ], ], [ 'name' => 'DestroyedTs', 'in' => 'query', 'schema' => [ 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', 'description' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。'."\n" .'> 如果传入的频道释放时间超过真实的释放时间，将返回从创建时间开始到真实释放时间之间的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614936817', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'title' => '用户ID。', 'description' => '用户ID。', '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' => '影响通信体验的指标类型。取值：'."\n" .'- **VIDEO_CAMERA**：摄像头码率。'."\n" .'- **VIDEO_SCREEN_SHARE**：共享屏幕流码率。'."\n" .'- **VIDEO_STUCK_CAMERA**：摄像头卡顿。'."\n" .'- **VIDEO_STUCK_SCREEN_SHARE**：屏幕共享卡顿。'."\n" .'- **VIDEO_VAGUE_CAMERA**：摄像头模糊。'."\n" .'- **VIDEO_VAGUE_SCREEN_SHARE**：屏幕共享模糊。', 'type' => 'string', 'example' => 'VIDEO_CAMERA', ], 'UserId' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => 'testuserid2', ], 'Nodes' => [ 'title' => '视频指标趋势图坐标点列表。', 'description' => '视频指标趋势图坐标点列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'X' => [ 'title' => '视频指标趋势图中x轴横坐标。', 'description' => '视频指标趋势图中x轴横坐标。', 'type' => 'string', 'example' => '1548670256', ], 'Y' => [ 'title' => '视频指标趋势图中y轴纵坐标。', 'description' => '视频指标趋势图中y轴纵坐标。', 'type' => 'string', 'example' => '123', ], ], ], ], ], ], ], 'AudioData' => [ 'title' => '音频数据。', 'description' => '音频数据。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '通信体验，取值：AUDIO：音频码率。AUDIO_STUCK：音频下行卡顿。', 'description' => '通信体验。取值：'."\n" .'- **AUDIO**：音频码率。'."\n" .'- **AUDIO_STUCK**：音频下行卡顿。', 'type' => 'string', 'example' => 'AUDIO', ], 'UserId' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => 'testuserid2', ], 'Nodes' => [ 'title' => '音频指标趋势图坐标点列表。', 'description' => '音频指标趋势图坐标点列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'X' => [ 'title' => '音频指标趋势图中x轴横坐标。', 'description' => '音频指标趋势图中x轴横坐标。', 'type' => 'string', 'example' => '1548670256', ], 'Y' => [ 'title' => '音频指标趋势图中y轴纵坐标。', 'description' => '音频指标趋势图中y轴纵坐标。', 'type' => 'string', 'example' => '123', ], ], ], ], ], ], ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID。', '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"}]', 'title' => '单次通信中下行体验质量指标', 'description' => '### 使用说明'."\n" .'本接口用于获取单次通信中用户的下行体验质量指标。例如：您可以获取影响通信体验的指标类型、音视频指标趋势图等信息。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeChannelOverallData' => [ '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' => 'testappid', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '频道ID。', 'description' => '频道ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'CreatedTs', 'in' => 'query', 'schema' => [ 'title' => '创建频道的时间戳，使用UNIX时间戳表示，单位：秒。', 'description' => '创建频道的时间戳，支持查询最近30天的数据。使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615860711', ], ], [ 'name' => 'DestroyedTs', 'in' => 'query', 'schema' => [ 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', 'description' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。'."\n" .'> 如果传入的频道释放时间超过真实的释放时间，将返回从创建时间开始到真实释放时间之间的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615860811', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'MetricDatas' => [ 'title' => '指标数据列表。', 'description' => '指标数据列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '指标类型，取值：CALL_QUALITY：通信质量。CONN_NUM：通信次数。', 'description' => '指标类型。取值：'."\n" .'- **CALL_QUALITY**：通信质量。'."\n" .'- **CONN_NUM**：加入频道成功用时的区间分布。', 'type' => 'string', 'example' => 'CALL_QUALITY', ], 'Nodes' => [ 'title' => '指标趋势图坐标点列表。', 'description' => '指标趋势图坐标点列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'X' => [ 'title' => '指标趋势图中x轴横坐标。', 'description' => '指标趋势图中x轴横坐标。', 'type' => 'string', 'example' => '1612418625', ], 'Y' => [ 'title' => '指标趋势图中y轴纵坐标。', 'description' => '指标趋势图中y轴纵坐标。', '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' => '5秒内连通成功率，用小数表示，例如1.0表示连通成功率为100%。', 'type' => 'number', 'format' => 'float', 'example' => '0.91', ], 'TotalAudioStuckRate' => [ 'title' => '整体音频卡顿率，用小数表示，例如0.02表示音频卡顿率为2%。', 'description' => '整体音频卡顿率，用小数表示，例如0.02表示音频卡顿率为2%。', 'type' => 'number', 'format' => 'float', 'example' => '0.02', ], 'TotalVideoStuckRate' => [ 'title' => '整体视频卡顿率，用小数表示，例如0.02表示视频卡顿率为2%。', 'description' => '整体视频卡顿率，用小数表示，例如0.02表示视频卡顿率为2%。', 'type' => 'number', 'format' => 'float', 'example' => '0.02', ], 'TotalVideoVagueRate' => [ 'title' => '整体视频模糊率，用小数表示，例如0.02表示视频模糊率为2%。', 'description' => '整体视频模糊率，用小数表示，例如0.02表示视频模糊率为2%。', 'type' => 'number', 'format' => 'float', 'example' => '0.02', ], ], ], 'CallInfo' => [ 'title' => '通信基本信息。', 'description' => '通信基本信息。', 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => '应用ID。', 'description' => '应用ID。', 'type' => 'string', 'example' => 'testappid', ], 'ChannelId' => [ 'title' => '频道ID。', 'description' => '频道ID。', 'type' => 'string', 'example' => 'testid', ], 'CallStatus' => [ 'title' => '通信状态，取值：IN：进行中。OUT：已结束', 'description' => '通信状态。取值：'."\n" ."\n" .'- **IN**：进行中。'."\n" ."\n" .'- **OUT**：已结束。', 'type' => 'string', 'example' => 'IN', ], 'CreatedTs' => [ 'title' => '创建通信的时间戳，使用UNIX时间戳表示，单位：秒。', 'description' => '创建频道的时间戳，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1615860711', ], 'DestroyedTs' => [ 'title' => '释放通信的时间戳，使用UNIX时间戳表示，单位：秒。', 'description' => '释放频道的时间戳，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1615860811', ], 'Duration' => [ 'title' => '通信时长，单位：秒。', 'description' => '频道时长，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '查询频道概览数据', 'description' => '### 使用说明'."\n" .'本接口用于查询频道概览数据。例如：您可以查询通信基本信息、指标趋势图等信息。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeChannelDistributionStatData' => [ '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' => 'testappid', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '频道ID', 'description' => '频道ID', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'CreatedTs', 'in' => 'query', 'schema' => [ 'title' => '创建频道的时间戳，使用UNIX时间戳表示，单位：秒。', 'description' => '创建频道的时间戳，支持查询最近30天的数据。使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1614936817', ], ], [ 'name' => 'DestroyedTs', 'in' => 'query', 'schema' => [ 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', 'description' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。'."\n" .'> 如果传入的频道释放时间超过真实的释放时间，将返回从创建时间开始到真实释放时间之间的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614936817', ], ], [ 'name' => 'StatDim', 'in' => 'query', 'schema' => [ 'title' => '统计维度，取值：OS：按照系统统计。SDK_VERSION：按照SDK版本统计。', 'description' => '统计维度。取值：'."\n" .'- **OS**：按照系统统计。'."\n" .'- **SDK_VERSION**：按照SDK版本统计。', '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' => '通信人数占比，用小数表示，例如1.0000表示通信人数占比为100%。', 'type' => 'string', 'example' => '1.0000', ], ], ], ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '获取频道分布统计数据', 'description' => '### 使用说明'."\n" .'本接口用于获取频道分布统计数据。您可以按系统类型或SDK版本不同维度统计数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeChannelAreaDistributionStatData' => [ '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' => 'testappid', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '频道ID', 'description' => '频道ID', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'CreatedTs', 'in' => 'query', 'schema' => [ 'title' => '频道创建时间，使用UNIX时间戳表示，单位：秒。', 'description' => '创建频道的时间戳，支持查询最近30天的数据。使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1614936817', ], ], [ 'name' => 'DestroyedTs', 'in' => 'query', 'schema' => [ 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', 'description' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。'."\n" .'> 如果传入的频道释放时间超过真实的释放时间，将返回从创建时间开始到真实释放时间之间的数据。', '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' => '优质传输率，用小数表示，例如0.9999表示优质传输率为99.99%。', 'type' => 'string', 'example' => '0.9999', ], ], ], ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '获取频道地区分布统计数据', 'description' => '### 使用说明'."\n" .'本接口用于获取频道地区分布统计数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeChannelTopPubUserList' => [ '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' => 'testappid', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '频道ID。', 'description' => '频道ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'CreatedTs', 'in' => 'query', 'schema' => [ 'title' => '创建频道的时间戳，使用UNIX时间戳表示，单位：秒。', 'description' => '创建频道的时间戳，支持查询最近30天的数据。使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615893133', ], ], [ 'name' => 'DestroyedTs', 'in' => 'query', 'schema' => [ 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', 'description' => '释放频道的时间戳，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。'."\n" .'> 如果传入的频道释放时间超过真实的释放时间，将返回从创建时间开始到真实释放时间之间的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615893757', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TopPubUserDetailList' => [ 'title' => 'Top发布用户详情列表', 'description' => 'Top发布用户详情列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => 'testuserid', ], 'Location' => [ 'title' => '地域位置，例如：北京市-北京市', 'description' => '地域位置，例如：北京市-北京市', 'type' => 'string', 'example' => '浙江省-杭州市', ], 'OnlinePeriods' => [ 'title' => '在线期间用户列表。', 'description' => '在线期间用户列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'JoinTs' => [ 'title' => '加入通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '加入频道时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1615893327', ], 'LeaveTs' => [ 'title' => '离开通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '离开频道时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1615893442', ], ], ], ], 'CreatedTs' => [ 'title' => '第一次加入通话的时间，使用UNIX时间戳表示，单位：秒。', 'description' => '第一次加入频道的时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1615893327', ], 'DestroyedTs' => [ 'title' => '最后一次离开通话的时间，使用UNIX时间戳表示，单位：秒。通话未结束时值为0。', 'description' => '最后一次离开频道的时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1615893442', ], 'OnlineDuration' => [ 'title' => '通信时长，单位：秒。', 'description' => '通信时长，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '115', ], 'Duration' => [ 'title' => '总时长，单位：秒。', 'description' => '总时长，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '115', ], ], ], ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '获取频道内发布端的用户列表', 'description' => '### 使用说明'."\n" .'本接口用于获取频道内发布端的用户列表（按用户在线时长降序）。例如：在用户列表中您可以查询用户加入通话时间、通信时长等信息。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeChannelUserMetrics' => [ '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' => 'testappid', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '频道ID。', 'description' => '频道ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], [ 'name' => 'CreatedTs', 'in' => 'query', 'schema' => [ 'title' => '频道的创建时间戳，使用UNIX时间戳表示，单位：秒。', 'description' => '创建频道的时间戳，支持查询最近30天的数据。使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1614936817', ], ], [ 'name' => 'DestroyedTs', 'in' => 'query', 'schema' => [ 'title' => '频道释放时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。', 'description' => '释放频道的时间戳，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。'."\n" .'> 如果传入的频道释放时间超过真实的释放时间，将返回从创建时间开始到真实释放时间之间的数据。', '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' => '指标类型。取值：'."\n" .'- **ALL_NUM**：单位时间内的用户数量。'."\n" .'- **PUB_NUM**：单位时间内发布端的用户数量。'."\n" .'- **SUB_NUM**：单位时间内订阅端的用户数量。'."\n" .'- **JOIN_FAIL_NUM**：单位时间内加入频道异常的用户数量。'."\n" .'- **BAD_EXP_NUM**：单位时间内通信体验异常的用户数量。', 'type' => 'string', 'example' => 'ALL_NUM', ], 'Nodes' => [ 'title' => '指标趋势图坐标点列表。', 'description' => '指标趋势图坐标点列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'X' => [ 'title' => '指标趋势图中x轴横坐标。', 'description' => '指标趋势图中x轴横坐标。', 'type' => 'string', 'example' => '1612418625', ], 'Y' => [ 'title' => '指标趋势图中y轴纵坐标。', 'description' => '指标趋势图中y轴纵坐标。', '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' => '请求ID。', '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"}]', 'title' => '查询频道概览中的用户数据', 'description' => '### 使用说明'."\n" .'本接口用于查询频道概览中的用户数据。例如：您可以查询指标数据详情、概览数据等信息。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeUsageOverallData' => [ 'summary' => '本接口用于获取用量统计的概览数据。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始时间，秒级时间戳：1609344000', 'description' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615824000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束时间，秒级时间戳：1609344000', 'description' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', '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' => '查询的指标类型，多个用英文逗号（,）分隔。取值：'."\n" .'- **TOTAL_CALL_DURATION**：总时长。'."\n" .'- **VIDEO_CALL_DURATION**：视频通信时长。'."\n" .'- **AUDIO_CALL_DURATION**：音频通信时长。'."\n" .'- **CALL_CHANNEL_COUNT**：通信频道数。'."\n" .'- **HIGHLY_CONCURRENT_CHANNEL_COUNT**：高并发通信频道数。'."\n" .'- **CHANNEL_CONCURRENT_PEAK**：并发频道数峰值。'."\n" .'- **ONLINE_USER_PEAK**：在线人数峰值。'."\n" .'- **TOTAL_CALL_USER**：累计通话人数。'."\n" .'- **TOTAL_INOUT_NUM**：累计进出人次。', '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' => '指标趋势图中x轴横坐标。', 'type' => 'string', 'example' => '1615824000', ], 'Y' => [ 'title' => 'y轴横坐标', 'description' => '指标趋势图中y轴纵坐标。', 'type' => 'string', 'example' => '1', ], ], ], ], ], ], ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID。', '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"}]', 'title' => '获取用量统计的概览数据', 'description' => '### 使用说明'."\n" .'本接口用于获取用量统计的概览数据。使用该接口时，限制如下：'."\n" .'- 支持查询最近365天（不包含查询当天）任意范围的数据。'."\n" .'- 如果查询范围小于24小时，则按小时统计查询的数据；如果查询范围大于或等于24小时，则按天统计查询的数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeUsageDistributionStatData' => [ 'summary' => '本接口用于获取用量统计的分布数据。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始时间，秒级时间戳：如1609344000', 'description' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615824000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束时间，秒级时间戳：如1609344000', 'description' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615910399', ], ], [ 'name' => 'StatDim', 'in' => 'query', 'schema' => [ 'title' => '统计维度，支持最多填入一个 CHANNEL_ONLINE, NETWORK, OS', 'description' => '统计维度。取值：'."\n" .'- **CHANNEL_ONLINE**：按照频道在线人数统计。'."\n" .'- **NETWORK**：按照网络类型统计。'."\n" .'- **OS**：按照系统类型统计。', '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' => [ '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' => '统计维度。取值：'."\n" .'- 当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人以上）。 '."\n" .'- 当StatDim为NETWORK时，取值：**WiFi**、**4G**等。 '."\n" .'- 当StatDim为OS时，取值：**iOS**、**Android**等。', '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' => '通话时长占比，四位小数表示，如0.9782。', 'type' => 'string', 'example' => '0.9782', ], ], ], ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID。', '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"}]', 'title' => '获取用量统计的分布数据', 'description' => '### 使用说明'."\n" .'本接口用于获取用量统计的分布数据。使用该接口时，限制如下：'."\n" .'- 支持查询最近365天（不包含查询当天）任意范围的数据。'."\n" .'- 如果查询范围小于24小时，则按小时统计查询的数据；如果查询范围大于或等于24小时，则按天统计查询的数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeUsageAreaDistributionStatData' => [ 'summary' => '本接口用于获取用量统计的地域分布数据。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始时间，秒级时间戳，如1609344000', 'description' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'string', 'required' => true, 'example' => '1615824000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束时间，秒级时间戳，如1609344000', 'description' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', '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' => '请求ID。', '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"}]', 'title' => '获取用量统计的地域分布数据', 'description' => '### 使用说明'."\n" .'本接口用于获取用量统计的地域分布数据。使用该接口时，限制如下：'."\n" .'- 支持查询最近365天（不包含查询当天）任意范围的数据。'."\n" .'- 如果查询范围小于24小时，则按小时统计查询的数据；如果查询范围大于或等于24小时，则按天统计查询的数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeUsageOsSdkVersionDistributionStatData' => [ 'summary' => '本接口用于获取用量统计中各操作系统及SDK版本的分布数据。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始时间，秒级时间戳：1609344000', 'description' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615824000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束时间，秒级时间戳：1609344000', 'description' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', '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' => '用量统计SDK版本数据列表。', 'type' => 'array', 'items' => [ 'description' => '用量统计中操作系统及SDK版本的数据详情。', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => 'SDK版本名称，1.0.0、1.1.1等', 'description' => 'SDK版本名称，1.0.0、1.1.1等。', 'type' => 'string', 'example' => '1.0.0', ], 'Os' => [ 'title' => '操作系统，如iOS、android等', 'description' => '操作系统，如iOS、android等。', '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' => '通话时长占比，四位小数表示，如0.0984。', 'type' => 'string', 'example' => '0.0984', ], ], ], ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID。', '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"}]', 'title' => '用量操作系统及SDK版本分布', 'description' => '### 使用说明'."\n" .'本接口用于获取用量统计中各操作系统及SDK版本的分布数据。使用该接口时，限制如下：'."\n" .'- 支持查询最近365天（不包含查询当天）任意范围的数据。'."\n" .'- 如果查询范围小于24小时，则按小时统计查询的数据；如果查询范围大于或等于24小时，则按天统计查询的数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeQualityOverallData' => [ 'summary' => '本接口用于获取质量统计的概览数据。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始时间，秒级时间戳，如1609344000', 'description' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615824000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束时间，秒级时间戳，如1609344000', 'description' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', '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' => '查询的指标类型，多个用英文逗号（,）分隔。取值：'."\n" .'- **JOIN_CHANNEL_SUC_RATE**：加入频道成功率。'."\n" .'- **JOIN_CHANNEL_SUC_FIVE_SEC_RATE**：五秒加入频道成功率。'."\n" .'- **VIDEO_FIRST_PIC_DUR**：首次出图时间。'."\n" .'- **AUDIO_STUCK_RATE**：音频卡顿率。'."\n" .'- **VIDEO_STUCK_RATE**：视频卡顿率。'."\n" .'- **AUDIO_DELAY**：音频延时。'."\n" .'- **VIDEO_DELAY**：视频延时。'."\n" .'- **AUDIO_HIGH_QUALITY_TRANSMISSION_RATE**：音频优质传输率。'."\n" .'- **VIDEO_HIGH_QUALITY_TRANSMISSION_RATE**：视频优质传输率。', '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' => '指标趋势图中x轴横坐标。', 'type' => 'string', 'example' => '1615831200', ], 'Y' => [ 'title' => 'y轴纵坐标', 'description' => '指标趋势图中y轴纵坐标。', 'type' => 'string', 'example' => '1.0000', ], ], ], ], 'Average' => [ 'title' => '平均值', 'description' => '该指标的平均值。', 'type' => 'string', 'example' => '0.9376', ], ], ], ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID。', '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"}]', 'title' => '获取质量统计的概览数据', 'description' => '### 使用说明'."\n" .'本接口用于获取质量统计的概览数据。使用该接口时，限制如下：'."\n" .'- 支持查询最近365天（不包含查询当天）任意范围的数据。'."\n" .'- 如果查询范围小于24小时，则按小时统计查询的数据；如果查询范围大于或等于24小时，则按天统计查询的数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeQualityDistributionStatData' => [ 'summary' => '本接口用于获取质量统计的分布数据。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始时间，秒级时间戳，如1609344000', 'description' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615824000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束时间，秒级时间戳，如1609344000', 'description' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615910399', ], ], [ 'name' => 'StatDim', 'in' => 'query', 'schema' => [ 'title' => '统计维度，支持最多填入一个 CHANNEL_ONLINE, NETWORK, OS', 'description' => '统计维度。取值：'."\n" .'- **CHANNEL_ONLINE**：按照频道在线人数统计。'."\n" .'- **NETWORK**：按照网络类型统计。'."\n" .'- **OS**：按照系统类型统计。', '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' => '统计维度。取值：'."\n" .'- 当StatDim为CHANNELONLINE时，取值：**ONE_TO_FIVE**（1~5人）、**SIX_TO_TEN**（6~10人）、**ELEVEN_TO_TWENTY**（11~20人）、**TWENTYONE_TO_FIFTY**（21~50人）、**ABOVE_FIFTY**（50人以上）。'."\n" .'- 当StatDim为NETWORK时，取值：**WiFi**、**4G**等。'."\n" .'- 当StatDim为OS时，取值：**iOS**、**Android**等。', 'type' => 'string', 'example' => 'ONE_TO_FIVE', ], 'CallDurationRatio' => [ 'title' => '通话时长用量占比，四位小数表示，如1.0000', 'description' => '通话时长占比，用四位小数表示，例如1.0000表示通话时长占比为100%。', 'type' => 'string', 'example' => '1.0000', ], 'JoinChannelSucRate' => [ 'title' => '加入频道成功率， 四位小数表示，如1.0000', 'description' => '加入频道成功率，用四位小数表示。', 'type' => 'string', 'example' => '0.9575', ], 'JoinChannelSucFiveSecRate' => [ 'title' => '5秒加入频道成功率， 四位小数表示，如1.0000', 'description' => '5秒加入频道成功率，用四位小数表示。', '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' => '请求ID。', '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"}]', 'title' => '获取质量统计的分布数据', 'description' => '### 使用说明'."\n" .'本接口用于获取质量统计的分布数据。使用该接口时，限制如下：'."\n" .'- 支持查询最近365天（不包含查询当天）任意范围的数据。'."\n" .'- 如果查询范围小于24小时，则按小时统计查询的数据；如果查询范围大于或等于24小时，则按天统计查询的数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeQualityAreaDistributionStatData' => [ 'summary' => '本接口用于获取质量统计的地域分布数据。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始时间，秒级时间戳，如1609344000', 'description' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615824000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束时间，秒级时间戳，如1609344000', 'description' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615910399', ], ], [ 'name' => 'ParentArea', 'in' => 'query', 'schema' => [ 'title' => '父级地区名称，为空取世界范围（国家维度）的统计，如： ""->中国、英国 "中国"->北京市、广东省 "广东省"->广州市、深圳市、佛山市 "北京市"->北京市', 'description' => '父级地区名称，例如：杭州市的父级为浙江省，参数设为中国_浙江省。参数为空表示世界范围（国家维度）的统计，例如：中国、英国。', 'type' => 'string', 'required' => false, 'example' => '中国_浙江省'."\n", ], ], [ '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' => '通话时长占比，用四位小数表示，例如1.0000表示通话时长占比为100%。', 'type' => 'string', 'example' => '0.6654', ], 'JoinChannelSucRate' => [ 'title' => '加入频道成功率， 四位小数表示，如1.0000', 'description' => '加入频道成功率，用四位小数表示。', 'type' => 'string', 'example' => '0.9356', ], 'JoinChannelSucFiveSecRate' => [ 'title' => '5秒加入频道成功率， 四位小数表示，如1.0000', 'description' => '5秒加入频道成功率，用四位小数表示。', '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' => '请求ID。', '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"}]', 'title' => '获取质量统计的地域分布数据', 'description' => '### 使用说明'."\n" .'本接口用于获取质量统计的地域分布数据。使用该接口时，限制如下：'."\n" .'- 支持查询最近365天（不包含查询当天）任意范围的数据。'."\n" .'- 如果查询范围小于24小时，则按小时统计查询的数据；如果查询范围大于或等于24小时，则按天统计查询的数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeQualityOsSdkVersionDistributionStatData' => [ 'summary' => '本接口用于获取质量统计中各操作系统及SDK版本的分布数据。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始时间，秒级时间戳，如1609344000', 'description' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615824000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束时间，秒级时间戳，如1609344000', 'description' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', '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' => '质量统计中操作系统及SDK版本的数据列表。', 'type' => 'array', 'items' => [ 'description' => '质量统计中操作系统及SDK版本的数据详情。', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => 'SDK版本名称，1.0.0、1.1.1等', 'description' => 'SDK版本名称，1.0.0、1.1.1等。', 'type' => 'string', 'example' => '2.1.0.210316.dev--release/rtcsdk_v2.1', ], 'Os' => [ 'title' => '操作系统名称，iOS、android等', 'description' => '操作系统名称，iOS、android等。', 'type' => 'string', 'example' => 'macOS', ], 'CallDurationRatio' => [ 'title' => '通话时长用量占比，四位小数表示，如1.0000', 'description' => '通话时长占比，用四位小数表示，例如1.0000表示通话时长占比为100%。', 'type' => 'string', 'example' => '0.0984', ], 'JoinChannelSucRate' => [ 'title' => '加入频道成功率， 四位小数表示，如1.0000', 'description' => '加入频道成功率，用四位小数表示。', 'type' => 'string', 'example' => '0.8276', ], 'JoinChannelSucFiveSecRate' => [ 'title' => '5秒加入频道成功率， 四位小数表示，如1.0000', 'description' => '5秒加入频道成功率，用四位小数表示。', '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' => '请求ID。', '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"}]', 'title' => '质量各操作系统及SDK版本分布', 'description' => '### 使用说明'."\n" .'本接口用于获取质量统计中各操作系统及SDK版本的分布数据。使用该接口时，限制如下：'."\n" .'- 支持查询最近365天（不包含查询当天）任意范围的数据。'."\n" .'- 如果查询范围小于24小时，则按小时统计查询的数据；如果查询范围大于或等于24小时，则按天统计查询的数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeFaultDiagnosisOverallData' => [ 'summary' => '调用DescribeFaultDiagnosisOverallData获取异常诊断的概览数据。', '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' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615824000', ], ], [ 'name' => 'EndTs', 'in' => 'query', 'schema' => [ 'title' => '结束时间，秒级时间戳：1609344000', 'description' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', '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' => '获取数据统计维度。取值：'."\n" .'- **JOIN_SLOW_USER**：进频道慢用户数。'."\n" .'- **AUDIO_STUCK_USER**：音频卡顿用户数。'."\n" .'- **VIDEO_STUCK_USER**：视频卡顿用户数。'."\n" .'- **VIDEO_VAGUE_USER**：视频模糊用户数。'."\n" .'- **HIGH_DELAY_USER**：通话延迟高用户数。'."\n" .'- **FIRST_FRAME_SLOW_USER**：接收首屏慢用户数。', '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.5', ], ], ], 'MetricData' => [ 'title' => '异常指标数据', 'description' => '异常指标数据。', 'type' => 'object', 'properties' => [ 'Nodes' => [ 'title' => '指标坐标点列表，单位时间为1分钟的异常用户数据', 'description' => '指标趋势图坐标点列表。', 'type' => 'array', 'items' => [ 'description' => '指标趋势图坐标点详情。', 'type' => 'object', 'properties' => [ 'X' => [ 'title' => 'x轴横坐标，秒级时间戳', 'description' => '指标趋势图中x轴横坐标，单位时间为1分钟。', 'type' => 'string', 'example' => '1615824000', ], 'Y' => [ 'title' => 'y轴横坐标，单位数据异常用户数', 'description' => '指标趋势图中y轴纵坐标。', 'type' => 'string', 'example' => '1', ], 'Ext' => [ 'title' => '拓展属性，ratio：单位时间内异常用户占比，totalCount：单位时间内用户总数', 'description' => '拓展属性，ratio：单位时间内异常用户占比，totalCount：单位时间内用户总数', 'type' => 'object', ], ], ], ], ], ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '获取异常诊断的概览数据', 'description' => '### 使用说明'."\n" .'本接口用于获取异常诊断的概览数据。使用该接口时，支持查询最近48小时且查询范围不超过24小时的数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeFaultDiagnosisFactorDistributionStat' => [ 'summary' => '调用DescribeFaultDiagnosisFactorDistributionStat获取异常诊断的影响因素分布。', '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' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615892596', ], ], [ 'name' => 'EndTs', 'in' => 'query', 'schema' => [ 'title' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', 'description' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', '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' => '影响因素ID，详情请参见下文中的影响因素ID取值。', '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' => '请求ID。', '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"}]', 'title' => '获取异常诊断的影响因素分布', 'description' => '### 使用说明'."\n" .'本接口用于获取异常诊断的影响因素分布。使用该接口时，支持查询最近48小时且查询范围不超过24小时的数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', 'responseParamsDescription' => '影响因素ID取值如下所示：'."\n" .'| ID | 描述 |'."\n" .'|---------------|--------|'."\n" .'| 1 | 发布端网络差。 |'."\n" .'| 2 | 订阅端网络差。 |'."\n" .'| 3 | 发布端设备性能差。 |'."\n" .'| 4 | 发布端关闭摄像头。 |'."\n" .'| 5 | 发布端切到后台运行。 |'."\n" .'| 6 | 发布端WiFi信号差。 |'."\n" .'| 7 | 订阅端WiFi信号差。 |'."\n" .'| 8 | 订阅端CPU使用率高。 |'."\n" .'| 9 | 订阅端CPU使用率高。 |'."\n" .'| 13 | 发布端网络延迟抖动。 |'."\n" .'| 14 | 发布端网丢包抖动。 |'."\n" .'| 15 | 发布端带宽低。 |'."\n" .'| 16 | 订阅端网络延迟抖动。 |'."\n" .'| 17 | 订阅端网络丢包抖动。 |'."\n" .'| 18 | 订阅端带宽低。 |'."\n" .'| 23 | 首帧渲染耗时长。 |'."\n" .'| UNKNOWN | 未知。 |', ], 'DescribeFaultDiagnosisUserList' => [ 'summary' => '调用DescribeFaultDiagnosisUserList获取异常诊断的用户明细列表。', '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' => '查询的开始时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615806196', ], ], [ 'name' => 'EndTs', 'in' => 'query', 'schema' => [ 'title' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', 'description' => '查询的结束时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615892596', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '搜索的频道ID', 'description' => '搜索的频道ID。', 'type' => 'string', 'required' => false, 'example' => '311', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'title' => '搜索的用户ID', 'description' => '搜索的用户ID。', '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' => '过滤的异常类型，多个用英文逗号（,）分隔。取值：'."\n" .'- **JOIN_SLOW**：进频道慢。'."\n" .'- **AUDIO_STUCK**：音频卡顿。 '."\n" .'- **VIDEO_STUCK**：视频卡顿。'."\n" .'- **VIDEO_VAGUE**：视频模糊。'."\n" .'- **HIGH_DELAY**：通话延迟高。'."\n" .'- **FIRST_FRAME_SLOW**：接收首屏慢。'."\n" ."\n" .'关于异常类型详情，请参见[异常类型说明](~~2639494~~)。', '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' => '频道ID。', 'type' => 'string', 'example' => '904', ], 'UserId' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => 'testuserid', ], 'CreatedTs' => [ 'title' => '用户首次进入通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '用户首次进入频道时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614936817', ], 'DestroyedTs' => [ 'title' => '用户最后一次离开通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '用户最后一次离开频道时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614936817', ], 'ChannelCreatedTs' => [ 'title' => '通信的创建时间戳，使用UNIX时间戳表示，单位：秒。', 'description' => '频道的创建时间戳，使用UNIX时间戳表示，单位：秒。', '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' => '1', ], 'PageSize' => [ 'title' => '每页数量。', 'description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCnt' => [ 'title' => '总数量。', 'description' => '总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '获取异常诊断的用户明细列表', 'description' => '### 使用说明'."\n" .'本接口用于获取异常诊断的用户明细列表。使用该接口时，支持查询最近48小时且查询范围不超过24小时的数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], 'DescribeFaultDiagnosisUserDetail' => [ 'summary' => '调用DescribeFaultDiagnosisUserDetail获取异常诊断的用户详情。', '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' => '频道ID', 'type' => 'string', 'required' => true, 'example' => '311', ], ], [ 'name' => 'CreatedTs', 'in' => 'query', 'schema' => [ 'title' => '频道创建时间，使用UNIX时间戳表示，单位：秒。', 'description' => '频道创建时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615892596', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'title' => '用户ID', 'description' => '用户ID', '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' => '异常类型。取值：'."\n" .'- **JOIN_SLOW**：进频道慢 。'."\n" .'- **AUDIO_STUCK**：音频卡顿。'."\n" .'- **VIDEO_STUCK**：视频卡顿。'."\n" .'- **VIDEO_VAGUE**：视频模糊。'."\n" .'- **HIGH_DELAY**：通话延迟高 。'."\n" .'- **FIRST_FRAME_SLOW**：接收首屏慢。', 'type' => 'string', 'required' => true, 'example' => 'JOIN_SLOW', ], ], [ 'name' => 'QueryCallUserInfo', 'in' => 'query', 'schema' => [ 'title' => '是否查询通话用户信息，为空默认是false', 'description' => '是否查询通话用户信息，为空默认是false。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CallInfo' => [ 'title' => '通信基本信息，QueryCallUserInfo=false是返回。', 'description' => '通信基本信息，QueryCallUserInfo=false时返回。', 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => 'App ID。', 'description' => 'App ID。', 'type' => 'string', 'example' => 'testappid', ], 'ChannelId' => [ 'title' => '频道ID。', 'description' => '频道ID。', 'type' => 'string', 'example' => '311', ], 'CallStatus' => [ 'title' => '通信状态。取值：IN：进行中。OUT：已结束。', 'description' => '通信状态。取值：'."\n" .'- **IN**：进行中。'."\n" .'- **OUT**：已结束。', 'type' => 'string', 'example' => 'IN', ], 'CreatedTs' => [ 'title' => '创建通信时间，使用UNIX时间戳表示，单位：秒。', 'description' => '创建通信时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620957905', ], 'DestroyedTs' => [ 'title' => '释放通信时间，使用UNIX时间戳表示，单位：秒。', 'description' => '释放通信时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620958150', ], 'Duration' => [ 'title' => '通信持续时长，单位：秒。', 'description' => '通信持续时长，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], 'UserDetail' => [ 'title' => '诊断用户详细信，QueryCallUserInfo=false是返回息', 'description' => '诊断用户详细信，QueryCallUserInfo=false时返回。', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => 'testuserid', ], 'Location' => [ 'title' => '地理位置信息，例如：北京市-北京市', 'description' => '地理位置信息，例如：北京市-北京市。', 'type' => 'string', 'example' => '浙江省-杭州市', ], 'OnlinePeriods' => [ 'title' => '在线时段信息。', 'description' => '在线时段信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'JoinTs' => [ 'title' => '加入通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '加入通话时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620957919', ], 'LeaveTs' => [ 'title' => '离开通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '离开通话时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620958150', ], ], ], ], 'CreatedTs' => [ 'title' => '创建通话时间，使用UNIX时间戳表示，单位：秒。', 'description' => '创建通话时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620957919'."\n", ], 'DestroyedTs' => [ 'title' => '释放通话时间，使用UNIX时间戳表示，单位：秒。通话未结束时值为0。', 'description' => '释放通话时间，使用UNIX时间戳表示，单位：秒。', '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' => 'SDK版本，如1.0.0、1.1.1等。', 'type' => 'string', 'example' => '1.0.0', ], 'Os' => [ 'title' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型', 'description' => '平台类型：若用户客户端为WEB则是浏览器类型，若客户端为NATIVE则是操作系统类型。', 'type' => 'string', 'example' => 'iOS', ], 'Network' => [ 'title' => '网络类型，如WiFi，4G等', 'description' => '网络类型，如WiFi，4G等。', 'type' => 'string', 'example' => '4G', ], ], ], 'FaultMetricData' => [ 'title' => '异常指标', 'description' => '异常指标。', 'type' => 'object', 'properties' => [ 'Nodes' => [ 'title' => '指标坐标点列表', 'description' => '指标坐标点列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'X' => [ 'title' => 'x轴坐标值，秒级时间戳，单位时间为分钟', 'description' => '指标趋势图中x轴横坐标，单位时间为1分钟。', 'type' => 'string', 'example' => '1620957900', ], 'Y' => [ 'title' => 'y轴坐标值，异常指标的值', 'description' => '指标趋势图中y轴纵坐标。', 'type' => 'string', 'example' => '0.4540', ], ], ], ], ], ], 'FactorList' => [ 'title' => '影响因素列表，空表示影响因素未知', 'description' => '影响因素列表，空表示影响因素未知。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FactorId' => [ 'title' => '影响因素ID： 1：发布端网络差 2：订阅端网络差 3：发布端设备性能差 4：发布端关闭摄像头 5：发布端切到后台运行', 'description' => '影响因素ID，详情请参见下文中的影响因素ID取值。', 'type' => 'string', 'example' => '1', ], 'FaultSource' => [ 'title' => '异常来源 LOCAL：本端 REMOTE：远端', 'description' => '异常来源 LOCAL：本端 REMOTE：远端。', 'type' => 'string', 'example' => 'LOCAL', ], 'RelatedMetricDatas' => [ 'title' => '关联的指标，坐标数据，当FaultType为AUDIO_STUCK、VIDEO_STUCK、VIDEO_VAGUE、HIGH_DELAY时返回', 'description' => '关联的指标，坐标数据，当FaultType为AUDIO_STUCK、VIDEO_STUCK、VIDEO_VAGUE、HIGH_DELAY时返回。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Role' => [ 'title' => '来源角色： SENDER：发布端，即上行 RECEIVER：订阅端，即下行', 'description' => '来源角色。取值：'."\n" .'- **SENDER**：发布端。'."\n" .'- **RECEIVER**：订阅端。', 'type' => 'string', 'example' => 'SENDER', ], 'UserId' => [ 'title' => '数据来自对应发布端的用户ID', 'description' => '数据来自对应发布端的用户ID。', 'type' => 'string', 'example' => 'testuserid2', ], 'Type' => [ 'title' => '指标类型，参照端到端指标接口的指标类型', 'description' => '指标类型，参照端到端指标接口的指标类型。', 'type' => 'string', 'example' => 'AUDIO_STUCK', ], 'Nodes' => [ 'title' => '坐标数据列表', 'description' => '指标趋势图坐标点列表。', 'type' => 'array', 'items' => [ 'description' => '指标趋势图坐标点详情。', 'type' => 'object', 'properties' => [ 'X' => [ 'title' => 'X坐标值，秒级时间戳', 'description' => '指标趋势图中x轴横坐标。', 'type' => 'string', 'example' => '1615892596', ], 'Y' => [ 'title' => 'Y坐标值，指标值', 'description' => '指标趋势图中y轴纵坐标。', 'type' => 'string', 'example' => '20', ], 'Ext' => [ 'title' => '扩展数据', 'description' => '扩展数据。', 'type' => 'object', ], ], ], ], ], ], ], 'RelatedEventDatas' => [ 'title' => '关联的事件，按时间分组，当FaultType为AUDIO_STUCK、VIDEO_STUCK、VIDEO_VAGUE、HIGH_DELAY时返回', 'description' => '关联的事件，按时间分组，当FaultType为AUDIO_STUCK、VIDEO_STUCK、VIDEO_VAGUE、HIGH_DELAY时返回坐标数据。', 'type' => 'array', 'items' => [ 'description' => '关联的事件详情。', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '0a497933****', ], 'Role' => [ 'title' => '来源角色： SENDER：发布端，即上行 RECEIVER：订阅端，即下行', 'description' => '来源角色。取值：'."\n" .'- **SENDER**：发布端。'."\n" .'- **RECEIVER**：订阅端。', 'type' => 'string', 'example' => 'SENDER', ], 'EventDataItems' => [ 'title' => '事件数据列表', 'description' => '事件数据列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Ts' => [ 'title' => '第一个事件发生的时间，使用UNIX时间戳表示，单位：秒。', 'description' => '第一个事件发生的时间，使用UNIX时间戳表示，单位：秒。', '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' => '事件类型。取值：'."\n" .'- **USER**：用户事件。'."\n" .'- **SYSTEM**：系统事件。', 'type' => 'string', 'example' => 'USER', ], 'Ts' => [ 'title' => '事件发生的时间，使用UNIX时间戳表示，单位：秒。', 'description' => '事件发生的时间，使用UNIX时间戳表示，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614936817', ], ], ], ], ], ], ], ], ], ], ], ], ], 'NetworkOperators' => [ 'title' => '网络运营商列表', 'description' => '网络运营商列表', 'type' => 'array', 'items' => [ 'description' => '网络运营商。', 'type' => 'string', 'example' => '移动', ], ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => '获取异常诊断的用户详情', 'description' => '### 使用说明'."\n" .'本接口用于获取异常诊断的概览数据。使用该接口时，支持查询最近48小时的数据。'."\n" .'### QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', ], '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' => '订阅哪些用户的消息，参数为空表示订阅该房间全部用户（包含主播和观众）。格式如下所示：'."\n" ."\n" .'```'."\n" .'Users.1=****'."\n" .'Users.2=****'."\n" .'......'."\n" .'```', 'type' => 'string', 'required' => false, 'example' => 'user1', ], 'required' => false, 'example' => 'user1', 'maxItems' => 64, ], ], [ 'name' => 'Events', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '订阅的事件。', 'type' => 'array', 'items' => [ 'description' => '订阅的事件，取值：'."\n" ."\n" .'- **ChannelEvent**：频道事件。'."\n" .'- **UserEvent**：频道内用户事件。'."\n" ."\n" .'详细信息请参见以下表格说明。', 'type' => 'string', 'required' => false, 'example' => 'ChannelEvent', ], 'required' => true, 'example' => 'ChannelEvent', 'maxItems' => 16, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '订阅的应用ID。', 'type' => 'string', 'required' => true, 'example' => '9qb1****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '订阅的频道ID。'."\n" ."\n" .'> 如果Users.N参数不为空，则此参数必填。', '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' => '是否开启回调鉴权，取值：'."\n" ."\n" .'- **true**：开启。'."\n" .'- **fasle**（默认值）：关闭。'."\n" ."\n" .'详细信息请参见以下回调鉴权说明。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Role', 'in' => 'query', 'schema' => [ 'description' => '用户角色，取值：'."\n" ."\n" .'- **1**：订阅频道中的主播消息。'."\n" .'- **2**：订阅频道中的观众消息。'."\n" .'- **空或其他值**：不进行角色过滤，订阅频道中的所有角色的消息。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'SubscribeId' => [ 'description' => '创建的订阅ID。', 'type' => 'string', 'example' => 'ad53276431c****', ], 'RequestId' => [ 'description' => '请求ID。', '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":"\\n760bad53276431c499e30dc36f6b26be\\nad53276431c****\\n","errorExample":""}]', 'title' => '创建事件订阅', 'summary' => '调用CreateEventSubscribe创建订阅房间消息的回调。', 'description' => '# 使用说明'."\n" .'本接口用于创建订阅房间消息的回调。例如：在创建回调时，您可以配置回调地址、事件类型等参数。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => '## CallBack'."\n" .'RTC通过用户传入的CallbackUrl，回调用户的内容，示例如下所示：'."\n" .'```'."\n" .'Request:'."\n" ."\n" .'POST /callbackURL'."\n" ."\n" .'Body'."\n" .'(x-www-form-urlencoded)'."\n" ."\n" .'{'."\n" .' "MsgId": "消息ID",'."\n" .' "MsgTimestamp": 12312324, // 消息发送时的Unix时间戳'."\n" .' "SubscribeID": "订阅ID",'."\n" .' "AppId":"", // 产生该消息的appid '."\n" .' "ChannelID":"", // 产生该消息的频道'."\n" .' "Contents": ['."\n" .' {'."\n" .' "Event": "UserEvent",//订阅的事件：频道内用户事件'."\n" .' "UserEvent": {'."\n" .' "UserId": "80331631628db0d1", // 用户ID'."\n" .' "EventTag": "Publish", // 事件，包括Join, Leave, Publish, Unpublish, Roleupdate'."\n" .' "SessionId": "0dr15rrnhkz0jnvz6o8sxo01hoondhu1", // 产生该事件的SessionID'."\n" .' "Timestamp": 1609854786, // 事件发生Unix 时间戳'."\n" .' "Reason": 1, // 入会、离会原因，仅Join事件有'."\n" .' "Role": 1, // 角色类型, 主播，观众'."\n" .' "TerminalType": 1, // 终端类型, win, android'."\n" .' "UserType":1, // 用户类型，native sdk, applete, webrtc'."\n" .' "Medias":[1,2,3] // 推流类型：用户推了哪些流'."\n" .' }'."\n" .' },'."\n" .' {'."\n" .' "Event": "ChannelEvent",//订阅的事件：频道事件'."\n" .' "ChannelEvent": {'."\n" .' "ChannelId": "8888889999",'."\n" .' "EventTag": "Open", // 频道事件，包括开启与关闭Open, Close'."\n" .' "Timestamp": 1609854530 // 事件发生Unix 时间戳'."\n" .' }'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" ."\n" .'Response '."\n" .'HTTP STATUS 200'."\n" .'```'."\n" ."\n" .'## UserEvent用户事件'."\n" .'|参数|类型|是否必须|描述|'."\n" .'|---|---|---|---|'."\n" .'|UserId | string | 是 | 用户ID。 |'."\n" .'|SessionId | string | 是 | 用户SessionID。 |'."\n" .'|EventTag | string | 是 | 事件类型，取值：
- **Join**：入会。
- **Leave**：离会。
- **PublishVideo**：开始推视频流。
- **PublishAudio**：开始推音频流。
- **PublishScreen**：开始屏幕共享。
- **UnpublishVideo**：停止推视频流。
- **UnpublishAudio**：停止推音频流。
- **UnpublishScreen**：停止屏幕共享。
- **Roleupdate**：角色切换。 |'."\n" .'|Timestamp | number | 是 | 事件发生的时间戳。 |'."\n" .'|Reason | integer | 是 | 入会、离会原因（仅Join事件有），取值：
- **1**：正常入会、离会。
- **2**：重连入会（当前会中已有该用户实例，该用户再次入会）。
- **3**：跨频道转推。
- **4**：超时离会。
- **5**：用户启用新的会话，当前会话被挤下线。
- **6**：被踢出。
- **7**：频道解散。 |'."\n" .'|Role | integer | 是 | 角色类型，取值：
- **1**：主播。
- **2**：观众。 |'."\n" .'|TerminalType | integer | 是 | 终端类型，取值：
- **1**：Windows设备。
- **2**：Android设备。
- **3**：Mac设备。
- **4**：iOS设备。
- **5**：Linux设备。
- **6**：其他（只有Native SDK入会可以解析终端类型)。 |'."\n" .'|UserType | integer | 是 | 用户类型，取值：
- **1**：Native SDK。
- **2**：WebRTC(非小程序，非Native都归为WebRTC)。
- **3**：小程序。 |'."\n" .'|Medias | integer | 是 | 推流类型，取值：
- **1**：音频。
- **2**：视频。
- **3**：屏幕共享。 |'."\n" ."\n" .'## ChannelEvent频道事件'."\n" .'|参数|类型|是否必须|描述|'."\n" .'|---|---|---|---|'."\n" .'|EventTag | string | 是 | 事件类型，取值：
- **Open**：会议开始。
- **Close**：会议结束。 |'."\n" .'|Timestamp | number | 是 | 事件发生的时间戳。 |'."\n" ."\n" .'## 回调鉴权说明'."\n" .'事件回调鉴权功能默认关闭，用户可在创建事件回调时启用鉴权。启用鉴权后，鉴权逻辑如下所示：'."\n" ."\n" .'- 阿里云音视频通信服务发起回调请求时在HTTP(S)请求头中包含`Ali-Rtc-Timestamp`和 `Ali-Rtc-Signature`字段，供回调消息接收服务端进行签名认证。`Ali-Rtc-Timestamp`值计算方式为：Ali-Rtc-Signature=MD5SUM(MD5CONTENT)。其中，MD5CONTENT=回调域名|Ali-Rtc-Timestamp取值|鉴权Key；回调域名指配置回调URL的域名，鉴权Key指用户创建AppId时生成的AppKey。'."\n" .'- 回调消息接收服务端接收回调消息时，将回调域名、`Ali-Rtc-Timestamp`取值、鉴权Key进行拼接后计算MD5值，得到加密字符串，再将计算出的加密字符串与音视频通信服务发起的HTTP(S)请求头中的`Ali-Rtc-Signature`字段值进行对比，如果不一致，则请求非法。', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteEventSubscribe' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID。'."\n" .'您可以在控制台创建和查询。', 'type' => 'string', 'required' => true, 'example' => '9qb1****', ], ], [ 'name' => 'SubscribeId', 'in' => 'query', 'schema' => [ 'description' => '订阅ID。更多信息，请参见[CreateEventSubscribe](~~274447~~)。', 'type' => 'string', 'required' => true, 'example' => 'ad53276431c****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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":"\\r\\n760bad53276431c499e30dc36f6b26be\\r\\n","errorExample":""}]', 'title' => '删除事件订阅', 'summary' => '调用DeleteEventSubscribe删除订阅房间消息的回调。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[CreateEventSubscribe](~~274447~~)创建订阅房间消息的回调。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateAutoLiveStreamRule' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ChannelIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '精确匹配的频道ID列表。', 'type' => 'array', 'items' => [ 'description' => '精确匹配的频道ID。'."\n" ."\n" .'> ChannelIds和ChannelIdPrefixes参数只能二选一输入或者都不输入，如果都不输入，则表示进行应用ID维度的自动旁路单路转推。', 'type' => 'string', 'required' => false, 'example' => '12333', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'ChannelIdPrefixes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '模糊匹配频道ID的前缀列表。', 'type' => 'array', 'items' => [ 'description' => '模糊匹配频道ID的前缀。'."\n" .'> ChannelIds和ChannelIdPrefixes参数只能二选一输入或者都不输入，如果都不输入，则表示进行应用ID维度的自动旁路单路转推。', 'type' => 'string', 'required' => false, 'example' => '12', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，可通过控制台创建和查询。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'eo85****', ], ], [ 'name' => 'PlayDomain', 'in' => 'query', 'schema' => [ 'description' => '自动旁路的播流域名。自动旁路任务对应播流地址为rtmp://${domain}/${app}/${stream}。'."\n" ."\n" .'- domain: 您的直播播流域名。'."\n" .'- app: live。'."\n" .'- stream: urlencode(${AppId}_${ChannelId}_${UserId}_${SourceType})，其中SourceType为输入源类型。'."\n" ."\n", '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' => '开启和结束旁路的回调地址。回调内容请参见下文中的CallBack回调示例。', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback', ], ], [ 'name' => 'MediaEncode', 'in' => 'query', 'schema' => [ 'description' => '编码选项，请参见下文中的MediaEncode枚举值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RuleId' => [ 'description' => '旁路规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12', ], 'RequestId' => [ 'description' => '请求ID。', '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":"\\n 12\\n 760bad53276431c499e30dc36f6b26be\\n","errorExample":""}]', 'title' => '创建自动旁路单路转推规则', 'summary' => '调用CreateAutoLiveStreamRule创建自动旁路单路转推规则。', 'description' => '# 使用说明'."\n" .'本接口用于创建旁路规则。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => '### CallBack回调示例'."\n" ."\n" .'```'."\n" .'{'."\n" .' "RequestId": "udie-jfieu89-34jfi-7jjifk",'."\n" .' "AppId": "pdtkb2qy",'."\n" .' "ChannelId": "0122",'."\n" .' "TaskId": "AL-1f43957a8e58fedef9b568b9c9ebddc0-1613618364",'."\n" .' "UserId": "2d0069089df36b22",'."\n" .' "SourceType": "camera",'."\n" .' "RuleId": 40,'."\n" .' "Event": "StartAutoLiveStreamTask",'."\n" .' "Description": "success"'."\n" .'}'."\n" .'```'."\n" .'| 参数 | 类型 | 是否必填 | 描述'."\n" .'| ----------- | ----- | ------ | -----------'."\n" .'| RequestId | String | 是 | 请求ID。 '."\n" .'| AppId| String | 是 | 应用ID。 '."\n" .'| ChannelId| String | 是 | 频道ID。 '."\n" .'| TaskId| String | 是 | 任务ID，生成规则为AL-MD5(rtmp://${domain}/${app}/${stream})。'."\n" .'| UserId| String | 是 | 用户ID。'."\n" .'| SourceType| String | 是 | 输入源类型，取值：
- camera：摄像头视频流。
- shareScreen：共享视频流。'."\n" .'| RuleId| Long| 是 | 旁路规则ID。 '."\n" .'| Event| String | 是 | 事件类型，取值：
- StartAutoLiveStreamTask：开启自动旁路单路转推任务。
- StopAutoLiveStreamTask：停止自动旁路单路转推任务。'."\n" .'| Description| String | 是 | 事件描述。 '."\n" ."\n" .'### MediaEncode枚举值'."\n" .'| ID | 宽 | 高 | 码流（Kps） | 帧率（FPS） '."\n" .'| ----------- | ----- | ------ | ----------- | --- '."\n" .'| 0 | 0 | 0 | 64 | 0 '."\n" .'| 1 | 640 | 360 | 500 | 15 '."\n" .'| 54 | 360 | 640 | 500 | 30 '."\n" .'| 53 | 360 | 640 | 500 | 15 '."\n" .'| 52 | 640 | 360 | 500 | 30 '."\n" .'| 10 | 960 | 540 | 700 | 24 '."\n" .'| 20 | 1280 | 720 | 1024 | 25 '."\n" .'| 22 | 720 | 1280 | 1024 | 30 '."\n" .'| 23 | 800 | 600 | 1024 | 30 '."\n" .'| 30 | 1920 | 1080 | 2048 | 30 '."\n" .'| 31 | 1080 | 1920 | 2048 | 30 '."\n" .'| 24 | 750 | 780 | 1024 | 30 '."\n" .'| 25 | 750 | 540 | 700 | 30 '."\n" .'| 26 | 720 | 1280 | 2048 | 30 '."\n" .'| 27 | 1280 | 720 | 2048 | 30 '."\n" .'| 28 | 1280 | 720 | 3096 | 30 '."\n" .'| 32 | 1024 | 768 | 1024 | 24 '."\n" .'| 33 | 1280 | 960 | 1024 | 24 '."\n" .'| 34 | 1024 | 768 | 2048 | 24 '."\n" .'| 35 | 1280 | 960 | 2048 | 24 '."\n" .'| 36 | 1280 | 720 | 1024 | 24 '."\n" .'| 37 | 1280 | 720 | 2048 | 24 '."\n" .'| 38 | 540 | 960 | 750 | 15 '."\n" .'| 39 | 540 | 960 | 1500 | 30 '."\n" .'| 40 | 1280 | 720 | 1200 | 15 '."\n" .'| 41 | 720 | 1280 | 1200 | 15 '."\n" .'| 42 | 720 | 1280 | 1500 | 15 '."\n" .'| 43 | 540 | 960 | 1200 | 15 '."\n", ], 'DeleteAutoLiveStreamRule' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，可通过控制台创建和查询。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'description' => '旁路规则ID。您可以通过控制台查询或调用接口[DescribeAutoLiveStreamRule](~~353198~~)获取旁路规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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":"\\n 760bad53276431c499e30dc36f6b26be\\n","errorExample":""}]', 'title' => '删除自动旁路单路转推规则', 'summary' => '调用DeleteAutoLiveStreamRule删除自动旁路单路转推规则。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[CreateAutoLiveStreamRule](~~353179~~)创建旁路规则。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', ], 'DisableAutoLiveStreamRule' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，可通过控制台创建和查询。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'eo85****', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'description' => '旁路规则ID。您可以通过控制台查询或调用接口[DescribeAutoLiveStreamRule](~~353198~~)获取旁路规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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":"\\n 760bad53276431c499e30dc36f6b26be\\n","errorExample":""}]', 'title' => '禁用自动旁路单路转推规则', 'summary' => '调用DisableAutoLiveStreamRule停用自动旁路单路转推规则。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[CreateAutoLiveStreamRule](~~353179~~)创建旁路规则。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', ], 'EnableAutoLiveStreamRule' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，可通过控制台创建和查询。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'eo85****', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'description' => '旁路规则ID。您可以通过控制台查询或调用接口[DescribeAutoLiveStreamRule](~~353198~~)获取旁路规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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":"\\n 760bad53276431c499e30dc36f6b26be\\n","errorExample":""}]', 'title' => '启用自动旁路单路转推规则', 'summary' => '调用EnableAutoLiveStreamRule开启自动旁路单路转推规则。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[CreateAutoLiveStreamRule](~~353179~~)创建旁路规则。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', ], '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' => '精确匹配的频道ID列表。', 'type' => 'array', 'items' => [ 'description' => '精确匹配的频道ID。'."\n" ."\n" .'> ChannelIds和ChannelIdPrefixes参数只能二选一输入或者都不输入，如果都不输入，则表示进行应用ID维度的自动旁路单路转推。', 'type' => 'string', 'required' => false, 'example' => '12333', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'ChannelIdPrefixes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '模糊匹配频道ID的前缀列表。', 'type' => 'array', 'items' => [ 'description' => '模糊匹配频道ID的前缀。'."\n" .'> ChannelIds和ChannelIdPrefixes参数只能二选一输入或者都不输入，如果都不输入，则表示进行应用ID维度的自动旁路单路转推。', 'type' => 'string', 'required' => false, 'example' => '12', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，可通过控制台创建和查询。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'eo85****', ], ], [ 'name' => 'PlayDomain', 'in' => 'query', 'schema' => [ 'description' => '自动旁路的播流域名。自动旁路任务对应播流地址为rtmp://${domain}/${app}/${stream}。'."\n" ."\n" .'- domain: 您的直播播流域名。'."\n" .'- app: live。'."\n" .'- stream: urlencode(${AppId}_${ChannelId}_${UserId}_${SourceType})，其中SourceType为输入源类型。', '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' => '开启和结束旁路的回调地址。您可以通过控制台查询或调用接口[DescribeAutoLiveStreamRule](~~353198~~)获取旁路回调地址。', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback', ], ], [ 'name' => 'MediaEncode', 'in' => 'query', 'schema' => [ 'description' => '编码选项。详情请参见[CreateAutoLiveStreamRule](~~353179~~)中MediaEncode枚举值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'description' => '旁路规则ID。您可以通过控制台查询或调用接口[DescribeAutoLiveStreamRule](~~353198~~)获取旁路规则ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '12', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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":"\\n 760bad53276431c499e30dc36f6b26be\\n","errorExample":""}]', 'title' => '更新自动旁路单路转推规则', 'summary' => '调用UpdateAutoLiveStreamRule修改自动旁路单路转推规则。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[CreateAutoLiveStreamRule](~~353179~~)创建旁路规则。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', ], 'DescribeAutoLiveStreamRule' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，可通过控制台创建和查询。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'eo85****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '069BCB66-CD80-11E8-A82B-A70F78BBDC00', ], 'Rules' => [ 'description' => '规则详情。', 'type' => 'array', 'items' => [ 'description' => '规则详情。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '规则状态，取值：'."\n" ."\n" .'- enable：启用。'."\n" .'- disable：停用。', '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' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12', ], 'RuleName' => [ 'description' => '规则名称。', 'type' => 'string', 'example' => 'testRule', ], 'ChannelIds' => [ 'description' => '精确匹配的频道ID列表。', 'type' => 'array', 'items' => [ 'description' => '精确匹配的频道ID。', 'type' => 'string', 'example' => '12333', ], ], 'ChannelIdPrefixes' => [ 'description' => '模糊匹配频道ID的前缀列表。', 'type' => 'array', 'items' => [ 'description' => '模糊匹配频道ID的前缀。', '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":"\\n 069BCB66-CD80-11E8-A82B-A70F78BBDC00\\n \\n disable\\n \\n rtmp://${domain}/${app}/${stream}\\n 12\\n 2021-08-19T02:53:07Z\\n \\n testRule\\n \\n","errorExample":""}]', 'title' => '获取自动旁路单路转推规则', 'summary' => '调用DescribeAutoLiveStreamRule查询自动旁路单路转推规则。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[CreateAutoLiveStreamRule](~~353179~~)创建旁路规则。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', ], 'DeleteChannel' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'eo85****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '已入会的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testid', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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":"\\n\\t16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\n\\n\\t\\n","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}"}]', 'title' => '删除频道', 'summary' => '调用DeleteChannel删除频道。', 'description' => '# 使用说明'."\n" .'本接口用于删除频道。'."\n" .'# QPS限制'."\n" .'本接口无单用户QPS限制，请您根据实际需要合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeChannelParticipants' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，可通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'aec****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '加入的频道，仅支持传单个ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'testId', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'description' => '排序方式，取值：'."\n" ."\n" .'- **asc**：递增。'."\n" ."\n" .'- **desc**（默认值）：递减。'."\n", 'type' => 'string', 'required' => false, 'example' => 'asc', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几页，默认查询第1页。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页显示用户数量，默认每页显示10条用户数据。', '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' => '请求ID。', 'type' => 'string', 'example' => '6159ba01-6687-4fb2-a831-f0cd8d188648', ], 'Timestamp' => [ 'description' => '返回结果时间，使用UNIX时间戳表示，单位：秒。', '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' => '用户ID列表，多个用英文逗号（,）分隔。', '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":"\\n6159ba01-6687-4fb2-a831-f0cd8d188648\\n1557909133\\n3\\n1\\n\\n 27f9****\\n bb87****\\n df82****\\n\\n","errorExample":""}]', 'title' => '查询频道在线用户列表', 'summary' => '查询频道在线用户列表，不包含详细信息。', 'description' => '# 使用说明'."\n" .'本接口用于查询频道内在线用户列表，不包含用户详细信息。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeUserInfoInChannel' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => '4eah****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => '1234', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '用户ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testId', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '6159ba01-6687-4fb2-a831-f0cd8d188648', ], 'Timestamp' => [ 'description' => '当前时刻的时间戳（UTC时间）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1557909133', ], 'IsInChannel' => [ 'description' => '用户当前是否在频道内，取值：'."\n" .'- **true**：在频道内。'."\n" .'- **false**：不在频道内。'."\n", 'type' => 'boolean', 'example' => 'true', ], 'IsChannelExist' => [ 'description' => '频道是否存在，取值：'."\n" .'- **true**：存在。'."\n" .'- **false**：不存在。', 'type' => 'boolean', 'example' => 'true', ], 'Property' => [ 'description' => '用户在频道内的信息。', 'type' => 'array', 'items' => [ 'description' => '用户在频道内的信息。', 'type' => 'object', 'properties' => [ 'Session' => [ 'description' => 'Session ID（会话ID）。', 'type' => 'string', 'example' => 'xa744sxx8rtobgj****', ], 'Role' => [ 'description' => '会议中的角色类型，取值：'."\n" ."\n" .'- **0**：通信模式下的用户角色。'."\n" .' '."\n" .'- **1**：interactive（参与互动）角色。'."\n" .' '."\n" .'- **2**：live（仅观看）角色。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Join' => [ 'description' => '用户进入会议的时间（UTC时间）。'."\n", '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":"\\n6159ba01-6687-4fb2-a831-f0cd8d188648\\n1557909133\\ntrue\\ntrue\\n\\n 1557909133\\n xa744sxx8rtobgj****\\n 1\\n\\n","errorExample":""}]', 'title' => '查询用户在频道中实时信息', 'summary' => '调用DescribeUserInfoInChannel查询用户在频道中实时信息。', 'description' => '# 使用说明'."\n" .'本接口用于查询用户在频道中实时信息。例如：您可以查询用户角色类型、入会时间等信息。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeChannelUsers' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'a2hz****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '要查询的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testId', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CommTotalNum' => [ 'description' => '通信模式下频道内的用户总数，如果频道为非通信模式，该参数为0。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '6159ba01-6687-4fb2-a831-f0cd8d188648', ], 'IsChannelExist' => [ 'description' => '频道是否存在，取值：'."\n" .'- **true**：存在。'."\n" ."\n" .'- **false**：不存在。', 'type' => 'boolean', 'example' => 'true', ], 'LiveUserNum' => [ 'description' => '直播模式下频道内的观众总数，如果频道为非直播模式，该参数为0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Timestamp' => [ 'description' => '当前时刻的时间戳（UTC时间）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1557909133', ], 'ChannelProfile' => [ 'description' => '频道模式，取值：'."\n" ."\n" .'- **1**：Communication（通信模式）。'."\n" ."\n" .'- **2**：Interactive_live（直播模式）。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'InteractiveUserNum' => [ 'description' => '直播模式下频道内的互动者用户总数，如果频道为非直播模式，该参数为0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'UserList' => [ 'type' => 'array', 'items' => [ 'description' => '通信模式下频道的用户列表，如果频道为非通信模式，该参数为空。'."\n", 'type' => 'string', 'example' => '[]', ], ], 'InteractiveUserList' => [ 'type' => 'array', 'items' => [ 'description' => '直播模式下频道内的互动用户列表，如果频道为非直播模式，该参数为空。'."\n", 'type' => 'string', 'example' => '["4455****", "3267****", "efbc****"]', ], ], 'LiveUserList' => [ 'type' => 'array', 'items' => [ 'description' => '直播模式下频道内的观众列表，只返回前1000人，如果频道为非直播模式，该参数为空。'."\n", '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":"\\n6159ba01-6687-4fb2-a831-f0cd8d188648\\n1557909133\\ntrue\\n1\\n100\\n0\\n0\\n4455****\\n3267****\\nefbc****\\n\\n","errorExample":""}]', 'title' => '查询实时在线用户列表', 'summary' => '查询 Channel（频道）实时在线用户列表。', 'description' => '# 使用说明'."\n" .'本接口用于查询频道内在线用户列表的详细信息。例如：您可以查询通信模式和直播模式下的用户总数。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RemoveTerminals' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'TerminalIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '用户ID列表。', 'type' => 'array', 'items' => [ 'description' => '用户ID列表，N的取值：**1**~**30**。格式如下所示：'."\n" ."\n" .'```'."\n" .'TerminalIds.1=****'."\n" .'TerminalIds.2=****'."\n" .'......'."\n" .'```', 'type' => 'string', 'required' => false, 'example' => '1811****', ], 'required' => true, 'example' => '1811xxxx', 'maxItems' => 30, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，仅支持传单个ID。'."\n" ."\n" .'可通过控制台创建和查询。', 'type' => 'string', 'required' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '已加入的频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'yourChannelId', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', ], 'Terminals' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Terminal' => [ 'description' => '用户ID信息列表。', 'type' => 'array', 'items' => [ 'description' => '用户ID信息。', 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '状态码，成功返回0，失败返回错误码描述。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Message' => [ 'description' => '删除终端操作结果。取值：'."\n" ."\n" .'- Success：成功。'."\n" ."\n" .'- Failed：失败。', 'type' => 'string', 'example' => 'Success', ], 'Id' => [ 'description' => '用户ID。', '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":"\\n 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\n \\n 1811****\\n 0\\n Success\\n \\n \\n 1811****\\n 0\\n Success\\n \\n","errorExample":""}]', 'title' => '将指定终端用户从频道踢出', 'summary' => '调用RemoveTerminals将指定终端用户从频道踢出。', 'description' => '# 使用说明'."\n" .'本接口用于将指定终端用户从频道踢出。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', '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' => '布局ID数据列表。', 'type' => 'array', 'items' => [ 'description' => '布局ID数据，您可在一次任务中指定多个布局，系统会根据当时频道中的人数进行切换。N表示数组的下标，取值范围1～16，相当于一个旁路任务中最多可以同时设置16种布局。详情请参见[布局说明](~~109587~~)。'."\n" .'> - N需要从1开始并从小到大，不能中断，要连续。'."\n" .'- 设置的布局窗格数不能相同。例如：官网上的布局ID 2和3不能同时设置，因为他们两个的窗格数相同都是2。', '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' => '录制文件格式。当前文件格式仅支持：**m3u8、mp4、flv**。'."\n" ."\n" .'> 文件格式仅支持小写。', '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' => '背景图片坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Url' => [ 'description' => '背景图片的HTTP或HTTPS地址。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '背景图片显示。取值：'."\n" ."\n" .'- **0**（None）：不显示。'."\n" .'- **1**（Always）：总是显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'ZOrder' => [ 'description' => '背景图片叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '背景图片坐标X，归一化百分比。', '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' => '水印透明度。0.0表示透明，1.0表示完全不透明。', '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' => '水印坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Url' => [ 'description' => '水印的HTTP或HTTPS地址。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '水印显示。取值：'."\n" ."\n" .'- **0**（None）：不显示。'."\n" .'- **1**（Always）：总是显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'ZOrder' => [ 'description' => '水印叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '水印坐标X，归一化百分比。', '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' => '时钟字体类型，取值：'."\n" ."\n" .'- **0**（默认值）：NOTO_SERIF_CJKSC_REGULAR'."\n" .'- **1**：ALIBABA_PUHUITI_REGULAR'."\n" .'- **2**：ALIBABA_PUHUITI_BOLD'."\n" .'- **3**：ALIBABA_PUHUITI_Heavy'."\n" .'- **4**：ALIBABA_PUHUITI_LIGHT'."\n" .'- **5**：ALIBABA_PUHUITI_MEDIUM', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'FontColor' => [ 'description' => '时钟文字颜色（RGB）。'."\n" ."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Y' => [ 'description' => '时钟坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'ZOrder' => [ 'description' => '时钟叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '时钟坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'FontSize' => [ 'description' => '时钟字体大小。字体合理范围**(0, 72]**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 1, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '任务计费配置，根据您的不同设置，进行收费。请参见下文中的TaskProfile枚举值。'."\n" ."\n" .'> - 编码选项MediaEncode的分辨率需要小于等于TaskProfile的分辨率。'."\n" .'- 布局最大窗格数需要小于等于TaskProfile的输入路数。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4IN_1080P', ], ], [ 'name' => 'MediaEncode', 'in' => 'query', 'schema' => [ 'description' => '编码选项，请参见下文中的MediaEncode枚举值。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20', ], ], [ 'name' => 'BackgroundColor', 'in' => 'query', 'schema' => [ 'description' => '背景色RGB。默认是0（黑色）。计算公式为R+G×256+B×65536，R（红）、G（绿）、B（蓝）的取值：**0~255**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'OssBucket', 'in' => 'query', 'schema' => [ 'description' => '录制文件存储的OSS bucket。'."\n" ."\n" .'> 目前仅支持上海区域OSS bucket。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rtc-record-oss', ], ], [ 'name' => 'OssFilePrefix', 'in' => 'query', 'schema' => [ 'description' => '录制文件命名规则。'."\n" ."\n" .'> 为确保录制的文件名称唯一，目前录制文件的命名规则为record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}', ], ], [ 'name' => 'FileSplitInterval', 'in' => 'query', 'schema' => [ 'description' => '录制文件切割时长（大于等于1800）。单位：秒。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1800', ], ], [ 'name' => 'DelayStopTime', 'in' => 'query', 'schema' => [ 'description' => '延时停止录制的时间。单位：秒。默认值为**180**秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '86400', 'minimum' => '5', 'example' => '180', 'default' => '180', ], ], [ 'name' => 'MnsQueue', 'in' => 'query', 'schema' => [ 'description' => '录制事件回调消息队列。'."\n" ."\n" .'> 此参数和HttpCallbackUrl必须输入其中某一个，不能两者都输入或都不输入。', 'type' => 'string', 'required' => false, 'example' => 'record-callback-queue', ], ], [ 'name' => 'HttpCallbackUrl', 'in' => 'query', 'schema' => [ 'description' => '录制事件HTTP回调地址。'."\n" .'> 此参数和MnsQueue必须输入其中某一个，不能两者都输入或都不输入。', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback', ], ], [ 'name' => 'EnableM3u8DateTime', 'in' => 'query', 'schema' => [ 'description' => '录制的m3u8文件是否需要加上ts文件时间点。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'OssEndpoint', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'description' => '录制配置模板ID。'."\n", 'type' => 'string', 'example' => '76dasgb****', ], 'RequestId' => [ 'description' => '该条任务请求ID。', '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":"\\n760bad53276431c499e30dc36f6b26be\\n76dasgb****\\n","errorExample":""}]', 'title' => '添加录制配置模板', 'summary' => '调用AddRecordTemplate添加录制配置模板。', 'description' => '# 使用说明'."\n" .'本接口用于添加录制配置模板。例如：添加录制配置模板时，您可以配置录制规格、编码选项等参数。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' **MediaEncode**枚举值如下所示。'."\n" ."\n" .'| ID | 宽 | 高 | 码流（Kps） | 帧率（FPS） '."\n" .'| ----------- | ----- | ------ | ----------- | --- '."\n" .'| 0 | 0 | 0 | 64 | 0 '."\n" .'| 1 | 640 | 360 | 500 | 15 '."\n" .'| 54 | 360 | 640 | 500 | 30 '."\n" .'| 53 | 360 | 640 | 500 | 15 '."\n" .'| 52 | 640 | 360 | 500 | 30 '."\n" .'| 10 | 960 | 540 | 700 | 24 '."\n" .'| 20 | 1280 | 720 | 1024 | 25 '."\n" .'| 22 | 720 | 1280 | 1024 | 30 '."\n" .'| 23 | 800 | 600 | 1024 | 30 '."\n" .'| 30 | 1920 | 1080 | 2048 | 30 '."\n" .'| 31 | 1080 | 1920 | 2048 | 30 '."\n" .'| 24 | 750 | 780 | 1024 | 30 '."\n" .'| 25 | 750 | 540 | 700 | 30 '."\n" .'| 26 | 720 | 1280 | 2048 | 30 '."\n" .'| 27 | 1280 | 720 | 2048 | 30 '."\n" .'| 28 | 1280 | 720 | 3096 | 30 '."\n" .'| 32 | 1024 | 768 | 1024 | 24 '."\n" .'| 33 | 1280 | 960 | 1024 | 24 '."\n" .'| 34 | 1024 | 768 | 2048 | 24 '."\n" .'| 35 | 1280 | 960 | 2048 | 24 '."\n" .'| 36 | 1280 | 720 | 1024 | 24 '."\n" .'| 37 | 1280 | 720 | 2048 | 24 '."\n" .'| 38 | 540 | 960 | 750 | 15 '."\n" .'| 39 | 540 | 960 | 1500 | 30 '."\n" .'| 40 | 1280 | 720 | 1200 | 15 '."\n" .'| 41 | 720 | 1280 | 1200 | 15 '."\n" .'| 42 | 720 | 1280 | 1500 | 15 '."\n" .'| 43 | 540 | 960 | 1200 | 15 '."\n" ."\n\n" .'**TaskProfile**枚举值：'."\n" ."\n" .'> Mixed_Audio（纯音频）不限制最大输入路数，其余规格根据第一个数字判断支持最大输入路数，例如：4IN_720P代表支持最大输入路数为4。'."\n" ."\n" .'| - | 1080P | 720P | 360P | Audio '."\n" .'| ----- | ------- | ----- | ------ | ------ '."\n" .'| 1IN | 1IN_1080P | 1IN_720P | 1IN_360P | 无'."\n" .'| 2IN | 2IN_1080P | 2IN_720P | 2IN_360P | 无 '."\n" .'| 4IN | 4IN_1080P | 4IN_720P | 4IN_360P | 无'."\n" .'| 9IN | 9IN_1080P | 9IN_720P | 9IN_360P | 无'."\n" .'| 12IN | 12IN_1080P | 12IN_720P | 12IN_360P | 无'."\n" .'| 16IN | 16IN_1080P | 16IN_720P | 16IN_360P | 无'."\n" .'| Mixed| 无 | 无 | 无 | Mixed_Audio'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => '## 特殊错误码'."\n" ."\n" .'|错误ID|错误代码|描述|HTTP状态码|'."\n" .'|-----|-------|---|----------|'."\n" .'| InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 内部错误 |', ], 'DeleteRecordTemplate' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => '配置模板ID。获取模板ID，请参见[AddRecordTemplate](~~193625~~)。', 'type' => 'string', 'required' => true, 'example' => '76dasgb****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID。'."\n", '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":"\\r\\n760bad53276431c499e30dc36f6b26be\\r\\n","errorExample":""}]', 'title' => '删除录制配置模板', 'summary' => '调用DeleteRecordTemplate删除录制配置模板。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[AddRecordTemplate](~~193625~~)添加录制配置模板。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '## 特殊错误码'."\n" ."\n" .'|错误ID|错误代码|描述|HTTP状态码|语义|'."\n" .'|-----|-------|---|----------|'."\n" .'| InternalError | InternalError|The request processing has failed due to some unknown error, exception or failure. | 500 |内部错误 |'."\n", ], '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' => '布局ID组。', 'type' => 'array', 'items' => [ 'description' => '布局ID数据，您可在一次任务中指定多个布局，系统会根据当时频道中的人数进行切换。N表示数组的下标，取值范围1～16，相当于一个旁路任务中最多可以同时设置16种布局。详情请参见[布局说明](~~109587~~)。'."\n" .'> - N需要从1开始并从小到大，不能中断，要连续。'."\n" .'- 设置的布局窗格数不能相同。例如：官网上的布局ID 2和3不能同时设置，因为他们两个的窗格数相同都是2。', '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' => '录制文件格式。当前文件格式仅支持：**m3u8、mp4、flv**。'."\n" ."\n" .'> 文件格式仅支持小写。', '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' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Url' => [ 'description' => '图片的HTTP或HTTPS地址。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '图片显示。取值：'."\n" ."\n" .'- **0**（None）：不显示。'."\n" .'- **1**（Always）：总是显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', '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' => '透明度。0.0表示透明，1.0表示完全不透明。', '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' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Url' => [ 'description' => '水印的HTTP或HTTPS地址。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '水印显示。取值：'."\n" ."\n" .'- **0**（None）：不显示。'."\n" .'- **1**（Always）：总是显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', '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' => '时钟字体类型，取值：'."\n" ."\n" .'- **0**（默认值）：NOTO_SERIF_CJKSC_REGULAR'."\n" .'- **1**：ALIBABA_PUHUITI_REGULAR'."\n" .'- **2**：ALIBABA_PUHUITI_BOLD'."\n" .'- **3**：ALIBABA_PUHUITI_Heavy'."\n" .'- **4**：ALIBABA_PUHUITI_LIGHT'."\n" .'- **5**：ALIBABA_PUHUITI_MEDIUM', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'FontColor' => [ 'description' => '时钟文字颜色（RGB）。'."\n" ."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Y' => [ 'description' => '时钟坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'ZOrder' => [ 'description' => '时钟叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '时钟坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'FontSize' => [ 'description' => '时钟字体大小。字体合理范围**(0, 72]**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 1, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', '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' => '配置模板ID。获取模板ID，请参加[AddRecordTemplate](~~193625~~)。'."\n", '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' => '背景色RGB，默认是0（黑色）。计算公式为R+G×256+B×65536，R（红）、G（绿）、B（蓝）的取值：**0~255**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'OssBucket', 'in' => 'query', 'schema' => [ 'description' => '录制文件存储的OSS Bucket。', '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' => '录制事件HTTP回调地址。', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback', ], ], [ 'name' => 'FileSplitInterval', 'in' => 'query', 'schema' => [ 'description' => '录制文件切割时长（大于等于1800）。单位：秒。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1800', ], ], [ 'name' => 'DelayStopTime', 'in' => 'query', 'schema' => [ 'description' => '延时停止录制的时间。单位：秒。默认值为**180**秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '86400', 'minimum' => '5', 'example' => '180', 'default' => '180', ], ], [ 'name' => 'EnableM3u8DateTime', 'in' => 'query', 'schema' => [ 'description' => '录制的m3u8文件是否需要加上ts文件时间点。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'OssEndpoint', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'description' => '录制配置模板ID。'."\n", 'type' => 'string', 'example' => '76dasgb****', ], 'RequestId' => [ 'description' => '该条任务请求ID。', '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":"\\n760bad53276431c499e30dc36f6b26be\\n76dasgb****\\n","errorExample":""}]', 'title' => '更新录制配置模板', 'summary' => '调用UpdateRecordTemplate更新录制配置模板。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[AddRecordTemplate](~~193625~~)添加录制配置模板。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '## 特殊错误码'."\n" ."\n" .'|错误ID|错误代码|描述|HTTP状态码|语义|'."\n" .'|-----|-------|---|----------|----|'."\n" .'| InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 内部错误 |', ], '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' => '指定该任务订阅的用户列表，默认订阅频道内全部用户，N表示的是数组的下标，取值范围：**1～16**。'."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'userID', ], 'required' => false, 'example' => 'userID', 'maxItems' => 64, ], ], [ 'name' => 'SubSpecAudioUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定订阅房间里有哪些用户音频流。', 'type' => 'array', 'items' => [ 'description' => '指定订阅房间里有哪些用户音频流（输入allStream表示混所有人音频流）。N表示的是数组的下标，取值范围：1～16。'."\n" ."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'audioUserID', ], 'required' => false, 'example' => '1', 'maxItems' => 64, ], ], [ 'name' => 'SubSpecShareScreenUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定订阅房间里有哪些用户屏幕共享流。', 'type' => 'array', 'items' => [ 'description' => '指定订阅房间里有哪些用户屏幕共享流（输入allStream表示混所有人屏幕共享流）。N表示的是数组的下标，取值范围：1～16。'."\n" ."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'videoUserID', ], 'required' => false, 'example' => '1', 'maxItems' => 64, ], ], [ 'name' => 'SubSpecCameraUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定订阅房间里有哪些用户摄像头流。', 'type' => 'array', 'items' => [ 'description' => '指定订阅房间里有哪些用户摄像头流（输入allStream表示混所有人摄像头流）。N表示的是数组的下标，取值范围：1～16。'."\n" ."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'cameraUserID', ], 'required' => false, 'example' => '1', 'maxItems' => 64, ], ], [ 'name' => 'UnsubSpecAudioUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定非订阅房间里有哪些用户音频流。', 'type' => 'array', 'items' => [ 'description' => '指定非订阅房间里有哪些用户音频流（输入allStream表示混所有人音频流）。N表示的是数组的下标，取值范围：1～16。'."\n" ."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'audioUserID2', ], 'required' => false, 'example' => '1', 'maxItems' => 64, ], ], [ 'name' => 'UnsubSpecShareScreenUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定非订阅房间里有哪些用户屏幕共享流。', 'type' => 'array', 'items' => [ 'description' => '指定非订阅房间里有哪些用户屏幕共享流（输入allStream表示混所有人屏幕共享流）。N表示的是数组的下标，取值范围：1～16。'."\n" ."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'videoUserID2', ], 'required' => false, 'example' => '1', 'maxItems' => 64, ], ], [ 'name' => 'UnsubSpecCameraUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定非订阅房间里有哪些用户摄像头流。', 'type' => 'array', 'items' => [ 'description' => '指定非订阅房间里有哪些用户摄像头流（输入allStream表示混所有人摄像头流）。N表示的是数组的下标，取值范围：1～16。'."\n" ."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', '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' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Url' => [ 'description' => '图片的HTTP或HTTPS地址。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '图片显示，取值：'."\n" ."\n" .'- **0**（None）：不显示。'."\n" .'- **1**（Always）：总是显示。'."\n" .'- **2**（Backup）：当前用户无视频流时显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 1, ], 'UserId' => [ 'description' => '对应布局框格的用户ID。N的取值：**1~16**。', 'type' => 'string', 'required' => false, 'example' => 'TestId', ], 'Texts' => [ 'description' => '当前布局的文字框位列表。', 'type' => 'array', 'items' => [ 'description' => '当前布局的文字框位，最多支持16个文本。', 'type' => 'object', 'properties' => [ 'FontType' => [ 'description' => '字体类型。取值：'."\n" ."\n" .'- **0**（默认）：NOTO_SERIF_CJKSC_REGULAR。'."\n" .'- **1**：ALIBABA_PUHUITI_REGULAR。'."\n" .'- **2**：ALIBABA_PUHUITI_BOLD。'."\n" .'- **3**：ALIBABA_PUHUITI_Heavy。'."\n" .'- **4**：ALIBABA_PUHUITI_LIGHT。'."\n" .'- **5**：ALIBABA_PUHUITI_MEDIUM。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'FontColor' => [ 'description' => '文字颜色（RGB）。计算公式为R+G×256+B×65536，R（红）、G（绿）、B（蓝）的取值：**0~255**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Y' => [ 'description' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Text' => [ 'description' => '文本内容。', 'type' => 'string', 'required' => false, 'example' => 'text', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'FontSize' => [ 'description' => '字体大小。字体合理范围**(0, 72]**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 16, ], 'SourceType' => [ 'description' => '对应布局的用户视频输入。取值：'."\n" ."\n" .'- **camera**（默认）：视频流。'."\n" .'- **shareScreen**：共享屏幕流。', 'type' => 'string', 'required' => false, 'example' => 'camera', ], 'PaneId' => [ 'description' => '窗格ID，取值：**0**~**15**。'."\n" ."\n" .'> - 当指定的PaneId用户找不到的话，会默认显示其他的流，流的确定是根据用户加入频道的顺序。'."\n" .'- 如果某个UserPanes相关的参数为必选，则其他相关参数都为必选，反之都为非必选。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 16, ], ], [ 'name' => 'LayoutIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '布局ID组。', 'type' => 'array', 'items' => [ 'description' => '布局ID数据，您可在一次任务中指定多个布局，系统会根据当时频道中的人数进行切换。数组下标取值范围：**1**～**16**，相当于一个旁路任务中最多可以同时设置16种布局。详情请参见[布局](~~109587~~)。'."\n" .'> - 数组下标需要从1开始并从小到大，不能中断，要连续。'."\n" .'- 设置的布局窗格数不能相同。例：官网上的布局ID 2和3 的不能同时设置，他们两个的窗格数相同都是2。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'required' => false, 'example' => '1111', 'maxItems' => 64, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '频道ID。仅支持传单个ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yourChannelId', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。仅支持传单个ID，需保证唯一。由1~55位大小写字母、数字、下划线、短划线（-）组成。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yourTaskId', ], ], [ 'name' => 'TaskProfile', 'in' => 'query', 'schema' => [ 'description' => '任务计费配置，根据您的不同设置，进行收费。请参见下文中的TaskProfile枚举值。'."\n" ."\n" .'> - 编码选项MediaEncode的分辨率需要小于等于TaskProfile的分辨率。'."\n" .'- 布局最大窗格数需要小于等于TaskProfile的输入路数。', 'type' => 'string', 'required' => false, 'example' => '4IN_1080P', ], ], [ 'name' => 'MediaEncode', 'in' => 'query', 'schema' => [ 'description' => '编码选项，请参见下文中的MediaEncode枚举值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => '配置模板ID。获取模板ID，请参见[AddRecordTemplate](~~193625~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '76dasgb****', ], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => [ 'description' => '单流录制模式下视频源，取值：'."\n" ."\n" .'- **camera**：摄像头。'."\n" .'- **shareScreen**：屏幕共享。'."\n" ."\n" .'> 如果视频源为shareScreen，且仅推摄像头流，则录制摄像头流；如果同时推屏幕共享流，则录制屏幕共享流。', 'type' => 'string', 'required' => false, 'example' => 'camera', ], ], [ 'name' => 'StreamType', 'in' => 'query', 'schema' => [ 'description' => '单流录制模式，取值：'."\n" ."\n" .'- **0**（默认值）：录制原始流。'."\n" .'- **1**：仅录制音频流。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'MixMode', 'in' => 'query', 'schema' => [ 'description' => '录制模式，取值：'."\n" ."\n" .'- **0**：单流录制，不允许中间修改任务参数（不允许调用UpdateRecordTask接口修改任务参数）。'."\n" .'- **1**（默认值）：合流录制，支持多画面合流输出。'."\n" ."\n" .'> - 单流录制模式下有效参数：StreamType、SourceType。'."\n" .'- 合流录制模式下有效参数：TaskProfile、MediaEncode、LayoutIds、BackgroundColor、SubSpecUsers、CropMode、UserPanes、Backgrounds、Watermarks、ClockWidgets。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CropMode', 'in' => 'query', 'schema' => [ 'description' => '视频的裁剪方式。取值：'."\n" ."\n" .'- **1**：保持比例裁剪。'."\n" .'- **2**：保持比例留边（默认值）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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":"\\r\\n760bad53276431c499e30dc36f6b****\\r\\n","errorExample":""}]', 'title' => '录制视频任务', 'summary' => '调用StartRecordTask录制视频任务。', 'description' => '# 使用说明'."\n" ."\n" .'- 调用本接口前，您必须已经调用[AddRecordTemplate](~~193625~~)添加录制配置模板。'."\n" .'- 默认最多同时启动100个录制任务，超出后新的录制任务将不可用，如果有特殊需求，请[提交工单](https://selfservice.console.aliyun.com/ticket/createIndex)。'."\n" .'- 默认最多同时启动100个录制任务，超出后新的录制任务将不可用，如果有特殊需求，请[提交工单](https://workorder-intl.console.aliyun.com/#/ticket/createIndex)。'."\n" ."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为500次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => '**MediaEncode枚举值：**'."\n" ."\n" .'| ID | 宽 | 高 | 码流（kps） | 帧率（fps） '."\n" .'| ----------- | ----- | ------ | ----------- | --- '."\n" .'| 0 | 0 | 0 | 64 | 0 '."\n" .'| 1 | 640 | 360 | 500 | 15 '."\n" .'| 54 | 360 | 640 | 500 | 30 '."\n" .'| 53 | 360 | 640 | 500 | 15 '."\n" .'| 52 | 640 | 360 | 500 | 30 '."\n" .'| 10 | 960 | 540 | 700 | 24 '."\n" .'| 20 | 1280 | 720 | 1024 | 25 '."\n" .'| 22 | 720 | 1280 | 1024 | 30 '."\n" .'| 23 | 800 | 600 | 1024 | 30 '."\n" .'| 30 | 1920 | 1080 | 2048 | 30 '."\n" .'| 31 | 1080 | 1920 | 2048 | 30 '."\n" .'| 24 | 750 | 780 | 1024 | 30 '."\n" .'| 25 | 750 | 540 | 700 | 30 '."\n" .'| 26 | 720 | 1280 | 2048 | 30 '."\n" .'| 27 | 1280 | 720 | 2048 | 30 '."\n" .'| 28 | 1280 | 720 | 3096 | 30 '."\n" .'| 32 | 1024 | 768 | 1024 | 24 '."\n" .'| 33 | 1280 | 960 | 1024 | 24 '."\n" .'| 34 | 1024 | 768 | 2048 | 24 '."\n" .'| 35 | 1280 | 960 | 2048 | 24 '."\n" .'| 36 | 1280 | 720 | 1024 | 24 '."\n" .'| 37 | 1280 | 720 | 2048 | 24 '."\n" .'| 38 | 540 | 960 | 750 | 15 '."\n" .'| 39 | 540 | 960 | 1500 | 30 '."\n" .'| 40 | 1280 | 720 | 1200 | 15 '."\n" .'| 41 | 720 | 1280 | 1200 | 15 '."\n" .'| 42 | 720 | 1280 | 1500 | 15 '."\n" .'| 43 | 540 | 960 | 1200 | 15 '."\n" ."\n\n" .'**TaskProfile枚举值：**'."\n" ."\n" .'> Mixed_Audio（纯音频）不限制最大输入路数，其余规格根据第一个数字判断支持最大输入路数，例如：4IN_720P代表支持最大输入路数为4。'."\n" ."\n" .'| - | 1080P | 720P | 360P | Audio '."\n" .'| ----- | ------- | ----- | ------ | ------ '."\n" .'| 1IN | 1IN_1080P | 1IN_720P | 1IN_360P | 无'."\n" .'| 2IN | 2IN_1080P | 2IN_720P | 2IN_360P | 无 '."\n" .'| 4IN | 4IN_1080P | 4IN_720P | 4IN_360P | 无'."\n" .'| 9IN | 9IN_1080P | 9IN_720P | 9IN_360P | 无'."\n" .'| 12IN | 12IN_1080P | 12IN_720P | 12IN_360P | 无'."\n" .'| 16IN | 16IN_1080P | 16IN_720P | 16IN_360P | 无'."\n" .'| Mixed| 无 | 无 | 无 | Mixed_Audio'."\n", 'responseParamsDescription' => '**录制结果回调**'."\n" .'录制产生的结果文件写入到用户MNS队列或者将结果文件通过JSON格式以HTTP POST方式回调，参数定义如下所示：'."\n" .'| 参数名称 | 类型 | 说明'."\n" .'| ----- | ------- | -----'."\n" .'| AppId | String | 应用ID。'."\n" .'| ChannelId | String | 频道ID。'."\n" .'| TaskId | String | 录制任务ID。'."\n" .'| Event | String | 事件类型，目前仅支持FileCreated事件。'."\n" .'| MsgId | String | 消息ID。'."\n" .'| StartTime | String | 录制开始时间。'."\n" .'| StopTime | String | 录制结束时间。'."\n" .'| Url | String | 录制到OSS的文件HTTP地址。'."\n" ."\n" .'示例说明：'."\n" ."\n" .'```'."\n" .'{'."\n" .' "AppId": "9q****",'."\n" .' "ChannelId": "record-004",'."\n" .' "Duration": 1792.257,'."\n" .' "Event": "FileCreated",'."\n" .' "MsgId": "83eaaf62-19e8-45df-929b-79f4753b****",'."\n" .' "StartTime": "2020-09-02T10:23:54Z",'."\n" .' "StopTime": "2020-09-02T10:53:46Z",'."\n" .' "TaskId": "task-005",'."\n" .' "Url": "http://rtc-record.****.aliyuncs.com/record/0902-1/9q****/record-004_task-005/2020-09-02-18-23-56_2020-09-02-18-53-56.m3u8"'."\n" .'}'."\n" .'```', 'extraInfo' => '## 特殊错误码'."\n" ."\n" .'|错误代码|描述|HTTP状态码|语义|'."\n" .'|-----|-------|---|----------|'."\n" .'| InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 内部错误。 |'."\n" .'| TaskExisted | task is already existed | 200 | 任务已存在。 |'."\n" .'| InvalidLayoutID.Malformed | The specified layout ID is malformed | 400 | 参数LayoutId错误。 |'."\n" .'| InvalidMediaEncode.Malformed | The specifed MediaEncode is malformed | 400 | 参数MediaEncode错误。|'."\n" .'| InvalidBackgroundColor.Malformed | The specifed background color is malformed | 400 | 参数BackgroundColor错误。 |'."\n" .'| InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 内部错误。 |'."\n", ], 'StopRecordTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。仅支持传单个ID，和[StartRecordTask](~~193528~~)入参TaskId一致。', 'type' => 'string', 'required' => true, 'example' => 'yourTaskId', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '760bad53276431c499e30dc36f6b26be', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => '%s', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n760bad53276431c499e30dc36f6b26be\\r\\n","errorExample":""}]', 'title' => '停止视频录制任务', 'summary' => '调用StopRecordTask停止视频录制任务。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[StartRecordTask](~~193528~~)开始录制视频任务。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为4000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '## 特殊错误码'."\n" ."\n" .'|错误代码|描述|HTTP状态码|语义|'."\n" .'|-------|---|----------|----|'."\n" .'| InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 内部错误 |', ], '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' => '指定该任务订阅的用户列表，默认订阅频道内全部用户，N表示的是数组的下标，取值范围：**1～16**。'."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'userID', ], 'required' => false, 'example' => 'userID', 'maxItems' => 64, ], ], [ 'name' => 'SubSpecAudioUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定订阅房间里有哪些用户音频流。', 'type' => 'array', 'items' => [ 'description' => '指定订阅房间里有哪些用户音频流（输入allStream表示混所有人音频流）。N表示的是数组的下标，取值范围：1～16。'."\n" ."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'audioUserID', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'SubSpecShareScreenUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定订阅房间里有哪些用户屏幕共享流。', 'type' => 'array', 'items' => [ 'description' => '指定订阅房间里有哪些用户屏幕共享流（输入allStream表示混所有人屏幕共享流）。N表示的是数组的下标，取值范围：1～16。'."\n" ."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'videoUserID', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'SubSpecCameraUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定订阅房间里有哪些用户摄像头流。', 'type' => 'array', 'items' => [ 'description' => '指定订阅房间里有哪些用户摄像头流（输入allStream表示混所有人摄像头流）。N表示的是数组的下标，取值范围：1～16。'."\n" ."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'cameraUserID', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'UnsubSpecAudioUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定非订阅房间里有哪些用户音频流。', 'type' => 'array', 'items' => [ 'description' => '指定非订阅房间里有哪些用户音频流（输入allStream表示混所有人音频流）。N表示的是数组的下标，取值范围：1～16。'."\n" ."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'audioUserID2', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'UnsubSpecShareScreenUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定非订阅房间里有哪些用户屏幕共享流。', 'type' => 'array', 'items' => [ 'description' => '指定非订阅房间里有哪些用户屏幕共享流（输入allStream表示混所有人屏幕共享流）。N表示的是数组的下标，取值范围：1～16。'."\n" ."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'videoUserID2', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'UnsubSpecCameraUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定非订阅房间里有哪些用户摄像头流。', 'type' => 'array', 'items' => [ 'description' => '指定非订阅房间里有哪些用户摄像头流（输入allStream表示混所有人摄像头流）。N表示的是数组的下标，取值范围：1～16。'."\n" ."\n" .'> N需要从1开始并从小到大，不能中断，要连续。', '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' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Url' => [ 'description' => '图片的HTTP或HTTPS地址。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '图片显示，取值：'."\n" ."\n" .'- **0**（None）：不显示。'."\n" .'- **1**（Always）：总是显示。'."\n" .'- **2**（Backup）：当前用户无视频流时显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 16, ], 'UserId' => [ 'description' => '对应布局框格的用户ID。N的取值：**1~16**。', 'type' => 'string', 'required' => false, 'example' => 'TestId', ], 'Texts' => [ 'description' => '当前布局的文字框位列表。', 'type' => 'array', 'items' => [ 'description' => '当前布局的文字框位，最多支持16个文本。', 'type' => 'object', 'properties' => [ 'FontType' => [ 'description' => '字体类型，取值：'."\n" ."\n" .'- **0**（默认）：NOTO_SERIF_CJKSC_REGULAR。'."\n" .'- **1**：ALIBABA_PUHUITI_REGULAR。'."\n" .'- **2**：ALIBABA_PUHUITI_BOLD。'."\n" .'- **3**：ALIBABA_PUHUITI_Heavy。'."\n" .'- **4**：ALIBABA_PUHUITI_LIGHT。'."\n" .'- **5**：ALIBABA_PUHUITI_MEDIUM。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'FontColor' => [ 'description' => '文字颜色（RGB）。计算公式为R+G×256+B×65536，R（红）、G（绿）、B（蓝）的取值：**0~255**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Y' => [ 'description' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Text' => [ 'description' => '文本内容。', 'type' => 'string', 'required' => false, 'example' => 'text', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'FontSize' => [ 'description' => '字体大小。字体合理范围：**(0, 72]**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 16, ], 'SourceType' => [ 'description' => '对应布局的用户视频输入。取值：'."\n" ."\n" .'- **camera**（默认）：视频流。'."\n" .'- **shareScreen**：共享屏幕流。'."\n" ."\n" .'N的取值：**1~16**。', 'type' => 'string', 'required' => false, 'example' => 'camera', ], 'PaneId' => [ 'description' => '窗格ID。N的取值：**1~16**。PaneID的取值：**0~15**。'."\n" ."\n" .'> 当指定的PaneId用户找不到的话，会默认显示其他的流，流的确定是根据用户加入频道的顺序。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 16, ], ], [ 'name' => 'LayoutIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '布局ID组。', 'type' => 'array', 'items' => [ 'description' => '布局ID数据，您可在一次任务中指定多个布局，系统会根据当时频道中的人数进行切换。数组下标取值范围：**1**～**16**，相当于一个旁路任务中最多可以同时设置16种布局。详情请参见[布局](~~109587~~)。'."\n" .'> - 数组下标需要从1开始并从小到大，不能中断，要连续。'."\n" .'- 设置的布局窗格数不能相同。例：官网上的布局ID 2和3 的不能同时设置，他们两个的窗格数相同都是2。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '频道ID。仅支持传单个ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yourChannelId', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。仅支持传单个ID，和[StartRecordTask](~~193528~~)入参TaskId一致。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yourTaskId', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => '配置模板ID。获取模板ID，请参见[AddRecordTemplate](~~193625~~)。', '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' => '请求ID。', 'type' => 'string', 'example' => '760bad53276431c499e30dc36f6b26be', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n760bad53276431c499e30dc36f6b26be\\r\\n","errorExample":""}]', 'title' => '更新录制视频任务', 'summary' => '调用UpdateRecordTask更新录制视频任务。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[StartRecordTask](~~193528~~)开始录制视频任务。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '## 特殊错误码'."\n" ."\n" .'|错误代码|描述|HTTP状态码|语义|'."\n" .'|-----|-------|---|----------|'."\n" .'| InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 内部错误。 |'."\n" .'| TaskExisted | task is already existed | 200 | 任务已存在。 |'."\n" .'| InvalidLayoutID.Malformed | The specified layout ID is malformed | 400 | 参数LayoutId错误 |'."\n" .'| InvalidMediaEncode.Malformed | The specifed MediaEncode is malformed | 400 | 参数MediaEncode错误。|'."\n" .'| InvalidBackgroundColor.Malformed | The specifed background color is malformed | 400 | 参数BackgroundColor错误。 |'."\n" .'| InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 内部错误。 |'."\n", ], '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' => '查询模板ID列表，格式如下所示：'."\n" ."\n" .'```'."\n" .'TemplateIds.1=****'."\n" .'TemplateIds.2=****'."\n" .'......'."\n" .'```'."\n" ."\n" .'获取模板ID，请参见[AddRecordTemplate](~~193625~~)。', 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => false, 'example' => '76dasgb****', 'maxItems' => 64, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID。通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页显示个数，默认取值**10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几页，默认查询第**1**页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalPage' => [ 'description' => '返回分页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RequestId' => [ 'description' => '请求ID。', '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' => '录制事件回调MNS队列名称。', 'type' => 'string', 'example' => 'record-callback-queue', ], 'OssFilePrefix' => [ 'description' => '录制文件命名规则。', 'type' => 'string', 'example' => 'record/pre/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}', ], 'CreateTime' => [ 'description' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2020-09-04T06:22:15Z', ], 'OssBucket' => [ 'description' => '录制文件存储OSS Bucket名称。', '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' => '录制事件HTTP回调地址。', 'type' => 'string', 'example' => 'http://example.com/callback', ], 'EnableM3u8DateTime' => [ 'description' => '录制的m3u8文件是否需要加上ts文件时间点。', 'type' => 'boolean', 'example' => 'false', ], 'BackgroundColor' => [ 'description' => '背景色RGB。默认是**0**（黑色）。计算公式为R+G×256+B×65536，R（红）、G（绿）、B（蓝）的取值：**0~255**。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Name' => [ 'description' => '录制配置模板名称。', 'type' => 'string', 'example' => '模板-demo', ], 'TemplateId' => [ 'description' => '录制配置模板ID。', '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' => '背景图片坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'example' => '0.7576', ], 'Url' => [ 'description' => '背景图片的HTTP或HTTPS地址。', 'type' => 'string', 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '背景图片显示。取值：'."\n" ."\n" .'- **0**（None）：不显示。'."\n" .'- **1**（Always）：总是显示。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ZOrder' => [ 'description' => '背景图片叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'X' => [ 'description' => '背景图片坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'example' => '0.7576', ], ], ], ], 'Watermarks' => [ 'description' => '水印信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Alpha' => [ 'description' => '水印透明度，归一化百分比。其中0表示透明，1表示完全不透明。', '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' => '水印坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'example' => '0.7576', ], 'Url' => [ 'description' => '水印的HTTP或HTTPS地址。', 'type' => 'string', 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '水印显示。取值：'."\n" ."\n" .'- **0**（None）：不显示。'."\n" .'- **1**（Always）：总是显示。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ZOrder' => [ 'description' => '水印叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'X' => [ 'description' => '水印坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'example' => '0.7576', ], ], ], ], 'ClockWidgets' => [ 'description' => '时钟信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FontType' => [ 'description' => '时钟字体类型，取值：'."\n" ."\n" .'- **0**（默认值）：NOTO_SERIF_CJKSC_REGULAR'."\n" .'- **1**：ALIBABA_PUHUITI_REGULAR'."\n" .'- **2**：ALIBABA_PUHUITI_BOLD'."\n" .'- **3**：ALIBABA_PUHUITI_Heavy'."\n" .'- **4**：ALIBABA_PUHUITI_LIGHT'."\n" .'- **5**：ALIBABA_PUHUITI_MEDIUM', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'FontColor' => [ 'description' => '时钟文字颜色（RGB）。'."\n" ."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Y' => [ 'description' => '时钟坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'example' => '0.7576', ], 'ZOrder' => [ 'description' => '时钟叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'X' => [ 'description' => '时钟坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'example' => '0.7576', ], 'FontSize' => [ 'description' => '时钟字体大小。字体合理范围**(0, 72]**。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'LayoutIds' => [ 'type' => 'array', 'items' => [ 'description' => '布局ID列表。', 'type' => 'integer', 'example' => '2', 'format' => 'int64', ], ], 'Formats' => [ 'type' => 'array', 'items' => [ 'description' => '录制文件格式。当前仅支持：**M3U8、MP4、FLV**。', '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":"\\r\\n1\\r\\n\\tC292B80E-5175-4BA4-8C1E-2ABEC4D7C2FE\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\t1800\\r\\nrecord/pre/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}\\r\\n\\t\\t4IN_1080P\\r\\n\\t\\trtc-record-pre\\r\\n\\t\\t50\\r\\n\\t\\t2\\r\\n\\t\\tm3u8\\r\\n\\t\\t1ca698e2-57fa-4314-8e11-00d950d4****\\r\\n\\t\\trecord-callback-queue\\r\\n\\t\\t模板-demo\\r\\n\\t\\t0\\r\\n\\t\\r\\n ","errorExample":""}]', 'title' => '查询录制模板配置列表', 'summary' => '调用DescribeRecordTemplates查询录制模板配置列表。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[AddRecordTemplate](~~193625~~)添加录制配置模板。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRecordFiles' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'TaskIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '录制任务ID。', 'type' => 'array', 'items' => [ 'description' => '录制任务ID（和[StartRecordTask](~~193528~~)入参中的TaskId一致），最多支持10个任务批量查询。格式如下所示：'."\n" ."\n" .'```'."\n" .'TaskIds.1=****'."\n" .'TaskIds.2=****'."\n" .'......'."\n" .'```', 'type' => 'string', 'required' => false, 'example' => 'yourTaskId', ], 'required' => false, 'example' => 'yourTaskId', 'maxItems' => 10, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID。仅支持传单个ID，您可以在控制台创建和查询。', 'type' => 'string', 'required' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '频道ID。仅支持传单个ID。', 'type' => 'string', 'required' => false, 'example' => 'yourChannelId', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页显示个数，默认为**10**，每页最多显示**100**个数据。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几页，默认查询第1页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-11-01T17:36:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n", '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' => '请求ID。', 'type' => 'string', 'example' => '760bad53276431c499e30dc36f6b****', ], 'TotalNum' => [ 'description' => '返回结果数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RecordFiles' => [ 'description' => '文件列表。', 'type' => 'array', 'items' => [ 'description' => '文件列表详情。', 'type' => 'object', 'properties' => [ 'StartTime' => [ 'description' => '开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2020-11-01T17:36:00Z', ], 'CreateTime' => [ 'description' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2020-10-02T17:36:00Z', ], 'AppId' => [ 'description' => '应用ID。', 'type' => 'string', 'example' => 'yourAppId', ], 'ChannelId' => [ 'description' => '频道ID。', 'type' => 'string', 'example' => 'yourChannelId', ], 'Url' => [ 'description' => '录制文件OSS URL。', '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' => '任务ID。', 'type' => 'string', 'example' => 'yourTaskId', ], 'StopTime' => [ 'description' => '结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', '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":"\\r\\n3\\r\\n\\tAB2D3461-2F88-43DC-B60F-2F4C9BDB6522\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\tyourTaskId\\r\\n\\t\\t9qb1zcyc\\r\\n\\t\\t2020-11-17T05:08:12Z\\r\\n\\t\\t2020-11-17T04:40:28Z\\r\\n\\t\\t1482.29\\r\\n\\t\\trecord-002\\r\\n\\t\\thttp://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\\r\\n\\t\\t2020-11-17T05:05:11Z\\r\\n\\t\\r\\n\\t\\r\\n\\t\\tyourTaskId\\r\\n\\t\\t9qb1zcyc\\r\\n\\t\\t2020-11-17T04:40:37Z\\r\\n\\t\\t2020-11-17T04:10:27Z\\r\\n\\t\\t1800.01\\r\\n\\t\\trecord-002\\r\\n\\t\\thttp://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\\r\\n\\t\\t2020-11-17T04:40:28Z\\r\\n\\t\\r\\n\\t\\r\\n\\t\\tyourTaskId\\r\\n\\t\\t9qb1zcyc\\r\\n\\t\\t2020-11-17T04:10:34Z\\r\\n\\t\\t2020-11-17T03:40:28Z\\r\\n\\t\\t1799.95\\r\\n\\t\\trecord-002\\r\\n\\t\\thttp://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\\r\\n\\t\\t2020-11-17T04:10:28Z\\r\\n\\t\\r\\n ","errorExample":""}]', 'title' => '查询录制生成的文件列表', 'summary' => '调用DescribeRecordFiles查询录制生成的文件列表。', 'description' => '# 使用说明'."\n" .'本接口用于查询录制生成的文件列表。例如：您可以查询录制生成文件的创建时间、录制时长等参数。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '## 特殊错误码'."\n" ."\n" .'|错误代码|描述|HTTP状态码|语义|'."\n" .'|-----|-------|---|----------|'."\n" .'| InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 内部错误 |', ], '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' => '指定该任务订阅的用户列表，默认订阅频道内全部用户，数组下标取值范围：**1**～**16**。'."\n" .'>数组下标需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'userID', ], 'required' => false, 'example' => 'userID', 'maxItems' => 64, ], ], [ 'name' => 'SubSpecAudioUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定订阅房间里哪些用户音频流。', 'type' => 'array', 'items' => [ 'description' => '指定订阅房间里哪些用户音频流（输入allStream表示混所有人音频）。数组下标取值范围：**1**～**64**。'."\n" .'>数组下标需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'audioUserID', ], 'required' => false, 'example' => 'audioUserID', 'maxItems' => 64, ], ], [ 'name' => 'SubSpecShareScreenUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定订阅房间里哪些用户共享视频流。', 'type' => 'array', 'items' => [ 'description' => '指定订阅房间里哪些用户共享视频流（输入allStream表示混所有人共享视频）。数组下标取值范围：**1**～**64**。'."\n" .'>数组下标需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'videoUserID', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'SubSpecCameraUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定订阅房间里哪些用户摄像头视频流。', 'type' => 'array', 'items' => [ 'description' => '指定订阅房间里哪些用户摄像头视频流（输入allStream表示混所有人摄像头视频）。数组下标取值范围：**1**～**64**。'."\n" .'>数组下标需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'cameraUserID', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'UnsubSpecAudioUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定不订阅房间里哪些用户音频流。', 'type' => 'array', 'items' => [ 'description' => '指定不订阅房间里哪些用户音频流（输入allStream表示不混所有人音频）。数组下标取值范围：**1**～**64**。'."\n" ."\n" .'> 数组下标需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'audioUserID2', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'UnsubSpecShareScreenUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定不订阅房间里哪些用户共享视频流。', 'type' => 'array', 'items' => [ 'description' => '指定不订阅房间里哪些用户共享视频流（输入allStream表示不混所有人共享视频）。数组下标取值范围：**1**～**64**。'."\n" ."\n" .'> 数组下标需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'videoUserID2', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'UnsubSpecCameraUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定不订阅房间里哪些用户摄像头视频流。', 'type' => 'array', 'items' => [ 'description' => '指定不订阅房间里哪些用户摄像头视频流（输入allStream表示不混所有人摄像头视频）。数组下标取值范围：**1**～**64**。'."\n" .'>数组下标需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'cameraUserID2', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'LayoutIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '布局ID数据。', 'type' => 'array', 'items' => [ 'description' => '布局ID数据，您可在一次任务中指定多个布局，系统会根据当时频道中的人数进行切换。数组下标取值范围：**1**～**16**，相当于一个旁路任务中最多可以同时设置16种布局。详情请参见[布局](~~109587~~)。'."\n" .'> - 数组下标需要从1开始并从小到大，不能中断，要连续。'."\n" .'- 设置的布局窗格数不能相同。例：官网上的布局ID 2和3 的不能同时设置，他们两个的窗格数相同都是2。', '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' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Url' => [ 'description' => '图片的HTTP或HTTPS地址。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '图片显示，取值：'."\n" ."\n" .'- **0（None）**：不显示。'."\n" .'- **1（Always）**：总是显示。'."\n" .'- **2（Backup）**：当前用户无视频流时显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 10, ], 'SegmentType' => [ 'description' => '人像分割类型。取值：'."\n" ."\n" .'- **0**：无人像分割（默认值）。'."\n" ."\n" .'- **1**：人像分割，仅在开启增强参数（人像分割功能）后有效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'UserId' => [ 'description' => '对应布局框格的用户ID。取值：**1**~**16**。', 'type' => 'string', 'required' => false, 'example' => 'TestId', ], 'Texts' => [ 'description' => '当前布局的文字框位列表。', 'type' => 'array', 'items' => [ 'description' => '当前布局的文字框位，最多支持16个文本。', 'type' => 'object', 'properties' => [ 'FontType' => [ 'description' => '字体类型，取值：'."\n" ."\n" .'- **0**：NOTO_SERIF_CJKSC_REGULAR（默认值）'."\n" .'- **1**：ALIBABA_PUHUITI_REGULAR'."\n" .'- **2**：ALIBABA_PUHUITI_BOLD'."\n" .'- **3**：ALIBABA_PUHUITI_Heavy'."\n" .'- **4**：ALIBABA_PUHUITI_LIGHT'."\n" .'- **5**：ALIBABA_PUHUITI_MEDIUM', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'FontColor' => [ 'description' => '文字颜色（RGB）。'."\n" ."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Y' => [ 'description' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.2456', ], 'Text' => [ 'description' => '文本内容。', 'type' => 'string', 'required' => false, 'example' => 'text', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'FontSize' => [ 'description' => '字体大小，取值范围：**0**~**72**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'BorderWidth' => [ 'description' => '文字描边宽度（单位：像素），默认为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1', ], 'BorderColor' => [ 'description' => '文字描边颜色。'."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '0', ], 'Box' => [ 'description' => '是否出现文字框。取值：'."\n" ."\n" .'- false（默认值）：不出现。'."\n" .'- true：出现。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'BoxColor' => [ 'description' => '文字框颜色。'."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '0', ], 'BoxBorderWidth' => [ 'description' => '文字框宽度（单位：像素），默认为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '0', ], 'Alpha' => [ 'description' => '文字框和文字透明度。0.0表示透明，1.0表示完全不透明。', 'type' => 'number', 'format' => 'float', 'required' => false, 'minimum' => '0', 'example' => '0', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 16, ], 'SourceType' => [ 'description' => '对应布局的用户视频输入。取值：'."\n" ."\n" .'- **camera**：视频流（默认值）。'."\n" .'- **shareScreen**：共享屏幕流。', 'type' => 'string', 'required' => false, 'example' => 'camera', ], 'PaneId' => [ 'description' => '窗格ID，取值：**0**~**15**。'."\n" .'>当指定的PaneId用户找不到的话，会默认显示其他的流，流的确定是根据用户加入频道的顺序。'."\n" ."\n", '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' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Url' => [ 'description' => '图片的HTTP或HTTPS地址。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '图片显示，取值：'."\n" ."\n" .'- **0（None）**：不显示。'."\n" .'- **1（Always）**：总是显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', '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' => '透明度。0.0表示透明，1.0表示完全不透明。'."\n", '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' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Url' => [ 'description' => '图片的HTTP或HTTPS地址。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '图片显示，取值：'."\n" ."\n" .'- **0（None）**：不显示。'."\n" .'- **1（Always）**：总是显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', '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' => '字体类型，取值：'."\n" ."\n" .'- **0**：NOTO_SERIF_CJKSC_REGULAR（默认值）'."\n" .'- **1**：ALIBABA_PUHUITI_REGULAR'."\n" .'- **2**：ALIBABA_PUHUITI_BOLD'."\n" .'- **3**：ALIBABA_PUHUITI_Heavy'."\n" .'- **4**：ALIBABA_PUHUITI_LIGHT'."\n" .'- **5**：ALIBABA_PUHUITI_MEDIUM', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'FontColor' => [ 'description' => '文字颜色（RGB）。'."\n" ."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Y' => [ 'description' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'FontSize' => [ 'description' => '字体大小，取值范围：**0**~**72**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'BorderWidth' => [ 'description' => '文字描边宽度（单位：像素），默认为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1', ], 'BorderColor' => [ 'description' => '文字描边颜色。'."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '0', ], 'Box' => [ 'description' => '是否出现文字框。取值：'."\n" ."\n" .'- false（默认值）：不出现。'."\n" .'- true：出现。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'BoxColor' => [ 'description' => '文字框颜色。'."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '0', ], 'BoxBorderWidth' => [ 'description' => '文字框宽度（单位：像素），默认为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '0', ], 'Alpha' => [ 'description' => '文字框和文字透明度。0.0表示透明，1.0表示完全不透明。', 'type' => 'number', 'format' => 'float', 'required' => false, 'minimum' => '0', 'example' => '0', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 1, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，仅支持传单个ID。'."\n" ."\n" .'您可以在控制台创建和查询。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yourChannelId', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。'."\n" ."\n" .'> 此ID为旁路转推的标识，需保证唯一。'."\n" ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yourTaskId', ], ], [ 'name' => 'MixMode', 'in' => 'query', 'schema' => [ 'description' => '混流模式。取值：'."\n" ."\n" .'- **0**：单路转推，不混流转码，仅转推原始单路流，无需配置混流转码参数。'."\n" .'- **1**：混流转码（默认值），支持混流转码输出。'."\n" ."\n" .'> - 单路转推模式下有效参数：**StreamType**、**SourceType**、**SubSpecUsers**。'."\n" .'- 混流转码模式下有效参数：**MediaEncode**、**LayoutIds**、**BackgroundColor**、**SubSpecUsers**、**CropMode**、**UserPanes**、**Backgrounds**、**Watermarks**。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'CropMode', 'in' => 'query', 'schema' => [ 'description' => '视频的裁剪方式。取值：'."\n" ."\n" .'- **1**：保持比例裁剪。'."\n" ."\n" .'- **2**：保持比例留边（默认值）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'MediaEncode', 'in' => 'query', 'schema' => [ 'description' => '编码选项，请参见下文中的MediaEncode枚举值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => [ 'description' => '单路转推模式下用户视频输入流。取值：'."\n" ."\n" .'- **camera**：摄像头。'."\n" .'- **shareScreen**：屏幕共享。'."\n", 'type' => 'string', 'required' => false, 'example' => 'camera', ], ], [ 'name' => 'StreamType', 'in' => 'query', 'schema' => [ 'description' => '单路转推模式下转推音频流。取值：'."\n" ."\n" .'- **0**：转推原始流。'."\n" .'- **1**：仅转推音频流。'."\n" .'- **2**：仅转推视频流。'."\n" ."\n" .'默认转推原始流。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'BackgroundColor', 'in' => 'query', 'schema' => [ 'description' => '背景色RGB，默认是**0**（黑色）。'."\n" ."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：0~255。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'StreamURL', 'in' => 'query', 'schema' => [ 'description' => '直播推流地址，仅支持传单个地址。生成规则请参见[推流地址和播放地址](~~199339~~)。'."\n" ."\n" .'>- 对已开防盗链鉴权的域名，需要在推流地址中包含鉴权串。'."\n" .'- 禁止同一个StreamURL在不同任务中同时使用。'."\n" .'- 任务停止10S之内，禁止使用同一个StreamURL。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'rtmp://example.com/live/stream', ], ], [ 'name' => 'PayloadType', 'in' => 'query', 'schema' => [ 'description' => '载荷类型。取值：'."\n" .'- **0**：不使用载荷。'."\n" .'- **1**：使用VideoSEI。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ReportVad', 'in' => 'query', 'schema' => [ 'description' => '语音激励标志。取值：'."\n" .'- **0**：不传递语音激励信息。'."\n" .'- **1**：传递语音激励信息。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'RtpExtInfo', 'in' => 'query', 'schema' => [ 'description' => 'RTP扩展头信息。取值：'."\n" .'- **0**：不传递。'."\n" .'- **1**：传递。', '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' => '媒体处理类型。取值：'."\n" ."\n" .'- **0**：旁路转推任务。'."\n" .'- **1**：MCU混流低延时分发任务。', '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' => '人像分割功能（内测中），取值：'."\n" ."\n" .'- **true**：开启。'."\n" .'- **false**（默认值）：关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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":"\\r\\n\\t760bad53276431c499e30dc36f6b26be\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]', 'title' => '开始任务', 'summary' => '调用StartMPUTask开始旁路转推任务。', 'description' => '# 使用说明'."\n" .'本接口用于开始旁路转推任务。当您使用旁路转推服务时，阿里云视频直播服务限制如下所示：'."\n" ."\n" .'- 并发限制任务数请参见[并发限制](https://help.aliyun.com/document_detail/71050.html#section-eaz-anq-a47)。如果有特殊需求，请提前两周[提交工单](https://selfservice.console.aliyun.com/ticket/createIndex)。'."\n" .'- 并发限制任务数请参见[并发限制](https://www.alibabacloud.com/help/rtc-61399/latest/60e652#section-eaz-anq-a47)。如果有特殊需求，请提前两周[提交工单](https://workorder-intl.console.aliyun.com/#/ticket/createIndex)。'."\n" .'- 如果未开启转码功能，默认每个账号下每个直播加速域名最多并发推送20个原画直播流。如果有特殊需求，请[提交工单](https://selfservice.console.aliyun.com/ticket/createIndex)。'."\n" .'- 如果启用转码功能，默认每个账号下每个直播加速域名最多并发推送10个转码直播流。如果有特殊需求，请[提交工单](https://selfservice.console.aliyun.com/ticket/createIndex)。'."\n" ."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为500次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => "\n" .'**MediaEncode**枚举值如下所示。'."\n" ."\n" .'| ID | 宽 | 高 | 码流（kps） | 帧率（fps） '."\n" .'| ----------- | ----- | ------ | ----------- | --- '."\n" .'| 0 | 0 | 0 | 64 | 0 '."\n" .'| 1 | 640 | 360 | 500 | 15 '."\n" .'| 54 | 360 | 640 | 500 | 30 '."\n" .'| 53 | 360 | 640 | 500 | 15 '."\n" .'| 52 | 640 | 360 | 500 | 30 '."\n" .'| 10 | 960 | 540 | 700 | 24 '."\n" .'| 20 | 1280 | 720 | 1024 | 25 '."\n" .'| 22 | 720 | 1280 | 1024 | 30 '."\n" .'| 23 | 800 | 600 | 1024 | 30 '."\n" .'| 30 | 1920 | 1080 | 2048 | 30 '."\n" .'| 31 | 1080 | 1920 | 2048 | 30 '."\n" .'| 24 | 750 | 780 | 1024 | 30 '."\n" .'| 25 | 750 | 540 | 700 | 30 '."\n" .'| 26 | 720 | 1280 | 2048 | 30 '."\n" .'| 27 | 1280 | 720 | 2048 | 30 '."\n" .'| 28 | 1280 | 720 | 3096 | 30 '."\n" .'| 32 | 1024 | 768 | 1024 | 24 '."\n" .'| 33 | 1280 | 960 | 1024 | 24 '."\n" .'| 34 | 1024 | 768 | 2048 | 24 '."\n" .'| 35 | 1280 | 960 | 2048 | 24 '."\n" .'| 36 | 1280 | 720 | 1024 | 24 '."\n" .'| 37 | 1280 | 720 | 2048 | 24 '."\n" .'| 38 | 540 | 960 | 750 | 15 '."\n" .'| 39 | 540 | 960 | 1500 | 30 '."\n" .'| 40 | 1280 | 720 | 1200 | 15 '."\n" .'| 41 | 720 | 1280 | 1200 | 15 '."\n" .'| 42 | 720 | 1280 | 1500 | 15 '."\n" .'| 43 | 540 | 960 | 1200 | 15 '."\n" ."\n" .'> 当用户使用纯音频直播的时候需要注意的问题，然后直接跳转常见问题中的[纯音频直播](https://helpcdn.aliyun.com/document_detail/159390.html?spm=a2c4g.11174283.6.729.445a3c3d4LDYq5)。', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'StopMPUTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，仅支持传单个ID。'."\n" ."\n" .'> 您可以在[控制台](https://rtc.console.aliyun.com/manage/list#/manage/list)创建和查询。', 'type' => 'string', 'required' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID，仅支持传单个ID，和[StartMpuTask](~~93183~~)入参TaskId一致。', 'type' => 'string', 'required' => true, 'example' => 'yourTaskId', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '760bad53276431c499e30dc36f6b26be', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => '%s', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\t760bad53276431c499e30dc36f6b26be\\n\\n\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\", \\n}"}]', 'title' => '停止任务', 'summary' => '调用StopMPUTask停止旁路转推任务。', 'description' => '# 使用说明'."\n" ."\n" .'- 调用本接口前，您必须已经调用[StartMpuTask](~~93183~~)开始旁路转推任务。'."\n" .'- 如果需要停止旁路转推任务时，此时旁路转推任务异常（未调用StopMPUTask停止任务），本次旁路转推任务会在最后一个人离开频道2分钟后自动停止任务。停止后如果需要恢复旁路转推，您需要重新调用[StartMpuTask](~~93183~~)接口。'."\n" ."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为500次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpdateMPUTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'LayoutIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '布局ID数据。', 'type' => 'array', 'items' => [ 'description' => '布局ID数据，用户可在一次任务中指定多个布局，系统会根据当时channel（频道）中的人数进行切换。详情请参见[布局](~~109587~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'SubSpecUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定该任务订阅的用户列表。', 'type' => 'array', 'items' => [ 'description' => '指定该任务订阅的用户列表，默认订阅频道内全部用户，数组下标取值范围：**1**～**16**。'."\n" .'>数组下标需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'userID', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'SubSpecAudioUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定订阅房间里哪些用户音频流。', 'type' => 'array', 'items' => [ 'description' => '指定订阅房间里哪些用户音频流（输入allStream表示混所有人音频）。数组下标取值范围：**1**～**64**。'."\n" .'>数组下标需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'audioUserID', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'SubSpecShareScreenUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定订阅房间里哪些用户共享视频流。', 'type' => 'array', 'items' => [ 'description' => '指定订阅房间里哪些用户共享视频流（输入allStream表示混所有人共享视频）。数组下标取值范围：**1**～**64**。'."\n" .'>数组下标需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'videoUserID', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'SubSpecCameraUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定订阅房间里哪些用户摄像头视频流。', 'type' => 'array', 'items' => [ 'description' => '指定订阅房间里哪些用户摄像头视频流（输入allStream表示混所有人摄像头视频）。数组下标取值范围：**1**～**64**。'."\n" .'>数组下标需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'cameraUserID', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'UnsubSpecAudioUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定不订阅房间里哪些用户音频流。', 'type' => 'array', 'items' => [ 'description' => '指定不订阅房间里哪些用户音频流（输入allStream表示不混所有人音频）。数组下标取值范围：**1**～**64**。'."\n" ."\n" .'> 数组下标需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'audioUserID2', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'UnsubSpecShareScreenUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定不订阅房间里哪些用户共享视频流。', 'type' => 'array', 'items' => [ 'description' => '指定不订阅房间里哪些用户共享视频流（输入allStream表示不混所有人共享视频）。数组下标取值范围：**1**～**64**。'."\n" ."\n" .'> 数组下标需要从1开始并从小到大，不能中断，要连续。', 'type' => 'string', 'required' => false, 'example' => 'videoUserID2', ], 'required' => false, 'maxItems' => 64, ], ], [ 'name' => 'UnsubSpecCameraUsers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '指定不订阅房间里哪些用户摄像头视频流。', 'type' => 'array', 'items' => [ 'description' => '指定不订阅房间里哪些用户摄像头视频流（输入allStream表示不混所有人摄像头视频）。数组下标取值范围：**1**～**64**。'."\n" .'>数组下标需要从1开始并从小到大，不能中断，要连续。', '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' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Url' => [ 'description' => '图片的HTTP或HTTPS地址。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '图片显示，取值：'."\n" ."\n" .'- **0（None）**：不显示。'."\n" .'- **1（Always）**：总是显示。'."\n" .'- **2（Backup）**：当前用户无视频流时显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 10, ], 'SegmentType' => [ 'description' => '人像分割类型。取值：'."\n" ."\n" .'- **0**：无人像分割（默认值）。'."\n" ."\n" .'- **1**：人像分割，仅在开启增强参数（人像分割功能）后有效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'UserId' => [ 'description' => '对应布局窗格的用户ID，取值：**1**~**16**。', 'type' => 'string', 'required' => false, 'example' => 'TestUserID', ], 'Texts' => [ 'description' => '当前布局的文字框位列表。', 'type' => 'array', 'items' => [ 'description' => '当前布局的文字框位，最多支持16个文本。', 'type' => 'object', 'properties' => [ 'FontType' => [ 'description' => '字体类型，取值：'."\n" ."\n" .'- **0**（默认值）：NOTO_SERIF_CJKSC_REGULAR'."\n" .'- **1**：ALIBABA_PUHUITI_REGULAR'."\n" .'- **2**：ALIBABA_PUHUITI_BOLD'."\n" .'- **3**：ALIBABA_PUHUITI_Heavy'."\n" .'- **4**：ALIBABA_PUHUITI_LIGHT'."\n" .'- **5**：ALIBABA_PUHUITI_MEDIUM', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'FontColor' => [ 'description' => '文字颜色（RGB）。'."\n" ."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Y' => [ 'description' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Text' => [ 'description' => '文本内容。', 'type' => 'string', 'required' => false, 'example' => 'text', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'FontSize' => [ 'description' => '字体大小，取值范围：**0**~**72**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'BorderWidth' => [ 'description' => '文字描边宽度（单位：像素），默认为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1', ], 'BorderColor' => [ 'description' => '文字描边颜色。'."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '0', ], 'Box' => [ 'description' => '是否出现文字框。取值：'."\n" ."\n" .'- false（默认值）：不出现。'."\n" .'- true：出现。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'BoxColor' => [ 'description' => '文字框颜色。'."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '0', ], 'BoxBorderWidth' => [ 'description' => '文字框宽度（单位：像素），默认为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '0', ], 'Alpha' => [ 'description' => '文字框和文字透明度。0.0表示透明，1.0表示完全不透明。', 'type' => 'number', 'format' => 'float', 'required' => false, 'minimum' => '0', 'example' => '0', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 16, ], 'SourceType' => [ 'description' => '对应布局的用户视频输入，取值：'."\n" ."\n" .'- **camera**：相机流。'."\n" ."\n" .'- **shareScreen**：共享屏幕流。'."\n", 'type' => 'string', 'required' => false, 'example' => 'camera', ], 'PaneId' => [ 'description' => '窗格ID，取值范围：**0**~**15**。', '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' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Url' => [ 'description' => '图片的HTTP或HTTPS地址。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '图片显示，取值：'."\n" ."\n" .'- **0（None）**：不显示。'."\n" .'- **1（Always）**：总是显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', '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' => '透明度。0.0表示透明，1.0表示完全不透明。', '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' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'Url' => [ 'description' => '图片的HTTP或HTTPS地址。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/image.jpg', ], 'Display' => [ 'description' => '图片显示，取值：'."\n" ."\n" .'- **0（None）**：不显示。'."\n" .'- **1（Always）**：总是显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', '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' => '字体类型，取值：'."\n" ."\n" .'- **0**（默认值）：NOTO_SERIF_CJKSC_REGULAR'."\n" .'- **1**：ALIBABA_PUHUITI_REGULAR'."\n" .'- **2**：ALIBABA_PUHUITI_BOLD'."\n" .'- **3**：ALIBABA_PUHUITI_Heavy'."\n" .'- **4**：ALIBABA_PUHUITI_LIGHT'."\n" .'- **5**：ALIBABA_PUHUITI_MEDIUM', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'FontColor' => [ 'description' => '文字颜色（RGB）。'."\n" ."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Y' => [ 'description' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'FontSize' => [ 'description' => '字体大小，取值范围：**0**~**72**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'BorderWidth' => [ 'description' => '文字描边宽度（单位：像素），默认为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1', ], 'BorderColor' => [ 'description' => '文字描边颜色。'."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], 'Box' => [ 'description' => '是否出现文字框。取值：'."\n" ."\n" .'- false（默认值）：不出现。'."\n" .'- true：出现。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'BoxColor' => [ 'description' => '文字框颜色。'."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '0', ], 'BoxBorderWidth' => [ 'description' => '文字框宽度（单位：像素），默认为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '0', ], 'Alpha' => [ 'description' => '文字框和文字透明度。0.0表示透明，1.0表示完全不透明。', 'type' => 'number', 'format' => 'float', 'required' => false, 'minimum' => '0', 'example' => '0', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 1, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，仅支持传单个ID。'."\n" ."\n" .'可通过控制台创建和查询。', 'type' => 'string', 'required' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID，仅支持传单个ID，和[StartMpuTask](~~93183~~)中入参TaskId一致。', 'type' => 'string', 'required' => true, 'example' => 'testId', ], ], [ 'name' => 'CropMode', 'in' => 'query', 'schema' => [ 'description' => '视频的裁剪模式。取值：'."\n" ."\n\n" .'- **1**：保持比例裁剪。'."\n" ."\n" .'- **2**（默认值）：保持比例留边。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'MediaEncode', 'in' => 'query', 'schema' => [ 'description' => '编码选项，请参见下文中的MediaEncode枚举值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'MixMode', 'in' => 'query', 'schema' => [ 'description' => '混流模式。取值：'."\n" ."\n" .'- **0**：单路转推，不混流转码，仅转推原始单路流，无需配置混流转码参数。'."\n" .'- **1**：混流转码（默认值），支持混流转码输出。'."\n" ."\n" .'> - 单路转推模式下有效参数：**StreamType**、**SourceType**。'."\n" .'- 混流转码模式下有效参数：**MediaEncode**、**LayoutIds**、**BackgroundColor**、**SubSpecUsers**、**CropMode**、**UserPanes**、**Backgrounds**、**Watermarks**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => [ 'description' => '单路转推模式下用户视频输入流。取值：'."\n" ."\n" .'- **camera**：摄像头。'."\n" .'- **shareScreen**：屏幕共享。'."\n", 'type' => 'string', 'required' => false, 'example' => 'camera', ], ], [ 'name' => 'StreamType', 'in' => 'query', 'schema' => [ 'description' => '单路转推模式下转推音频流。取值：'."\n" ."\n" .'- **0**（默认值）：转推原始流。'."\n" .'- **1**：仅转推音频流。'."\n" .'- **2**：仅转推视频流。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'BackgroundColor', 'in' => 'query', 'schema' => [ 'description' => '背景色RGB，默认是**0**（黑色）。'."\n" ."\n" .'计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：**0**~**255**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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":"\\n 760bad53276431c499e30dc36f6b26be\\n","errorExample":""}]', 'title' => '更新旁路转推任务', 'summary' => '调用UpdateMPUTask更新旁路转推任务。', 'description' => '# 使用说明'."\n" ."\n" .'- 调用本接口前，您必须已经调用[StartMpuTask](~~93183~~)开始旁路转推任务。'."\n" .'- 本接口需要在任务运行正常时调用，任务未开始、已结束或异常状态调用都无效。您可以调用[GetMPUTaskStatus](~~93181~~)获取任务运行状态。'."\n" ."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为4000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => '**MediaEncode**枚举值如下所示。'."\n" ."\n" .'| ID | 宽 | 高 | 码流（kps） | 帧率（fps） '."\n" .'| ----------- | ----- | ------ | ----------- | --- '."\n" .'| 0 | 0 | 0 | 64 | 0 '."\n" .'| 1 | 640 | 360 | 500 | 15 '."\n" .'| 54 | 360 | 640 | 500 | 30 '."\n" .'| 53 | 360 | 640 | 500 | 15 '."\n" .'| 52 | 640 | 360 | 500 | 30 '."\n" .'| 10 | 960 | 540 | 700 | 24 '."\n" .'| 20 | 1280 | 720 | 1024 | 25 '."\n" .'| 22 | 720 | 1280 | 1024 | 30 '."\n" .'| 23 | 800 | 600 | 1024 | 30 '."\n" .'| 30 | 1920 | 1080 | 2048 | 30 '."\n" .'| 31 | 1080 | 1920 | 2048 | 30 '."\n" .'| 24 | 750 | 780 | 1024 | 30 '."\n" .'| 25 | 750 | 540 | 700 | 30 '."\n" .'| 26 | 720 | 1280 | 2048 | 30 '."\n" .'| 27 | 1280 | 720 | 2048 | 30 '."\n" .'| 28 | 1280 | 720 | 3096 | 30 '."\n" .'| 32 | 1024 | 768 | 1024 | 24 '."\n" .'| 33 | 1280 | 960 | 1024 | 24 '."\n" .'| 34 | 1024 | 768 | 2048 | 24 '."\n" .'| 35 | 1280 | 960 | 2048 | 24 '."\n" .'| 36 | 1280 | 720 | 1024 | 24 '."\n" .'| 37 | 1280 | 720 | 2048 | 24 '."\n" .'| 38 | 540 | 960 | 750 | 15 '."\n" .'| 39 | 540 | 960 | 1500 | 30 '."\n" .'| 40 | 1280 | 720 | 1200 | 15 '."\n" .'| 41 | 720 | 1280 | 1200 | 15 '."\n" .'| 42 | 720 | 1280 | 1500 | 15 '."\n" .'| 43 | 540 | 960 | 1200 | 15 '."\n" ."\n" .'> 当用户使用纯音频直播的时候需要注意的问题，然后直接跳转常见问题中的[纯音频直播](https://helpcdn.aliyun.com/document_detail/159390.html?spm=a2c4g.11174283.6.729.445a3c3d4LDYq5)。'."\n", ], 'GetMPUTaskStatus' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID，仅支持传单个ID，和[StartMpuTask](~~93183~~)入参TaskId一致。', 'type' => 'string', 'required' => true, 'example' => 'yourTaskId', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '旁路转推任务的状态ID。'."\n" .' - **0**：等待Channel开始。'."\n" .'> 30天内没有启动任务，任务将自动停止。'."\n" ."\n" .' - **1**：任务运行中 。'."\n" ."\n" .' - **2**：任务已停止 。'."\n" ."\n" .' - **3**：用户停止任务。'."\n" ."\n" .' - **4**：Channel已停止。'."\n" ."\n" .' - **5**：CDN网络问题，直播停止。'."\n" ."\n" .' - **6**：直播URL问题，直播停止。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RequestId' => [ 'description' => '请求ID。', '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":"\\n\\t760bad53276431c499e30dc36f6b26be\\n\\t0\\n\\n\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\", \\n \\"Status\\":0\\n} "}]', 'title' => '获取任务状态', 'summary' => '调用GetMPUTaskStatus获取旁路转推任务状态。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[StartMpuTask](~~93183~~)开始旁路转推任务。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为4000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', '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' => '指定主窗格，每个布局只能有一个主窗格。'."\n" ."\n" .'- **0**：副窗格。'."\n" .' '."\n" .'- **1**：主窗格。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Width' => [ 'description' => '窗格宽，归一化百分比。Width取值范围：**0.0 'number', 'format' => 'float', 'required' => false, 'example' => '0.25', ], 'Height' => [ 'description' => '窗格高，归一化百分比。Height取值范围：**0.0 'number', 'format' => 'float', 'required' => false, 'example' => '0.25', ], 'Y' => [ 'description' => '坐标Y，归一化百分比。坐标Y取值范围：**0.0≤Y≤1.0**。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.25', ], 'PaneId' => [ 'description' => '布局ID，从左上到右下排序，从0开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。坐标X取值范围：**0.0≤X≤1.0**。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.25', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 16, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，仅支持传单个ID。'."\n" .'您可以在控制台创建和查询。', 'type' => 'string', 'required' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '布局名称。', 'type' => 'string', 'required' => false, 'example' => 'LayoutName', ], ], [ 'name' => 'AudioMixCount', 'in' => 'query', 'schema' => [ 'description' => '最大混音个数。取值范围：**0**~**6**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'LayoutId' => [ 'description' => '布局ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'RequestId' => [ 'description' => '请求ID。', '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":"\\n760bad53276431c499e30dc36f6b26be\\n2\\n\\n","errorExample":""}]', 'title' => '创建旁路直播布局', 'summary' => '调用CreateMPULayout创建旁路直播布局。', 'description' => '# 使用说明'."\n" .'本接口用于创建旁路直播布局。例如：您可以配置混音个数、主窗格等参数。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' > N从1开始取值。', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteMPULayout' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID。仅支持传单个ID，您可以在控制台创建和查询。', 'type' => 'string', 'required' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'LayoutId', 'in' => 'query', 'schema' => [ 'description' => '布局ID。仅支持传单个ID，获取布局ID，请参见[CreateMPULayout](~~162192~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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":"\\r\\n760bad53276431c499e30dc36f6b26be\\r\\n\\r\\n","errorExample":""}]', 'title' => '删除旁路直播布局', 'summary' => '调用DeleteMPULayout删除旁路直播布局。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[CreateMPULayout](~~162192~~)创建旁路直播布局。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', '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' => '指定主窗格，每个布局只能有一个主窗格。'."\n" ."\n" .'- **0**：副窗格。'."\n" .' '."\n" .'- **1**：主窗格。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Width' => [ 'description' => '窗格宽，归一化百分比。Width取值范围：**0.0 'number', 'format' => 'float', 'required' => false, 'example' => '0.2456', ], 'Height' => [ 'description' => '窗格高，归一化百分比。Height取值范围：**0.0 'number', 'format' => 'float', 'required' => false, 'example' => '0.2456', ], 'Y' => [ 'description' => '坐标Y，归一化百分比。坐标Y取值范围：**0.0≤Y≤1.0**。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], 'PaneId' => [ 'description' => '布局窗口ID。从左上到右下排序，从0开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'ZOrder' => [ 'description' => '叠放顺序。0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'X' => [ 'description' => '坐标，归一化百分比。坐标X取值范围：**0.0≤X≤1.0**。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7576', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 16, ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，仅支持传单个ID。'."\n" ."\n" .'您可以在控制台创建和查询。', 'type' => 'string', 'required' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '布局名称。', 'type' => 'string', 'required' => false, 'example' => 'LayoutName', ], ], [ 'name' => 'LayoutId', 'in' => 'query', 'schema' => [ 'description' => '布局ID。获取布局ID，请参见[CreateMPULayout](~~162192~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10117', ], ], [ 'name' => 'AudioMixCount', 'in' => 'query', 'schema' => [ 'description' => '最大混音个数。取值范围：**0**~**6**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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":"\\r\\n760bad53276431c499e30dc36f6b26be\\r\\n","errorExample":""}]', 'title' => '修改旁路直播布局', 'summary' => '调用ModifyMPULayout修改旁路直播布局。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[CreateMPULayout](~~162192~~)创建旁路直播布局。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeMPULayoutInfoList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID。仅支持传单个ID，您可以在控制台创建和查询。', 'type' => 'string', 'required' => true, 'example' => 'yourAppId', ], ], [ 'name' => 'LayoutId', 'in' => 'query', 'schema' => [ 'description' => '布局ID。获取布局ID，请参见[CreateMPULayout](~~162192~~).', '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' => '页码，默认为**1**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页显示数量，默认为**10**。', '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' => '请求ID。', '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' => '布局ID。', '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' => '指定主窗格，每个布局只能有一个主窗格。'."\n" .'- **0**：副窗格。'."\n" .'- **1**：主窗格。', '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' => '坐标Y，归一化百分比。', 'type' => 'number', 'format' => 'float', 'example' => '0.5', ], 'PaneId' => [ 'description' => '窗格ID，从左上到右下排序，从0开始。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ZOrder' => [ 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'X' => [ 'description' => '坐标X，归一化百分比。', '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":"\\n1\\n1\\n760bad53276431c499e30dc36f6b26be\\n\\n 3\\n 2\\n LayoutName\\n \\n 0\\n 0\\n 0.5\\n 0.5\\n 0.5\\n 0.5\\n 0\\n \\n\\n","errorExample":""}]', 'title' => '获取旁路直播任务布局参数', 'summary' => '调用DescribeMPULayoutInfoList获取旁路直播任务布局参数。', 'description' => '# 使用说明'."\n" .'调用本接口前，您必须已经调用[CreateMPULayout](~~162192~~)创建旁路直播布局。'."\n" .'# QPS限制'."\n" .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~341645~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRtcDurationData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '查询数据起始时间，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2020-02-04T05:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '查询数据结束时间，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" ."\n" .'结束时间需大于起始时间。', 'type' => 'string', 'required' => false, 'example' => '2020-02-04T07:00:00Z', ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，仅支持传单个ID。'."\n" ."\n" .'默认查询所有应用ID。'."\n" .' ', 'type' => 'string', 'required' => false, 'example' => 'yourAppId', ], ], [ 'name' => 'ServiceArea', 'in' => 'query', 'schema' => [ 'description' => '服务区域，CN：中国（默认值）。', 'type' => 'string', 'required' => false, 'example' => 'CN', ], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => '查询数据的时间粒度，单位：秒。'."\n" ."\n" .'取值为**3600**（1小时）或**86400**（1天），默认为**3600**。'."\n" .' ', 'type' => 'string', 'required' => false, 'example' => '3600', 'enum' => [ '86400', '3600', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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' => '高清通信时长，视频分辨率为1280X720及以下，单位：分钟。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'V360Duration' => [ 'description' => '标清通信时长，视频分辨率为640X480及以下，单位：分钟。', 'type' => 'integer', 'format' => 'int64', 'example' => '300', ], 'AudioDuration' => [ 'description' => '纯音频通信时长，单位：分钟。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'TimeStamp' => [ 'description' => '时间戳，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n", 'type' => 'string', 'example' => '2020-02-04T05:00:00Z', ], 'V1080Duration' => [ 'description' => '全高清通信时长，视频分辨率为1920X1080及以下，单位：分钟。', '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":"\\n8D49CBEB-84E5-4847-AD5E-1EE4B235034E\\n\\n \\n 0\\n 0\\n 0\\n 0\\n 2020-02-04T05:00:00Z\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 2020-02-04T06:00:00Z\\n 0\\n 0\\n \\n\\n\\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' => '获取按照音视频规格进行统计累计通信时长', 'summary' => '获取应用在一段时间内按照音视频规格进行统计的累计通信时长。', 'description' => '> 数据查询的起止时间跨度最大为30天。'."\n" .' '."\n" .' '."\n" .' '."\n" .' ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRtcUserCntData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '查询数据起始时间，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2018-01-29T00:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '查询数据结束时间，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" ."\n" .'结束时间需大于起始时间。', 'type' => 'string', 'required' => false, 'example' => '2018-01-29T01:00:00Z', ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，仅支持传单个ID。'."\n" ."\n" .'默认查询所有应用ID。'."\n" .' ', 'type' => 'string', 'required' => false, 'example' => 'yourAppId', ], ], [ 'name' => 'ServiceArea', 'in' => 'query', 'schema' => [ 'description' => '服务区域。CN：中国（默认值）。', 'type' => 'string', 'required' => false, 'example' => 'CN', ], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => '查询数据时间粒度，单位：秒。'."\n" ."\n" .'取值为**3600**（1小时） 或**86400**（1天），默认为**3600**。'."\n" .' ', 'type' => 'string', 'required' => false, 'example' => '3600', 'enum' => [ '86400', '3600', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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' => '时间戳，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。', '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":"\\n16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\n\\n \\n 2018-01-29T00:00:00Z\\n 10\\n \\n\\n","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' => '查询应用活跃用户数', 'summary' => '查询应用在一段时间内的活跃用户数，即发生通信的用户终端数。', 'description' => '> 数据查询的起止时间跨度最大为30天。'."\n" .' '."\n" .' '."\n" .' '."\n" .' ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRtcPeakChannelCntData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '查询数据起始时间，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2018-01-29T00:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '查询数据结束时间，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" ."\n" .'结束时间需大于起始时间。', 'type' => 'string', 'required' => false, 'example' => '2018-01-29T00:00:00Z', ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，仅支持传单个ID。'."\n" ."\n" .'默认查询所有应用ID。'."\n" .' ', 'type' => 'string', 'required' => false, 'example' => 'yourAppId', ], ], [ 'name' => 'ServiceArea', 'in' => 'query', 'schema' => [ 'description' => '服务区域。CN：中国（默认值）。', 'type' => 'string', 'required' => false, 'example' => 'CN', ], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => '查询数据的时间粒度，单位：秒。'."\n" ."\n" .'取值为**3600**（1小时） 或**86400**（1天），默认为**3600**。'."\n" .' ', 'type' => 'string', 'required' => false, 'example' => '3600', 'enum' => [ '86400', '3600', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', ], 'PeakChannelCntDataPerInterval' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PeakChannelCntModule' => [ 'description' => '并发频道峰值数据结构。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ActiveChannelPeakTime' => [ 'description' => '峰值时刻，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2018-01-29T00:01:00Z', ], 'TimeStamp' => [ 'description' => '时间戳，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。', '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":"\\n\\t16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\n\\t\\n\\t\\t2018-01-29T00:00:00Z\\n\\t\\t10\\n\\t\\t2018-01-29T00:01:00Z\\n\\t\\n\\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' => '查询应用并发频道峰值数量', 'summary' => '查询应用在指定时间内的并发频道峰值数量。', 'description' => '> 数据查询的起止时间跨度最大为30天。'."\n" .' '."\n" .' '."\n" .' '."\n" .' ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRtcChannelList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，可通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => false, 'example' => 'aoe****', ], ], [ 'name' => 'TimePoint', 'in' => 'query', 'schema' => [ 'description' => '查询时间点，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" ."\n" .'时间粒度为天。', 'type' => 'string', 'required' => true, 'example' => '2018-01-29T00:00:00Z', ], ], [ 'name' => 'SortType', 'in' => 'query', 'schema' => [ 'description' => '排序顺序，默认按StartTime逆序排序。', 'type' => 'string', 'required' => false, 'example' => 'desc', 'enum' => [ 'sortByStartTime', 'sortByStartTimeDesc', 'sortByEndTime', 'sortByEndTimeDesc', ], ], ], [ 'name' => 'ServiceArea', 'in' => 'query', 'schema' => [ 'description' => '服务区域，默认查询所有区域。'."\n" ."\n" .'- **cn**：中国。'."\n" ."\n" .'- **us**：美国。'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '用户ID，仅支持传单个ID。', 'type' => 'string', 'required' => false, 'example' => 'testUser', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => false, 'example' => 'testChannel', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'description' => '第几页，取值：大于**0**。'."\n" ."\n" .'默认为1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '显示数量，取值：大于**0**。'."\n" ."\n" .'默认为10。', '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' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', ], 'PageSize' => [ 'description' => '显示数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'ChannelList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ChannelList' => [ 'description' => '通信记录。'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ChannelId' => [ 'description' => '频道ID。', 'type' => 'string', 'example' => 'testChannel', ], 'EndTime' => [ 'description' => '会话结束时间，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2018-01-29T02:00:00Z', ], 'TotalUserCnt' => [ 'description' => '累计用户数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'StartTime' => [ 'description' => '会话起始时间，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2018-01-29T01:00:00Z', ], 'CallArea' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CallArea' => [ 'type' => 'array', 'items' => [ 'description' => '通信区域。取值：'."\n" ."\n" .'- **cn**：中国。'."\n" ."\n" .'- **us**：美国。', '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":"\\n1\\n68F57D4C-557B-44FB-A0B7-D002E153555E\\n24\\n1\\n\\n \\n 2\\n 2020-04-14T13:09:00+08:00\\n 2020-04-14T13:08:00+08:00\\n testChannel\\n \\n cn\\n \\n \\n\\n","errorExample":""}]', 'title' => '获取频道通信记录列表', 'summary' => '调用DescribeRtcChannelList获取频道通信记录列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRtcChannelMetric' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'TimePoint', 'in' => 'query', 'schema' => [ 'description' => '查询记录时间，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" ."\n" .'时间粒度为天。', 'type' => 'string', 'required' => true, 'example' => '2018-01-29T00:00:00Z', ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，可通过控制台创建和查询，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'aoe****', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '频道ID，仅支持传单个ID。', 'type' => 'string', 'required' => true, 'example' => 'testId', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', ], 'ChannelMetricInfo' => [ 'description' => '详细信息。', 'type' => 'object', 'properties' => [ 'ChannelMetric' => [ 'description' => '频道用户信息。', 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => '用户离开频道时间，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2019-06-06T18:57:00Z', ], 'StartTime' => [ 'description' => '用户加入频道时间，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n", 'type' => 'string', 'example' => '2019-06-06T17:57:00Z', ], 'SubUserCount' => [ 'description' => '曾经进入频道并且成功订阅的用户数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '25', ], 'ChannelId' => [ 'description' => '频道ID。', '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' => '标清视频时长，单位：分钟。'."\n", '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' => '标清视频时长，单位：分钟。'."\n", '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":"\\nF7748E0F-1FC6-4410-9799-19757EF3C837\\n\\n \\n 2020-04-14T14:04:00+08:00\\n 2\\n 2020-04-14T14:04:00+08:00\\n 2\\n example_channel\\n 2\\n \\n \\n \\n 2\\n 0\\n 0\\n 0\\n \\n \\n \\n 2\\n 0\\n 0\\n 0\\n \\n \\n \\n\\n\\n","errorExample":""}]', 'title' => '获取频道通信记录详情', 'summary' => '获取频道通信记录详情，支持查询近180天内的数据。', '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', ], ], ];