创建待阅

POST

/apps/v1/to-read

接口描述：企业应用在开启待阅功能后可以通过接口创建待阅。
请求地址：https://service.cheng-xun.cn/api/apps/v1/to-read?access_token={access_token}
请求方式：POST

请求参数

Authorization

Query 参数

access_token

string

应用的访问凭证

必需

Header 参数

User-Agent

string

可选

默认值:

Body 参数application/json

待阅信息

title

string

标题

必需

待阅标题

description

string

详情

必需

待阅详情，换行使用\n表示

third_id

string

必需

待阅唯一id，由三方应用自己生成，id只能包括英文大小写字母、数字、- 或 _，大小写不区分

jump_action

string

跳转参数

必需

待阅通知跳转参数

end_time

string

结束时间

可选

需包含时区，格式"yyyy-MM-dd HH:mm:ss Z"，例如"2024-07-10 08:00:00 +0800"

remind_time

string

提醒时间

可选

需包含时区，格式"yyyy-MM-dd HH:mm:ss Z"，例如"2024-07-10 08:00:00 +0800"，如果结束时间不为空，则不得晚于结束时间

executor_ids

array[string]

执行人ID列表

必需

执行人 account id 列表，不得为空列表，最多支持1000人

示例

{
    "title": "string",
    "description": "string",
    "third_id": "string",
    "jump_action": "string",
    "end_time": "string",
    "remind_time": "string",
    "executor_ids": [
        "string"
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://service.cheng-xun.cn/api/apps/v1/to-read?access_token' \
--header 'User-Agent: CX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "string",
    "description": "string",
    "third_id": "string",
    "jump_action": "string",
    "end_time": "string",
    "remind_time": "string",
    "executor_ids": [
        "string"
    ]
}'

返回响应

🟢200成功

application/json

Body

com.westone.aac.dto.thirdapp.ThirdAppResponseDTO

err_code

integer

可选

err_msg

string

可选

默认值:

ErrorCode.SUCCESS.getErrMsg()

示例

{
  "errCode": 0,
  "errMsg": ""
}

修改于 2025-04-01 02:36:03

概述

更新待阅

创建待阅

接口描述：企业应用在开启待阅功能后可以通过接口创建待阅。请求地址：https://service.cheng-xun.cn/api/apps/v1/to-read?access_token={access_token}请求方式：POST#

请求参数

示例代码

返回响应

接口描述：企业应用在开启待阅功能后可以通过接口创建待阅。
请求地址：https://service.cheng-xun.cn/api/apps/v1/to-read?access_token={access_token}
请求方式：POST