创建评论 - Canva

对设计创建新评论。

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

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

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

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

在设计上创建新的顶级评论。有关评论及其在 Canva UI 中的使用方式的信息，请参阅 Canva 帮助中心。一个设计最多可以有 1000 条评论。

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

{ "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" } } }

请求参数

Header 参数

Authorization

string

必需

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

示例值:

Bearer {token}

Content-Type

string

必需

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

示例值:

application/json

Body 参数application/json

attached_to

object

必需

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

design_id

string

必需

type

string

必需

message

string

必需

评论消息。这是 Canva UI 中显示的评论正文。您还可以在消息中提及用户，方法是使用格式指定其用户 ID 和团队 ID [user_id:team_id]。如果assignee_id指定了参数，则必须在消息中提及受让人。

assignee_id

string

可选

允许您使用用户 ID 将评论分配给 Canva 用户。您必须在中提及分配的用户message。

示例

返回响应

🟢200成功

application/json

Body

comment

object

必需

评论类型。创建新的父（顶级）评论时，type为parent。

type

string

必需

评论类型。创建新的父（顶级）评论时，type为parent。

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 和显示名称。