Canva

获取评论

开发环境

GET

/rest/v1/designs/{designId}/comments/{commentId}

获得对设计的评论。

此 API 目前以预览版形式提供。请注意以下事项：

可能会有未公布的重大变化。

对预览 API 的任何重大更改都不会产生新的API 版本。

使用预览 API 的公共集成将不会通过审核流程，并且无法向所有 Canva 用户提供。

获取评论。有关评论及其在 Canva UI 中的使用方式的信息，请参阅 Canva 帮助中心。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/rest/v1/designs//comments/' \
--header 'Authorization: Bearer {token}'

响应示例

{
  "comment": {
    "type": "parent",
    "id": "KeAbiEAjZEj",
    "attached_to": {
      "design_id": "DAFVztcvd9z",
      "type": "design"
    },
    "message": "Great work [UAFZjbdfojE:BABdhiebEoe]!",
    "author": {
      "id": "uKakKUfI03Fg8k2gZ6OkT",
      "display_name": "John Doe"
    },
    "created_at": 1692928800,
    "updated_at": 1692928900,
    "mentions": {
      "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
        "user_id": "oUnPjZ2k2yuhftbWF7873o",
        "team_id": "oBpVhLW22VrqtwKgaayRbP",
        "display_name": "John Doe"
      }
    },
    "assignee": {
      "id": "uKakKUfI03Fg8k2gZ6OkT",
      "display_name": "John Doe"
    },
    "resolver": {
      "id": "uKakKUfI03Fg8k2gZ6OkT",
      "display_name": "John Doe"
    }
  }
}

请求参数

Path 参数

designId

string

设计 ID。

必需

commentId

string

id评论的。

必需

Header 参数

Authorization

string

必需

以令牌的形式提供凭证来验证请求Bearer。

示例值:

Bearer {token}

返回响应

🟢200成功

application/json

Body

comment

object

必需

type

string

必需

可以是下列之一： parent：评论类型。创建新的父级（顶级）评论时，type为parent。 reply：评论类型。创建对顶级评论的回复时，type为reply。

string

必需

评论的ID。您可以使用此 ID 通过创建回复 API创建对评论的回复。

attached_to

object

必需

识别有关注释所附加到的对象（例如设计）的信息。

message

string

必需

评论消息。这是 Canva UI 中显示的评论正文。用户提及以格式显示在此处[user_id:team_id]。

author

object

必需

用户的元数据，包括用户 ID 和显示名称。

created_at

integer

必需

评论或回复的创建时间，以 Unix 时间戳 (Unix 纪元以来的秒数) 表示。

updated_at

integer

必需

评论或回复的最后更新时间，以 Unix 时间戳 (Unix 纪元以来的秒数) 表示。

mentions

object

必需

评论中提到的 Canva 用户。

assignee

object

必需

用户的元数据，包括用户 ID 和显示名称。

resolver

object

必需

用户的元数据，包括用户 ID 和显示名称。

修改于 2024-06-26 09:37:19

创建评论

创建回复