开发工具

文档协作者协同状态变化

开发中

POST

{endpoint_url}/events

当文档当前参与协作的用户发生改变时，推送此事件。

事件可通过 action 的值区分用户行为：

enter 网络无异常情况下，进入文档，触发此事件。

leave 用户关闭文档或网络断开时，触发此事件。

请求参数

Path 参数

endpoint_url

string

必需

示例值:

Header 参数

X-Shimo-Credential-Type

string

必需

无法提供 token 的回调凭证类型

X-Shimo-Sdk-Event

string

必需

用于识别具体的事件类型

示例值:

Collaborator

X-Shimo-Signature

string

必需

当石墨无法提供接入方 Token 时，使用接入方对应 appId, secret 主动生成 signature 用于回调接口校验。

Body 参数application/json

kind

string

必需

action

string

必需

enter 或 leave 代表用户加入或退出协作

fileId

string

接入方文件 ID

必需

userId

string

接入方用户 ID

必需

collaboratorChanged

object

必需

clientId

string

必需

timestamp

integer

此事件产生的时间

必需

示例

{
  "kind": "collaborator",
  "action": "enter", // enter 或 leave 代表用户加入或退出协作
  "fileId": "file1", // 接入方文件 ID
  "userId": "user1", // 接入方用户 ID
  "collaboratorChanged": {
    // 一个用户可能有多个clientId参与同一个文档的协作
    "clientId": "47c8c791-9938-4f09-b76a-d6a2dc3cda5e"
  },
  "timestamp": 1635732089224 // 此事件产生的时间
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '/events' \
--header 'X-Shimo-Credential-Type;' \
--header 'X-Shimo-Sdk-Event: Collaborator' \
--header 'X-Shimo-Signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "kind": "collaborator",
  "action": "enter", // enter 或 leave 代表用户加入或退出协作
  "fileId": "file1", // 接入方文件 ID
  "userId": "user1", // 接入方用户 ID
  "collaboratorChanged": {
    // 一个用户可能有多个clientId参与同一个文档的协作
    "clientId": "47c8c791-9938-4f09-b76a-d6a2dc3cda5e"
  },
  "timestamp": 1635732089224 // 此事件产生的时间
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

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

文件内容更新

版本