添加评论

开发中

POST{endpoint_url}/events

请求参数

Path 参数

endpoint_url

string

必需

示例值:

Header 参数

X-Shimo-Token

string

必需

用于接入方对本次请求鉴权

X-Shimo-Sdk-Event

string

必需

用于识别具体的事件类型

示例值:

Comment

kind

string

必需

type

string

必需

预留评论下的小分类，目前就 comment

action

string

业务操作

必需

fileId

string

接入方文件 ID

必需

userId

string

接入方用户 ID

必需

comment

object

必需

guid

string

评论 ID

必需

content

string

评论内容

必需

userIds

array[string]

必需

评论中若有 at 用户，此参数会传递一份，也可通过 mention_at 事件中获取

selectionGuid

string

必需

评论划词高亮区域的 ID

selectionContent

string

必需

{
  "kind": "comment",
  "type": "comment", // 预留评论下的小分类，目前就 comment
  "action": "create", // 业务操作
  "fileId": "file1", // 接入方文件 ID
  "userId": "user1", // 接入方用户 ID
  "comment": {
    "guid": "wS2uTQBMuujrwaGZ", // 评论 ID
    "content": "这是评论内容", // 评论内容
    "userIds": ["user1", "user2"], // 评论中若有 at 用户，此参数会传递一份，也可通过 mention_at 事件中获取
    "selectionGuid": "comment-Ynimup3kBXoxwF4j", // 评论划词高亮区域的 ID
    "selectionContent": "123123123123"
  }
}

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

object {0}

{}

最后修改时间： 8 个月前