From 788ccd90d886d6b789a312cad7646c9e1770951c Mon Sep 17 00:00:00 2001 From: "Vicente.Yu" <^@^> Date: Sun, 3 Nov 2024 16:39:05 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=20-=20=E3=80=90=E5=B8=90?= =?UTF-8?q?=E5=8F=B7=E3=80=91=E9=80=80=E5=87=BA=E7=99=BB=E5=BD=95=20-=20?= =?UTF-8?q?=E3=80=90=E9=A3=9E=E4=B9=A6=E4=BA=BA=E4=BA=8B=EF=BC=88=E4=BC=81?= =?UTF-8?q?=E4=B8=9A=E7=89=88=EF=BC=89=E3=80=91=E6=9F=A5=E8=AF=A2=E7=BC=96?= =?UTF-8?q?=E5=88=B6=E8=A7=84=E5=88=92=E6=96=B9=E6=A1=88=20-=20=E3=80=90?= =?UTF-8?q?=E9=A3=9E=E4=B9=A6=E4=BA=BA=E4=BA=8B=EF=BC=88=E4=BC=81=E4=B8=9A?= =?UTF-8?q?=E7=89=88=EF=BC=89=E3=80=91=E5=90=AF=E7=94=A8/=E5=81=9C?= =?UTF-8?q?=E7=94=A8=E5=85=AC=E5=8F=B8=20-=20=E3=80=90=E9=A3=9E=E4=B9=A6?= =?UTF-8?q?=E4=BA=BA=E4=BA=8B=EF=BC=88=E4=BC=81=E4=B8=9A=E7=89=88=EF=BC=89?= =?UTF-8?q?=E3=80=91=E6=B7=BB=E5=8A=A0=E5=9C=B0=E7=82=B9=E5=9C=B0=E5=9D=80?= =?UTF-8?q?=20-=20=E3=80=90=E9=A3=9E=E4=B9=A6=E4=BA=BA=E4=BA=8B=EF=BC=88?= =?UTF-8?q?=E4=BC=81=E4=B8=9A=E7=89=88=EF=BC=89=E3=80=91=E6=9B=B4=E6=96=B0?= =?UTF-8?q?=E5=9C=B0=E7=82=B9=E5=9C=B0=E5=9D=80=20-=20=E3=80=90=E9=A3=9E?= =?UTF-8?q?=E4=B9=A6=E4=BA=BA=E4=BA=8B=EF=BC=88=E4=BC=81=E4=B8=9A=E7=89=88?= =?UTF-8?q?=EF=BC=89=E3=80=91=E5=90=AF=E7=94=A8/=E5=81=9C=E7=94=A8?= =?UTF-8?q?=E5=9C=B0=E7=82=B9=20-=20=E3=80=90=E9=A3=9E=E4=B9=A6=E4=BA=BA?= =?UTF-8?q?=E4=BA=8B=EF=BC=88=E4=BC=81=E4=B8=9A=E7=89=88=EF=BC=89=E3=80=91?= =?UTF-8?q?=E6=9B=B4=E6=96=B0=E5=9C=B0=E7=82=B9=20-=20=E3=80=90=E9=A3=9E?= =?UTF-8?q?=E4=B9=A6=E4=BA=BA=E4=BA=8B=EF=BC=88=E4=BC=81=E4=B8=9A=E7=89=88?= =?UTF-8?q?=EF=BC=89=E3=80=91=E5=88=A0=E9=99=A4=E5=9C=B0=E7=82=B9=E5=9C=B0?= =?UTF-8?q?=E5=9D=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 变更 - 发起员工异动 请求体 - 发起员工异动 响应体 - 获取招聘需求列表 响应体 - 创建招聘需求 请求体 - 创建招聘需求 响应体 - 获取招聘需求信息 响应体 - 更新招聘需求 请求体 - 第三方会议室日程变动 事件体 - 【飞书人事（企业版）】获取指定人员审批任务列表 接口 Signed-off-by: Vicente.Yu <^@^> --- TenantAccessList.md | 148 +-- UserAccessList.md | 78 +- .../PostAttendanceV1UserApprovalsBodyDto.cs | 2 +- ...tAuthV3TenantAccessTokenInternalBodyDto.cs | 7 +- ...hV3TenantAccessTokenInternalResponseDto.cs | 7 +- ...TablesByTableIdViewsByViewIdResponseDto.cs | 24 +- ...AppTokenTablesByTableIdViewsResponseDto.cs | 20 +- ...itableV1AppsByAppTokenTablesResponseDto.cs | 8 +- ...eV1AppsByAppTokenTablesByTableIdBodyDto.cs | 12 +- ...ppsByAppTokenTablesByTableIdResponseDto.cs | 8 +- ...okenTablesByTableIdViewsByViewIdBodyDto.cs | 28 +- ...TablesByTableIdViewsByViewIdResponseDto.cs | 18 +- ...1AppsByAppTokenTablesBatchCreateBodyDto.cs | 9 +- ...sByAppTokenTablesBatchCreateResponseDto.cs | 2 +- ...1AppsByAppTokenTablesBatchDeleteBodyDto.cs | 6 +- ...ostBitableV1AppsByAppTokenTablesBodyDto.cs | 50 +- ...okenTablesByTableIdRecordsSearchBodyDto.cs | 2 + ...TablesByTableIdRecordsSearchResponseDto.cs | 2 + ...psByAppTokenTablesByTableIdViewsBodyDto.cs | 6 +- ...AppTokenTablesByTableIdViewsResponseDto.cs | 10 +- ...itableV1AppsByAppTokenTablesResponseDto.cs | 8 +- .../PostContactV3DepartmentsBodyDto.cs | 1 + .../PostContactV3DepartmentsResponseDto.cs | 1 + .../GetCorehrV2WorkforcePlansResponseDto.cs | 111 +++ ...ByLocationIdAddressesByAddressIdBodyDto.cs | 191 ++++ ...tchCorehrV2LocationsByLocationIdBodyDto.cs | 164 ++++ .../PostCorehrV2CompaniesActiveBodyDto.cs | 62 ++ .../PostCorehrV2LocationsActiveBodyDto.cs | 63 ++ ...V2LocationsByLocationIdAddressesBodyDto.cs | 191 ++++ ...cationsByLocationIdAddressesResponseDto.cs | 31 + src/FeishuNetSdk.csproj | 2 +- .../PostCorehrV1JobChangesBodyDto.cs | 24 +- .../PostCorehrV1JobChangesResponseDto.cs | 25 +- .../GetHireV1JobRequirementsResponseDto.cs | 10 +- src/Hire/PostHireV1JobRequirementsBodyDto.cs | 10 +- .../PostHireV1JobRequirementsResponseDto.cs | 10 +- ...tHireV1JobRequirementsSearchResponseDto.cs | 10 +- ...obRequirementsByJobRequirementIdBodyDto.cs | 10 +- ...tHumanAuthenticationV1IdentitiesBodyDto.cs | 8 +- ...anAuthenticationV1IdentitiesResponseDto.cs | 7 +- src/IFeishuApi.cs | 7 +- src/IFeishuTenantApi.cs | 861 +++++++++++++++--- src/IFeishuUserApi.cs | 507 ++++++++--- ...essEventBotP2pChatEnteredV1EventBodyDto.cs | 8 +- .../ImChatDisbandedV1EventBodyDto.cs | 8 +- .../ImChatMemberBotAddedV1EventBodyDto.cs | 8 +- .../ImChatMemberBotDeletedV1EventBodyDto.cs | 8 +- .../ImChatMemberUserAddedV1EventBodyDto.cs | 8 +- .../ImChatMemberUserDeletedV1EventBodyDto.cs | 8 +- ...ImChatMemberUserWithdrawnV1EventBodyDto.cs | 9 +- src/Im.Events/ImChatUpdatedV1EventBodyDto.cs | 98 +- .../PostInteractiveV1CardUpdateBodyDto.cs | 4 +- src/Im.Spec/PostMessageV4BatchSendBodyDto.cs | 1 + ...1ChatsByChatIdChatTabsDeleteTabsBodyDto.cs | 13 +- ...tsByChatIdChatTabsDeleteTabsResponseDto.cs | 36 +- .../DeleteImV1ChatsByChatIdMembersBodyDto.cs | 17 +- ...leteImV1ChatsByChatIdMembersResponseDto.cs | 11 +- .../DeleteImV1ChatsByChatIdMenuTreeBodyDto.cs | 10 +- ...eteImV1ChatsByChatIdMenuTreeResponseDto.cs | 81 +- ...mV1ChatsByChatIdAnnouncementResponseDto.cs | 42 +- ...hatsByChatIdChatTabsListTabsResponseDto.cs | 34 +- ...ChatsByChatIdMembersIsInChatResponseDto.cs | 6 +- .../GetImV1ChatsByChatIdMembersResponseDto.cs | 12 +- ...GetImV1ChatsByChatIdMenuTreeResponseDto.cs | 80 +- ...tImV1ChatsByChatIdModerationResponseDto.cs | 19 +- src/Im/GetImV1ChatsByChatIdResponseDto.cs | 41 +- src/Im/GetImV1ChatsResponseDto.cs | 20 +- src/Im/GetImV1ChatsSearchResponseDto.cs | 19 +- ...tchImV1ChatsByChatIdAnnouncementBodyDto.cs | 18 +- ...atsByChatIdMenuItemsByMenuItemIdBodyDto.cs | 50 +- ...yChatIdMenuItemsByMenuItemIdResponseDto.cs | 42 +- src/Im/PostImV1ChatsBodyDto.cs | 61 +- .../PostImV1ChatsByChatIdChatTabsBodyDto.cs | 46 +- ...ostImV1ChatsByChatIdChatTabsResponseDto.cs | 36 +- ...mV1ChatsByChatIdChatTabsSortTabsBodyDto.cs | 18 +- ...hatsByChatIdChatTabsSortTabsResponseDto.cs | 36 +- ...1ChatsByChatIdChatTabsUpdateTabsBodyDto.cs | 44 +- ...tsByChatIdChatTabsUpdateTabsResponseDto.cs | 40 +- src/Im/PostImV1ChatsByChatIdLinkBodyDto.cs | 16 +- .../PostImV1ChatsByChatIdLinkResponseDto.cs | 12 +- ...ChatsByChatIdManagersAddManagersBodyDto.cs | 17 +- ...sByChatIdManagersAddManagersResponseDto.cs | 10 +- ...tsByChatIdManagersDeleteManagersBodyDto.cs | 10 +- ...ChatIdManagersDeleteManagersResponseDto.cs | 10 +- src/Im/PostImV1ChatsByChatIdMembersBodyDto.cs | 22 +- ...PostImV1ChatsByChatIdMembersResponseDto.cs | 20 +- .../PostImV1ChatsByChatIdMenuTreeBodyDto.cs | 100 +- ...ostImV1ChatsByChatIdMenuTreeResponseDto.cs | 83 +- ...ostImV1ChatsByChatIdMenuTreeSortBodyDto.cs | 11 +- ...mV1ChatsByChatIdMenuTreeSortResponseDto.cs | 85 +- ...atsByChatIdTopNoticePutTopNoticeBodyDto.cs | 24 +- src/Im/PostImV1ChatsResponseDto.cs | 23 +- src/Im/PutImV1ChatsByChatIdBodyDto.cs | 55 +- .../PutImV1ChatsByChatIdModerationBodyDto.cs | 27 +- ...artyMeetingRoomEventCreatedEventBodyDto.cs | 24 +- .../PostPassportV1SessionsLogoutBodyDto.cs | 86 ++ 96 files changed, 3280 insertions(+), 1108 deletions(-) create mode 100644 src/Corehr/GetCorehrV2WorkforcePlansResponseDto.cs create mode 100644 src/Corehr/PatchCorehrV2LocationsByLocationIdAddressesByAddressIdBodyDto.cs create mode 100644 src/Corehr/PatchCorehrV2LocationsByLocationIdBodyDto.cs create mode 100644 src/Corehr/PostCorehrV2CompaniesActiveBodyDto.cs create mode 100644 src/Corehr/PostCorehrV2LocationsActiveBodyDto.cs create mode 100644 src/Corehr/PostCorehrV2LocationsByLocationIdAddressesBodyDto.cs create mode 100644 src/Corehr/PostCorehrV2LocationsByLocationIdAddressesResponseDto.cs rename src/{HumanAuthentication.Spec => HumanAuthentication}/PostHumanAuthenticationV1IdentitiesBodyDto.cs (90%) rename src/{HumanAuthentication.Spec => HumanAuthentication}/PostHumanAuthenticationV1IdentitiesResponseDto.cs (86%) create mode 100644 src/Passport/PostPassportV1SessionsLogoutBodyDto.cs diff --git a/TenantAccessList.md b/TenantAccessList.md index e74c01a9..aea614fc 100644 --- a/TenantAccessList.md +++ b/TenantAccessList.md @@ -5,67 +5,67 @@ PostPassportV1SessionsQuery 32024-07-05✓通讯录通过手机号或邮箱获取用户 ID PostContactV3UsersBatchGetId -42024-06-21✓消息与群组解散群 +42024-10-30✓消息与群组解散群 DeleteImV1ChatsByChatId -52024-06-21✓消息与群组更新群信息 +52024-10-30✓消息与群组更新群信息 PutImV1ChatsByChatId -62024-06-21✓消息与群组更新群发言权限 +62024-10-30✓消息与群组更新群发言权限 PutImV1ChatsByChatIdModeration -72024-06-21✓消息与群组获取群信息 +72024-10-30✓消息与群组获取群信息 GetImV1ChatsByChatId -82024-06-21✓消息与群组更新群置顶 +82024-10-30✓消息与群组更新群置顶 PostImV1ChatsByChatIdTopNoticePutTopNotice -92024-06-21✓消息与群组撤销群置顶 +92024-10-30✓消息与群组撤销群置顶 PostImV1ChatsByChatIdTopNoticeDeleteTopNotice -102024-06-05✓消息与群组获取用户或机器人所在的群列表 +102024-10-30✓消息与群组获取用户或机器人所在的群列表 GetImV1Chats -112024-06-05✓消息与群组搜索对用户或机器人可见的群列表 +112024-10-30✓消息与群组搜索对用户或机器人可见的群列表 GetImV1ChatsSearch -122024-06-21✓消息与群组获取群成员发言权限 +122024-10-30✓消息与群组获取群成员发言权限 GetImV1ChatsByChatIdModeration -132024-06-21✓消息与群组获取群分享链接 +132024-10-30✓消息与群组获取群分享链接 PostImV1ChatsByChatIdLink 142024-07-05✓通讯录更新用户 ID PatchContactV3UsersByUserIdUpdateUserId -152024-06-21✓消息与群组指定群管理员 +152024-10-30✓消息与群组指定群管理员 PostImV1ChatsByChatIdManagersAddManagers -162024-06-21✓消息与群组删除群管理员 +162024-10-30✓消息与群组删除群管理员 PostImV1ChatsByChatIdManagersDeleteManagers -172024-09-25✓消息与群组将用户或机器人拉入群聊 +172024-10-30✓消息与群组将用户或机器人拉入群聊 PostImV1ChatsByChatIdMembers -182024-06-05✓消息与群组用户或机器人主动加入群聊 +182024-10-30✓消息与群组用户或机器人主动加入群聊 PatchImV1ChatsByChatIdMembersMeJoin -192024-06-05✓消息与群组将用户或机器人移出群聊 +192024-10-30✓消息与群组将用户或机器人移出群聊 DeleteImV1ChatsByChatIdMembers -202024-06-21✓消息与群组获取群成员列表 +202024-10-30✓消息与群组获取群成员列表 GetImV1ChatsByChatIdMembers -212024-06-05✓消息与群组判断用户或机器人是否在群里 +212024-10-30✓消息与群组判断用户或机器人是否在群里 GetImV1ChatsByChatIdMembersIsInChat -222024-06-21✓消息与群组更新群公告信息 +222024-10-30✓消息与群组更新群公告信息 PatchImV1ChatsByChatIdAnnouncement -232024-06-21✓消息与群组获取群公告信息 +232024-10-30✓消息与群组获取群公告信息 GetImV1ChatsByChatIdAnnouncement -242024-07-15✓消息与群组添加会话标签页 +242024-10-30✓消息与群组添加会话标签页 PostImV1ChatsByChatIdChatTabs 252024-07-05✓通讯录创建用户组 PostContactV3Group -262024-07-15✓消息与群组删除会话标签页 +262024-10-30✓消息与群组删除会话标签页 DeleteImV1ChatsByChatIdChatTabsDeleteTabs -272024-07-15✓消息与群组更新会话标签页 +272024-10-30✓消息与群组更新会话标签页 PostImV1ChatsByChatIdChatTabsUpdateTabs -282024-07-15✓消息与群组会话标签页排序 +282024-10-30✓消息与群组会话标签页排序 PostImV1ChatsByChatIdChatTabsSortTabs -292024-07-15✓消息与群组拉取会话标签页 +292024-10-30✓消息与群组拉取会话标签页 GetImV1ChatsByChatIdChatTabsListTabs -302024-06-21✓消息与群组添加群菜单 +302024-10-31✓消息与群组添加群菜单 PostImV1ChatsByChatIdMenuTree -312024-06-21✓消息与群组删除群菜单 +312024-10-30✓消息与群组删除群菜单 DeleteImV1ChatsByChatIdMenuTree -322024-06-21✓消息与群组修改群菜单元信息 +322024-10-30✓消息与群组修改群菜单元信息 PatchImV1ChatsByChatIdMenuItemsByMenuItemId -332024-06-21✓消息与群组排序群菜单 +332024-10-30✓消息与群组排序群菜单 PostImV1ChatsByChatIdMenuTreeSort -342024-06-21✓消息与群组获取群菜单 +342024-10-30✓消息与群组获取群菜单 GetImV1ChatsByChatIdMenuTree 352024-08-12✓云文档获取我的空间（root folder）元数据 GetDriveExplorerV2RootFolderMeta @@ -291,7 +291,7 @@ PostSheetsV3SpreadsheetsBySpreadsheetTokenSheetsBySheetIdFilterViews 1462024-07-31✓云文档更新筛选视图 PatchSheetsV3SpreadsheetsBySpreadsheetTokenSheetsBySheetIdFilterViewsByFilterViewId -1472024-09-20✓通讯录创建部门 +1472024-10-29✓通讯录创建部门 PostContactV3Departments 1482024-07-31✓云文档删除筛选视图 DeleteSheetsV3SpreadsheetsBySpreadsheetTokenSheetsBySheetIdFilterViewsByFilterViewId @@ -351,33 +351,33 @@ GetBitableV1AppsByAppToken 1762024-10-17✓多维表格更新多维表格元数据 PutBitableV1AppsByAppToken -1772024-10-18✓多维表格新增一个数据表 +1772024-10-28✓多维表格新增一个数据表 PostBitableV1AppsByAppTokenTables -1782024-10-18✓多维表格新增多个数据表 +1782024-10-28✓多维表格新增多个数据表 PostBitableV1AppsByAppTokenTablesBatchCreate -1792024-10-18✓多维表格删除一个数据表 +1792024-10-28✓多维表格删除一个数据表 DeleteBitableV1AppsByAppTokenTablesByTableId 1802024-07-05✓通讯录更新部门所有信息 PutContactV3DepartmentsByDepartmentId -1812024-10-18✓多维表格删除多个数据表 +1812024-10-28✓多维表格删除多个数据表 PostBitableV1AppsByAppTokenTablesBatchDelete -1822024-10-18✓多维表格更新数据表 +1822024-10-28✓多维表格更新数据表 PatchBitableV1AppsByAppTokenTablesByTableId -1832024-10-18✓多维表格列出数据表 +1832024-10-28✓多维表格列出数据表 GetBitableV1AppsByAppTokenTables 1842024-09-18✓多维表格复制仪表盘 PostBitableV1AppsByAppTokenDashboardsByBlockIdCopy 1852024-09-18✓多维表格列出仪表盘 GetBitableV1AppsByAppTokenDashboards -1862024-09-18✓多维表格更新视图 +1862024-10-28✓多维表格更新视图 PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewId -1872024-09-18✓多维表格检索视图 +1872024-10-28✓多维表格获取视图 GetBitableV1AppsByAppTokenTablesByTableIdViewsByViewId -1882024-09-18✓多维表格列出视图 +1882024-10-28✓多维表格列出视图 GetBitableV1AppsByAppTokenTablesByTableIdViews -1892024-09-18✓多维表格新增视图 +1892024-10-28✓多维表格新增视图 PostBitableV1AppsByAppTokenTablesByTableIdViews -1902024-09-18✓多维表格删除视图 +1902024-10-28✓多维表格删除视图 DeleteBitableV1AppsByAppTokenTablesByTableIdViewsByViewId 1912024-07-05✓通讯录部门群转为普通群 PostContactV3DepartmentsUnbindDepartmentChat @@ -643,7 +643,7 @@ PostAttendanceV1ShiftsQuery 3222024-08-13✓考勤打卡查询所有班次 GetAttendanceV1Shifts -3232024-08-28✓考勤打卡创建或修改考勤组 +3232024-10-29✓考勤打卡创建或修改考勤组 PostAttendanceV1Groups 3242024-07-05✓通讯录获取单位信息 GetContactV3UnitByUnitId @@ -673,7 +673,7 @@ GetContactV3Unit 3372024-10-21✓考勤打卡获取审批通过数据 PostAttendanceV1UserApprovalsQuery -3382024-09-10✓考勤打卡写入审批结果 +3382024-10-29✓考勤打卡写入审批结果 PostAttendanceV1UserApprovals 3392024-08-13✓考勤打卡通知审批状态更新 PostAttendanceV1ApprovalInfosProcess @@ -1391,15 +1391,15 @@ GetCorehrV1DepartmentsByDepartmentId 6962024-09-06✓飞书人事批量查询部门 GetCorehrV1Departments -6972024-09-30✓飞书人事（企业版）通过地点 ID 批量获取地点信息 +6972024-10-29✓飞书人事（企业版）通过地点 ID 批量获取地点信息 PostCorehrV2LocationsBatchGet -6982024-09-30✓飞书人事创建地点 +6982024-10-29✓飞书人事创建地点 PostCorehrV1Locations 6992024-09-13✓飞书人事删除地点 DeleteCorehrV1LocationsByLocationId -7002024-09-30✓飞书人事查询单个地点 +7002024-10-29✓飞书人事查询单个地点 GetCorehrV1LocationsByLocationId -7012024-09-30✓飞书人事批量分页查询地点信息 +7012024-10-29✓飞书人事批量分页查询地点信息 GetCorehrV1Locations 7022024-09-25✓消息与群组合并转发消息 PostImV1MessagesMergeForward @@ -1495,7 +1495,7 @@ GetCorehrV1TransferReasonsQuery 7482024-03-07✓飞书人事获取异动类型列表 GetCorehrV1TransferTypesQuery -7492024-07-15✓飞书人事发起员工异动 +7492024-10-28✓飞书人事发起员工异动 PostCorehrV1JobChanges 7502024-08-21✓飞书人事（企业版）搜索员工异动信息 PostCorehrV2JobChangesSearch @@ -1547,13 +1547,13 @@ PostHireV1JobsByJobIdUpdateConfig 7742024-08-28✓招聘获取职位类别列表 GetHireV1JobTypes -7752024-09-27✓招聘创建招聘需求 +7752024-10-31✓招聘创建招聘需求 PostHireV1JobRequirements -7762024-09-27✓招聘获取招聘需求信息 +7762024-10-31✓招聘获取招聘需求信息 PostHireV1JobRequirementsSearch -7772024-09-02✓招聘获取招聘需求列表 +7772024-10-31✓招聘获取招聘需求列表 GetHireV1JobRequirements -7782024-10-17✓招聘更新招聘需求 +7782024-10-31✓招聘更新招聘需求 PutHireV1JobRequirementsByJobRequirementId 7792024-07-05✓通讯录批量获取用户信息 GetContactV3UsersBatch @@ -1579,7 +1579,7 @@ PutHireV1ExternalApplicationsByExternalApplicationId 7902024-09-09✓招聘删除外部投递 DeleteHireV1ExternalApplicationsByExternalApplicationId -7912024-10-23✓消息与群组批量发送消息 +7912024-10-30✓消息与群组批量发送消息 PostMessageV4BatchSend 7922024-09-09✓招聘创建外部面试 PostHireV1ExternalInterviews @@ -1719,13 +1719,13 @@ GetOkrV1ProgressRecordsByProgressId 8602024-10-15✓OKR上传进展记录图片 PostOkrV1ImagesUpload -8612023-04-06✓实名认证录入身份信息 +8612024-11-01✓实名认证录入身份信息 PostHumanAuthenticationV1Identities -8622024-04-15✓实名认证上传人脸基准图片 +8622024-11-01✓实名认证上传人脸基准图片 PostFaceVerifyV1UploadFaceImage -8632023-01-09✓实名认证裁剪人脸图片 +8632024-11-01✓实名认证裁剪人脸图片 PostFaceVerifyV1CropFaceImage -8642024-04-15✓实名认证查询人脸认证结果 +8642024-11-01✓实名认证查询人脸认证结果 GetFaceVerifyV1QueryAuthResult 8652022-12-19✓智能门禁修改用户部分信息 PatchAcsV1UsersByUserId @@ -1759,7 +1759,7 @@ PatchImV1MessagesByMessageId 8802023-10-25✓词典更新草稿 PutLingoV1DraftsByDraftId -8812024-04-24✓词典创建免审词条 +8812024-10-30✓词典创建免审词条 PostLingoV1Entities 8822024-04-19✓词典更新免审词条 PutLingoV1EntitiesByEntityId @@ -1779,7 +1779,7 @@ GetLingoV1Repos 8902024-10-23✓通讯录获取部门直属用户列表 GetContactV3UsersFindByDepartment -8912024-10-14✓消息与群组延时更新消息卡片 +8912024-10-28✓消息与群组延时更新消息卡片 PostInteractiveV1CardUpdate 8922023-10-25✓词典上传图片 PostLingoV1FilesUpload @@ -1977,7 +1977,7 @@ PostVcV1RoomConfigsSetCheckboardAccessCode 9892024-07-23✓视频会议创建会议室部署码 PostVcV1RoomConfigsSetRoomAccessCode -9902024-06-05✓消息与群组创建群 +9902024-10-30✓消息与群组创建群 PostImV1Chats 9912024-07-23✓视频会议查询会议室配置 GetVcV1RoomConfigsQuery @@ -2053,7 +2053,7 @@ GetCalendarV4CalendarsByCalendarIdEventsInstanceView 10272024-08-28✓招聘获取职位列表 GetHireV1Jobs -10282024-10-18✓多维表格查询记录 +10282024-10-28✓多维表格查询记录 PostBitableV1AppsByAppTokenTablesByTableIdRecordsSearch 10292024-01-26✓应用信息启停用应用 PutApplicationV6ApplicationsByAppIdManagement @@ -2387,7 +2387,7 @@ PostCorehrV1LeavesWorkCalendarDate 11942024-09-12✓飞书人事获取工作日历 PostCorehrV1LeavesWorkCalendar -11952024-09-13✓飞书人事（企业版）查询编制规划明细信息 +11952024-10-30✓飞书人事（企业版）查询编制规划明细信息 PostCorehrV2WorkforcePlanDetailsBatch 11962024-10-21✓飞书人事（企业版）查询指定时间范围内当前生效信息发生变更的部门 GetCorehrV2DepartmentsQueryRecentChange @@ -2463,7 +2463,7 @@ GetHireV1TalentTags 12322024-10-18✓招聘操作人才标签 PostHireV1TalentsByTalentIdTag -12332024-10-17✓飞书人事（企业版）获取指定人员审批任务列表 +12332024-10-29✓飞书人事（企业版）获取指定人员审批任务列表 GetCorehrV2Approvers 12342024-10-22✓智能伙伴创建平台执行数据知识问答 PostAilyV1AppsByAppIdKnowledgesAsk @@ -2473,10 +2473,26 @@ GetAilyV1AppsByAppIdDataAssetTags 12372024-10-21✓飞书人事（企业版）查询指定时间范围内当前生效信息发生变更的公司 GetCorehrV2CompaniesQueryRecentChange -12382024-10-24新增智能伙伴创建平台调用技能 +12382024-10-24✓智能伙伴创建平台调用技能 PostAilyV1AppsByAppIdSkillsBySkillIdStart -12392024-10-24新增智能伙伴创建平台获取技能信息 +12392024-10-24✓智能伙伴创建平台获取技能信息 GetAilyV1AppsByAppIdSkillsBySkillId -12402024-10-24新增智能伙伴创建平台查询技能列表 +12402024-10-24✓智能伙伴创建平台查询技能列表 GetAilyV1AppsByAppIdSkills +12412024-10-30新增飞书人事（企业版）查询编制规划方案 +GetCorehrV2WorkforcePlans +12422024-10-29新增飞书人事（企业版）启用/停用公司 +PostCorehrV2CompaniesActive +12432024-10-30新增帐号退出登录 +PostPassportV1SessionsLogout +12442024-10-29新增飞书人事（企业版）添加地点地址 +PostCorehrV2LocationsByLocationIdAddresses +12452024-10-29新增飞书人事（企业版）更新地点地址 +PatchCorehrV2LocationsByLocationIdAddressesByAddressId +12462024-10-29新增飞书人事（企业版）启用/停用地点 +PostCorehrV2LocationsActive +12472024-10-29新增飞书人事（企业版）更新地点 +PatchCorehrV2LocationsByLocationId +12482024-10-29新增飞书人事（企业版）删除地点地址 +DeleteCorehrV2LocationsByLocationIdAddressesByAddressId diff --git a/UserAccessList.md b/UserAccessList.md index 93747090..45bc4e42 100644 --- a/UserAccessList.md +++ b/UserAccessList.md @@ -171,33 +171,33 @@ GetBitableV1AppsByAppToken 862024-10-17✓多维表格更新多维表格元数据 PutBitableV1AppsByAppToken -872024-10-18✓多维表格新增一个数据表 +872024-10-28✓多维表格新增一个数据表 PostBitableV1AppsByAppTokenTables -882024-10-18✓多维表格新增多个数据表 +882024-10-28✓多维表格新增多个数据表 PostBitableV1AppsByAppTokenTablesBatchCreate -892024-10-18✓多维表格删除一个数据表 +892024-10-28✓多维表格删除一个数据表 DeleteBitableV1AppsByAppTokenTablesByTableId -902024-10-18✓多维表格删除多个数据表 +902024-10-28✓多维表格删除多个数据表 PostBitableV1AppsByAppTokenTablesBatchDelete 912024-08-21✓消息与群组删除消息表情回复 DeleteImV1MessagesByMessageIdReactionsByReactionId -922024-10-18✓多维表格更新数据表 +922024-10-28✓多维表格更新数据表 PatchBitableV1AppsByAppTokenTablesByTableId -932024-10-18✓多维表格列出数据表 +932024-10-28✓多维表格列出数据表 GetBitableV1AppsByAppTokenTables 942024-09-18✓多维表格复制仪表盘 PostBitableV1AppsByAppTokenDashboardsByBlockIdCopy 952024-09-18✓多维表格列出仪表盘 GetBitableV1AppsByAppTokenDashboards -962024-09-18✓多维表格更新视图 +962024-10-28✓多维表格更新视图 PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewId -972024-09-18✓多维表格检索视图 +972024-10-28✓多维表格获取视图 GetBitableV1AppsByAppTokenTablesByTableIdViewsByViewId -982024-09-18✓多维表格列出视图 +982024-10-28✓多维表格列出视图 GetBitableV1AppsByAppTokenTablesByTableIdViews -992024-09-18✓多维表格新增视图 +992024-10-28✓多维表格新增视图 PostBitableV1AppsByAppTokenTablesByTableIdViews -1002024-09-18✓多维表格删除视图 +1002024-10-28✓多维表格删除视图 DeleteBitableV1AppsByAppTokenTablesByTableIdViewsByViewId 1012024-09-18✓多维表格更新表单元数据 PatchBitableV1AppsByAppTokenTablesByTableIdFormsByFormId @@ -291,7 +291,7 @@ PostWikiV1NodesSearch 1462023-12-29✓云文档获取订阅状态 GetDriveV1FilesByFileTokenSubscriptionsBySubscriptionId -1472024-06-21✓消息与群组解散群 +1472024-10-30✓消息与群组解散群 DeleteImV1ChatsByChatId 1482023-12-29✓云文档创建订阅 PostDriveV1FilesByFileTokenSubscriptions @@ -313,7 +313,7 @@ PatchCalendarV4CalendarsByCalendarId 1572024-08-07✓日历搜索日历 PostCalendarV4CalendarsSearch -1582024-06-21✓消息与群组更新群信息 +1582024-10-30✓消息与群组更新群信息 PutImV1ChatsByChatId 1592024-08-14✓日历订阅日历 PostCalendarV4CalendarsByCalendarIdSubscribe @@ -335,7 +335,7 @@ PostCalendarV4CalendarsByCalendarIdAclsUnsubscription 1682024-08-14✓日历创建日程 PostCalendarV4CalendarsByCalendarIdEvents -1692024-06-21✓消息与群组更新群发言权限 +1692024-10-30✓消息与群组更新群发言权限 PutImV1ChatsByChatIdModeration 1702024-08-06✓日历删除日程 DeleteCalendarV4CalendarsByCalendarIdEventsByEventId @@ -357,7 +357,7 @@ PostCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingChat 1792024-05-24✓会议室查询会议室忙闲 GetMeetingRoomFreebusyBatchGet -1802024-06-21✓消息与群组获取群信息 +1802024-10-30✓消息与群组获取群信息 GetImV1ChatsByChatId 1812024-07-16✓日历添加日程参与人 PostCalendarV4CalendarsByCalendarIdEventsByEventIdAttendees @@ -379,7 +379,7 @@ PostVcV1ReservesApply 1902024-09-09✓视频会议删除预约 DeleteVcV1ReservesByReserveId -1912024-06-21✓消息与群组更新群置顶 +1912024-10-30✓消息与群组更新群置顶 PostImV1ChatsByChatIdTopNoticePutTopNotice 1922024-09-09✓视频会议更新预约 PutVcV1ReservesByReserveId @@ -401,7 +401,7 @@ PatchVcV1MeetingsByMeetingIdRecordingStart 2012024-06-14✓视频会议停止录制 PatchVcV1MeetingsByMeetingIdRecordingStop -2022024-06-21✓消息与群组撤销群置顶 +2022024-10-30✓消息与群组撤销群置顶 PostImV1ChatsByChatIdTopNoticeDeleteTopNotice 2032024-08-07✓视频会议获取录制文件 GetVcV1MeetingsByMeetingIdRecording @@ -423,7 +423,7 @@ PostVcV1RoomLevels 2122023-07-14删除视频会议删除会议室层级 PostVcV1RoomLevelsDel -2132024-06-05✓消息与群组获取用户或机器人所在的群列表 +2132024-10-30✓消息与群组获取用户或机器人所在的群列表 GetImV1Chats 2142023-07-14删除视频会议更新会议室层级 PatchVcV1RoomLevelsByRoomLevelId @@ -447,7 +447,7 @@ PostVcV1RoomsMget 2242024-07-05✓通讯录批量获取用户信息 GetContactV3UsersBatch -2252024-06-05✓消息与群组搜索对用户或机器人可见的群列表 +2252024-10-30✓消息与群组搜索对用户或机器人可见的群列表 GetImV1ChatsSearch 2262023-07-14删除视频会议查询会议室列表 GetVcV1Rooms @@ -469,7 +469,7 @@ GetVcV1ReserveConfigsByReserveConfigIdAdmin 2352023-08-29删除视频会议更新会议室预定管理员 PatchVcV1ReserveConfigsByReserveConfigIdAdmin -2362024-06-21✓消息与群组获取群成员发言权限 +2362024-10-30✓消息与群组获取群成员发言权限 GetImV1ChatsByChatIdModeration 2372023-07-14删除视频会议查询禁用状态变更通知 GetVcV1ReserveConfigsByReserveConfigIdDisableInform @@ -491,7 +491,7 @@ PostHelpdeskV1AgentSchedules 2462024-03-06✓服务台删除客服工作日程 DeleteHelpdeskV1AgentsByAgentIdSchedules -2472024-06-21✓消息与群组获取群分享链接 +2472024-10-30✓消息与群组获取群分享链接 PostImV1ChatsByChatIdLink 2482024-03-06✓服务台更新客服工作日程 PatchHelpdeskV1AgentsByAgentIdSchedules @@ -513,7 +513,7 @@ PostHelpdeskV1Faqs 2572024-03-06✓服务台删除知识库 DeleteHelpdeskV1FaqsById -2582024-06-21✓消息与群组指定群管理员 +2582024-10-30✓消息与群组指定群管理员 PostImV1ChatsByChatIdManagersAddManagers 2592024-06-27✓服务台修改知识库 PatchHelpdeskV1FaqsById @@ -535,7 +535,7 @@ PostHelpdeskV1NotificationsByNotificationIdSubmitApprove 2682023-08-15✓服务台取消审核 PostHelpdeskV1NotificationsByNotificationIdCancelApprove -2692024-06-21✓消息与群组删除群管理员 +2692024-10-30✓消息与群组删除群管理员 PostImV1ChatsByChatIdManagersDeleteManagers 2702023-08-15✓服务台执行推送 PostHelpdeskV1NotificationsByNotificationIdExecuteSend @@ -557,7 +557,7 @@ GetTaskV1Tasks 2792023-07-13✓任务新增提醒时间 PostTaskV1TasksByTaskIdReminders -2802024-09-25✓消息与群组将用户或机器人拉入群聊 +2802024-10-30✓消息与群组将用户或机器人拉入群聊 PostImV1ChatsByChatIdMembers 2812023-07-13✓任务删除提醒时间 DeleteTaskV1TasksByTaskIdRemindersByReminderId @@ -579,7 +579,7 @@ DeleteTaskV1TasksByTaskIdFollowersByFollowerId 2902023-07-13✓任务批量删除关注人 PostTaskV1TasksByTaskIdBatchDeleteFollower -2912024-06-05✓消息与群组用户或机器人主动加入群聊 +2912024-10-30✓消息与群组用户或机器人主动加入群聊 PatchImV1ChatsByChatIdMembersMeJoin 2922022-12-23✓任务获取关注人列表 GetTaskV1TasksByTaskIdFollowers @@ -601,7 +601,7 @@ DeleteTaskV2TasksByTaskGuid 3012023-08-07✓任务添加任务成员 PostTaskV2TasksByTaskGuidAddMembers -3022024-06-05✓消息与群组将用户或机器人移出群聊 +3022024-10-30✓消息与群组将用户或机器人移出群聊 DeleteImV1ChatsByChatIdMembers 3032023-08-07✓任务移除任务成员 PostTaskV2TasksByTaskGuidRemoveMembers @@ -623,7 +623,7 @@ PostTaskV2TasksByTaskGuidRemoveDependencies 3122023-07-20✓任务创建子任务 PostTaskV2TasksByTaskGuidSubtasks -3132024-06-21✓消息与群组获取群成员列表 +3132024-10-30✓消息与群组获取群成员列表 GetImV1ChatsByChatIdMembers 3142023-07-20✓任务获取任务的子任务列表 GetTaskV2TasksByTaskGuidSubtasks @@ -645,7 +645,7 @@ GetTaskV2Tasklists 3232023-11-09✓任务创建动态订阅 PostTaskV2TasklistsByTasklistGuidActivitySubscriptions -3242024-06-05✓消息与群组判断用户或机器人是否在群里 +3242024-10-30✓消息与群组判断用户或机器人是否在群里 GetImV1ChatsByChatIdMembersIsInChat 3252023-11-09✓任务获取动态订阅 GetTaskV2TasklistsByTasklistGuidActivitySubscriptionsByActivitySubscriptionGuid @@ -669,7 +669,7 @@ PostTaskV2AttachmentsUpload 3352024-10-23✓通讯录获取部门直属用户列表 GetContactV3UsersFindByDepartment -3362024-06-21✓消息与群组更新群公告信息 +3362024-10-30✓消息与群组更新群公告信息 PatchImV1ChatsByChatIdAnnouncement 3372023-11-06✓任务列取附件 GetTaskV2Attachments @@ -691,7 +691,7 @@ GetTaskV2SectionsBySectionGuidTasks 3462024-04-23✓任务创建自定义字段 PostTaskV2CustomFields -3472024-06-21✓消息与群组获取群公告信息 +3472024-10-30✓消息与群组获取群公告信息 GetImV1ChatsByChatIdAnnouncement 3482024-04-23✓任务获取自定义字段 GetTaskV2CustomFieldsByCustomFieldGuid @@ -713,7 +713,7 @@ PostSearchV2Message 3572023-11-27✓搜索搜索应用 PostSearchV2App -3582024-07-15✓消息与群组添加会话标签页 +3582024-10-30✓消息与群组添加会话标签页 PostImV1ChatsByChatIdChatTabs 3592024-04-25✓OKR获取用户的 OKR 列表 GetOkrV1UsersByUserIdOkrs @@ -735,7 +735,7 @@ PostPerformanceV1ReviewDatasQuery 3682023-10-25✓词典创建草稿 PostLingoV1Drafts -3692024-07-15✓消息与群组删除会话标签页 +3692024-10-30✓消息与群组删除会话标签页 DeleteImV1ChatsByChatIdChatTabsDeleteTabs 3702023-10-25✓词典更新草稿 PutLingoV1DraftsByDraftId @@ -757,7 +757,7 @@ GetLingoV1Classifications 3792023-10-25✓词典获取词库列表 GetLingoV1Repos -3802024-07-15✓消息与群组更新会话标签页 +3802024-10-30✓消息与群组更新会话标签页 PostImV1ChatsByChatIdChatTabsUpdateTabs 3812023-10-25✓词典上传图片 PostLingoV1FilesUpload @@ -779,7 +779,7 @@ PostBaikeV1Entities 3902023-10-13✓词典[不推荐] 更新免审词条 PutBaikeV1EntitiesByEntityId -3912024-07-15✓消息与群组会话标签页排序 +3912024-10-30✓消息与群组会话标签页排序 PostImV1ChatsByChatIdChatTabsSortTabs 3922023-10-13✓词典[不推荐] 获取词条详情 GetBaikeV1EntitiesByEntityId @@ -801,7 +801,7 @@ GetBaikeV1FilesByFileTokenDownload 4012024-08-14✓通讯录获取用户列表 GetContactV3Users -4022024-07-15✓消息与群组拉取会话标签页 +4022024-10-30✓消息与群组拉取会话标签页 GetImV1ChatsByChatIdChatTabsListTabs 4032024-08-02✓通讯录[不推荐] 获取部门信息列表 GetContactV3Departments @@ -987,7 +987,7 @@ DeleteAcsV1VisitorsByVisitorId 4942024-07-16✓日历查询日程视图 GetCalendarV4CalendarsByCalendarIdEventsInstanceView -4952024-10-18✓多维表格查询记录 +4952024-10-28✓多维表格查询记录 PostBitableV1AppsByAppTokenTablesByTableIdRecordsSearch 4962024-02-27✓画板获取所有节点 GetBoardV1WhiteboardsByWhiteboardIdNodes @@ -1065,10 +1065,10 @@ GetAilyV1AppsByAppIdDataAssets 5332024-10-22✓智能伙伴创建平台获取数据知识分类列表 GetAilyV1AppsByAppIdDataAssetTags -5342024-10-24新增智能伙伴创建平台调用技能 +5342024-10-24✓智能伙伴创建平台调用技能 PostAilyV1AppsByAppIdSkillsBySkillIdStart -5352024-10-24新增智能伙伴创建平台获取技能信息 +5352024-10-24✓智能伙伴创建平台获取技能信息 GetAilyV1AppsByAppIdSkillsBySkillId -5362024-10-24新增智能伙伴创建平台查询技能列表 +5362024-10-24✓智能伙伴创建平台查询技能列表 GetAilyV1AppsByAppIdSkills diff --git a/src/Attendance/PostAttendanceV1UserApprovalsBodyDto.cs b/src/Attendance/PostAttendanceV1UserApprovalsBodyDto.cs index 8e4b2de9..6f37956f 100644 --- a/src/Attendance/PostAttendanceV1UserApprovalsBodyDto.cs +++ b/src/Attendance/PostAttendanceV1UserApprovalsBodyDto.cs @@ -310,7 +310,7 @@ public record UserLeaveI18nNames public record UserOvertimeWork { /// - /// 加班时长 + /// 加班时长，如需使用此字段进行加班时长计算，请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)开通。默认采用start_time和end_time计算 /// 必填：是 /// 示例值：1.5 /// diff --git a/src/Auth.Spec/PostAuthV3TenantAccessTokenInternalBodyDto.cs b/src/Auth.Spec/PostAuthV3TenantAccessTokenInternalBodyDto.cs index dc2f03db..bca9c6fc 100644 --- a/src/Auth.Spec/PostAuthV3TenantAccessTokenInternalBodyDto.cs +++ b/src/Auth.Spec/PostAuthV3TenantAccessTokenInternalBodyDto.cs @@ -15,9 +15,10 @@ namespace FeishuNetSdk.Auth.Spec; /// /// 自建应用获取 tenant_access_token 请求体 /// 自建应用通过此接口获取 `tenant_access_token`。 -/// **说明：** `tenant_access_token` 的最大有效期是 2 小时。 -/// - 如果在有效期小于 30 分钟的情况下，调用本接口，会返回一个新的 `tenant_access_token`，这会同时存在两个有效的 `tenant_access_token`。 -/// - 如果有效期不小于 30 分钟，调用本接口，会返回原有的 `tenant_access_token`。 +/// 注意事项： +/// `tenant_access_token` 的最大有效期是 2 小时。 +/// - 剩余有效期小于 30 分钟时，调用本接口会返回一个新的 `tenant_access_token`，这会同时存在两个有效的 `tenant_access_token`。 +/// - 剩余有效期大于等于 30 分钟时，调用本接口会返回原有的 `tenant_access_token`。 /// 接口ID：6995779366223724548 /// 文档地址：https://open.feishu.cn/document/server-docs/authentication-management/access-token/tenant_access_token_internal /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fukDNz4SO0MjL5QzM%2fauth-v3%2fauth%2ftenant_access_token_internal diff --git a/src/Auth.Spec/PostAuthV3TenantAccessTokenInternalResponseDto.cs b/src/Auth.Spec/PostAuthV3TenantAccessTokenInternalResponseDto.cs index b323d7cf..26ceb6e7 100644 --- a/src/Auth.Spec/PostAuthV3TenantAccessTokenInternalResponseDto.cs +++ b/src/Auth.Spec/PostAuthV3TenantAccessTokenInternalResponseDto.cs @@ -15,9 +15,10 @@ namespace FeishuNetSdk.Auth.Spec; /// /// 自建应用获取 tenant_access_token 响应体 /// 自建应用通过此接口获取 `tenant_access_token`。 -/// **说明：** `tenant_access_token` 的最大有效期是 2 小时。 -/// - 如果在有效期小于 30 分钟的情况下，调用本接口，会返回一个新的 `tenant_access_token`，这会同时存在两个有效的 `tenant_access_token`。 -/// - 如果有效期不小于 30 分钟，调用本接口，会返回原有的 `tenant_access_token`。 +/// 注意事项： +/// `tenant_access_token` 的最大有效期是 2 小时。 +/// - 剩余有效期小于 30 分钟时，调用本接口会返回一个新的 `tenant_access_token`，这会同时存在两个有效的 `tenant_access_token`。 +/// - 剩余有效期大于等于 30 分钟时，调用本接口会返回原有的 `tenant_access_token`。 /// 接口ID：6995779366223724548 /// 文档地址：https://open.feishu.cn/document/server-docs/authentication-management/access-token/tenant_access_token_internal /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fukDNz4SO0MjL5QzM%2fauth-v3%2fauth%2ftenant_access_token_internal diff --git a/src/Base/GetBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdResponseDto.cs b/src/Base/GetBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdResponseDto.cs index 5e1d4571..53b5cf68 100644 --- a/src/Base/GetBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdResponseDto.cs +++ b/src/Base/GetBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdResponseDto.cs @@ -9,12 +9,12 @@ // // MIT // -// 检索视图 响应体 +// 获取视图 响应体 // ************************************************************************ namespace FeishuNetSdk.Base; /// -/// 检索视图 响应体 -/// 该接口根据 view_id 检索现有视图 +/// 获取视图 响应体 +/// 根据视图 ID 获取现有视图信息，包括视图名称、类型、属性等。 /// 接口ID：7177650713441845251 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table-view/get /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table-view%2fget @@ -34,7 +34,7 @@ public record GetBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdResponseDto public record AppTableView { /// - /// 视图Id + /// 视图 ID /// 必填：否 /// 示例值：vewieWxfON /// @@ -42,7 +42,7 @@ public record AppTableView public string? ViewId { get; set; } /// - /// 视图名字 + /// 视图名称 /// 必填：否 /// 示例值：表格 1 /// @@ -50,7 +50,13 @@ public record AppTableView public string? ViewName { get; set; } /// - /// 视图类型 + /// 视图类型。 + /// **可选值有**： + /// - `grid`：表格视图 + /// - `kanban`：看板视图 + /// - `gallery`：画册视图 + /// - `gantt`：甘特视图 + /// - `form`：表单视图 /// 必填：否 /// 示例值：grid /// @@ -145,7 +151,7 @@ public record AppTableViewPropertyFilterInfoCondition public string? Value { get; set; } /// - /// 过滤条件的唯一ID + /// 过滤条件的 ID /// 必填：否 /// 示例值：conNaOEK6O /// @@ -192,7 +198,7 @@ public record AppTableViewPropertyFilterInfoCondition } /// - /// 隐藏字段ID列表 + /// 隐藏字段 ID 列表 /// 必填：否 /// 示例值：["fldCGzANXx", "fldCGzANXx"] /// 最大长度：300 @@ -213,7 +219,7 @@ public record AppTableViewPropertyFilterInfoCondition public record AppTableViewPropertyHierarchyConfig { /// - /// 层级结构的关联列id + /// 层级结构的关联列 ID /// 必填：否 /// 示例值：fldTca**hb /// diff --git a/src/Base/GetBitableV1AppsByAppTokenTablesByTableIdViewsResponseDto.cs b/src/Base/GetBitableV1AppsByAppTokenTablesByTableIdViewsResponseDto.cs index b49a0eee..a0cf14e9 100644 --- a/src/Base/GetBitableV1AppsByAppTokenTablesByTableIdViewsResponseDto.cs +++ b/src/Base/GetBitableV1AppsByAppTokenTablesByTableIdViewsResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 列出视图 响应体 -/// 根据 app_token 和 table_id，获取数据表的所有视图 +/// 获取多维表格数据表中的所有视图。 /// 接口ID：6978670625209597954 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table-view/list /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table-view%2flist @@ -34,7 +34,7 @@ public record GetBitableV1AppsByAppTokenTablesByTableIdViewsResponseDto public record AppTableView { /// - /// 视图Id + /// 视图 ID /// 必填：否 /// 示例值：vewieWxfON /// @@ -42,15 +42,21 @@ public record AppTableView public string? ViewId { get; set; } /// - /// 视图名字 + /// 视图名称 /// 必填：否 - /// 示例值：表格1 + /// 示例值：表格 1 /// [JsonPropertyName("view_name")] public string? ViewName { get; set; } /// - /// 视图类型 + /// 视图类型。 + /// **可选值有**： + /// - `grid`：表格视图 + /// - `kanban`：看板视图 + /// - `gallery`：画册视图 + /// - `gantt`：甘特视图 + /// - `form`：表单视图 /// 必填：否 /// 示例值：grid /// @@ -58,7 +64,7 @@ public record AppTableView public string? ViewType { get; set; } /// - /// 视图公共等级 Public、Locked、Private + /// 视图公共等级 /// 必填：否 /// 示例值：Public /// 可选值： @@ -71,7 +77,7 @@ public record AppTableView public string? ViewPublicLevel { get; set; } /// - /// 个人视图的owner_id，id类型和 user_id_type 参数保持一致 + /// 个人视图的所有者的 ID，ID 类型和查询参数 user_id_type 保持一致 /// 必填：否 /// 示例值：ou_2910013f1e6456f16a0ce75ede950a0a /// diff --git a/src/Base/GetBitableV1AppsByAppTokenTablesResponseDto.cs b/src/Base/GetBitableV1AppsByAppTokenTablesResponseDto.cs index cc99b363..407b5bab 100644 --- a/src/Base/GetBitableV1AppsByAppTokenTablesResponseDto.cs +++ b/src/Base/GetBitableV1AppsByAppTokenTablesResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 列出数据表 响应体 -/// 根据 app_token，获取多维表格下的所有数据表。 +/// 列出多维表格中的所有数据表，包括其 ID、版本号和名称。 /// 接口ID：6960166873968476163 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table/list /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table%2flist @@ -58,7 +58,7 @@ public record GetBitableV1AppsByAppTokenTablesResponseDto public record AppTable { /// - /// 数据表 id + /// 数据表 ID /// 必填：否 /// 示例值：\- /// @@ -66,7 +66,7 @@ public record AppTable public string? TableId { get; set; } /// - /// 数据表的版本号 + /// 数据表的版本号。对数据表进行修改时更新，如新增、删除记录，修改数据表名称等，初始为 1，每次更新+1 /// 必填：否 /// 示例值：\- /// @@ -74,7 +74,7 @@ public record AppTable public int? Revision { get; set; } /// - /// 数据表名字 + /// 数据表名称 /// 必填：否 /// 示例值：\- /// diff --git a/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdBodyDto.cs b/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdBodyDto.cs index d41d1ad8..cff6d7d5 100644 --- a/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdBodyDto.cs +++ b/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdBodyDto.cs @@ -14,9 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 更新数据表 请求体 -/// 该接口用于更新数据表的基本信息，包括数据表的名称等。 -/// note -/// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) +/// 更新数据表的名称。 /// 接口ID：7182466310810402817 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table/patch /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table%2fpatch @@ -25,11 +23,11 @@ public record PatchBitableV1AppsByAppTokenTablesByTableIdBodyDto { /// /// 数据表的新名称。 - /// 请注意： - /// 1. 名称中的首尾空格将会被去除。 - /// 2. 如果名称为空或和旧名称相同，接口仍然会返回成功，但是名称不会被更改。 + /// **注意**： + /// - 名称中的首尾空格将会被去除。 + /// - 如果名称为空或和旧名称相同，接口仍然会返回成功，但是名称不会被更改。 /// 必填：否 - /// 示例值：数据表的新名称 + /// 示例值：新的数据表名称 /// 最大长度：100 /// 最小长度：1 /// diff --git a/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdResponseDto.cs b/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdResponseDto.cs index ff1b9543..81804e93 100644 --- a/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdResponseDto.cs +++ b/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdResponseDto.cs @@ -14,9 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 更新数据表 响应体 -/// 该接口用于更新数据表的基本信息，包括数据表的名称等。 -/// note -/// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) +/// 更新数据表的名称。 /// 接口ID：7182466310810402817 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table/patch /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table%2fpatch @@ -24,9 +22,9 @@ namespace FeishuNetSdk.Base; public record PatchBitableV1AppsByAppTokenTablesByTableIdResponseDto { /// - /// 数据表的名称 + /// 新的数据表名称 /// 必填：否 - /// 示例值：数据表的新名称 + /// 示例值：新的数据表名称 /// [JsonPropertyName("name")] public string? Name { get; set; } diff --git a/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdBodyDto.cs b/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdBodyDto.cs index 42b26212..7f3501a3 100644 --- a/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdBodyDto.cs +++ b/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 更新视图 请求体 -/// 该接口用于增量修改视图信息 +/// 增量更新视图信息，包括视图名称、属性等，可设置视图的筛选条件等。 /// 接口ID：7177650713441828867 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table-view/patch /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table-view%2fpatch @@ -24,7 +24,7 @@ public record PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdBodyDto /// /// 视图名称 /// 必填：否 - /// 示例值：grid + /// 示例值：表格视图 1 /// [JsonPropertyName("view_name")] public string? ViewName { get; set; } @@ -54,7 +54,7 @@ public record AppTableViewProperty public record AppTableViewPropertyFilterInfo { /// - /// 多个筛选条件的关系 + /// 多个筛选条件的关系，表示条件之间的逻辑连接词 /// 必填：是 /// 示例值：and /// 可选值： @@ -67,7 +67,7 @@ public record AppTableViewPropertyFilterInfo public string Conjunction { get; set; } = string.Empty; /// - /// 筛选条件 + /// 筛选条件集合 /// 必填：是 /// 最大长度：50 /// @@ -75,20 +75,20 @@ public record AppTableViewPropertyFilterInfo public AppTableViewPropertyFilterInfoCondition[] Conditions { get; set; } = Array.Empty(); /// - /// 筛选条件 + /// 筛选条件集合 /// public record AppTableViewPropertyFilterInfoCondition { /// - /// 用于过滤的字段唯一ID + /// 用于过滤的字段的 ID。可通过[列出字段](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/list)接口获取 /// 必填：是 - /// 示例值：fldVioU**1 + /// 示例值：fldmeqmpVA /// [JsonPropertyName("field_id")] public string FieldId { get; set; } = string.Empty; /// - /// 过滤操作的类型 + /// 过滤操作的类型，条件运算符 /// 必填：是 /// 示例值：is /// 可选值： @@ -109,9 +109,9 @@ public record AppTableViewPropertyFilterInfoCondition public string Operator { get; set; } = string.Empty; /// - /// 筛选值 + /// 条件的值，可以是单个值或多个值的数组。不同字段类型和不同的 operator 可填的值不同。详情参考下文字段目标值（value）填写说明。 /// 必填：否 - /// 示例值：["optbdVH***","optrpd3***"] + /// 示例值：`[\"text content\"]` /// [JsonPropertyName("value")] public string? Value { get; set; } @@ -119,9 +119,9 @@ public record AppTableViewPropertyFilterInfoCondition } /// - /// 隐藏字段ID列表 + /// 隐藏字段 ID 列表 /// 必填：否 - /// 示例值：["fldCGzANXx","fldCGzANXx"] + /// 示例值：["fldCGzANXx", "fldCGzANXx"] /// 最大长度：300 /// [JsonPropertyName("hidden_fields")] @@ -140,9 +140,9 @@ public record AppTableViewPropertyFilterInfoCondition public record AppTableViewPropertyHierarchyConfig { /// - /// 层级结构的关联列id + /// 层级结构的关联列 ID /// 必填：否 - /// 示例值：fldTca**hb + /// 示例值：fldmeqmpVA /// [JsonPropertyName("field_id")] public string? FieldId { get; set; } diff --git a/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdResponseDto.cs b/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdResponseDto.cs index 37f35602..78bc02cb 100644 --- a/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdResponseDto.cs +++ b/src/Base/PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 更新视图 响应体 -/// 该接口用于增量修改视图信息 +/// 增量更新视图信息，包括视图名称、属性等，可设置视图的筛选条件等。 /// 接口ID：7177650713441828867 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table-view/patch /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table-view%2fpatch @@ -34,7 +34,7 @@ public record PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdResponseDt public record AppTableView { /// - /// 视图Id + /// 视图 ID /// 必填：否 /// 示例值：vewieWxfON /// @@ -42,9 +42,9 @@ public record AppTableView public string? ViewId { get; set; } /// - /// 视图名字 + /// 视图名称 /// 必填：否 - /// 示例值：表格 1 + /// 示例值：表格视图 1 /// [JsonPropertyName("view_name")] public string? ViewName { get; set; } @@ -108,9 +108,9 @@ public record AppTableViewPropertyFilterInfo public record AppTableViewPropertyFilterInfoCondition { /// - /// 用于过滤的字段唯一ID + /// 用于过滤的字段的 ID /// 必填：是 - /// 示例值：fldVioU**1 + /// 示例值：fldmeqmpVA /// [JsonPropertyName("field_id")] public string FieldId { get; set; } = string.Empty; @@ -139,13 +139,13 @@ public record AppTableViewPropertyFilterInfoCondition /// /// 筛选值 /// 必填：否 - /// 示例值：["optbdVH***", "optrpd3***"] + /// 示例值：[\"text content\"] /// [JsonPropertyName("value")] public string? Value { get; set; } /// - /// 过滤条件的唯一ID + /// 过滤条件的 ID /// 必填：否 /// 示例值：conNaOEK6O /// @@ -213,7 +213,7 @@ public record AppTableViewPropertyFilterInfoCondition public record AppTableViewPropertyHierarchyConfig { /// - /// 层级结构的关联列id + /// 层级结构的关联列 ID /// 必填：否 /// 示例值：fldTca**hb /// diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesBatchCreateBodyDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesBatchCreateBodyDto.cs index a11e8474..4eb55e21 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesBatchCreateBodyDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesBatchCreateBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 新增多个数据表 请求体 -/// 新增多个数据表。 +/// 新增多个数据表，仅可指定数据表名称。 /// 接口ID：6960166873968558083 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table/batch_create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table%2fbatch_create @@ -34,12 +34,11 @@ public record PostBitableV1AppsByAppTokenTablesBatchCreateBodyDto public record ReqTable { /// - /// 数据表名称 - /// 请注意： - /// 1. 名称中的首尾空格将会被去除。 + /// 数据表名称。名称中的首尾空格将会被默认去除。 /// 必填：否 - /// 示例值：table1 + /// 示例值：一个新的数据表 /// 最大长度：100 + /// 最小长度：1 /// [JsonPropertyName("name")] public string? Name { get; set; } diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesBatchCreateResponseDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesBatchCreateResponseDto.cs index 503038a6..17522207 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesBatchCreateResponseDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesBatchCreateResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 新增多个数据表 响应体 -/// 新增多个数据表。 +/// 新增多个数据表，仅可指定数据表名称。 /// 接口ID：6960166873968558083 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table/batch_create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table%2fbatch_create diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesBatchDeleteBodyDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesBatchDeleteBodyDto.cs index 3afee960..6af7b735 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesBatchDeleteBodyDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesBatchDeleteBodyDto.cs @@ -14,9 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 删除多个数据表 请求体 -/// 删除多个数据表。 -/// note -/// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) +/// 删除多个数据表。如果多维表格中只剩最后一张数据表，则不允许被删除。 /// 接口ID：6960166873968459779 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table/batch_delete /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table%2fbatch_delete @@ -24,7 +22,7 @@ namespace FeishuNetSdk.Base; public record PostBitableV1AppsByAppTokenTablesBatchDeleteBodyDto { /// - /// 待删除的数据表的 ID。当前一次操作最多支持50个数据表。 + /// 待删除的数据表的 ID。当前一次操作最多支持 50 个数据表。 /// 获取方式： /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id`。 /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id`。 diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesBodyDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesBodyDto.cs index 25c5d60f..5e023941 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesBodyDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 新增一个数据表 请求体 -/// 新增一个数据表，默认仅包含索引列，也可以指定一部分初始字段。 +/// 新增一个数据表，默认仅包含索引字段，也可以指定一部分初始字段。 /// 接口ID：6960166873968541699 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table%2fcreate @@ -35,6 +35,8 @@ public record ReqTable { /// /// 数据表名称。名称中的首尾空格将会被默认去除。 + /// **注意**： + /// 该字段必填。 /// 必填：否 /// 示例值：一个新的数据表 /// 最大长度：100 @@ -55,10 +57,18 @@ public record ReqTable public string? DefaultViewName { get; set; } /// - /// 数据表的初始字段。 - /// 注意： - /// - 如果 default_view_name 字段和 fields 字段都不填写，将会创建一个仅包含索引列的空数据表。 - /// - 如果指定了本字段，将会创建一个包含初始字段的数据表、且默认第一个字段为索引列。 + /// 数据表的初始字段。了解如何填写字段，参考[字段编辑指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/guide)。 + /// **注意**： + /// - 如果 `default_view_name` 字段和 `fields` 字段都不填写，将会创建一个仅包含索引字段的空数据表。 + /// - 如果指定了本字段，将会创建一个包含初始字段的数据表、且默认第一个字段为索引字段。 + /// - 索引字段仅支持以下类型： + /// - 1：多行文本 + /// - 2：数字 + /// - 5：日期 + /// - 13：电话号码 + /// - 15：超链接 + /// - 20：公式 + /// - 22：地理位置 /// 必填：否 /// 最大长度：300 /// 最小长度：1 @@ -67,17 +77,25 @@ public record ReqTable public AppTableCreateHeader[]? Fields { get; set; } /// - /// 数据表的初始字段。 - /// 注意： - /// - 如果 default_view_name 字段和 fields 字段都不填写，将会创建一个仅包含索引列的空数据表。 - /// - 如果指定了本字段，将会创建一个包含初始字段的数据表、且默认第一个字段为索引列。 + /// 数据表的初始字段。了解如何填写字段，参考[字段编辑指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/guide)。 + /// **注意**： + /// - 如果 `default_view_name` 字段和 `fields` 字段都不填写，将会创建一个仅包含索引字段的空数据表。 + /// - 如果指定了本字段，将会创建一个包含初始字段的数据表、且默认第一个字段为索引字段。 + /// - 索引字段仅支持以下类型： + /// - 1：多行文本 + /// - 2：数字 + /// - 5：日期 + /// - 13：电话号码 + /// - 15：超链接 + /// - 20：公式 + /// - 22：地理位置 /// public record AppTableCreateHeader { /// /// 字段名称 /// 必填：是 - /// 示例值：文本 + /// 示例值：问题描述 /// [JsonPropertyName("field_name")] public string FieldName { get; set; } = string.Empty; @@ -113,11 +131,11 @@ public record AppTableCreateHeader public int Type { get; set; } /// - /// 字段在界面上的展示类型，例如进度字段是数字的一种展示形态 + /// 字段在界面上的展示类型，例如 Progress 进度字段是数字的一种展示形态 /// 必填：否 /// 示例值：Progress /// 可选值： - /// Text：多行文本 + /// Text：文本 /// Barcode：条码 /// Number：数字 /// Progress：进度 @@ -179,7 +197,7 @@ public record AppTableFieldPropertyOption public string? Name { get; set; } /// - /// 选项 ID，创建时不允许指定 ID + /// 选项 ID，创建时不可指定 ID /// 必填：否 /// 示例值：optKl35lnG /// @@ -187,7 +205,7 @@ public record AppTableFieldPropertyOption public string? Id { get; set; } /// - /// 选项颜色 + /// 选项颜色，详情参考[字段编辑指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/guide)。 /// 必填：否 /// 示例值：0 /// 最大值：54 @@ -198,7 +216,7 @@ public record AppTableFieldPropertyOption } /// - /// 数字、公式字段的显示格式 + /// 数字、公式字段的显示格式。详情参考[字段编辑指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/guide)。 /// 必填：否 /// 示例值：0 /// @@ -206,7 +224,7 @@ public record AppTableFieldPropertyOption public string? Formatter { get; set; } /// - /// 日期、创建时间、最后更新时间字段的显示格式 + /// 日期、创建时间、最后更新时间字段的显示格式。详情参考[字段编辑指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/guide)。 /// 必填：否 /// 示例值：日期格式 /// diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsSearchBodyDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsSearchBodyDto.cs index 87fb7b85..e3529230 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsSearchBodyDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsSearchBodyDto.cs @@ -15,6 +15,8 @@ namespace FeishuNetSdk.Base; /// /// 查询记录 请求体 /// 该接口用于查询数据表中的现有记录，单次最多查询 500 行记录，支持分页获取。 +/// ## 注意事项 +/// 若多维表格开启了高级权限，你需确保调用身份拥有多维表格的可管理权限，否则可能出现调用成功但返回数据为空的情况。了解具体步骤，参考[如何为应用或用户开通文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 /// 接口ID：7312729248342360068 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table-record%2fsearch diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsSearchResponseDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsSearchResponseDto.cs index d041eff4..d7ee5dd4 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsSearchResponseDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsSearchResponseDto.cs @@ -15,6 +15,8 @@ namespace FeishuNetSdk.Base; /// /// 查询记录 响应体 /// 该接口用于查询数据表中的现有记录，单次最多查询 500 行记录，支持分页获取。 +/// ## 注意事项 +/// 若多维表格开启了高级权限，你需确保调用身份拥有多维表格的可管理权限，否则可能出现调用成功但返回数据为空的情况。了解具体步骤，参考[如何为应用或用户开通文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 /// 接口ID：7312729248342360068 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table-record%2fsearch diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdViewsBodyDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdViewsBodyDto.cs index aafc8192..27453e09 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdViewsBodyDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdViewsBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 新增视图 请求体 -/// 在数据表中新增一个视图 +/// 在多维表格数据表中新增一个视图，可指定视图类型，包括表格视图、看板视图、画册视图、甘特视图和表单视图。 /// 接口ID：6978670625209614338 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table-view/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table-view%2fcreate @@ -22,9 +22,9 @@ namespace FeishuNetSdk.Base; public record PostBitableV1AppsByAppTokenTablesByTableIdViewsBodyDto { /// - /// 视图名字 + /// 视图名称 /// 必填：是 - /// 示例值：表格视图1 + /// 示例值：表格视图 1 /// [JsonPropertyName("view_name")] public string ViewName { get; set; } = string.Empty; diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdViewsResponseDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdViewsResponseDto.cs index 9d700aa2..fa70ddd6 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdViewsResponseDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdViewsResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 新增视图 响应体 -/// 在数据表中新增一个视图 +/// 在多维表格数据表中新增一个视图，可指定视图类型，包括表格视图、看板视图、画册视图、甘特视图和表单视图。 /// 接口ID：6978670625209614338 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table-view/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table-view%2fcreate @@ -34,7 +34,7 @@ public record PostBitableV1AppsByAppTokenTablesByTableIdViewsResponseDto public record AppTableView { /// - /// 视图Id + /// 视图 ID /// 必填：否 /// 示例值：vewTpR1urY /// @@ -42,9 +42,9 @@ public record AppTableView public string? ViewId { get; set; } /// - /// 视图名字 + /// 视图名称 /// 必填：否 - /// 示例值：甘特视图1 + /// 示例值：表格视图 1 /// [JsonPropertyName("view_name")] public string? ViewName { get; set; } @@ -52,7 +52,7 @@ public record AppTableView /// /// 视图类型 /// 必填：否 - /// 示例值：gantt + /// 示例值：grid /// [JsonPropertyName("view_type")] public string? ViewType { get; set; } diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesResponseDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesResponseDto.cs index 58d2fe43..a369851b 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesResponseDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 新增一个数据表 响应体 -/// 新增一个数据表，默认仅包含索引列，也可以指定一部分初始字段。 +/// 新增一个数据表，默认仅包含索引字段，也可以指定一部分初始字段。 /// 接口ID：6960166873968541699 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table%2fcreate @@ -22,7 +22,7 @@ namespace FeishuNetSdk.Base; public record PostBitableV1AppsByAppTokenTablesResponseDto { /// - /// 多维表格数据表的唯一标识符 + /// 多维表格数据表的 ID /// 必填：否 /// 示例值：tbl1AybU4ogJYXKA /// @@ -30,7 +30,7 @@ public record PostBitableV1AppsByAppTokenTablesResponseDto public string? TableId { get; set; } /// - /// 默认表格视图的id，该字段仅在请求参数中填写了default_view_name或fields才会返回 + /// 默认表格视图的 ID。该字段仅在请求参数中填写了`default_view_name` 或 `fields` 字段才会返回 /// 必填：否 /// 示例值：vew3y6oFgo /// @@ -38,7 +38,7 @@ public record PostBitableV1AppsByAppTokenTablesResponseDto public string? DefaultViewId { get; set; } /// - /// 数据表初始字段的id列表，该字段仅在请求参数中填写了fields才会返回 + /// 数据表初始字段的 ID 列表，该字段仅在请求参数中填写了 `fields` 才会返回 /// 必填：否 /// 示例值：["fldO1Q5uD2"] /// diff --git a/src/Contact/PostContactV3DepartmentsBodyDto.cs b/src/Contact/PostContactV3DepartmentsBodyDto.cs index e6e89c9a..fcfc3ccd 100644 --- a/src/Contact/PostContactV3DepartmentsBodyDto.cs +++ b/src/Contact/PostContactV3DepartmentsBodyDto.cs @@ -22,6 +22,7 @@ namespace FeishuNetSdk.Contact; /// - 单租户内单个部门的直属成员数量上限为 10,000。 /// - 单租户内单个部门的直属子部门数量上限为 1,000。 /// - 部门层级上限为 25 层。 +/// - 该接口不支持设置自定义部门字段。如果必须在创建部门时设置自定义部门字段，请联系企业管理员在 [管理后台](https://feishu.cn/admin) > **组织架构** > **成员与部门** > **部门** 功能页创建部门并设置自定义部门字段。 /// 接口ID：6943913881476857883 /// 文档地址：https://open.feishu.cn/document/server-docs/contact-v3/department/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcontact-v3%2fdepartment%2fcreate diff --git a/src/Contact/PostContactV3DepartmentsResponseDto.cs b/src/Contact/PostContactV3DepartmentsResponseDto.cs index 8a45f85a..bec7de1a 100644 --- a/src/Contact/PostContactV3DepartmentsResponseDto.cs +++ b/src/Contact/PostContactV3DepartmentsResponseDto.cs @@ -22,6 +22,7 @@ namespace FeishuNetSdk.Contact; /// - 单租户内单个部门的直属成员数量上限为 10,000。 /// - 单租户内单个部门的直属子部门数量上限为 1,000。 /// - 部门层级上限为 25 层。 +/// - 该接口不支持设置自定义部门字段。如果必须在创建部门时设置自定义部门字段，请联系企业管理员在 [管理后台](https://feishu.cn/admin) > **组织架构** > **成员与部门** > **部门** 功能页创建部门并设置自定义部门字段。 /// 接口ID：6943913881476857883 /// 文档地址：https://open.feishu.cn/document/server-docs/contact-v3/department/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcontact-v3%2fdepartment%2fcreate diff --git a/src/Corehr/GetCorehrV2WorkforcePlansResponseDto.cs b/src/Corehr/GetCorehrV2WorkforcePlansResponseDto.cs new file mode 100644 index 00000000..e27467ed --- /dev/null +++ b/src/Corehr/GetCorehrV2WorkforcePlansResponseDto.cs @@ -0,0 +1,111 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-11-03 +// +// Last Modified By : yxr +// Last Modified On : 2024-11-03 +// ************************************************************************ +// +// MIT +// +// 查询编制规划方案 响应体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 查询编制规划方案 响应体 +/// 根据传入的筛选项获取编制规划的方案列表 +/// 接口ID：7314710843818508289 +/// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/workforce_plan/list +/// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fworkforce_plan%2flist +/// +public record GetCorehrV2WorkforcePlansResponseDto +{ + /// + /// 编制规划方案列表 + /// 必填：否 + /// + [JsonPropertyName("items")] + public WorkforcePlan[]? Items { get; set; } + + /// + /// 编制规划方案列表 + /// + public record WorkforcePlan + { + /// + /// 编制规划方案 ID + /// 必填：是 + /// 示例值：123456 + /// + [JsonPropertyName("workforce_plan_id")] + public string WorkforcePlanId { get; set; } = string.Empty; + + /// + /// 编制规划方案名称 + /// 必填：否 + /// + [JsonPropertyName("workforce_plan_name")] + public I18n[]? WorkforcePlanNames { get; set; } + + /// + /// 编制规划方案名称 + /// + public record I18n + { + /// + /// 语言信息，中文为 zh-CN，英文为 en-US + /// 必填：是 + /// 示例值：zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 内容 + /// 必填：是 + /// 示例值：张三 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + + /// + /// 开始日期 + /// - 返回格式：YYYY-MM-DD（最小单位到日） + /// - 日期范围:1900-01-01 ～ 9999-12-31 + /// 必填：否 + /// 示例值：2020-10-01 + /// + [JsonPropertyName("start_date")] + public string? StartDate { get; set; } + + /// + /// 结束日期 + /// - 返回格式：YYYY-MM-DD（最小单位到日） + /// - 日期范围:1900-01-01 ～ 9999-12-31 + /// 必填：否 + /// 示例值：2020-10-31 + /// + [JsonPropertyName("end_date")] + public string? EndDate { get; set; } + + /// + /// 是否启用 + /// - true 表示启用 + /// - false 表示停用 + /// 必填：否 + /// 示例值：true + /// + [JsonPropertyName("active")] + public bool? Active { get; set; } + } + + /// + /// 满足条件的方案总数 + /// 必填：否 + /// 示例值：100 + /// + [JsonPropertyName("total")] + public int? Total { get; set; } +} diff --git a/src/Corehr/PatchCorehrV2LocationsByLocationIdAddressesByAddressIdBodyDto.cs b/src/Corehr/PatchCorehrV2LocationsByLocationIdAddressesByAddressIdBodyDto.cs new file mode 100644 index 00000000..33ce8efc --- /dev/null +++ b/src/Corehr/PatchCorehrV2LocationsByLocationIdAddressesByAddressIdBodyDto.cs @@ -0,0 +1,191 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-11-03 +// +// Last Modified By : yxr +// Last Modified On : 2024-11-03 +// ************************************************************************ +// +// MIT +// +// 更新地点地址 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 更新地点地址 请求体 +/// 更新地点地址 +/// 接口ID：7420421437192929283 +/// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/patch +/// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2flocation-address%2fpatch +/// +public record PatchCorehrV2LocationsByLocationIdAddressesByAddressIdBodyDto +{ + /// + /// 国家 / 地区 ID + /// - 可通过[【查询国家/地区信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口获取 + /// 必填：否 + /// 示例值：6862995757234914824 + /// + [JsonPropertyName("country_region_id")] + public string? CountryRegionId { get; set; } + + /// + /// 主要行政区 ID + /// - 可通过[【查询省份/行政区信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口获取 + /// 必填：否 + /// 示例值：6863326264296474119 + /// + [JsonPropertyName("region_id")] + public string? RegionId { get; set; } + + /// + /// 城市ID。 + /// - 详情调用[【查询城市信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search)获取 + /// 必填：否 + /// 示例值：6863333555859097096 + /// + [JsonPropertyName("city_id")] + public string? CityId { get; set; } + + /// + /// 区/县ID + /// - 详情可通过[【查询区县信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-district/search)接口获取 + /// 必填：否 + /// 示例值：6863333556291110408 + /// + [JsonPropertyName("distinct_id")] + public string? DistinctId { get; set; } + + /// + /// 地址行 1（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line1")] + public string? LocalAddressLine1 { get; set; } + + /// + /// 地址行 2（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line2")] + public string? LocalAddressLine2 { get; set; } + + /// + /// 地址行 3（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line3")] + public string? LocalAddressLine3 { get; set; } + + /// + /// 地址行 4（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line4")] + public string? LocalAddressLine4 { get; set; } + + /// + /// 地址行 5（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line5")] + public string? LocalAddressLine5 { get; set; } + + /// + /// 地址行 6（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line6")] + public string? LocalAddressLine6 { get; set; } + + /// + /// 地址行 7（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line7")] + public string? LocalAddressLine7 { get; set; } + + /// + /// 地址行 8（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line8")] + public string? LocalAddressLine8 { get; set; } + + /// + /// 地址行 9（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line9")] + public string? LocalAddressLine9 { get; set; } + + /// + /// 邮政编码 + /// 必填：否 + /// 示例值：611530 + /// + [JsonPropertyName("postal_code")] + public string? PostalCode { get; set; } + + /// + /// 地址类型，枚举值及详细信息可通过[【枚举常量介绍】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)查询获得 + /// 必填：否 + /// 最大长度：5 + /// 最小长度：0 + /// + [JsonPropertyName("address_types")] + public Enum[]? AddressTypes { get; set; } + + /// + /// 地址类型，枚举值及详细信息可通过[【枚举常量介绍】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)查询获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填：是 + /// 示例值：phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + } + + /// + /// 是否主要地址，一个地点只能存在一个主要地址，更新地址为主要地址会取消原主要地址，无法更新主要地址为非主要地址 + /// - true 表示地址是主要地址 + /// - false 表示地址不是主要地址 + /// 必填：否 + /// 示例值：true + /// + [JsonPropertyName("is_primary")] + public bool? IsPrimary { get; set; } + + /// + /// 是否公开地址 + /// - true 表示地址是公开地址 + /// - false 表示地址不是公开地址 + /// 必填：否 + /// 示例值：true + /// + [JsonPropertyName("is_public")] + public bool? IsPublic { get; set; } +} diff --git a/src/Corehr/PatchCorehrV2LocationsByLocationIdBodyDto.cs b/src/Corehr/PatchCorehrV2LocationsByLocationIdBodyDto.cs new file mode 100644 index 00000000..d52f5268 --- /dev/null +++ b/src/Corehr/PatchCorehrV2LocationsByLocationIdBodyDto.cs @@ -0,0 +1,164 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-11-03 +// +// Last Modified By : yxr +// Last Modified On : 2024-11-03 +// ************************************************************************ +// +// MIT +// +// 更新地点 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 更新地点 请求体 +/// 更新地点 +/// 接口ID：7420421437192962051 +/// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/patch +/// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2flocation%2fpatch +/// +public record PatchCorehrV2LocationsByLocationIdBodyDto +{ + /// + /// 上级地点，在创建场景下，该字段必填，枚举值及详细信息可通过[【批量分页查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)查询获得 + /// 必填：否 + /// 示例值：4719168654814483759 + /// + [JsonPropertyName("parent_id")] + public string? ParentId { get; set; } + + /// + /// 地点名称 + /// - 名称不能包含「/」「；」「;」字符 + /// - 地点中英文名称会有全局唯一校验 + /// 必填：否 + /// 最大长度：5 + /// 最小长度：0 + /// + [JsonPropertyName("names")] + public I18n[]? Names { get; set; } + + /// + /// 地点名称 + /// - 名称不能包含「/」「；」「;」字符 + /// - 地点中英文名称会有全局唯一校验 + /// + public record I18n + { + /// + /// 语言信息，中文用zh-CN，英文用en-US + /// 必填：是 + /// 示例值：zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 名称内容 + /// 必填：是 + /// 示例值：中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + + /// + /// 地点启用/停用状态 + /// - true 为启用 + /// - false 为停用 + /// 必填：否 + /// 示例值：true + /// + [JsonPropertyName("active")] + public bool? Active { get; set; } + + /// + /// 版本生效日期 + /// - 填写格式：YYYY-MM-DD + /// - 系统默认为填写日期当天的 00:00:00 生效 + /// - 该接口只支持到最小单位为日 + /// - 日期范围要求:1900-01-01～9999-12-31 + /// - 详情可以参考[时间轴介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/about-timeline-version) + /// 必填：是 + /// 示例值：2020-05-02 + /// + [JsonPropertyName("effective_time")] + public string EffectiveTime { get; set; } = string.Empty; + + /// + /// 地点编码 (不能与其他记录的编码重复)，当开启自动编码时，该字段会失效 + /// 必填：否 + /// 示例值：12456 + /// + [JsonPropertyName("code")] + public string? Code { get; set; } + + /// + /// 地点描述 + /// 必填：否 + /// 最大长度：5 + /// 最小长度：0 + /// + [JsonPropertyName("descriptions")] + public I18n[]? Descriptions { get; set; } + + /// + /// 地点用途 ID，枚举值及详细信息可通过[【批量查询地点用途】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询获得。 + /// - 请求参数object_api_name=location；custom_api_name=location_usage + /// 必填：否 + /// 最大长度：10 + /// 最小长度：0 + /// + [JsonPropertyName("location_usages")] + public Enum[]? LocationUsages { get; set; } + + /// + /// 地点用途 ID，枚举值及详细信息可通过[【批量查询地点用途】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询获得。 + /// - 请求参数object_api_name=location；custom_api_name=location_usage + /// + public record Enum + { + /// + /// 枚举值 + /// 必填：是 + /// 示例值：phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + } + + /// + /// 工时制度 ID，枚举值及详细信息可通过[【批量查询工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)接口查询获得 + /// 必填：否 + /// 示例值：4690238309151997779 + /// + [JsonPropertyName("working_hours_type_id")] + public string? WorkingHoursTypeId { get; set; } + + /// + /// 区域设置 ID ，枚举值及详细信息可通过[【批量查询枚举信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询获得。 + /// - 请求参数object_api_name=location；custom_api_name=locale + /// 必填：否 + /// 示例值：zh_cn + /// + [JsonPropertyName("locale")] + public Enum? Locale { get; set; } + + /// + /// 时区 ID + /// 必填：否 + /// 示例值：123456789 + /// + [JsonPropertyName("time_zone_id")] + public string? TimeZoneId { get; set; } + + /// + /// 默认显示语言 ID + /// 必填：否 + /// 示例值：123456789 + /// + [JsonPropertyName("display_language_id")] + public string? DisplayLanguageId { get; set; } +} diff --git a/src/Corehr/PostCorehrV2CompaniesActiveBodyDto.cs b/src/Corehr/PostCorehrV2CompaniesActiveBodyDto.cs new file mode 100644 index 00000000..6c4f4449 --- /dev/null +++ b/src/Corehr/PostCorehrV2CompaniesActiveBodyDto.cs @@ -0,0 +1,62 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-11-03 +// +// Last Modified By : yxr +// Last Modified On : 2024-11-03 +// ************************************************************************ +// +// MIT +// +// 启用/停用公司 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 启用/停用公司 请求体 +/// 对公司进行启用或停用操作 +/// 接口ID：7408127338960781340 +/// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/company/active +/// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fcompany%2factive +/// +public record PostCorehrV2CompaniesActiveBodyDto +{ + /// + /// 公司 ID + /// - 可从 [批量查询公司](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)的 id 字段中获取。 + /// 必填：是 + /// 示例值：1616161616 + /// + [JsonPropertyName("company_id")] + public string CompanyId { get; set; } = string.Empty; + + /// + /// 公司启用/停用生效时间 + /// - 填写格式： YYYY-MM-DD + /// - 系统默认为填写日期当天的 00:00:00 生效 + /// - 该接口只支持到最小单位为日 + /// - 日期范围要求:1900-01-01 ～ 9999-12-31 + /// 必填：是 + /// 示例值：2020-01-01 + /// + [JsonPropertyName("effective_time")] + public string EffectiveTime { get; set; } = string.Empty; + + /// + /// 启用/停用状态。 + /// - active 传 true 代表启用 + /// - active 传 false 代表停用 + /// 必填：是 + /// 示例值：true + /// + [JsonPropertyName("active")] + public bool Active { get; set; } + + /// + /// 操作原因 + /// 必填：是 + /// 示例值：业务操作 + /// + [JsonPropertyName("operation_reason")] + public string OperationReason { get; set; } = string.Empty; +} diff --git a/src/Corehr/PostCorehrV2LocationsActiveBodyDto.cs b/src/Corehr/PostCorehrV2LocationsActiveBodyDto.cs new file mode 100644 index 00000000..2912c210 --- /dev/null +++ b/src/Corehr/PostCorehrV2LocationsActiveBodyDto.cs @@ -0,0 +1,63 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-11-03 +// +// Last Modified By : yxr +// Last Modified On : 2024-11-03 +// ************************************************************************ +// +// MIT +// +// 启用/停用地点 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 启用/停用地点 请求体 +/// 启用/停用地点 +/// 接口ID：7420421437192945667 +/// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/active +/// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2flocation%2factive +/// +public record PostCorehrV2LocationsActiveBodyDto +{ + /// + /// 地点 ID。ID 获取方式： + /// - 调用[【创建地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/create)[【批量分页查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)等接口可以返回地点ID + /// 必填：是 + /// 示例值：1616161616 + /// + [JsonPropertyName("location_id")] + public string LocationId { get; set; } = string.Empty; + + /// + /// 地点启用/停用生效日期 + /// - 填写格式：YYYY-MM-DD + /// - 系统默认为填写日期当天的 00:00:00 生效 + /// - 该接口只支持到最小单位为日 + /// - 日期范围要求:1900-01-01～9999-12-31 + /// - 详情可以参考[时间轴介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/about-timeline-version) + /// 必填：是 + /// 示例值：2020-01-01 + /// + [JsonPropertyName("effective_time")] + public string EffectiveTime { get; set; } = string.Empty; + + /// + /// 地点启用/停用状态 + /// - true 为启用 + /// - false 为停用 + /// 必填：是 + /// 示例值：true + /// + [JsonPropertyName("active")] + public bool Active { get; set; } + + /// + /// 操作原因 + /// 必填：是 + /// 示例值：业务操作 + /// + [JsonPropertyName("operation_reason")] + public string OperationReason { get; set; } = string.Empty; +} diff --git a/src/Corehr/PostCorehrV2LocationsByLocationIdAddressesBodyDto.cs b/src/Corehr/PostCorehrV2LocationsByLocationIdAddressesBodyDto.cs new file mode 100644 index 00000000..28ee2526 --- /dev/null +++ b/src/Corehr/PostCorehrV2LocationsByLocationIdAddressesBodyDto.cs @@ -0,0 +1,191 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-11-03 +// +// Last Modified By : yxr +// Last Modified On : 2024-11-03 +// ************************************************************************ +// +// MIT +// +// 添加地点地址 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 添加地点地址 请求体 +/// 添加地点地址 +/// 接口ID：7420421437192912899 +/// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/create +/// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2flocation-address%2fcreate +/// +public record PostCorehrV2LocationsByLocationIdAddressesBodyDto +{ + /// + /// 国家 / 地区 ID + /// - 可通过[【查询国家/地区信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口获取 + /// 必填：是 + /// 示例值：6862995757234914824 + /// + [JsonPropertyName("country_region_id")] + public string CountryRegionId { get; set; } = string.Empty; + + /// + /// 主要行政区 ID + /// - 可通过[【查询省份/行政区信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口获取 + /// 必填：是 + /// 示例值：6863326264296474119 + /// + [JsonPropertyName("region_id")] + public string RegionId { get; set; } = string.Empty; + + /// + /// 城市ID。 + /// - 详情调用[【查询城市信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search)获取 + /// 必填：是 + /// 示例值：6863333555859097096 + /// + [JsonPropertyName("city_id")] + public string CityId { get; set; } = string.Empty; + + /// + /// 区/县ID + /// - 详情可通过[【查询区县信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-district/search)接口获取 + /// 必填：是 + /// 示例值：6863333556291110408 + /// + [JsonPropertyName("distinct_id")] + public string DistinctId { get; set; } = string.Empty; + + /// + /// 地址行 1（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line1")] + public string? LocalAddressLine1 { get; set; } + + /// + /// 地址行 2（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line2")] + public string? LocalAddressLine2 { get; set; } + + /// + /// 地址行 3（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line3")] + public string? LocalAddressLine3 { get; set; } + + /// + /// 地址行 4（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line4")] + public string? LocalAddressLine4 { get; set; } + + /// + /// 地址行 5（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line5")] + public string? LocalAddressLine5 { get; set; } + + /// + /// 地址行 6（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line6")] + public string? LocalAddressLine6 { get; set; } + + /// + /// 地址行 7（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line7")] + public string? LocalAddressLine7 { get; set; } + + /// + /// 地址行 8（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line8")] + public string? LocalAddressLine8 { get; set; } + + /// + /// 地址行 9（非拉丁语系的本地文字） + /// - 填写规则可见[【地址填写指南】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/basic-infomation/data-calculation-rules/address-completion-guidelines) + /// 必填：否 + /// 示例值：丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line9")] + public string? LocalAddressLine9 { get; set; } + + /// + /// 邮政编码 + /// 必填：否 + /// 示例值：611530 + /// + [JsonPropertyName("postal_code")] + public string? PostalCode { get; set; } + + /// + /// 地址类型，枚举值及详细信息可通过[【枚举常量介绍】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)查询获得 + /// 必填：否 + /// 最大长度：5 + /// 最小长度：0 + /// + [JsonPropertyName("address_types")] + public Enum[]? AddressTypes { get; set; } + + /// + /// 地址类型，枚举值及详细信息可通过[【枚举常量介绍】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)查询获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填：是 + /// 示例值：phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + } + + /// + /// 是否主要地址，一个地点只能存在一个主要地址，添加主要地址会将取消原主要地址 + /// - true 表示地址是主要地址 + /// - false 表示地址不是主要地址 + /// 必填：否 + /// 示例值：true + /// + [JsonPropertyName("is_primary")] + public bool? IsPrimary { get; set; } + + /// + /// 是否公开地址 + /// - true 表示地址是公开地址 + /// - false 表示地址不是公开地址 + /// 必填：否 + /// 示例值：true + /// + [JsonPropertyName("is_public")] + public bool? IsPublic { get; set; } +} diff --git a/src/Corehr/PostCorehrV2LocationsByLocationIdAddressesResponseDto.cs b/src/Corehr/PostCorehrV2LocationsByLocationIdAddressesResponseDto.cs new file mode 100644 index 00000000..f5c5ca07 --- /dev/null +++ b/src/Corehr/PostCorehrV2LocationsByLocationIdAddressesResponseDto.cs @@ -0,0 +1,31 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-11-03 +// +// Last Modified By : yxr +// Last Modified On : 2024-11-03 +// ************************************************************************ +// +// MIT +// +// 添加地点地址 响应体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 添加地点地址 响应体 +/// 添加地点地址 +/// 接口ID：7420421437192912899 +/// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/create +/// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2flocation-address%2fcreate +/// +public record PostCorehrV2LocationsByLocationIdAddressesResponseDto +{ + /// + /// 地址 ID + /// 必填：否 + /// 示例值：6862995757234914824 + /// + [JsonPropertyName("address_id")] + public string? AddressId { get; set; } +} diff --git a/src/FeishuNetSdk.csproj b/src/FeishuNetSdk.csproj index 40ab45ad..394e4990 100644 --- a/src/FeishuNetSdk.csproj +++ b/src/FeishuNetSdk.csproj @@ -16,7 +16,7 @@ MIT 适用于飞书开放平台的.Net开发包 LICENSE - 3.1.0 + 3.1.1 diff --git a/src/FeishuPeople/PostCorehrV1JobChangesBodyDto.cs b/src/FeishuPeople/PostCorehrV1JobChangesBodyDto.cs index 8c8c5060..7f5e58be 100644 --- a/src/FeishuPeople/PostCorehrV1JobChangesBodyDto.cs +++ b/src/FeishuPeople/PostCorehrV1JobChangesBodyDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-07-18 +// Last Modified On : 2024-11-03 // ************************************************************************ // // MIT @@ -44,7 +44,7 @@ public record PostCorehrV1JobChangesBodyDto public string EmploymentId { get; set; } = string.Empty; /// - /// 异动类型唯一标识，可通过接口 + /// 异动类型唯一标识。不支持系统预置异动类型，包括组织架构调整、职责转交、试用期转正，可通过接口 /// [获取异动类型列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/transfer_type/query)获取 /// 必填：是 /// 示例值：internal_transfer @@ -246,6 +246,22 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo [JsonPropertyName("target_workforce_type")] public string? TargetWorkforceType { get; set; } + /// + /// 原人员子类型 + /// 必填：否 + /// 示例值：6968386026792289828 + /// + [JsonPropertyName("original_employee_subtype")] + public string? OriginalEmployeeSubtype { get; set; } + + /// + /// 新人员子类型 + /// 必填：否 + /// 示例值：7036268995372303885 + /// + [JsonPropertyName("target_employee_subtype")] + public string? TargetEmployeeSubtype { get; set; } + /// /// 原公司，详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 /// 必填：否 @@ -598,7 +614,7 @@ public record CustomFieldData public string? TargetServiceCompany { get; set; } /// - /// 原岗位，可通过[【岗职务管理-岗位】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/position/query)相关API获取（目前仅灰度部分租户，如需要请联系管理员开灰） + /// 原岗位 /// 必填：否 /// 示例值：7289005963599693367 /// @@ -606,7 +622,7 @@ public record CustomFieldData public string? OriginalPosition { get; set; } /// - /// 新岗位，可通过[【岗职务管理-岗位】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/position/query)相关API获取（目前仅灰度部分租户，如需要请联系管理员开灰） + /// 新岗位 /// 必填：否 /// 示例值：7289005963599693367 /// diff --git a/src/FeishuPeople/PostCorehrV1JobChangesResponseDto.cs b/src/FeishuPeople/PostCorehrV1JobChangesResponseDto.cs index 77f5158b..10d232af 100644 --- a/src/FeishuPeople/PostCorehrV1JobChangesResponseDto.cs +++ b/src/FeishuPeople/PostCorehrV1JobChangesResponseDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-07-18 +// Last Modified On : 2024-11-03 // ************************************************************************ // // MIT @@ -48,10 +48,11 @@ public record PostCorehrV1JobChangesResponseDto /// 2：Transformed 已异动 /// 3：Rejected 已拒绝 /// 4：Cancelled 已撤销 + /// 5：NoNeedApproval 无需审批 /// /// [JsonPropertyName("status")] - public string? Status { get; set; } + public int? Status { get; set; } /// /// 异动类型唯一标识，，可通过接口 @@ -271,6 +272,22 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo [JsonPropertyName("target_workforce_type")] public string? TargetWorkforceType { get; set; } + /// + /// 原人员子类型 + /// 必填：否 + /// 示例值：6968386026792289828 + /// + [JsonPropertyName("original_employee_subtype")] + public string? OriginalEmployeeSubtype { get; set; } + + /// + /// 新人员子类型 + /// 必填：否 + /// 示例值：7036268995372303885 + /// + [JsonPropertyName("target_employee_subtype")] + public string? TargetEmployeeSubtype { get; set; } + /// /// 原公司，详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 /// 必填：否 @@ -658,7 +675,7 @@ public record CustomName public string? TargetServiceCompany { get; set; } /// - /// 原岗位，可通过[【岗职务管理-岗位】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/position/query)相关API获取（目前仅灰度部分租户，如需要请联系管理员开灰） + /// 原岗位 /// 必填：否 /// 示例值：7289005963599693367 /// @@ -666,7 +683,7 @@ public record CustomName public string? OriginalPosition { get; set; } /// - /// 新岗位，可通过[【岗职务管理-岗位】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/position/query)相关API获取（目前仅灰度部分租户，如需要请联系管理员开灰） + /// 新岗位 /// 必填：否 /// 示例值：7289005963599693367 /// diff --git a/src/Hire/GetHireV1JobRequirementsResponseDto.cs b/src/Hire/GetHireV1JobRequirementsResponseDto.cs index eccde530..9c54a536 100644 --- a/src/Hire/GetHireV1JobRequirementsResponseDto.cs +++ b/src/Hire/GetHireV1JobRequirementsResponseDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-07-04 +// Last Modified On : 2024-11-03 // ************************************************************************ // // MIT @@ -588,5 +588,13 @@ public record I18n /// [JsonPropertyName("update_time")] public string? UpdateTime { get; set; } + + /// + /// 职务ID，详情请查看：[查询单个职务](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/get) + /// 必填：否 + /// 示例值：6807407987381831949 + /// + [JsonPropertyName("employment_job_id")] + public string? EmploymentJobId { get; set; } } } diff --git a/src/Hire/PostHireV1JobRequirementsBodyDto.cs b/src/Hire/PostHireV1JobRequirementsBodyDto.cs index 737f2145..7d645bb4 100644 --- a/src/Hire/PostHireV1JobRequirementsBodyDto.cs +++ b/src/Hire/PostHireV1JobRequirementsBodyDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-09-27 +// Last Modified On : 2024-11-03 // ************************************************************************ // // MIT @@ -290,4 +290,12 @@ public record JobRequirementCustomizedData /// [JsonPropertyName("job_id_list")] public string[]? JobIdList { get; set; } + + /// + /// 职务 ID，可通过[获取租户职务列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)获取 + /// 必填：否 + /// 示例值：6807407987381831949 + /// + [JsonPropertyName("employment_job_id")] + public string? EmploymentJobId { get; set; } } diff --git a/src/Hire/PostHireV1JobRequirementsResponseDto.cs b/src/Hire/PostHireV1JobRequirementsResponseDto.cs index ca4107a3..92125f9c 100644 --- a/src/Hire/PostHireV1JobRequirementsResponseDto.cs +++ b/src/Hire/PostHireV1JobRequirementsResponseDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-08-14 +// Last Modified On : 2024-11-03 // ************************************************************************ // // MIT @@ -565,5 +565,13 @@ public record I18n /// [JsonPropertyName("update_time")] public string? UpdateTime { get; set; } + + /// + /// 职务ID，详情请查看：[查询单个职务](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/get) + /// 必填：否 + /// 示例值：6807407987381831949 + /// + [JsonPropertyName("employment_job_id")] + public string? EmploymentJobId { get; set; } } } diff --git a/src/Hire/PostHireV1JobRequirementsSearchResponseDto.cs b/src/Hire/PostHireV1JobRequirementsSearchResponseDto.cs index 84db58a7..086420fa 100644 --- a/src/Hire/PostHireV1JobRequirementsSearchResponseDto.cs +++ b/src/Hire/PostHireV1JobRequirementsSearchResponseDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-07-04 +// Last Modified On : 2024-11-03 // ************************************************************************ // // MIT @@ -572,5 +572,13 @@ public record I18n /// [JsonPropertyName("update_time")] public string? UpdateTime { get; set; } + + /// + /// 职务ID，详情请查看：[查询单个职务](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/get) + /// 必填：否 + /// 示例值：6807407987381831949 + /// + [JsonPropertyName("employment_job_id")] + public string? EmploymentJobId { get; set; } } } diff --git a/src/Hire/PutHireV1JobRequirementsByJobRequirementIdBodyDto.cs b/src/Hire/PutHireV1JobRequirementsByJobRequirementIdBodyDto.cs index 54f4f18e..efe0a5d6 100644 --- a/src/Hire/PutHireV1JobRequirementsByJobRequirementIdBodyDto.cs +++ b/src/Hire/PutHireV1JobRequirementsByJobRequirementIdBodyDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-09-27 +// Last Modified On : 2024-11-03 // ************************************************************************ // // MIT @@ -284,4 +284,12 @@ public record JobRequirementCustomizedData /// [JsonPropertyName("job_id_list")] public string[]? JobIdList { get; set; } + + /// + /// 职务 ID，可通过[获取租户职务列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)获取 + /// 必填：否 + /// 示例值：6807407987381831949 + /// + [JsonPropertyName("employment_job_id")] + public string? EmploymentJobId { get; set; } } diff --git a/src/HumanAuthentication.Spec/PostHumanAuthenticationV1IdentitiesBodyDto.cs b/src/HumanAuthentication/PostHumanAuthenticationV1IdentitiesBodyDto.cs similarity index 90% rename from src/HumanAuthentication.Spec/PostHumanAuthenticationV1IdentitiesBodyDto.cs rename to src/HumanAuthentication/PostHumanAuthenticationV1IdentitiesBodyDto.cs index cca8c06d..f5462382 100644 --- a/src/HumanAuthentication.Spec/PostHumanAuthenticationV1IdentitiesBodyDto.cs +++ b/src/HumanAuthentication/PostHumanAuthenticationV1IdentitiesBodyDto.cs @@ -11,7 +11,7 @@ // // 录入身份信息 请求体 // ************************************************************************ -namespace FeishuNetSdk.HumanAuthentication.Spec; +namespace FeishuNetSdk.HumanAuthentication; /// /// 录入身份信息 请求体 /// 该接口用于录入实名认证的身份信息，在唤起有源活体认证前，需要使用该接口进行实名认证。 @@ -23,24 +23,24 @@ public record PostHumanAuthenticationV1IdentitiesBodyDto { /// /// 姓名 - /// **示例值**："张三" /// 必填：是 + /// 示例值：张三 /// [JsonPropertyName("identity_name")] public string IdentityName { get; set; } = string.Empty; /// /// 身份证号 - /// **示例值**："4xxxxxxxx" /// 必填：是 + /// 示例值：4xxxxxxxx /// [JsonPropertyName("identity_code")] public string IdentityCode { get; set; } = string.Empty; /// /// 手机号 - /// **示例值**："13xxxxxxx" /// 必填：否 + /// 示例值：13xxxxxxx /// [JsonPropertyName("mobile")] public string? Mobile { get; set; } diff --git a/src/HumanAuthentication.Spec/PostHumanAuthenticationV1IdentitiesResponseDto.cs b/src/HumanAuthentication/PostHumanAuthenticationV1IdentitiesResponseDto.cs similarity index 86% rename from src/HumanAuthentication.Spec/PostHumanAuthenticationV1IdentitiesResponseDto.cs rename to src/HumanAuthentication/PostHumanAuthenticationV1IdentitiesResponseDto.cs index 1b05da01..dd8b6fa6 100644 --- a/src/HumanAuthentication.Spec/PostHumanAuthenticationV1IdentitiesResponseDto.cs +++ b/src/HumanAuthentication/PostHumanAuthenticationV1IdentitiesResponseDto.cs @@ -11,7 +11,7 @@ // // 录入身份信息 响应体 // ************************************************************************ -namespace FeishuNetSdk.HumanAuthentication.Spec; +namespace FeishuNetSdk.HumanAuthentication; /// /// 录入身份信息 响应体 /// 该接口用于录入实名认证的身份信息，在唤起有源活体认证前，需要使用该接口进行实名认证。 @@ -23,8 +23,9 @@ public record PostHumanAuthenticationV1IdentitiesResponseDto { /// /// 用户绑定实名身份的uid - /// 必填：否 + /// 必填：是 + /// 示例值：ou_2eb5483cb377daa5054bc6f86e2089a5 /// [JsonPropertyName("verify_uid")] - public string? VerifyUid { get; set; } + public string VerifyUid { get; set; } = string.Empty; } diff --git a/src/IFeishuApi.cs b/src/IFeishuApi.cs index 3e32ce35..cd4d8f12 100644 --- a/src/IFeishuApi.cs +++ b/src/IFeishuApi.cs @@ -42,9 +42,10 @@ public interface IFeishuApi : IHttpApi /// 接口ID：6995779366223724548 /// 接口文档：https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token_internal /// 自建应用通过此接口获取 `tenant_access_token`。 - /// **说明：** `tenant_access_token` 的最大有效期是 2 小时。 - /// - 如果在有效期小于 30 分钟的情况下，调用本接口，会返回一个新的 `tenant_access_token`，这会同时存在两个有效的 `tenant_access_token`。 - /// - 如果有效期不小于 30 分钟，调用本接口，会返回原有的 `tenant_access_token`。 + /// 注意事项： + /// `tenant_access_token` 的最大有效期是 2 小时。 + /// - 剩余有效期小于 30 分钟时，调用本接口会返回一个新的 `tenant_access_token`，这会同时存在两个有效的 `tenant_access_token`。 + /// - 剩余有效期大于等于 30 分钟时，调用本接口会返回原有的 `tenant_access_token`。 /// /// 请求体 [HttpPost("/open-apis/auth/v3/tenant_access_token/internal")] diff --git a/src/IFeishuTenantApi.cs b/src/IFeishuTenantApi.cs index bd5c3f91..ff7690c7 100644 --- a/src/IFeishuTenantApi.cs +++ b/src/IFeishuTenantApi.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-10-25 +// Last Modified On : 2024-11-03 // ************************************************************************ // // MIT @@ -3064,29 +3064,24 @@ System.Threading.Tasks.Task PostVcV1RoomConfigsSetAsync( /// /// 必填：是 /// 用户的唯一标识（使用的ID类型见下一参数描述，不同ID类型的区别和获取，参考文档：[如何获得 User ID、Open ID 和 Union ID？](https://open.feishu.cn/document/home/user-identity-introduction/how-to-get)） - /// **示例值**："ou_2eb5483cb377daa5054bc6f86e2089a5" + /// 示例值：ou_2eb5483cb377daa5054bc6f86e2089a5 /// /// /// 必填：否 /// 用户 ID 类型 - /// **示例值**："open_id" - /// **可选值有**： - /// open_id:标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid),union_id:标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id),user_id:标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id) - /// **默认值**：`open_id` - /// **当值为 `user_id`，字段权限要求**： - /// - contact:user.employee_id:readonly : 获取用户 user ID + /// 示例值：open_id /// - /// open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](/ssl - /// union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](/ssl - /// user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](/ssl + /// open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id) + /// user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id) /// /// 默认值：open_id /// /// 请求体 [HttpPost("/open-apis/human_authentication/v1/identities")] - System.Threading.Tasks.Task> PostHumanAuthenticationV1IdentitiesAsync( + System.Threading.Tasks.Task> PostHumanAuthenticationV1IdentitiesAsync( [PathQuery] string user_id, - [JsonContent] HumanAuthentication.Spec.PostHumanAuthenticationV1IdentitiesBodyDto dto, + [JsonContent] HumanAuthentication.PostHumanAuthenticationV1IdentitiesBodyDto dto, [PathQuery] string? user_id_type = "open_id"); /// @@ -3301,6 +3296,7 @@ System.Threading.Tasks.Task PostVcV1RoomConfigsSetAsync( /// - 单租户内单个部门的直属成员数量上限为 10,000。 /// - 单租户内单个部门的直属子部门数量上限为 1,000。 /// - 部门层级上限为 25 层。 + /// - 该接口不支持设置自定义部门字段。如果必须在创建部门时设置自定义部门字段，请联系企业管理员在 [管理后台](https://feishu.cn/admin) > **组织架构** > **成员与部门** > **部门** 功能页创建部门并设置自定义部门字段。 /// 权限要求： /// contact:contact /// @@ -4077,7 +4073,11 @@ System.Threading.Tasks.Task DeleteContactV3DepartmentsByDepartme /// 接口ID：6946222929790418972 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/is_in_chat /// Authorization：tenant_access_token、user_access_token - /// 根据使用的access_token判断对应的用户或者机器人是否在群里。 + /// 根据使用的 access_token 判断对应的用户或者机器人是否在指定的群里。 + /// ## 前提条件 + /// 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// 获取内部群信息时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat:readonly @@ -4088,7 +4088,10 @@ System.Threading.Tasks.Task DeleteContactV3DepartmentsByDepartme /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// [HttpGet("/open-apis/im/v1/chats/{chat_id}/members/is_in_chat")] @@ -4100,7 +4103,11 @@ System.Threading.Tasks.Task DeleteContactV3DepartmentsByDepartme /// 接口ID：6946222929790435356 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/get /// Authorization：tenant_access_token、user_access_token - /// 获取会话中的群公告信息，公告信息格式与[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。 + /// 获取指定群组中的群公告信息，公告信息格式与[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的群组内。 + /// - 获取内部群信息时，调用当前接口的用户或者机器人必须与对应群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat:readonly @@ -4113,8 +4120,11 @@ System.Threading.Tasks.Task DeleteContactV3DepartmentsByDepartme /// /// 路径参数 /// 必填：是 - /// 待获取公告的群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：不支持P2P单聊 + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：单聊（群类型为 `p2p`）不支持获取群公告。 /// 示例值：oc_5ad11d72b830411d72b836c20 /// /// @@ -4180,7 +4190,14 @@ System.Threading.Tasks.Task DeleteContactV3DepartmentsByDepartme /// 接口ID：6946222929790468124 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/delete /// Authorization：tenant_access_token、user_access_token - /// 将用户或机器人移出群聊。 + /// 将指定的用户或机器人从群聊中移出。 + /// ## 前提条件 + /// 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 仅群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以将其他群成员移出群组。 + /// - 用户或机器人在任何条件下均可将自己移出群组（即主动退群）。 + /// - 每次请求，最多移除 50 个用户或者 5 个机器人。 + /// - 操作内部群时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat.members:write_only @@ -4192,8 +4209,11 @@ System.Threading.Tasks.Task DeleteContactV3DepartmentsByDepartme /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`、`topic`的群组ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**话题（topic）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`topic`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -4278,7 +4298,15 @@ System.Threading.Tasks.Task GetImV1FilesByFileKeyAsync( /// 接口ID：6946222929790550044 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/get /// Authorization：tenant_access_token、user_access_token - /// 获取用户/机器人所在群的群成员列表。 + /// 获取指定群组的成员信息，包括成员名字与 ID。 + /// ## 前提条件 + /// - 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 当前接口的操作者（机器人或用户）必须在被查询的群组内。 + /// ## 使用限制 + /// - 该接口不会返回群组内的机器人成员。 + /// - 由于返回的群成员列表会过滤掉机器人成员，因此返回的群成员个数可能会小于指定的 page_size。 + /// - 如果有同一时间加入群的群成员，会一次性返回，这会导致返回的群成员个数可能会大于指定的 page_size。 + /// - 获取内部群信息时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat:readonly @@ -4292,7 +4320,10 @@ System.Threading.Tasks.Task GetImV1FilesByFileKeyAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -4300,15 +4331,17 @@ System.Threading.Tasks.Task GetImV1FilesByFileKeyAsync( /// 用户 ID 类型 /// 示例值：open_id /// - /// open_id：以 open_id 来识别成员</md-enum-item> **当值为 `user_id`，字段权限要求**： <md-perm name="contact:user.employee_id:readonly" desc="获取用户 user ID" support_app_types="custom" tags="">获取用户 user ID</md-perm> </md-td> </md-tr> - /// union_id：以 union_id 来识别成员 - /// user_id：以 user_id 来识别成员 + /// open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id) + /// user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id) /// /// 默认值：open_id /// /// /// 必填：否 - /// 分页大小 + /// 分页大小，用来限制一次请求所返回的数据条目数。 + /// - 由于返回的群成员列表会过滤掉机器人成员，因此返回的群成员个数可能会小于指定的 page_size。 + /// - 如果有同一时间加入群的群成员，会一次性返回，这会导致返回的群成员个数可能会大于指定的 page_size。 /// 示例值：20 **默认值**：`20` **数据校验规则**： - 最大值：`100` /// 默认值：10 /// @@ -4353,7 +4386,12 @@ System.Threading.Tasks.Task GetImV1ImagesByImageKeyAsync( /// 接口ID：6946222929790631964 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/me_join /// Authorization：tenant_access_token、user_access_token - /// 用户或机器人主动加入群聊。 + /// 将当前调用接口的操作者（用户或机器人）加入指定群聊。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 仅支持加入公开群。 + /// - 操作内部群时，操作者必须与相应的群组在同一租户内。 /// 权限要求： /// im:chat /// im:chat.members:write_only @@ -4362,10 +4400,13 @@ System.Threading.Tasks.Task GetImV1ImagesByImageKeyAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// **注意**： - /// - 仅支持公开（Public）群类型 - /// - 对于已认证企业的飞书的群人数默认上限：普通群5000人，会议群3000人，话题群5000人 + /// - 仅支持公开群（public），你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_type ` 参数取值是否为 `public`。 + /// - 群成员数量达到上限时无法进群。对于已认证企业的飞书的群人数默认上限：普通群 5000 人，会议群 3000 人，话题群 5000 人。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// [HttpPatch("/open-apis/im/v1/chats/{chat_id}/members/me_join")] @@ -4377,8 +4418,9 @@ System.Threading.Tasks.Task PatchImV1ChatsByChatIdMembersMeJoinA /// 接口ID：6946222929790648348 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search /// Authorization：tenant_access_token、user_access_token - /// 根据使用的 access_token 搜索对用户或机器人可见的群列表，包括：用户或机器人所在的群、对用户或机器人公开的群。 - /// 搜索可获得的群信息包括：群ID（chat_id）、群名称、群描述等。 + /// 获取当前身份（用户或机器人）可见的群列表，包括当前身份所在的群、对当前身份公开的群。支持关键词搜索、分页搜索。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 /// 权限要求： /// im:chat /// im:chat:read @@ -4403,11 +4445,11 @@ System.Threading.Tasks.Task PatchImV1ChatsByChatIdMembersMeJoinA /// /// 必填：否 /// 关键词 - /// **注意事项**： + /// **注意**： /// - 关键词支持匹配群国际化名称、群成员名称 - /// - 支持使用多语种搜索 + /// - 支持使用多语种搜索（飞书客户端内支持的多语种） /// - 支持拼音、前缀等模糊搜索 - /// - 关键词为空值或长度超过`64`个字符时将返回空的结果 + /// - 关键词为空值或长度超过 `64` 个字符时将返回空的结果 /// 示例值：abc /// 默认值：null /// @@ -4419,7 +4461,7 @@ System.Threading.Tasks.Task PatchImV1ChatsByChatIdMembersMeJoinA /// /// /// 必填：否 - /// 分页大小 + /// 分页大小，用来限制一次请求所返回的数据条目数。 /// 示例值：10 /// 默认值：20 /// @@ -4471,7 +4513,14 @@ System.Threading.Tasks.Task DeleteImV1MessagesByMessageIdAsync( /// 接口ID：6946222931479379969 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create /// Authorization：tenant_access_token - /// 创建群并设置群头像、群名、群描述等。 + /// 创建群聊，创建时支持设置群头像、群名称、群主以及群类型等配置，同时支持邀请群成员、群机器人入群。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// 商店应用无法使用用户的 user_id，因此使用商店应用调用本接口时用户 ID 类型请选择 open_id 或者 union_id。 + /// ## 注意事项 + /// - 如果你需要在已创建的群聊内邀请用户或机器人入群，可调用[将用户或机器人拉入群聊](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create)接口。 + /// - 调用 API 只能创建普通消息群，消息形式可以选择对话消息或者话题消息。如果你需要直接创建话题群，请通过飞书客户端创建群组，创建时群模式选择 **话题**。 /// 权限要求： /// im:chat /// im:chat:create @@ -4493,13 +4542,13 @@ System.Threading.Tasks.Task DeleteImV1MessagesByMessageIdAsync( /// /// /// 必填：否 - /// 如果在请求体的 ==owner_id== 字段指定了某个用户为群主，可以选择是否同时设置创建此群的机器人为管理员，此标志位用于标记是否设置创建群的机器人为管理员 + /// 如果在请求体的 ==owner_id== 字段指定了某个用户为群主，可以选择是否同时设置创建此群的机器人为管理员，此标志位用于标记是否设置创建群的机器人为管理员。 /// 示例值：false /// 默认值：false /// /// /// 必填：否 - /// 由开发者生成的唯一字符串序列，用于创建群组请求去重；持有相同uuid + owner_id（若有） 的请求10小时内只可成功创建1个群聊 + /// 由开发者生成的唯一字符串序列，用于创建群组请求去重；持有相同 uuid + owner_id（若有） 的请求 10 小时内只可成功创建 1 个群聊。不传值表示不进行请求去重，每一次请求成功后都会创建一个群聊。 /// 示例值：b13g2t38-1jd2-458b-8djf-dtbca5104204 /// 默认值：null /// @@ -4516,7 +4565,14 @@ System.Threading.Tasks.Task DeleteImV1MessagesByMessageIdAsync( /// 接口ID：6946222931479396353 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/delete /// Authorization：tenant_access_token、user_access_token - /// 解散群组。 + /// 通过 chat_id 解散指定群组。通过 API 解散群组后，群聊天记录将不会保存。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 如果以应用身份（tenant_access_token）解散群，则应用机器人需要符合以下任一情况。 + /// - 应用机器人是群主。 + /// - 应用机器人是群的创建者，且应用已开通 **更新应用所创建群的群信息**（im:chat:operate_as_owner）权限。 + /// - 如果以用户身份（user_access_token）解散群，需要该用户是群主。 /// 权限要求： /// im:chat /// im:chat:delete @@ -4525,8 +4581,11 @@ System.Threading.Tasks.Task DeleteImV1MessagesByMessageIdAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`的群组ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 `group` 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// [HttpDelete("/open-apis/im/v1/chats/{chat_id}")] @@ -4539,6 +4598,12 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list /// Authorization：tenant_access_token、user_access_token /// 获取 [access_token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) 所代表的用户或者机器人所在的群列表。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 注意事项 + /// - 请注意区分本接口和[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)的请求 URL。 + /// - 获取到的群列表中，不包含单聊（群模式为 `p2p`）。 + /// - 查询参数 **user_id_type** 用于控制响应体中 owner_id 的类型，如果是获取机器人所在群列表该值可以不填。 /// 权限要求： /// im:chat /// im:chat:read @@ -4566,7 +4631,7 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// 示例值：ByCreateTimeAsc /// /// ByCreateTimeAsc：按群组创建时间升序排列 - /// ByActiveTimeDesc：按群组活跃时间降序排列 + /// ByActiveTimeDesc：按群组活跃时间降序排列。因群组活跃时间变动频繁，使用 `ByActiveTimeDesc` 排序方式可能会造成群组遗漏。例如，设置分页大小为 10，发起第一次请求获取到第一页数据后，原本排在第 11 位的群组中有群成员发送了一条消息，那么该群组将被排列到第 1 位，此时发起请求获取第二页数据时，该群组将不能被获取到，需要再从第一页开始获取。 /// /// 默认值：ByCreateTimeAsc /// @@ -4578,7 +4643,7 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// /// /// 必填：否 - /// 分页大小 + /// 分页大小，用来限制一次请求返回的数据条目数。 /// 示例值：10 /// 默认值：20 /// @@ -4658,7 +4723,12 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// 接口ID：6946222931479478273 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get /// Authorization：tenant_access_token、user_access_token - /// 获取群名称、群描述、群头像、群主 ID 等群基本信息。 + /// 获取指定群的基本信息，包括群名称、群描述、群头像、群主 ID 以及群权限配置等。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 调用接口的机器人或者用户需要在群组内，才可以获取完整信息，否则只返回群名称、群头像、成员数量以及群状态信息。 + /// - 获取内部群信息时，调用接口的机器人或者用户需要与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat:read @@ -4671,7 +4741,10 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -4695,7 +4768,14 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// 接口ID：6946222931479511041 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/patch /// Authorization：tenant_access_token、user_access_token - /// 更新会话中的群公告信息，更新公告信息的格式和更新[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同，不支持新版文档格式。 + /// 更新指定群组中的群公告信息。更新的公告内容格式和更新[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)的格式相同，不支持新版云文档格式。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的群组内，且需要拥有群公告文档的阅读权限。 + /// ## 使用限制 + /// - 如果群组配置了 **仅群主和群管理员可编辑群信息**，则仅有群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以更新群公告信息。 + /// - 如果群组没有配置 **仅群主和群管理员可编辑群信息**，则所有群成员可以更新群公告信息。 + /// - 操作内部群时，操作者和被操作的群组必须在同一租户下。 /// 权限要求： /// im:chat /// im:chat.announcement:write_only @@ -4704,8 +4784,11 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// /// 路径参数 /// 必填：是 - /// 待修改公告的群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：不支持P2P单聊 + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：单聊（群类型为 `p2p`）不支持更新群公告。 /// 示例值：oc_5ad11d72b830411d72b836c20 /// /// 请求体 @@ -4925,7 +5008,16 @@ System.Threading.Tasks.Task GetImV1MessagesByMessageIdResou /// 接口ID：6946222931479592961 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/update /// Authorization：tenant_access_token、user_access_token - /// 更新群头像、群名称、群描述、群配置、转让群主等。 + /// 更新指定群的信息，包括群头像、群名称、群描述、群配置以及群主等。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 对于群主和群管理员，或是创建群组且具备 ==更新应用所创建群的群信息（im:chat:operate_as_owner）== 权限的机器人，可调用本接口更新所有信息。 + /// - 对于不满足上述权限条件的群成员或机器人： + /// - 如果群设置中配置了 **所有群成员可编辑群信息**，则仅可更新群头像、群名称、群描述、群国际化名称信息。 + /// - 如果群设置中配置了 **仅群主和群管理员可编辑群信息**，则无法修改任何群信息。 + /// ## 注意事项 + /// 调用该接口时，未传值的请求参数默认不更新，保持原有群信息。 /// 权限要求： /// im:chat /// im:chat:update @@ -4937,8 +5029,11 @@ System.Threading.Tasks.Task GetImV1MessagesByMessageIdResou /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`的群组ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 `group` 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -4964,7 +5059,17 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdAsync( /// 接口ID：6946222931479609345 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create /// Authorization：tenant_access_token、user_access_token - /// 将用户或机器人拉入群聊。 + /// 把指定的用户或机器人拉入指定群聊内。 + /// ## 前提条件 + /// - 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用该接口的应用或者用户，必须在相应的群组中。 + /// - 如需拉机器人进群，则该机器人必须开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 如果以应用身份拉用户进群，则该用户需要在应用的[可用范围](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability)内。 + /// ## 使用限制 + /// - 外部租户不能被拉入内部群，但可以被拉入外部群。通过机器人拉外部租户的用户进群，需要先为机器人配置对外共享能力，详情参考[机器人支持外部群和外部用户单聊](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/develop-robots/add-bot-to-external-group)。 + /// - 操作内部群时，当前操作者必须与群组在同一租户内。 + /// - 如果群组配置了 **仅群主和群管理员可添加群成员**，则仅有群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以拉用户或机器人进群。 + /// - 如果群组没有配置 **仅群主和群管理员可添加群成员**，则所有群成员都可以拉用户或机器人进群。 /// 权限要求： /// im:chat /// im:chat.members:write_only @@ -4976,8 +5081,11 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`、`topic`的群组ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**话题（topic）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`topic`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -4998,7 +5106,7 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdAsync( /// **默认值**：`0` /// 示例值：0 /// - /// 0：兼容之前的策略，不存在/不可见的 ID 会拉群失败，并返回错误响应。存在已离职 ID 时，会将其他可用 ID 拉入群聊，返回拉群成功的响应。 + /// 0：不存在/不可见的 ID 会拉群失败，并返回错误响应。存在已离职 ID 时，会将其他可用 ID 拉入群聊，返回拉群成功的响应。 /// 1：将参数中可用的 ID 全部拉入群聊，返回拉群成功的响应，并展示剩余不可用的 ID 及原因。 /// 2：参数中只要存在任一不可用的 ID ，就会拉群失败，返回错误响应，并展示出不可用的 ID。 /// @@ -5537,7 +5645,11 @@ System.Threading.Tasks.Task GetEhrV1AttachmentsByTokenAsync /// 接口ID：6951292665602883586 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/get /// Authorization：tenant_access_token、user_access_token - /// 获取群发言模式、可发言用户名单等。 + /// 获取指定群组的发言模式、可发言用户名单等信息。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// 调用本接口的用户或机器人必须要在对应的群组内。 /// 权限要求： /// im:chat /// im:chat:readonly @@ -5550,7 +5662,10 @@ System.Threading.Tasks.Task GetEhrV1AttachmentsByTokenAsync /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -5566,7 +5681,7 @@ System.Threading.Tasks.Task GetEhrV1AttachmentsByTokenAsync /// /// /// 必填：否 - /// 分页大小 + /// 分页大小，用来限制一次请求返回的数据条目数。 /// 示例值：dmJCRHhpd3JRbGV1VEVNRFFyTitRWDY5ZFkybmYrMEUwMUFYT0VMMWdENEtuYUhsNUxGMDIwemtvdE5ORjBNQQ== /// 默认值：10 /// @@ -5588,7 +5703,14 @@ System.Threading.Tasks.Task GetEhrV1AttachmentsByTokenAsync /// 接口ID：6951292665602899970 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/update /// Authorization：tenant_access_token、user_access_token - /// 更新群组的发言权限设置，可设置为全员可发言、仅管理员可发言 或 指定用户可发言。 + /// 更新指定群组的发言权限，可设置为所有群成员可发言、仅群主或管理员可发言、指定群成员可发言。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 如果以用户身份（user_access_token）调用本接口，则该用户必须是群组的群主，才可以更新群发言权限。 + /// - 如果以应用身份（tenant_access_token）调用本接口，则该应用机器人需要符合以下任一情况才可以更新群发言权限。 + /// - 机器人是群组的群主。 + /// - 机器人是群组的创建者、具备==更新应用所创建群的群信息（im:chat:operate_as_owner）== 权限，且仍在群组内。 /// 权限要求： /// im:chat /// im:chat:moderation:write_only @@ -5600,7 +5722,10 @@ System.Threading.Tasks.Task GetEhrV1AttachmentsByTokenAsync /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -9653,9 +9778,7 @@ System.Threading.Tasks.Task PostHelpdeskV1EventsUnsubscribeAsync /// 接口ID：6960166873968443395 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/delete /// Authorization：tenant_access_token、user_access_token - /// 删除一个数据表，最后一张数据表不允许被删除。 - /// note - /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) + /// 删除一个数据表，如果多维表格中只剩最后一张数据表，则不允许被删除。 /// 权限要求： /// base:table:delete /// bitable:app @@ -9664,13 +9787,19 @@ System.Threading.Tasks.Task PostHelpdeskV1EventsUnsubscribeAsync /// /// 路径参数 /// 必填：是 - /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识。你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id`。你也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id`。 + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// @@ -9684,9 +9813,7 @@ System.Threading.Tasks.Task DeleteBitableV1AppsByAppTokenTablesB /// 接口ID：6960166873968459779 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_delete /// Authorization：tenant_access_token、user_access_token - /// 删除多个数据表。 - /// note - /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) + /// 删除多个数据表。如果多维表格中只剩最后一张数据表，则不允许被删除。 /// 权限要求： /// base:table:delete /// bitable:app @@ -9695,7 +9822,11 @@ System.Threading.Tasks.Task DeleteBitableV1AppsByAppTokenTablesB /// /// 路径参数 /// 必填：是 - /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// 请求体 @@ -9709,7 +9840,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// 接口ID：6960166873968476163 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list /// Authorization：tenant_access_token、user_access_token - /// 根据 app_token，获取多维表格下的所有数据表。 + /// 列出多维表格中的所有数据表，包括其 ID、版本号和名称。 /// 权限要求： /// base:table:read /// bitable:app @@ -9719,7 +9850,11 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// @@ -9874,7 +10009,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// 接口ID：6960166873968541699 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/create /// Authorization：tenant_access_token、user_access_token - /// 新增一个数据表，默认仅包含索引列，也可以指定一部分初始字段。 + /// 新增一个数据表，默认仅包含索引字段，也可以指定一部分初始字段。 /// 权限要求： /// base:table:create /// bitable:app @@ -9883,7 +10018,11 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 app_token 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// 请求体 @@ -9897,7 +10036,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// 接口ID：6960166873968558083 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_create /// Authorization：tenant_access_token、user_access_token - /// 新增多个数据表。 + /// 新增多个数据表，仅可指定数据表名称。 /// 权限要求： /// base:table:create /// bitable:app @@ -9909,7 +10048,11 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 app_token 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// @@ -11882,7 +12025,7 @@ System.Threading.Tasks.Task DeleteSheetsV3SpreadsheetsBySpreadsh /// 接口ID：6978670625209597954 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list /// Authorization：tenant_access_token、user_access_token - /// 根据 app_token 和 table_id，获取数据表的所有视图 + /// 获取多维表格数据表中的所有视图。 /// 权限要求： /// base:view:read /// bitable:app @@ -11895,13 +12038,20 @@ System.Threading.Tasks.Task DeleteSheetsV3SpreadsheetsBySpreadsh /// /// 路径参数 /// 必填：是 - /// base app token + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// table id + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// @@ -11940,7 +12090,7 @@ System.Threading.Tasks.Task DeleteSheetsV3SpreadsheetsBySpreadsh /// 接口ID：6978670625209614338 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/create /// Authorization：tenant_access_token、user_access_token - /// 在数据表中新增一个视图 + /// 在多维表格数据表中新增一个视图，可指定视图类型，包括表格视图、看板视图、画册视图、甘特视图和表单视图。 /// 权限要求： /// base:view:write_only /// bitable:app @@ -11949,13 +12099,20 @@ System.Threading.Tasks.Task DeleteSheetsV3SpreadsheetsBySpreadsh /// /// 路径参数 /// 必填：是 - /// base app token + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// table id + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// 请求体 @@ -11970,7 +12127,7 @@ System.Threading.Tasks.Task DeleteSheetsV3SpreadsheetsBySpreadsh /// 接口ID：6978670625209630722 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/delete /// Authorization：tenant_access_token、user_access_token - /// 删除数据表中的视图 + /// 删除多维表格数据表中的指定视图。 /// 权限要求： /// base:view:write_only /// bitable:app @@ -11979,19 +12136,31 @@ System.Threading.Tasks.Task DeleteSheetsV3SpreadsheetsBySpreadsh /// /// 路径参数 /// 必填：是 - /// base app token + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// table id + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// /// 路径参数 /// 必填：是 - /// 视图Id + /// 多维表格中视图的唯一标识。获取方式： + /// - 在多维表格的 URL 地址栏中，`view_id` 是下图中高亮部分： + /// ![view_id.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/140668632c97e0095832219001d17c54_DJMgVH9x2S.png?height=748&lazyload=true&width=2998) + /// - 通过[列出视图](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list)接口获取。暂时无法获取到嵌入到云文档中的多维表格的 `view_id`。 + /// **注意**： + /// 当 `filter` 参数 或 `sort` 参数不为空时，请求视为对数据表中的全部数据做条件过滤，指定的 `view_id` 会被忽略。 /// 示例值：vewTpR1urY /// [HttpDelete("/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/views/{view_id}")] @@ -15178,7 +15347,11 @@ System.Threading.Tasks.Task PostReportV1RulesByRuleIdViewsRemove /// 接口ID：6995085510524698625 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/add_managers /// Authorization：tenant_access_token、user_access_token - /// 将用户或机器人指定为群管理员。 + /// 指定群组，将群内指定的用户或者机器人设置为群管理员。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// 仅群组内的群主可以指定群管理员。 /// 权限要求： /// im:chat /// im:chat.managers:write_only @@ -15190,8 +15363,11 @@ System.Threading.Tasks.Task PostReportV1RulesByRuleIdViewsRemove /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`、`topic`的群组ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**话题（topic）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`topic`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -15218,7 +15394,11 @@ System.Threading.Tasks.Task PostReportV1RulesByRuleIdViewsRemove /// 接口ID：6995085510524715009 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/delete_managers /// Authorization：tenant_access_token、user_access_token - /// 删除指定的群管理员（用户或机器人）。 + /// 指定群组，删除群组内指定的管理员，包括用户类型的管理员和机器人类型的管理员。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// 仅群组内的群主可以删除群管理员。 /// 权限要求： /// im:chat /// im:chat.managers:write_only @@ -15230,8 +15410,11 @@ System.Threading.Tasks.Task PostReportV1RulesByRuleIdViewsRemove /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`、`topic`的群组ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**话题（topic）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`topic`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -19802,7 +19985,11 @@ System.Threading.Tasks.Task DeleteMailV1UserMailboxesByUserMailb /// 接口ID：7043611687799816193 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/put_top_notice /// Authorization：tenant_access_token、user_access_token - /// 更新会话中的群置顶信息，可以将群中的某一条消息，或者群公告置顶显示。 + /// 更新群组中的群置顶信息，可以将群中的某一条消息，或群公告置顶展示。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// 调用接口的机器人或者用户必须要在群组内，且和该群组属于同一租户。 /// 权限要求： /// im:chat /// im:chat.top_notice:write_only @@ -19811,7 +19998,10 @@ System.Threading.Tasks.Task DeleteMailV1UserMailboxesByUserMailb /// /// 路径参数 /// 必填：是 - /// 待修改置顶的群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_5ad11d72b830411d72b836c20 /// /// 请求体 @@ -19825,7 +20015,11 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticePutTop /// 接口ID：7043624153760759810 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/delete_top_notice /// Authorization：tenant_access_token、user_access_token - /// 撤销会话中的置顶。 + /// 撤销指定群组中的置顶消息或群公告。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// 调用接口的机器人或者用户必须要在群组内，且和该群组属于同一租户。 /// 权限要求： /// im:chat /// im:chat.top_notice:write_only @@ -19834,7 +20028,10 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticePutTop /// /// 路径参数 /// 必填：是 - /// 待撤销置顶的群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_5ad11d72b830411d72b836c20 /// [HttpPost("/open-apis/im/v1/chats/{chat_id}/top_notice/delete_top_notice")] @@ -25490,7 +25687,14 @@ System.Threading.Tasks.Task PutHireV1OfferCustomFieldsByOfferCus /// 接口ID：7111246605500563457 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create /// Authorization：tenant_access_token、user_access_token - /// 添加自定义会话标签页。 + /// 在指定会话内添加自定义会话标签页，仅支持添加文档类型（doc）或 URL （url）类型的标签页。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的会话内。 + /// ## 使用限制 + /// - 调用该接口仅支持添加 doc、url 类型的标签页，即 tab_type 参数传值时，只能传入 doc 或 url，传入其他枚举值将会报错。如果你需要添加其他类型的会话标签页，需要在飞书客户端内操作，详情参见[会话内标签页](https://www.feishu.cn/hc/zh-CN/articles/536850681075)。 + /// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以添加会话标签页。 + /// - 操作内部群时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat.tabs:write_only @@ -25499,8 +25703,11 @@ System.Threading.Tasks.Task PutHireV1OfferCustomFieldsByOfferCus /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：支持群模式为`p2p`与`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**单聊（p2p）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`p2p`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 请求体 @@ -25514,7 +25721,14 @@ System.Threading.Tasks.Task PutHireV1OfferCustomFieldsByOfferCus /// 接口ID：7111246605500579841 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/delete_tabs /// Authorization：tenant_access_token、user_access_token - /// 删除会话标签页。 + /// 删除指定会话内的一个或多个会话标签页。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的会话内。 + /// ## 使用限制 + /// - 只允许删除类型为`doc`和`url`的会话标签页。 + /// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以删除会话标签页。 + /// - 操作内部群时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat.tabs:write_only @@ -25523,8 +25737,11 @@ System.Threading.Tasks.Task PutHireV1OfferCustomFieldsByOfferCus /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：支持群模式为`p2p`与`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**单聊（p2p）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`p2p`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 请求体 @@ -25538,7 +25755,12 @@ System.Threading.Tasks.Task PutHireV1OfferCustomFieldsByOfferCus /// 接口ID：7111246605500596225 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs /// Authorization：tenant_access_token、user_access_token - /// 拉取会话标签页。 + /// 获取指定会话内的会话标签页信息，包括 ID、名称、类型以及内容等。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的会话内。 + /// ## 使用限制 + /// 操作内部群时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat:readonly @@ -25548,8 +25770,11 @@ System.Threading.Tasks.Task PutHireV1OfferCustomFieldsByOfferCus /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：支持群模式为`p2p`与`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**单聊（p2p）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`p2p`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// [HttpGet("/open-apis/im/v1/chats/{chat_id}/chat_tabs/list_tabs")] @@ -25561,7 +25786,14 @@ System.Threading.Tasks.Task PutHireV1OfferCustomFieldsByOfferCus /// 接口ID：7111246605500612609 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/update_tabs /// Authorization：tenant_access_token、user_access_token - /// 更新会话标签页。 + /// 更新指定的会话标签页信息，包括名称、类型以及内容等。仅支持更新文档类型（doc）或 URL （url）类型的标签页。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的会话内。 + /// ## 使用限制 + /// - 调用该接口仅支持更新 doc、url 类型的标签页，即 tab_type 参数传值时，只能传入 doc 或 url，传入其他枚举值将会报错。如果你需要更新其他类型的会话标签页，需要在飞书客户端内操作，详情参见[会话内标签页](https://www.feishu.cn/hc/zh-CN/articles/536850681075)。 + /// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以更新会话标签页。 + /// - 操作内部群时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat.tabs:write_only @@ -25570,8 +25802,11 @@ System.Threading.Tasks.Task PutHireV1OfferCustomFieldsByOfferCus /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：支持群模式为`p2p`与`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**单聊（p2p）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`p2p`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 请求体 @@ -25585,7 +25820,14 @@ System.Threading.Tasks.Task PutHireV1OfferCustomFieldsByOfferCus /// 接口ID：7111246605500628993 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/sort_tabs /// Authorization：tenant_access_token、user_access_token - /// 会话标签页排序。 + /// 调整指定会话内的多个会话标签页排列顺序。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的会话内。 + /// ## 使用限制 + /// - 会话内消息类型的标签页固定为第一顺位，不参与排序，但需要注意请求时 tab_ids 必须包含消息类型标签页的 ID。 + /// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以调整会话标签页排序。 + /// - 操作内部群时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat.tabs:write_only @@ -25594,8 +25836,11 @@ System.Threading.Tasks.Task PutHireV1OfferCustomFieldsByOfferCus /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：支持群模式为`p2p`与`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**单聊（p2p）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`p2p`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 请求体 @@ -28159,7 +28404,15 @@ System.Threading.Tasks.Task DeleteImV1PinsByMessageIdAsync( /// 接口ID：7139929321426386972 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/link /// Authorization：tenant_access_token、user_access_token - /// 获取指定群的分享链接。 + /// 获取指定群的分享链接，他人点击分享链接后可加入群组。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 调用该接口的用户或机器人必须在对应群组内。 + /// - 单聊、密聊、团队群不支持生成分享链接。 + /// - 当机器人被停用或者退出群组时，由该机器人获取的群分享链接也将失效。 + /// - 当群组设置了 **仅群主和群管理员可添加群成员或分享群** 时，调用该接口的用户或机器人必须是群组的群主或管理员。 + /// - 获取内部群分享链接时，调用该接口的用户或机器人必须和群组属于同一租户。 /// 权限要求： /// im:chat /// im:chat:read @@ -28169,7 +28422,10 @@ System.Threading.Tasks.Task DeleteImV1PinsByMessageIdAsync( /// /// 路径参数 /// 必填：是 - /// 待获取分享链接的群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// **注意**：单聊、密聊、团队群不支持分享群链接 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// @@ -29527,7 +29783,15 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// 接口ID：7174746098262638596 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/create /// Authorization：tenant_access_token - /// 该接口用于向群组中添加群菜单。 + /// 在指定群组中添加一个或多个群菜单。成功调用后接口会返回当前群组内所有群菜单信息。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的机器人必须在对应的群组内。 + /// ## 使用限制 + /// - 该接口是向群内追加菜单，群内已存在的菜单不会被覆盖。 + /// - 一个群内最多有 3 个一级菜单，每个一级菜单最多配置 5 个二级菜单。 + /// - 不支持在已有的一级菜单中追加二级菜单。 + /// - 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 权限要求： /// im:chat /// im:chat.menu_tree:write_only @@ -29536,8 +29800,11 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 请求体 @@ -29551,7 +29818,13 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// 接口ID：7174746098262654980 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/delete /// Authorization：tenant_access_token - /// 该接口用于删除群内已经添加的群菜单。 + /// 删除指定群内的一级菜单。成功调用后接口会返回群组内最新的群菜单信息。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的会话内。 + /// ## 使用限制 + /// - 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 + /// - 仅支持删除群组内的一级菜单。 /// 权限要求： /// im:chat /// im:chat.menu_tree:write_only @@ -29560,8 +29833,11 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 请求体 @@ -29575,7 +29851,12 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// 接口ID：7174746098262671364 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get /// Authorization：tenant_access_token - /// 通过群 ID 获取群内菜单。 + /// 获取指定群组内的群菜单信息，包括所有一级或二级菜单的名称、跳转链接、图标等信息。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的机器人必须在对应的群组内。 + /// ## 使用限制 + /// 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 权限要求： /// im:chat /// im:chat:readonly @@ -29585,8 +29866,11 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// [HttpGet("/open-apis/im/v1/chats/{chat_id}/menu_tree")] @@ -29598,7 +29882,13 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// 接口ID：7174746098262687748 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/sort /// Authorization：tenant_access_token - /// 给一个群内的一级菜单排序。 + /// 调整指定群组内的群菜单排列顺序，成功调用后接口会返回群组内所有群菜单信息。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的机器人必须在对应的群组内。 + /// ## 使用限制 + /// - 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 + /// - 仅支持调整群组内一级菜单的排序。 /// 权限要求： /// im:chat /// im:chat.menu_tree:write_only @@ -29607,8 +29897,11 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 请求体 @@ -29622,7 +29915,13 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// 接口ID：7174746098262704132 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_item/patch /// Authorization：tenant_access_token - /// 修改某个一级菜单或者二级菜单的元信息，包括群菜单的图标、名称、国际化名称和跳转链接。 + /// 修改指定群组内的某个一级菜单或者二级菜单的元信息，包括图标、名称、国际化名称和跳转链接。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的机器人必须在对应的群组内。 + /// ## 使用限制 + /// - 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 + /// - 本接口不支持在一级菜单上添加或删除二级菜单。 /// 权限要求： /// im:chat /// im:chat.menu_tree:write_only @@ -29631,14 +29930,17 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// /// 路径参数 /// 必填：是 - /// 一级或二级菜单ID，通过 [获取群菜单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) 接口通过群ID获取菜单ID。 + /// 一级菜单或者二级菜单的 ID，ID 可通过 [获取群菜单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) 接口获取。 /// 示例值：7156553273518882844 /// /// 请求体 @@ -29779,7 +30081,7 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// 接口ID：7177650713441828867 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/patch /// Authorization：tenant_access_token、user_access_token - /// 该接口用于增量修改视图信息 + /// 增量更新视图信息，包括视图名称、属性等，可设置视图的筛选条件等。 /// 权限要求： /// base:view:write_only /// bitable:app @@ -29788,19 +30090,31 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// /// 路径参数 /// 必填：是 - /// base app token + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：bascng7vrxcxpig7geggXiCtadY /// /// /// 路径参数 /// 必填：是 - /// table id + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// /// 路径参数 /// 必填：是 - /// 视图 ID + /// 多维表格中视图的唯一标识。获取方式： + /// - 在多维表格的 URL 地址栏中，`view_id` 是下图中高亮部分： + /// ![view_id.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/140668632c97e0095832219001d17c54_DJMgVH9x2S.png?height=748&lazyload=true&width=2998) + /// - 通过[列出视图](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list)接口获取。暂时无法获取到嵌入到云文档中的多维表格的 `view_id`。 + /// **注意**： + /// 当 `filter` 参数 或 `sort` 参数不为空时，请求视为对数据表中的全部数据做条件过滤，指定的 `view_id` 会被忽略。 /// 示例值：vewTpR1urY /// /// 请求体 @@ -29812,11 +30126,11 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan [JsonContent] Base.PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdBodyDto dto); /// - /// 【多维表格】检索视图 + /// 【多维表格】获取视图 /// 接口ID：7177650713441845251 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/get /// Authorization：tenant_access_token、user_access_token - /// 该接口根据 view_id 检索现有视图 + /// 根据视图 ID 获取现有视图信息，包括视图名称、类型、属性等。 /// 权限要求： /// base:view:read /// bitable:app @@ -29826,19 +30140,31 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// /// 路径参数 /// 必填：是 - /// base app token + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：bascnCMII2ORej2RItqpZZUNMIe /// /// /// 路径参数 /// 必填：是 - /// table id + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// /// 路径参数 /// 必填：是 - /// 视图 ID + /// 多维表格中视图的唯一标识。获取方式： + /// - 在多维表格的 URL 地址栏中，`view_id` 是下图中高亮部分： + /// ![view_id.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/140668632c97e0095832219001d17c54_DJMgVH9x2S.png?height=748&lazyload=true&width=2998) + /// - 通过[列出视图](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list)接口获取。暂时无法获取到嵌入到云文档中的多维表格的 `view_id`。 + /// **注意**： + /// 当 `filter` 参数 或 `sort` 参数不为空时，请求视为对数据表中的全部数据做条件过滤，指定的 `view_id` 会被忽略。 /// 示例值：vewTpR1urY /// [HttpGet("/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/views/{view_id}")] @@ -29924,9 +30250,7 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// 接口ID：7182466310810402817 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/patch /// Authorization：tenant_access_token、user_access_token - /// 该接口用于更新数据表的基本信息，包括数据表的名称等。 - /// note - /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) + /// 更新数据表的名称。 /// 权限要求： /// base:table:update /// bitable:app @@ -29935,13 +30259,19 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// /// 路径参数 /// 必填：是 - /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：XrgTb4y1haKYnasu0xXb1g7lcSg /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识。你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id`。你也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id`。 + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tbl1TkhyTWDkSoZ3 /// @@ -39453,6 +39783,8 @@ System.Threading.Tasks.Task DeleteHireV1TripartiteAgreementsByTr /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search /// Authorization：tenant_access_token、user_access_token /// 该接口用于查询数据表中的现有记录，单次最多查询 500 行记录，支持分页获取。 + /// ## 注意事项 + /// 若多维表格开启了高级权限，你需确保调用身份拥有多维表格的可管理权限，否则可能出现调用成功但返回数据为空的情况。了解具体步骤，参考[如何为应用或用户开通文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 /// 权限要求： /// base:record:retrieve /// bitable:app @@ -39707,6 +40039,37 @@ System.Threading.Tasks.Task DeleteHireV1TripartiteAgreementsByTr [PathQuery] int page_size = 100, [PathQuery] string? page_token = null); + /// + /// 【飞书人事（企业版）】查询编制规划方案 + /// 接口ID：7314710843818508289 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/workforce_plan/list + /// Authorization：tenant_access_token + /// 根据传入的筛选项获取编制规划的方案列表 + /// 权限要求： + /// corehr:workforce_plan:read + /// + /// + /// + /// 必填：否 + /// 是否获取所有编制规划方案，默认为 false。 + /// - true 所有编制规划方案列表。 + /// - false 为仅获取当前生效的编制规划方案。 + /// 示例值：false + /// 默认值：null + /// + /// + /// 必填：否 + /// 是否只获取已启用的方案，默认为 true。 + /// - true 获取已启用编制规划方案 + /// - false 获取所有编制规划方案 + /// 示例值：false + /// 默认值：null + /// + [HttpGet("/open-apis/corehr/v2/workforce_plans")] + System.Threading.Tasks.Task> GetCorehrV2WorkforcePlansAsync( + [PathQuery] bool? get_all_plan = null, + [PathQuery] bool? active = null); + /// /// 【飞书人事（企业版）】查询编制规划明细信息 /// 接口ID：7314710843818524673 @@ -43346,6 +43709,21 @@ System.Threading.Tasks.Task PostHireV1TalentsByTalentIdTagAsync( [HttpGet("/open-apis/application/v6/scopes")] System.Threading.Tasks.Task> GetApplicationV6ScopesAsync(); + /// + /// 【飞书人事（企业版）】启用/停用公司 + /// 接口ID：7408127338960781340 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/company/active + /// Authorization：tenant_access_token + /// 对公司进行启用或停用操作 + /// 权限要求： + /// corehr:company:write + /// + /// + /// 请求体 + [HttpPost("/open-apis/corehr/v2/companies/active")] + System.Threading.Tasks.Task PostCorehrV2CompaniesActiveAsync( + [JsonContent] Corehr.PostCorehrV2CompaniesActiveBodyDto dto); + /// /// 【飞书人事】获取工作日历日期详情 /// 接口ID：7408403062694084611 @@ -43657,6 +44035,178 @@ System.Threading.Tasks.Task PostApaasV1ApplicationsByNamespaceRo [PathQuery] string role_api_name, [JsonContent] AppEngine.PostApaasV1ApplicationsByNamespaceRolesByRoleApiNameMemberBatchCreateAuthorizationBodyDto dto); + /// + /// 【帐号】退出登录 + /// 接口ID：7419242474898472963 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/passport-v1/session/logout + /// Authorization：tenant_access_token + /// 该接口用于退出用户的登录态 + /// 权限要求： + /// passport:session:logout + /// + /// 字段权限要求： + /// contact:user.employee_id:readonly + /// + /// + /// + /// 必填：否 + /// 用户 ID 类型 + /// 示例值：open_id + /// + /// open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id) + /// user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id) + /// + /// 默认值：open_id + /// + /// 请求体 + [HttpPost("/open-apis/passport/v1/sessions/logout")] + System.Threading.Tasks.Task PostPassportV1SessionsLogoutAsync( + [JsonContent] Passport.PostPassportV1SessionsLogoutBodyDto dto, + [PathQuery] string? user_id_type = "open_id"); + + /// + /// 【飞书人事（企业版）】添加地点地址 + /// 接口ID：7420421437192912899 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/create + /// Authorization：tenant_access_token + /// 添加地点地址 + /// 权限要求： + /// corehr:locations:write + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 地点 ID。ID 获取方式： + /// - 调用[【创建地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/create)[【批量分页查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)等接口可以返回地点 ID + /// 示例值：1616161616 + /// + /// + /// 必填：否 + /// 根据 client_token 是否一致来判断是否为同一请求 + /// 示例值：12454646 + /// 默认值：null + /// + /// 请求体 + [HttpPost("/open-apis/corehr/v2/locations/{location_id}/addresses")] + System.Threading.Tasks.Task> PostCorehrV2LocationsByLocationIdAddressesAsync( + [PathQuery] string location_id, + [JsonContent] Corehr.PostCorehrV2LocationsByLocationIdAddressesBodyDto dto, + [PathQuery] string? client_token = null); + + /// + /// 【飞书人事（企业版）】更新地点地址 + /// 接口ID：7420421437192929283 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/patch + /// Authorization：tenant_access_token + /// 更新地点地址 + /// 权限要求： + /// corehr:locations:write + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 地点 ID。ID 获取方式： + /// - 调用[【创建地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/create)[【批量分页查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)等接口可以返回地点 ID + /// 示例值：1616161616 + /// + /// + /// 路径参数 + /// 必填：是 + /// 地址 ID。ID 获取方式： + /// - 调用[【创建地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/create)[【批量分页查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)[【添加地点地址】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/create)等接口可以返回地址 ID + /// 示例值：1515151515 + /// + /// + /// 必填：否 + /// 根据 client_token 是否一致来判断是否为同一请求 + /// 示例值：12454646 + /// 默认值：null + /// + /// 请求体 + [HttpPatch("/open-apis/corehr/v2/locations/{location_id}/addresses/{address_id}")] + System.Threading.Tasks.Task PatchCorehrV2LocationsByLocationIdAddressesByAddressIdAsync( + [PathQuery] string location_id, + [PathQuery] string address_id, + [JsonContent] Corehr.PatchCorehrV2LocationsByLocationIdAddressesByAddressIdBodyDto dto, + [PathQuery] string? client_token = null); + + /// + /// 【飞书人事（企业版）】启用/停用地点 + /// 接口ID：7420421437192945667 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/active + /// Authorization：tenant_access_token + /// 启用/停用地点 + /// 权限要求： + /// corehr:locations:write + /// + /// + /// 请求体 + [HttpPost("/open-apis/corehr/v2/locations/active")] + System.Threading.Tasks.Task PostCorehrV2LocationsActiveAsync( + [JsonContent] Corehr.PostCorehrV2LocationsActiveBodyDto dto); + + /// + /// 【飞书人事（企业版）】更新地点 + /// 接口ID：7420421437192962051 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/patch + /// Authorization：tenant_access_token + /// 更新地点 + /// 权限要求： + /// corehr:locations:write + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 地点ID。ID获取方式： + /// - 调用[【创建地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/create)[【批量分页查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)等接口可以返回地点ID + /// 示例值：1616161616 + /// + /// + /// 必填：否 + /// 根据 client_token 是否一致来判断是否为同一请求 + /// 示例值：12454646 + /// 默认值：null + /// + /// 请求体 + [HttpPatch("/open-apis/corehr/v2/locations/{location_id}")] + System.Threading.Tasks.Task PatchCorehrV2LocationsByLocationIdAsync( + [PathQuery] string location_id, + [JsonContent] Corehr.PatchCorehrV2LocationsByLocationIdBodyDto dto, + [PathQuery] string? client_token = null); + + /// + /// 【飞书人事（企业版）】删除地点地址 + /// 接口ID：7420421437192978435 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/delete + /// Authorization：tenant_access_token + /// 删除地点地址 + /// 权限要求： + /// corehr:locations:write + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 地点 ID。ID 获取方式： + /// - 调用[【创建地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/create)[【批量分页查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)等接口可以返回地点 ID + /// 示例值：1616161616 + /// + /// + /// 路径参数 + /// 必填：是 + /// 地址 ID。ID 获取方式： + /// - 调用[【创建地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/create)[【批量分页查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)[【添加地点地址】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/create)等接口可以返回地址 ID + /// 示例值：1515151515 + /// + [HttpDelete("/open-apis/corehr/v2/locations/{location_id}/addresses/{address_id}")] + System.Threading.Tasks.Task DeleteCorehrV2LocationsByLocationIdAddressesByAddressIdAsync( + [PathQuery] string location_id, + [PathQuery] string address_id); + /// /// 【飞书人事（企业版）】删除职等 /// 接口ID：7422326822924550146 @@ -43966,12 +44516,33 @@ System.Threading.Tasks.Task PatchCorehrV2JobGradesByJobGradeIdAs /// 指定人员id，按user_id_type类型传递。 /// 示例值：ou_91791271921729102012 /// + /// + /// 必填：否 + /// 任务状态 + /// 示例值：1 + /// + /// -2：跳过 + /// -1：发起 + /// 0：未开始 + /// 1：进行中 + /// 2：已拒绝 + /// 3：已通过 + /// 4：被撤回 + /// 5：抄送 + /// 6：表单提交 + /// 12：失败 + /// 14：已回退 + /// 16：发起撤销 + /// + /// 默认值：null + /// [HttpGet("/open-apis/corehr/v2/approvers")] System.Threading.Tasks.Task> GetCorehrV2ApproversAsync( [PathQuery] string user_id, [PathQuery] int page_size = 20, [PathQuery] string? page_token = "1", - [PathQuery] string? user_id_type = "open_id"); + [PathQuery] string? user_id_type = "open_id", + [PathQuery] int? approver_status = null); /// /// 【飞书人事（企业版）】查询指定时间范围内当前生效信息发生变更的公司 diff --git a/src/IFeishuUserApi.cs b/src/IFeishuUserApi.cs index 2a93349f..ba8deff3 100644 --- a/src/IFeishuUserApi.cs +++ b/src/IFeishuUserApi.cs @@ -2299,7 +2299,11 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// 接口ID：6946222929790418972 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/is_in_chat /// Authorization：tenant_access_token、user_access_token - /// 根据使用的access_token判断对应的用户或者机器人是否在群里。 + /// 根据使用的 access_token 判断对应的用户或者机器人是否在指定的群里。 + /// ## 前提条件 + /// 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// 获取内部群信息时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat:readonly @@ -2310,7 +2314,10 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 用户凭证 @@ -2324,7 +2331,11 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// 接口ID：6946222929790435356 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/get /// Authorization：tenant_access_token、user_access_token - /// 获取会话中的群公告信息，公告信息格式与[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。 + /// 获取指定群组中的群公告信息，公告信息格式与[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的群组内。 + /// - 获取内部群信息时，调用当前接口的用户或者机器人必须与对应群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat:readonly @@ -2337,8 +2348,11 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// /// 路径参数 /// 必填：是 - /// 待获取公告的群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：不支持P2P单聊 + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：单聊（群类型为 `p2p`）不支持获取群公告。 /// 示例值：oc_5ad11d72b830411d72b836c20 /// /// @@ -2364,7 +2378,14 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// 接口ID：6946222929790468124 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/delete /// Authorization：tenant_access_token、user_access_token - /// 将用户或机器人移出群聊。 + /// 将指定的用户或机器人从群聊中移出。 + /// ## 前提条件 + /// 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 仅群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以将其他群成员移出群组。 + /// - 用户或机器人在任何条件下均可将自己移出群组（即主动退群）。 + /// - 每次请求，最多移除 50 个用户或者 5 个机器人。 + /// - 操作内部群时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat.members:write_only @@ -2376,8 +2397,11 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`、`topic`的群组ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**话题（topic）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`topic`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -2406,7 +2430,15 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// 接口ID：6946222929790550044 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/get /// Authorization：tenant_access_token、user_access_token - /// 获取用户/机器人所在群的群成员列表。 + /// 获取指定群组的成员信息，包括成员名字与 ID。 + /// ## 前提条件 + /// - 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 当前接口的操作者（机器人或用户）必须在被查询的群组内。 + /// ## 使用限制 + /// - 该接口不会返回群组内的机器人成员。 + /// - 由于返回的群成员列表会过滤掉机器人成员，因此返回的群成员个数可能会小于指定的 page_size。 + /// - 如果有同一时间加入群的群成员，会一次性返回，这会导致返回的群成员个数可能会大于指定的 page_size。 + /// - 获取内部群信息时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat:readonly @@ -2420,7 +2452,10 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -2428,15 +2463,17 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// 用户 ID 类型 /// 示例值：open_id /// - /// open_id：以 open_id 来识别成员</md-enum-item> **当值为 `user_id`，字段权限要求**： <md-perm name="contact:user.employee_id:readonly" desc="获取用户 user ID" support_app_types="custom" tags="">获取用户 user ID</md-perm> </md-td> </md-tr> - /// union_id：以 union_id 来识别成员 - /// user_id：以 user_id 来识别成员 + /// open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id) + /// user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id) /// /// 默认值：open_id /// /// /// 必填：否 - /// 分页大小 + /// 分页大小，用来限制一次请求所返回的数据条目数。 + /// - 由于返回的群成员列表会过滤掉机器人成员，因此返回的群成员个数可能会小于指定的 page_size。 + /// - 如果有同一时间加入群的群成员，会一次性返回，这会导致返回的群成员个数可能会大于指定的 page_size。 /// 示例值：20 **默认值**：`20` **数据校验规则**： - 最大值：`100` /// 默认值：10 /// @@ -2460,7 +2497,12 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// 接口ID：6946222929790631964 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/me_join /// Authorization：tenant_access_token、user_access_token - /// 用户或机器人主动加入群聊。 + /// 将当前调用接口的操作者（用户或机器人）加入指定群聊。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 仅支持加入公开群。 + /// - 操作内部群时，操作者必须与相应的群组在同一租户内。 /// 权限要求： /// im:chat /// im:chat.members:write_only @@ -2469,10 +2511,13 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// **注意**： - /// - 仅支持公开（Public）群类型 - /// - 对于已认证企业的飞书的群人数默认上限：普通群5000人，会议群3000人，话题群5000人 + /// - 仅支持公开群（public），你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_type ` 参数取值是否为 `public`。 + /// - 群成员数量达到上限时无法进群。对于已认证企业的飞书的群人数默认上限：普通群 5000 人，会议群 3000 人，话题群 5000 人。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 用户凭证 @@ -2486,8 +2531,9 @@ System.Threading.Tasks.Task PatchImV1ChatsByChatIdMembersMeJoinA /// 接口ID：6946222929790648348 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search /// Authorization：tenant_access_token、user_access_token - /// 根据使用的 access_token 搜索对用户或机器人可见的群列表，包括：用户或机器人所在的群、对用户或机器人公开的群。 - /// 搜索可获得的群信息包括：群ID（chat_id）、群名称、群描述等。 + /// 获取当前身份（用户或机器人）可见的群列表，包括当前身份所在的群、对当前身份公开的群。支持关键词搜索、分页搜索。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 /// 权限要求： /// im:chat /// im:chat:read @@ -2512,11 +2558,11 @@ System.Threading.Tasks.Task PatchImV1ChatsByChatIdMembersMeJoinA /// /// 必填：否 /// 关键词 - /// **注意事项**： + /// **注意**： /// - 关键词支持匹配群国际化名称、群成员名称 - /// - 支持使用多语种搜索 + /// - 支持使用多语种搜索（飞书客户端内支持的多语种） /// - 支持拼音、前缀等模糊搜索 - /// - 关键词为空值或长度超过`64`个字符时将返回空的结果 + /// - 关键词为空值或长度超过 `64` 个字符时将返回空的结果 /// 示例值：abc /// 默认值：null /// @@ -2528,7 +2574,7 @@ System.Threading.Tasks.Task PatchImV1ChatsByChatIdMembersMeJoinA /// /// /// 必填：否 - /// 分页大小 + /// 分页大小，用来限制一次请求所返回的数据条目数。 /// 示例值：10 /// 默认值：20 /// @@ -2584,7 +2630,14 @@ System.Threading.Tasks.Task DeleteImV1MessagesByMessageIdAsync( /// 接口ID：6946222931479396353 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/delete /// Authorization：tenant_access_token、user_access_token - /// 解散群组。 + /// 通过 chat_id 解散指定群组。通过 API 解散群组后，群聊天记录将不会保存。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 如果以应用身份（tenant_access_token）解散群，则应用机器人需要符合以下任一情况。 + /// - 应用机器人是群主。 + /// - 应用机器人是群的创建者，且应用已开通 **更新应用所创建群的群信息**（im:chat:operate_as_owner）权限。 + /// - 如果以用户身份（user_access_token）解散群，需要该用户是群主。 /// 权限要求： /// im:chat /// im:chat:delete @@ -2593,8 +2646,11 @@ System.Threading.Tasks.Task DeleteImV1MessagesByMessageIdAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`的群组ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 `group` 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 用户凭证 @@ -2609,6 +2665,12 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list /// Authorization：tenant_access_token、user_access_token /// 获取 [access_token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) 所代表的用户或者机器人所在的群列表。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 注意事项 + /// - 请注意区分本接口和[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)的请求 URL。 + /// - 获取到的群列表中，不包含单聊（群模式为 `p2p`）。 + /// - 查询参数 **user_id_type** 用于控制响应体中 owner_id 的类型，如果是获取机器人所在群列表该值可以不填。 /// 权限要求： /// im:chat /// im:chat:read @@ -2636,7 +2698,7 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// 示例值：ByCreateTimeAsc /// /// ByCreateTimeAsc：按群组创建时间升序排列 - /// ByActiveTimeDesc：按群组活跃时间降序排列 + /// ByActiveTimeDesc：按群组活跃时间降序排列。因群组活跃时间变动频繁，使用 `ByActiveTimeDesc` 排序方式可能会造成群组遗漏。例如，设置分页大小为 10，发起第一次请求获取到第一页数据后，原本排在第 11 位的群组中有群成员发送了一条消息，那么该群组将被排列到第 1 位，此时发起请求获取第二页数据时，该群组将不能被获取到，需要再从第一页开始获取。 /// /// 默认值：ByCreateTimeAsc /// @@ -2648,7 +2710,7 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// /// /// 必填：否 - /// 分页大小 + /// 分页大小，用来限制一次请求返回的数据条目数。 /// 示例值：10 /// 默认值：20 /// @@ -2666,7 +2728,12 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// 接口ID：6946222931479478273 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get /// Authorization：tenant_access_token、user_access_token - /// 获取群名称、群描述、群头像、群主 ID 等群基本信息。 + /// 获取指定群的基本信息，包括群名称、群描述、群头像、群主 ID 以及群权限配置等。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 调用接口的机器人或者用户需要在群组内，才可以获取完整信息，否则只返回群名称、群头像、成员数量以及群状态信息。 + /// - 获取内部群信息时，调用接口的机器人或者用户需要与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat:read @@ -2679,7 +2746,10 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -2705,7 +2775,14 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// 接口ID：6946222931479511041 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/patch /// Authorization：tenant_access_token、user_access_token - /// 更新会话中的群公告信息，更新公告信息的格式和更新[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同，不支持新版文档格式。 + /// 更新指定群组中的群公告信息。更新的公告内容格式和更新[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)的格式相同，不支持新版云文档格式。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的群组内，且需要拥有群公告文档的阅读权限。 + /// ## 使用限制 + /// - 如果群组配置了 **仅群主和群管理员可编辑群信息**，则仅有群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以更新群公告信息。 + /// - 如果群组没有配置 **仅群主和群管理员可编辑群信息**，则所有群成员可以更新群公告信息。 + /// - 操作内部群时，操作者和被操作的群组必须在同一租户下。 /// 权限要求： /// im:chat /// im:chat.announcement:write_only @@ -2714,8 +2791,11 @@ System.Threading.Tasks.Task DeleteImV1ChatsByChatIdAsync( /// /// 路径参数 /// 必填：是 - /// 待修改公告的群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：不支持P2P单聊 + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：单聊（群类型为 `p2p`）不支持更新群公告。 /// 示例值：oc_5ad11d72b830411d72b836c20 /// /// 请求体 @@ -2770,7 +2850,16 @@ System.Threading.Tasks.Task PatchImV1MessagesByMessageIdAsync( /// 接口ID：6946222931479592961 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/update /// Authorization：tenant_access_token、user_access_token - /// 更新群头像、群名称、群描述、群配置、转让群主等。 + /// 更新指定群的信息，包括群头像、群名称、群描述、群配置以及群主等。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 对于群主和群管理员，或是创建群组且具备 ==更新应用所创建群的群信息（im:chat:operate_as_owner）== 权限的机器人，可调用本接口更新所有信息。 + /// - 对于不满足上述权限条件的群成员或机器人： + /// - 如果群设置中配置了 **所有群成员可编辑群信息**，则仅可更新群头像、群名称、群描述、群国际化名称信息。 + /// - 如果群设置中配置了 **仅群主和群管理员可编辑群信息**，则无法修改任何群信息。 + /// ## 注意事项 + /// 调用该接口时，未传值的请求参数默认不更新，保持原有群信息。 /// 权限要求： /// im:chat /// im:chat:update @@ -2782,8 +2871,11 @@ System.Threading.Tasks.Task PatchImV1MessagesByMessageIdAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`的群组ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 `group` 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -2811,7 +2903,17 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdAsync( /// 接口ID：6946222931479609345 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create /// Authorization：tenant_access_token、user_access_token - /// 将用户或机器人拉入群聊。 + /// 把指定的用户或机器人拉入指定群聊内。 + /// ## 前提条件 + /// - 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用该接口的应用或者用户，必须在相应的群组中。 + /// - 如需拉机器人进群，则该机器人必须开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 如果以应用身份拉用户进群，则该用户需要在应用的[可用范围](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability)内。 + /// ## 使用限制 + /// - 外部租户不能被拉入内部群，但可以被拉入外部群。通过机器人拉外部租户的用户进群，需要先为机器人配置对外共享能力，详情参考[机器人支持外部群和外部用户单聊](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/develop-robots/add-bot-to-external-group)。 + /// - 操作内部群时，当前操作者必须与群组在同一租户内。 + /// - 如果群组配置了 **仅群主和群管理员可添加群成员**，则仅有群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以拉用户或机器人进群。 + /// - 如果群组没有配置 **仅群主和群管理员可添加群成员**，则所有群成员都可以拉用户或机器人进群。 /// 权限要求： /// im:chat /// im:chat.members:write_only @@ -2823,8 +2925,11 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`、`topic`的群组ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**话题（topic）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`topic`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -2845,7 +2950,7 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdAsync( /// **默认值**：`0` /// 示例值：0 /// - /// 0：兼容之前的策略，不存在/不可见的 ID 会拉群失败，并返回错误响应。存在已离职 ID 时，会将其他可用 ID 拉入群聊，返回拉群成功的响应。 + /// 0：不存在/不可见的 ID 会拉群失败，并返回错误响应。存在已离职 ID 时，会将其他可用 ID 拉入群聊，返回拉群成功的响应。 /// 1：将参数中可用的 ID 全部拉入群聊，返回拉群成功的响应，并展示剩余不可用的 ID 及原因。 /// 2：参数中只要存在任一不可用的 ID ，就会拉群失败，返回错误响应，并展示出不可用的 ID。 /// @@ -2866,7 +2971,11 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdAsync( /// 接口ID：6951292665602883586 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/get /// Authorization：tenant_access_token、user_access_token - /// 获取群发言模式、可发言用户名单等。 + /// 获取指定群组的发言模式、可发言用户名单等信息。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// 调用本接口的用户或机器人必须要在对应的群组内。 /// 权限要求： /// im:chat /// im:chat:readonly @@ -2879,7 +2988,10 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -2895,7 +3007,7 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdAsync( /// /// /// 必填：否 - /// 分页大小 + /// 分页大小，用来限制一次请求返回的数据条目数。 /// 示例值：dmJCRHhpd3JRbGV1VEVNRFFyTitRWDY5ZFkybmYrMEUwMUFYT0VMMWdENEtuYUhsNUxGMDIwemtvdE5ORjBNQQ== /// 默认值：10 /// @@ -2919,7 +3031,14 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdAsync( /// 接口ID：6951292665602899970 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/update /// Authorization：tenant_access_token、user_access_token - /// 更新群组的发言权限设置，可设置为全员可发言、仅管理员可发言 或 指定用户可发言。 + /// 更新指定群组的发言权限，可设置为所有群成员可发言、仅群主或管理员可发言、指定群成员可发言。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 如果以用户身份（user_access_token）调用本接口，则该用户必须是群组的群主，才可以更新群发言权限。 + /// - 如果以应用身份（tenant_access_token）调用本接口，则该应用机器人需要符合以下任一情况才可以更新群发言权限。 + /// - 机器人是群组的群主。 + /// - 机器人是群组的创建者、具备==更新应用所创建群的群信息（im:chat:operate_as_owner）== 权限，且仍在群组内。 /// 权限要求： /// im:chat /// im:chat:moderation:write_only @@ -2931,7 +3050,10 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdAsync( /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -5366,9 +5488,7 @@ System.Threading.Tasks.Task DeleteHelpdeskV1CategoriesByIdAsync( /// 接口ID：6960166873968443395 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/delete /// Authorization：tenant_access_token、user_access_token - /// 删除一个数据表，最后一张数据表不允许被删除。 - /// note - /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) + /// 删除一个数据表，如果多维表格中只剩最后一张数据表，则不允许被删除。 /// 权限要求： /// base:table:delete /// bitable:app @@ -5377,13 +5497,19 @@ System.Threading.Tasks.Task DeleteHelpdeskV1CategoriesByIdAsync( /// /// 路径参数 /// 必填：是 - /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识。你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id`。你也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id`。 + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// @@ -5399,9 +5525,7 @@ System.Threading.Tasks.Task DeleteBitableV1AppsByAppTokenTablesB /// 接口ID：6960166873968459779 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_delete /// Authorization：tenant_access_token、user_access_token - /// 删除多个数据表。 - /// note - /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) + /// 删除多个数据表。如果多维表格中只剩最后一张数据表，则不允许被删除。 /// 权限要求： /// base:table:delete /// bitable:app @@ -5410,7 +5534,11 @@ System.Threading.Tasks.Task DeleteBitableV1AppsByAppTokenTablesB /// /// 路径参数 /// 必填：是 - /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// 请求体 @@ -5426,7 +5554,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// 接口ID：6960166873968476163 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list /// Authorization：tenant_access_token、user_access_token - /// 根据 app_token，获取多维表格下的所有数据表。 + /// 列出多维表格中的所有数据表，包括其 ID、版本号和名称。 /// 权限要求： /// base:table:read /// bitable:app @@ -5436,7 +5564,11 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// @@ -5599,7 +5731,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// 接口ID：6960166873968541699 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/create /// Authorization：tenant_access_token、user_access_token - /// 新增一个数据表，默认仅包含索引列，也可以指定一部分初始字段。 + /// 新增一个数据表，默认仅包含索引字段，也可以指定一部分初始字段。 /// 权限要求： /// base:table:create /// bitable:app @@ -5608,7 +5740,11 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 app_token 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// 请求体 @@ -5624,7 +5760,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// 接口ID：6960166873968558083 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_create /// Authorization：tenant_access_token、user_access_token - /// 新增多个数据表。 + /// 新增多个数据表，仅可指定数据表名称。 /// 权限要求： /// base:table:create /// bitable:app @@ -5636,7 +5772,11 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 app_token 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// @@ -7029,7 +7169,7 @@ System.Threading.Tasks.Task DeleteSheetsV3SpreadsheetsBySpreadsh /// 接口ID：6978670625209597954 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list /// Authorization：tenant_access_token、user_access_token - /// 根据 app_token 和 table_id，获取数据表的所有视图 + /// 获取多维表格数据表中的所有视图。 /// 权限要求： /// base:view:read /// bitable:app @@ -7042,13 +7182,20 @@ System.Threading.Tasks.Task DeleteSheetsV3SpreadsheetsBySpreadsh /// /// 路径参数 /// 必填：是 - /// base app token + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// table id + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// @@ -7089,7 +7236,7 @@ System.Threading.Tasks.Task DeleteSheetsV3SpreadsheetsBySpreadsh /// 接口ID：6978670625209614338 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/create /// Authorization：tenant_access_token、user_access_token - /// 在数据表中新增一个视图 + /// 在多维表格数据表中新增一个视图，可指定视图类型，包括表格视图、看板视图、画册视图、甘特视图和表单视图。 /// 权限要求： /// base:view:write_only /// bitable:app @@ -7098,13 +7245,20 @@ System.Threading.Tasks.Task DeleteSheetsV3SpreadsheetsBySpreadsh /// /// 路径参数 /// 必填：是 - /// base app token + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// table id + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// 请求体 @@ -7121,7 +7275,7 @@ System.Threading.Tasks.Task DeleteSheetsV3SpreadsheetsBySpreadsh /// 接口ID：6978670625209630722 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/delete /// Authorization：tenant_access_token、user_access_token - /// 删除数据表中的视图 + /// 删除多维表格数据表中的指定视图。 /// 权限要求： /// base:view:write_only /// bitable:app @@ -7130,19 +7284,31 @@ System.Threading.Tasks.Task DeleteSheetsV3SpreadsheetsBySpreadsh /// /// 路径参数 /// 必填：是 - /// base app token + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// table id + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// /// 路径参数 /// 必填：是 - /// 视图Id + /// 多维表格中视图的唯一标识。获取方式： + /// - 在多维表格的 URL 地址栏中，`view_id` 是下图中高亮部分： + /// ![view_id.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/140668632c97e0095832219001d17c54_DJMgVH9x2S.png?height=748&lazyload=true&width=2998) + /// - 通过[列出视图](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list)接口获取。暂时无法获取到嵌入到云文档中的多维表格的 `view_id`。 + /// **注意**： + /// 当 `filter` 参数 或 `sort` 参数不为空时，请求视为对数据表中的全部数据做条件过滤，指定的 `view_id` 会被忽略。 /// 示例值：vewTpR1urY /// /// 用户凭证 @@ -8622,7 +8788,11 @@ System.Threading.Tasks.Task DeleteTaskV1TasksByTaskIdCollaborato /// 接口ID：6995085510524698625 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/add_managers /// Authorization：tenant_access_token、user_access_token - /// 将用户或机器人指定为群管理员。 + /// 指定群组，将群内指定的用户或者机器人设置为群管理员。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// 仅群组内的群主可以指定群管理员。 /// 权限要求： /// im:chat /// im:chat.managers:write_only @@ -8634,8 +8804,11 @@ System.Threading.Tasks.Task DeleteTaskV1TasksByTaskIdCollaborato /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`、`topic`的群组ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**话题（topic）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`topic`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -8664,7 +8837,11 @@ System.Threading.Tasks.Task DeleteTaskV1TasksByTaskIdCollaborato /// 接口ID：6995085510524715009 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/delete_managers /// Authorization：tenant_access_token、user_access_token - /// 删除指定的群管理员（用户或机器人）。 + /// 指定群组，删除群组内指定的管理员，包括用户类型的管理员和机器人类型的管理员。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// 仅群组内的群主可以删除群管理员。 /// 权限要求： /// im:chat /// im:chat.managers:write_only @@ -8676,8 +8853,11 @@ System.Threading.Tasks.Task DeleteTaskV1TasksByTaskIdCollaborato /// /// 路径参数 /// 必填：是 - /// 群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：仅支持群模式为`group`、`topic`的群组ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**话题（topic）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`topic`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// @@ -10240,7 +10420,11 @@ System.Threading.Tasks.Task DeleteTaskV1TasksByTaskIdCommentsByC /// 接口ID：7043611687799816193 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/put_top_notice /// Authorization：tenant_access_token、user_access_token - /// 更新会话中的群置顶信息，可以将群中的某一条消息，或者群公告置顶显示。 + /// 更新群组中的群置顶信息，可以将群中的某一条消息，或群公告置顶展示。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// 调用接口的机器人或者用户必须要在群组内，且和该群组属于同一租户。 /// 权限要求： /// im:chat /// im:chat.top_notice:write_only @@ -10249,7 +10433,10 @@ System.Threading.Tasks.Task DeleteTaskV1TasksByTaskIdCommentsByC /// /// 路径参数 /// 必填：是 - /// 待修改置顶的群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_5ad11d72b830411d72b836c20 /// /// 请求体 @@ -10265,7 +10452,11 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticePutTop /// 接口ID：7043624153760759810 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/delete_top_notice /// Authorization：tenant_access_token、user_access_token - /// 撤销会话中的置顶。 + /// 撤销指定群组中的置顶消息或群公告。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// 调用接口的机器人或者用户必须要在群组内，且和该群组属于同一租户。 /// 权限要求： /// im:chat /// im:chat.top_notice:write_only @@ -10274,7 +10465,10 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticePutTop /// /// 路径参数 /// 必填：是 - /// 待撤销置顶的群 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// 示例值：oc_5ad11d72b830411d72b836c20 /// /// 用户凭证 @@ -12111,7 +12305,14 @@ System.Threading.Tasks.Task PostWikiV2SpacesBySpaceIdNodesByNode /// 接口ID：7111246605500563457 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create /// Authorization：tenant_access_token、user_access_token - /// 添加自定义会话标签页。 + /// 在指定会话内添加自定义会话标签页，仅支持添加文档类型（doc）或 URL （url）类型的标签页。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的会话内。 + /// ## 使用限制 + /// - 调用该接口仅支持添加 doc、url 类型的标签页，即 tab_type 参数传值时，只能传入 doc 或 url，传入其他枚举值将会报错。如果你需要添加其他类型的会话标签页，需要在飞书客户端内操作，详情参见[会话内标签页](https://www.feishu.cn/hc/zh-CN/articles/536850681075)。 + /// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以添加会话标签页。 + /// - 操作内部群时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat.tabs:write_only @@ -12120,8 +12321,11 @@ System.Threading.Tasks.Task PostWikiV2SpacesBySpaceIdNodesByNode /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：支持群模式为`p2p`与`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**单聊（p2p）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`p2p`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 请求体 @@ -12137,7 +12341,14 @@ System.Threading.Tasks.Task PostWikiV2SpacesBySpaceIdNodesByNode /// 接口ID：7111246605500579841 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/delete_tabs /// Authorization：tenant_access_token、user_access_token - /// 删除会话标签页。 + /// 删除指定会话内的一个或多个会话标签页。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的会话内。 + /// ## 使用限制 + /// - 只允许删除类型为`doc`和`url`的会话标签页。 + /// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以删除会话标签页。 + /// - 操作内部群时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat.tabs:write_only @@ -12146,8 +12357,11 @@ System.Threading.Tasks.Task PostWikiV2SpacesBySpaceIdNodesByNode /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：支持群模式为`p2p`与`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**单聊（p2p）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`p2p`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 请求体 @@ -12163,7 +12377,12 @@ System.Threading.Tasks.Task PostWikiV2SpacesBySpaceIdNodesByNode /// 接口ID：7111246605500596225 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs /// Authorization：tenant_access_token、user_access_token - /// 拉取会话标签页。 + /// 获取指定会话内的会话标签页信息，包括 ID、名称、类型以及内容等。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的会话内。 + /// ## 使用限制 + /// 操作内部群时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat:readonly @@ -12173,8 +12392,11 @@ System.Threading.Tasks.Task PostWikiV2SpacesBySpaceIdNodesByNode /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：支持群模式为`p2p`与`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**单聊（p2p）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`p2p`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 用户凭证 @@ -12188,7 +12410,14 @@ System.Threading.Tasks.Task PostWikiV2SpacesBySpaceIdNodesByNode /// 接口ID：7111246605500612609 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/update_tabs /// Authorization：tenant_access_token、user_access_token - /// 更新会话标签页。 + /// 更新指定的会话标签页信息，包括名称、类型以及内容等。仅支持更新文档类型（doc）或 URL （url）类型的标签页。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的会话内。 + /// ## 使用限制 + /// - 调用该接口仅支持更新 doc、url 类型的标签页，即 tab_type 参数传值时，只能传入 doc 或 url，传入其他枚举值将会报错。如果你需要更新其他类型的会话标签页，需要在飞书客户端内操作，详情参见[会话内标签页](https://www.feishu.cn/hc/zh-CN/articles/536850681075)。 + /// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以更新会话标签页。 + /// - 操作内部群时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat.tabs:write_only @@ -12197,8 +12426,11 @@ System.Threading.Tasks.Task PostWikiV2SpacesBySpaceIdNodesByNode /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：支持群模式为`p2p`与`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**单聊（p2p）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`p2p`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 请求体 @@ -12214,7 +12446,14 @@ System.Threading.Tasks.Task PostWikiV2SpacesBySpaceIdNodesByNode /// 接口ID：7111246605500628993 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/sort_tabs /// Authorization：tenant_access_token、user_access_token - /// 会话标签页排序。 + /// 调整指定会话内的多个会话标签页排列顺序。 + /// ## 前提条件 + /// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// - 调用当前接口的用户或者机器人必须在对应的会话内。 + /// ## 使用限制 + /// - 会话内消息类型的标签页固定为第一顺位，不参与排序，但需要注意请求时 tab_ids 必须包含消息类型标签页的 ID。 + /// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以调整会话标签页排序。 + /// - 操作内部群时，操作者须与群组在同一租户下。 /// 权限要求： /// im:chat /// im:chat.tabs:write_only @@ -12223,8 +12462,11 @@ System.Threading.Tasks.Task PostWikiV2SpacesBySpaceIdNodesByNode /// /// 路径参数 /// 必填：是 - /// 群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) - /// **注意**：支持群模式为`p2p`与`group`的群ID + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 + /// **注意**：仅支持群模式为 **群组（group）**、**单聊（p2p）** 的群组 ID。你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`、`p2p`。 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// /// 请求体 @@ -13314,7 +13556,15 @@ System.Threading.Tasks.Task DeleteImV1PinsByMessageIdAsync( /// 接口ID：7139929321426386972 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/link /// Authorization：tenant_access_token、user_access_token - /// 获取指定群的分享链接。 + /// 获取指定群的分享链接，他人点击分享链接后可加入群组。 + /// ## 前提条件 + /// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 + /// ## 使用限制 + /// - 调用该接口的用户或机器人必须在对应群组内。 + /// - 单聊、密聊、团队群不支持生成分享链接。 + /// - 当机器人被停用或者退出群组时，由该机器人获取的群分享链接也将失效。 + /// - 当群组设置了 **仅群主和群管理员可添加群成员或分享群** 时，调用该接口的用户或机器人必须是群组的群主或管理员。 + /// - 获取内部群分享链接时，调用该接口的用户或机器人必须和群组属于同一租户。 /// 权限要求： /// im:chat /// im:chat:read @@ -13324,7 +13574,10 @@ System.Threading.Tasks.Task DeleteImV1PinsByMessageIdAsync( /// /// 路径参数 /// 必填：是 - /// 待获取分享链接的群ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。获取方式： + /// - [创建群](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create)，从返回结果中获取该群的 chat_id。 + /// - 调用[获取用户或机器人所在的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list)接口，可以查询用户或机器人所在群的 chat_id。 + /// - 调用[搜索对用户或机器人可见的群列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search)，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 /// **注意**：单聊、密聊、团队群不支持分享群链接 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// @@ -13658,7 +13911,7 @@ System.Threading.Tasks.Task DeleteDriveV1FilesByFileTokenVersion /// 接口ID：7177650713441828867 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/patch /// Authorization：tenant_access_token、user_access_token - /// 该接口用于增量修改视图信息 + /// 增量更新视图信息，包括视图名称、属性等，可设置视图的筛选条件等。 /// 权限要求： /// base:view:write_only /// bitable:app @@ -13667,19 +13920,31 @@ System.Threading.Tasks.Task DeleteDriveV1FilesByFileTokenVersion /// /// 路径参数 /// 必填：是 - /// base app token + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：bascng7vrxcxpig7geggXiCtadY /// /// /// 路径参数 /// 必填：是 - /// table id + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// /// 路径参数 /// 必填：是 - /// 视图 ID + /// 多维表格中视图的唯一标识。获取方式： + /// - 在多维表格的 URL 地址栏中，`view_id` 是下图中高亮部分： + /// ![view_id.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/140668632c97e0095832219001d17c54_DJMgVH9x2S.png?height=748&lazyload=true&width=2998) + /// - 通过[列出视图](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list)接口获取。暂时无法获取到嵌入到云文档中的多维表格的 `view_id`。 + /// **注意**： + /// 当 `filter` 参数 或 `sort` 参数不为空时，请求视为对数据表中的全部数据做条件过滤，指定的 `view_id` 会被忽略。 /// 示例值：vewTpR1urY /// /// 请求体 @@ -13693,11 +13958,11 @@ System.Threading.Tasks.Task DeleteDriveV1FilesByFileTokenVersion [JsonContent] Base.PatchBitableV1AppsByAppTokenTablesByTableIdViewsByViewIdBodyDto dto); /// - /// 【多维表格】检索视图 + /// 【多维表格】获取视图 /// 接口ID：7177650713441845251 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/get /// Authorization：tenant_access_token、user_access_token - /// 该接口根据 view_id 检索现有视图 + /// 根据视图 ID 获取现有视图信息，包括视图名称、类型、属性等。 /// 权限要求： /// base:view:read /// bitable:app @@ -13707,19 +13972,31 @@ System.Threading.Tasks.Task DeleteDriveV1FilesByFileTokenVersion /// /// 路径参数 /// 必填：是 - /// base app token + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：bascnCMII2ORej2RItqpZZUNMIe /// /// /// 路径参数 /// 必填：是 - /// table id + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// /// 路径参数 /// 必填：是 - /// 视图 ID + /// 多维表格中视图的唯一标识。获取方式： + /// - 在多维表格的 URL 地址栏中，`view_id` 是下图中高亮部分： + /// ![view_id.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/140668632c97e0095832219001d17c54_DJMgVH9x2S.png?height=748&lazyload=true&width=2998) + /// - 通过[列出视图](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list)接口获取。暂时无法获取到嵌入到云文档中的多维表格的 `view_id`。 + /// **注意**： + /// 当 `filter` 参数 或 `sort` 参数不为空时，请求视为对数据表中的全部数据做条件过滤，指定的 `view_id` 会被忽略。 /// 示例值：vewTpR1urY /// /// 用户凭证 @@ -13832,9 +14109,7 @@ System.Threading.Tasks.Task DeleteDriveV1FilesByFileTokenVersion /// 接口ID：7182466310810402817 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/patch /// Authorization：tenant_access_token、user_access_token - /// 该接口用于更新数据表的基本信息，包括数据表的名称等。 - /// note - /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) + /// 更新数据表的名称。 /// 权限要求： /// base:table:update /// bitable:app @@ -13843,13 +14118,19 @@ System.Threading.Tasks.Task DeleteDriveV1FilesByFileTokenVersion /// /// 路径参数 /// 必填：是 - /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：XrgTb4y1haKYnasu0xXb1g7lcSg /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识。你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id`。你也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id`。 + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tbl1TkhyTWDkSoZ3 /// @@ -17889,6 +18170,8 @@ System.Threading.Tasks.Task DeleteTaskV2AttachmentsByAttachmentG /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search /// Authorization：tenant_access_token、user_access_token /// 该接口用于查询数据表中的现有记录，单次最多查询 500 行记录，支持分页获取。 + /// ## 注意事项 + /// 若多维表格开启了高级权限，你需确保调用身份拥有多维表格的可管理权限，否则可能出现调用成功但返回数据为空的情况。了解具体步骤，参考[如何为应用或用户开通文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 /// 权限要求： /// base:record:retrieve /// bitable:app diff --git a/src/Im.Events/ImChatAccessEventBotP2pChatEnteredV1EventBodyDto.cs b/src/Im.Events/ImChatAccessEventBotP2pChatEnteredV1EventBodyDto.cs index b289fcdb..6b2351cf 100644 --- a/src/Im.Events/ImChatAccessEventBotP2pChatEnteredV1EventBodyDto.cs +++ b/src/Im.Events/ImChatAccessEventBotP2pChatEnteredV1EventBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Im.Events; /// /// 用户进入与机器人的会话 事件体 -/// 用户进入与机器人的会话时触发此事件{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat.access_event&event=bot_p2p_chat_entered) +/// 用户进入与机器人的会话时触发此事件。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat.access_event&event=bot_p2p_chat_entered) /// 接口ID：7372115309028524036 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-access_event/events/bot_p2p_chat_entered /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-access_event%2fevents%2fbot_p2p_chat_entered @@ -22,21 +22,21 @@ namespace FeishuNetSdk.Im.Events; public record ImChatAccessEventBotP2pChatEnteredV1EventBodyDto() : EventBodyDto("im.chat.access_event.bot_p2p_chat_entered_v1") { /// - /// 会话 ID + /// 会话 ID，详情参见[群 ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)。 /// 必填：否 /// [JsonPropertyName("chat_id")] public string? ChatId { get; set; } /// - /// 操作人 ID + /// 操作者的 ID。用户不同 ID 类型介绍参考[用户身份概述](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。 /// 必填：否 /// [JsonPropertyName("operator_id")] public UserIdSuffix? OperatorId { get; set; } /// - /// 会话内用户可见的最新消息ID + /// 会话内用户可见的最新消息 ID，可通过[获取指定消息的内容](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/get)接口获取消息内容。 /// 必填：否 /// [JsonPropertyName("last_message_id")] diff --git a/src/Im.Events/ImChatDisbandedV1EventBodyDto.cs b/src/Im.Events/ImChatDisbandedV1EventBodyDto.cs index 9f6d54a3..fba73da1 100644 --- a/src/Im.Events/ImChatDisbandedV1EventBodyDto.cs +++ b/src/Im.Events/ImChatDisbandedV1EventBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Im.Events; /// /// 群解散 事件体 -/// 群组被解散后触发此事件。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat&event=disbanded) +/// 群组被解散后触发此事件，在该群组内的、已订阅当前事件的应用机器人将会收到事件通知。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat&event=disbanded) /// 接口ID：6946222929790599196 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat/events/disbanded /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat%2fevents%2fdisbanded @@ -22,14 +22,14 @@ namespace FeishuNetSdk.Im.Events; public record ImChatDisbandedV1EventBodyDto() : EventBodyDto("im.chat.disbanded_v1") { /// - /// 群组 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群组 ID。详情介绍参见[群 ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)。 /// 必填：否 /// [JsonPropertyName("chat_id")] public string? ChatId { get; set; } /// - /// 操作者的ID + /// 解散群的操作者的 ID 信息。 /// 必填：否 /// [JsonPropertyName("operator_id")] @@ -43,7 +43,7 @@ public record ImChatDisbandedV1EventBodyDto() : EventBodyDto("im.chat.disbanded_ public bool? External { get; set; } /// - /// 操作者的租户 Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识 + /// 操作者的租户 Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识。 /// 必填：否 /// [JsonPropertyName("operator_tenant_key")] diff --git a/src/Im.Events/ImChatMemberBotAddedV1EventBodyDto.cs b/src/Im.Events/ImChatMemberBotAddedV1EventBodyDto.cs index f8dbf4af..071a435c 100644 --- a/src/Im.Events/ImChatMemberBotAddedV1EventBodyDto.cs +++ b/src/Im.Events/ImChatMemberBotAddedV1EventBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Im.Events; /// /// 机器人进群 事件体 -/// 机器人被用户添加至群聊时触发此事件。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat.member.bot&event=added) +/// 机器人被用户添加至群聊时触发此事件，在群组内的、已订阅该事件的机器人会收到事件消息。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat.member.bot&event=added) /// 接口ID：6946222929790484508 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/event/added-2 /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-member-bot%2fevents%2fadded @@ -22,14 +22,14 @@ namespace FeishuNetSdk.Im.Events; public record ImChatMemberBotAddedV1EventBodyDto() : EventBodyDto("im.chat.member.bot.added_v1") { /// - /// 群组 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群组 ID，详情参见[群 ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) /// 必填：否 /// [JsonPropertyName("chat_id")] public string? ChatId { get; set; } /// - /// 用户 ID + /// 操作者的 ID。用户不同 ID 类型介绍参考[用户身份概述](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。 /// 必填：否 /// [JsonPropertyName("operator_id")] @@ -43,7 +43,7 @@ public record ImChatMemberBotAddedV1EventBodyDto() : EventBodyDto("im.chat.membe public bool? External { get; set; } /// - /// 操作者的租户Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识 + /// 操作者的租户 Key，为租户在飞书上的唯一标识，用来换取对应的 tenant_access_token，也可以用作租户在应用中的唯一标识 /// 必填：否 /// [JsonPropertyName("operator_tenant_key")] diff --git a/src/Im.Events/ImChatMemberBotDeletedV1EventBodyDto.cs b/src/Im.Events/ImChatMemberBotDeletedV1EventBodyDto.cs index ba741109..92cd11e5 100644 --- a/src/Im.Events/ImChatMemberBotDeletedV1EventBodyDto.cs +++ b/src/Im.Events/ImChatMemberBotDeletedV1EventBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Im.Events; /// /// 机器人被移出群 事件体 -/// 机器人被移出群聊后触发此事件。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat.member.bot&event=deleted) +/// 机器人被移出群聊后触发此事件，仅被移除群组且订阅该事件的机器人会收到事件数据。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat.member.bot&event=deleted) /// 接口ID：6946222929790566428 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/event/deleted /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-member-bot%2fevents%2fdeleted @@ -22,14 +22,14 @@ namespace FeishuNetSdk.Im.Events; public record ImChatMemberBotDeletedV1EventBodyDto() : EventBodyDto("im.chat.member.bot.deleted_v1") { /// - /// 群组 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群组 ID，详情参见[群 ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) /// 必填：否 /// [JsonPropertyName("chat_id")] public string? ChatId { get; set; } /// - /// 用户 ID + /// 操作者的 ID。用户不同 ID 类型介绍参考[用户身份概述](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。 /// 必填：否 /// [JsonPropertyName("operator_id")] @@ -43,7 +43,7 @@ public record ImChatMemberBotDeletedV1EventBodyDto() : EventBodyDto("im.chat.mem public bool? External { get; set; } /// - /// 操作者租户 Key + /// 操作者的租户 Key，为租户在飞书上的唯一标识，用来换取对应的 tenant_access_token，也可以用作租户在应用中的唯一标识 /// 必填：否 /// [JsonPropertyName("operator_tenant_key")] diff --git a/src/Im.Events/ImChatMemberUserAddedV1EventBodyDto.cs b/src/Im.Events/ImChatMemberUserAddedV1EventBodyDto.cs index ad980a8e..d821b79a 100644 --- a/src/Im.Events/ImChatMemberUserAddedV1EventBodyDto.cs +++ b/src/Im.Events/ImChatMemberUserAddedV1EventBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Im.Events; /// /// 用户进群 事件体 -/// 新用户进群（包含话题群）触发此事件。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat.member.user&event=added) +/// 新用户进群（包含话题群）时触发此事件，在群组内的、已订阅该事件的机器人会收到事件数据。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat.member.user&event=added) /// 接口ID：6946222931479429121 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/event/added /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-member-user%2fevents%2fadded @@ -22,14 +22,14 @@ namespace FeishuNetSdk.Im.Events; public record ImChatMemberUserAddedV1EventBodyDto() : EventBodyDto("im.chat.member.user.added_v1") { /// - /// 群组 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群组 ID，详情参见[群 ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) /// 必填：否 /// [JsonPropertyName("chat_id")] public string? ChatId { get; set; } /// - /// 用户 ID + /// 操作者的 ID。用户不同 ID 类型介绍参考[用户身份概述](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。 /// 必填：否 /// [JsonPropertyName("operator_id")] @@ -43,7 +43,7 @@ public record ImChatMemberUserAddedV1EventBodyDto() : EventBodyDto("im.chat.memb public bool? External { get; set; } /// - /// 操作者租户 Key + /// 操作者的租户 Key，为租户在飞书上的唯一标识，用来换取对应的 tenant_access_token，也可以用作租户在应用中的唯一标识 /// 必填：否 /// [JsonPropertyName("operator_tenant_key")] diff --git a/src/Im.Events/ImChatMemberUserDeletedV1EventBodyDto.cs b/src/Im.Events/ImChatMemberUserDeletedV1EventBodyDto.cs index 47634be0..a68a6a9e 100644 --- a/src/Im.Events/ImChatMemberUserDeletedV1EventBodyDto.cs +++ b/src/Im.Events/ImChatMemberUserDeletedV1EventBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Im.Events; /// /// 用户出群 事件体 -/// 用户主动退群或被移出群聊时推送事件。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat.member.user&event=deleted) +/// 用户主动退出群聊或被移出群聊时推触发此事件，在群组内的、已订阅该事件的机器人会收到事件数据。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat.member.user&event=deleted) /// 接口ID：6946222931479494657 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/event/deleted-2 /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-member-user%2fevents%2fdeleted @@ -22,14 +22,14 @@ namespace FeishuNetSdk.Im.Events; public record ImChatMemberUserDeletedV1EventBodyDto() : EventBodyDto("im.chat.member.user.deleted_v1") { /// - /// 群组 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群组 ID，详情参见[群 ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) /// 必填：否 /// [JsonPropertyName("chat_id")] public string? ChatId { get; set; } /// - /// 用户 ID + /// 操作者的 ID。用户不同 ID 类型介绍参考[用户身份概述](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。 /// 必填：否 /// [JsonPropertyName("operator_id")] @@ -43,7 +43,7 @@ public record ImChatMemberUserDeletedV1EventBodyDto() : EventBodyDto("im.chat.me public bool? External { get; set; } /// - /// 操作者的租户Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识 + /// 操作者的租户 Key，为租户在飞书上的唯一标识，用来换取对应的 tenant_access_token，也可以用作租户在应用中的唯一标识 /// 必填：否 /// [JsonPropertyName("operator_tenant_key")] diff --git a/src/Im.Events/ImChatMemberUserWithdrawnV1EventBodyDto.cs b/src/Im.Events/ImChatMemberUserWithdrawnV1EventBodyDto.cs index bbe8fe3c..9066e358 100644 --- a/src/Im.Events/ImChatMemberUserWithdrawnV1EventBodyDto.cs +++ b/src/Im.Events/ImChatMemberUserWithdrawnV1EventBodyDto.cs @@ -14,7 +14,8 @@ namespace FeishuNetSdk.Im.Events; /// /// 撤销拉用户进群 事件体 -/// 撤销拉用户进群后触发此事件。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat.member.user&event=withdrawn) +/// 撤销拉用户进群后触发此事件，在群组内的、已订阅该事件的机器人会收到事件消息。撤销操作是指如下图所示的群内 **撤销邀请**。 +/// ![image.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/2faba42d3e4203e1dd899931da6dbfc8_DFXlHNscdw.png?height=278&maxWidth=550&width=1383){使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat.member.user&event=withdrawn) /// 接口ID：6946222929790664732 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/event/withdrawn /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-member-user%2fevents%2fwithdrawn @@ -22,14 +23,14 @@ namespace FeishuNetSdk.Im.Events; public record ImChatMemberUserWithdrawnV1EventBodyDto() : EventBodyDto("im.chat.member.user.withdrawn_v1") { /// - /// 群组 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群组 ID，详情参见[群 ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) /// 必填：否 /// [JsonPropertyName("chat_id")] public string? ChatId { get; set; } /// - /// 用户 ID + /// 操作者的 ID。用户不同 ID 类型介绍参考[用户身份概述](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。 /// 必填：否 /// [JsonPropertyName("operator_id")] @@ -43,7 +44,7 @@ public record ImChatMemberUserWithdrawnV1EventBodyDto() : EventBodyDto("im.chat. public bool? External { get; set; } /// - /// 操作者的租户Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识 + /// 操作者的租户 Key，为租户在飞书上的唯一标识，用来换取对应的 tenant_access_token，也可以用作租户在应用中的唯一标识 /// 必填：否 /// [JsonPropertyName("operator_tenant_key")] diff --git a/src/Im.Events/ImChatUpdatedV1EventBodyDto.cs b/src/Im.Events/ImChatUpdatedV1EventBodyDto.cs index 04279680..98e35890 100644 --- a/src/Im.Events/ImChatUpdatedV1EventBodyDto.cs +++ b/src/Im.Events/ImChatUpdatedV1EventBodyDto.cs @@ -14,10 +14,10 @@ namespace FeishuNetSdk.Im.Events; /// /// 群配置修改 事件体 -/// 群组配置被修改后触发此事件，包含： -/// - 群主转移 -/// - 群基本信息修改(群头像/群名称/群描述/群国际化名称) -/// - 群权限修改(加人入群权限/群编辑权限/at所有人权限/群分享权限等){使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat&event=updated) +/// 群组配置被修改后触发此事件，在该群组内的、已订阅当前事件的应用机器人将会收到事件通知。修改操作包含： +/// - 转移群主 +/// - 修改群基本信息，包括：群头像、群名称、群描述、群国际化名称 +/// - 修改群权限，包括：加人入群权限、群编辑权限、at 所有人权限、群分享权限等{使用示例}(url=/api/tools/api_explore/api_explore_config?project=im&version=v1&resource=chat&event=updated) /// 接口ID：6946222929790615580 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat/events/updated /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat%2fevents%2fupdated @@ -25,14 +25,14 @@ namespace FeishuNetSdk.Im.Events; public record ImChatUpdatedV1EventBodyDto() : EventBodyDto("im.chat.updated_v1") { /// - /// 群组 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群组 ID，详细介绍参见[群 ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) /// 必填：否 /// [JsonPropertyName("chat_id")] public string? ChatId { get; set; } /// - /// 用户 ID + /// 修改群配置的操作者的 ID 信息 /// 必填：否 /// [JsonPropertyName("operator_id")] @@ -46,7 +46,7 @@ public record ImChatUpdatedV1EventBodyDto() : EventBodyDto("im.chat.updated_v1") public bool? External { get; set; } /// - /// 操作者租户 Key + /// 操作者的租户 Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识。 /// 必填：否 /// [JsonPropertyName("operator_tenant_key")] @@ -100,63 +100,118 @@ public record ChatChange public I18nLanguage? I18nNames { get; set; } /// - /// 加人入群权限(all_members/only_owner/unknown) + /// 谁可以邀请成员（用户或机器人）入群 + /// **可选值有**： + /// - all_members：所有成员 + /// - only_owner：仅群主和管理员 + /// - unknown：未设置 /// 必填：否 + /// 可选值： + /// - all_members：所有成员 + /// /// [JsonPropertyName("add_member_permission")] public string? AddMemberPermission { get; set; } /// - /// 群分享权限(allowed/not_allowed/unknown) + /// 群分享权限 + /// **可选值有**： + /// - allowed：允许 + /// - not_allowed：不允许 + /// - unknown：未设置 /// 必填：否 + /// 可选值： + /// - allowed：允许 + /// /// [JsonPropertyName("share_card_permission")] public string? ShareCardPermission { get; set; } /// - /// at 所有人权限(all_members/only_owner/unknown) + /// 谁可以 at 所有人 + /// **可选值有**： + /// - all_members：所有成员 + /// - only_owner：仅群主和管理员 + /// - unknown：未设置 /// 必填：否 + /// 可选值： + /// - all_members：所有成员 + /// /// [JsonPropertyName("at_all_permission")] public string? AtAllPermission { get; set; } /// - /// 群编辑权限(all_members/only_owner/unknown) + /// 谁可以编辑群 + /// **可选值有**： + /// - all_members：所有成员 + /// - only_owner：仅群主和管理员 + /// - unknown：未设置 /// 必填：否 + /// 可选值： + /// - all_members：所有成员 + /// /// [JsonPropertyName("edit_permission")] public string? EditPermission { get; set; } /// - /// 加群审批(no_approval_required/approval_required) + /// 加群是否需要审批 + /// **可选值有**： + /// - no_approval_required：无需审批 + /// - approval_required：需要审批 /// 必填：否 + /// 可选值： + /// - no_approval_required：无需审批 + /// /// [JsonPropertyName("membership_approval")] public string? MembershipApproval { get; set; } /// - /// 入群消息可见性(only_owner/all_members/not_anyone) + /// 入群提示消息的可见性 + /// **可选值有**： + /// - only_owner：仅群主和管理员可见 + /// - all_members：所有成员可见 + /// - not_anyone：任何人均不可见 /// 必填：否 + /// 可选值： + /// - only_owner：仅群主和管理员可见 + /// /// [JsonPropertyName("join_message_visibility")] public string? JoinMessageVisibility { get; set; } /// - /// 出群消息可见性(only_owner/all_members/not_anyone) + /// 出群消息可见性 + /// **可选值有**： + /// - only_owner：仅群主和管理员可见 + /// - all_members：所有成员可见 + /// - not_anyone：任何人均不可见 /// 必填：否 + /// 可选值： + /// - only_owner：仅群主和管理员可见 + /// /// [JsonPropertyName("leave_message_visibility")] public string? LeaveMessageVisibility { get; set; } /// - /// 发言权限(all_members/only_owner) + /// 发言权限 + /// **可选值有**： + /// - all_members：所有成员 + /// - only_owner：仅群主和管理员 + /// **说明**：发言权限为指定群成员时，需要参考 `moderator_list` 参数。 /// 必填：否 + /// 可选值： + /// - all_members：所有成员 + /// /// [JsonPropertyName("moderation_permission")] public string? ModerationPermission { get; set; } /// - /// 用户 ID + /// 群主 ID /// 必填：否 /// [JsonPropertyName("owner_id")] @@ -223,8 +278,13 @@ public record RestrictedModeSettingSuffix /// /// 群消息形式 - /// （chat/thread） + /// **可选值有**： + /// - chat：会话消息 + /// - thread：话题消息 /// 必填：否 + /// 可选值： + /// - chat：会话消息 + /// /// [JsonPropertyName("group_message_type")] public string? GroupMessageType { get; set; } @@ -243,7 +303,7 @@ public record RestrictedModeSettingSuffix public record ModeratorListSuffix { /// - /// 被添加进可发言名单的用户列表（列表中一定会有owner） + /// 被添加进可发言名单的用户列表（该列表中一定有群主） /// 必填：否 /// [JsonPropertyName("added_member_list")] @@ -263,7 +323,7 @@ public record ModeratorListSuffix public record ListEventModerator { /// - /// 租户 Key + /// 租户 Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识。 /// 必填：否 /// [JsonPropertyName("tenant_key")] diff --git a/src/Im.Spec/PostInteractiveV1CardUpdateBodyDto.cs b/src/Im.Spec/PostInteractiveV1CardUpdateBodyDto.cs index 5bb0e063..af3f4f8b 100644 --- a/src/Im.Spec/PostInteractiveV1CardUpdateBodyDto.cs +++ b/src/Im.Spec/PostInteractiveV1CardUpdateBodyDto.cs @@ -30,7 +30,7 @@ public record PostInteractiveV1CardUpdateBodyDto public string Token { get; set; } = string.Empty; /// - /// 消息卡片的 JSON 结构内容。具体结构说明可参见[卡片 JSON 结构](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-structure)。 + /// 消息卡片的内容，可以是[卡片 JSON 数据](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-structure)，也可以是卡片模板。详情参考以下请求体示例。 /// **示例值**：{"open_ids":["ou_515fbe9d04838174e2035f8xxxx"],"elements":[{"tag":"div","text":{"tag":"plain_text","content":"overflow & datePicker 功能测试"},"fields":[{"is_short":true,"text":{"tag":"lark_md","content":"已同意"}}]}]} /// 必填：是 /// @@ -38,7 +38,7 @@ public record PostInteractiveV1CardUpdateBodyDto public object Card { get; set; } = new(); /// - /// 用户的 open_id 列表。在卡片 JSON 结构内，支持添加 open_ids 数组参数，通过该参数指定用户 open_id 来定义需要更新卡片的用户范围。用户 open_id 获取方式参考[如何获取自己的 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)。 + /// 用户的 open_id 列表，用于定义接收更新卡片的用户范围。获取方式参考[如何获取自己的 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)。 /// **示例值**：["ou_5ad573a6411d72b8305fda3a9c15xxxx"] /// **注意**： /// - 如果卡片为共享卡片（卡片 JSON 结构 `config` 参数内 `"update_multi": true` 表示共享卡片），则无需传入该值，默认会更新所有用户接收到的卡片内容。若传入该值，会导致无法正常更新。 diff --git a/src/Im.Spec/PostMessageV4BatchSendBodyDto.cs b/src/Im.Spec/PostMessageV4BatchSendBodyDto.cs index 48fb0fcb..c972fba7 100644 --- a/src/Im.Spec/PostMessageV4BatchSendBodyDto.cs +++ b/src/Im.Spec/PostMessageV4BatchSendBodyDto.cs @@ -72,6 +72,7 @@ public record PostMessageV4BatchSendBodyDto /// /// 部门 ID 列表。列表内支持传入部门 department_id 和 open_department_id，部门 ID 介绍与获取方式，参见[部门资源介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview)的 **部门 ID** 章节。 /// **注意**： + /// - 不支持传入根部门 ID（根部门 ID 为 `0`）。 /// - 列表长度不能超过 200。 /// - 请求时，消息会发送给 ID 对应部门内的所有成员，包括部门下的所有子部门成员。 /// - `department_ids`、`open_ids`、`user_ids`、`union_ids` 四个字段至少需要填写其中一个。 diff --git a/src/Im/DeleteImV1ChatsByChatIdChatTabsDeleteTabsBodyDto.cs b/src/Im/DeleteImV1ChatsByChatIdChatTabsDeleteTabsBodyDto.cs index 81fd1a4d..71e33879 100644 --- a/src/Im/DeleteImV1ChatsByChatIdChatTabsDeleteTabsBodyDto.cs +++ b/src/Im/DeleteImV1ChatsByChatIdChatTabsDeleteTabsBodyDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 删除会话标签页 请求体 -/// 删除会话标签页。 +/// 删除指定会话内的一个或多个会话标签页。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的用户或者机器人必须在对应的会话内。 +/// ## 使用限制 +/// - 只允许删除类型为`doc`和`url`的会话标签页。 +/// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以删除会话标签页。 +/// - 操作内部群时，操作者须与群组在同一租户下。 /// 接口ID：7111246605500579841 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-tab/delete_tabs /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-tab%2fdelete_tabs @@ -22,9 +29,9 @@ namespace FeishuNetSdk.Im; public record DeleteImV1ChatsByChatIdChatTabsDeleteTabsBodyDto { /// - /// 会话标签页ID列表，Tab ID可以在[添加会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create)与[拉取会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs)的返回值中获取 + /// 会话标签页 ID 列表，ID 可以在[添加会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create)或者[拉取会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs)接口返回值中获取。 /// 必填：是 - /// 示例值：["7101214603622940671","7101214603622940672"] + /// 示例值：["7101214603622940671", "7101214603622940672"] /// [JsonPropertyName("tab_ids")] public string[] TabIds { get; set; } = Array.Empty(); diff --git a/src/Im/DeleteImV1ChatsByChatIdChatTabsDeleteTabsResponseDto.cs b/src/Im/DeleteImV1ChatsByChatIdChatTabsDeleteTabsResponseDto.cs index 22fd2f66..797e581c 100644 --- a/src/Im/DeleteImV1ChatsByChatIdChatTabsDeleteTabsResponseDto.cs +++ b/src/Im/DeleteImV1ChatsByChatIdChatTabsDeleteTabsResponseDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 删除会话标签页 响应体 -/// 删除会话标签页。 +/// 删除指定会话内的一个或多个会话标签页。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的用户或者机器人必须在对应的会话内。 +/// ## 使用限制 +/// - 只允许删除类型为`doc`和`url`的会话标签页。 +/// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以删除会话标签页。 +/// - 操作内部群时，操作者须与群组在同一租户下。 /// 接口ID：7111246605500579841 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-tab/delete_tabs /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-tab%2fdelete_tabs @@ -34,7 +41,7 @@ public record DeleteImV1ChatsByChatIdChatTabsDeleteTabsResponseDto public record ChatTab { /// - /// Tab ID + /// 会话标签页 ID /// 必填：否 /// 示例值：7101214603622940671 /// @@ -42,8 +49,7 @@ public record ChatTab public string? TabId { get; set; } /// - /// Tab名称 - /// **注意**：会话标签页的名称不能超过30个字符 + /// 会话标签页名称 /// 必填：否 /// 示例值：文档 /// @@ -51,7 +57,7 @@ public record ChatTab public string? TabName { get; set; } /// - /// Tab类型 + /// 会话标签页类型 /// 必填：是 /// 示例值：doc /// 可选值： @@ -63,7 +69,7 @@ public record ChatTab /// chat_announcement：群公告 /// url：URL /// file：文件 - /// files_resources：合并类型, 包含文件、Doc文档、URL链接 + /// files_resources：合并类型，包含文件、Doc文档、URL链接 /// images_videos：合并类型，包含图片、视频 /// /// @@ -71,19 +77,19 @@ public record ChatTab public string TabType { get; set; } = string.Empty; /// - /// Tab内容 + /// 会话标签页内容 /// 必填：否 /// [JsonPropertyName("tab_content")] public ChatTabContent? TabContent { get; set; } /// - /// Tab内容 + /// 会话标签页内容 /// public record ChatTabContent { /// - /// URL类型 + /// url 类型标签页对应的 URL 地址 /// 必填：否 /// 示例值：https://www.feishu.cn /// @@ -91,7 +97,7 @@ public record ChatTabContent public string? Url { get; set; } /// - /// Doc链接 + /// 文档类型标签页对应的云文档链接 /// 必填：否 /// 示例值：https://example.feishu.cn/wiki/wikcnPIcqWjJQwkwDzrB9t40123xz /// @@ -99,7 +105,7 @@ public record ChatTabContent public string? Doc { get; set; } /// - /// 会议纪要 + /// 会议纪要类型标签页对应的会议纪要地址 /// 必填：否 /// 示例值：https://example.feishu.cn/docs/doccnvIXbV22i6hSD3utar4123dx /// @@ -108,19 +114,19 @@ public record ChatTabContent } /// - /// Tab的配置 + /// 会话标签页配置 /// 必填：否 /// [JsonPropertyName("tab_config")] public ChatTabConfig? TabConfig { get; set; } /// - /// Tab的配置 + /// 会话标签页配置 /// public record ChatTabConfig { /// - /// 群Tab图标 + /// 会话标签页图标 /// 必填：否 /// 示例值：img_v2_b99741-7628-4abd-aad0-b881e4db83ig /// @@ -128,7 +134,7 @@ public record ChatTabConfig public string? IconKey { get; set; } /// - /// 群tab是否App内嵌打开 + /// 会话标签页是否在 App 内嵌打开 /// 必填：否 /// 示例值：false /// diff --git a/src/Im/DeleteImV1ChatsByChatIdMembersBodyDto.cs b/src/Im/DeleteImV1ChatsByChatIdMembersBodyDto.cs index 784a4ef7..07bce98e 100644 --- a/src/Im/DeleteImV1ChatsByChatIdMembersBodyDto.cs +++ b/src/Im/DeleteImV1ChatsByChatIdMembersBodyDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 将用户或机器人移出群聊 请求体 -/// 将用户或机器人移出群聊。 +/// 将指定的用户或机器人从群聊中移出。 +/// ## 前提条件 +/// 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// - 仅群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以将其他群成员移出群组。 +/// - 用户或机器人在任何条件下均可将自己移出群组（即主动退群）。 +/// - 每次请求，最多移除 50 个用户或者 5 个机器人。 +/// - 操作内部群时，操作者须与群组在同一租户下。 /// 接口ID：6946222929790468124 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/delete /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-members%2fdelete @@ -22,10 +29,12 @@ namespace FeishuNetSdk.Im; public record DeleteImV1ChatsByChatIdMembersBodyDto { /// - /// 成员列表。移除群内的用户时推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)；移除群内的机器人时需填写应用的App ID，请参考[如何获取应用的 App ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id) + /// 成员 ID 列表。ID 类型与查询参数 member_id_type 的取值一致。 + /// - 移除群内的用户时推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)。 + /// - 移除群内的机器人时需填写应用的 App ID，请参考[如何获取应用的 App ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id)。 /// **注意**： - /// - 成员列表不可为空 - /// - 列表中填写的成员ID类型应与 ==member_id_type== 参数中选择的类型相对应 + /// - 成员列表不可为空。 + /// - 每次请求，最多移除 50 个用户或者 5 个机器人。 /// 必填：否 /// 示例值：["ou_9204a37300b3700d61effaa439f34295"] /// diff --git a/src/Im/DeleteImV1ChatsByChatIdMembersResponseDto.cs b/src/Im/DeleteImV1ChatsByChatIdMembersResponseDto.cs index e9dc444a..ebb9fdd1 100644 --- a/src/Im/DeleteImV1ChatsByChatIdMembersResponseDto.cs +++ b/src/Im/DeleteImV1ChatsByChatIdMembersResponseDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 将用户或机器人移出群聊 响应体 -/// 将用户或机器人移出群聊。 +/// 将指定的用户或机器人从群聊中移出。 +/// ## 前提条件 +/// 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// - 仅群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以将其他群成员移出群组。 +/// - 用户或机器人在任何条件下均可将自己移出群组（即主动退群）。 +/// - 每次请求，最多移除 50 个用户或者 5 个机器人。 +/// - 操作内部群时，操作者须与群组在同一租户下。 /// 接口ID：6946222929790468124 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/delete /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-members%2fdelete @@ -22,7 +29,7 @@ namespace FeishuNetSdk.Im; public record DeleteImV1ChatsByChatIdMembersResponseDto { /// - /// 无效成员列表 + /// 无效成员列表。 /// 必填：否 /// [JsonPropertyName("invalid_id_list")] diff --git a/src/Im/DeleteImV1ChatsByChatIdMenuTreeBodyDto.cs b/src/Im/DeleteImV1ChatsByChatIdMenuTreeBodyDto.cs index 27d0b75a..a52d87ac 100644 --- a/src/Im/DeleteImV1ChatsByChatIdMenuTreeBodyDto.cs +++ b/src/Im/DeleteImV1ChatsByChatIdMenuTreeBodyDto.cs @@ -14,7 +14,13 @@ namespace FeishuNetSdk.Im; /// /// 删除群菜单 请求体 -/// 该接口用于删除群内已经添加的群菜单。 +/// 删除指定群内的一级菜单。成功调用后接口会返回群组内最新的群菜单信息。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的用户或者机器人必须在对应的会话内。 +/// ## 使用限制 +/// - 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 +/// - 仅支持删除群组内的一级菜单。 /// 接口ID：7174746098262654980 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-menu_tree/delete /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-menu_tree%2fdelete @@ -22,7 +28,7 @@ namespace FeishuNetSdk.Im; public record DeleteImV1ChatsByChatIdMenuTreeBodyDto { /// - /// 群内要删除的一级菜单ID。通过 [获取群菜单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) 接口获取群内菜单详情。 + /// 一级菜单 ID。ID 可通过 [获取群菜单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) 接口获取。 /// 必填：是 /// 示例值：7156553273518882844 /// diff --git a/src/Im/DeleteImV1ChatsByChatIdMenuTreeResponseDto.cs b/src/Im/DeleteImV1ChatsByChatIdMenuTreeResponseDto.cs index fcaa7047..dd450063 100644 --- a/src/Im/DeleteImV1ChatsByChatIdMenuTreeResponseDto.cs +++ b/src/Im/DeleteImV1ChatsByChatIdMenuTreeResponseDto.cs @@ -14,7 +14,13 @@ namespace FeishuNetSdk.Im; /// /// 删除群菜单 响应体 -/// 该接口用于删除群内已经添加的群菜单。 +/// 删除指定群内的一级菜单。成功调用后接口会返回群组内最新的群菜单信息。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的用户或者机器人必须在对应的会话内。 +/// ## 使用限制 +/// - 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 +/// - 仅支持删除群组内的一级菜单。 /// 接口ID：7174746098262654980 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-menu_tree/delete /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-menu_tree%2fdelete @@ -22,14 +28,14 @@ namespace FeishuNetSdk.Im; public record DeleteImV1ChatsByChatIdMenuTreeResponseDto { /// - /// 群内现有菜单 + /// 删除群菜单后，群内现有菜单的信息。 /// 必填：否 /// [JsonPropertyName("menu_tree")] public ChatMenuTree? MenuTree { get; set; } /// - /// 群内现有菜单 + /// 删除群菜单后，群内现有菜单的信息。 /// public record ChatMenuTree { @@ -46,7 +52,7 @@ public record ChatMenuTree public record ChatMenuTopLevel { /// - /// 一级菜单ID + /// 一级菜单 ID /// 必填：否 /// 示例值：7117116451961487361 /// @@ -67,12 +73,10 @@ public record ChatMenuTopLevelChatMenuItem { /// /// 菜单类型 - /// **注意** - /// - 如果一级菜单有二级菜单时，则此一级菜单的值必须为NONE。 /// 必填：否 /// 示例值：NONE /// 可选值： - /// NONE：无类型 + /// NONE：无类型，当一级菜单下有二级菜单时，类型取值为 NONE。 /// REDIRECT_LINK：跳转链接类型 /// /// @@ -92,7 +96,7 @@ public record ChatMenuTopLevelChatMenuItem public record ChatMenuItemRedirectLink { /// - /// 公用跳转链接，必须以http开头。 + /// 公用跳转链接 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -100,7 +104,7 @@ public record ChatMenuItemRedirectLink public string? CommonUrl { get; set; } /// - /// IOS端跳转链接，当该字段不设置时，IOS端会使用common_url。必须以http开头。 + /// iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 common_url 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -108,7 +112,7 @@ public record ChatMenuItemRedirectLink public string? IosUrl { get; set; } /// - /// Android端跳转链接，当该字段不设置时，Android端会使用common_url。必须以http开头。 + /// Android 端跳转链接，当该字段不设置时，Android 端默认使用 common_url 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -116,7 +120,8 @@ public record ChatMenuItemRedirectLink public string? AndroidUrl { get; set; } /// - /// PC端跳转链接，当该字段不设置时，PC端会使用common_url。必须以http开头。在PC端点击群菜单后，如果需要url对应的页面在飞书侧边栏展开，可以在url前加上https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=，比如https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/ + /// PC 端跳转链接，当该字段不设置时，PC 端默认使用 common_url 值。 + /// **说明**：以 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=` 开头的链接表示在飞书侧边栏展开。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -124,7 +129,7 @@ public record ChatMenuItemRedirectLink public string? PcUrl { get; set; } /// - /// Web端跳转链接，当该字段不设置时，Web端会使用common_url。必须以http开头。 + /// Web 端跳转链接，当该字段不设置时，Web 端默认使用 common_url 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -133,9 +138,8 @@ public record ChatMenuItemRedirectLink } /// - /// 图片的key值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key - /// **注意** - /// - 如果一级菜单有二级菜单，则此一级菜单不能有图标。 + /// 图标的 key 值。通过[下载图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get)接口可将图标下载到本地（只能下载由当前机器人上传的图片）。 + /// **注意**：一级菜单下存在二级菜单时不能设置图标。 /// 必填：否 /// 示例值：img_v2_b0fbe905-7988-4282-b882-82edd010336j /// @@ -143,9 +147,7 @@ public record ChatMenuItemRedirectLink public string? ImageKey { get; set; } /// - /// 菜单名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单名称 /// 必填：否 /// 示例值：评审报名 /// @@ -153,18 +155,14 @@ public record ChatMenuItemRedirectLink public string? Name { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// 必填：否 /// [JsonPropertyName("i18n_names")] public ChatMenuTopLevelChatMenuItemI18nNames? I18nNames { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// public record ChatMenuTopLevelChatMenuItemI18nNames { @@ -179,7 +177,7 @@ public record ChatMenuTopLevelChatMenuItemI18nNames /// /// 英文名 /// 必填：否 - /// 示例值：Signup + /// 示例值：Sign up /// [JsonPropertyName("en_us")] public string? EnUs { get; set; } @@ -207,7 +205,7 @@ public record ChatMenuTopLevelChatMenuItemI18nNames public record ChatMenuSecondLevel { /// - /// 二级菜单ID + /// 二级菜单 ID /// 必填：否 /// 示例值：7039638308221468675 /// @@ -228,8 +226,6 @@ public record ChatMenuSecondLevelChatMenuItem { /// /// 菜单类型 - /// **注意** - /// - 如果一级菜单有二级菜单时，则此一级菜单的值必须为NONE。 /// 必填：否 /// 示例值：NONE /// 可选值： @@ -253,7 +249,7 @@ public record ChatMenuSecondLevelChatMenuItem public record ChatMenuItemRedirectLink { /// - /// 公用跳转链接，必须以http开头。 + /// 公用跳转链接 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -261,7 +257,7 @@ public record ChatMenuItemRedirectLink public string? CommonUrl { get; set; } /// - /// IOS端跳转链接，当该字段不设置时，IOS端会使用common_url。必须以http开头。 + /// iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 common_url 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -269,7 +265,7 @@ public record ChatMenuItemRedirectLink public string? IosUrl { get; set; } /// - /// Android端跳转链接，当该字段不设置时，Android端会使用common_url。必须以http开头。 + /// Android 端跳转链接，当该字段不设置时，Android 端默认使用 common_url 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -277,7 +273,8 @@ public record ChatMenuItemRedirectLink public string? AndroidUrl { get; set; } /// - /// PC端跳转链接，当该字段不设置时，PC端会使用common_url。必须以http开头。在PC端点击群菜单后，如果需要url对应的页面在飞书侧边栏展开，可以在url前加上https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=，比如https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/ + /// PC 端跳转链接，当该字段不设置时，PC 端默认使用 `common_url` 值。 + /// **说明**：以 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=` 开头的链接表示在飞书侧边栏展开。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -285,7 +282,7 @@ public record ChatMenuItemRedirectLink public string? PcUrl { get; set; } /// - /// Web端跳转链接，当该字段不设置时，Web端会使用common_url。必须以http开头。 + /// Web 端跳转链接，当该字段不设置时，Web 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -294,9 +291,7 @@ public record ChatMenuItemRedirectLink } /// - /// 图片的key值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key - /// **注意** - /// - 如果一级菜单有二级菜单，则此一级菜单不能有图标。 + /// 图标的 key 值。通过[下载图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get)接口可将图标下载到本地（只能下载由当前机器人上传的图片）。 /// 必填：否 /// 示例值：img_v2_b0fbe905-7988-4282-b882-82edd010336j /// @@ -304,9 +299,7 @@ public record ChatMenuItemRedirectLink public string? ImageKey { get; set; } /// - /// 菜单名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单名称 /// 必填：否 /// 示例值：评审报名 /// @@ -314,18 +307,14 @@ public record ChatMenuItemRedirectLink public string? Name { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// 必填：否 /// [JsonPropertyName("i18n_names")] public ChatMenuSecondLevelChatMenuItemI18nNames? I18nNames { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// public record ChatMenuSecondLevelChatMenuItemI18nNames { @@ -340,7 +329,7 @@ public record ChatMenuSecondLevelChatMenuItemI18nNames /// /// 英文名 /// 必填：否 - /// 示例值：Signup + /// 示例值：Sign up /// [JsonPropertyName("en_us")] public string? EnUs { get; set; } diff --git a/src/Im/GetImV1ChatsByChatIdAnnouncementResponseDto.cs b/src/Im/GetImV1ChatsByChatIdAnnouncementResponseDto.cs index 9ec304f9..962495c3 100644 --- a/src/Im/GetImV1ChatsByChatIdAnnouncementResponseDto.cs +++ b/src/Im/GetImV1ChatsByChatIdAnnouncementResponseDto.cs @@ -14,7 +14,11 @@ namespace FeishuNetSdk.Im; /// /// 获取群公告信息 响应体 -/// 获取会话中的群公告信息，公告信息格式与[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。 +/// 获取指定群组中的群公告信息，公告信息格式与[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的用户或者机器人必须在对应的群组内。 +/// - 获取内部群信息时，调用当前接口的用户或者机器人必须与对应群组在同一租户下。 /// 接口ID：6946222929790435356 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-announcement/get /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-announcement%2fget @@ -22,7 +26,9 @@ namespace FeishuNetSdk.Im; public record GetImV1ChatsByChatIdAnnouncementResponseDto { /// - /// 云文档序列化信息 + /// 群公告内容，以旧版云文档序列化数据结构展示，数据结构详情参考： + /// - [编辑旧版文档内容](https://open.feishu.cn/document/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN) + /// - [旧版文档数据结构参考](https://open.feishu.cn/document/ukTMukTMukTM/ukDM2YjL5AjN24SOwYjN) /// 必填：否 /// 示例值：xxx /// @@ -30,7 +36,7 @@ public record GetImV1ChatsByChatIdAnnouncementResponseDto public string? Content { get; set; } /// - /// 文档当前版本号 纯数字 + /// 文档当前版本号 /// 必填：否 /// 示例值：12 /// @@ -55,22 +61,22 @@ public record GetImV1ChatsByChatIdAnnouncementResponseDto /// /// 文档所有者的 ID 类型 - /// - 如果所有者是用户，则与查询参数中的user_id_type 相同；取值为`open_id` `user_id` `union_id` 其中之一，不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction) - /// - 如果所有者是机器人，为机器人应用的 `app_id`，详情参见 [获取应用身份访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/g) + /// - 如果所有者是用户，则类型与查询参数中的 user_id_type 相同，取值为`open_id` `user_id` `union_id` 其中之一，不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。 + /// - 如果所有者是机器人，为机器人应用的 `app_id`，详情参见 [获取应用身份访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/g)。 /// 必填：否 /// 示例值：open_id /// 可选值： - /// user_id：以user_id来识别用户 - /// union_id：以union_id来识别用户 - /// open_id：以open_id来识别用户 - /// app_id：以app_id来识别机器人应用 + /// user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。 + /// union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。 + /// open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。 + /// app_id：飞书开放平台应用的唯一标识。在创建应用时，由系统自动生成，用户不能自行修改。 /// /// [JsonPropertyName("owner_id_type")] public string? OwnerIdType { get; set; } /// - /// 文档所有者 ID，ID 值与owner_id_type 中的ID类型对应 + /// 文档所有者 ID，ID 类型与 owner_id_type 取值一致。 /// 必填：否 /// 示例值：ou_7d8a6e6df7621556ce0d21922b676706ccs /// @@ -78,23 +84,23 @@ public record GetImV1ChatsByChatIdAnnouncementResponseDto public string? OwnerId { get; set; } /// - /// 文档最新修改者 id 类型 - /// - 如果修改者是用户，则与查询参数中的user_id_type 相同；取值为`open_id` `user_id` `union_id` 其中之一，不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction) - /// - 如果修改者是机器人，为机器人应用的 `app_id`，详情参见 [获取应用身份访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/g) + /// 文档最新修改者 ID 类型。 + /// - 如果修改者是用户，则类型与查询参数中的 user_id_type 相同，取值为`open_id` `user_id` `union_id` 其中之一，不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。 + /// - 如果修改者是机器人，为机器人应用的 `app_id`，详情参见 [获取应用身份访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/g)。 /// 必填：否 /// 示例值：open_id /// 可选值： - /// user_id：以user_id来识别用户 - /// union_id：以union_id来识别用户 - /// open_id：以open_id来识别用户 - /// app_id：以app_id来识别应用 + /// user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。 + /// union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。 + /// open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。 + /// app_id：飞书开放平台应用的唯一标识。在创建应用时，由系统自动生成，用户不能自行修改。 /// /// [JsonPropertyName("modifier_id_type")] public string? ModifierIdType { get; set; } /// - /// 文档最新修改者 ID，ID 值与modifier_id_type 中的ID类型对应 + /// 文档最新修改者 ID，ID 类型与 modifier_id_type 取值一致。 /// 必填：否 /// 示例值：ou_7d8a6e6df7621556ce0d21922b676706ccs /// diff --git a/src/Im/GetImV1ChatsByChatIdChatTabsListTabsResponseDto.cs b/src/Im/GetImV1ChatsByChatIdChatTabsListTabsResponseDto.cs index 531ac4b8..6637a916 100644 --- a/src/Im/GetImV1ChatsByChatIdChatTabsListTabsResponseDto.cs +++ b/src/Im/GetImV1ChatsByChatIdChatTabsListTabsResponseDto.cs @@ -14,7 +14,12 @@ namespace FeishuNetSdk.Im; /// /// 拉取会话标签页 响应体 -/// 拉取会话标签页。 +/// 获取指定会话内的会话标签页信息，包括 ID、名称、类型以及内容等。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的用户或者机器人必须在对应的会话内。 +/// ## 使用限制 +/// 操作内部群时，操作者须与群组在同一租户下。 /// 接口ID：7111246605500596225 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-tab/list_tabs /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-tab%2flist_tabs @@ -34,7 +39,7 @@ public record GetImV1ChatsByChatIdChatTabsListTabsResponseDto public record ChatTab { /// - /// Tab ID + /// 会话标签页 ID /// 必填：否 /// 示例值：7101214603622940671 /// @@ -42,8 +47,7 @@ public record ChatTab public string? TabId { get; set; } /// - /// Tab名称 - /// **注意**：会话标签页的名称不能超过30个字符 + /// 会话标签页名称 /// 必填：否 /// 示例值：文档 /// @@ -51,7 +55,7 @@ public record ChatTab public string? TabName { get; set; } /// - /// Tab类型 + /// 会话标签页类型 /// 必填：是 /// 示例值：doc /// 可选值： @@ -63,7 +67,7 @@ public record ChatTab /// chat_announcement：群公告 /// url：URL /// file：文件 - /// files_resources：合并类型, 包含文件、Doc文档、URL链接 + /// files_resources：合并类型，包含文件、Doc文档、URL链接 /// images_videos：合并类型，包含图片、视频 /// /// @@ -71,19 +75,19 @@ public record ChatTab public string TabType { get; set; } = string.Empty; /// - /// Tab内容 + /// 会话标签页内容 /// 必填：否 /// [JsonPropertyName("tab_content")] public ChatTabContent? TabContent { get; set; } /// - /// Tab内容 + /// 会话标签页内容 /// public record ChatTabContent { /// - /// URL类型 + /// url 类型标签页对应的 URL 地址 /// 必填：否 /// 示例值：https://www.feishu.cn /// @@ -91,7 +95,7 @@ public record ChatTabContent public string? Url { get; set; } /// - /// Doc链接 + /// 文档类型标签页对应的云文档链接 /// 必填：否 /// 示例值：https://example.feishu.cn/wiki/wikcnPIcqWjJQwkwDzrB9t40123xz /// @@ -99,7 +103,7 @@ public record ChatTabContent public string? Doc { get; set; } /// - /// 会议纪要 + /// 会议纪要类型标签页对应的会议纪要地址 /// 必填：否 /// 示例值：https://example.feishu.cn/docs/doccnvIXbV22i6hSD3utar4123dx /// @@ -108,19 +112,19 @@ public record ChatTabContent } /// - /// Tab的配置 + /// 会话标签页配置 /// 必填：否 /// [JsonPropertyName("tab_config")] public ChatTabConfig? TabConfig { get; set; } /// - /// Tab的配置 + /// 会话标签页配置 /// public record ChatTabConfig { /// - /// 群Tab图标 + /// 会话标签页图标。可调用[下载图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get)（只能下载由当前机器人上传的图片），将图标下载至本地查看 /// 必填：否 /// 示例值：img_v2_b99741-7628-4abd-aad0-b881e4db83ig /// @@ -128,7 +132,7 @@ public record ChatTabConfig public string? IconKey { get; set; } /// - /// 群tab是否App内嵌打开 + /// 会话标签页是否在 App 内嵌打开 /// 必填：否 /// 示例值：false /// diff --git a/src/Im/GetImV1ChatsByChatIdMembersIsInChatResponseDto.cs b/src/Im/GetImV1ChatsByChatIdMembersIsInChatResponseDto.cs index d6d914b5..7f64e7cc 100644 --- a/src/Im/GetImV1ChatsByChatIdMembersIsInChatResponseDto.cs +++ b/src/Im/GetImV1ChatsByChatIdMembersIsInChatResponseDto.cs @@ -14,7 +14,11 @@ namespace FeishuNetSdk.Im; /// /// 判断用户或机器人是否在群里 响应体 -/// 根据使用的access_token判断对应的用户或者机器人是否在群里。 +/// 根据使用的 access_token 判断对应的用户或者机器人是否在指定的群里。 +/// ## 前提条件 +/// 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// 获取内部群信息时，操作者须与群组在同一租户下。 /// 接口ID：6946222929790418972 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/is_in_chat /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-members%2fis_in_chat diff --git a/src/Im/GetImV1ChatsByChatIdMembersResponseDto.cs b/src/Im/GetImV1ChatsByChatIdMembersResponseDto.cs index 62e33cc8..4e3b7a1c 100644 --- a/src/Im/GetImV1ChatsByChatIdMembersResponseDto.cs +++ b/src/Im/GetImV1ChatsByChatIdMembersResponseDto.cs @@ -14,7 +14,15 @@ namespace FeishuNetSdk.Im; /// /// 获取群成员列表 响应体 -/// 获取用户/机器人所在群的群成员列表。 +/// 获取指定群组的成员信息，包括成员名字与 ID。 +/// ## 前提条件 +/// - 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 当前接口的操作者（机器人或用户）必须在被查询的群组内。 +/// ## 使用限制 +/// - 该接口不会返回群组内的机器人成员。 +/// - 由于返回的群成员列表会过滤掉机器人成员，因此返回的群成员个数可能会小于指定的 page_size。 +/// - 如果有同一时间加入群的群成员，会一次性返回，这会导致返回的群成员个数可能会大于指定的 page_size。 +/// - 获取内部群信息时，操作者须与群组在同一租户下。 /// 接口ID：6946222929790550044 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/get /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-members%2fget @@ -42,7 +50,7 @@ public record ListMember public string? MemberIdType { get; set; } /// - /// 成员的用户ID，ID值与查询参数中的 member_id_type 对应。 + /// 成员的用户ID，ID 值与查询参数中的 member_id_type 对应。 /// 不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction) /// 必填：否 /// 示例值：4d7a3c6g diff --git a/src/Im/GetImV1ChatsByChatIdMenuTreeResponseDto.cs b/src/Im/GetImV1ChatsByChatIdMenuTreeResponseDto.cs index c79d33c9..51b693e1 100644 --- a/src/Im/GetImV1ChatsByChatIdMenuTreeResponseDto.cs +++ b/src/Im/GetImV1ChatsByChatIdMenuTreeResponseDto.cs @@ -14,7 +14,12 @@ namespace FeishuNetSdk.Im; /// /// 获取群菜单 响应体 -/// 通过群 ID 获取群内菜单。 +/// 获取指定群组内的群菜单信息，包括所有一级或二级菜单的名称、跳转链接、图标等信息。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的机器人必须在对应的群组内。 +/// ## 使用限制 +/// 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 接口ID：7174746098262671364 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-menu_tree/get /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-menu_tree%2fget @@ -22,14 +27,14 @@ namespace FeishuNetSdk.Im; public record GetImV1ChatsByChatIdMenuTreeResponseDto { /// - /// 群内所有菜单 + /// 群内所有菜单的信息 /// 必填：否 /// [JsonPropertyName("menu_tree")] public ChatMenuTree? MenuTree { get; set; } /// - /// 群内所有菜单 + /// 群内所有菜单的信息 /// public record ChatMenuTree { @@ -46,7 +51,7 @@ public record ChatMenuTree public record ChatMenuTopLevel { /// - /// 一级菜单ID + /// 一级菜单 ID。删除、修改、排序等群菜单管理操作均需要使用菜单 ID。 /// 必填：否 /// 示例值：7117116451961487361 /// @@ -67,12 +72,10 @@ public record ChatMenuTopLevelChatMenuItem { /// /// 菜单类型 - /// **注意** - /// - 如果一级菜单有二级菜单时，则此一级菜单的值必须为NONE。 /// 必填：否 /// 示例值：NONE /// 可选值： - /// NONE：无类型 + /// NONE：无类型，当一级菜单下有二级菜单时，类型取值为 NONE。 /// REDIRECT_LINK：跳转链接类型 /// /// @@ -92,7 +95,7 @@ public record ChatMenuTopLevelChatMenuItem public record ChatMenuItemRedirectLink { /// - /// 公用跳转链接，必须以http开头。 + /// 公用跳转链接 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -100,7 +103,7 @@ public record ChatMenuItemRedirectLink public string? CommonUrl { get; set; } /// - /// IOS端跳转链接，当该字段不设置时，IOS端会使用common_url。必须以http开头。 + /// iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -108,7 +111,7 @@ public record ChatMenuItemRedirectLink public string? IosUrl { get; set; } /// - /// Android端跳转链接，当该字段不设置时，Android端会使用common_url。必须以http开头。 + /// Android 端跳转链接，当该字段不设置时，Android 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -116,7 +119,8 @@ public record ChatMenuItemRedirectLink public string? AndroidUrl { get; set; } /// - /// PC端跳转链接，当该字段不设置时，PC端会使用common_url。必须以http开头。在PC端点击群菜单后，如果需要url对应的页面在飞书侧边栏展开，可以在url前加上https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=，比如https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/ + /// PC 端跳转链接，当该字段不设置时，PC 端默认使用 `common_url` 值。 + /// **说明**：以 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=` 开头的链接表示在飞书侧边栏展开。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -124,7 +128,7 @@ public record ChatMenuItemRedirectLink public string? PcUrl { get; set; } /// - /// Web端跳转链接，当该字段不设置时，Web端会使用common_url。必须以http开头。 + /// Web 端跳转链接，当该字段不设置时，Web 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -133,9 +137,8 @@ public record ChatMenuItemRedirectLink } /// - /// 图片的key值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key - /// **注意** - /// - 如果一级菜单有二级菜单，则此一级菜单不能有图标。 + /// 图标的 key 值。通过[下载图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get)接口可将图标下载到本地（只能下载由当前机器人上传的图片）。 + /// **注意**：一级菜单下存在二级菜单时不能设置图标。 /// 必填：否 /// 示例值：img_v2_b0fbe905-7988-4282-b882-82edd010336j /// @@ -143,9 +146,7 @@ public record ChatMenuItemRedirectLink public string? ImageKey { get; set; } /// - /// 菜单名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单名称 /// 必填：否 /// 示例值：评审报名 /// @@ -153,18 +154,14 @@ public record ChatMenuItemRedirectLink public string? Name { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// 必填：否 /// [JsonPropertyName("i18n_names")] public ChatMenuTopLevelChatMenuItemI18nNames? I18nNames { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// public record ChatMenuTopLevelChatMenuItemI18nNames { @@ -179,7 +176,7 @@ public record ChatMenuTopLevelChatMenuItemI18nNames /// /// 英文名 /// 必填：否 - /// 示例值：Signup + /// 示例值：Sign up /// [JsonPropertyName("en_us")] public string? EnUs { get; set; } @@ -207,7 +204,7 @@ public record ChatMenuTopLevelChatMenuItemI18nNames public record ChatMenuSecondLevel { /// - /// 二级菜单ID + /// 二级菜单 ID /// 必填：否 /// 示例值：7039638308221468675 /// @@ -228,8 +225,6 @@ public record ChatMenuSecondLevelChatMenuItem { /// /// 菜单类型 - /// **注意** - /// - 如果一级菜单有二级菜单时，则此一级菜单的值必须为NONE。 /// 必填：否 /// 示例值：NONE /// 可选值： @@ -253,7 +248,7 @@ public record ChatMenuSecondLevelChatMenuItem public record ChatMenuItemRedirectLink { /// - /// 公用跳转链接，必须以http开头。 + /// 公用跳转链接 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -261,7 +256,7 @@ public record ChatMenuItemRedirectLink public string? CommonUrl { get; set; } /// - /// IOS端跳转链接，当该字段不设置时，IOS端会使用common_url。必须以http开头。 + /// iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -269,7 +264,7 @@ public record ChatMenuItemRedirectLink public string? IosUrl { get; set; } /// - /// Android端跳转链接，当该字段不设置时，Android端会使用common_url。必须以http开头。 + /// Android 端跳转链接，当该字段不设置时，Android 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -277,7 +272,8 @@ public record ChatMenuItemRedirectLink public string? AndroidUrl { get; set; } /// - /// PC端跳转链接，当该字段不设置时，PC端会使用common_url。必须以http开头。在PC端点击群菜单后，如果需要url对应的页面在飞书侧边栏展开，可以在url前加上https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=，比如https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/ + /// PC 端跳转链接，当该字段不设置时，PC 端默认使用 `common_url` 值。 + /// **说明**：以 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=` 开头的链接表示在飞书侧边栏展开。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -285,7 +281,7 @@ public record ChatMenuItemRedirectLink public string? PcUrl { get; set; } /// - /// Web端跳转链接，当该字段不设置时，Web端会使用common_url。必须以http开头。 + /// Web 端跳转链接，当该字段不设置时，Web 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -294,9 +290,7 @@ public record ChatMenuItemRedirectLink } /// - /// 图片的key值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key - /// **注意** - /// - 如果一级菜单有二级菜单，则此一级菜单不能有图标。 + /// 图标的 key 值。通过[下载图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get)接口可将图标下载到本地（只能下载由当前机器人上传的图片）。 /// 必填：否 /// 示例值：img_v2_b0fbe905-7988-4282-b882-82edd010336j /// @@ -304,9 +298,7 @@ public record ChatMenuItemRedirectLink public string? ImageKey { get; set; } /// - /// 菜单名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单名称 /// 必填：否 /// 示例值：评审报名 /// @@ -314,18 +306,14 @@ public record ChatMenuItemRedirectLink public string? Name { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// 必填：否 /// [JsonPropertyName("i18n_names")] public ChatMenuSecondLevelChatMenuItemI18nNames? I18nNames { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// public record ChatMenuSecondLevelChatMenuItemI18nNames { @@ -340,7 +328,7 @@ public record ChatMenuSecondLevelChatMenuItemI18nNames /// /// 英文名 /// 必填：否 - /// 示例值：Signup + /// 示例值：Sign up /// [JsonPropertyName("en_us")] public string? EnUs { get; set; } diff --git a/src/Im/GetImV1ChatsByChatIdModerationResponseDto.cs b/src/Im/GetImV1ChatsByChatIdModerationResponseDto.cs index b9b97a4a..c5366a4f 100644 --- a/src/Im/GetImV1ChatsByChatIdModerationResponseDto.cs +++ b/src/Im/GetImV1ChatsByChatIdModerationResponseDto.cs @@ -14,7 +14,11 @@ namespace FeishuNetSdk.Im; /// /// 获取群成员发言权限 响应体 -/// 获取群发言模式、可发言用户名单等。 +/// 获取指定群组的发言模式、可发言用户名单等信息。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// 调用本接口的用户或机器人必须要在对应的群组内。 /// 接口ID：6951292665602883586 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat/get /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-moderation%2fget @@ -22,7 +26,10 @@ namespace FeishuNetSdk.Im; public record GetImV1ChatsByChatIdModerationResponseDto { /// - /// 群发言模式（all_members/only_owner/moderator_list，其中 moderator_list 表示部分用户可发言的模式） + /// 群发言模式，可能值有： + /// - all_members：所有群成员可发言 + /// - only_owner：仅群主或管理员可发言 + /// - moderator_list：指定群成员可发言 /// 必填：否 /// 示例值：moderator_list /// @@ -46,14 +53,14 @@ public record GetImV1ChatsByChatIdModerationResponseDto public bool? HasMore { get; set; } /// - /// 可发言用户列表 + /// 可发言用户列表，当群发言模式为 `moderator_list` 时，该参数有返回值。 /// 必填：否 /// [JsonPropertyName("items")] public ListModerator[]? Items { get; set; } /// - /// 可发言用户列表 + /// 可发言用户列表，当群发言模式为 `moderator_list` 时，该参数有返回值。 /// public record ListModerator { @@ -66,7 +73,7 @@ public record ListModerator public string? UserIdType { get; set; } /// - /// 可发言用户 ID + /// 可发言用户 ID，ID 类型与查询参数 user_id_type 取值一致。 /// 必填：否 /// 示例值：4d7a3c6g /// @@ -74,7 +81,7 @@ public record ListModerator public string? UserId { get; set; } /// - /// 租户Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识 + /// 租户 Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识。 /// 必填：否 /// 示例值：2ca1d211f64f6438 /// diff --git a/src/Im/GetImV1ChatsByChatIdResponseDto.cs b/src/Im/GetImV1ChatsByChatIdResponseDto.cs index 1f6c099c..55da2f2e 100644 --- a/src/Im/GetImV1ChatsByChatIdResponseDto.cs +++ b/src/Im/GetImV1ChatsByChatIdResponseDto.cs @@ -14,7 +14,12 @@ namespace FeishuNetSdk.Im; /// /// 获取群信息 响应体 -/// 获取群名称、群描述、群头像、群主 ID 等群基本信息。 +/// 获取指定群的基本信息，包括群名称、群描述、群头像、群主 ID 以及群权限配置等。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// - 调用接口的机器人或者用户需要在群组内，才可以获取完整信息，否则只返回群名称、群头像、成员数量以及群状态信息。 +/// - 获取内部群信息时，调用接口的机器人或者用户需要与群组在同一租户下。 /// 接口ID：6946222931479478273 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat/get-2 /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat%2fget @@ -83,7 +88,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames } /// - /// 群成员添加权限 + /// 谁可以添加群成员，群成员包括用户或机器人 /// **可选值有**： /// - `only_owner`：仅群主和管理员 /// - `all_members`：所有成员 @@ -95,7 +100,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public string? AddMemberPermission { get; set; } /// - /// 群分享权限 + /// 是否允许分享群 /// **可选值有**： /// - `allowed`：允许 /// - `not_allowed`：不允许 @@ -107,7 +112,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public string? ShareCardPermission { get; set; } /// - /// at 所有人权限 + /// 谁可以 at 所有人 /// **可选值有**： /// - `only_owner`：仅群主和管理员 /// - `all_members`：所有成员 @@ -119,7 +124,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public string? AtAllPermission { get; set; } /// - /// 群编辑权限 + /// 谁可以编辑群 /// **可选值有**： /// - `only_owner`：仅群主和管理员 /// - `all_members`：所有成员 @@ -130,7 +135,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public string? EditPermission { get; set; } /// - /// 群主 ID 对应的ID类型，与查询参数中的 ==user_id_type== 相同。取值为：`open_id`、`user_id`、`union_id`其中之一 + /// 群主的用户 ID 类型，与查询参数中的 user_id_type 相同。取值为 `open_id`、`user_id`、`union_id` 其中之一，不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。 /// **注意**： /// - 当群主是机器人时不返回该字段 /// - 单聊不返回该字段 @@ -141,7 +146,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public string? OwnerIdType { get; set; } /// - /// 群主 ID，ID值与查询参数中的 ==user_id_type== 对应；不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction) + /// 群主的用户 ID，ID 类型与查询参数中的 user_id_type 对应。 /// **注意**： /// - 当群主是机器人时不返回该字段 /// - 单聊不返回该字段 @@ -152,14 +157,14 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public string? OwnerId { get; set; } /// - /// 用户管理员列表 + /// 用户管理员 ID 列表，ID 类型与查询参数 user_id_type 一致。 /// 必填：否 /// [JsonPropertyName("user_manager_id_list")] public string[]? UserManagerIdList { get; set; } /// - /// 机器人管理员列表 + /// 机器人管理员 ID 列表，ID 类型为应用的 App ID。 /// 必填：否 /// [JsonPropertyName("bot_manager_id_list")] @@ -170,7 +175,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames /// **可选值有**： /// - `chat`：会话消息 /// - ` thread`：话题消息 - /// **注意**：仅对话群返回该字段 + /// **注意**：仅普通对话群组返回该字段，话题群和单聊不返回值。 /// 必填：否 /// 示例值：chat /// @@ -202,7 +207,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public string? ChatType { get; set; } /// - /// 群标签，如有多个，则按照下列顺序返回第一个 + /// 群标签。如有多个，则按照下列顺序返回第一个标签。 /// **可选值有**： /// - `inner`：内部群 /// - `tenant`：公司群 @@ -218,7 +223,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public string? ChatTag { get; set; } /// - /// 入群消息可见性 + /// 入群提示消息的可见性 /// **可选值有**： /// - `only_owner`：仅群主和管理员可见 /// - `all_members`：所有成员可见 @@ -231,7 +236,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public string? JoinMessageVisibility { get; set; } /// - /// 出群消息可见性 + /// 出群提示消息的可见性 /// **可选值有**： /// - `only_owner`：仅群主和管理员可见 /// - `all_members`：所有成员可见 @@ -244,7 +249,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public string? LeaveMessageVisibility { get; set; } /// - /// 加群审批 + /// 加群是否需要审批 /// **可选值有**： /// - `no_approval_required`：无需审批 /// - `approval_required`：需要审批 @@ -256,7 +261,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public string? MembershipApproval { get; set; } /// - /// 发言权限 + /// 群发言权限 /// **可选值有**： /// - `only_owner`：仅群主和管理员 /// - `all_members`：所有成员 @@ -276,7 +281,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public bool? External { get; set; } /// - /// 租户Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识 + /// 租户 Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识。 /// 必填：否 /// 示例值：736588c9260f175e /// @@ -284,7 +289,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public string? TenantKey { get; set; } /// - /// 群成员人数 + /// 群内用户的数量 /// 必填：否 /// 示例值：1 /// @@ -292,7 +297,7 @@ public record GetImV1ChatsByChatIdResponseDtoI18nNames public string? UserCount { get; set; } /// - /// 群机器人数 + /// 群内机器人的数量 /// 必填：否 /// 示例值：3 /// diff --git a/src/Im/GetImV1ChatsResponseDto.cs b/src/Im/GetImV1ChatsResponseDto.cs index b17cc855..6cc25090 100644 --- a/src/Im/GetImV1ChatsResponseDto.cs +++ b/src/Im/GetImV1ChatsResponseDto.cs @@ -15,6 +15,12 @@ namespace FeishuNetSdk.Im; /// /// 获取用户或机器人所在的群列表 响应体 /// 获取 [access_token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) 所代表的用户或者机器人所在的群列表。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 注意事项 +/// - 请注意区分本接口和[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)的请求 URL。 +/// - 获取到的群列表中，不包含单聊（群模式为 `p2p`）。 +/// - 查询参数 **user_id_type** 用于控制响应体中 owner_id 的类型，如果是获取机器人所在群列表该值可以不填。 /// 接口ID：6946222931479412737 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat/list /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat%2flist @@ -22,19 +28,19 @@ namespace FeishuNetSdk.Im; public record GetImV1ChatsResponseDto { /// - /// chat 列表 + /// 群组列表 /// 必填：否 /// [JsonPropertyName("items")] public ListChat[]? Items { get; set; } /// - /// chat 列表 + /// 群组列表 /// public record ListChat { /// - /// 群组 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群组 ID，调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，根据群组 ID 可获取群详细信息。 /// 必填：否 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// @@ -66,7 +72,8 @@ public record ListChat public string? Description { get; set; } /// - /// 群主 ID + /// 群主的用户 ID，ID 类型与 owner_id_type 相对应。 + /// **注意**：群主为机器人时无返回值。 /// 必填：否 /// 示例值：4d7a3c6g /// @@ -74,7 +81,8 @@ public record ListChat public string? OwnerId { get; set; } /// - /// 群主 ID 类型 + /// 群主的用户 ID 类型，类型分为 user_id、open_id、union_id。各类型 ID 介绍参考[用户身份概述](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。 + /// **注意**：群主为机器人时无返回值。 /// 必填：否 /// 示例值：user_id /// @@ -90,7 +98,7 @@ public record ListChat public bool? External { get; set; } /// - /// 租户Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识 + /// 租户 Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识。 /// 必填：否 /// 示例值：736588c9260f175e /// diff --git a/src/Im/GetImV1ChatsSearchResponseDto.cs b/src/Im/GetImV1ChatsSearchResponseDto.cs index 608f0f65..483061f4 100644 --- a/src/Im/GetImV1ChatsSearchResponseDto.cs +++ b/src/Im/GetImV1ChatsSearchResponseDto.cs @@ -14,8 +14,9 @@ namespace FeishuNetSdk.Im; /// /// 搜索对用户或机器人可见的群列表 响应体 -/// 根据使用的 access_token 搜索对用户或机器人可见的群列表，包括：用户或机器人所在的群、对用户或机器人公开的群。 -/// 搜索可获得的群信息包括：群ID（chat_id）、群名称、群描述等。 +/// 获取当前身份（用户或机器人）可见的群列表，包括当前身份所在的群、对当前身份公开的群。支持关键词搜索、分页搜索。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 /// 接口ID：6946222929790648348 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat/search /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat%2fsearch @@ -23,19 +24,19 @@ namespace FeishuNetSdk.Im; public record GetImV1ChatsSearchResponseDto { /// - /// chat 列表 + /// 群组列表 /// 必填：否 /// [JsonPropertyName("items")] public ListChat[]? Items { get; set; } /// - /// chat 列表 + /// 群组列表 /// public record ListChat { /// - /// 群组 ID，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群组 ID，调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，根据群组 ID 可获取群详细信息。 /// 必填：否 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// @@ -67,7 +68,8 @@ public record ListChat public string? Description { get; set; } /// - /// 群主 ID + /// 群主的用户 ID，ID 类型与 owner_id_type 相对应。 + /// **注意**：群主为机器人时无返回值。 /// 必填：否 /// 示例值：4d7a3c6g /// @@ -75,7 +77,8 @@ public record ListChat public string? OwnerId { get; set; } /// - /// 群主 ID 类型 + /// 群主的用户 ID 类型，类型分为 user_id、open_id、union_id。各类型 ID 介绍参考[用户身份概述](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。 + /// **注意**：群主为机器人时无返回值。 /// 必填：否 /// 示例值：user_id /// @@ -91,7 +94,7 @@ public record ListChat public bool? External { get; set; } /// - /// 租户Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识 + /// 租户 Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识。 /// 必填：否 /// 示例值：736588c9260f175e /// diff --git a/src/Im/PatchImV1ChatsByChatIdAnnouncementBodyDto.cs b/src/Im/PatchImV1ChatsByChatIdAnnouncementBodyDto.cs index cc0d7aba..a60e19ac 100644 --- a/src/Im/PatchImV1ChatsByChatIdAnnouncementBodyDto.cs +++ b/src/Im/PatchImV1ChatsByChatIdAnnouncementBodyDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 更新群公告信息 请求体 -/// 更新会话中的群公告信息，更新公告信息的格式和更新[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同，不支持新版文档格式。 +/// 更新指定群组中的群公告信息。更新的公告内容格式和更新[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)的格式相同，不支持新版云文档格式。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的用户或者机器人必须在对应的群组内，且需要拥有群公告文档的阅读权限。 +/// ## 使用限制 +/// - 如果群组配置了 **仅群主和群管理员可编辑群信息**，则仅有群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以更新群公告信息。 +/// - 如果群组没有配置 **仅群主和群管理员可编辑群信息**，则所有群成员可以更新群公告信息。 +/// - 操作内部群时，操作者和被操作的群组必须在同一租户下。 /// 接口ID：6946222931479511041 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-announcement/patch /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-announcement%2fpatch @@ -22,8 +29,8 @@ namespace FeishuNetSdk.Im; public record PatchImV1ChatsByChatIdAnnouncementBodyDto { /// - /// 文档当前版本号 int64 类型，[获取群公告信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/get)接口会返回 - /// **注意**：传入的版本号和最新版本号的差距不能超过100 + /// 文档当前版本号 int64 类型，可调用[获取群公告信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/get)接口，从返回结果中获取。 + /// **注意**：传入的版本号和最新版本号的差距不能超过 100。 /// 必填：是 /// 示例值：12 /// @@ -31,10 +38,9 @@ public record PatchImV1ChatsByChatIdAnnouncementBodyDto public string Revision { get; set; } = string.Empty; /// - /// 修改文档请求的序列化字段 - /// 更新公告信息的格式和更新[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同 + /// 公告内容，调用接口时该参数必须传入值。公告内容的格式与更新旧版文档内容的格式相同，具体数据结构参考[编辑旧版文档内容](https://open.feishu.cn/document/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)。 /// 必填：否 - /// 示例值：{\"requestType\":\"InsertBlocksRequestType\",\"insertBlocksRequest\":{\"payload\":\"{\\\"blocks\\\":[{\\\"type\\\":\\\"paragraph\\\",\\\"paragraph\\\":{\\\"elements\\\":[{\\\"type\\\":\\\"textRun\\\",\\\"textRun\\\":{\\\"text\\\":\\\"ylyyyyyDocsAPISampleContent\\\",\\\"style\\\":{}}}],\\\"style\\\":{}}}]}\",\"location\":{\"zoneId\":\"0\",\"index\":0,\"endOfZone\":true}}} + /// 示例值：{\"requestType\":\"InsertBlocksRequestType\",\"insertBlocksRequest\":{\"payload\":\"{\\\"blocks\\\":[{\\\"type\\\":\\\"paragraph\\\",\\\"paragraph\\\":{\\\"elements\\\":[{\\\"type\\\":\\\"textRun\\\",\\\"textRun\\\":{\\\"text\\\":\\\"ylyyyyyDocs API Sample Content\\\",\\\"style\\\":{}}}],\\\"style\\\":{}}}]}\",\"location\":{\"zoneId\":\"0\",\"index\":0, \"endOfZone\": true}}} /// [JsonPropertyName("requests")] public string[]? Requests { get; set; } diff --git a/src/Im/PatchImV1ChatsByChatIdMenuItemsByMenuItemIdBodyDto.cs b/src/Im/PatchImV1ChatsByChatIdMenuItemsByMenuItemIdBodyDto.cs index 9d8dff05..92109658 100644 --- a/src/Im/PatchImV1ChatsByChatIdMenuItemsByMenuItemIdBodyDto.cs +++ b/src/Im/PatchImV1ChatsByChatIdMenuItemsByMenuItemIdBodyDto.cs @@ -14,7 +14,13 @@ namespace FeishuNetSdk.Im; /// /// 修改群菜单元信息 请求体 -/// 修改某个一级菜单或者二级菜单的元信息，包括群菜单的图标、名称、国际化名称和跳转链接。 +/// 修改指定群组内的某个一级菜单或者二级菜单的元信息，包括图标、名称、国际化名称和跳转链接。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的机器人必须在对应的群组内。 +/// ## 使用限制 +/// - 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 +/// - 本接口不支持在一级菜单上添加或删除二级菜单。 /// 接口ID：7174746098262704132 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-menu_tree/patch /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-menu_item%2fpatch @@ -22,7 +28,7 @@ namespace FeishuNetSdk.Im; public record PatchImV1ChatsByChatIdMenuItemsByMenuItemIdBodyDto { /// - /// 要修改的字段 + /// 要修改的元信息 /// 必填：是 /// 示例值：["ICON"] /// @@ -30,21 +36,20 @@ public record PatchImV1ChatsByChatIdMenuItemsByMenuItemIdBodyDto public string[] UpdateFields { get; set; } = Array.Empty(); /// - /// 元信息 + /// 群菜单的元信息 /// 必填：是 /// [JsonPropertyName("chat_menu_item")] public PatchImV1ChatsByChatIdMenuItemsByMenuItemIdBodyDtoChatMenuItem ChatMenuItem { get; set; } = new(); /// - /// 元信息 + /// 群菜单的元信息 /// public record PatchImV1ChatsByChatIdMenuItemsByMenuItemIdBodyDtoChatMenuItem { /// /// 菜单类型 - /// **注意** - /// - 如果一级菜单有二级菜单时，则此一级菜单的值必须为NONE。 + /// **注意**：如果一级菜单有二级菜单，则此一级菜单的值必须为 `NONE`。 /// 必填：否 /// 示例值：NONE /// 可选值： @@ -68,7 +73,7 @@ public record PatchImV1ChatsByChatIdMenuItemsByMenuItemIdBodyDtoChatMenuItem public record ChatMenuItemRedirectLink { /// - /// 公用跳转链接，必须以http开头。 + /// 公用跳转链接，必须以 http/https 开头。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -76,7 +81,7 @@ public record ChatMenuItemRedirectLink public string? CommonUrl { get; set; } /// - /// IOS端跳转链接，当该字段不设置时，IOS端会使用common_url。必须以http开头。 + /// iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 `common_url` 值。必须以 http/https 开头。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -84,7 +89,7 @@ public record ChatMenuItemRedirectLink public string? IosUrl { get; set; } /// - /// Android端跳转链接，当该字段不设置时，Android端会使用common_url。必须以http开头。 + /// Android 端跳转链接，当该字段不设置时，Android 端默认使用 `common_url` 值。必须以 http/https 开头。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -92,7 +97,8 @@ public record ChatMenuItemRedirectLink public string? AndroidUrl { get; set; } /// - /// PC端跳转链接，当该字段不设置时，PC端会使用common_url。必须以http开头。在PC端点击群菜单后，如果需要url对应的页面在飞书侧边栏展开，可以在url前加上https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=，比如https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/ + /// PC 端跳转链接，当该字段不设置时，PC 端默认使用 `common_url` 值。必须以 http/https 开头。 + /// **使用说明**：在 PC 端点击群菜单后，如果需要 url 对应的页面在飞书侧边栏展开，可以在 url 前加上 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=`，例如 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/` /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -100,7 +106,7 @@ public record ChatMenuItemRedirectLink public string? PcUrl { get; set; } /// - /// Web端跳转链接，当该字段不设置时，Web端会使用common_url。必须以http开头。 + /// Web 端跳转链接，当该字段不设置时，Web 端默认使用 `common_url` 值。必须以 http/https 开头。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -109,9 +115,8 @@ public record ChatMenuItemRedirectLink } /// - /// 图片的key值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key - /// **注意** - /// - 如果一级菜单有二级菜单，则此一级菜单不能有图标。 + /// 图标的 key 值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传 message 类型图片获取 image_key，并传入该值。 + /// **注意**：如果一级菜单有二级菜单，则此一级菜单不能设置图标。 /// 必填：否 /// 示例值：img_v2_b0fbe905-7988-4282-b882-82edd010336j /// @@ -119,9 +124,8 @@ public record ChatMenuItemRedirectLink public string? ImageKey { get; set; } /// - /// 菜单名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单名称 + /// **注意**：一级、二级菜单名称字符数要在 1 ~ 120 范围内。 /// 必填：否 /// 示例值：群聊 /// @@ -129,18 +133,16 @@ public record ChatMenuItemRedirectLink public string? Name { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 + /// **注意**：一级、二级菜单名称字符数要在 1 ~ 120 范围内。 /// 必填：否 /// [JsonPropertyName("i18n_names")] public PatchImV1ChatsByChatIdMenuItemsByMenuItemIdBodyDtoChatMenuItemI18nNames? I18nNames { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 + /// **注意**：一级、二级菜单名称字符数要在 1 ~ 120 范围内。 /// public record PatchImV1ChatsByChatIdMenuItemsByMenuItemIdBodyDtoChatMenuItemI18nNames { @@ -155,7 +157,7 @@ public record PatchImV1ChatsByChatIdMenuItemsByMenuItemIdBodyDtoChatMenuItemI18n /// /// 英文名 /// 必填：否 - /// 示例值：Signup + /// 示例值：Sign up /// [JsonPropertyName("en_us")] public string? EnUs { get; set; } diff --git a/src/Im/PatchImV1ChatsByChatIdMenuItemsByMenuItemIdResponseDto.cs b/src/Im/PatchImV1ChatsByChatIdMenuItemsByMenuItemIdResponseDto.cs index d6b92de6..108b94fb 100644 --- a/src/Im/PatchImV1ChatsByChatIdMenuItemsByMenuItemIdResponseDto.cs +++ b/src/Im/PatchImV1ChatsByChatIdMenuItemsByMenuItemIdResponseDto.cs @@ -14,7 +14,13 @@ namespace FeishuNetSdk.Im; /// /// 修改群菜单元信息 响应体 -/// 修改某个一级菜单或者二级菜单的元信息，包括群菜单的图标、名称、国际化名称和跳转链接。 +/// 修改指定群组内的某个一级菜单或者二级菜单的元信息，包括图标、名称、国际化名称和跳转链接。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的机器人必须在对应的群组内。 +/// ## 使用限制 +/// - 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 +/// - 本接口不支持在一级菜单上添加或删除二级菜单。 /// 接口ID：7174746098262704132 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-menu_tree/patch /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-menu_item%2fpatch @@ -35,12 +41,10 @@ public record PatchImV1ChatsByChatIdMenuItemsByMenuItemIdResponseDtoChatMenuItem { /// /// 菜单类型 - /// **注意** - /// - 如果一级菜单有二级菜单时，则此一级菜单的值必须为NONE。 /// 必填：否 /// 示例值：NONE /// 可选值： - /// NONE：无类型 + /// NONE：无类型，当一级菜单下有二级菜单时，类型取值为 NONE。 /// REDIRECT_LINK：跳转链接类型 /// /// @@ -60,7 +64,7 @@ public record PatchImV1ChatsByChatIdMenuItemsByMenuItemIdResponseDtoChatMenuItem public record ChatMenuItemRedirectLink { /// - /// 公用跳转链接，必须以http开头。 + /// 公用跳转链接 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -68,7 +72,7 @@ public record ChatMenuItemRedirectLink public string? CommonUrl { get; set; } /// - /// IOS端跳转链接，当该字段不设置时，IOS端会使用common_url。必须以http开头。 + /// iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -76,7 +80,7 @@ public record ChatMenuItemRedirectLink public string? IosUrl { get; set; } /// - /// Android端跳转链接，当该字段不设置时，Android端会使用common_url。必须以http开头。 + /// Android 端跳转链接，当该字段不设置时，Android 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -84,7 +88,8 @@ public record ChatMenuItemRedirectLink public string? AndroidUrl { get; set; } /// - /// PC端跳转链接，当该字段不设置时，PC端会使用common_url。必须以http开头。在PC端点击群菜单后，如果需要url对应的页面在飞书侧边栏展开，可以在url前加上https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=，比如https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/ + /// PC 端跳转链接，当该字段不设置时，PC 端默认使用 `common_url` 值。 + /// **说明**：以 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=` 开头的链接表示在飞书侧边栏展开。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -92,7 +97,7 @@ public record ChatMenuItemRedirectLink public string? PcUrl { get; set; } /// - /// Web端跳转链接，当该字段不设置时，Web端会使用common_url。必须以http开头。 + /// Web 端跳转链接，当该字段不设置时，Web 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -101,9 +106,8 @@ public record ChatMenuItemRedirectLink } /// - /// 图片的key值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key - /// **注意** - /// - 如果一级菜单有二级菜单，则此一级菜单不能有图标。 + /// 图标的 key 值。通过[下载图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get)接口可将图标下载到本地（只能下载由当前机器人上传的图片）。 + /// **注意**：一级菜单下存在二级菜单时不能设置图标。 /// 必填：否 /// 示例值：img_v2_b0fbe905-7988-4282-b882-82edd010336j /// @@ -111,9 +115,7 @@ public record ChatMenuItemRedirectLink public string? ImageKey { get; set; } /// - /// 菜单名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单名称 /// 必填：否 /// 示例值：群聊 /// @@ -121,18 +123,14 @@ public record ChatMenuItemRedirectLink public string? Name { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// 必填：否 /// [JsonPropertyName("i18n_names")] public PatchImV1ChatsByChatIdMenuItemsByMenuItemIdResponseDtoChatMenuItemI18nNames? I18nNames { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// public record PatchImV1ChatsByChatIdMenuItemsByMenuItemIdResponseDtoChatMenuItemI18nNames { @@ -147,7 +145,7 @@ public record PatchImV1ChatsByChatIdMenuItemsByMenuItemIdResponseDtoChatMenuItem /// /// 英文名 /// 必填：否 - /// 示例值：Signup + /// 示例值：Sign up /// [JsonPropertyName("en_us")] public string? EnUs { get; set; } diff --git a/src/Im/PostImV1ChatsBodyDto.cs b/src/Im/PostImV1ChatsBodyDto.cs index 4383be8f..d668bd75 100644 --- a/src/Im/PostImV1ChatsBodyDto.cs +++ b/src/Im/PostImV1ChatsBodyDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 创建群 请求体 -/// 创建群并设置群头像、群名、群描述等。 +/// 创建群聊，创建时支持设置群头像、群名称、群主以及群类型等配置，同时支持邀请群成员、群机器人入群。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// 商店应用无法使用用户的 user_id，因此使用商店应用调用本接口时用户 ID 类型请选择 open_id 或者 union_id。 +/// ## 注意事项 +/// - 如果你需要在已创建的群聊内邀请用户或机器人入群，可调用[将用户或机器人拉入群聊](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create)接口。 +/// - 调用 API 只能创建普通消息群，消息形式可以选择对话消息或者话题消息。如果你需要直接创建话题群，请通过飞书客户端创建群组，创建时群模式选择 **话题**。 /// 接口ID：6946222931479379969 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat%2fcreate @@ -22,7 +29,9 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsBodyDto { /// - /// 群头像对应的 Image Key，可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取（注意：上传图片的 ==image_type== 需要指定为 ==avatar==） + /// 群头像对应的 Image Key + /// - 可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取（注意：上传图片的 ==image_type== 需要指定为 ==avatar==） + /// - 不传值则使用系统默认头像 /// 必填：否 /// 示例值：default-avatar_44ae0ca3-e140-494b-956f-78091e348435 /// @@ -32,8 +41,9 @@ public record PostImV1ChatsBodyDto /// /// 群名称 /// **注意：** - /// - 公开群名称的长度不得少于2个字符 - /// - 私有群若未填写群名称，群名称默认设置为 ”`(无主题)`“ + /// - 建议群名称不超过 60 字符 + /// - 公开群名称的长度不得少于 2 个字符 + /// - 私有群若未填写群名称，群名称默认设置为 `(无主题)` /// 必填：否 /// 示例值：测试群名称 /// @@ -41,7 +51,8 @@ public record PostImV1ChatsBodyDto public string? Name { get; set; } /// - /// 群描述 + /// 群描述，建议不超过 100 字符 + /// **默认值**：空 /// 必填：否 /// 示例值：测试群描述 /// @@ -50,6 +61,9 @@ public record PostImV1ChatsBodyDto /// /// 群国际化名称 + /// **注意**： + /// - 建议不超过 60 字符 + /// - 不设置国际化名称，则默认展示 `name` 参数对应的名称 /// 必填：否 /// [JsonPropertyName("i18n_names")] @@ -57,6 +71,9 @@ public record PostImV1ChatsBodyDto /// /// 群国际化名称 + /// **注意**： + /// - 建议不超过 60 字符 + /// - 不设置国际化名称，则默认展示 `name` 参数对应的名称 /// public record PostImV1ChatsBodyDtoI18nNames { @@ -86,7 +103,7 @@ public record PostImV1ChatsBodyDtoI18nNames } /// - /// 创建群时指定的群主，不填时指定建群的机器人为群主。群主 ID值应与查询参数中的 ==user_id_type== 对应；推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// 创建群时指定的群主，不填时指定建群的机器人为群主。群主 ID 类型在查询参数 ==user_id_type== 中指定；推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) /// 必填：否 /// 示例值：ou_7d8a6e6df7621556ce0d21922b676706ccs /// @@ -94,10 +111,10 @@ public record PostImV1ChatsBodyDtoI18nNames public string? OwnerId { get; set; } /// - /// 创建群时邀请的群成员，ID 类型在查询参数 ==user_id_type== 中指定；推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// 创建群时邀请的群成员，不填则不邀请成员。ID 类型在查询参数 ==user_id_type== 中指定；推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) /// **注意**： /// - 最多同时邀请 50 个用户 - /// - 为便于在客户端查看效果，建议调试接口时加入开发者自身ID + /// - 为便于在客户端查看效果，建议调试接口时加入开发者自身 ID /// 必填：否 /// 示例值：["ou_7d8a6e6df7621556ce0d21922b676706ccs"] /// 最大长度：50 @@ -106,11 +123,11 @@ public record PostImV1ChatsBodyDtoI18nNames public string[]? UserIdList { get; set; } /// - /// 创建群时邀请的群机器人；可参考[如何获取应用的 App ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id)来获取应用的App ID + /// 创建群时邀请的群机器人，不填则不邀请机器人。可参考[如何获取应用的 App ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id)来获取应用的 App ID /// **注意：** /// - 操作此接口的机器人会自动入群，无需重复填写 - /// - 拉机器人入群请使用`app_id` - /// - 最多同时邀请5个机器人，且邀请后群组中机器人数量不能超过 15 个 + /// - 拉机器人入群请使用 `app_id` + /// - 最多同时邀请 5 个机器人，且邀请后群组中机器人数量不能超过 15 个 /// 必填：否 /// 示例值：["cli_a10fbf7e94b8d01d"] /// 最大长度：5 @@ -155,7 +172,7 @@ public record PostImV1ChatsBodyDtoI18nNames public string? ChatType { get; set; } /// - /// 入群消息可见性 + /// 成员入群提示消息的可见性 /// **可选值有**： /// - `only_owner`：仅群主和管理员可见 /// - `all_members`：所有成员可见 @@ -168,7 +185,7 @@ public record PostImV1ChatsBodyDtoI18nNames public string? JoinMessageVisibility { get; set; } /// - /// 退群消息可见性 + /// 成员退群提示消息的可见性 /// **可选值有**： /// - `only_owner`：仅群主和管理员可见 /// - `all_members`：所有成员可见 @@ -181,7 +198,7 @@ public record PostImV1ChatsBodyDtoI18nNames public string? LeaveMessageVisibility { get; set; } /// - /// 加群审批 + /// 加群是否需要审批 /// **可选值有**： /// - `no_approval_required`：无需审批 /// - `approval_required`：需要审批 @@ -194,6 +211,7 @@ public record PostImV1ChatsBodyDtoI18nNames /// /// 保密模式设置 + /// **注意**：保密模式适用于企业旗舰版。适用版本与功能介绍参见[会话保密模式](https://www.feishu.cn/hc/zh-CN/articles/418691056559)。 /// 必填：否 /// [JsonPropertyName("restricted_mode_setting")] @@ -201,14 +219,16 @@ public record PostImV1ChatsBodyDtoI18nNames /// /// 保密模式设置 + /// **注意**：保密模式适用于企业旗舰版。适用版本与功能介绍参见[会话保密模式](https://www.feishu.cn/hc/zh-CN/articles/418691056559)。 /// public record PostImV1ChatsBodyDtoRestrictedModeSetting { /// /// 保密模式是否开启 - /// **注意**： - /// - status为true时，screenshot_has_permission_setting、download_has_permission_setting、message_has_permission_setting不能全为all_members。 - /// - status为false时，screenshot_has_permission_setting、download_has_permission_setting、message_has_permission_setting不能存在not_anyone。 + /// **可选值有**： + /// - true：开启。设置为 ture 时，`screenshot_has_permission_setting`、`download_has_permission_setting`、`message_has_permission_setting` 不能全为 `all_members`。 + /// - false：不开启。设置为 false 时，`screenshot_has_permission_setting`、`download_has_permission_setting`、`message_has_permission_setting` 不能存在 `not_anyone`。 + /// **默认值**：false /// 必填：否 /// 示例值：false /// @@ -217,6 +237,7 @@ public record PostImV1ChatsBodyDtoRestrictedModeSetting /// /// 允许截屏录屏 + /// **默认值**：all_members /// 必填：否 /// 示例值：all_members /// 可选值： @@ -229,6 +250,7 @@ public record PostImV1ChatsBodyDtoRestrictedModeSetting /// /// 允许下载消息中图片、视频和文件 + /// **默认值**：all_members /// 必填：否 /// 示例值：all_members /// 可选值： @@ -241,6 +263,7 @@ public record PostImV1ChatsBodyDtoRestrictedModeSetting /// /// 允许复制和转发消息 + /// **默认值**：all_members /// 必填：否 /// 示例值：all_members /// 可选值： @@ -254,6 +277,7 @@ public record PostImV1ChatsBodyDtoRestrictedModeSetting /// /// 谁可以加急 + /// **默认值**：all_members /// 必填：否 /// 示例值：all_members /// 可选值： @@ -266,6 +290,7 @@ public record PostImV1ChatsBodyDtoRestrictedModeSetting /// /// 谁可以发起视频会议 + /// **默认值**：all_members /// 必填：否 /// 示例值：all_members /// 可选值： @@ -278,6 +303,7 @@ public record PostImV1ChatsBodyDtoRestrictedModeSetting /// /// 谁可以编辑群信息 + /// **默认值**：all_members /// 必填：否 /// 示例值：all_members /// 可选值： @@ -290,6 +316,7 @@ public record PostImV1ChatsBodyDtoRestrictedModeSetting /// /// 隐藏群成员人数设置 + /// **默认值**：all_members /// 必填：否 /// 示例值：all_members /// 可选值： diff --git a/src/Im/PostImV1ChatsByChatIdChatTabsBodyDto.cs b/src/Im/PostImV1ChatsByChatIdChatTabsBodyDto.cs index b3f581e9..00401c71 100644 --- a/src/Im/PostImV1ChatsByChatIdChatTabsBodyDto.cs +++ b/src/Im/PostImV1ChatsByChatIdChatTabsBodyDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 添加会话标签页 请求体 -/// 添加自定义会话标签页。 +/// 在指定会话内添加自定义会话标签页，仅支持添加文档类型（doc）或 URL （url）类型的标签页。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的用户或者机器人必须在对应的会话内。 +/// ## 使用限制 +/// - 调用该接口仅支持添加 doc、url 类型的标签页，即 tab_type 参数传值时，只能传入 doc 或 url，传入其他枚举值将会报错。如果你需要添加其他类型的会话标签页，需要在飞书客户端内操作，详情参见[会话内标签页](https://www.feishu.cn/hc/zh-CN/articles/536850681075)。 +/// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以添加会话标签页。 +/// - 操作内部群时，操作者须与群组在同一租户下。 /// 接口ID：7111246605500563457 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-tab/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-tab%2fcreate @@ -23,7 +30,7 @@ public record PostImV1ChatsByChatIdChatTabsBodyDto { /// /// 会话标签页 - /// **注意**：一个群内最多只允许添加20个自定义会话标签页 + /// **注意**：一个会话内最多只允许添加 20 个自定义会话标签页 /// 必填：是 /// [JsonPropertyName("chat_tabs")] @@ -31,13 +38,13 @@ public record PostImV1ChatsByChatIdChatTabsBodyDto /// /// 会话标签页 - /// **注意**：一个群内最多只允许添加20个自定义会话标签页 + /// **注意**：一个会话内最多只允许添加 20 个自定义会话标签页 /// public record ChatTab { /// - /// Tab名称 - /// **注意**：会话标签页的名称不能超过30个字符（最多 10 个汉字） + /// 会话标签页名称 + /// **注意**：会话标签页的名称不能超过 30 个字符（最多 10 个汉字） /// 必填：否 /// 示例值：文档 /// @@ -45,7 +52,8 @@ public record ChatTab public string? TabName { get; set; } /// - /// Tab类型 + /// 会话标签页类型 + /// **注意**：只支持添加 doc、url 类型的标签页，其他字段为只读字段 /// 必填：是 /// 示例值：doc /// 可选值： @@ -57,7 +65,7 @@ public record ChatTab /// chat_announcement：群公告 /// url：URL /// file：文件 - /// files_resources：合并类型, 包含文件、Doc文档、URL链接 + /// files_resources：合并类型，包含文件、Doc 文档、URL 链接 /// images_videos：合并类型，包含图片、视频 /// /// @@ -65,19 +73,20 @@ public record ChatTab public string TabType { get; set; } = string.Empty; /// - /// Tab内容 + /// 会话标签页的内容 /// 必填：否 /// [JsonPropertyName("tab_content")] public ChatTabContent? TabContent { get; set; } /// - /// Tab内容 + /// 会话标签页的内容 /// public record ChatTabContent { /// - /// URL类型 + /// URL 地址，在 tab_type 取值为 url 时生效 + /// **注意**：必须以 http 或 https 开头 /// 必填：否 /// 示例值：https://www.feishu.cn /// @@ -85,7 +94,10 @@ public record ChatTabContent public string? Url { get; set; } /// - /// Doc链接 + /// 云文档链接，在 tab_type 取值为 doc 时生效 + /// **注意**： + /// - 必须以 http 或 https 开头 + /// - 当前操作者必须有云文档的协作者权限 /// 必填：否 /// 示例值：https://example.feishu.cn/wiki/wikcnPIcqWjJQwkwDzrB9t40123xz /// @@ -93,7 +105,7 @@ public record ChatTabContent public string? Doc { get; set; } /// - /// 会议纪要 + /// 会议纪要，因不支持添加 meeting_minute 类型的会话标签页，该字段为只读字段，无需传值。 /// 必填：否 /// 示例值：https://example.feishu.cn/docs/doccnvIXbV22i6hSD3utar4123dx /// @@ -102,19 +114,21 @@ public record ChatTabContent } /// - /// Tab的配置 + /// 会话标签页的配置 + /// **注意**：仅当 tab_type 取值为 url 时，该参数生效 /// 必填：否 /// [JsonPropertyName("tab_config")] public ChatTabConfig? TabConfig { get; set; } /// - /// Tab的配置 + /// 会话标签页的配置 + /// **注意**：仅当 tab_type 取值为 url 时，该参数生效 /// public record ChatTabConfig { /// - /// 群Tab图标 + /// 会话标签页的图标。需要先调用[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口，图片类型设置为 message 上传图片，然后获取 `image_key` 后传入当前参数。 /// 必填：否 /// 示例值：img_v2_b99741-7628-4abd-aad0-b881e4db83ig /// @@ -122,7 +136,7 @@ public record ChatTabConfig public string? IconKey { get; set; } /// - /// 群tab是否App内嵌打开 + /// 会话标签页是否在 App 内嵌打开 /// 必填：否 /// 示例值：false /// diff --git a/src/Im/PostImV1ChatsByChatIdChatTabsResponseDto.cs b/src/Im/PostImV1ChatsByChatIdChatTabsResponseDto.cs index f7898f09..341e5049 100644 --- a/src/Im/PostImV1ChatsByChatIdChatTabsResponseDto.cs +++ b/src/Im/PostImV1ChatsByChatIdChatTabsResponseDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 添加会话标签页 响应体 -/// 添加自定义会话标签页。 +/// 在指定会话内添加自定义会话标签页，仅支持添加文档类型（doc）或 URL （url）类型的标签页。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的用户或者机器人必须在对应的会话内。 +/// ## 使用限制 +/// - 调用该接口仅支持添加 doc、url 类型的标签页，即 tab_type 参数传值时，只能传入 doc 或 url，传入其他枚举值将会报错。如果你需要添加其他类型的会话标签页，需要在飞书客户端内操作，详情参见[会话内标签页](https://www.feishu.cn/hc/zh-CN/articles/536850681075)。 +/// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以添加会话标签页。 +/// - 操作内部群时，操作者须与群组在同一租户下。 /// 接口ID：7111246605500563457 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-tab/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-tab%2fcreate @@ -34,7 +41,7 @@ public record PostImV1ChatsByChatIdChatTabsResponseDto public record ChatTab { /// - /// Tab ID + /// 会话标签页 ID，建议你保存该 ID，后续更新、删除、排序标签页时需要基于该 ID 进行操作。 /// 必填：否 /// 示例值：7101214603622940671 /// @@ -42,8 +49,7 @@ public record ChatTab public string? TabId { get; set; } /// - /// Tab名称 - /// **注意**：会话标签页的名称不能超过30个字符 + /// 会话标签页名称 /// 必填：否 /// 示例值：文档 /// @@ -51,7 +57,7 @@ public record ChatTab public string? TabName { get; set; } /// - /// Tab类型 + /// 会话标签页类型 /// 必填：是 /// 示例值：doc /// 可选值： @@ -63,7 +69,7 @@ public record ChatTab /// chat_announcement：群公告 /// url：URL /// file：文件 - /// files_resources：合并类型, 包含文件、Doc文档、URL链接 + /// files_resources：合并类型，包含文件、Doc文档、URL链接 /// images_videos：合并类型，包含图片、视频 /// /// @@ -71,19 +77,19 @@ public record ChatTab public string TabType { get; set; } = string.Empty; /// - /// Tab内容 + /// 会话标签页内容 /// 必填：否 /// [JsonPropertyName("tab_content")] public ChatTabContent? TabContent { get; set; } /// - /// Tab内容 + /// 会话标签页内容 /// public record ChatTabContent { /// - /// URL类型 + /// url 类型标签页对应的 URL 地址 /// 必填：否 /// 示例值：https://www.feishu.cn /// @@ -91,7 +97,7 @@ public record ChatTabContent public string? Url { get; set; } /// - /// Doc链接 + /// 文档类型标签页对应的云文档链接 /// 必填：否 /// 示例值：https://example.feishu.cn/wiki/wikcnPIcqWjJQwkwDzrB9t40123xz /// @@ -99,7 +105,7 @@ public record ChatTabContent public string? Doc { get; set; } /// - /// 会议纪要 + /// 会议纪要类型标签页对应的会议纪要地址 /// 必填：否 /// 示例值：https://example.feishu.cn/docs/doccnvIXbV22i6hSD3utar4123dx /// @@ -108,19 +114,19 @@ public record ChatTabContent } /// - /// Tab的配置 + /// 会话标签页配置 /// 必填：否 /// [JsonPropertyName("tab_config")] public ChatTabConfig? TabConfig { get; set; } /// - /// Tab的配置 + /// 会话标签页配置 /// public record ChatTabConfig { /// - /// 群Tab图标 + /// 会话标签页图标。可调用[下载图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get)（只能下载由当前机器人上传的图片），将图标下载至本地查看 /// 必填：否 /// 示例值：img_v2_b99741-7628-4abd-aad0-b881e4db83ig /// @@ -128,7 +134,7 @@ public record ChatTabConfig public string? IconKey { get; set; } /// - /// 群tab是否App内嵌打开 + /// 会话标签页是否在 App 内嵌打开 /// 必填：否 /// 示例值：false /// diff --git a/src/Im/PostImV1ChatsByChatIdChatTabsSortTabsBodyDto.cs b/src/Im/PostImV1ChatsByChatIdChatTabsSortTabsBodyDto.cs index d3b5934a..b6a1af26 100644 --- a/src/Im/PostImV1ChatsByChatIdChatTabsSortTabsBodyDto.cs +++ b/src/Im/PostImV1ChatsByChatIdChatTabsSortTabsBodyDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 会话标签页排序 请求体 -/// 会话标签页排序。 +/// 调整指定会话内的多个会话标签页排列顺序。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的用户或者机器人必须在对应的会话内。 +/// ## 使用限制 +/// - 会话内消息类型的标签页固定为第一顺位，不参与排序，但需要注意请求时 tab_ids 必须包含消息类型标签页的 ID。 +/// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以调整会话标签页排序。 +/// - 操作内部群时，操作者须与群组在同一租户下。 /// 接口ID：7111246605500628993 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-tab/sort_tabs /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-tab%2fsort_tabs @@ -22,10 +29,13 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsByChatIdChatTabsSortTabsBodyDto { /// - /// 会话标签页ID列表，Tab ID可以在[添加会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create)与[拉取会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs)的返回值中获取 - /// **注意**：必须包含该会话中全部的Tab ID + /// 会话标签页 ID 列表，ID 可以在[添加会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create)或者[拉取会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs)接口返回值中获取。 + /// **注意**： + /// - 必须包含会话内全部标签页的 ID。 + /// - 当前参数的排序，对应会话内从左往右的排序。 + /// - 会话内消息类型的标签页固定在第一顺位。 /// 必填：否 - /// 示例值：["7101214603622940671","7101214603622940672"] + /// 示例值：["7101214603622940671", "7101214603622940672"] /// [JsonPropertyName("tab_ids")] public string[]? TabIds { get; set; } diff --git a/src/Im/PostImV1ChatsByChatIdChatTabsSortTabsResponseDto.cs b/src/Im/PostImV1ChatsByChatIdChatTabsSortTabsResponseDto.cs index 7e79ec69..140e4c92 100644 --- a/src/Im/PostImV1ChatsByChatIdChatTabsSortTabsResponseDto.cs +++ b/src/Im/PostImV1ChatsByChatIdChatTabsSortTabsResponseDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 会话标签页排序 响应体 -/// 会话标签页排序。 +/// 调整指定会话内的多个会话标签页排列顺序。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的用户或者机器人必须在对应的会话内。 +/// ## 使用限制 +/// - 会话内消息类型的标签页固定为第一顺位，不参与排序，但需要注意请求时 tab_ids 必须包含消息类型标签页的 ID。 +/// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以调整会话标签页排序。 +/// - 操作内部群时，操作者须与群组在同一租户下。 /// 接口ID：7111246605500628993 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-tab/sort_tabs /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-tab%2fsort_tabs @@ -34,7 +41,7 @@ public record PostImV1ChatsByChatIdChatTabsSortTabsResponseDto public record ChatTab { /// - /// Tab ID + /// 会话标签页 ID /// 必填：否 /// 示例值：7101214603622940671 /// @@ -42,8 +49,7 @@ public record ChatTab public string? TabId { get; set; } /// - /// Tab名称 - /// **注意**：会话标签页的名称不能超过30个字符 + /// 会话标签页名称 /// 必填：否 /// 示例值：文档 /// @@ -51,7 +57,7 @@ public record ChatTab public string? TabName { get; set; } /// - /// Tab类型 + /// 会话标签页类型 /// 必填：是 /// 示例值：doc /// 可选值： @@ -63,7 +69,7 @@ public record ChatTab /// chat_announcement：群公告 /// url：URL /// file：文件 - /// files_resources：合并类型, 包含文件、Doc文档、URL链接 + /// files_resources：合并类型，包含文件、Doc文档、URL链接 /// images_videos：合并类型，包含图片、视频 /// /// @@ -71,19 +77,19 @@ public record ChatTab public string TabType { get; set; } = string.Empty; /// - /// Tab内容 + /// 会话标签页内容 /// 必填：否 /// [JsonPropertyName("tab_content")] public ChatTabContent? TabContent { get; set; } /// - /// Tab内容 + /// 会话标签页内容 /// public record ChatTabContent { /// - /// URL类型 + /// url 类型标签页对应的 URL 地址 /// 必填：否 /// 示例值：https://www.feishu.cn /// @@ -91,7 +97,7 @@ public record ChatTabContent public string? Url { get; set; } /// - /// Doc链接 + /// 文档类型标签页对应的云文档链接 /// 必填：否 /// 示例值：https://example.feishu.cn/wiki/wikcnPIcqWjJQwkwDzrB9t40123xz /// @@ -99,7 +105,7 @@ public record ChatTabContent public string? Doc { get; set; } /// - /// 会议纪要 + /// 会议纪要类型标签页对应的会议纪要地址 /// 必填：否 /// 示例值：https://example.feishu.cn/docs/doccnvIXbV22i6hSD3utar4123dx /// @@ -108,19 +114,19 @@ public record ChatTabContent } /// - /// Tab的配置 + /// 会话标签页配置 /// 必填：否 /// [JsonPropertyName("tab_config")] public ChatTabConfig? TabConfig { get; set; } /// - /// Tab的配置 + /// 会话标签页配置 /// public record ChatTabConfig { /// - /// 群Tab图标 + /// 会话标签页图标。可调用[下载图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get)（只能下载由当前机器人上传的图片），将图标下载至本地查看 /// 必填：否 /// 示例值：img_v2_b99741-7628-4abd-aad0-b881e4db83ig /// @@ -128,7 +134,7 @@ public record ChatTabConfig public string? IconKey { get; set; } /// - /// 群tab是否App内嵌打开 + /// 会话标签页是否在 App 内嵌打开 /// 必填：否 /// 示例值：false /// diff --git a/src/Im/PostImV1ChatsByChatIdChatTabsUpdateTabsBodyDto.cs b/src/Im/PostImV1ChatsByChatIdChatTabsUpdateTabsBodyDto.cs index e9849cfe..76f6dad1 100644 --- a/src/Im/PostImV1ChatsByChatIdChatTabsUpdateTabsBodyDto.cs +++ b/src/Im/PostImV1ChatsByChatIdChatTabsUpdateTabsBodyDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 更新会话标签页 请求体 -/// 更新会话标签页。 +/// 更新指定的会话标签页信息，包括名称、类型以及内容等。仅支持更新文档类型（doc）或 URL （url）类型的标签页。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的用户或者机器人必须在对应的会话内。 +/// ## 使用限制 +/// - 调用该接口仅支持更新 doc、url 类型的标签页，即 tab_type 参数传值时，只能传入 doc 或 url，传入其他枚举值将会报错。如果你需要更新其他类型的会话标签页，需要在飞书客户端内操作，详情参见[会话内标签页](https://www.feishu.cn/hc/zh-CN/articles/536850681075)。 +/// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以更新会话标签页。 +/// - 操作内部群时，操作者须与群组在同一租户下。 /// 接口ID：7111246605500612609 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-tab/update_tabs /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-tab%2fupdate_tabs @@ -34,7 +41,7 @@ public record PostImV1ChatsByChatIdChatTabsUpdateTabsBodyDto public record ChatTab { /// - /// Tab ID + /// 会话标签页 ID，ID 可以在[添加会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create)或者[拉取会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs)接口返回值中获取。 /// 必填：否 /// 示例值：7101214603622940671 /// @@ -42,8 +49,8 @@ public record ChatTab public string? TabId { get; set; } /// - /// Tab名称 - /// **注意**：会话标签页的名称不能超过30个字符 + /// 会话标签页名称 + /// **注意**：会话标签页的名称不能超过 30 个字符（最多 10 个汉字） /// 必填：否 /// 示例值：文档 /// @@ -51,7 +58,8 @@ public record ChatTab public string? TabName { get; set; } /// - /// Tab类型 + /// 会话标签页类型 + /// **注意**：只支持更新 doc、url 类型的标签页，其他字段为只读字段 /// 必填：是 /// 示例值：doc /// 可选值： @@ -63,7 +71,7 @@ public record ChatTab /// chat_announcement：群公告 /// url：URL /// file：文件 - /// files_resources：合并类型, 包含文件、Doc文档、URL链接 + /// files_resources：合并类型，包含文件、Doc文档、URL链接 /// images_videos：合并类型，包含图片、视频 /// /// @@ -71,19 +79,20 @@ public record ChatTab public string TabType { get; set; } = string.Empty; /// - /// Tab内容 + /// 会话标签页内容 /// 必填：否 /// [JsonPropertyName("tab_content")] public ChatTabContent? TabContent { get; set; } /// - /// Tab内容 + /// 会话标签页内容 /// public record ChatTabContent { /// - /// URL类型 + /// URL 地址，在 tab_type 取值为 url 时生效 + /// **注意**：必须以 http 或 https 开头 /// 必填：否 /// 示例值：https://www.feishu.cn /// @@ -91,7 +100,10 @@ public record ChatTabContent public string? Url { get; set; } /// - /// Doc链接 + /// 云文档链接，在 tab_type 取值为 doc 时生效 + /// **注意**： + /// - 必须以 http 或 https 开头 + /// - 当前操作者必须有云文档的协作者权限 /// 必填：否 /// 示例值：https://example.feishu.cn/wiki/wikcnPIcqWjJQwkwDzrB9t40123xz /// @@ -99,7 +111,7 @@ public record ChatTabContent public string? Doc { get; set; } /// - /// 会议纪要 + /// 会议纪要，因不支持更新 meeting_minute 类型的会话标签页，该字段为只读字段，无需传值。 /// 必填：否 /// 示例值：https://example.feishu.cn/docs/doccnvIXbV22i6hSD3utar4123dx /// @@ -108,19 +120,21 @@ public record ChatTabContent } /// - /// Tab的配置 + /// 会话标签页的配置 + /// **注意**：仅当 tab_type 取值为 url 时，该参数生效 /// 必填：否 /// [JsonPropertyName("tab_config")] public ChatTabConfig? TabConfig { get; set; } /// - /// Tab的配置 + /// 会话标签页的配置 + /// **注意**：仅当 tab_type 取值为 url 时，该参数生效 /// public record ChatTabConfig { /// - /// 群Tab图标 + /// 会话标签页的图标。需要先调用[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口，图片类型设置为 message 上传图片，然后获取 `image_key` 后传入当前参数。 /// 必填：否 /// 示例值：img_v2_b99741-7628-4abd-aad0-b881e4db83ig /// @@ -128,7 +142,7 @@ public record ChatTabConfig public string? IconKey { get; set; } /// - /// 群tab是否App内嵌打开 + /// 会话标签页是否在 App 内嵌打开 /// 必填：否 /// 示例值：false /// diff --git a/src/Im/PostImV1ChatsByChatIdChatTabsUpdateTabsResponseDto.cs b/src/Im/PostImV1ChatsByChatIdChatTabsUpdateTabsResponseDto.cs index e5579afe..ca4965f2 100644 --- a/src/Im/PostImV1ChatsByChatIdChatTabsUpdateTabsResponseDto.cs +++ b/src/Im/PostImV1ChatsByChatIdChatTabsUpdateTabsResponseDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 更新会话标签页 响应体 -/// 更新会话标签页。 +/// 更新指定的会话标签页信息，包括名称、类型以及内容等。仅支持更新文档类型（doc）或 URL （url）类型的标签页。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的用户或者机器人必须在对应的会话内。 +/// ## 使用限制 +/// - 调用该接口仅支持更新 doc、url 类型的标签页，即 tab_type 参数传值时，只能传入 doc 或 url，传入其他枚举值将会报错。如果你需要更新其他类型的会话标签页，需要在飞书客户端内操作，详情参见[会话内标签页](https://www.feishu.cn/hc/zh-CN/articles/536850681075)。 +/// - 如果群组配置了 **仅群主和群管理员可以管理标签页**，则仅群主或者群管理员可以更新会话标签页。 +/// - 操作内部群时，操作者须与群组在同一租户下。 /// 接口ID：7111246605500612609 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-tab/update_tabs /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-tab%2fupdate_tabs @@ -22,19 +29,19 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsByChatIdChatTabsUpdateTabsResponseDto { /// - /// 群标签 + /// 会话标签页 /// 必填：否 /// [JsonPropertyName("chat_tabs")] public ChatTab[]? ChatTabs { get; set; } /// - /// 群标签 + /// 会话标签页 /// public record ChatTab { /// - /// Tab ID + /// 会话标签页 ID /// 必填：否 /// 示例值：7101214603622940671 /// @@ -42,8 +49,7 @@ public record ChatTab public string? TabId { get; set; } /// - /// Tab名称 - /// **注意**：会话标签页的名称不能超过30个字符 + /// 会话标签页名称 /// 必填：否 /// 示例值：文档 /// @@ -51,7 +57,7 @@ public record ChatTab public string? TabName { get; set; } /// - /// Tab类型 + /// 会话标签页类型 /// 必填：是 /// 示例值：doc /// 可选值： @@ -63,7 +69,7 @@ public record ChatTab /// chat_announcement：群公告 /// url：URL /// file：文件 - /// files_resources：合并类型, 包含文件、Doc文档、URL链接 + /// files_resources：合并类型，包含文件、Doc文档、URL链接 /// images_videos：合并类型，包含图片、视频 /// /// @@ -71,19 +77,19 @@ public record ChatTab public string TabType { get; set; } = string.Empty; /// - /// Tab内容 + /// 会话标签页内容 /// 必填：否 /// [JsonPropertyName("tab_content")] public ChatTabContent? TabContent { get; set; } /// - /// Tab内容 + /// 会话标签页内容 /// public record ChatTabContent { /// - /// URL类型 + /// url 类型标签页对应的 URL 地址 /// 必填：否 /// 示例值：https://www.feishu.cn /// @@ -91,7 +97,7 @@ public record ChatTabContent public string? Url { get; set; } /// - /// Doc链接 + /// 文档类型标签页对应的云文档链接 /// 必填：否 /// 示例值：https://example.feishu.cn/wiki/wikcnPIcqWjJQwkwDzrB9t40123xz /// @@ -99,7 +105,7 @@ public record ChatTabContent public string? Doc { get; set; } /// - /// 会议纪要 + /// 会议纪要类型标签页对应的会议纪要地址 /// 必填：否 /// 示例值：https://example.feishu.cn/docs/doccnvIXbV22i6hSD3utar4123dx /// @@ -108,19 +114,19 @@ public record ChatTabContent } /// - /// Tab的配置 + /// 会话标签页配置 /// 必填：否 /// [JsonPropertyName("tab_config")] public ChatTabConfig? TabConfig { get; set; } /// - /// Tab的配置 + /// 会话标签页配置 /// public record ChatTabConfig { /// - /// 群Tab图标 + /// 会话标签页图标。可调用[下载图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get)（只能下载由当前机器人上传的图片），将图标下载至本地查看 /// 必填：否 /// 示例值：img_v2_b99741-7628-4abd-aad0-b881e4db83ig /// @@ -128,7 +134,7 @@ public record ChatTabConfig public string? IconKey { get; set; } /// - /// 群tab是否App内嵌打开 + /// 会话标签页是否在 App 内嵌打开 /// 必填：否 /// 示例值：false /// diff --git a/src/Im/PostImV1ChatsByChatIdLinkBodyDto.cs b/src/Im/PostImV1ChatsByChatIdLinkBodyDto.cs index f61b17da..1175579b 100644 --- a/src/Im/PostImV1ChatsByChatIdLinkBodyDto.cs +++ b/src/Im/PostImV1ChatsByChatIdLinkBodyDto.cs @@ -14,7 +14,15 @@ namespace FeishuNetSdk.Im; /// /// 获取群分享链接 请求体 -/// 获取指定群的分享链接。 +/// 获取指定群的分享链接，他人点击分享链接后可加入群组。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// - 调用该接口的用户或机器人必须在对应群组内。 +/// - 单聊、密聊、团队群不支持生成分享链接。 +/// - 当机器人被停用或者退出群组时，由该机器人获取的群分享链接也将失效。 +/// - 当群组设置了 **仅群主和群管理员可添加群成员或分享群** 时，调用该接口的用户或机器人必须是群组的群主或管理员。 +/// - 获取内部群分享链接时，调用该接口的用户或机器人必须和群组属于同一租户。 /// 接口ID：7139929321426386972 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat/link /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat%2flink @@ -22,12 +30,12 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsByChatIdLinkBodyDto { /// - /// 群分享链接有效时长，可选值week、year、permanently，分别表示7天、1年以及永久有效 + /// 群分享链接有效时长 /// 必填：否 /// 示例值：week /// 可选值： - /// week：有效期7天 - /// year：有效期1年 + /// week：有效期 7 天 + /// year：有效期 1 年 /// permanently：永久有效 /// /// 默认值：week diff --git a/src/Im/PostImV1ChatsByChatIdLinkResponseDto.cs b/src/Im/PostImV1ChatsByChatIdLinkResponseDto.cs index 0e243431..f5ddb23d 100644 --- a/src/Im/PostImV1ChatsByChatIdLinkResponseDto.cs +++ b/src/Im/PostImV1ChatsByChatIdLinkResponseDto.cs @@ -14,7 +14,15 @@ namespace FeishuNetSdk.Im; /// /// 获取群分享链接 响应体 -/// 获取指定群的分享链接。 +/// 获取指定群的分享链接，他人点击分享链接后可加入群组。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// - 调用该接口的用户或机器人必须在对应群组内。 +/// - 单聊、密聊、团队群不支持生成分享链接。 +/// - 当机器人被停用或者退出群组时，由该机器人获取的群分享链接也将失效。 +/// - 当群组设置了 **仅群主和群管理员可添加群成员或分享群** 时，调用该接口的用户或机器人必须是群组的群主或管理员。 +/// - 获取内部群分享链接时，调用该接口的用户或机器人必须和群组属于同一租户。 /// 接口ID：7139929321426386972 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat/link /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat%2flink @@ -30,7 +38,7 @@ public record PostImV1ChatsByChatIdLinkResponseDto public string? ShareLink { get; set; } /// - /// 分享链接过期时间戳（秒级） + /// 分享链接的过期时间，秒级时间戳 /// 必填：否 /// 示例值：1609296809 /// diff --git a/src/Im/PostImV1ChatsByChatIdManagersAddManagersBodyDto.cs b/src/Im/PostImV1ChatsByChatIdManagersAddManagersBodyDto.cs index a20e1a8b..afe60499 100644 --- a/src/Im/PostImV1ChatsByChatIdManagersAddManagersBodyDto.cs +++ b/src/Im/PostImV1ChatsByChatIdManagersAddManagersBodyDto.cs @@ -14,7 +14,11 @@ namespace FeishuNetSdk.Im; /// /// 指定群管理员 请求体 -/// 将用户或机器人指定为群管理员。 +/// 指定群组，将群内指定的用户或者机器人设置为群管理员。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// 仅群组内的群主可以指定群管理员。 /// 接口ID：6995085510524698625 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/add_managers /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-managers%2fadd_managers @@ -22,11 +26,14 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsByChatIdManagersAddManagersBodyDto { /// - /// 要增加的 manager_id。指定用户为管理员时推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)；指定机器人为管理员时需填写应用的App ID，请参考[如何获取应用的 App ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id) + /// 要设置为管理员的 ID，ID 类型与查询参数 member_id_type 取值一致。 + /// - 如果是用户（member_id_type 取值为 user_id/open_id/union_id），推荐使用用户的 open_id，获取方式可参考文档[如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)。 + /// - 如果是机器人（member_id_type 取值为 app_id），请参考[如何获取应用的 App ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id) /// **注意**： - /// - 对于普通群，最多指定 10 个管理员 - /// - 对于超大群，最多指定 20 个管理员 - /// - 每次请求最多指定 50 个用户或者 5 个机器人 + /// - 对于普通群，最多可指定 10 个管理员。 + /// - 对于超大群，最多可指定 20 个管理员。 + /// - 每次请求最多可指定 50 个用户或者 5 个机器人。 + /// 超大群和普通群的区别，参见[超大群与普通群有什么区别](https://www.feishu.cn/hc/zh-CN/articles/374791927841)。 /// 必填：否 /// 示例值：["ou_9204a37300b3700d61effaa439f34295"] /// 最大长度：50 diff --git a/src/Im/PostImV1ChatsByChatIdManagersAddManagersResponseDto.cs b/src/Im/PostImV1ChatsByChatIdManagersAddManagersResponseDto.cs index f596542d..4950949c 100644 --- a/src/Im/PostImV1ChatsByChatIdManagersAddManagersResponseDto.cs +++ b/src/Im/PostImV1ChatsByChatIdManagersAddManagersResponseDto.cs @@ -14,7 +14,11 @@ namespace FeishuNetSdk.Im; /// /// 指定群管理员 响应体 -/// 将用户或机器人指定为群管理员。 +/// 指定群组，将群内指定的用户或者机器人设置为群管理员。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// 仅群组内的群主可以指定群管理员。 /// 接口ID：6995085510524698625 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/add_managers /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-managers%2fadd_managers @@ -22,14 +26,14 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsByChatIdManagersAddManagersResponseDto { /// - /// 群目前用户类型的管理员 id + /// 当前群组内，用户类型管理员的用户 ID。ID 类型与查询参数 member_id_type 取值一致（如果 member_id_type 取值 app_id，则当前参数返回的是用户 open_id）。 /// 必填：否 /// [JsonPropertyName("chat_managers")] public string[]? ChatManagers { get; set; } /// - /// 群目前机器人类型的管理员 id + /// 当前群组内，机器人类型管理员的 App ID。 /// 必填：否 /// [JsonPropertyName("chat_bot_managers")] diff --git a/src/Im/PostImV1ChatsByChatIdManagersDeleteManagersBodyDto.cs b/src/Im/PostImV1ChatsByChatIdManagersDeleteManagersBodyDto.cs index 63430be9..a382af73 100644 --- a/src/Im/PostImV1ChatsByChatIdManagersDeleteManagersBodyDto.cs +++ b/src/Im/PostImV1ChatsByChatIdManagersDeleteManagersBodyDto.cs @@ -14,7 +14,11 @@ namespace FeishuNetSdk.Im; /// /// 删除群管理员 请求体 -/// 删除指定的群管理员（用户或机器人）。 +/// 指定群组，删除群组内指定的管理员，包括用户类型的管理员和机器人类型的管理员。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// 仅群组内的群主可以删除群管理员。 /// 接口ID：6995085510524715009 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/delete_managers /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-managers%2fdelete_managers @@ -22,7 +26,9 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsByChatIdManagersDeleteManagersBodyDto { /// - /// 要删除的 manager_id。移除用户类型的管理员时推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)；移除机器人类型的管理员时需填写应用的App ID，请参考[如何获取应用的 App ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id) + /// 要删除的管理员 ID，ID 类型与查询参数 member_id_type 取值一致。 + /// - 如果是用户（member_id_type 取值为 user_id/open_id/union_id），推荐使用用户的 open_id，获取方式可参考文档[如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)。 + /// - 如果是机器人（member_id_type 取值为 app_id），请参考[如何获取应用的 App ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id) /// **注意**：每次请求最多指定 50 个用户或者 5 个机器人 /// 必填：否 /// 示例值：["ou_9204a37300b3700d61effaa439f34295"] diff --git a/src/Im/PostImV1ChatsByChatIdManagersDeleteManagersResponseDto.cs b/src/Im/PostImV1ChatsByChatIdManagersDeleteManagersResponseDto.cs index 596f39a9..64156d4e 100644 --- a/src/Im/PostImV1ChatsByChatIdManagersDeleteManagersResponseDto.cs +++ b/src/Im/PostImV1ChatsByChatIdManagersDeleteManagersResponseDto.cs @@ -14,7 +14,11 @@ namespace FeishuNetSdk.Im; /// /// 删除群管理员 响应体 -/// 删除指定的群管理员（用户或机器人）。 +/// 指定群组，删除群组内指定的管理员，包括用户类型的管理员和机器人类型的管理员。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// 仅群组内的群主可以删除群管理员。 /// 接口ID：6995085510524715009 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/delete_managers /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-managers%2fdelete_managers @@ -22,14 +26,14 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsByChatIdManagersDeleteManagersResponseDto { /// - /// 群目前用户类型的管理员 id + /// 当前群组内，用户类型管理员的用户 ID。ID 类型与查询参数 member_id_type 取值一致（如果 member_id_type 取值 app_id，则当前参数返回的是用户 open_id）。 /// 必填：否 /// [JsonPropertyName("chat_managers")] public string[]? ChatManagers { get; set; } /// - /// 群目前机器人类型的管理员 id + /// 当前群组内，机器人类型管理员的 App ID。 /// 必填：否 /// [JsonPropertyName("chat_bot_managers")] diff --git a/src/Im/PostImV1ChatsByChatIdMembersBodyDto.cs b/src/Im/PostImV1ChatsByChatIdMembersBodyDto.cs index 5fdf58d8..5ab8fb80 100644 --- a/src/Im/PostImV1ChatsByChatIdMembersBodyDto.cs +++ b/src/Im/PostImV1ChatsByChatIdMembersBodyDto.cs @@ -14,7 +14,17 @@ namespace FeishuNetSdk.Im; /// /// 将用户或机器人拉入群聊 请求体 -/// 将用户或机器人拉入群聊。 +/// 把指定的用户或机器人拉入指定群聊内。 +/// ## 前提条件 +/// - 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用该接口的应用或者用户，必须在相应的群组中。 +/// - 如需拉机器人进群，则该机器人必须开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 如果以应用身份拉用户进群，则该用户需要在应用的[可用范围](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability)内。 +/// ## 使用限制 +/// - 外部租户不能被拉入内部群，但可以被拉入外部群。通过机器人拉外部租户的用户进群，需要先为机器人配置对外共享能力，详情参考[机器人支持外部群和外部用户单聊](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/develop-robots/add-bot-to-external-group)。 +/// - 操作内部群时，当前操作者必须与群组在同一租户内。 +/// - 如果群组配置了 **仅群主和群管理员可添加群成员**，则仅有群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以拉用户或机器人进群。 +/// - 如果群组没有配置 **仅群主和群管理员可添加群成员**，则所有群成员都可以拉用户或机器人进群。 /// 接口ID：6946222931479609345 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-members%2fcreate @@ -22,12 +32,14 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsByChatIdMembersBodyDto { /// - /// 成员ID列表。邀请用户进群时推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)；邀请机器人进群时需填写应用的App ID，请参考[如何获取应用的 App ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id) + /// 成员 ID 列表。 + /// - 邀请用户进群时推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// - 邀请机器人进群时需填写应用的 App ID，请参考[如何获取应用的 App ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id) /// **注意**： /// - 成员列表不可为空 - /// - 列表中填写的成员ID类型应与 ==member_id_type== 参数中选择的类型相对应 - /// - 每次请求最多拉50个用户且不超过群人数上限。对于已认证企业的飞书的群人数默认上限：普通群5000人，会议群3000人，话题群5000人。若租户管理员配置了群人数上限，则群人数上限为该人数上限 - /// - 最多同时邀请5个机器人，且邀请后群组中机器人数量不能超过 15 个 + /// - 列表中填写的成员 ID 类型应与 ==member_id_type== 参数中选择的类型相对应 + /// - 每次请求最多拉 50 个用户且不超过群人数上限。对于已认证企业的飞书的群人数默认上限：普通群 5000 人，会议群 3000 人，话题群 5000 人。若租户管理员配置了群人数上限，则群人数上限为该人数上限 + /// - 最多同时邀请 5 个机器人，且邀请后群组中机器人数量不能超过 15 个 /// 必填：否 /// 示例值：["ou_9204a37300b3700d61effaa439f34295"] /// diff --git a/src/Im/PostImV1ChatsByChatIdMembersResponseDto.cs b/src/Im/PostImV1ChatsByChatIdMembersResponseDto.cs index 6198b925..b9249cd1 100644 --- a/src/Im/PostImV1ChatsByChatIdMembersResponseDto.cs +++ b/src/Im/PostImV1ChatsByChatIdMembersResponseDto.cs @@ -14,7 +14,17 @@ namespace FeishuNetSdk.Im; /// /// 将用户或机器人拉入群聊 响应体 -/// 将用户或机器人拉入群聊。 +/// 把指定的用户或机器人拉入指定群聊内。 +/// ## 前提条件 +/// - 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用该接口的应用或者用户，必须在相应的群组中。 +/// - 如需拉机器人进群，则该机器人必须开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 如果以应用身份拉用户进群，则该用户需要在应用的[可用范围](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability)内。 +/// ## 使用限制 +/// - 外部租户不能被拉入内部群，但可以被拉入外部群。通过机器人拉外部租户的用户进群，需要先为机器人配置对外共享能力，详情参考[机器人支持外部群和外部用户单聊](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/develop-robots/add-bot-to-external-group)。 +/// - 操作内部群时，当前操作者必须与群组在同一租户内。 +/// - 如果群组配置了 **仅群主和群管理员可添加群成员**，则仅有群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以拉用户或机器人进群。 +/// - 如果群组没有配置 **仅群主和群管理员可添加群成员**，则所有群成员都可以拉用户或机器人进群。 /// 接口ID：6946222931479609345 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-member/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-members%2fcreate @@ -24,22 +34,22 @@ public record PostImV1ChatsByChatIdMembersResponseDto /// /// 无效成员列表 /// **注意**： - /// - 当`success_type=0`时，`invalid_id_list`只包含已离职的用户ID - /// - 当`success_type=1`时，`invalid_id_list`中包含已离职的、不可见的、应用未激活的ID + /// - 当`success_type` 取值为 `0`时，`invalid_id_list`只包含已离职的用户ID + /// - 当`success_type` 取值为 `1`时，`invalid_id_list`中包含已离职的、不可见的、应用未激活的 ID /// 必填：否 /// [JsonPropertyName("invalid_id_list")] public string[]? InvalidIdList { get; set; } /// - /// ID不存在的成员列表 + /// ID 不存在的成员列表 /// 必填：否 /// [JsonPropertyName("not_existed_id_list")] public string[]? NotExistedIdList { get; set; } /// - /// 等待群主或管理员审批的成员ID列表 + /// 等待群主或管理员审批的成员 ID 列表 /// 必填：否 /// [JsonPropertyName("pending_approval_id_list")] diff --git a/src/Im/PostImV1ChatsByChatIdMenuTreeBodyDto.cs b/src/Im/PostImV1ChatsByChatIdMenuTreeBodyDto.cs index 2ea29654..81b3aaf4 100644 --- a/src/Im/PostImV1ChatsByChatIdMenuTreeBodyDto.cs +++ b/src/Im/PostImV1ChatsByChatIdMenuTreeBodyDto.cs @@ -14,7 +14,15 @@ namespace FeishuNetSdk.Im; /// /// 添加群菜单 请求体 -/// 该接口用于向群组中添加群菜单。 +/// 在指定群组中添加一个或多个群菜单。成功调用后接口会返回当前群组内所有群菜单信息。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的机器人必须在对应的群组内。 +/// ## 使用限制 +/// - 该接口是向群内追加菜单，群内已存在的菜单不会被覆盖。 +/// - 一个群内最多有 3 个一级菜单，每个一级菜单最多配置 5 个二级菜单。 +/// - 不支持在已有的一级菜单中追加二级菜单。 +/// - 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 接口ID：7174746098262638596 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-menu_tree/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-menu_tree%2fcreate @@ -35,6 +43,7 @@ public record ChatMenuTree { /// /// 一级菜单列表 + /// **注意**：一个群内最多有 3 个一级菜单。 /// 必填：是 /// [JsonPropertyName("chat_menu_top_levels")] @@ -42,6 +51,7 @@ public record ChatMenuTree /// /// 一级菜单列表 + /// **注意**：一个群内最多有 3 个一级菜单。 /// public record ChatMenuTopLevel { @@ -58,33 +68,32 @@ public record ChatMenuTopLevel public record ChatMenuTopLevelChatMenuItem { /// - /// 菜单类型 - /// **注意** - /// - 如果一级菜单有二级菜单时，则此一级菜单的值必须为NONE。 + /// 一级菜单类型 + /// **注意**：如果一级菜单有二级菜单，则此一级菜单的值必须为 `NONE`。 /// 必填：是 /// 示例值：NONE /// 可选值： - /// NONE：无类型 - /// REDIRECT_LINK：跳转链接类型 + /// NONE：无类型，如果需要在一级菜单内添加二级菜单，则该一级菜单需要设置为 NONE。 + /// REDIRECT_LINK：跳转链接类型，取该值时需要设置对应的跳转链接（redirect_link）。 /// /// [JsonPropertyName("action_type")] public string ActionType { get; set; } = string.Empty; /// - /// 跳转链接 + /// 一级菜单的跳转链接 /// 必填：否 /// [JsonPropertyName("redirect_link")] public ChatMenuItemRedirectLink? RedirectLink { get; set; } /// - /// 跳转链接 + /// 一级菜单的跳转链接 /// public record ChatMenuItemRedirectLink { /// - /// 公用跳转链接，必须以http开头。 + /// 公用跳转链接，必须以 http/https 开头。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -92,7 +101,7 @@ public record ChatMenuItemRedirectLink public string? CommonUrl { get; set; } /// - /// IOS端跳转链接，当该字段不设置时，IOS端会使用common_url。必须以http开头。 + /// iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 `common_url` 值。必须以 http/https 开头。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -100,7 +109,7 @@ public record ChatMenuItemRedirectLink public string? IosUrl { get; set; } /// - /// Android端跳转链接，当该字段不设置时，Android端会使用common_url。必须以http开头。 + /// Android 端跳转链接，当该字段不设置时，Android 端默认使用 `common_url` 值。必须以 http/https 开头。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -108,7 +117,8 @@ public record ChatMenuItemRedirectLink public string? AndroidUrl { get; set; } /// - /// PC端跳转链接，当该字段不设置时，PC端会使用common_url。必须以http开头。在PC端点击群菜单后，如果需要url对应的页面在飞书侧边栏展开，可以在url前加上https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=，比如https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/ + /// PC 端跳转链接，当该字段不设置时，PC 端默认使用 `common_url` 值。必须以 http/https 开头。 + /// **使用说明**：在 PC 端点击群菜单后，如果需要 url 对应的页面在飞书侧边栏展开，可以在 url 前加上 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=`，例如 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/` /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -116,7 +126,7 @@ public record ChatMenuItemRedirectLink public string? PcUrl { get; set; } /// - /// Web端跳转链接，当该字段不设置时，Web端会使用common_url。必须以http开头。 + /// Web 端跳转链接，当该字段不设置时，Web 端默认使用 `common_url` 值。必须以 http/https 开头。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -125,9 +135,8 @@ public record ChatMenuItemRedirectLink } /// - /// 图片的key值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key - /// **注意** - /// - 如果一级菜单有二级菜单，则此一级菜单不能有图标。 + /// 一级菜单图标的 key 值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传 message 类型图片获取 image_key，并传入该值。 + /// **注意**：如果一级菜单有二级菜单，则此一级菜单不能设置图标。 /// 必填：否 /// 示例值：img_v2_b0fbe905-7988-4282-b882-82edd010336j /// @@ -135,9 +144,8 @@ public record ChatMenuItemRedirectLink public string? ImageKey { get; set; } /// - /// 菜单名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单名称 + /// **注意**：一级、二级菜单名称字符数要在 1 ~ 120 范围内。 /// 必填：是 /// 示例值：群聊 /// @@ -145,18 +153,16 @@ public record ChatMenuItemRedirectLink public string Name { get; set; } = string.Empty; /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 + /// **注意**：一级、二级菜单名称字符数要在 1 ~ 120 范围内。 /// 必填：否 /// [JsonPropertyName("i18n_names")] public ChatMenuTopLevelChatMenuItemI18nNames? I18nNames { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 + /// **注意**：一级、二级菜单名称字符数要在 1 ~ 120 范围内。 /// public record ChatMenuTopLevelChatMenuItemI18nNames { @@ -171,7 +177,7 @@ public record ChatMenuTopLevelChatMenuItemI18nNames /// /// 英文名 /// 必填：否 - /// 示例值：Signup + /// 示例值：Sign up /// [JsonPropertyName("en_us")] public string? EnUs { get; set; } @@ -211,33 +217,31 @@ public record ChatMenuSecondLevel public record ChatMenuSecondLevelChatMenuItem { /// - /// 菜单类型 - /// **注意** - /// - 如果一级菜单有二级菜单时，则此一级菜单的值必须为NONE。 + /// 二级菜单类型 /// 必填：否 /// 示例值：NONE /// 可选值： /// NONE：无类型 - /// REDIRECT_LINK：跳转链接类型 + /// REDIRECT_LINK：跳转链接类型，取该值时需要设置跳转链接（redirect_link）。 /// /// [JsonPropertyName("action_type")] public string? ActionType { get; set; } /// - /// 跳转链接 + /// 二级菜单跳转链接 /// 必填：否 /// [JsonPropertyName("redirect_link")] public ChatMenuItemRedirectLink? RedirectLink { get; set; } /// - /// 跳转链接 + /// 二级菜单跳转链接 /// public record ChatMenuItemRedirectLink { /// - /// 公用跳转链接，必须以http开头。 + /// 公用跳转链接，必须以 http/https 开头。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -245,7 +249,7 @@ public record ChatMenuItemRedirectLink public string? CommonUrl { get; set; } /// - /// IOS端跳转链接，当该字段不设置时，IOS端会使用common_url。必须以http开头。 + /// iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 `common_url` 值。必须以 http/https 开头。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -253,7 +257,7 @@ public record ChatMenuItemRedirectLink public string? IosUrl { get; set; } /// - /// Android端跳转链接，当该字段不设置时，Android端会使用common_url。必须以http开头。 + /// Android 端跳转链接，当该字段不设置时，Android 端默认使用 `common_url` 值。必须以 http/https 开头。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -261,7 +265,8 @@ public record ChatMenuItemRedirectLink public string? AndroidUrl { get; set; } /// - /// PC端跳转链接，当该字段不设置时，PC端会使用common_url。必须以http开头。在PC端点击群菜单后，如果需要url对应的页面在飞书侧边栏展开，可以在url前加上https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=，比如https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/ + /// PC 端跳转链接，当该字段不设置时，PC 端默认使用 `common_url` 值。必须以 http/https 开头。 + /// **使用说明**：在 PC 端点击群菜单后，如果需要 url 对应的页面在飞书侧边栏展开，可以在 url 前加上 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=`，例如 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/` /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -269,7 +274,7 @@ public record ChatMenuItemRedirectLink public string? PcUrl { get; set; } /// - /// Web端跳转链接，当该字段不设置时，Web端会使用common_url。必须以http开头。 + /// Web 端跳转链接，当该字段不设置时，Web 端默认使用 `common_url` 值。必须以 http/https 开头。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -278,9 +283,7 @@ public record ChatMenuItemRedirectLink } /// - /// 图片的key值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key - /// **注意** - /// - 如果一级菜单有二级菜单，则此一级菜单不能有图标。 + /// 二级菜单图标的 key 值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传 message 类型图片获取 image_key，并传入该值。 /// 必填：否 /// 示例值：img_v2_b0fbe905-7988-4282-b882-82edd010336j /// @@ -288,9 +291,8 @@ public record ChatMenuItemRedirectLink public string? ImageKey { get; set; } /// - /// 菜单名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单名称 + /// **注意**：一级、二级菜单名称字符数要在 1 ~ 120 范围内 /// 必填：否 /// 示例值：群聊 /// @@ -298,18 +300,16 @@ public record ChatMenuItemRedirectLink public string? Name { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 + /// **注意**：一级、二级菜单名称字符数要在 1 ~ 120 范围内 /// 必填：否 /// [JsonPropertyName("i18n_names")] public ChatMenuSecondLevelChatMenuItemI18nNames? I18nNames { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 + /// **注意**：一级、二级菜单名称字符数要在 1 ~ 120 范围内 /// public record ChatMenuSecondLevelChatMenuItemI18nNames { @@ -324,7 +324,7 @@ public record ChatMenuSecondLevelChatMenuItemI18nNames /// /// 英文名 /// 必填：否 - /// 示例值：Signup + /// 示例值：Sign up /// [JsonPropertyName("en_us")] public string? EnUs { get; set; } diff --git a/src/Im/PostImV1ChatsByChatIdMenuTreeResponseDto.cs b/src/Im/PostImV1ChatsByChatIdMenuTreeResponseDto.cs index b106fb99..6c3f4825 100644 --- a/src/Im/PostImV1ChatsByChatIdMenuTreeResponseDto.cs +++ b/src/Im/PostImV1ChatsByChatIdMenuTreeResponseDto.cs @@ -14,7 +14,15 @@ namespace FeishuNetSdk.Im; /// /// 添加群菜单 响应体 -/// 该接口用于向群组中添加群菜单。 +/// 在指定群组中添加一个或多个群菜单。成功调用后接口会返回当前群组内所有群菜单信息。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的机器人必须在对应的群组内。 +/// ## 使用限制 +/// - 该接口是向群内追加菜单，群内已存在的菜单不会被覆盖。 +/// - 一个群内最多有 3 个一级菜单，每个一级菜单最多配置 5 个二级菜单。 +/// - 不支持在已有的一级菜单中追加二级菜单。 +/// - 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 /// 接口ID：7174746098262638596 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-menu_tree/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-menu_tree%2fcreate @@ -22,14 +30,14 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsByChatIdMenuTreeResponseDto { /// - /// 追加后群内现有菜单 + /// 添加群菜单后，该群组内所有群菜单的信息。 /// 必填：否 /// [JsonPropertyName("menu_tree")] public ChatMenuTree? MenuTree { get; set; } /// - /// 追加后群内现有菜单 + /// 添加群菜单后，该群组内所有群菜单的信息。 /// public record ChatMenuTree { @@ -46,7 +54,7 @@ public record ChatMenuTree public record ChatMenuTopLevel { /// - /// 一级菜单ID + /// 一级菜单 ID，后续删除、修改、排序等群菜单管理操作均需要使用菜单 ID。 /// 必填：否 /// 示例值：7117116451961487361 /// @@ -67,12 +75,10 @@ public record ChatMenuTopLevelChatMenuItem { /// /// 菜单类型 - /// **注意** - /// - 如果一级菜单有二级菜单时，则此一级菜单的值必须为NONE。 /// 必填：否 /// 示例值：NONE /// 可选值： - /// NONE：无类型 + /// NONE：无类型，当一级菜单下有二级菜单时，类型取值为 NONE。 /// REDIRECT_LINK：跳转链接类型 /// /// @@ -92,7 +98,7 @@ public record ChatMenuTopLevelChatMenuItem public record ChatMenuItemRedirectLink { /// - /// 公用跳转链接，必须以http开头。 + /// 公用跳转链接 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -100,7 +106,7 @@ public record ChatMenuItemRedirectLink public string? CommonUrl { get; set; } /// - /// IOS端跳转链接，当该字段不设置时，IOS端会使用common_url。必须以http开头。 + /// iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -108,7 +114,7 @@ public record ChatMenuItemRedirectLink public string? IosUrl { get; set; } /// - /// Android端跳转链接，当该字段不设置时，Android端会使用common_url。必须以http开头。 + /// Android 端跳转链接，当该字段不设置时，Android 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -116,7 +122,8 @@ public record ChatMenuItemRedirectLink public string? AndroidUrl { get; set; } /// - /// PC端跳转链接，当该字段不设置时，PC端会使用common_url。必须以http开头。在PC端点击群菜单后，如果需要url对应的页面在飞书侧边栏展开，可以在url前加上https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=，比如https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/ + /// PC 端跳转链接，当该字段不设置时，PC 端默认使用 `common_url` 值。 + /// **说明**：以 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=` 开头的链接表示在飞书侧边栏展开。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -124,7 +131,7 @@ public record ChatMenuItemRedirectLink public string? PcUrl { get; set; } /// - /// Web端跳转链接，当该字段不设置时，Web端会使用common_url。必须以http开头。 + /// Web 端跳转链接，当该字段不设置时，Web 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -133,9 +140,8 @@ public record ChatMenuItemRedirectLink } /// - /// 图片的key值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key - /// **注意** - /// - 如果一级菜单有二级菜单，则此一级菜单不能有图标。 + /// 图标的 key 值。通过[下载图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get)接口可将图标下载到本地（只能下载由当前机器人上传的图片）。 + /// **注意**：一级菜单下存在二级菜单时不能设置图标。 /// 必填：否 /// 示例值：img_v2_b0fbe905-7988-4282-b882-82edd010336j /// @@ -143,9 +149,7 @@ public record ChatMenuItemRedirectLink public string? ImageKey { get; set; } /// - /// 菜单名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单名称 /// 必填：否 /// 示例值：群聊 /// @@ -153,18 +157,14 @@ public record ChatMenuItemRedirectLink public string? Name { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// 必填：否 /// [JsonPropertyName("i18n_names")] public ChatMenuTopLevelChatMenuItemI18nNames? I18nNames { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// public record ChatMenuTopLevelChatMenuItemI18nNames { @@ -179,7 +179,7 @@ public record ChatMenuTopLevelChatMenuItemI18nNames /// /// 英文名 /// 必填：否 - /// 示例值：Signup + /// 示例值：Sign up /// [JsonPropertyName("en_us")] public string? EnUs { get; set; } @@ -207,7 +207,7 @@ public record ChatMenuTopLevelChatMenuItemI18nNames public record ChatMenuSecondLevel { /// - /// 二级菜单ID + /// 二级菜单 ID /// 必填：否 /// 示例值：7039638308221468675 /// @@ -228,8 +228,6 @@ public record ChatMenuSecondLevelChatMenuItem { /// /// 菜单类型 - /// **注意** - /// - 如果一级菜单有二级菜单时，则此一级菜单的值必须为NONE。 /// 必填：否 /// 示例值：NONE /// 可选值： @@ -253,7 +251,7 @@ public record ChatMenuSecondLevelChatMenuItem public record ChatMenuItemRedirectLink { /// - /// 公用跳转链接，必须以http开头。 + /// 公用跳转链接 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -261,7 +259,7 @@ public record ChatMenuItemRedirectLink public string? CommonUrl { get; set; } /// - /// IOS端跳转链接，当该字段不设置时，IOS端会使用common_url。必须以http开头。 + /// iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -269,7 +267,7 @@ public record ChatMenuItemRedirectLink public string? IosUrl { get; set; } /// - /// Android端跳转链接，当该字段不设置时，Android端会使用common_url。必须以http开头。 + /// Android 端跳转链接，当该字段不设置时，Android 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -277,7 +275,8 @@ public record ChatMenuItemRedirectLink public string? AndroidUrl { get; set; } /// - /// PC端跳转链接，当该字段不设置时，PC端会使用common_url。必须以http开头。在PC端点击群菜单后，如果需要url对应的页面在飞书侧边栏展开，可以在url前加上https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=，比如https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/ + /// PC 端跳转链接，当该字段不设置时，PC 端默认使用 `common_url` 值。 + /// **说明**：以 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=` 开头的链接表示在飞书侧边栏展开。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -285,7 +284,7 @@ public record ChatMenuItemRedirectLink public string? PcUrl { get; set; } /// - /// Web端跳转链接，当该字段不设置时，Web端会使用common_url。必须以http开头。 + /// Web 端跳转链接，当该字段不设置时，Web 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -294,9 +293,7 @@ public record ChatMenuItemRedirectLink } /// - /// 图片的key值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key - /// **注意** - /// - 如果一级菜单有二级菜单，则此一级菜单不能有图标。 + /// 图标的 key 值。通过[下载图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get)接口可将图标下载到本地（只能下载由当前机器人上传的图片）。 /// 必填：否 /// 示例值：img_v2_b0fbe905-7988-4282-b882-82edd010336j /// @@ -304,9 +301,7 @@ public record ChatMenuItemRedirectLink public string? ImageKey { get; set; } /// - /// 菜单名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单名称 /// 必填：否 /// 示例值：群聊 /// @@ -314,18 +309,14 @@ public record ChatMenuItemRedirectLink public string? Name { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// 必填：否 /// [JsonPropertyName("i18n_names")] public ChatMenuSecondLevelChatMenuItemI18nNames? I18nNames { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// public record ChatMenuSecondLevelChatMenuItemI18nNames { @@ -340,7 +331,7 @@ public record ChatMenuSecondLevelChatMenuItemI18nNames /// /// 英文名 /// 必填：否 - /// 示例值：Signup + /// 示例值：Sign up /// [JsonPropertyName("en_us")] public string? EnUs { get; set; } diff --git a/src/Im/PostImV1ChatsByChatIdMenuTreeSortBodyDto.cs b/src/Im/PostImV1ChatsByChatIdMenuTreeSortBodyDto.cs index e60fb46d..afffc43e 100644 --- a/src/Im/PostImV1ChatsByChatIdMenuTreeSortBodyDto.cs +++ b/src/Im/PostImV1ChatsByChatIdMenuTreeSortBodyDto.cs @@ -14,7 +14,13 @@ namespace FeishuNetSdk.Im; /// /// 排序群菜单 请求体 -/// 给一个群内的一级菜单排序。 +/// 调整指定群组内的群菜单排列顺序，成功调用后接口会返回群组内所有群菜单信息。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的机器人必须在对应的群组内。 +/// ## 使用限制 +/// - 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 +/// - 仅支持调整群组内一级菜单的排序。 /// 接口ID：7174746098262687748 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-menu_tree/sort /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-menu_tree%2fsort @@ -22,7 +28,8 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsByChatIdMenuTreeSortBodyDto { /// - /// 新的一级菜单的顺序，进行排序ID列表需要跟群内目前存在的一级菜单ID列表对齐。通过 [获取群菜单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) 接口获取群内菜单详情。 + /// 通过一级菜单的 ID 进行排序。数组内的元素排序对应群组内一级菜单从左往右的排序。ID 可通过 [获取群菜单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) 接口获取。 + /// **说明**：进行排序的 ID 列表需要跟群内存在的一级菜单 ID 列表对齐。 /// 必填：是 /// 示例值：7156553273518882844 /// diff --git a/src/Im/PostImV1ChatsByChatIdMenuTreeSortResponseDto.cs b/src/Im/PostImV1ChatsByChatIdMenuTreeSortResponseDto.cs index fd05cc6d..a553083a 100644 --- a/src/Im/PostImV1ChatsByChatIdMenuTreeSortResponseDto.cs +++ b/src/Im/PostImV1ChatsByChatIdMenuTreeSortResponseDto.cs @@ -14,7 +14,13 @@ namespace FeishuNetSdk.Im; /// /// 排序群菜单 响应体 -/// 给一个群内的一级菜单排序。 +/// 调整指定群组内的群菜单排列顺序，成功调用后接口会返回群组内所有群菜单信息。 +/// ## 前提条件 +/// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// - 调用当前接口的机器人必须在对应的群组内。 +/// ## 使用限制 +/// - 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 +/// - 仅支持调整群组内一级菜单的排序。 /// 接口ID：7174746098262687748 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat-menu_tree/sort /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-menu_tree%2fsort @@ -22,14 +28,14 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsByChatIdMenuTreeSortResponseDto { /// - /// 排序后群内菜单 + /// 排序后，群菜单信息 /// 必填：否 /// [JsonPropertyName("menu_tree")] public ChatMenuTree? MenuTree { get; set; } /// - /// 排序后群内菜单 + /// 排序后，群菜单信息 /// public record ChatMenuTree { @@ -46,7 +52,7 @@ public record ChatMenuTree public record ChatMenuTopLevel { /// - /// 一级菜单ID + /// 一级菜单 ID /// 必填：否 /// 示例值：7117116451961487361 /// @@ -67,12 +73,10 @@ public record ChatMenuTopLevelChatMenuItem { /// /// 菜单类型 - /// **注意** - /// - 如果一级菜单有二级菜单时，则此一级菜单的值必须为NONE。 /// 必填：否 /// 示例值：NONE /// 可选值： - /// NONE：无类型 + /// NONE：无分类，当一级菜单下有二级菜单时，类型取值为 NONE。 /// REDIRECT_LINK：跳转链接类型 /// /// @@ -92,7 +96,7 @@ public record ChatMenuTopLevelChatMenuItem public record ChatMenuItemRedirectLink { /// - /// 公用跳转链接，必须以http开头。 + /// 公用跳转链接 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -100,7 +104,7 @@ public record ChatMenuItemRedirectLink public string? CommonUrl { get; set; } /// - /// IOS端跳转链接，当该字段不设置时，IOS端会使用common_url。必须以http开头。 + /// iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -108,7 +112,7 @@ public record ChatMenuItemRedirectLink public string? IosUrl { get; set; } /// - /// Android端跳转链接，当该字段不设置时，Android端会使用common_url。必须以http开头。 + /// Android 端跳转链接，当该字段不设置时，Android 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -116,7 +120,8 @@ public record ChatMenuItemRedirectLink public string? AndroidUrl { get; set; } /// - /// PC端跳转链接，当该字段不设置时，PC端会使用common_url。必须以http开头。在PC端点击群菜单后，如果需要url对应的页面在飞书侧边栏展开，可以在url前加上https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=，比如https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/ + /// PC 端跳转链接，当该字段不设置时，PC 端默认使用 `common_url` 值。 + /// **说明**：以 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=` 开头的链接表示在飞书侧边栏展开。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -124,7 +129,7 @@ public record ChatMenuItemRedirectLink public string? PcUrl { get; set; } /// - /// Web端跳转链接，当该字段不设置时，Web端会使用common_url。必须以http开头。 + /// Web 端跳转链接，当该字段不设置时，Web 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -133,9 +138,8 @@ public record ChatMenuItemRedirectLink } /// - /// 图片的key值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key - /// **注意** - /// - 如果一级菜单有二级菜单，则此一级菜单不能有图标。 + /// 图标的 key 值。通过[下载图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get)接口可将图标下载到本地（只能下载由当前机器人上传的图片）。 + /// **注意**：一级菜单下存在二级菜单时不能设置图标。 /// 必填：否 /// 示例值：img_v2_b0fbe905-7988-4282-b882-82edd010336j /// @@ -143,9 +147,7 @@ public record ChatMenuItemRedirectLink public string? ImageKey { get; set; } /// - /// 菜单名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单名称 /// 必填：否 /// 示例值：评审报名 /// @@ -153,18 +155,14 @@ public record ChatMenuItemRedirectLink public string? Name { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// 必填：否 /// [JsonPropertyName("i18n_names")] public ChatMenuTopLevelChatMenuItemI18nNames? I18nNames { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// public record ChatMenuTopLevelChatMenuItemI18nNames { @@ -179,7 +177,7 @@ public record ChatMenuTopLevelChatMenuItemI18nNames /// /// 英文名 /// 必填：否 - /// 示例值：Signup + /// 示例值：Sign up /// [JsonPropertyName("en_us")] public string? EnUs { get; set; } @@ -207,7 +205,7 @@ public record ChatMenuTopLevelChatMenuItemI18nNames public record ChatMenuSecondLevel { /// - /// 二级菜单ID + /// 二级菜单 ID /// 必填：否 /// 示例值：7039638308221468675 /// @@ -215,21 +213,19 @@ public record ChatMenuSecondLevel public string? ChatMenuSecondLevelId { get; set; } /// - /// 二级菜单信息 + /// 二级菜单 ID，后续删除、修改、排序等群菜单管理操作均需要使用菜单 ID。 /// 必填：否 /// [JsonPropertyName("chat_menu_item")] public ChatMenuSecondLevelChatMenuItem? ChatMenuItem { get; set; } /// - /// 二级菜单信息 + /// 二级菜单 ID，后续删除、修改、排序等群菜单管理操作均需要使用菜单 ID。 /// public record ChatMenuSecondLevelChatMenuItem { /// /// 菜单类型 - /// **注意** - /// - 如果一级菜单有二级菜单时，则此一级菜单的值必须为NONE。 /// 必填：否 /// 示例值：NONE /// 可选值： @@ -253,7 +249,7 @@ public record ChatMenuSecondLevelChatMenuItem public record ChatMenuItemRedirectLink { /// - /// 公用跳转链接，必须以http开头。 + /// 公用跳转链接 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -261,7 +257,7 @@ public record ChatMenuItemRedirectLink public string? CommonUrl { get; set; } /// - /// IOS端跳转链接，当该字段不设置时，IOS端会使用common_url。必须以http开头。 + /// iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -269,7 +265,7 @@ public record ChatMenuItemRedirectLink public string? IosUrl { get; set; } /// - /// Android端跳转链接，当该字段不设置时，Android端会使用common_url。必须以http开头。 + /// Android 端跳转链接，当该字段不设置时，Android 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -277,7 +273,8 @@ public record ChatMenuItemRedirectLink public string? AndroidUrl { get; set; } /// - /// PC端跳转链接，当该字段不设置时，PC端会使用common_url。必须以http开头。在PC端点击群菜单后，如果需要url对应的页面在飞书侧边栏展开，可以在url前加上https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=，比如https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=https://open.feishu.cn/ + /// PC 端跳转链接，当该字段不设置时，PC 端默认使用 `common_url` 值。 + /// **说明**：以 `https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url=` 开头的链接表示在飞书侧边栏展开。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -285,7 +282,7 @@ public record ChatMenuItemRedirectLink public string? PcUrl { get; set; } /// - /// Web端跳转链接，当该字段不设置时，Web端会使用common_url。必须以http开头。 + /// Web 端跳转链接，当该字段不设置时，Web 端默认使用 `common_url` 值。 /// 必填：否 /// 示例值：https://open.feishu.cn/ /// @@ -294,9 +291,7 @@ public record ChatMenuItemRedirectLink } /// - /// 图片的key值。通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key - /// **注意** - /// - 如果一级菜单有二级菜单，则此一级菜单不能有图标。 + /// 图标的 key 值。通过[下载图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get)接口可将图标下载到本地（只能下载由当前机器人上传的图片）。 /// 必填：否 /// 示例值：img_v2_b0fbe905-7988-4282-b882-82edd010336j /// @@ -304,9 +299,7 @@ public record ChatMenuItemRedirectLink public string? ImageKey { get; set; } /// - /// 菜单名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单名称 /// 必填：否 /// 示例值：评审报名 /// @@ -314,18 +307,14 @@ public record ChatMenuItemRedirectLink public string? Name { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// 必填：否 /// [JsonPropertyName("i18n_names")] public ChatMenuSecondLevelChatMenuItemI18nNames? I18nNames { get; set; } /// - /// 菜单国际化名称。 - /// **注意** - /// - 一级、二级菜单名称字符数要在1到120范围内 + /// 菜单国际化名称 /// public record ChatMenuSecondLevelChatMenuItemI18nNames { @@ -340,7 +329,7 @@ public record ChatMenuSecondLevelChatMenuItemI18nNames /// /// 英文名 /// 必填：否 - /// 示例值：Signup + /// 示例值：Sign up /// [JsonPropertyName("en_us")] public string? EnUs { get; set; } diff --git a/src/Im/PostImV1ChatsByChatIdTopNoticePutTopNoticeBodyDto.cs b/src/Im/PostImV1ChatsByChatIdTopNoticePutTopNoticeBodyDto.cs index 1ac5547b..8f1a3e4d 100644 --- a/src/Im/PostImV1ChatsByChatIdTopNoticePutTopNoticeBodyDto.cs +++ b/src/Im/PostImV1ChatsByChatIdTopNoticePutTopNoticeBodyDto.cs @@ -14,7 +14,11 @@ namespace FeishuNetSdk.Im; /// /// 更新群置顶 请求体 -/// 更新会话中的群置顶信息，可以将群中的某一条消息，或者群公告置顶显示。 +/// 更新群组中的群置顶信息，可以将群中的某一条消息，或群公告置顶展示。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// 调用接口的机器人或者用户必须要在群组内，且和该群组属于同一租户。 /// 接口ID：7043611687799816193 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat/put_top_notice /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-top_notice%2fput_top_notice @@ -22,27 +26,24 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsByChatIdTopNoticePutTopNoticeBodyDto { /// - /// 要进行发布的群置顶 + /// 群置顶配置 /// 必填：是 /// [JsonPropertyName("chat_top_notice")] public ChatTopNotice[] ChatTopNotices { get; set; } = Array.Empty(); /// - /// 要进行发布的群置顶 + /// 群置顶配置 /// public record ChatTopNotice { /// - /// 置顶的类型 - /// **注意**： - /// - 选择 ==消息类型== 时必须填写`message_id`字段 - /// - 选择 ==群公告类型== 时填写的`message_id`将被忽略 + /// 置顶类型 /// 必填：否 /// 示例值：2 /// 可选值： - /// 1：消息类型 - /// 2：群公告类型 + /// 1：消息类型，必需填写 `message_id` + /// 2：群公告类型，无需填写 `message_id` /// /// 默认值：2 /// @@ -50,7 +51,10 @@ public record ChatTopNotice public string? ActionType { get; set; } /// - /// 消息ID，详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2) + /// 消息 ID。ID 获取方式： + /// - 调用[发送消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/create)接口后，从响应结果的 `message_id` 参数获取。 + /// - 监听[接收消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/events/receive)事件，当触发该事件后可以从事件体内获取消息的 `message_id`。 + /// - 调用[获取会话历史消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/list)接口，从响应结果的 `message_id` 参数获取。 /// 必填：否 /// 示例值：om_dc13264520392913993dd051dba21dcf /// diff --git a/src/Im/PostImV1ChatsResponseDto.cs b/src/Im/PostImV1ChatsResponseDto.cs index 34533718..82c9c654 100644 --- a/src/Im/PostImV1ChatsResponseDto.cs +++ b/src/Im/PostImV1ChatsResponseDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 创建群 响应体 -/// 创建群并设置群头像、群名、群描述等。 +/// 创建群聊，创建时支持设置群头像、群名称、群主以及群类型等配置，同时支持邀请群成员、群机器人入群。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// 商店应用无法使用用户的 user_id，因此使用商店应用调用本接口时用户 ID 类型请选择 open_id 或者 union_id。 +/// ## 注意事项 +/// - 如果你需要在已创建的群聊内邀请用户或机器人入群，可调用[将用户或机器人拉入群聊](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create)接口。 +/// - 调用 API 只能创建普通消息群，消息形式可以选择对话消息或者话题消息。如果你需要直接创建话题群，请通过飞书客户端创建群组，创建时群模式选择 **话题**。 /// 接口ID：6946222931479379969 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat%2fcreate @@ -22,7 +29,7 @@ namespace FeishuNetSdk.Im; public record PostImV1ChatsResponseDto { /// - /// 群 ID，详情参见：[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) + /// 群 ID。建议保存该 ID，后续[向群发送消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/create)、[更新群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/update)以及[将用户或机器人拉入群聊](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create)等群组相关的操作均需使用该 ID。 /// 必填：否 /// 示例值：oc_a0553eda9014c201e6969b478895c230 /// @@ -91,7 +98,7 @@ public record PostImV1ChatsResponseDtoI18nNames } /// - /// 群主 ID，ID值与查询参数中的 ==user_id_type== 对应；不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction) + /// 群主 ID，ID 类型与查询参数中的 ==user_id_type== 对应；不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。 /// **注意**：当群主是机器人时，该字段不返回 /// 必填：否 /// 示例值：ou_7d8a6e6df7621556ce0d21922b676706ccs @@ -100,7 +107,7 @@ public record PostImV1ChatsResponseDtoI18nNames public string? OwnerId { get; set; } /// - /// 群主 ID 对应的ID类型，与查询参数中的 ==user_id_type== 相同。取值为：`open_id`、`user_id`、`union_id`其中之一 + /// 群主 ID 类型，与查询参数中的 ==user_id_type== 取值相同。 /// **注意**：当群主是机器人时，该字段不返回 /// 必填：否 /// 示例值：open_id @@ -133,7 +140,7 @@ public record PostImV1ChatsResponseDtoI18nNames public string? VideoConferenceSetting { get; set; } /// - /// 拉 用户或机器人 入群权限 + /// 谁可以邀请用户或机器人入群 /// **可选值有**： /// - `only_owner`：仅群主和管理员 /// - `all_members`：所有成员 @@ -155,7 +162,7 @@ public record PostImV1ChatsResponseDtoI18nNames public string? ShareCardPermission { get; set; } /// - /// at 所有人权限 + /// 谁可以 at 所有人 /// **可选值有**： /// - `only_owner`：仅群主和管理员 /// - `all_members`：所有成员 @@ -232,7 +239,7 @@ public record PostImV1ChatsResponseDtoI18nNames public bool? External { get; set; } /// - /// 租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用里面的唯一标识 + /// 租户在飞书上的唯一标识，用来换取对应的 tenant_access_token，也可以用作租户在应用里面的唯一标识 /// 必填：否 /// 示例值：736588c9260f175e /// @@ -288,6 +295,7 @@ public record PostImV1ChatsResponseDtoI18nNames /// /// 保密模式设置 + /// **注意**：仅企业旗舰版支持设置保密模式。保密模式的适用版本与功能介绍，参见[会话保密模式](https://www.feishu.cn/hc/zh-CN/articles/418691056559)。 /// 必填：否 /// [JsonPropertyName("restricted_mode_setting")] @@ -295,6 +303,7 @@ public record PostImV1ChatsResponseDtoI18nNames /// /// 保密模式设置 + /// **注意**：仅企业旗舰版支持设置保密模式。保密模式的适用版本与功能介绍，参见[会话保密模式](https://www.feishu.cn/hc/zh-CN/articles/418691056559)。 /// public record PostImV1ChatsResponseDtoRestrictedModeSetting { diff --git a/src/Im/PutImV1ChatsByChatIdBodyDto.cs b/src/Im/PutImV1ChatsByChatIdBodyDto.cs index 39180d8e..85664ebb 100644 --- a/src/Im/PutImV1ChatsByChatIdBodyDto.cs +++ b/src/Im/PutImV1ChatsByChatIdBodyDto.cs @@ -14,7 +14,16 @@ namespace FeishuNetSdk.Im; /// /// 更新群信息 请求体 -/// 更新群头像、群名称、群描述、群配置、转让群主等。 +/// 更新指定群的信息，包括群头像、群名称、群描述、群配置以及群主等。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// - 对于群主和群管理员，或是创建群组且具备 ==更新应用所创建群的群信息（im:chat:operate_as_owner）== 权限的机器人，可调用本接口更新所有信息。 +/// - 对于不满足上述权限条件的群成员或机器人： +/// - 如果群设置中配置了 **所有群成员可编辑群信息**，则仅可更新群头像、群名称、群描述、群国际化名称信息。 +/// - 如果群设置中配置了 **仅群主和群管理员可编辑群信息**，则无法修改任何群信息。 +/// ## 注意事项 +/// 调用该接口时，未传值的请求参数默认不更新，保持原有群信息。 /// 接口ID：6946222931479592961 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat/update-2 /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat%2fupdate @@ -31,6 +40,9 @@ public record PutImV1ChatsByChatIdBodyDto /// /// 群名称 + /// **注意：** + /// - 建议群名称不超过 60 字符 + /// - 公开群名称的长度不得少于 2 个字符 /// 必填：否 /// 示例值：群聊 /// @@ -38,7 +50,7 @@ public record PutImV1ChatsByChatIdBodyDto public string? Name { get; set; } /// - /// 群描述 + /// 群描述，建议不超过 100 字符 /// 必填：否 /// 示例值：测试群描述 /// @@ -46,14 +58,14 @@ public record PutImV1ChatsByChatIdBodyDto public string? Description { get; set; } /// - /// 群国际化名称 + /// 群国际化名称，建议不超过 60 字符 /// 必填：否 /// [JsonPropertyName("i18n_names")] public PutImV1ChatsByChatIdBodyDtoI18nNames? I18nNames { get; set; } /// - /// 群国际化名称 + /// 群国际化名称，建议不超过 60 字符 /// public record PutImV1ChatsByChatIdBodyDtoI18nNames { @@ -83,13 +95,13 @@ public record PutImV1ChatsByChatIdBodyDtoI18nNames } /// - /// 邀请用户或机器人入群权限 - /// 注意： - /// - 若值设置为`only_owner`，则share_card_permission只能设置为`not_allowed` - /// - 若值设置为`all_members`，则share_card_permission只能设置为`allowed` + /// 谁可以添加群成员，群成员包括用户或机器人 /// **可选值有**： /// - `only_owner`：仅群主和管理员 /// - `all_members`：所有成员 + /// **注意**：`add_member_permission` 和 `share_card_permission` 两个参数必须同步配置。 + /// - 如果 `add_member_permission` 值为 `only_owner`，则 `share_card_permission` 只能设置为 `not_allowed`。 + /// - 如果 `add_member_permission` 值为`all_members`，则 `share_card_permission` 只能设置为 `allowed`。 /// 必填：否 /// 示例值：all_members /// @@ -97,10 +109,13 @@ public record PutImV1ChatsByChatIdBodyDtoI18nNames public string? AddMemberPermission { get; set; } /// - /// 群分享权限 + /// 是否允许分享群 /// **可选值有**： /// - `allowed`：允许 /// - `not_allowed`：不允许 + /// **注意**：`add_member_permission` 和 `share_card_permission` 两个参数必须同步配置。 + /// - 如果 `add_member_permission` 值为 `only_owner`，则 `share_card_permission` 只能设置为 `not_allowed`。 + /// - 如果 `add_member_permission` 值为`all_members`，则 `share_card_permission` 只能设置为 `allowed`。 /// 必填：否 /// 示例值：allowed /// @@ -108,7 +123,7 @@ public record PutImV1ChatsByChatIdBodyDtoI18nNames public string? ShareCardPermission { get; set; } /// - /// at 所有人权限 + /// 谁可以 at 所有人 /// **可选值有**： /// - `only_owner`：仅群主和管理员 /// - `all_members`：所有成员 @@ -119,7 +134,7 @@ public record PutImV1ChatsByChatIdBodyDtoI18nNames public string? AtAllPermission { get; set; } /// - /// 群编辑权限 + /// 谁可以编辑群信息 /// **可选值有**： /// - `only_owner`：仅群主和管理员 /// - `all_members`：所有成员 @@ -130,7 +145,7 @@ public record PutImV1ChatsByChatIdBodyDtoI18nNames public string? EditPermission { get; set; } /// - /// 新群主 ID，不转让群主时无需填写。ID类型推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// 新群主的用户 ID，不转让群主时无需填写。ID 类型与查询参数 user_id_type 取值一致，ID 类型推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)。 /// 必填：否 /// 示例值：4d7a3c6g /// @@ -138,7 +153,7 @@ public record PutImV1ChatsByChatIdBodyDtoI18nNames public string? OwnerId { get; set; } /// - /// 入群消息可见性 + /// 成员入群提示消息的可见性 /// **可选值有**： /// - `only_owner`：仅群主和管理员可见 /// - `all_members`：所有成员可见 @@ -150,7 +165,7 @@ public record PutImV1ChatsByChatIdBodyDtoI18nNames public string? JoinMessageVisibility { get; set; } /// - /// 出群消息可见性 + /// 成员退群提示消息的可见性 /// **可选值有**： /// - `only_owner`：仅群主和管理员可见 /// - `all_members`：所有成员可见 @@ -162,7 +177,7 @@ public record PutImV1ChatsByChatIdBodyDtoI18nNames public string? LeaveMessageVisibility { get; set; } /// - /// 加群审批 + /// 加群是否需要审批 /// **可选值有**： /// - `no_approval_required`：无需审批 /// - `approval_required`：需要审批 @@ -174,6 +189,7 @@ public record PutImV1ChatsByChatIdBodyDtoI18nNames /// /// 保密模式设置 + /// **注意**：保密模式适用于企业旗舰版。适用版本与功能介绍参见[会话保密模式](https://www.feishu.cn/hc/zh-CN/articles/418691056559)。 /// 必填：否 /// [JsonPropertyName("restricted_mode_setting")] @@ -181,14 +197,15 @@ public record PutImV1ChatsByChatIdBodyDtoI18nNames /// /// 保密模式设置 + /// **注意**：保密模式适用于企业旗舰版。适用版本与功能介绍参见[会话保密模式](https://www.feishu.cn/hc/zh-CN/articles/418691056559)。 /// public record PutImV1ChatsByChatIdBodyDtoRestrictedModeSetting { /// - /// 保密模式是否开启。 - /// **注意**： - /// - status为true时，screenshot_has_permission_setting、download_has_permission_setting、message_has_permission_setting不能全为all_members。 - /// - status为false时，screenshot_has_permission_setting、download_has_permission_setting、message_has_permission_setting不能存在not_anyone。 + /// 保密模式是否开启 + /// **可选值有**： + /// - true：开启。设置为 ture 时，`screenshot_has_permission_setting`、`download_has_permission_setting`、`message_has_permission_setting` 不能全为 `all_members`。 + /// - false：不开启。设置为 false 时，`screenshot_has_permission_setting`、`download_has_permission_setting`、`message_has_permission_setting` 不能存在 `not_anyone`。 /// 必填：否 /// 示例值：false /// diff --git a/src/Im/PutImV1ChatsByChatIdModerationBodyDto.cs b/src/Im/PutImV1ChatsByChatIdModerationBodyDto.cs index 2df11d9a..adb483eb 100644 --- a/src/Im/PutImV1ChatsByChatIdModerationBodyDto.cs +++ b/src/Im/PutImV1ChatsByChatIdModerationBodyDto.cs @@ -14,7 +14,14 @@ namespace FeishuNetSdk.Im; /// /// 更新群发言权限 请求体 -/// 更新群组的发言权限设置，可设置为全员可发言、仅管理员可发言 或 指定用户可发言。 +/// 更新指定群组的发言权限，可设置为所有群成员可发言、仅群主或管理员可发言、指定群成员可发言。 +/// ## 前提条件 +/// 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 +/// ## 使用限制 +/// - 如果以用户身份（user_access_token）调用本接口，则该用户必须是群组的群主，才可以更新群发言权限。 +/// - 如果以应用身份（tenant_access_token）调用本接口，则该应用机器人需要符合以下任一情况才可以更新群发言权限。 +/// - 机器人是群组的群主。 +/// - 机器人是群组的创建者、具备==更新应用所创建群的群信息（im:chat:operate_as_owner）== 权限，且仍在群组内。 /// 接口ID：6951292665602899970 /// 文档地址：https://open.feishu.cn/document/server-docs/group/chat/update /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fim-v1%2fchat-moderation%2fupdate @@ -22,7 +29,11 @@ namespace FeishuNetSdk.Im; public record PutImV1ChatsByChatIdModerationBodyDto { /// - /// 群发言模式（all_members/only_owner/moderator_list，其中 moderator_list 表示部分用户可发言的模式） + /// 群发言模式 + /// **可选值有**： + /// - all_members：所有群成员可发言 + /// - only_owner：仅群主或管理员可发言 + /// - moderator_list：指定群成员可发言，取该值时需要选择设置 `moderator_added_list` 和 `moderator_removed_list` /// 必填：否 /// 示例值：moderator_list /// @@ -30,7 +41,11 @@ public record PutImV1ChatsByChatIdModerationBodyDto public string? ModerationSetting { get; set; } /// - /// 选择部分用户可发言模式时，添加的可发言用户列表（自动过滤不在群内的用户）。推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// 当 `moderation_setting ` 取值为 `moderator_list` 时，以 ID 列表形式添加可发言的用户。 + /// **注意**： + /// - ID 类型与查询参数 user_id_type 取值一致，推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)。 + /// - 列表内的用户如果不在群组内，则会被自动过滤掉。 + /// - 请求时，请确保 `moderator_added_list` 和 `moderator_removed_list` 两个参数内的 ID 不重复。 /// 必填：否 /// 示例值：["ou_7d8a6e6df7621556ce0d21922b676706ccs"] /// @@ -38,7 +53,11 @@ public record PutImV1ChatsByChatIdModerationBodyDto public string[]? ModeratorAddedList { get; set; } /// - /// 选择部分用户可发言模式时，移除的可发言用户列表（自动过滤不在群内的用户）。推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// 当 `moderation_setting ` 取值为 `moderator_list` 时，以 ID 列表形式移除可发言的用户。 + /// **注意**： + /// - ID 类型与查询参数 user_id_type 取值一致，推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)。 + /// - 列表内的用户如果不在群组内，则会被自动过滤掉。 + /// - 请求时，请确保 `moderator_added_list` 和 `moderator_removed_list` 两个参数内的 ID 不重复。 /// 必填：否 /// 示例值：["ou_8d7h6e6df76215566d8dbs92k6767c4d87"] /// diff --git a/src/MeetingRoom.Events/ThirdPartyMeetingRoomEventCreatedEventBodyDto.cs b/src/MeetingRoom.Events/ThirdPartyMeetingRoomEventCreatedEventBodyDto.cs index 58a016f4..57f6e1b3 100644 --- a/src/MeetingRoom.Events/ThirdPartyMeetingRoomEventCreatedEventBodyDto.cs +++ b/src/MeetingRoom.Events/ThirdPartyMeetingRoomEventCreatedEventBodyDto.cs @@ -58,12 +58,19 @@ public record ThirdPartyMeetingRoomEventCreatedEventBodyDto() : EventBodyDto("th public string? Uid { get; set; } /// - /// 重复日程的例外的唯一标识，如果不是重复的日程，此处为0。 + /// 重复日程的例外日程的唯一标识，时间戳格式。 /// 必填：否 /// [JsonPropertyName("original_time")] public int? OriginalTime { get; set; } + /// + /// 日程 ID，格式为 `{Uid}_{Original time}`，`{Uid}` 是日程的唯一标识，`{Original time}` 是日程实例原始时间，非重复性日程和重复性日程取值为 0，重复性日程的例外日程取值为具体时间戳。 + /// 必填：否 + /// + [JsonPropertyName("event_id")] + public string? EventId { get; set; } + /// /// 日程开始时间 /// 必填：否 @@ -96,20 +103,7 @@ public record EventTimeSuffix /// 必填：否 /// [JsonPropertyName("meeting_rooms")] - public MeetingRoom[]? MeetingRooms { get; set; } - - /// - /// 会议室 - /// - public record MeetingRoom - { - /// - /// 会议室唯一标识 - /// 必填：否 - /// - [JsonPropertyName("open_id")] - public string? OpenId { get; set; } - } + public string[]? MeetingRooms { get; set; } /// /// 日程的组织者 diff --git a/src/Passport/PostPassportV1SessionsLogoutBodyDto.cs b/src/Passport/PostPassportV1SessionsLogoutBodyDto.cs new file mode 100644 index 00000000..d73f0615 --- /dev/null +++ b/src/Passport/PostPassportV1SessionsLogoutBodyDto.cs @@ -0,0 +1,86 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-11-03 +// +// Last Modified By : yxr +// Last Modified On : 2024-11-03 +// ************************************************************************ +// +// MIT +// +// 退出登录 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Passport; +/// +/// 退出登录 请求体 +/// 该接口用于退出用户的登录态 +/// 接口ID：7419242474898472963 +/// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/passport-v1/session/logout +/// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fpassport-v1%2fsession%2flogout +/// +public record PostPassportV1SessionsLogoutBodyDto +{ + /// + /// idp 侧的唯一标识，logout_type = 2 时必填 + /// 必填：否 + /// 示例值：user@xxx.xx + /// + [JsonPropertyName("idp_credential_id")] + public string? IdpCredentialId { get; set; } + + /// + /// 登出的方式 + /// 必填：是 + /// 示例值：1 + /// 可选值： + /// 1：UserID，使用开放平台的维度登出 + /// 2：IdpCredentialID，使用 idp 侧的唯一标识登出 + /// 3：Session 标识符，基于session uuid 登出 + /// + /// + [JsonPropertyName("logout_type")] + public int LogoutType { get; set; } + + /// + /// 登出的客户端类型，默认全部登出。可选值： + /// - 1：PC 端 + /// - 2：Web 端 + /// - 3：Android 端 + /// - 4：iOS 端 + /// - 5：服务端 + /// - 6：旧版小程序端 + /// - 8：其他移动端 + /// 必填：否 + /// + [JsonPropertyName("terminal_type")] + public int[]? TerminalType { get; set; } + + /// + /// 开放平台的数据标识，用户 ID 类型与查询参数 user_id_type 一致，logout_type = 1 时必填 + /// 必填：否 + /// 示例值：ou_7dab8a3d3cdcc9da365777c7ad535d62 + /// + [JsonPropertyName("user_id")] + public string? UserId { get; set; } + + /// + /// 登出提示语，非必填，不传时默认提示：你已在其他客户端上退出了当前设备，请重新登录。 + /// 可选值： + /// - 34：您已修改登录密码，请重新登录 + /// - 35：您的登录态已失效，请重新登录 + /// - 36：您的密码已过期，请在登录页面通过忘记密码功能修改密码后重新登录 + /// 必填：否 + /// 示例值：34 + /// + [JsonPropertyName("logout_reason")] + public int? LogoutReason { get; set; } + + /// + /// 需要精确登出的 session 标识符，logout_type = 3 时必填 + /// 必填：否 + /// 示例值：AAAAAAAAAANll6nQoIAAFA== + /// + [JsonPropertyName("sid")] + public string? Sid { get; set; } +}