From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/zh_cn/lingmou/2025-05-27/api-docs.php | 3514 ++++++++++++++++++++++++++++ 1 file changed, 3514 insertions(+) create mode 100644 data/zh_cn/lingmou/2025-05-27/api-docs.php (limited to 'data/zh_cn/lingmou/2025-05-27') diff --git a/data/zh_cn/lingmou/2025-05-27/api-docs.php b/data/zh_cn/lingmou/2025-05-27/api-docs.php new file mode 100644 index 0000000..b4928fa --- /dev/null +++ b/data/zh_cn/lingmou/2025-05-27/api-docs.php @@ -0,0 +1,3514 @@ + '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'LingMou', + 'version' => '2025-05-27', + ], + 'directories' => [ + [ + 'id' => 341630, + 'title' => '数字人播报', + 'type' => 'directory', + 'children' => [ + 'CreateBroadcastSticker', + 'ListBroadcastTemplates', + 'GetBroadcastTemplate', + 'CreateBroadcastVideoFromTemplate', + 'ListBroadcastVideosById', + 'CreateBroadcastAudio', + 'ListBroadcastAudiosById', + ], + ], + [ + 'id' => 313383, + 'title' => '数字人资产合成与管理', + 'type' => 'directory', + 'children' => [ + 'GetUploadPolicy', + [ + 'id' => 341636, + 'title' => '音色', + 'type' => 'directory', + 'children' => [ + 'CreateTTSVoiceCustom', + 'GetTTSVoiceByIdCustom', + 'ListPrivateTTSVoicesCustom', + ], + ], + [ + 'id' => 341639, + 'title' => '图片数字人', + 'type' => 'directory', + 'children' => [ + 'ListTemplateMaterial', + 'CreateTrainPicAvatar', + 'ConfirmTrainPicAvatar', + 'GetTrainPicAvatarStatus', + ], + ], + [ + 'id' => 341626, + 'title' => '对话背景图', + 'type' => 'directory', + 'children' => [ + 'CreateBackgroundPic', + ], + ], + [ + 'id' => 341627, + 'title' => '图片免训数字人', + 'type' => 'directory', + 'children' => [ + 'CreateNoTrainPicAvatar', + ], + ], + ], + ], + [ + 'id' => 313384, + 'title' => '数字人对话', + 'type' => 'directory', + 'children' => [ + 'CreateChatConfig', + 'CreateChatSession', + 'CloseChatInstanceSessions', + 'QueryChatInstanceSessions', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'BroadcastAudio' => [ + 'description' => '播报音频', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '音频ID。', + 'type' => 'string', + 'example' => 'M1Ju6XhHog_e-lSeb80Slp9g', + ], + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2026-01-22T01:59:03', + ], + 'modifiedTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2026-01-22T01:59:03', + ], + 'name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => '播报音频', + ], + 'status' => [ + 'description' => '音频状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'SUCCESS' => '检测成功', + 'PROCESSING' => '检测中', + 'ERROR' => '检测失败', + ], + 'example' => 'SUCCESS', + ], + 'audioLength' => [ + 'description' => '音频时长。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'BroadcastTemplate' => [ + 'description' => '播报模板。', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-11-28T10:11:28', + ], + 'modifiedTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2025-11-28T11:11:28', + ], + 'name' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => '测试播报模板', + ], + 'id' => [ + 'description' => '模板id。', + 'type' => 'string', + 'example' => 'BS1b2WNnRMu4ouRzT4clY9Jhg', + ], + 'variables' => [ + 'description' => '可替换的动态变量列表。', + 'type' => 'array', + 'items' => [ + 'description' => '动态变量。', + '$ref' => '#/components/schemas/TemplateVariable', + ], + ], + ], + ], + 'BroadcastVideo' => [ + 'description' => '播报视频。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'example' => 'M1k3So6n9IlrDV69sr3jDa3g', + ], + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-11-28T13:40:33', + ], + 'modifiedTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2025-11-28T13:41:31', + ], + 'name' => [ + 'description' => '视频名称。', + 'type' => 'string', + 'example' => '播报视频合成测试', + ], + 'status' => [ + 'description' => '视频状态。'."\n" + ."\n" + .'- PROCESSING：合成中。'."\n" + .'- SUCCESS：合成成功。'."\n" + .'- ERROR：合成失败。', + 'type' => 'string', + 'enumValueTitles' => [ + 'SUCCESS' => 'SUCCESS', + 'PROCESSING' => 'PROCESSING', + 'ERROR' => 'ERROR', + ], + 'example' => 'SUCCESS', + ], + 'coverURL' => [ + 'description' => '封面图URL。', + 'type' => 'string', + 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/cover.jpg', + ], + 'videoURL' => [ + 'description' => '视频URL。', + 'type' => 'string', + 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/result.mp4', + ], + 'captionURL' => [ + 'description' => '字幕文件URL。', + 'type' => 'string', + 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/result.srt', + ], + 'alignmentFileURL' => [ + 'description' => '字幕对齐文件URL。', + 'type' => 'string', + 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/alignment.json', + ], + ], + ], + 'ChatSessionInfo' => [ + 'description' => '灵眸数字人会话session信息。', + 'type' => 'object', + 'properties' => [ + 'sessionId' => [ + 'description' => '会话id', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'mainAccountId' => [ + 'description' => '主账号id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567', + ], + 'createdAt' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1755680969', + ], + ], + ], + 'TemplateVariable' => [ + 'description' => '播播模板动态变量。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '变量名。', + 'type' => 'string', + 'example' => 'test', + ], + 'type' => [ + 'description' => '变量类型。'."\n" + ."\n" + .'- text：文本'."\n" + .'- image：图片'."\n" + .'- avatar：数字人'."\n" + .'- voice：音色', + 'type' => 'string', + 'enumValueTitles' => [ + 'voice' => 'voice', + 'image' => 'image', + 'text' => 'text', + 'avatar' => 'avatar', + ], + 'example' => 'text', + ], + 'properties' => [ + 'description' => '变量属性（JSON结构体），根据类型区分。'."\n" + ."\n" + .'> - 文本变量：包含`content`字段。'."\n" + .'> - 图像变量：包含`resourceId`和`fit`字段。'."\n" + .'> - 数字人变量：包含`resourceId`字段。'."\n" + .'> - 音色变量：包含`resourceId`字段。', + 'type' => 'any', + 'example' => '{'."\n" + .' "content": "待替换内容"'."\n" + .'}', + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateBroadcastSticker' => [ + 'summary' => '创建播报贴图。', + 'path' => '/openapi/customer/broadcast/material/sticker/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarYF4CD3', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'ossKey' => [ + 'description' => 'oss文件目录。', + 'type' => 'string', + 'required' => false, + 'example' => 'material/INPUT_BROADCAST_STICKER/Mt.CPRLVQRR27YU2', + ], + 'fileName' => [ + 'description' => '文件名。', + 'type' => 'string', + 'required' => false, + 'example' => 'sticker.png', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result', + 'description' => 'Result', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '播报贴图。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '加密后ID，防止遍历', + 'description' => '贴图id。', + 'type' => 'string', + 'example' => 'M1lhKArheOyYdeYybDFqS1-Q', + ], + ], + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => 'http响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"id\\": \\"M1lhKArheOyYdeYybDFqS1-Q\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '创建播报贴图', + ], + 'ListBroadcastTemplates' => [ + 'summary' => '列举播报模板。', + 'path' => '/openapi/customer/broadcast/template/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarYF4CD3', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '页数，从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页Token值，无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => 'BS1b2WNnRMu4ouRzT4clY9Jhg', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '最大返回结果数，无需关注。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'ListResult', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '播报模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '播报模板。', + '$ref' => '#/components/schemas/BroadcastTemplate', + ], + ], + 'nextToken' => [ + 'description' => '分页Token值，无需关注。', + 'type' => 'string', + 'example' => 'BS1b2WNnRMu4ouRzT4clY9Jhk', + ], + 'maxResults' => [ + 'description' => '最大返回结果数，无需关注。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'page' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'size' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => 'http响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"createTime\\": \\"\\",\\n \\"modifiedTime\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"variables\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"properties\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"nextToken\\": \\"BS1b2WNnRMu4ouRzT4clY9Jhk\\",\\n \\"maxResults\\": 20,\\n \\"page\\": 1,\\n \\"size\\": 20,\\n \\"success\\": true,\\n \\"code\\": \\"SUCCESS\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '列举播报模板', + ], + 'GetBroadcastTemplate' => [ + 'summary' => '查询播报模板详情。', + 'path' => '/openapi/customer/broadcast/template/detail', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarYF4CD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'templateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模版ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'BS1b2WNnRMu4ouRzT4clY9Jhg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result', + 'description' => 'Result', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '播报模板。', + '$ref' => '#/components/schemas/BroadcastTemplate', + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => 'http响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"createTime\\": \\"\\",\\n \\"modifiedTime\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"variables\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"properties\\": \\"\\"\\n }\\n ]\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询播报模板详情', + ], + 'CreateBroadcastVideoFromTemplate' => [ + 'summary' => '基于播报模板合成视频。', + 'path' => '/api/v1/amp/customer/broadcast/video/createFromTemplate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarYF4CD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'templateId' => [ + 'description' => '播报模板Id。'."\n" + ."\n" + .'- 调用[列举播报模板接口](https://help.aliyun.com/zh/avatar/avatar-application/developer-reference/api-lingmou-2025-05-27-listbroadcasttemplates)获取id参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'BS1b2WNnRMu4ouRzT4clY9Jhg', + ], + 'name' => [ + 'description' => '视频名称。', + 'type' => 'string', + 'required' => false, + 'example' => '播报视频合成测试', + ], + 'videoOptions' => [ + 'description' => '视频输出选项。', + 'type' => 'object', + 'properties' => [ + 'resolution' => [ + 'description' => '分辨率，默认`720p`。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '1080p' => '1080p', + '720p' => '720p', + ], + 'example' => '720p', + ], + 'fps' => [ + 'description' => '帧率，默认`30`fps。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + 15 => '15', + 30 => '30', + ], + 'example' => '30', + ], + 'watermark' => [ + 'description' => '是否带水印，默认`True`。'."\n" + ."\n" + .'- True：是'."\n" + .'- False：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + 'required' => false, + ], + 'variables' => [ + 'description' => '播报模板中的动态变量列表，可以用于替换图片对象、文本对象、数字人id（全局）、音色id（全局）。', + 'type' => 'array', + 'items' => [ + 'description' => '播报模板动态变量。', + 'required' => false, + '$ref' => '#/components/schemas/TemplateVariable', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result', + 'description' => 'Result', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '播报视频。', + 'example' => '{"sessionId": "20250311-41523E3C-1D27-5844-8EEF-194E4714096B", "mainAccountId": 1234567, "createdAt": 1755680457}', + '$ref' => '#/components/schemas/BroadcastVideo', + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0EC3BA89-13F5-5766-A0BA-85096092A032', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => 'http响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"id\\": \\"\\",\\n \\"createTime\\": \\"\\",\\n \\"modifiedTime\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"coverURL\\": \\"\\",\\n \\"videoURL\\": \\"\\",\\n \\"captionURL\\": \\"\\",\\n \\"alignmentFileURL\\": \\"\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"SUCCESS\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"0EC3BA89-13F5-5766-A0BA-85096092A032\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '基于模版创建播报视频', + 'description' => '查询指定实例下的活跃会话信息。', + ], + 'ListBroadcastVideosById' => [ + 'summary' => '根据id列表批量查询播报视频。当您新提交任务后，建议您参照文字对应的音频时间长度，至少等待6倍时间后进行查询视频合成结果。', + 'path' => '/api/v1/amp/customer/broadcast/video/batchQuery', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarYF4CD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'videoIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '视频id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '视频ID', + 'type' => 'string', + 'required' => false, + 'example' => 'M1k3So6n9IlrDV69sr3jDa3g', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result>', + 'description' => 'Result>', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '响应数据。', + 'type' => 'array', + 'items' => [ + 'description' => '播报视频。', + '$ref' => '#/components/schemas/BroadcastVideo', + ], + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => 'http响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"id\\": \\"\\",\\n \\"createTime\\": \\"\\",\\n \\"modifiedTime\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"coverURL\\": \\"\\",\\n \\"videoURL\\": \\"\\",\\n \\"captionURL\\": \\"\\",\\n \\"alignmentFileURL\\": \\"\\"\\n }\\n ],\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '根据id列表批量查询播报视频', + 'responseParamsDescription' => '除特殊说明外，返回参数中文件URL有效加签时间均为8小时', + ], + 'CreateBroadcastAudio' => [ + 'summary' => '创建播报音频。', + 'path' => '/openapi/customer/broadcast/material/audio/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarYF4CD3', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'ossKey' => [ + 'description' => 'oss文件目录。', + 'type' => 'string', + 'required' => false, + 'example' => 'material/INPUT_BROADCAST_INFER_AUDIO/Mt.CPRLVQRR27YU2', + ], + 'fileName' => [ + 'description' => '文件名。', + 'type' => 'string', + 'required' => false, + 'example' => 'audio.mp3', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result', + 'description' => 'Result', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '播报音频。', + '$ref' => '#/components/schemas/BroadcastAudio', + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '用来封装当前请求处理的结果是成功还是失败', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '结果码', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '请求处理失败时返回的错误消息', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90C68329-A75C-5449-A928-4D0BAD7AA0FA', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => '返回的httpStatusCode', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"id\\": \\"\\",\\n \\"createTime\\": \\"\\",\\n \\"modifiedTime\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"audioLength\\": 0\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"90C68329-A75C-5449-A928-4D0BAD7AA0FA\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '创建播报音频', + ], + 'ListBroadcastAudiosById' => [ + 'summary' => '根据id列表批量查询播报音频。', + 'path' => '/openapi/customer/broadcast/material/audio/batchQuery', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarYF4CD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'audioIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '音频 id 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '音频id', + 'type' => 'string', + 'required' => false, + 'example' => 'M1k3So6n9IlrDV69sr3jDa3g', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result>', + 'description' => 'Result>', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '响应数据。', + 'type' => 'array', + 'items' => [ + 'description' => '播报音频。', + '$ref' => '#/components/schemas/BroadcastAudio', + ], + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '用来封装当前请求处理的结果是成功还是失败', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '结果码', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '请求处理失败时返回的错误消息', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0EC3BA89-13F5-5766-A0BA-85096092A032', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => '返回的httpStatusCode', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"id\\": \\"\\",\\n \\"createTime\\": \\"\\",\\n \\"modifiedTime\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"audioLength\\": 0\\n }\\n ],\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"0EC3BA89-13F5-5766-A0BA-85096092A032\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '根据id列表批量查询播报音频', + ], + 'GetUploadPolicy' => [ + 'summary' => '获取对话免训图片素材上传凭证。', + 'path' => '/openapi/chat/getUploadPolicy', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，必传。'."\n" + .'当前支持类型：'."\n" + .'- INPUT_CHAT_BACKGROUND_PIC，配合CreateBackgroundPic'."\n" + .'- INPUT_INFER_PIC，配合创建CreateNoTrainPicAvatar'."\n" + .'- INPUT_TRAIN_PIC，配合创建CreateTrainPicAvatar'."\n" + .'- INPUT_TRAIN_AUDIO 配合创建CreateTTSVoiceCustom '."\n" + .'- INPUT_BROADCAST_STICKER 配合创建CreateBroadcastSticker'."\n" + ."\n" + .'更多类型待更新。', + 'type' => 'string', + 'required' => false, + 'example' => 'INPUT_CHAT_BACKGROUND_PIC', + ], + ], + [ + 'name' => 'jwtToken', + 'in' => 'query', + 'schema' => [ + 'title' => '包含额外登录认证信息JWT', + 'description' => '包含额外登录认证信息JWT，已废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'Token', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'ossKey' => [ + 'description' => 'oss文件key。', + 'type' => 'string', + 'example' => 'material/INPUT_CHAT_BACKGROUND_PIC/Mt.CPQHBSWQS5QU2', + ], + 'ossPolicy' => [ + 'description' => 'OSS凭据数据。', + 'type' => 'object', + 'properties' => [ + 'accessId' => [ + 'description' => 'accessId。', + 'type' => 'string', + 'example' => 'LTBI5123ADDJdsadCidYA8kw3', + ], + 'dir' => [ + 'description' => '目录。', + 'type' => 'string', + 'example' => 'material/INPUT_CHAT_BACKGROUND_PIC/Mt.CPQHBSWQS5QU2/', + ], + 'expire' => [ + 'description' => '过期时间。', + 'type' => 'string', + 'example' => '1761551667', + ], + 'host' => [ + 'description' => '主机。', + 'type' => 'string', + 'example' => 'daily-avatar-property.oss-cn-beijing.aliyuncs.com', + ], + 'policy' => [ + 'description' => '凭证票据。', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMi0yNVQwMzowMDoyNC4xNDNaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTM2ODcwOTEyMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJ0ZW1wXC8xNzQwNDQ4ODI0MTQxLnppcCJdXX0=', + ], + 'signature' => [ + 'description' => '对policy的签名信息。', + 'type' => 'string', + 'example' => 'I2KcV3CFloyRr94WhefmVEuNiv0=', + ], + ], + ], + ], + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '响应码。', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90C68329-A75C-5449-A928-4D0BAD7AA0FA', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => 'http响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"ossKey\\": \\"material/INPUT_CHAT_BACKGROUND_PIC/Mt.CPQHBSWQS5QU2\\",\\n \\"ossPolicy\\": {\\n \\"accessId\\": \\"LTBI5123ADDJdsadCidYA8kw3\\",\\n \\"dir\\": \\"material/INPUT_CHAT_BACKGROUND_PIC/Mt.CPQHBSWQS5QU2/\\",\\n \\"expire\\": \\"1761551667\\",\\n \\"host\\": \\"daily-avatar-property.oss-cn-beijing.aliyuncs.com\\",\\n \\"policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNS0wMi0yNVQwMzowMDoyNC4xNDNaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTM2ODcwOTEyMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJ0ZW1wXC8xNzQwNDQ4ODI0MTQxLnppcCJdXX0=\\",\\n \\"signature\\": \\"I2KcV3CFloyRr94WhefmVEuNiv0=\\"\\n }\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"90C68329-A75C-5449-A928-4D0BAD7AA0FA\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取上传凭证', + 'responseParamsDescription' => '凭证有效期4小时', + ], + 'CreateTTSVoiceCustom' => [ + 'summary' => '创建TTS音色', + 'path' => '/openapi/voice/createTTSVoiceCustom', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '音色名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestTTSVoiceName', + ], + ], + [ + 'name' => 'gender', + 'in' => 'query', + 'schema' => [ + 'description' => '性别（非必填）。'."\n" + .'- FEMALE'."\n" + .'- MALE', + 'type' => 'string', + 'required' => false, + 'example' => 'FEMALE', + ], + ], + [ + 'name' => 'ossKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'oss文件key。', + 'type' => 'string', + 'required' => true, + 'example' => 'material/INPUT_TRAIN_AUDIO/Mt.CN2VNOPRC5QU2', + ], + ], + [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => [ + 'description' => '文件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestTTSVoiceName.mp3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result', + 'description' => 'Result', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'audioURL' => [ + 'description' => '音频文件地址。', + 'type' => 'string', + 'example' => 'https://xxx-aliyuncs.com/material/INPUT_TRAIN_AUDIO/Mt.CQEG75L4FWIU2/TestTTSVoiceName.mp3?Expires=1764262805&OSSAccessKeyId=LTAI5tK3WcKwKtAyaTSe*****&Signature=D%2Fld6gp9Zh6TsGRU9cd6GD2pFY0%3D', + ], + 'censorStatus' => [ + 'description' => '审核状态。状态枚举值：'."\n" + .'- INIT'."\n" + .'- CHECKING'."\n" + .'- BLOCKED'."\n" + .'- PASS', + 'type' => 'string', + 'example' => 'CHECKING', + ], + 'common' => [ + 'description' => '是否为公共资源。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-10-10T07:48:31Z', + ], + 'description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'This is a testTTSVoice。', + ], + 'errorDetail' => [ + 'description' => '错误信息。（创建音色克隆任务时无效，音色克隆任务创建结果以code和message为准。音色克隆结果以后续查询接口返回结果为准）。', + 'type' => 'string', + 'example' => 'Error', + ], + 'gender' => [ + 'description' => '性别。', + 'type' => 'string', + 'example' => 'FEMALE', + ], + 'id' => [ + 'description' => '音色ID。', + 'type' => 'string', + 'example' => 'M1lhKArheOyYdeYybDFqS1-Q', + ], + 'language' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'modifiedTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2024-10-10T07:48:31Z', + ], + 'name' => [ + 'description' => '音色名称。', + 'type' => 'string', + 'example' => 'TestTTSVoiceName', + ], + 'pitchRate' => [ + 'description' => '朗读语调。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'remainSeconds' => [ + 'description' => '预计生成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'speechRate' => [ + 'description' => '朗读语速。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'status' => [ + 'description' => '音色素材状态：'."\n" + ."\n" + .'- CREATED'."\n" + .'- PROCESSING'."\n" + .'- SUCCESS'."\n" + .'- ERROR'."\n" + .'- DELETED', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'text' => [ + 'description' => '文本输出内容。', + 'type' => 'string', + 'example' => '你好朋友！你还需要这款产品吗？', + ], + 'voiceKey' => [ + 'description' => '音色参数。', + 'type' => 'string', + 'example' => 'testTTSVoice', + ], + ], + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '用来封装当前请求处理的结果是成功还是失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '结果码。', + 'type' => 'string', + 'enumValueTitles' => [ + 'HA15110000000360' => '上传音频失败', + 'HA15110000000010' => '名称长度非法', + 'HA15110000000375' => '音色克隆数量超过限制', + 'HA15110000000001' => '参数不合法', + 'HA15110000000366' => '音频时长过短，请重新上传/录制', + 'HA15110000000400' => '未登录或登录过期', + 'HA15110000000367' => '音频时长过长，请重新上传/录制', + 'HA15110000000501' => '名称包含平台限制词汇，请调整后重试', + 'HA15110000000505' => '您的音频涉及平台限制内容，请重新上传', + ], + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '请求处理失败时返回的错误消息。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A7174E51-3523-5AEB-AE18-1D877FF22497', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => '返回的httpStatusCode。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"audioURL\\": \\"https://xxx-aliyuncs.com/material/INPUT_TRAIN_AUDIO/Mt.CQEG75L4FWIU2/TestTTSVoiceName.mp3?Expires=1764262805&OSSAccessKeyId=LTAI5tK3WcKwKtAyaTSe*****&Signature=D%2Fld6gp9Zh6TsGRU9cd6GD2pFY0%3D\\",\\n \\"censorStatus\\": \\"CHECKING\\",\\n \\"common\\": false,\\n \\"createTime\\": \\"2024-10-10T07:48:31Z\\",\\n \\"description\\": \\"This is a testTTSVoice。\\",\\n \\"errorDetail\\": \\"Error\\",\\n \\"gender\\": \\"FEMALE\\",\\n \\"id\\": \\"M1lhKArheOyYdeYybDFqS1-Q\\",\\n \\"language\\": \\"zh\\",\\n \\"modifiedTime\\": \\"2024-10-10T07:48:31Z\\",\\n \\"name\\": \\"TestTTSVoiceName\\",\\n \\"pitchRate\\": 100,\\n \\"remainSeconds\\": 100,\\n \\"speechRate\\": 100,\\n \\"status\\": \\"SUCCESS\\",\\n \\"text\\": \\"你好朋友！你还需要这款产品吗？\\",\\n \\"voiceKey\\": \\"testTTSVoice\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"A7174E51-3523-5AEB-AE18-1D877FF22497\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '自定义语音克隆', + ], + 'GetTTSVoiceByIdCustom' => [ + 'summary' => '查询自定义音色是否创建成功，建议您创建后至少等待1分钟再进行查询。', + 'path' => '/openapi/voice/getTTSVoiceById', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'voiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '音色ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'M1ScGtY****PBFEJHdUV1thQ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result', + 'description' => 'Result', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '音色名称。', + 'type' => 'string', + 'example' => 'TestTTSVoiceName。', + ], + 'description' => [ + 'description' => '音色描述。', + 'type' => 'string', + 'example' => 'This is a testTTSVoice。', + ], + 'gender' => [ + 'description' => '性别。', + 'type' => 'string', + 'example' => 'FEMALE', + ], + 'language' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => '中/英文。', + ], + 'audioURL' => [ + 'description' => '音频文件地址。', + 'type' => 'string', + 'example' => 'https://xxx-aliyuncs.com/material/INPUT_TTS_VOICE/Mt.CQEG75L4FWIU2/TestTTSVoiceName.mp3?Expires=1764262805&OSSAccessKeyId=LTAI5tK3WcKwKtAyaTSe*****&Signature=D%2Fld6gp9Zh6TsGRU9cd6GD2pFY0%3D', + ], + 'voiceKey' => [ + 'description' => '音色参数。', + 'type' => 'string', + 'example' => 'avatar-2464b55a65794e75a20fe07dde2*****', + ], + 'status' => [ + 'description' => '音色素材状态：'."\n" + ."\n" + .'- CREATED'."\n" + .'- PROCESSING'."\n" + .'- SUCCESS'."\n" + .'- ERROR'."\n" + .'- DELETED', + 'type' => 'string', + 'example' => 'SUCCESS。', + ], + 'censorStatus' => [ + 'description' => '审核状态。状态枚举值：'."\n" + .'- INIT'."\n" + .'- CHECKING'."\n" + .'- BLOCKED'."\n" + .'- PASS', + 'type' => 'string', + 'example' => 'CHECKING。', + ], + 'common' => [ + 'description' => '是否为公共资源。', + 'type' => 'boolean', + 'example' => 'false。', + ], + 'remainSeconds' => [ + 'description' => '预计生成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100。', + ], + 'errorDetail' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Audio.AudioSilentError' => '音频为静音或非静音长度过短', + 'Voice.Undeployed' => '音色审核不通过', + 'Voice.Timeout' => '音色生成超时', + 'Audio.AudioShortError' => '有效音频过短', + 'InternalError' => '内部错误，请稍后再试', + ], + 'example' => '有效音频过短。', + ], + 'text' => [ + 'description' => '文本输出内容。', + 'type' => 'string', + 'example' => '你好朋友！你还需要这款产品吗？', + ], + 'id' => [ + 'title' => '加密后ID，防止遍历', + 'description' => '加密后ID，防止遍历。', + 'type' => 'string', + 'example' => 'M1lhKArheOyYdeYyb*****', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-11-28T10:11:28', + ], + 'modifiedTime' => [ + 'title' => '最后更新时间', + 'description' => '最后更新时间。', + 'type' => 'string', + 'example' => '2025-11-28T13:41:31', + ], + 'errorCode' => [ + 'title' => '错误码。', + 'description' => '错误码。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Audio.AudioSilentError' => '音频为静音或非静音长度过短', + 'Voice.Undeployed' => '音色审核不通过', + 'Voice.Timeout' => '音色生成超时', + 'Audio.AudioShortError' => '有效音频过短', + 'InternalError' => '内部错误，请稍后再试', + ], + 'example' => 'Audio.AudioShortError', + ], + ], + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '用来封装当前请求处理的结果是成功还是失败。', + 'type' => 'boolean', + 'example' => 'True。', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '结果码。', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '请求处理失败时返回的错误消息。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBD****', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => '返回的httpStatusCode。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"name\\": \\"TestTTSVoiceName。\\",\\n \\"description\\": \\"This is a testTTSVoice。\\",\\n \\"gender\\": \\"FEMALE\\",\\n \\"language\\": \\"中/英文。\\",\\n \\"audioURL\\": \\"https://xxx-aliyuncs.com/material/INPUT_TTS_VOICE/Mt.CQEG75L4FWIU2/TestTTSVoiceName.mp3?Expires=1764262805&OSSAccessKeyId=LTAI5tK3WcKwKtAyaTSe*****&Signature=D%2Fld6gp9Zh6TsGRU9cd6GD2pFY0%3D\\",\\n \\"voiceKey\\": \\"avatar-2464b55a65794e75a20fe07dde2*****\\",\\n \\"status\\": \\"SUCCESS。\\",\\n \\"censorStatus\\": \\"CHECKING。\\",\\n \\"common\\": true,\\n \\"remainSeconds\\": 0,\\n \\"errorDetail\\": \\"有效音频过短。\\",\\n \\"text\\": \\"你好朋友！你还需要这款产品吗？\\",\\n \\"id\\": \\"M1lhKArheOyYdeYyb*****\\",\\n \\"createTime\\": \\"2025-11-28T10:11:28\\",\\n \\"modifiedTime\\": \\"2025-11-28T13:41:31\\",\\n \\"errorCode\\": \\"Audio.AudioShortError\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBD****\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '自定义语音单个音色查询', + ], + 'ListPrivateTTSVoicesCustom' => [ + 'summary' => '查看属于自己的音色列表。新增的自定义音色，建议您创建后至少等待1分钟再进行查询。', + 'path' => '/openapi/voice/listPrivateTTSVoicesCustom', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'title' => '标题', + 'description' => '标题', + 'type' => 'string', + 'required' => false, + 'example' => '2D测试数字人', + ], + ], + [ + 'name' => 'pageIndex', + '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', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页游标。', + 'type' => 'string', + 'required' => false, + 'example' => 'Q45algIClks=', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。'."\n" + ."\n" + .'> 分页时，返回参数里返回数量。后续页数的获取，保持和初始页一致，不传默认100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result>', + 'description' => 'Result>', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '响应结果。', + 'type' => 'array', + 'items' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '音色名称。', + 'type' => 'string', + 'example' => 'TestTTSVoice', + ], + 'description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'Optional for WH managernif no issue will be cancel', + ], + 'gender' => [ + 'description' => '性别。'."\n" + .'- FEMALE'."\n" + .'- MALE', + 'type' => 'string', + 'example' => 'FEMALE', + ], + 'language' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'ZH_CN', + ], + 'audioURL' => [ + 'description' => '音频文件地址。', + 'type' => 'string', + 'example' => 'https://xxx-aliyuncs.com/material/INPUT_TRAIN_AUDIO/Mt.CQEG75L4FWIU2/TestTTSVoiceName.mp3?Expires=1764262805&OSSAccessKeyId=LTAI5tK3WcKwKtAyaTSe*****&Signature=D%2Fld6gp9Zh6TsGRU9cd6GD2pFY0%3D', + ], + 'voiceKey' => [ + 'description' => '音色参数。', + 'type' => 'string', + 'example' => 'TestTTSVoice', + ], + 'status' => [ + 'description' => '音色素材状态：'."\n" + ."\n" + .'- CREATED'."\n" + .'- PROCESSING'."\n" + .'- SUCCESS'."\n" + .'- ERROR'."\n" + .'- DELETED', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'censorStatus' => [ + 'description' => '审核状态。状态枚举值：'."\n" + .'- INIT'."\n" + .'- CHECKING'."\n" + .'- BLOCKED'."\n" + .'- PASS', + 'type' => 'string', + 'example' => 'PASS', + ], + 'common' => [ + 'description' => '是否为公共资源', + 'type' => 'boolean', + 'example' => 'false', + ], + 'remainSeconds' => [ + 'description' => '预计生成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'errorDetail' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Audio.AudioSilentError' => '音频为静音或非静音长度过短', + 'Voice.Undeployed' => '音色审核不通过', + 'Voice.Timeout' => 'Voice.Timeout', + 'Audio.AudioShortError' => '有效音频过短', + 'InternalError' => '内部错误，请稍后再试', + ], + 'example' => '有效音频过短', + ], + 'text' => [ + 'description' => '生成文本', + 'type' => 'string', + 'example' => '机器学习需要提供一个应用程序接口，以便大家使用。机器学习需要提供一个应用程序接口，以便大家使用。机器学习需要提供一个应用程序接口，以便大家使用。', + ], + 'id' => [ + 'title' => '加密后ID，防止遍历', + 'description' => '加密后ID，防止遍历', + 'type' => 'string', + 'example' => 'M1lhKArheOyYdeYybDFqS1-Q', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-04-15T09:42:15Z', + ], + 'modifiedTime' => [ + 'title' => '最后更新时间', + 'description' => '最后更新时间', + 'type' => 'string', + 'example' => '2024-04-15T09:42:15Z', + ], + 'errorCode' => [ + 'title' => '错误码。', + 'description' => '错误码。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Audio.AudioSilentError' => '音频为静音或非静音长度过短', + 'Voice.Undeployed' => '音色审核不通过', + 'Voice.Timeout' => '音色生成超时', + 'Audio.AudioShortError' => '有效音频过短', + 'InternalError' => '内部错误，请稍后再试', + ], + 'example' => 'Audio.AudioShortError', + ], + ], + ], + ], + 'total' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'page' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'size' => [ + 'description' => '单页数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'pages' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + ], + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '用来封装当前请求处理的结果是成功还是失败', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '结果码', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '请求处理失败时返回的错误消息', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => '返回的httpStatusCode', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'nextToken' => [ + 'description' => '分页游标。', + 'type' => 'string', + 'example' => 'qht-fc2-test', + ], + 'maxResults' => [ + 'description' => '最大返回结果数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"data\\": [\\n {\\n \\"name\\": \\"TestTTSVoice\\",\\n \\"description\\": \\"Optional for WH managernif no issue will be cancel\\",\\n \\"gender\\": \\"FEMALE\\",\\n \\"language\\": \\"ZH_CN\\",\\n \\"audioURL\\": \\"https://xxx-aliyuncs.com/material/INPUT_TRAIN_AUDIO/Mt.CQEG75L4FWIU2/TestTTSVoiceName.mp3?Expires=1764262805&OSSAccessKeyId=LTAI5tK3WcKwKtAyaTSe*****&Signature=D%2Fld6gp9Zh6TsGRU9cd6GD2pFY0%3D\\",\\n \\"voiceKey\\": \\"TestTTSVoice\\",\\n \\"status\\": \\"SUCCESS\\",\\n \\"censorStatus\\": \\"PASS\\",\\n \\"common\\": false,\\n \\"remainSeconds\\": 100,\\n \\"errorDetail\\": \\"有效音频过短\\",\\n \\"text\\": \\"机器学习需要提供一个应用程序接口，以便大家使用。机器学习需要提供一个应用程序接口，以便大家使用。机器学习需要提供一个应用程序接口，以便大家使用。\\",\\n \\"id\\": \\"M1lhKArheOyYdeYybDFqS1-Q\\",\\n \\"createTime\\": \\"2024-04-15T09:42:15Z\\",\\n \\"modifiedTime\\": \\"2024-04-15T09:42:15Z\\",\\n \\"errorCode\\": \\"Audio.AudioShortError\\"\\n }\\n ],\\n \\"total\\": 20,\\n \\"page\\": 1,\\n \\"size\\": 20,\\n \\"pages\\": 16\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200,\\n \\"nextToken\\": \\"qht-fc2-test\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]', + 'title' => '自定义语音查询', + ], + 'ListTemplateMaterial' => [ + 'summary' => '查询底板素材', + 'path' => '/openapi/train/listTemplateMaterial', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '页数，从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '最大结果值，无需关注。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页Token值，无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => 'M1Ti7gfj7VGDQgD588hxReiw ', + ], + ], + [ + 'name' => 'templateIds', + 'in' => 'query', + 'schema' => [ + 'description' => '模版id（可多选 英文逗号隔开）。', + 'type' => 'string', + 'required' => false, + 'example' => 'M1Ti7gfj7VGDQgD588hxReiw,M1j9tcbkh9YtBw7BdOYlDusQ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '响应数据（集合）。', + 'type' => 'array', + 'items' => [ + 'description' => '响应实例数据。', + 'type' => 'object', + 'properties' => [ + 'templateId' => [ + 'description' => '模版ID。', + 'type' => 'string', + 'example' => 'M1Ti7gfj7VGDQgD588hxReiw ', + ], + 'templateName' => [ + 'description' => '模版名称。', + 'type' => 'string', + 'example' => '模版测试', + ], + 'templateURL' => [ + 'description' => '模版视频url地址。', + 'type' => 'string', + 'example' => '//daily-avatar-property.oss-cn-beijing.aliyuncs.com/material/INPUT_TRAIN_TEMPLATE_UGC_BODY/Mt.CNYEA3CV25QU2/%E5%BA%95%E6%9D%BF3%E6%9B%BF%E6%8D%A2.mp4?Expires=1764326111&OSSAccessKeyId=LTAI5tBRPnF5JkRCidYA****&Signature=3WU2%2FV2XDaQdt00lkAInK6yr9uk%3D', + ], + 'bizType' => [ + 'description' => '底板应用类型。', + 'type' => 'string', + 'example' => 'BROADCAST', + ], + ], + ], + ], + 'totalCount' => [ + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'total' => [ + 'description' => ' 总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'page' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'size' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True'."\n", + ], + 'code' => [ + 'title' => '结果码', + 'description' => '响应码。', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => 'http响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'nextToken' => [ + 'description' => '分页Token值，无需关注。', + 'type' => 'string', + 'example' => ' '."\n" + .'M1Ti7gfj7VGDQgD588hxReiw', + ], + 'maxResults' => [ + 'description' => '最大结果值，无需关注。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"templateId\\": \\"M1Ti7gfj7VGDQgD588hxReiw\\\\t\\",\\n \\"templateName\\": \\"模版测试\\",\\n \\"templateURL\\": \\"//daily-avatar-property.oss-cn-beijing.aliyuncs.com/material/INPUT_TRAIN_TEMPLATE_UGC_BODY/Mt.CNYEA3CV25QU2/%E5%BA%95%E6%9D%BF3%E6%9B%BF%E6%8D%A2.mp4?Expires=1764326111&OSSAccessKeyId=LTAI5tBRPnF5JkRCidYA****&Signature=3WU2%2FV2XDaQdt00lkAInK6yr9uk%3D\\",\\n \\"bizType\\": \\"BROADCAST\\"\\n }\\n ],\\n \\"totalCount\\": 100,\\n \\"total\\": 100,\\n \\"page\\": 1,\\n \\"size\\": 20,\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200,\\n \\"nextToken\\": \\"\\\\t\\\\nM1Ti7gfj7VGDQgD588hxReiw\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]', + 'title' => '底板素材分页查询。', + ], + 'CreateTrainPicAvatar' => [ + 'summary' => '创建图片训练数字人。', + 'path' => '/openapi/train/createTrainPicAvatar', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '图片训练数字人名称。', + 'type' => 'string', + 'required' => true, + 'example' => '图片训练数字人', + ], + ], + [ + 'name' => 'imageOssPath', + 'in' => 'query', + 'schema' => [ + 'description' => '图片路径。要求图片比是9:16', + 'type' => 'string', + 'required' => true, + 'example' => 'material/INPUT_TRAIN_PIC/Mt.CQEJ2DQ6BBYU2/2.jpg', + ], + ], + [ + 'name' => 'gender', + 'in' => 'query', + 'schema' => [ + 'description' => '性别。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'MALE' => '男性', + 'FEMALE' => '女性', + ], + 'example' => 'FEMALE', + ], + ], + [ + 'name' => 'templateId', + 'in' => 'query', + 'schema' => [ + 'title' => '动作底板id', + 'description' => '参数已废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'M16vSG46Pby9HWOrFSZ7QaQA', + ], + ], + [ + 'name' => 'transparent', + 'in' => 'query', + 'schema' => [ + 'title' => '背景: 透明/实景色', + 'description' => '背景: 透明/实景色。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'generateAssets', + 'in' => 'query', + 'schema' => [ + 'title' => '是否生成资产', + 'description' => '是否生成资产。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'bizType', + 'in' => 'query', + 'schema' => [ + 'description' => '业务类型。（可为空，为空默认值为：BROADCAST）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CHAT' => '对话', + 'BROADCAST' => '播报', + ], + 'example' => 'BROADCAST', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'avatarId' => [ + 'description' => '数字人ID。', + 'type' => 'string', + 'example' => 'M1AguofmMxaoUQsuSPQ3j0ng', + ], + 'pass' => [ + 'description' => '是否通过。', + 'type' => 'boolean', + 'example' => 'true :通过，false：不通过', + ], + 'expectedCompletionTime' => [ + 'description' => '预期完成时间（单位秒）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1200', + ], + ], + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '响应码。', + 'type' => 'string', + 'enumValueTitles' => [ + 'CONTENT_RISK' => 'CONTENT_RISK', + 'MULTI_HUMAN_BODY' => 'MULTI_HUMAN_BODY', + 'FACE_INCOMPLETE' => 'FACE_INCOMPLETE', + 'NO_HUMAN_BODY' => 'NO_HUMAN_BODY', + 'INVALID_FACE_ORIENTATION' => 'INVALID_FACE_ORIENTATION', + 'DETECT_FAILED' => 'DETECT_FAILED', + 'INVALID_PERSON_VAGUE' => 'INVALID_PERSON_VAGUE', + 'INVALID_HUMAN_PROPORTION' => 'INVALID_HUMAN_PROPORTION', + 'INVALID_BODY_ORIENTATION' => 'INVALID_BODY_ORIENTATION', + 'DETECT_NOT_PASS' => 'DETECT_NOT_PASS', + 'INVALID_IMAGE_SIZE' => 'INVALID_IMAGE_SIZE', + ], + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '状态码描述。', + 'type' => 'string', + 'enumValueTitles' => [ + 'CONTENT_RISK' => '您的图片涉及平台限制内容，请重新上传', + 'MULTI_HUMAN_BODY' => '请上传单个形象图片', + 'FACE_INCOMPLETE' => '请确保脸部完整', + 'NO_HUMAN_BODY' => '未检测到人脸', + 'INVALID_FACE_ORIENTATION' => '请确保脸部朝向正面', + 'DETECT_FAILED' => '图像检测失败', + 'INVALID_PERSON_VAGUE' => '请上传更清晰的照片', + 'INVALID_HUMAN_PROPORTION' => '形象在照片中比例过大/过小', + 'INVALID_BODY_ORIENTATION' => '请确保身体朝向正面', + 'DETECT_NOT_PASS' => '图像检测不通过', + 'INVALID_IMAGE_SIZE' => '图片大小不符合要求', + ], + 'example' => 'success', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => 'http响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"avatarId\\": \\"M1AguofmMxaoUQsuSPQ3j0ng\\",\\n \\"pass\\": true,\\n \\"expectedCompletionTime\\": 1200\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '创建图片训练数字人。', + 'description' => '> **通过API调用创建图片训练数字人，图片比例需提前裁剪至9:16。**', + ], + 'ConfirmTrainPicAvatar' => [ + 'summary' => '用户确认', + 'path' => '/openapi/train/confirmTrainPicAvatar', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'avatarId', + 'in' => 'query', + 'schema' => [ + 'description' => '数字人id。', + 'type' => 'string', + 'required' => true, + 'example' => 'M1_eTNYgO5lOys5g7ObvC_nw ', + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'description' => '数字人状态确认。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'CUSTOMER_REJECTED' => '拒绝', + 'CUSTOMER_CONFIRMED' => '确认成功', + ], + 'example' => 'CUSTOMER_CONFIRMED', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '响应码。', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => 'http响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '结果确认。', + ], + 'GetTrainPicAvatarStatus' => [ + 'summary' => '查询图片数字人的训练状态，建议您在提交训练任务后，等待至少20分钟后进行结果的查询。', + 'path' => '/openapi/train/getTrainPicAvatarStatus', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'avatarId', + 'in' => 'query', + 'schema' => [ + 'description' => '数字人id。', + 'type' => 'string', + 'required' => true, + 'example' => 'M1YJTNTH2yoLmLnzKdYHeGBg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'avatarId' => [ + 'description' => '数字人id。', + 'type' => 'string', + 'example' => 'M1YJTNTH2yoLmLnzKdYHeGBg', + ], + 'status' => [ + 'description' => '数字人训练状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'COMPLETED ' => '已完成', + 'EXPIRED' => '已过期', + 'PENDING_CONFIRM' => '结果确认', + 'TRAIN_FAILED' => '训练失败', + 'TRAINING ' => '训练中', + ], + 'example' => 'TRAINING (训练中)，TRAIN_FAILED（训练失败）,PENDING_CONFIRM（结果确认）, COMPLETED (已完成) ,EXPIRED(已过期)', + ], + 'previewURL' => [ + 'description' => '训练成功后的预览视频。', + 'type' => 'string', + 'example' => '//daily-avatar-property.oss-cn-beijing.aliyuncs.com/avatar-share-property/AVATAR_2D_PIC/Mt.CMTMRYX4TNIU2/retalking_output.mp4?Expires=1764327167&OSSAccessKeyId=LTAI5tBRPnF5JkRCidYA****&Signature=%2BH%2BSBpNDPiMQtPyl8vraEHMv9X8%3D', + ], + ], + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '响应码。', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => 'http响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"avatarId\\": \\"M1YJTNTH2yoLmLnzKdYHeGBg\\",\\n \\"status\\": \\"TRAINING (训练中)，TRAIN_FAILED（训练失败）,PENDING_CONFIRM（结果确认）, COMPLETED (已完成) ,EXPIRED(已过期)\\",\\n \\"previewURL\\": \\"//daily-avatar-property.oss-cn-beijing.aliyuncs.com/avatar-share-property/AVATAR_2D_PIC/Mt.CMTMRYX4TNIU2/retalking_output.mp4?Expires=1764327167&OSSAccessKeyId=LTAI5tBRPnF5JkRCidYA****&Signature=%2BH%2BSBpNDPiMQtPyl8vraEHMv9X8%3D\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询图片训练数字人的状态。', + ], + 'CreateBackgroundPic' => [ + 'summary' => '创建背景素材。', + 'path' => '/openapi/chat/createBackgroundPic', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ossKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'oss文件key。', + 'type' => 'string', + 'required' => false, + 'example' => 'material/INPUT_CHAT_BACKGROUND_PIC/Mt.CN2VNOPRC5QU2', + ], + ], + [ + 'name' => 'filename', + 'in' => 'query', + 'schema' => [ + 'description' => '文件名称。', + 'type' => 'string', + 'required' => false, + 'example' => '1.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '记录ID。', + 'type' => 'string', + 'example' => 'M1lhKArheOyYdeYybDFqS1-Q', + ], + ], + ], + 'success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'description' => '响应码。', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'httpStatusCode' => [ + 'description' => 'http响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"id\\": \\"M1lhKArheOyYdeYybDFqS1-Q\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '创建背景素材', + ], + 'CreateNoTrainPicAvatar' => [ + 'summary' => '创建对话免训照片数字人。', + 'path' => '/openapi/chat/createNoTrainPicAvatar', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'title' => '数字人名称', + 'description' => '数字人名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'avatar', + ], + ], + [ + 'name' => 'gender', + 'in' => 'query', + 'schema' => [ + 'title' => '性别', + 'description' => '性别。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'MALE' => 'MALE', + 'FEMALE' => 'FEMALE', + ], + 'example' => 'FEMALE/MALE', + ], + ], + [ + 'name' => 'imageOssPath', + 'in' => 'query', + 'schema' => [ + 'title' => '上传的图片路径', + 'description' => '上传的图片路径，必须输入。', + 'type' => 'string', + 'required' => false, + 'example' => 'material/INPUT_INFER_PIC/Mt.CPQX3T6E25QU2/2e81e20797954440aed4da4264eb7494.webp', + ], + ], + [ + 'name' => 'expressiveness', + 'in' => 'query', + 'schema' => [ + 'title' => '表现力(热情的/普通的)', + 'description' => '表现力(热情的/普通的)，影响您的数字人形象的表现幅度。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ENTHUSIASTIC' => 'ENTHUSIASTIC', + 'NORMAL' => 'NORMAL', + ], + 'example' => 'NORMAL/ENTHUSIASTIC', + ], + ], + [ + 'name' => 'transparent', + 'in' => 'query', + 'schema' => [ + 'title' => '背景: 透明/实景色', + 'description' => '背景: 透明/实景色。如果您需要我们进行抠图处理，则选择透明。如果您已经完成了抠图，或者您想保留图片中的背景，则选择实景色。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true/false', + ], + ], + [ + 'name' => 'jwtToken', + 'in' => 'query', + 'schema' => [ + 'title' => '包含额外登录认证信息JWT', + 'description' => '包含额外登录认证信息JWT，已废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'Token', + ], + ], + [ + 'name' => 'generateAssets', + 'in' => 'query', + 'schema' => [ + 'description' => '是否生成资产。如您仅希望进行图片可用性检测而不生成资产，则选择false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true/false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'avatarId' => [ + 'description' => '数字人id。', + 'type' => 'string', + 'example' => 'M1ONzwuILu-nPT7pvr6maKvQ', + ], + 'pass' => [ + 'description' => '是否通过。', + 'type' => 'boolean', + 'example' => 'true/false', + ], + ], + ], + 'success' => [ + 'title' => '用来封装当前请求处理的结果是成功还是失败', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'title' => '结果码', + 'description' => '响应码。', + 'type' => 'string', + 'enumValueTitles' => [ + 'CONTENT_RISK' => 'CONTENT_RISK', + 'MULTI_HUMAN_BODY' => 'MULTI_HUMAN_BODY', + 'FACE_INCOMPLETE' => 'FACE_INCOMPLETE', + 'NO_HUMAN_BODY' => 'NO_HUMAN_BODY', + 'INVALID_FACE_ORIENTATION' => 'INVALID_FACE_ORIENTATION', + 'DETECT_FAILED' => 'DETECT_FAILED', + 'INVALID_PERSON_VAGUE' => 'INVALID_PERSON_VAGUE', + 'INVALID_HUMAN_PROPORTION' => 'INVALID_HUMAN_PROPORTION', + 'INVALID_BODY_ORIENTATION' => 'INVALID_BODY_ORIENTATION', + 'DETECT_NOT_PASS' => 'DETECT_NOT_PASS', + 'INVALID_IMAGE_SIZE' => 'INVALID_IMAGE_SIZE', + ], + 'example' => '200', + ], + 'message' => [ + 'title' => '请求处理失败时返回的错误消息', + 'description' => '状态码描述。', + 'type' => 'string', + 'enumValueTitles' => [ + 'CONTENT_RISK' => '您的图片涉及平台限制内容，请重新上传', + 'MULTI_HUMAN_BODY' => '请上传单个形象图片', + 'FACE_INCOMPLETE' => '请确保脸部完整', + 'NO_HUMAN_BODY' => '未检测到人脸', + 'INVALID_FACE_ORIENTATION' => '请确保脸部朝向正面', + 'DETECT_FAILED' => '图像检测失败', + 'INVALID_PERSON_VAGUE' => '请上传更清晰的照片', + 'INVALID_HUMAN_PROPORTION' => '形象在照片中比例过大/过小', + 'INVALID_BODY_ORIENTATION' => '请确保身体朝向正面', + 'DETECT_NOT_PASS' => '图像检测不通过', + 'INVALID_IMAGE_SIZE' => '图片大小不符合要求', + ], + 'example' => 'success', + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8'."\n", + ], + 'httpStatusCode' => [ + 'title' => '返回的httpStatusCode', + 'description' => 'http响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"avatarId\\": \\"M1ONzwuILu-nPT7pvr6maKvQ\\",\\n \\"pass\\": true\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\\\n\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '创建免训图片数字人', + ], + 'CreateChatConfig' => [ + 'summary' => '背景配置。', + 'path' => '/openapi/chat/createChatConfig', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'backgroundId', + 'in' => 'query', + 'schema' => [ + 'description' => '背景素材ID。如您的数字人形象不是透明的，则不需要这个参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'M1ONzwuILu-nPT7pvr6maKvQ', + ], + ], + [ + 'name' => 'avatarId', + 'in' => 'query', + 'schema' => [ + 'description' => '数字人id，必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'M1ONzwuILu-nPT7pvr6maKvQ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0EC3BA89-13F5-5766-A0BA-85096092A032', + ], + 'success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'description' => '响应码。', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'httpStatusCode' => [ + 'description' => 'http响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '对话配置ID。', + 'type' => 'string', + 'example' => 'C1RznvtlM-JO6HuPHqNC-Xxg', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0EC3BA89-13F5-5766-A0BA-85096092A032\\",\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": \\"C1RznvtlM-JO6HuPHqNC-Xxg\\"\\n }\\n}","type":"json"}]', + 'title' => '创建对话配置', + ], + 'CreateChatSession' => [ + 'summary' => '创建实时数字人会话。', + 'path' => '/openapi/chat/init/{id}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '即对话数字人的项目ID，通过灵眸控制台[对话互动](https://avatar.console.aliyun.com/lingmou/chat)页面点击对话项目右下角更多选项查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'C1gttTrdX7l98YCPck7Jr-iA', + ], + ], + [ + 'name' => 'license', + 'in' => 'query', + 'schema' => [ + 'description' => '灵眸平台颁发的个人凭证（在使用端渲染数字人的场景下必填）。', + 'type' => 'string', + 'required' => false, + 'example' => 'b9be4b25c2d38c409c376ffd2372be1', + ], + ], + [ + 'name' => 'platform', + 'in' => 'query', + 'schema' => [ + 'description' => '运行SDK的平台（在使用端渲染数字人的场景下必填）。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Web' => 'Web', + 'iOS' => 'iOS', + 'Android' => 'Android', + ], + 'example' => 'Web | Android | iOS', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要在[数字人实时交互服务](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.457876812ETi6y&commodityCode=avatar_2dchat_public_cn)购买完成对应的服务购买，当前有可用的服务时，前往阿里云-[我的订单](https://billing-cost.console.aliyun.com/order/list)页面对应订单详情下进行查询', + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-9t946y43m1d', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'message' => [ + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'httpStatusCode' => [ + 'description' => 'http响应码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'data' => [ + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'sessionId' => [ + 'description' => '会话ID', + 'type' => 'string', + 'example' => '9827f4bd-5008-4d34-98fb-62598f3ad3b5', + ], + 'rtcParams' => [ + 'description' => 'RTC入参。', + 'type' => 'object', + 'properties' => [ + 'appId' => [ + 'description' => '应用id。', + 'type' => 'string', + 'example' => '895cbf3b', + ], + 'avatarUserId' => [ + 'description' => '数字人侧用户ID。', + 'type' => 'string', + 'example' => 'E7enIvjUos', + ], + 'channel' => [ + 'description' => 'RTC通道ID。', + 'type' => 'string', + 'example' => 'pPltqR3FovNCK3hNQc8eHUL3Ztq1wY', + ], + 'clientUserId' => [ + 'description' => '客户端侧用户ID。', + 'type' => 'string', + 'example' => 'aw0tqpFlP4', + ], + 'gslb' => [ + 'description' => 'RTC服务地址。', + 'type' => 'string', + 'example' => 'https://gw.rtn.aliyuncs.com', + ], + 'nonce' => [ + 'description' => '随机串。', + 'type' => 'string', + 'example' => 'f8b0ef02c5da778f4488e2470c', + ], + 'serverUserId' => [ + 'description' => '服务端侧用户ID。', + 'type' => 'string', + 'example' => 'YzZtSQP8QX', + ], + 'timestamp' => [ + 'description' => '过期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1560588594', + ], + 'token' => [ + 'description' => '访问凭证token。', + 'type' => 'string', + 'example' => 'PtGgv2dM9F8tEuAtda50c0VNNFjn0WUbyTDRPa1im4cUBEcxlo', + ], + ], + ], + 'avatarAssets' => [ + 'description' => '端渲染数字人资产信息。', + 'type' => 'object', + 'properties' => [ + 'url' => [ + 'description' => '资产下载链接。', + 'type' => 'string', + 'example' => 'https://daily-avatar-property.oss-cn-beijing.aliyuncs.com/avatar-share-property/AVATAR_3D_TRADITIONAL/Mt.CNMU6BO4RBYU2/secret_assets_web.zip?Expires=1752637519&OSSAccessKeyId=STS.NZULzwLRx8thHDHQxem94dWdN&Signature=Oni3%2Be8dY8Xrv3iRGDyzn7uReVc%3D&security-token=CAISzAJ1q6Ft5B2yfSjIr5ngB8DDoY1Zj7aDSmL5tXgwYbYYi5LPrDz2IHhMfnloB%2BEcsfU3nmxT6vkZlrp6SJtIXleCZtF94oxN9h2gb4fb4093DEHt08%2FLI3OaLjKm9u2wCryLYbGwU%2FOpbE%2B%2B5U0X6LDmdDKkckW4OJmS8%2FBOZcgWWQ%2FKBlgvRq0hRG1YpdQdKGHaONu0LxfumRCwNkdzvRdmgm4NgsbWgO%2Fks0KA1QSml7ZP%2B9WuesH0M%2FMBZskvD42Hu8VtbbfE3SJq7BxHybx7lqQs%2B02c5onHUwEPsk%2FZYrKOroYzc1RjAbM%2FErRY6fP8nOE9ovbUm5RXHpT05CrMOs62ZPdDoKOscIvBXr6yZaP7JmcGC6iQLG%2FznQkSc081IsK2C7Xq0pe54O3lg9Ab41ZGNYEjq%2BpCIUP%2Fs97dqXEelD2e%2Bh8UezDnKxqAAXuAiYRY7Ox3cf6h2MlmRsK5yywg45O%2FizjiK2k8Z8p6WeOA54W3pfbg6ElV4d8TMWCVZ7tuAbSgRCKBg3q5YYrdS2ENqDu6njIea1pxG4LT4ydGxDBkYpjwcUxutDd0aAhFjsypSK%2Feuk0%2FDCfKMrWzCmkr1AtPpcNfJ8LPj58qIA', + ], + 'md5' => [ + 'description' => '资产MD5值。', + 'type' => 'string', + 'example' => '5B83BE2114489274BB88BADE7EBC9BC0', + ], + 'secret' => [ + 'description' => 'SDK使用的密钥。', + 'type' => 'string', + 'example' => 'J562PNqJBZDhzOQpLBgIcIW8+rHQoM7P6IONGMP7P5vGxrWLxT7VtRenFnMY+wg/zpA2qwpFBmJYO2rVexnlCQ2WE4kvYOH/OKmlTzpQddY34U5jS9KaS3b3ulpq4xnKDjWJ+sLZSRMhuPDdlq8ZPfcfEPhJhF3zPO8Hu4QOSu+D/pAIDJUoixOTo9Q14DXFKGFuuVRQOQ7f/VxJcoSLIWIusV917pLtph/IYBaLd27gzbrTZBEVD8qrucR+WOQPY1g67PGAdafkhJWrs/+coM7+5dc3HEUC+KgI9JN4X4Akelc94aJcy78RZ6tRdr73hBzN83/cMZdzt2hxnjzg==', + ], + 'type' => [ + 'description' => '资产类型。', + 'type' => 'string', + 'example' => 'AVATAR_3D_TRADITIONAL', + ], + 'minRequiredVersion' => [ + 'description' => '支持的SDK最低版本。', + 'type' => 'string', + 'example' => '0.0.1', + ], + ], + ], + ], + ], + 'code' => [ + 'description' => '响应码。', + 'type' => 'string', + 'example' => '200', + ], + 'success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'True' => 'True', + 'False' => 'False', + ], + 'example' => 'True', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"sessionId\\": \\"9827f4bd-5008-4d34-98fb-62598f3ad3b5\\",\\n \\"rtcParams\\": {\\n \\"appId\\": \\"895cbf3b\\",\\n \\"avatarUserId\\": \\"E7enIvjUos\\",\\n \\"channel\\": \\"pPltqR3FovNCK3hNQc8eHUL3Ztq1wY\\",\\n \\"clientUserId\\": \\"aw0tqpFlP4\\",\\n \\"gslb\\": \\"https://gw.rtn.aliyuncs.com\\",\\n \\"nonce\\": \\"f8b0ef02c5da778f4488e2470c\\",\\n \\"serverUserId\\": \\"YzZtSQP8QX\\",\\n \\"timestamp\\": 1560588594,\\n \\"token\\": \\"PtGgv2dM9F8tEuAtda50c0VNNFjn0WUbyTDRPa1im4cUBEcxlo\\"\\n },\\n \\"avatarAssets\\": {\\n \\"url\\": \\"https://daily-avatar-property.oss-cn-beijing.aliyuncs.com/avatar-share-property/AVATAR_3D_TRADITIONAL/Mt.CNMU6BO4RBYU2/secret_assets_web.zip?Expires=1752637519&OSSAccessKeyId=STS.NZULzwLRx8thHDHQxem94dWdN&Signature=Oni3%2Be8dY8Xrv3iRGDyzn7uReVc%3D&security-token=CAISzAJ1q6Ft5B2yfSjIr5ngB8DDoY1Zj7aDSmL5tXgwYbYYi5LPrDz2IHhMfnloB%2BEcsfU3nmxT6vkZlrp6SJtIXleCZtF94oxN9h2gb4fb4093DEHt08%2FLI3OaLjKm9u2wCryLYbGwU%2FOpbE%2B%2B5U0X6LDmdDKkckW4OJmS8%2FBOZcgWWQ%2FKBlgvRq0hRG1YpdQdKGHaONu0LxfumRCwNkdzvRdmgm4NgsbWgO%2Fks0KA1QSml7ZP%2B9WuesH0M%2FMBZskvD42Hu8VtbbfE3SJq7BxHybx7lqQs%2B02c5onHUwEPsk%2FZYrKOroYzc1RjAbM%2FErRY6fP8nOE9ovbUm5RXHpT05CrMOs62ZPdDoKOscIvBXr6yZaP7JmcGC6iQLG%2FznQkSc081IsK2C7Xq0pe54O3lg9Ab41ZGNYEjq%2BpCIUP%2Fs97dqXEelD2e%2Bh8UezDnKxqAAXuAiYRY7Ox3cf6h2MlmRsK5yywg45O%2FizjiK2k8Z8p6WeOA54W3pfbg6ElV4d8TMWCVZ7tuAbSgRCKBg3q5YYrdS2ENqDu6njIea1pxG4LT4ydGxDBkYpjwcUxutDd0aAhFjsypSK%2Feuk0%2FDCfKMrWzCmkr1AtPpcNfJ8LPj58qIA\\",\\n \\"md5\\": \\"5B83BE2114489274BB88BADE7EBC9BC0\\",\\n \\"secret\\": \\"J562PNqJBZDhzOQpLBgIcIW8+rHQoM7P6IONGMP7P5vGxrWLxT7VtRenFnMY+wg/zpA2qwpFBmJYO2rVexnlCQ2WE4kvYOH/OKmlTzpQddY34U5jS9KaS3b3ulpq4xnKDjWJ+sLZSRMhuPDdlq8ZPfcfEPhJhF3zPO8Hu4QOSu+D/pAIDJUoixOTo9Q14DXFKGFuuVRQOQ7f/VxJcoSLIWIusV917pLtph/IYBaLd27gzbrTZBEVD8qrucR+WOQPY1g67PGAdafkhJWrs/+coM7+5dc3HEUC+KgI9JN4X4Akelc94aJcy78RZ6tRdr73hBzN83/cMZdzt2hxnjzg==\\",\\n \\"type\\": \\"AVATAR_3D_TRADITIONAL\\",\\n \\"minRequiredVersion\\": \\"0.0.1\\"\\n }\\n },\\n \\"code\\": \\"200\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '创建实时数字人会话', + ], + 'CloseChatInstanceSessions' => [ + 'summary' => '关闭会话实例session。', + 'path' => '/openapi/chat/instances/{instanceId}/sessions/close', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '购买开通的实例id，可在订单页查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'avatar_2dchat_public_cn-xxxxxxx', + ], + ], + [ + 'name' => 'sessionIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '待关闭的会话id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '待关闭的会话id。', + 'type' => 'string', + 'required' => false, + 'example' => '8C9F2D4E-7A6B-4F1C-9E53-0B2C8D3F9A4B', + ], + 'required' => false, + 'example' => '["8C9F2D4E-7A6B-4F1C-9E53-0B2C8D3F9A4B"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '本次pop请求的id。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'description' => '响应码。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'message' => [ + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'httpStatusCode' => [ + 'description' => 'http响应码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'data' => [ + 'description' => '响应数据。', + 'type' => 'array', + 'items' => [ + 'description' => '成功关闭的会话信息，包括会话'."\n" + .'id、所属主账号、创建的时间戳。', + 'example' => '{"sessionId": "20250311-41523E3C-1D27-5844-8EEF-194E4714096B", "mainAccountId": 1234567, "createdAt": 1755680457}', + '$ref' => '#/components/schemas/ChatSessionInfo', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"success\\": true,\\n \\"code\\": \\"SUCCESS\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"sessionId\\": \\"\\",\\n \\"mainAccountId\\": 0,\\n \\"createdAt\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '关闭实例下的会话', + ], + 'QueryChatInstanceSessions' => [ + 'summary' => '查询会话实例session。', + 'path' => '/openapi/chat/instances/{instanceId}/sessions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREavatarWE6ABK', + 'FEATUREavatar8ULNZ9', + 'FEATUREavatarIODFBA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '购买开通的实例id，可在订单页查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'avatar_2dchat_public_cn-xxxxxxx', + ], + ], + [ + 'name' => 'sessionIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '指定查询的会话id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指定查询的会话id。', + 'type' => 'string', + 'required' => false, + 'example' => '8C9F2D4E-7A6B-4F1C-9E53-0B2C8D3F9A4B', + ], + 'required' => false, + 'example' => '["8C9F2D4E-7A6B-4F1C-9E53-0B2C8D3F9A4B"] ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '本次pop请求的id。', + 'type' => 'string', + 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', + ], + 'success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'code' => [ + 'description' => '响应码。', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'httpStatusCode' => [ + 'description' => 'http响应码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'data' => [ + 'description' => '响应数据。', + 'type' => 'array', + 'items' => [ + 'description' => '当前活跃的会话信息，包括会话 id、所属主账号、创建的时间戳。', + 'example' => '{"sessionId": "7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8", "createdAt": 1755680969, "mainAccountId": 1234567}', + '$ref' => '#/components/schemas/ChatSessionInfo', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"sessionId\\": \\"\\",\\n \\"mainAccountId\\": 0,\\n \\"createdAt\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询实例下的活跃会话', + 'description' => '查询指定实例下的活跃会话信息。', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'lingmou.cn-beijing.aliyuncs.com', + ], + ], +]; -- cgit v1.2.3