400-158-0245

概述

网页与手机端开发

系统架构

网页端开发

手机端开发

常见问题

API接口文档

说明

用户接口

文件核心操作接口

文件管理接口

其它文件操作接口

审批接口

讨论接口

快捷方式/发布接口

消息/提醒接口

多媒体接口

 

消息/提醒接口

1、设置文件/文件夹定时提醒、变动提醒

URI: /app/notice/set

POST参数:

token: token参数

fileId: 文件或文件夹的ID

type1: 是否开启文件变动提醒,其值为0不开启,1开启

type2: 是否开启定时提醒,其值为0开启,1不开启

ndesc: 提醒事由,仅type2=1有意义

ntime: 定时提醒时间,unix时间戳,仅type2=1有意义

注意要点:

1)、如果当前是文件夹,文件变动提醒对该文件夹下的一级子文件/子文件夹都生效(即子文件有变动,都会触发文件变动提醒)

2)、要取消提醒只需要把type1,type2的值设为0即可

2、获取当前用户对某个文件/文件夹的提醒设置

URI: /app/notice/info

POST参数:

token: token参数

fileId: 文件或文件夹的ID

返回的json中,json.data为一个列表,其每一项中:

nType=1为文件变动提醒,2为定时提醒

如果nType=2,param1为unix时间戳,表时定时时间,param2为提醒事由

3、查看当前用户的所有提醒设置

URI: /app/notice/list

POST参数:

token: token参数

返回的json中,json.data为一个列表,其每一项中:

fileId: 文件或文件夹ID

filePath: 文件或文件夹路径

nType: 其值为1表示文件变动提醒,2表示定时提醒

4、获取当前用户的所有消息

URI: /app/notice/msg-list

POST参数:

token: token参数

type: 消息类型,其值为0表示所有消息,其它值的意义如下:

1、文件变动提醒

2、定时提醒

3、审批结束提醒

4、审批抄送提醒

5、处理审批提醒

6、讨论提醒

7、接收文件提醒

返回值中,json.count表示未读的消息条数,json.data为一个列表,其每一项中

id: 消息ID

nType: 消息类型,与输入参数type表示的意义一致

content: 消息内容

createtime: 消息产生时间

username/realname: 消息相关用户的用户名与真实姓名

status: 消息状态,0表示未读,1表示已读

5、把消息设为已读

URI: /app/notice/set-msg-read

POST参数:

token: token参数

mid: 消息ID,可通过/app/notice/msg-list接口获取

6、确认收到通知

URI: /app/notice/set-notice-read

POST参数:

token: token参数

说明:用户每获得一条新的消息,同步接口/app/user/sync的json.data.noticeMsg会一直有新消息的内容,此时调用本接口,json.data.noticeMsg将被清空,本接口与同步接口配合,可实现在用户桌面弹出消息提示(及提示音)的功能