在评论中 at

开发中

POST

{endpoint_url}events

请求参数

Path 参数

endpoint_url

string

必需

示例值:

Header 参数

X-Shimo-Token

string

必需

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

X-Shimo-Sdk-Event

string

必需

用于识别具体的事件类型

示例值:

MentionAt

Body 参数application/json

kind

string

必需

type

string

必需

子分类，comment、discussion、mention_at

action

string

create 等

必需

fileId

string

接入方文件 ID

必需

userId

string

接入方用户 ID

必需

comment

object

必需

guid

string

评论 ID

必需

selectionGuid

string

评论划词 ID

必需

selectionContent

string

选中文字

必需

content

string

评论内容

必需

userIds

array[string]

评论中 @ 的用户

必需

示例

{
  "kind": "mention_at",
  "type": "comment", // 子分类，comment、discussion、mention_at
  "action": "create", // create 等
  "fileId": "file1", // 接入方文件 ID
  "userId": "user1", // 接入方用户 ID
  "comment": {
    "guid": "yAvBcaQON88pGq5C", // 评论 ID
    "selectionGuid": "comment-MSS0l7ZjOzoDzs8M", // 评论划词 ID
    "selectionContent": "123123", // 选中文字
    "content": "@zhangsan @lisi 123", // 评论内容
    "userIds": ["user1", "user2"] // 评论中 @ 的用户
  }
}

示例代码

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: MentionAt' \
--header 'Content-Type: application/json' \
--data-raw '{
  "kind": "mention_at",
  "type": "comment", // 子分类，comment、discussion、mention_at
  "action": "create", // create 等
  "fileId": "file1", // 接入方文件 ID
  "userId": "user1", // 接入方用户 ID
  "comment": {
    "guid": "yAvBcaQON88pGq5C", // 评论 ID
    "selectionGuid": "comment-MSS0l7ZjOzoDzs8M", // 评论划词 ID
    "selectionContent": "123123", // 选中文字
    "content": "@zhangsan @lisi 123", // 评论内容
    "userIds": ["user1", "user2"] // 评论中 @ 的用户
  }
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

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

发送讨论消息

在讨论中 at