画布评论元素统计

更新时间 2025/02/22 07:19:43

英飞画布服务端支持基于 REST API 根据画布 ID，获取该画布内的全部评论数据。

注：由于本功能为新增能力，本 API 仅能确保覆盖 2024/12/07 日起的画布内评论数据。

前提条件

• 已经完成英飞画布应用的创建动作，详见新人指引文档。
• 了解 REST API 请求的认证方式，详见获取 Access Token 文档。
• 持有创建画布接口返回的画布 ID。

请求路径

https://devc2c.plaso.cn/infi/api/v1/comment/list

请求参数

字段

类型

描述

必填

recordId

string

画布 ID

是

pageSize

integer

分页大小

否

pageIndex

integer

分页页码

否

请求 curl 示例

curl --location --request POST  \
      --header 'token: Access Token' \
      --header 'Content-Type: application/json' \
      --data '{
        "recordId": "SAMPlE_RECORD_ID",
        "pageSize": 100,
        "pageIndex": 1
      }'
      https:///devc2c.plaso.cn/infi/api/v1/comment/list

请求成功情况

响应的 Http 状态码为 200 时表示请求成功，请求成功返回数据示例如下：

{
  "total":1,
  "list": {
    "id": "SAMPLE_MSG_DATA_ID",
    "elementId": "SAMPLE_COMMENT_ELEMENT_ID",
    "commentId": "SAMPLE_MSG_ORDER_ID",
    "commentType": 0,
    "commentMessage": ["你好"],
    "commentAppend": null,
    "createdAt": 1732852602161,
    "updatedAt": 1732852602161
  }
}

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

字段

类型

描述

total

integer

总评论数

list

Array

评论数组

id

string

数据记录 ID

elementId

string

评论元素 ID

commentId

string

评论消息 ID

commentType

integer

评论消息类型，详见下方描述

commentMessage

Array<string>

文本消息，数组内每个元素代表一个段落，与 commentAppend 互斥

commentAppend

Object

文件类数据，与 commentMessage 互斥

createdAt

integer

评论消息创建时间

updatedAt

integer

评论消息更新时间

commentType 评论消息类型包括：

• 0: 文本类型
• 1：音频类型
• 2：视频类型
• 3：图片类型
• 4：文件类型

请求失败情况

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