DescribeCloudNotes - 纪要文件列表

纪要列表

接口说明

使用说明

本接口用于查询有纪要结果的纪要任务文件列表。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rtc:DescribeCloudNotesnone
*全部资源
*

请求参数

名称类型必填描述示例值
AppIdstring

APP ID。

testappid
ChannelIdstring

频道 ID。

311
PageNointeger

页码。

1
PageSizeinteger

每页数量。

10
StartTslong

查询范围,任务开始时间开区间,单位:ms。如果不传,默认查询 3 天内,最长查询过去一年的录制文件。

1712376032000
EndTslong

查询范围,任务开始时间闭区间,单位:ms。

1712376532000
TaskIdsarray

任务 TaskId 列表。

string

具体任务 ID。

task001

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

154EF5DE-3D08-1F2C-A482-281F78D74B7C
PageNointeger

页码。

1
PageSizeinteger

每页数量。

10
TotalCntinteger

总数量。

10
Itemsarray<object>

纪要结果列表。

Itemobject
ChannelIdstring

频道 ID。

testchannelId
TaskIdstring

任务 ID。

test001
TranscriptionFilePathstring

转写结果文件存放路径。

cloudNote/ksvxxppi/88_12/transcription_1724914365173.json
AutoChaptersFilePathstring

章节速览结果文件存放路径。

cloudNote/ksvxxppi/88_12/autoChapters_1724914365173.json
MeetingAssistanceFilePathstring

要点提炼结果文件存放路径。

cloudNote/ksvxxppi/88_12/meetingAssistance_1724914365173.json
SummarizationFilePathstring

摘要总结结果文件存放路径。

cloudNote/ksvxxppi/88_12/summarization_1724914365173.json
TextPolishFilePathstring

口语书面化结果文件存放路径。

cloudNote/ksvxxppi/88_12/textPolish_1724914365173.json
ServiceInspectionFilePathstring

服务质检结果文件存放路径。

cloudNote/ksvxxppi/88_12/serviceInspection_1724914365173.json
CustomPromptFilePathstring

自定义 prompt 结果文件存放路径。

cloudNote/ksvxxppi/88_12/customPrompt_1724914365173.json
Vendorinteger

参考开启任务 vendor。

1
Regioninteger

参考任务 region。

1
Bucketstring

用户自定义的 bucket。

sample-bucket
StartTslong

纪要任务开始时间。

1731939816837

纪要结果文件格式内容请参考回调页面

示例

正常返回示例

JSON格式

{
  "RequestId": "154EF5DE-3D08-1F2C-A482-281F78D74B7C",
  "PageNo": 1,
  "PageSize": 10,
  "TotalCnt": 10,
  "Items": [
    {
      "ChannelId": "testchannelId",
      "TaskId": "test001",
      "TranscriptionFilePath": "cloudNote/ksvxxppi/88_12/transcription_1724914365173.json",
      "AutoChaptersFilePath": "cloudNote/ksvxxppi/88_12/autoChapters_1724914365173.json",
      "MeetingAssistanceFilePath": "cloudNote/ksvxxppi/88_12/meetingAssistance_1724914365173.json",
      "SummarizationFilePath": "cloudNote/ksvxxppi/88_12/summarization_1724914365173.json",
      "TextPolishFilePath": "cloudNote/ksvxxppi/88_12/textPolish_1724914365173.json",
      "ServiceInspectionFilePath": "cloudNote/ksvxxppi/88_12/serviceInspection_1724914365173.json",
      "CustomPromptFilePath": "cloudNote/ksvxxppi/88_12/customPrompt_1724914365173.json",
      "Vendor": 1,
      "Region": 1,
      "Bucket": "sample-bucket",
      "StartTs": 1731939816837
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ApiParamErrorAPI %s.Api参数错误
403BizAppErrorA business application permission error occurred.业务应用权限错误
403BizUidErrorA business UID error occurred.业务主账号错误
500ServerInternalErrorAn internal error occurred.服务器内部错误

访问错误中心查看更多错误码。