枚举值列表
事件模块
| 事件模块可选值 | 事件模块描述 |
|---|---|
| 1 | 云文档 |
| 2 | 即时消息 |
| 3 | 通讯录 |
| 4 | 工作台 |
| 5 | 音视频会话 |
| 6 | 账号行为 |
| 9 | 公司圈 |
| 13 | OKR |
| 16 | 邮箱 |
| 18 | 审批 |
| 21 | 日历 |
事件名称
| 事件名称 | 事件描述 | 所属事件模块 |
|---|---|---|
| space_create_doc | 创建云文档 | 1 |
| space_read_doc | 访问云文档 | 1 |
| space_delete_doc | 删除文件/文件夹 | 1 |
| space_edit_doc | 编辑文件 | 1 |
| space_comment_doc | 评论云文档 | 1 |
| space_update_collaborator_doc | 更新文档协作者（包括内/外部协作者） | 1 |
| space_update_share_setting_doc | 更新文档分享设置 | 1 |
| space_export_doc | 导出云文档 | 1 |
| space_download_file | 下载文件/文件夹 | 1 |
| space_import_doc | 导入云文档 | 1 |
| space_share_to_3rdApp | 分享到第三方应用 | 1 |
| space_front_export_csv | 电子表格导出CSV | 1 |
| space_front_export_image | 移动端导出图片并下载 | 1 |
| space_open_with_3rdApp | 用第三方应用打开预览文件 | 1 |
| space_print_doc | 打印云文档 | 1 |
| space_copy_content | 复制内容 | 1 |
| set_doc_sec_label | 设置文档密级标签 | 1 |
| space_add_comment | 添加评论 | 1 |
| space_add_reply | 添加回复 | 1 |
| space_create_copy | 创建副本 | 1 |
| space_create_spacecopy | 创建知识库 | 1 |
| space_delete_doccurrent | 删除文件/文件夹（不影响子文件/文件夹） | 1 |
| space_delete_reply | 删除回复 | 1 |
| space_delete_retlabel | 清除保留标签 | 1 |
| space_demoslides | 演示幻灯片 | 1 |
| space_download_history | 下载历史版本 | 1 |
| space_edit_reply | 编辑回复 | 1 |
| space_edit_retlabel | 修改保留标签 | 1 |
| space_edit_space_member | 编辑知识空间成员 | 1 |
| space_edit_space_member_auth | 修改知识空间成员权限 | 1 |
| space_edit_space_owner | 编辑知识空间管理员 | 1 |
| space_finish_comment | 解决评论 | 1 |
| space_modfiy_security_setting | 修改知识空间安全设置 | 1 |
| space_move | 移动到文件夹/知识库 | 1 |
| space_move_owner | 转移所有权 | 1 |
| space_recover_history | 还原历史版本 | 1 |
| space_reopen_comment | 恢复评论 | 1 |
| space_save_module | 保存为我的模板 | 1 |
| space_set_retlabel | 设置保留标签 | 1 |
| space_share | 分享文件/文件夹 | 1 |
| space_share_content | 分享文件中内容 | 1 |
| space_update_collaborator_auth | 修改协作者权限 | 1 |
| space_update_spaceshare_status | 开启/关闭空间链接分享 | 1 |
| space_view_history | 查看历史版本 | 1 |
| turn_down_doc_sec_label | 调低密级标签敏感等级 | 1 |
| turn_up_doc_sec_label | 调高密级标签敏感等级 | 1 |
| space_authapprove | 云文档申请权限 | 1 |
| space_doc_clickDocPlugin | 点击打开文档 | 1 |
| space_upgrade_doc_to_docx | 完成 doc 1.0 升级为 docx | 1 |
| im_download_image | 下载图片 | 2 |
| im_download_video | 下载视频 | 2 |
| im_open_link | 在聊天中点击 URL | 2 |
| im_start_external_chat | 对陌生人发起单聊 | 2 |
| im_load_file_to_local | 将服务端文件缓存到本地 | 2 |
| im_forward_file | 转发 | 2 |
| im_create_chat | 创建群组 | 2 |
| im_delete_chat | 解散群组 | 2 |
| im_join_chat | 加入群组 | 2 |
| im_quit_chat | 退出群组 | 2 |
| im_add_chatadmin | 添加群管理员 | 2 |
| im_addtochat | 添加群组成员 | 2 |
| im_admin_no_restrict_ctrl | 管理免受群聊保密模式限制成员 | 2 |
| im_chat_editimage | 编辑图片 | 2 |
| im_chat_previewfile | 在线预览非图片或视频文件 | 2 |
| im_chat_uploadfile | 上传文件 | 2 |
| im_chat_withdraw | 撤回 | 2 |
| im_delete_chatadmin | 删除群管理员 | 2 |
| im_deletefromchat | 删除群组成员 | 2 |
| im_download | 下载文件 | 2 |
| im_forward_chatadmin | 转让群主 | 2 |
| im_ocr | 截图提取文字 | 2 |
| im_savetospace | 保存到我的空间 | 2 |
| im_screencap | 即时消息录屏 | 2 |
| im_send_link | 在聊天中发送url | 2 |
| im_snaphot | 即时消息截图 | 2 |
| im_copy_image | 复制 | 2 |
| im_read_doc | 访问 IM 会话中的文件 | 2 |
| im_download_file | 下载 IM 会话中的文件 | 2 |
| im_open_with_3rdApp | 用第三方应用打开文件 | 2 |
| im_chat_pin_show_pin_list | 展开置顶看板 | 2 |
| im_chat_pin_show_in_chat | 查看置顶内容 | 2 |
| im_chat_pin_stick | 将置顶内容“固定在首位” | 2 |
| im_chat_pin_update_permission | 更改置顶管理权限 | 2 |
| im_chat_pin_update | 修改置顶链接的标题 | 2 |
| im_chat_pin_sidebar_search | 点击工具栏中的“搜索” | 2 |
| im_chat_pin_click_open_browser | 在置顶链接菜单内点击“在浏览器中打开” | 2 |
| im_chat_pin_sidebar_file | 点击工具栏中的“文件” | 2 |
| im_chat_pin_unstick | 将置顶内容“取消固定” | 2 |
| im_chat_pin_hover_show | PC Hover 查看置顶预览卡片 | 2 |
| im_chat_pin_reorder | 对置顶进行拖拽排序 | 2 |
| im_chat_pin_create | 添加置顶 | 2 |
| im_chat_pin_click_copy_url | 在置顶链接菜单内点击“复制链接” | 2 |
| im_chat_pin_sidebar_add_link | 点击工具栏中的“添加置顶链接” | 2 |
| im_chat_pin_click_back_to_chat | 点击置顶消息 “回到原文” | 2 |
| im_export_chat_chatter | 导出群成员信息 | 2 |
| im_chat_pin_sidebar_announce | 点击工具栏中的“添加/查看群公告” | 2 |
| im_chat_pin_click_open_url | 点击置顶链接卡片后打开链接 | 2 |
| im_chat_pin_delete | 移除置顶 | 2 |
| im_chat_avatar_type | 修改群头像 | 2 |
| im_chat_deleteAutoJoinRule | 删除自动入群规则 | 2 |
| im_chat_linked_page_create | 关联页面与群组 | 2 |
| im_chat_linked_page_delete | 解除页面与群组的关联 | 2 |
| im_chat_setAutoJoinRule | 设置自动入群规则 | 2 |
| contact_obtain_mobile | 获取手机号 | 3 |
| contact_view_department_struct | 查看部门组织架构 | 3 |
| contact_view_personal_info | 查看个人信息页 | 3 |
| contact_add_external_friend | 添加外部联系人为好友 | 3 |
| contact_personal_avatar_update | 更新个人头像 | 3 |
| add_as_star_contact | 添加星标联系人 | 3 |
| remove_star_contact | 移除星标联系人 | 3 |
| call_phone_number | 拨打电话 | 3 |
| copy_phone_number | 复制电话 | 3 |
| add_phone_number_to_contacts | 保存到通讯录 | 3 |
| contact_obtain_mobile | 获取手机号 | 3 |
| workplace_open_app | 打开应用 | 4 |
| workplace_app_download_doc | 下载工作台应用中的文档 | 4 |
| workplace_app_open_with_3rdApp | 用第三方应用打开工作台应用中的预览文件 | 4 |
| vc_create_video_meeting | 创建视频会议 | 5 |
| vc_finish_video_meeting | 结束视频会议 | 5 |
| vc_quit_video_meeting | 退出视频会议 | 5 |
| vc_join_video_meeting | 加入视频会议 | 5 |
| vc_changerange | 修改入会权限 | 5 |
| vc_invite_video_meeting | 邀请其他用户进入视频会议 | 5 |
| vc_share_video_meeting | 分享视频会议 | 5 |
| vc_sharescreen_video_meeting | 共享屏幕/云文档/白板 | 5 |
| vc_createclip | 创建妙记片段 | 5 |
| vc_deleteclip | 删除妙记片段 | 5 |
| vc_deletemeta | 将某篇妙记移入回收站 | 5 |
| vc_deletemetafromtrash | 永久删除某篇妙记 | 5 |
| vc_drivebatchtranscribe | 通过导入飞书云端文件生成妙记 | 5 |
| vc_exportmeta | 导出妙记 | 5 |
| vc_revertmeta | 从回收站恢复某篇妙记 | 5 |
| vc_setaudiostatus | 通过移动端录音生成妙记文件 | 5 |
| vc_share_to_room_video_meeting | 会议室投屏 | 5 |
| vc_sharebychat | 通过会话分享妙记 | 5 |
| vc_sharebylink | 通过链接修改妙记权限 | 5 |
| vc_shareclipbychat | 通过会话分享妙记片段 | 5 |
| vc_sharecollaborator | 管理妙记协作者 | 5 |
| vc_uploadbymeeting | 通过会中录制生成妙记文件 | 5 |
| vc_uploadmeta | 通过上传本地文件生成妙记 | 5 |
| vc_viewclip | 访问某篇妙记片段 | 5 |
| vc_viewmeta | 访问某篇妙记 | 5 |
| vc_start_transcript | 开始会议转录 | 5 |
| vc_stop_transcript | 停止会议转录 | 5 |
| vc_request_transcript | 申请会议转录 | 5 |
| vc_access_transcript | 同意会议转录申请 | 5 |
| vc_refuse_transcript | 拒绝会议转录申请 | 5 |
| vc_access_local_record | 同意会议本地录制申请 | 5 |
| vc_refuse_local_record | 拒绝会议本地录制申请 | 5 |
| vc_refuse_record | 拒绝会议录制申请 | 5 |
| vc_access_record | 同意会议录制申请 | 5 |
| vc_stop_record | 结束会议录制 | 5 |
| vc_request_record | 申请会议录制 | 5 |
| vc_start_local_record | 开始会议本地录制 | 5 |
| vc_stop_local_record | 停止会议本地录制 | 5 |
| vc_request_local_record | 申请会议本地录制 | 5 |
| vc_manage_stop_local_record | 停止参会人本地录制会议 | 5 |
| vc_start_record | 开始会议录制 | 5 |
| vc_start_screen_control | 开启远程屏幕控制 | 5 |
| vc_finish_screen_control | 关闭远程屏幕控制 | 5 |
| vc_access_download_minutes | 同意下载录制文件 | 5 |
| vc_apply_download_minutes | 申请下载录制文件 | 5 |
| vc_download_minutes | 下载妙记文件到本地 | 5 |
| vc_refuse_download_minutes | 拒绝下载录制文件 | 5 |
| account_login | 登录 | 6 |
| account_passport_changeaccount | 切换账号 | 6 |
| account_passport_logout | 登出 | 6 |
| account_passport_renew_logoncre | 登录凭证更新 | 6 |
| account_passport_renew_password | 登录密码更新 | 6 |
| user_active_exit_team | 退出企业 | 6 |
| account_passport_update_otp | 更新动态口令设置 | 6 |
| account_passport_update_2fa | 更新两步验证设置 | 6 |
| account_passport_updatesparecre | 更新备用验证方式设置 | 6 |
| account_passport_revoke_appauth | 管理应用授权 | 6 |
| account_passport_renew_fidocre | 更新通行密钥设置 | 6 |
| moments_copy_comment | 复制评论 | 9 |
| moments_copy_image | 复制图片 | 9 |
| moments_copy_link | 复制链接 | 9 |
| moments_copy_post | 复制动态 | 9 |
| moments_create_comment | 发布评论 | 9 |
| moments_create_official | 创建官方号 | 9 |
| moments_create_post | 发布动态 | 9 |
| moments_create_reaction | 表情回复 | 9 |
| moments_delete_comment | 删除评论 | 9 |
| moments_delete_post | 删除帖子 | 9 |
| moments_delete_reaction | 取消表情回复 | 9 |
| moments_download_image | 下载图片 | 9 |
| moments_edit_official | 修改官方号 | 9 |
| moments_enter_post_detail | 点击动态详情页 | 9 |
| moments_forward_post | 转发动态 | 9 |
| moments_login_official | 登录官方号 | 9 |
| moments_preview_image | 预览图片 | 9 |
| moments_preview_video | 预览视频 | 9 |
| moments_view_feed_post | 浏览动态 | 9 |
| email_batchexport | 批量导出邮件 | 16 |
| email_copy | 复制邮件内容 | 16 |
| email_delete | 永久删除邮件 | 16 |
| email_downloadfile | 下载附件 | 16 |
| email_downloadmail | 下载邮件 | 16 |
| email_editforward | 设置自动转发 | 16 |
| email_foawardasatt | 将邮件作为附件转发 | 16 |
| email_localopen | 本地应用打开附件 | 16 |
| email_login | 登录公共邮箱 | 16 |
| email_loginthird | 登录第三方邮箱客户端 | 16 |
| email_move | 移动邮件 | 16 |
| email_print | 打印邮件 | 16 |
| email_read | 阅读邮件 | 16 |
| email_reply | 回复/转发邮件 | 16 |
| email_send | 发送邮件 | 16 |
| email_sharefile | 分享附件至会话 | 16 |
| email_sharemail | 分享邮件至会话 | 16 |
| email_urlclick | 点击邮件正文链接 | 16 |
| addmailuser | 添加邮箱联系人 | 16 |
| deletemailuser | 删除邮箱联系人 | 16 |
| modifymailuser | 修改邮箱联系人 | 16 |
| viewmailuser | 查看邮箱联系人 | 16 |
| officeapprove_operate_clear | 操作删除 | 18 |
| officeapprove_add_submanager | 管理后台添加子管理员 | 18 |
| officeapprove_process_intervene | 流程干预 | 18 |
| officeapprove_hand_over | 审批交接 | 18 |
| officeapprove_operate_save | 操作保存 | 18 |
| officeapprove_bitable_add_data | 添加审批数据 | 18 |
| officeapprove_admin_export_data | 管理后台导出数据 | 18 |
| officeapprove_create_approval_group | 新建审批流程分组 | 18 |
| officeapprove_enable_approval | 启用审批流程 | 18 |
| officeapprove_update_approval_group | 更新审批流程分组 | 18 |
| officeapprove_update_approval | 修改审批流程 | 18 |
| officeapprove_delete_approval | 删除审批流程 | 18 |
| officeapprove_delete_approval_group | 删除审批流程分组 | 18 |
| officeapprove_disable_approval | 停用审批流程 | 18 |
| officeapprove_export_data | 客户端导出数据 | 18 |
| officeapprove_create_approval | 新建审批流程 | 18 |
| officeapprove_export_efficiency_task_detail | 导出任务明细 | 18 |
| officeapprove_process_diagnosis | 查看流程诊断 | 18 |
| officeapprove_export_efficiency_process_detail | 导出流程明细 | 18 |
| officeapprove_efficiency | 查看个人效率 | 18 |
| officeapprove_share_approval | 分享流程提交入口 | 18 |
| officeapprove_operate_submit_again | 操作重新提交 | 18 |
| officeapprove_operate_recall | 操作撤回 | 18 |
| officeapprove_operate_upload_attachment | 上传附件 | 18 |
| officeapprove_operate_upload_image | 上传图片 | 18 |
| officeapprove_operate_share | 分享审批单 | 18 |
| officeapprove_operate_urgent | 催办 | 18 |
| officeapprove_operate_discuss | 操作讨论 | 18 |
| officeapprove_operate_addsign | 操作加签 | 18 |
| officeapprove_operate_rollback | 操作退回 | 18 |
| officeapprove_operate_removesign | 操作减签 | 18 |
| officeapprove_operate_comment | 操作评论 | 18 |
| officeapprove_operate_cc | 操作抄送 | 18 |
| officeapprove_operate_reject | 操作拒绝 | 18 |
| officeapprove_operate_forward | 操作转交 | 18 |
| officeapprove_operate_approve | 操作同意 | 18 |
| officeapprove_modify_instance | 修改审批单 | 18 |
| officeapprove_create_instance | 发起审批单 | 18 |
| officeapprove_detail_instance | 查看审批单 | 18 |
| cal_create_event | 创建日程 | 21 |
| cal_add_attachment | 添加日程附件 | 21 |
| cal_remove_attachment | 移除日程附件 | 21 |
| cal_delete_event | 删除日程 | 21 |
| cal_add_remove_participants | 添加/移除日程参与者 | 21 |
| cal_add_remove_meeting_room | 添加/移除会议室 | 21 |
| cal_mod_event_permission | 更改日程参与者权限 | 21 |
| cal_create_meeting_group | 创建会议群 | 21 |
| cal_transfer_event | 日程转让 | 21 |
| cal_share_event | 分享日程至会话 | 21 |
| cal_join_event | 加入日程 | 21 |
| calendar_create_scheduler | 创建预约活动 | 21 |
| calendar_edit_scheduler | 修改预约活动 | 21 |
| calendar_del_scheduler | 删除预约活动 | 21 |
| cal_change_def_cal_permissions | 更改日历默认权限 | 21 |
| cal_add_remove_calendar_sharee | 新增/删除日历共享人 | 21 |
| cal_modify_sharee_permissions | 更改日历共享人权限 | 21 |
| cal_add_3party_account | 添加第三方日历账号 | 21 |
| cal_subscribe_calendar | 订阅日历 | 21 |
| cal_unsubscribe_calendar | 取消订阅日历 | 21 |
| cal_share_calendar_to_session | 分享日历至会话 | 21 |
| cal_remove_3party_account | 移除第三方日历账号 | 21 |
| cal_create_meetingnote | 创建会议纪要 | 21 |
| cal_del_meetingnote | 删除会议纪要 | 21 |
| cal_edit_calendar | 编辑日历信息 | 21 |
| cal_edit_event | 编辑日程 | 21 |
| cal_event_rsvp | 回复日程参与状态 | 21 |
| cal_export_calendar | 导出日历 | 21 |
| cal_create_calendar | 新建日历 | 21 |
| cal_delete_calendar | 删除日历 | 21 |
| cal_switch_calendar | 更改日程所在日历 | 21 |
| cal_bind_meetingnote | 关联会议纪要 | 21 |
| cal_convert_group | 将会议群转为普通群组 | 21 |
Web环境信息
| 环境字段 | 描述 |
|---|---|
| user_agent | UA信息 |
| IP | 公网IP |
Android环境信息
| 环境字段 | 描述 |
|---|---|
| udid | UDID |
| did | 设备ID |
| app_ver | app的版本 |
| ver | SecSDK版本 |
| region | 设备语言 |
| id_i | 安卓版本号 |
| id_r | 安卓版本 |
| hw_brand | Brand |
| hw_manuf | 制造商 |
| wifip | wifi ip |
| route_iip | 路由IP |
| route_gip | 路由网关IP |
| env_su | 表示当前是否root |
| env_tz | 手机系统时区 |
| env_ml | 手机系统语言 |
| IP | 公网ip |
iOS环境信息
| 环境字段 | 描述 |
|---|---|
| udid | UDID |
| did | 设备ID |
| app_ver | app的版本 |
| ver | SecSDK版本 |
| os | 系统类型及版本 |
| STZone | 系统时区 |
| ML | 当前语言 |
| sjd | 是否越狱 |
| proxyip | 代理ip |
| wifip | wif ip |
| IP | 公网ip |
PC环境信息
| 环境字段 | 描述 |
|---|---|
| udid | UDID |
| did | 设备ID |
| app_ver | app的版本 |
| ver | SecSDK版本 |
| os | 客户端类型 |
| wifip | wifi ip |
| IP | 公网ip |
事件扩展字段详情
扩展字段
| 字段 | 事件名称 | 字段名称 | 描述 |
|---|---|---|---|
| ApplyPermissionRole | space_authapprove | 申请的权限 | CollaboratorRole_CanView 可阅读； CollaboratorRole_CanEdit 可编辑； CollaboratorRole_FullAccess 可管理； |
| ccm_authuser_auth_after | space_update_collaborator_auth | 修改后的协作者权限 | CollaboratorRole_FullAccess 可访问； CollaboratorRole_CanView 可阅读； CollaboratorRole_CanEdit 可编辑； |
| ccm_download_type | space_download_file space_download_history | 下载类型 | 图片image； 视频video； 文件file； |
| ccm_edit_part | space_edit_doc | 编辑内容类型 | 1：标题； 0：正文； |
| ccm_share_type | space_share | 分享渠道 | share_wechat：微信； share_lark：飞书； share_encrypted_link：加密链接； copy_link：复制链接； share_qrcode：二维码； |
| ccm_space_default_permission | space_edit_space_member_auth | 修改后的成员权限 | WikiNodeRole_VIEW : 可阅读； WikiNodeRole_EDIT : 可编辑； |
| CCMPermissionSettingType | space_update_share_setting_doc | 更改的设置项 | 见下文云文档权限设置参数说明表 |
| CCMPermissionSettingType_space | space_modfiy_security_setting | 更改的设置项 | 见下文云空间权限设置参数说明表 |
| CCMPermissionSettingTypeAftervalue | space_update_share_setting_doc | 更改后的值 | 见下文云文档权限设置参数说明表 |
| CCMPermissionSettingTypeAftervalue_space | space_modfiy_security_setting | 更改后的值 | 见下文云空间权限设置参数说明表 |
| ChatType | im_chat_uploadfile im_chat_withdraw im_copy_image im_forward_file im_open_link im_savetospace email_sharefile im_chat_editimage im_chat_previewfile | 会话类型 | P2P：单聊； GROUP：群聊； |
| exportType | vc_exportmeta | 导出文件类型 | FEISHUDOC：飞书文档； TXT：文本； SRT：SRT文件； |
| FileType | im_chat_uploadfile im_download im_chat_previewfile | 文件类型 | 如MEDIA等，如为了更准确判断文件类型，可以使用FileName的后缀名称 |
| im_chat_restrict_whitelist_level | im_admin_no_restrict_ctrl | 限制成员模式 | unkown：未知； member：没有人； only admin and owner：仅群主和群管理员； white list：指定群成员； |
| im_message_type | im_forward_file | 转发的消息类型 | 见下文消息类型枚举表 |
| im_withdraw_messagetype | im_chat_withdraw | 撤回的消息类型 | 见下文消息类型枚举表 |
| LabelType | space_delete_retlabel space_edit_retlabel space_set_retlabel | 标签类型 | reserve：自定义期限保留； delete：删除到期内容； reserve forever：永久保留； |
| MessageType | im_copy_image | 消息类型 | 见下文消息类型枚举表 |
| MetaType | vc_createclip vc_deleteclip vc_deletemeta vc_deletemetafromtrash vc_download_minutes vc_drivebatchtranscribe vc_exportmeta vc_revertmeta vc_setaudiostatus vc_sharebychat vc_sharebylink vc_shareclipbychat vc_sharecollaborator vc_uploadbymeeting vc_uploadmeta vc_viewclip vc_viewmeta | 妙记类型 | MediaType_Video：视频； MediaType_Audio：音频； MediaType_Text：文本； |
| OperateType | space_update_spaceshare_status | 是否将空间发布到互联网 | off：关闭； on：开启； |
| OpResult | im_copy_image vc_sharescreen_video_meeting im_chat_editimage im_chat_previewfile im_download_image im_ocr vc_share_to_room_video_meeting | 是否操作成功 | 0：成功； 1：失败； |
| roomsharetype | vc_share_to_room_video_meeting | 投屏方式 | roomsharetypevwireless：无线投屏； roomsharetypevwired：有线投屏； |
| shareAuth | vc_sharebylink | 权限 | PermLinkShareEntity_TenantReadable：组织内可阅读； PermLinkShareEntity_TenantEditable：组织内可编辑； PermLinkShareEntity_AnyoneReadable：互联网上可阅读； PermLinkShareEntity_AnyoneEditable：互联网上可编辑； PermLinkShareEntity_Off：关闭链接分享； |
| shareAuth | vc_sharecollaborator | 授予/收回的权限 | PermissionCode_VIEW：可阅读； PermissionCode_EDIT：可编辑； Delete：删除协作者； |
| shareAuth | vc_sharebychat | 权限 | AuthViewSuccess可阅读； AuthEditSuccess可编辑； AuthNotAllowExternal不允许分享到外部； AuthNoShareAccess分享失败； AuthAlreadyHasPerm分享对象已经有权限； AuthFailed分享失败； |
| sharetype | vc_sharescreen_video_meeting | 共享类型 | sharetypevsharetypescreen：屏幕/应用； sharetypevsharetypefollow：云文档； sharetypevsharetypewhiteboard：白板； |
| space_share_to_3rdApp | space_share_to_3rdApp | 分享渠道 | share_wechat：微信； share_lark：飞书； share_encrypted_link：加密链接； copy_link：复制链接； share_qrcode：二维码； |
| SwitchTenantType | account_login account_passport_changeaccount | 租户切换方式 | 主动0； 被动1； 登录流程2； |
| Type | vc_createclip vc_deleteclip vc_deletemeta vc_deletemetafromtrash vc_download_minutes vc_drivebatchtranscribe vc_exportmeta vc_revertmeta vc_setaudiostatus vc_sharebychat vc_sharebylink vc_shareclipbychat vc_sharecollaborator vc_uploadbymeeting vc_uploadmeta vc_viewclip vc_viewmeta | 创建方式 | ObjectType_Normal：会议录制生产妙记； ObjectType_Upload：本地上传生成妙记； ObjectType_Upload_CCM：导入云端文档生成妙记； ObjectType_RealTime_Recording：用户通过录音生成妙记文件； ObjectType_Clip：用户创建的妙记片段； ObjectType_Live：直播生成的妙记； |
| UpdateType | account_passport_renew_logoncre account_passport_renew_password | 更新类型 | 增加0； 修改1； 删除2； |
消息类型枚举
| 枚举值 | 描述 |
|---|---|
| POST | 可能包含多种类型 例如文本 图片等 属于富文本 |
| FILE | 文件 |
| TEXT | 文本 |
| IMAGE | 图片 |
| SYSTEM | 系统消息 |
| AUDIO | 语音 |
| SHARE_GROUP_CHAT | 群名片 |
| STICKER | 自定义表情 |
| MERGE_FORWARD | 合并转发后的消息 |
| CALENDAR | 日历 |
| CLOUD_FILE | 云文件 |
| CARD | 卡片消息 和 邮件 |
| MEDIA | 视频 |
| SHARE_CALENDAR_EVENT | 日程邀请 |
| HONGBAO | 红包 |
| GENERAL_CALENDER | 日程转让 |
| VIDEO_CHAT | 视频会议邀请 |
| LOCATION | 位置 |
| CUSTOMIZE | 自定义 |
| COMMERCIALIZED_HONGBAO | 商业红包 |
| SHARE_USER_CARD | 个人名片 |
| TODO | 任务 |
| FOLDER | 文件夹 |
| DIAGNOSE | 诊断消息 |
| VOTE | 投票消息 |
云文档权限设置参数说明
| 字段 | 参数 | 描述 |
|---|---|---|
| CCMPermissionSettingType | PermissionLinkShareType | 链接分享设置 |
| CCMPermissionSettingType | PermissionSinglePageSettingType | 单页面链接分享设置 |
| CCMPermissionSettingType | PermissionExternalAccessType | 是否开启外部访问设置 |
| CCMPermissionSettingType | CommentEntityType | 评论设置属性情况 |
| CCMPermissionSettingType | SecurityEntityType | 安全设置属性情况 |
| CCMPermissionSettingType | ShareEntityType | 谁可添加协作者（组织维度）设置属性情况 |
| CCMPermissionSettingType | ManageCollaboratorEntityType | 谁可添加协作者（权限维度）设置属性情况 |
| CCMPermissionSettingType | ShareExternalEntityType | 只有可管理将内容分享到组织外或关联组织 |
| CCMPermissionSettingType | PermissionSinglePageExternalAccessType | 是否开启单页面外部访问设置 |
| CCMPermissionSettingType | ApplyEmbedEntityType | 谁能快捷访问无权限的引用文档和快捷申请权限设置 |
| CCMPermissionSettingType | ShowCollaboratorInfoEntityType | 谁可以查看文档协同头像和点赞头像 |
| CCMPermissionSettingType | LeaderCopySwitchType | 文档所有者上级复制文档内容 |
| CCMPermissionSettingType | LeaderLinkShareEntityType | 文档所有者上级获得链接可访问 |
| CCMPermissionSettingTypeAftervalue | DisableLinkShare | 不开启链接分享 |
| CCMPermissionSettingTypeAftervalue | CanReadByLinkInTenant | 组织内获得链接可访问 |
| CCMPermissionSettingTypeAftervalue | CanEditByLinkInTenant | 组织内获得链接可编辑 |
| CCMPermissionSettingTypeAftervalue | CanReadByLinkInPartnerTenant | 关联组织内获得链接可访问 |
| CCMPermissionSettingTypeAftervalue | CanEditByLinkInPartnerTenant | 关联组织内获得链接可编辑 |
| CCMPermissionSettingTypeAftervalue | CanReadByLinkInInternet | 互联网获得链接可访问 |
| CCMPermissionSettingTypeAftervalue | CanEditByLinkInInternet | 互联网获得链接可编辑 |
| CCMPermissionSettingTypeAftervalue | CanReadBySinglePageLinkInTenant | 单页面组织内获得链接可访问 |
| CCMPermissionSettingTypeAftervalue | CanEditBySinglePageLinkInTenant | 单页面组织内获得链接可编辑 |
| CCMPermissionSettingTypeAftervalue | CanReadBySinglePageLinkInPartnerTenant | 单页面关联组织内获得链接可访问 |
| CCMPermissionSettingTypeAftervalue | CanEditBySinglePageLinkInPartnerTenant | 单页面关联组织内获得链接可编辑 |
| CCMPermissionSettingTypeAftervalue | CanReadBySinglePageLinkInInternet | 单页面互联网获得链接可访问 |
| CCMPermissionSettingTypeAftervalue | CanEditBySinglePageLinkInInternet | 单页面互联网获得链接可编辑 |
| CCMPermissionSettingTypeAftervalue | ExternalAccessOn | 开启对外分享 |
| CCMPermissionSettingTypeAftervalue | ExternalAccessOff | 关闭对外分享 |
| CCMPermissionSettingTypeAftervalue | ExternalAccessPartnerTenant | 可分享给关联组织 |
| CCMPermissionSettingTypeAftervalue | SinglePageExternalAccessOn | 开启单页面对外分享 |
| CCMPermissionSettingTypeAftervalue | SinglePageExternalAccessPartnerTenant | 单页面可分享给关联组织 |
| CCMPermissionSettingTypeAftervalue | CommentEntityView | 拥有阅读权限可评论 |
| CCMPermissionSettingTypeAftervalue | CommentEntityEdit | 拥有编辑权限可评论 |
| CCMPermissionSettingTypeAftervalue | SecurityEntityView | 拥有阅读权限可复制、创建副本、打印、下载、导出 |
| CCMPermissionSettingTypeAftervalue | SecurityEntityEdit | 拥有编辑权限可复制、创建副本、打印、下载、导出 |
| CCMPermissionSettingTypeAftervalue | SecurityEntityFullAccess | 拥有全部权限可复制、创建副本、打印、下载、导出 |
| CCMPermissionSettingTypeAftervalue | ShareEntityFullAccess | 可管理可邀请协作者 |
| CCMPermissionSettingTypeAftervalue | ShareEntitySameTenant | 同租户可添加协作者 |
| CCMPermissionSettingTypeAftervalue | ShareEntityAnyone | 任何人可添加协作者 |
| CCMPermissionSettingTypeAftervalue | ManageCollaboratorEntityView | 拥有阅读权限可添加协作者 |
| CCMPermissionSettingTypeAftervalue | ManageCollaboratorEntityEdit | 拥有编辑权限可添加协作者 |
| CCMPermissionSettingTypeAftervalue | ManageCollaboratorEntityFullAccess | 拥有全部权限可添加协作者 |
| CCMPermissionSettingTypeAftervalue | DetailValTrue | 开启 |
| CCMPermissionSettingTypeAftervalue | DetailValFalse | 关闭 |
| CCMPermissionSettingTypeAftervalue | ApplyEmbedEntityView | 拥有阅读权限可快捷访问无权限的引用文档和快捷申请权限 |
| CCMPermissionSettingTypeAftervalue | ApplyEmbedEntityEdit | 拥有编辑权限可快捷访问无权限的引用文档和快捷申请权限 |
| CCMPermissionSettingTypeAftervalue | ApplyEmbedEntityFullAccess | 拥有全部权限可快捷访问无权限的引用文档和快捷申请权限 |
| CCMPermissionSettingTypeAftervalue | ShowCollaboratorInfoEntityView | 拥有阅读权限可查看文档协同头像和点赞头像 |
| CCMPermissionSettingTypeAftervalue | ShowCollaboratorInfoEntityEdit | 拥有编辑权限可查看文档协同头像和点赞头像 |
| CCMPermissionSettingTypeAftervalue | ShowCollaboratorInfoEntityFullAccess | 拥有全部权限可查看文档协同头像和点赞头像 |
| CCMPermissionSettingTypeAftervalue | LeaderLinkShareEntityClose | 关闭上级可访问 |
| CCMPermissionSettingTypeAftervalue | LeaderLinkShareEntityCanView | 允许上级可阅读 |
| CCMPermissionSettingTypeAftervalue | LeaderLinkShareEntityCanEdit | 允许上级可编辑 |
| CCMPermissionSettingTypeAftervalue | LeaderLinkShareEntityFullAccess | 允许上级可管理 |
| CCMPermissionSettingTypeAftervalue | LeaderCopyOff | 关闭上级复制 |
| CCMPermissionSettingTypeAftervalue | LeaderCopyOn | 允许上级复制 |
云空间权限设置参数说明
| CCMPermissionSettingType_space | CCMPermissionSettingTypeAftervalue_space |
|---|---|
| WikiCreateFirstNode 谁可新建空间的一级节点？ | Admin 只有管理员； AdminAndMember 管理员和成员； |
| WikiSecurityEntity 是否允许可阅读的用户对空间内的页面内容进行复制、创建副本、打印、或导出（Word、PDF、图片等）？ | Allow 允许； Deny 拒绝； |
| WikiCommentEntity 是否允许可阅读的用户在页面进行评论？ | Allow 允许； Deny 拒绝； |
| WikiExternalAccess 是否允许页面被分享到组织外？ | Allow 允许； Deny 拒绝； |
| WikiExternalAccessEntity 是否允许空间内容被分享到外部？ | ExternalAccessEntity_None 未设置； ExternalAccessEntity_Open 允许分享到外部； ExternalAccessEntity_Close 不允许分享到外部； ExternalAccessEntity_PartnerTenant 允许分享到关联组织； |
| WikiSpaceScope 知识空间公开范围 | WikiSpaceScope_PRIVATE 个人空间； WikiSpaceScope_PUBLIC 公共空间； |
操作对象扩展字段详情
| 字段 | 类型 | 描述 |
|---|---|---|
| clone_source | string | 复制来源 |
| third_party_appID | string | 第三方APPID |
| contain_file_num | int | 文件或文件夹数量 |
| permission_setting_type | string | 链接分享设置 |
| permission_external_access_Type | boolean | 是否开启外部访问设置 |
| permission_share_type | string | 权限分享设置 |
| file_service_source | string | 上传文件的来源 |
| okr_download_content | string | 下载OKR的内容 |
| container_type | string | 容器类型，标识是否wiki |
| container_id | string | 容器id，wiki标识字段 |
操作对象类型
| 类型 | 描述 | 是否支持搜索 |
|---|---|---|
| 1 | 用户 | 是 |
| 2 | 部门 | 是 |
| 3 | 租户 | 是 |
| 4 | 聊天群 | 是 |
| 5 | doc云文档 | 是 |
| 6 | sheet云文档 | 是 |
| 7 | file云文档 | 是 |
| 8 | folder云文档 | 是 |
| 9 | mindnote云文档 | 是 |
| 10 | bitable云文档 | 是 |
| 11 | slide云文档 | 是 |
| 12 | 机器人 | 否 |
| 13 | 音视频通话 | 否 |
| 14 | 普通文件，值类型为app_id与app_file_id，一般为聊天框中的预览文件 | 否 |
| 15 | 链接 | 是 |
| 16 | IM用户标识类型 | 否 |
| 17 | 图片 | 是 |
| 18 | 视频 | 是 |
| 19 | 普通文件，值类型为fileKey，一般为聊天框中用户发送的普通文件 | 是 |
| 20 | 小程序和H5应用 | 是 |
| 21 | 打开的本地文件 | 否 |
| 29 | OKR | 否 |
| 31 | docx云文档 | 是 |
| 106 | slides云文档 | 是 |
| 107 | 知识空间 | 是 |
| 121 | IM场景文件 | 是 |
| 425 | 妙记 | 是 |
| 426 | 同步块 | 是 |
| 210001 | 日历 | 是 |
| 210002 | 日历事件 | 是 |
| 210003 | 日历预约 | 是 |
| 210004 | 第三方日历账号 | 是 |