添加评论

开发中

POST

{endpoint_url}/events

请求参数

Path 参数

endpoint_url

string

必需

示例值:

Header 参数

X-Shimo-Token

string

必需

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

X-Shimo-Sdk-Event

string

必需

用于识别具体的事件类型

示例值:

Comment

Body 参数application/json

kind

string

必需

type

string

必需

action

string

必需

fileId

string

必需

userId

string

必需

comment

object

必需

guid

string

评论 ID

必需

selectionGuid

string

划词高亮区域 ID

必需

content

string

评论内容

必需

userIds

array[string]

必需

评论中 at 的用户，若无则为空

示例

{
  "kind": "comment",
  "type": "comment",
  "action": "create",
  "fileId": "691f6abc72f769a4",
  "userId": "1",
  "comment": {
    "guid": "ZwOJjlTDHcPda0V4", // 评论 ID
    "selectionGuid": "comment-Y29tbWVudD05Ng==", // 划词高亮区域 ID
    "content": "3123123", // 评论内容
    "userIds": ["user1"] // 评论中 at 的用户，若无则为空
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '/events' \
--header 'X-Shimo-Token;' \
--header 'X-Shimo-Sdk-Event: Comment' \
--header 'Content-Type: application/json' \
--data-raw '{
  "kind": "comment",
  "type": "comment",
  "action": "create",
  "fileId": "691f6abc72f769a4",
  "userId": "1",
  "comment": {
    "guid": "ZwOJjlTDHcPda0V4", // 评论 ID
    "selectionGuid": "comment-Y29tbWVudD05Ng==", // 划词高亮区域 ID
    "content": "3123123", // 评论内容
    "userIds": ["user1"] // 评论中 at 的用户，若无则为空
  }
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

修改于 2024-03-19 08:39:27

结束评论

删除评论