跳到主要内容

获取评论列表

更新时间 2025/02/27 09:24:51

英飞画布服务端支持基于 Restful API 获取通过开发者门户创建的模板列表信息。

前提条件​

请求路径​

https://developer.infi.cn/infi/api/v1/comment/groupList
  • 请求参数
字段
类型
描述
recordId
string
画布ID
pageSize
integer
分页大小
pageIndex
integer
分页页码

请求 curl 示例​

curl --location --request POST \
      --header 'token: YOUR_ACCESS_TOKEN' \
      --header 'Content-Type: application/json' \
      --data '{
        "recordId": "SAMPlE_RECORD_ID",
        "pageIndex": 1
        "pageSize": 10,
      }'
      https://developer.infi.cn/infi/api/v1/comment/groupList

请求成功情况​

响应的 Http 状态码为 200 时表示请求成功，并会返回模板列表信息。

请求成功返回数据示例如下:

{
    "total": 1,
    "list": [
        {
            "elementId": "ELEMENT_ID",
            "list": [
                {
                    "id": "ID",
                    "commentId": "COMMENT_ID",
                    "commentType": "TYPE",
                    "commentMessage": ["comment"],
                    "commentAppend": {
                        "duration": 0,
                        "ext": "wav",
                        "fileId": "FILE_ID",
                        "name": "NAME",
                        "size": 0,
                    },
                     "createdAt": 1740213011086,
                     "updatedAt": 1740213011086,
                }
            ]
        }
    ]
}

成功返回的字段说明如下：

字段
类型
描述
total
number
标签总数
list
ArrayElementDataType
标签数组，数组元素结构请参考下方说明

ElementDataType 结构体说明如下：

字段
类型
描述
elementId
string
批注标签 ID
list
ArrayCommentDataType
标签内评论数组，数组元素结构请参考下方说明

CommentDataType 结构体说明如下：

字段
类型
描述
id
string
记录 ID
commentId
integer
评论 ID
commentType
integer
评论类型：0文本，1音频，2视频，3图片，4文件
commentMessage
array[string]
文本评论
commentAppend
object AppendDataType
附件评论对象，对象结构参考下方说明
createdAt
integer
创建时间
updatedAt
integer
更新时间

AppendDataType 结构体说明如下：

字段
类型
描述
duration
integer
文件时长
ext
string
文件扩展名
fileId
string
文件 ID
name
string
文件名称
size
integer
文件大小

请求失败情况​

响应的 Http 状态码不为 200 时表示请求失败，如需更多信息请参考请求错误说明文档。