创建

开发中

POST

{endpoint_url}/events

请求参数

Path 参数

endpoint_url

string

必需

示例值:

Header 参数

X-Shimo-Token

string

必需

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

X-Shimo-Sdk-Event

string

必需

用于识别具体的事件类型

示例值:

DateMention

Body 参数application/json

kind

string

必需

type

string

必需

action

string

必需

createData

object

必需

string

提醒 ID

必需

fileId

string

文件 ID

必需

authorId

string

创建者用户 ID

必需

content

string

提醒文字

必需

remindAt

string

提醒时间

必需

positionId

string

预留字段，暂无用途

必需

示例

{
  "kind": "mention",
  "type": "date_mention",
  "action": "create",
  "createData": {
    "id": "MlRFslp55Mrt19Iq", // 提醒 ID
    "fileId": "ac4ce108419f103c", // 文件 ID
    "authorId": "12", // 创建者用户 ID
    "content": "2022年01月19日, 周三", // 提醒文字
    "remindAt": "2021-12-07T15:00:00Z", // 提醒时间
    "positionId": "36" // 预留字段，暂无用途
  }
}

示例代码

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: DateMention	' \
--header 'Content-Type: application/json' \
--data-raw '{
  "kind": "mention",
  "type": "date_mention",
  "action": "create",
  "createData": {
    "id": "MlRFslp55Mrt19Iq", // 提醒 ID
    "fileId": "ac4ce108419f103c", // 文件 ID
    "authorId": "12", // 创建者用户 ID
    "content": "2022年01月19日, 周三", // 提醒文字
    "remindAt": "2021-12-07T15:00:00Z", // 提醒时间
    "positionId": "36" // 预留字段，暂无用途
  }
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

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

删除

修改