事件列表

更新企业

企业更新（kso.company.update）

基本信息

字段	内容
事件名称	企业更新
事件 Key	`kso.company.update`
所需权限	查询通讯录信息 `kso.contact.read`
Topic	`kso.company`
操作类型	update

事件说明

触发场景：管理后台-企业概况，修改企业名称/头像

事件体示例

json

{
  "companies": [
    {
      "company_id": "123",
      "src": {
        "name": "New Company Name",
        "status": "Active"
      }
    }
  ]
}

创建部门

创建部门（kso.dept.create）

基本信息

字段	内容
事件名称	创建部门
事件 Key	`kso.dept.create`
所需权限	查询通讯录信息 `kso.contact.read`
Topic	`kso.dept`
操作类型	create

事件说明

触发场景：管理后台-通讯录-组织架构，点击企业或企业下部门，在右侧界面点击添加子部门，或在企业或企业下部门选项末尾点击三黑点，后在弹窗点击添加子部门

事件体示例

json

{
  "company_id": "",
  "depts": [
    {
      "company_id": "123",
      "dept_id": "456",
      "ex_dept_id": "456",
      "create_source": "adm_create",
      "src": {
        "name": "xxx",
        "parent_id": "789",
        "ex_parent_id": "789"
      }
    }
  ]
}

更新部门

更新部门（kso.dept.update）

基本信息

字段	内容
事件名称	更新部门
事件 Key	`kso.dept.update`
所需权限	查询通讯录信息 `kso.contact.read`
Topic	`kso.dept`
操作类型	update

事件说明

触发场景：管理后台-通讯录-组织架构，点击企业或企业下部门，在右侧界面点击编辑部门，或在企业或企业下部门选项末尾点击三黑点，后在弹窗点击编辑部门。对编辑部门界面中部门名称、部门负责人、部门类型进行修改

事件体示例

json

{
  "depts": [
    {
      "company_id": "123",
      "dept_id": "456",
      "src": {
        "name": "xxx",
        "parent_id": "789",
        "ex_parent_id": "789"
      }
    }
  ]
}

删除部门

删除部门（kso.dept.delete）

基本信息

字段	内容
事件名称	删除部门
事件 Key	`kso.dept.delete`
所需权限	查询通讯录信息 `kso.contact.read`
Topic	`kso.dept`
操作类型	delete

事件说明

触发场景：管理后台-通讯录-组织架构，在企业下部门选项末尾点击三黑点，后在弹窗点击删除部门

事件体示例

json

{
  "depts": [
    {
      "company_id": "123",
      "dept_id": "456",
      "ex_dept_id": "456",
      "src": {
        "name": "xxx",
        "parent_id": "789",
        "ex_parent_id": "789"
      }
    }
  ]
}

创建成员

创建成员（kso.user.create）

基本信息

字段	内容
事件名称	创建成员
事件 Key	`kso.user.create`
所需权限	查询通讯录信息 `kso.contact.read`
Topic	`kso.user`
操作类型	create

事件说明

触发场景：管理后台-通讯录-组织架构，点击企业或企业下部门，在右侧界面点击[添加]，输入员工信息，点击[保存并继续添加]或[添加]

事件体示例

json

{
  "company_id": "123",
  "users": [
    {
      "company_id": "123",
      "user_id": "456",
      "ex_user_id": "456",
      "src": {
        "dept_ids": ["789","012"],
        "ex_dept_ids": ["789","012"],
        "name": "New User Name",
        "role": "Admin",
        "email": "newuser@example.com",
        "phone": "123456789",
        "avatar": "http://example.com/avatar.jpg",
        "nick_name": "new_nick",
        "user_name": "",
        "alias_name": "",
        "status": "Active"
      }
    }
  ]
}

更新成员

更新成员（kso.user.update）

基本信息

字段	内容
事件名称	更新成员
事件 Key	`kso.user.update`
所需权限	查询通讯录信息 `kso.contact.read`
Topic	`kso.user`
操作类型	update

事件说明

触发场景：管理后台-通讯录-组织架构，点击企业或企业下部门，在右侧界面各个员工信息末尾点击[编辑]，修改员工各项信息，点击[保存]

事件体示例

json

{
  "users": [
    {
      "company_id": "123",
      "user_id": "456",
      "ex_user_id": "456",
      "src": {
        "dept_ids": ["789","012"],
        "ex_dept_ids": ["789","012"],
        "name": "New User Name",
        "role": "Admin",
        "email": "newuser@example.com",
        "phone": "123456789",
        "avatar": "http://example.com/avatar.jpg",
        "nick_name": "new_nick",
        "user_name": "",
        "alias_name": "",
        "status": "Active"
      }
    }
  ]
}

删除成员

删除成员（kso.user.delete）

基本信息

字段	内容
事件名称	删除成员
事件 Key	`kso.user.delete`
所需权限	查询通讯录信息 `kso.contact.read`
Topic	`kso.user`
操作类型	delete

事件说明

触发场景：管理后台-通讯录-组织架构，点击企业或企业下部门，在右侧界面员工信息处勾选非企业拥有者的员工，点击删除

事件体示例

json

{
  "users": [
    {
      "company_id": "123",
      "user_id": "456",
      "ex_user_id": "456",
      "src": {
        "dept_ids": ["789","012"],
        "ex_dept_ids": ["789","012"],
        "name": "New User Name",
        "role": "Admin",
        "email": "newuser@example.com",
        "phone": "123456789",
        "avatar": "http://example.com/avatar.jpg",
        "nick_name": "new_nick",
        "user_name": "",
        "alias_name": "",
        "status": "Active"
      }
    }
  ]
}

成员状态变更

成员状态变更（kso.user.status.update）

基本信息

字段	内容
事件名称	成员状态变更
事件 Key	`kso.user.status.update`
所需权限	查询通讯录信息 `kso.contact.read`
Topic	`kso.user.status`
操作类型	update

事件说明

触发场景：管理后台-通讯录-组织架构，点击企业或企业下部门，在右侧界面员工信息处勾选非企业拥有者的员工，点击禁用

事件体示例

json

{
  "users": [
    {
      "company_id": "123",
      "user_id": "456",
      "ex_user_id": "456",
      "src": {
        "dept_ids": ["789","012"],
        "ex_dept_ids": ["789","012"],
        "name": "New User Name",
        "role": "Admin",
        "email": "newuser@example.com",
        "phone": "123456789",
        "avatar": "http://example.com/avatar.jpg",
        "nick_name": "new_nick",
        "status": "Active"
      }
    }
  ]
}

用户登录创建会话

用户登录创建会话（kso.user.session.create）

基本信息

字段	内容
事件名称	用户登录创建会话
事件 Key	`kso.user.session.create`
所需权限	查询通讯录信息 `kso.contact.read`
Topic	`kso.user.session`
操作类型	create

事件说明

触发场景：私网环境协作用户登录

事件体示例

json

{
  "company_id": "123",
  "user_id": "222",
  "ex_user_id": "222",
  "device_id": "333",
  "session_id": "444",
  "app_name": "555",
  "device_name": "666",
  "reason": "用户下线"
}

用户设备下线

用户设备下线（kso.user.session.delete）

基本信息

字段	内容
事件名称	用户设备下线
事件 Key	`kso.user.session.delete`
所需权限	查询通讯录信息 `kso.contact.read`
Topic	`kso.user.session`
操作类型	delete

事件说明

触发场景：私网环境协作用户退出登录

事件体示例

json

{
  "company_id": "123",
  "user_id": "222",
  "ex_user_id": "222",
  "device_id": "333",
  "session_id": "444",
  "app_name": "555",
  "device_name": "666",
  "reason": "用户下线"
}

成员重置密码

成员重置密码（kso.user.password.update）

基本信息

字段	内容
事件名称	成员重置密码
事件 Key	`kso.user.password.update`
所需权限	查询通讯录信息 `kso.contact.read`
Topic	`kso.user.password`
操作类型	update

事件说明

触发场景：私网环境协作，点击左下角头像，点击[设置]，点击[账号与安全]，点击[前往账号安全中心]，在修改密码选项点击[修改]

事件体示例

json

{
  "company_id": "123",
  "users": [
    {
      "company_id": "123",
      "user_id": "456",
      "ex_user_id": "456",
      "src": {
        "dept_ids": ["789","012"],
        "ex_dept_ids": ["789","012"],
        "name": "New User Name",
        "role": "Admin",
        "email": "newuser@example.com",
        "phone": "123456789",
        "avatar": "http://example.com/avatar.jpg",
        "nick_name": "new_nick",
        "status": "Active"
      }
    }
  ]
}

复制文件

复制文件（kso.file.copy）

基本信息

字段	内容
事件名称	复制文件
事件 Key	`kso.file.copy`
所需权限	查询和管理文件 `kso.file.readwrite`
Topic	`kso.file`
操作类型	copy

事件说明

触发场景：私网环境协作，点击左侧工具栏[文档图标]，在文档界面点击某一文件末尾[三黑点]，在弹出菜单点击[复制]后选择要复制到的位置点击[粘贴]；或勾选文件，点击文件区域上方[复制]

事件体示例

json

{
  "company_id": "123",
  "src_drive_id": "src_drive_123",
  "size": 1024,
  "version": 1,
  "type": "file",
  "name": "example.txt",
  "ctime": 1638212389,
  "mtime": 1638212395,
  "operator": {
    "id": "456",
    "name": "John Doe",
    "avatar": "http://example.com/avatar.jpg",
    "company_id": "789",
    "type": "user"
  },
  "src_drive_source": "src_drive_source_123",
  "src_file_id": "src_file_789",
  "src_parent_id": "src_parent_456",
  "dst_drive_id": "dst_drive_456",
  "dst_drive_source": "dst_drive_source_456",
  "dst_file_id": "dst_file_789",
  "dst_parent_id": "dst_parent_456"
}

删除文件

删除文件（kso.file.delete）

基本信息

字段	内容
事件名称	删除文件
事件 Key	`kso.file.delete`
所需权限	查询和管理文件 `kso.file.readwrite`
Topic	`kso.file`
操作类型	delete

事件说明

触发场景：私网环境协作，点击左侧工具栏[文档图标]，在文档界面点击某一文件末尾[三黑点]，在弹出菜单点击[删除]；或勾选文件，点击文件区域上方[删除]

事件体示例

json

{
  "company_id": "123",
  "drive_id": "drive_456",
  "mtime": 1638212395,
  "drive_source": "drive_source_789",
  "file_id": "file_123",
  "parent_id": "parent_456",
  "deleted_by": {
    "id": "789",
    "name": "Alice",
    "avatar": "http://example.com/avatar_alice.jpg",
    "company_id": "456",
    "type": "user"
  },
  "size": 2048,
  "type": "file",
  "name": "deleted_file.txt",
  "ctime": 1638212389
}

移动文件

移动文件（kso.file.move）

基本信息

字段	内容
事件名称	移动文件
事件 Key	`kso.file.move`
所需权限	查询和管理文件 `kso.file.readwrite`
Topic	`kso.file`
操作类型	move

事件说明

触发场景：私网环境协作，点击左侧工具栏[文档图标]，在文档界面点击某一文件末尾[三黑点]，在弹出菜单点击[移动]后选择要移动到的位置点击[移动]；或勾选文件，点击文件区域上方[移动]；或打开某一文件，点击左上角[三横杠]，在弹出菜单点击[移动]

事件体示例

json

{
  "company_id": "123",
  "src_drive_id": "src_drive_123",
  "size": 1024,
  "version": 1,
  "type": "file",
  "name": "example.txt",
  "ctime": 1638212389,
  "mtime": 1638212395,
  "operator": {
    "id": "456",
    "name": "John Doe",
    "avatar": "http://example.com/avatar.jpg",
    "company_id": "789",
    "type": "user"
  },
  "src_drive_source": "src_drive_source_123",
  "src_file_id": "src_file_789",
  "src_parent_id": "src_parent_456",
  "dst_drive_id": "dst_drive_456",
  "dst_drive_source": "dst_drive_source_456",
  "dst_file_id": "dst_file_789",
  "dst_parent_id": "dst_parent_456"
}

创建文件

创建文件（kso.file.create）

基本信息

字段	内容
事件名称	创建文件
事件 Key	`kso.file.create`
所需权限	查询和管理文件 `kso.file.readwrite`
Topic	`kso.file`
操作类型	create

事件说明

触发场景：私网环境协作，点击左侧工具栏[文档图标]，在文档界面点击[新建]，选择文件类型或文件夹。或在文档界面点击某团队文档，在右侧文件列表上方点击[新建]

事件体示例

json

{
  "company_id": "123",
  "drive_id": "drive_456",
  "mtime": 1638212395,
  "drive_source": "drive_source_789",
  "file_id": "file_123",
  "parent_id": "parent_456",
  "operator": {
    "id": "789",
    "name": "Alice",
    "avatar": "http://example.com/avatar_alice.jpg",
    "company_id": "456",
    "type": "user"
  },
  "size": 2048,
  "type": "file",
  "name": "deleted_file.txt",
  "ctime": 1638212389
}

上传文件

上传文件（kso.file.upload）

基本信息

字段	内容
事件名称	上传文件
事件 Key	`kso.file.upload`
所需权限	查询和管理文件 `kso.file.readwrite`
Topic	`kso.file`
操作类型	upload

事件说明

触发场景：私网环境协作，点击左侧工具栏[文档图标]，在文档界面点击[导入]，选择[上传文件]或[上传文件夹]。或在文档界面点击某团队文档，在右侧文件列表上方点击[导入]

事件体示例

json

{
  "company_id": "123",
  "drive_id": "drive_456",
  "mtime": 1638212395,
  "drive_source": "drive_source_789",
  "file_id": "file_123",
  "parent_id": "parent_456",
  "operator": {
    "id": "789",
    "name": "Alice",
    "avatar": "http://example.com/avatar_alice.jpg",
    "company_id": "456",
    "type": "user"
  },
  "size": 2048,
  "type": "file",
  "name": "deleted_file.txt",
  "ctime": 1638212389
}

编辑文件

编辑文件（kso.file.update）

基本信息

字段	内容
事件名称	编辑文件
事件 Key	`kso.file.update`
所需权限	查询和管理文件 `kso.file.readwrite`
Topic	`kso.file`
操作类型	update

事件说明

触发场景：私网环境协作，点击左侧工具栏[文档图标]，在文档界面点击某一文件并进行编辑

事件体示例

json

{
  "company_id": "123",
  "drive_id": "drive_456",
  "mtime": 1638212395,
  "drive_source": "drive_source_789",
  "file_id": "file_123",
  "parent_id": "parent_456",
  "operator": {
    "id": "789",
    "name": "Alice",
    "avatar": "http://example.com/avatar_alice.jpg",
    "company_id": "456",
    "type": "user"
  },
  "size": 2048,
  "type": "file",
  "name": "deleted_file.txt",
  "ctime": 1638212389,
  "update_source": "yundoc"
}

重命名文件

重命名文件（kso.file.rename）

基本信息

字段	内容
事件名称	重命名文件
事件 Key	`kso.file.rename`
所需权限	查询和管理文件 `kso.file.readwrite`
Topic	`kso.file`
操作类型	rename

事件说明

触发场景：私网环境协作，点击左侧工具栏[文档图标]，在文档界面点击某一文件末尾[三黑点]，在弹出菜单点击[重命名]；或打开某一文件，点击左上角[三横杠]，在弹出菜单点击[文件管理]后点击[重命名]

事件体示例

json

{
  "company_id": "123",
  "drive_id": "drive_456",
  "mtime": 1638212395,
  "drive_source": "drive_source_789",
  "file_id": "file_123",
  "parent_id": "parent_456",
  "operator": {
    "id": "789",
    "name": "Alice",
    "avatar": "http://example.com/avatar_alice.jpg",
    "company_id": "456",
    "type": "user"
  },
  "size": 2048,
  "type": "file",
  "name": "deleted_file.txt",
  "ctime": 1638212389
}

待办创建

待办创建（kso.todo_task.change.create）

基本信息

字段	内容
事件名称	待办创建
事件 Key	`kso.todo_task.change.create`
所需权限	待办信息 `kso.task.read`
Topic	`kso.todo_task.change`
操作类型	create

事件说明

触发场景：私网环境协作，点击左侧工具栏[工具台图标]，在工具台界面点击[待办中心]，点击[新建待办]

事件体示例

json

{
  "task_id": "10809",
  "company_id": "1",
  "app_id": "AK20231201QNPMBT"
}

待办更新

待办更新（kso.todo_task.change.update）

基本信息

字段	内容
事件名称	待办更新
事件 Key	`kso.todo_task.change.update`
所需权限	待办信息 `kso.task.read`
Topic	`kso.todo_task.change`
操作类型	update

事件说明

触发场景：私网环境协作，点击左侧工具栏[工具台图标]，在工具台界面点击[待办中心]，在待办列表点击某一待办任务，在右侧弹出抽屉中修改待办名称、添加/移除参与人、修改待办截止时间、将待办任务状态修改为已完成

事件体示例

json

{
  "task_id": "10809",
  "company_id": "1",
  "app_id": "AK20231201QNPMBT"
}

待办删除

待办删除（kso.todo_task.change.delete）

基本信息

字段	内容
事件名称	待办删除
事件 Key	`kso.todo_task.change.delete`
所需权限	待办信息 `kso.task.read`
Topic	`kso.todo_task.change`
操作类型	delete

事件说明

触发场景：私网环境协作，点击左侧工具栏[工具台图标]，在工具台界面点击[待办中心]，在待办列表点击某一待办任务末尾[三黑点]，在弹出菜单点击[删除]；或点击某一待办任务，在右侧弹出抽屉中点击右上角[三黑点]，在弹出菜单中点击[删除待办]

事件体示例

json

{
  "task_id": "10809",
  "company_id": "1",
  "app_id": "AK20231201QNPMBT"
}

日程变更

日程变更（kso.calendar.event.update）

基本信息

字段	内容
事件名称	日程变更
事件 Key	`kso.calendar.event.update`
所需权限	查询日程 `kso.calendar_events.read`
Topic	`kso.calendar.event`
操作类型	update

事件说明

触发场景：私网环境协作，点击左侧工具栏[日历图标]，在日历界面点击某一日程，点击弹出悬浮窗口上方[笔型图标]，在跳转界面对日程进行修改

事件体示例

json

{
  "event": {
    "id": "1",
    "organizer_calendar_id": "121",
    "calendar_list": [
      {"calendar_id": "121"},
      {"calendar_id": "122"}
    ]
  }
}

创建审批

创建审批（kso.workflow.create）

基本信息

字段	内容
事件名称	创建审批
事件 Key	`kso.workflow.create`
所需权限	查询审批实例 `kso.workflow_approval_instance.read`
Topic	`kso.workflow`
操作类型	create

事件说明

触发场景：私网环境协作，点击左侧工具栏[工具台图标]，在工具台界面点击[轻审批]，在轻审批界面创建一条审批单

事件体示例

json

{
  "id": "1972",
  "event_type": "task_event",
  "ctime": 1725952980,
  "event_task": {
    "approval_define_id": "Xam3xK9E62BzKPWGewJygA40l5",
    "extra": {
      "rollback_node_id": "",
      "add_sign_user_ids": ["281249626"],
      "ex_add_sign_user_ids": ["281249626"]
    },
    "instance_id": "4arDwM8peAXWDBjY9JRn2bo1K6",
    "node_id": "7",
    "status": "pending",
    "task_id": "833",
    "user_id": "281249626",
    "ex_user_id": "11"
  },
  "event_instance": {
    "approval_define_id": "Xam3xK9E62BzKPWGewJygA40l5",
    "creator": "280310411",
    "ex_creator": "280310411",
    "instance_id": "4arDwM8peAXWDBjY9JRn2bo1K6",
    "status": "auditing"
  },
  "event_cc": {
    "approval_define_id": "Xam3xK9E62BzKPWGewJygA40l5",
    "instance_id": "4arDwM8peAXWDBjY9JRn2bo1K6",
    "cc_id": "1024",
    "form_user_id": "1024",
    "ex_form_user_id": "1024",
    "to_user_id": "1024",
    "ex_to_user_id": "1024"
  }
}

应用能力变更

应用能力变更（kso.developer.application.capability.update）

基本信息

字段	内容
事件名称	应用能力变更
事件 Key	`kso.developer.application.capability.update`
所需权限	查询应用信息 `kso.app.read`
Topic	`kso.developer.application.capability`
操作类型	update

事件说明

触发场景：开发者后台-应用能力，打开/关闭各个能力开关

事件体示例

json

{
  "appid": "",
  "name": "",
  "switch": true
}

艾特人

艾特人（kso.kdocs.create）

基本信息

字段	内容
事件名称	艾特人
事件 Key	`kso.kdocs.create`
所需权限	查询文件 `kso.file.read`
Topic	`kso.kdocs`
操作类型	create

事件说明

私网协作打开登录账户创建的文档@除自身任一用户

事件体示例（当前平台返回示例）

json

{
  "at_id": "1",
  "file_id": "1",
  "file_name": "名字",
  "at_scene": 2,
  "extra_data": {
    "comment_id": "1",
    "conversation_id": "1"
  },
  "operator": {
    "id": 1,
    "ex_id": "123",
    "name": "wk",
    "type": "string",
    "avatar": "string",
    "company_id": "1"
  },
  "to_users": [1, 2],
  "ex_to_users": ["1", "2"]
}