Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

创建待办任务

创建待办任务

请求说明

请求地址https://openapi.wps.cn/v7/todo/tasks
请求方法POST
签名方式KSO-1
权限要求查询和管理待办任务(应用授权) kso.task.readwrite

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

请求体(Body)

名称参数类型是否必填说明
actionsarray[object]操作行为
∟ keystring回调 key
∟ linkobject跳转 url
∟ ∟ mobile_urlstring移动端跳转链接
∟ ∟ pc_urlstringpc 跳转链接
∟ modalobject弹窗设置
∟ ∟ descstring弹窗提示文本
∟ ∟ titlestring弹窗标题
∟ stylestring[enum]按钮样式
normal:普通样式;secondary:辅助样式;disable:禁用样式
∟ textstring按钮文本
category_idstring待办分类 id
create_timeinteger创建时间(单位:毫秒)
creatorstring创建者
descriptionstring待办描述
display_timeinteger展示时间(预留,单位:毫秒)
due_timeinteger截止时间(单位:毫秒)
executorstring执行人 id
ext_attrsarray[object]预留扩展字段
∟ namestring属性名
∟ valuestring属性值
finish_timeinteger完成时间(单位:毫秒)
is_readboolean是否已读
linkobject待办任务跳转链接
∟ mobile_urlstring移动端跳转链接
∟ pc_urlstringpc 跳转链接
notify_configobject提醒设置
∟ remindersarray[object]推送人设置
∟ ∟ before_due_timeinteger提前推送时间(单位:分)
∟ switchboolean推送开关(默认开)
priorityinteger优先级 id
statusstring[enum]待办状态
todo:未完成;finish:已完成
tagsarray[string]标签
titleobject待办标题
∟ prefixstring前缀
∟ subjectstring主题

请求地址示例

[POST] https://openapi.wps.cn/v7/todo/tasks

请求体示例

json
{
  "actions": [
    {
      "key": "string",
      "link": {
        "mobile_url": "string",
        "pc_url": "string"
      },
      "modal": {
        "desc": "string",
        "title": "string"
      },
      "style": "string[enum]",
      "text": "string"
    }
  ],
  "category_id": "string",
  "create_time": 0,
  "creator": "string",
  "description": "string",
  "display_time": 0,
  "due_time": 0,
  "executor": "string",
  "ext_attrs": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "finish_time": 0,
  "is_read": false,
  "link": {
    "mobile_url": "string",
    "pc_url": "string"
  },
  "notify_config": {
    "reminders": [
      {
        "before_due_time": 0
      }
    ],
    "switch": false
  },
  "priority": 0,
  "status": "string[enum]",
  "tags": [
    "string"
  ],
  "title": {
    "prefix": "string",
    "subject": "string"
  }
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ task_idstring待办 id
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "task_id": "string"
  },
  "msg": "string"
}
回到旧版