创建回复

开发环境

POST

/rest/v1/comments/{commentId}/replies

回复对设计的评论。

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

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

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

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

创建对设计中评论的回复。要回复现有的评论主题，您可以使用id父评论（原始评论）的，或thread_id主题中评论的。每个评论最多可以创建 100 条回复。

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

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/rest/v1/comments//replies' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "attached_to": {
    "design_id": "DAFVztcvd9z",
    "type": "design"
  },
  "message": "Thanks!"
}'

响应示例

{
  "comment": {
    "type": "reply",
    "id": "KeAZEAjijEb",
    "attached_to": {
      "design_id": "DAFVztcvd9z",
      "type": "design"
    },
    "message": "Thanks!",
    "author": {
      "id": "uKakKUfI03Fg8k2gZ6OkT",
      "display_name": "John Doe"
    },
    "created_at": 1692929800,
    "updated_at": 1692929900,
    "mentions": {
      "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
        "user_id": "oUnPjZ2k2yuhftbWF7873o",
        "team_id": "oBpVhLW22VrqtwKgaayRbP",
        "display_name": "John Doe"
      }
    },
    "thread_id": "KeAbiEAjZEj"
  }
}

请求参数

Path 参数

commentId

string

id评论的。

必需

Header 参数

Authorization

string

必需

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

示例值:

Bearer {token}

Content-Type

string

必需

指示请求中发送的信息的媒体类型。必须设置为application/json。

示例值:

application/json

Body 参数application/json

attached_to

object

必需

包含您想要附加注释的设计或其他对象的识别信息的对象。

design_id

string

必需

您想要附加此评论的设计的 ID。

type

string

必需

可以是下列之一： design：如果评论附加到 Canva 设计。

message

string

必需

回复评论消息。这是 Canva UI 中显示的回复评论正文。您还可以在消息中提及用户，通过使用格式指定他们的用户 ID 和团队 ID [user_id:team_id]。

示例

返回响应

🟢200成功

application/json

Body

comment

object

必需

关于回复评论的数据，包括消息、作者以及评论所附加的对象（例如设计）。

type

string

必需

评论类型。创建对顶级评论的回复时，type为reply。

string

评论的ID。

必需

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

必需

thread_id

string

必需

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

获取评论

概述