@satorijs/adapter-lark 3.9.1 → 3.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/lib/index.cjs +1077 -13
  2. package/lib/types/acs.d.ts +19 -19
  3. package/lib/types/admin.d.ts +58 -32
  4. package/lib/types/aily.d.ts +52 -52
  5. package/lib/types/apaas.d.ts +96 -96
  6. package/lib/types/application.d.ts +151 -67
  7. package/lib/types/approval.d.ts +182 -150
  8. package/lib/types/attendance.d.ts +395 -353
  9. package/lib/types/auth.d.ts +18 -18
  10. package/lib/types/authen.d.ts +24 -24
  11. package/lib/types/baike.d.ts +42 -42
  12. package/lib/types/bitable.d.ts +268 -184
  13. package/lib/types/calendar.d.ts +144 -144
  14. package/lib/types/cardkit.d.ts +8 -8
  15. package/lib/types/contact.d.ts +209 -137
  16. package/lib/types/corehr.d.ts +760 -620
  17. package/lib/types/document_ai.d.ts +68 -68
  18. package/lib/types/docx.d.ts +103 -95
  19. package/lib/types/drive.d.ts +236 -236
  20. package/lib/types/ehr.d.ts +26 -2
  21. package/lib/types/helpdesk.d.ts +155 -155
  22. package/lib/types/hire.d.ts +954 -510
  23. package/lib/types/im.d.ts +446 -446
  24. package/lib/types/index.d.ts +72 -30
  25. package/lib/types/lingo.d.ts +28 -28
  26. package/lib/types/mail.d.ts +192 -192
  27. package/lib/types/minutes.d.ts +4 -4
  28. package/lib/types/okr.d.ts +86 -58
  29. package/lib/types/passport.d.ts +13 -5
  30. package/lib/types/payroll.d.ts +13 -5
  31. package/lib/types/performance.d.ts +85 -79
  32. package/lib/types/personal_settings.d.ts +12 -12
  33. package/lib/types/report.d.ts +11 -5
  34. package/lib/types/search.d.ts +48 -24
  35. package/lib/types/sheets.d.ts +64 -64
  36. package/lib/types/speech_to_text.d.ts +4 -4
  37. package/lib/types/task.d.ts +191 -185
  38. package/lib/types/translation.d.ts +4 -4
  39. package/lib/types/vc.d.ts +335 -155
  40. package/lib/types/wiki.d.ts +48 -48
  41. package/package.json +1 -1
  42. package/src/internal.ts +1 -1
  43. package/src/types/acs.ts +24 -24
  44. package/src/types/admin.ts +69 -39
  45. package/src/types/aily.ts +61 -61
  46. package/src/types/apaas.ts +113 -113
  47. package/src/types/application.ts +173 -79
  48. package/src/types/approval.ts +202 -166
  49. package/src/types/attendance.ts +466 -421
  50. package/src/types/auth.ts +20 -20
  51. package/src/types/authen.ts +28 -28
  52. package/src/types/baike.ts +55 -55
  53. package/src/types/bitable.ts +305 -219
  54. package/src/types/calendar.ts +167 -167
  55. package/src/types/cardkit.ts +10 -10
  56. package/src/types/contact.ts +251 -169
  57. package/src/types/corehr.ts +903 -743
  58. package/src/types/document_ai.ts +85 -85
  59. package/src/types/docx.ts +117 -108
  60. package/src/types/drive.ts +298 -298
  61. package/src/types/ehr.ts +28 -2
  62. package/src/types/helpdesk.ts +181 -181
  63. package/src/types/hire.ts +1081 -591
  64. package/src/types/im.ts +521 -521
  65. package/src/types/index.ts +73 -30
  66. package/src/types/lingo.ts +36 -36
  67. package/src/types/mail.ts +215 -215
  68. package/src/types/minutes.ts +5 -5
  69. package/src/types/okr.ts +98 -66
  70. package/src/types/passport.ts +15 -6
  71. package/src/types/payroll.ts +15 -6
  72. package/src/types/performance.ts +98 -91
  73. package/src/types/personal_settings.ts +15 -15
  74. package/src/types/report.ts +13 -6
  75. package/src/types/search.ts +57 -29
  76. package/src/types/sheets.ts +80 -80
  77. package/src/types/speech_to_text.ts +5 -5
  78. package/src/types/task.ts +238 -231
  79. package/src/types/translation.ts +5 -5
  80. package/src/types/vc.ts +386 -186
  81. package/src/types/wiki.ts +59 -59
  82. package/src/utils.ts +11 -6
package/src/types/im.ts CHANGED
@@ -377,527 +377,6 @@ export interface CreateImMessageQuery {
377
377
  receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id'
378
378
  }
379
379
 
380
- export interface ReplyImMessageRequest {
381
- /** 消息内容 json 格式,格式说明参考: [发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */
382
- content: string
383
- /** 消息类型,包括:text、post、image、file、audio、media、sticker、interactive、share_card、share_user */
384
- msg_type: string
385
- /** 是否以话题形式回复;若群聊已经是话题模式,则自动回复该条消息所在的话题 */
386
- reply_in_thread?: boolean
387
- /** 由开发者生成的唯一字符串序列,用于回复消息请求去重;持有相同uuid的请求1小时内至多成功执行一次 */
388
- uuid?: string
389
- }
390
-
391
- export interface UpdateImMessageRequest {
392
- /** 消息的类型,仅支持文本(text)和富文本(post)类型 */
393
- msg_type: string
394
- /** 消息内容,JSON 格式 */
395
- content: string
396
- }
397
-
398
- export interface ForwardImMessageRequest {
399
- /** 依据receive_id_type的值,填写对应的转发目标的ID */
400
- receive_id: string
401
- }
402
-
403
- export interface ForwardImMessageQuery {
404
- /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
405
- receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id'
406
- /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
407
- uuid?: string
408
- }
409
-
410
- export interface MergeForwardImMessageRequest {
411
- /** 依据receive_id_type的值,填写对应的转发目标的ID */
412
- receive_id: string
413
- /** 要转发的消息ID列表 */
414
- message_id_list: string[]
415
- }
416
-
417
- export interface MergeForwardImMessageQuery {
418
- /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
419
- receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id'
420
- /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
421
- uuid?: string
422
- }
423
-
424
- export interface ForwardImThreadRequest {
425
- /** 依据receive_id_type的值,填写对应的转发目标的ID */
426
- receive_id: string
427
- }
428
-
429
- export interface ForwardImThreadQuery {
430
- /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id/thread_id */
431
- receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id'
432
- /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
433
- uuid?: string
434
- }
435
-
436
- export interface PushFollowUpImMessageRequest {
437
- /** follow up列表 */
438
- follow_ups: FollowUp[]
439
- }
440
-
441
- export interface ReadUsersImMessageQuery extends Pagination {
442
- /** 此次调用中使用的用户ID的类型 */
443
- user_id_type: 'user_id' | 'union_id' | 'open_id'
444
- }
445
-
446
- export interface ListImMessageQuery extends Pagination {
447
- /** 容器类型 ,目前可选值仅有"chat",包含单聊(p2p)和群聊(group) */
448
- container_id_type: string
449
- /** 容器的id,即chat的id,详情参见[群ID 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) */
450
- container_id: string
451
- /** 历史信息的起始时间(秒级时间戳) */
452
- start_time?: string
453
- /** 历史信息的结束时间(秒级时间戳) */
454
- end_time?: string
455
- /** 消息排序方式 */
456
- sort_type?: 'ByCreateTimeAsc' | 'ByCreateTimeDesc'
457
- }
458
-
459
- export interface GetImMessageResourceQuery {
460
- /** 资源类型,可选"image, file“; image对应消息中的 图片,富文本消息中的图片。 file对应消息中的 文件、音频、视频、(表情包除外) */
461
- type: string
462
- }
463
-
464
- export interface GetImMessageQuery {
465
- /** 此次调用中使用的用户ID的类型 */
466
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
467
- }
468
-
469
- export interface CreateImImageForm {
470
- /** 图片类型 */
471
- image_type: 'message' | 'avatar'
472
- /** 图片内容 **注意:** 上传的图片大小不能超过10MB */
473
- image: Blob
474
- }
475
-
476
- export interface CreateImFileForm {
477
- /** 文件类型 */
478
- file_type: 'opus' | 'mp4' | 'pdf' | 'doc' | 'xls' | 'ppt' | 'stream'
479
- /** 带后缀的文件名 */
480
- file_name: string
481
- /** 文件的时长(视频,音频),单位:毫秒。不填充时无法显示具体时长。 */
482
- duration?: number
483
- /** 文件内容 */
484
- file: Blob
485
- }
486
-
487
- export interface UrgentAppImMessageRequest {
488
- /** 该字段标识目标用户的id类型 */
489
- user_id_list: string[]
490
- }
491
-
492
- export interface UrgentAppImMessageQuery {
493
- /** 此次调用中使用的用户ID的类型 */
494
- user_id_type: 'user_id' | 'union_id' | 'open_id'
495
- }
496
-
497
- export interface UrgentSmsImMessageRequest {
498
- /** 该字段标识目标用户的id类型 */
499
- user_id_list: string[]
500
- }
501
-
502
- export interface UrgentSmsImMessageQuery {
503
- /** 此次调用中使用的用户ID的类型 */
504
- user_id_type: 'user_id' | 'union_id' | 'open_id'
505
- }
506
-
507
- export interface UrgentPhoneImMessageRequest {
508
- /** 该字段标识目标用户的id类型 */
509
- user_id_list: string[]
510
- }
511
-
512
- export interface UrgentPhoneImMessageQuery {
513
- /** 此次调用中使用的用户ID的类型 */
514
- user_id_type: 'user_id' | 'union_id' | 'open_id'
515
- }
516
-
517
- export interface CreateImMessageReactionRequest {
518
- /** reaction资源类型 */
519
- reaction_type: Emoji
520
- }
521
-
522
- export interface ListImMessageReactionQuery extends Pagination {
523
- /** 待查询消息reaction的类型[emoji类型列举](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)。- 不传入该参数,表示拉取所有类型reaction */
524
- reaction_type?: string
525
- /** 当操作人为用户时返回用户ID的类型 */
526
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
527
- }
528
-
529
- export interface CreateImPinRequest {
530
- /** 待Pin的消息ID */
531
- message_id: string
532
- }
533
-
534
- export interface ListImPinQuery extends Pagination {
535
- /** 待获取Pin消息的Chat ID */
536
- chat_id: string
537
- /** Pin信息的起始时间(毫秒级时间戳) */
538
- start_time?: string
539
- /** Pin信息的结束时间(毫秒级时间戳) */
540
- end_time?: string
541
- }
542
-
543
- export interface PatchImMessageRequest {
544
- /** 消息内容 json 格式,[发送消息 content 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json),参考文档中的卡片格式 */
545
- content: string
546
- }
547
-
548
- export interface BatchUpdateImUrlPreviewRequest {
549
- /** URL预览的token列表 */
550
- preview_tokens: string[]
551
- /** 需要更新URL预览的用户open_id。若不传,则默认更新URL所在会话成员;若用户不在URL所在会话,则无法更新该用户 */
552
- open_ids?: string[]
553
- }
554
-
555
- export interface CreateImChatRequest {
556
- /** 群头像对应的 Image Key,可通过[上传图片](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */
557
- avatar?: string
558
- /** 群名称 **注意:** 公开群名称的长度不得少于2个字符 */
559
- name?: string
560
- /** 群描述 */
561
- description?: string
562
- /** 群国际化名称 */
563
- i18n_names?: I18nNames
564
- /** 创建群时指定的群主,不填时指定建群的机器人为群主。群主 ID,ID值与查询参数中的 user_id_type 对应。不同 ID 的说明参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
565
- owner_id?: string
566
- /** 创建群时邀请的群成员,id 类型为 user_id_type */
567
- user_id_list?: string[]
568
- /** 创建群时邀请的群机器人 **注意:** 拉机器人入群请使用 ==app_id== */
569
- bot_id_list?: string[]
570
- /** 群消息模式 */
571
- group_message_type?: 'chat' | 'thread'
572
- /** 群模式**可选值有**:- `group`:群组 */
573
- chat_mode?: string
574
- /** 群类型**可选值有**:- `private`:私有群- `public`:公开群 */
575
- chat_type?: string
576
- /** 入群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */
577
- join_message_visibility?: string
578
- /** 退群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */
579
- leave_message_visibility?: string
580
- /** 加群审批**可选值有**:- `no_approval_required`:无需审批- `approval_required`:需要审批 */
581
- membership_approval?: string
582
- /** 防泄密模式设置 */
583
- restricted_mode_setting?: RestrictedModeSetting
584
- /** 谁可以加急 */
585
- urgent_setting?: 'only_owner' | 'all_members'
586
- /** 谁可以发起视频会议 */
587
- video_conference_setting?: 'only_owner' | 'all_members'
588
- /** 谁可以编辑群信息 */
589
- edit_permission?: 'only_owner' | 'all_members'
590
- /** 隐藏群成员人数设置 */
591
- hide_member_count_setting?: 'all_members' | 'only_owner'
592
- }
593
-
594
- export interface CreateImChatQuery {
595
- /** 此次调用中使用的用户ID的类型 */
596
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
597
- /** 如果选择了设置群主为指定用户,可以选择是否同时设置创建此群的机器人为管理员,此标志位用于标记是否设置创建群的机器人为管理员 */
598
- set_bot_manager?: boolean
599
- /** 由开发者生成的唯一字符串序列,用于创建群组请求去重;持有相同uuid的请求10小时内只可成功创建1个群聊 */
600
- uuid?: string
601
- }
602
-
603
- export interface UpdateImChatRequest {
604
- /** 群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */
605
- avatar?: string
606
- /** 群名称 */
607
- name?: string
608
- /** 群描述 */
609
- description?: string
610
- /** 群国际化名称 */
611
- i18n_names?: I18nNames
612
- /** 加 user/bot 入群权限(all_members/only_owner) */
613
- add_member_permission?: string
614
- /** 群分享权限(allowed/not_allowed) */
615
- share_card_permission?: string
616
- /** at 所有人权限(all_members/only_owner) */
617
- at_all_permission?: string
618
- /** 群编辑权限(all_members/only_owner) */
619
- edit_permission?: string
620
- /** 新群主 ID */
621
- owner_id?: string
622
- /** 入群消息可见性(only_owner/all_members/not_anyone) */
623
- join_message_visibility?: string
624
- /** 出群消息可见性(only_owner/all_members/not_anyone) */
625
- leave_message_visibility?: string
626
- /** 加群审批(no_approval_required/approval_required) */
627
- membership_approval?: string
628
- /** 防泄密模式设置 */
629
- restricted_mode_setting?: RestrictedModeSetting
630
- /** 群类型 */
631
- chat_type?: string
632
- /** 群消息模式 */
633
- group_message_type?: 'chat' | 'thread'
634
- /** 谁可以加急 */
635
- urgent_setting?: 'only_owner' | 'all_members'
636
- /** 谁可以发起视频会议 */
637
- video_conference_setting?: 'only_owner' | 'all_members'
638
- /** 隐藏群成员人数设置 */
639
- hide_member_count_setting?: 'all_members' | 'only_owner'
640
- }
641
-
642
- export interface UpdateImChatQuery {
643
- /** 此次调用中使用的用户ID的类型 */
644
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
645
- }
646
-
647
- export interface UpdateImChatModerationRequest {
648
- /** 群发言模式(all_members/only_owner/moderator_list,其中 moderator_list 表示部分用户可发言的模式) */
649
- moderation_setting?: string
650
- /** 选择部分用户可发言模式时,添加的可发言用户列表(自动过滤不在群内的用户) */
651
- moderator_added_list?: string[]
652
- /** 选择部分用户可发言模式时,移除的可发言用户列表(自动过滤不在群内的用户) */
653
- moderator_removed_list?: string[]
654
- }
655
-
656
- export interface UpdateImChatModerationQuery {
657
- /** 此次调用中使用的用户ID的类型 */
658
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
659
- }
660
-
661
- export interface GetImChatQuery {
662
- /** 此次调用中使用的用户ID的类型 */
663
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
664
- }
665
-
666
- export interface PutTopNoticeImChatTopNoticeRequest {
667
- /** 要进行发布的群置顶 */
668
- chat_top_notice: ChatTopNotice[]
669
- }
670
-
671
- export interface ListImChatQuery extends Pagination {
672
- /** 此次调用中使用的用户ID的类型 */
673
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
674
- /** 群组排序方式 */
675
- sort_type?: 'ByCreateTimeAsc' | 'ByActiveTimeDesc'
676
- }
677
-
678
- export interface SearchImChatQuery extends Pagination {
679
- /** 此次调用中使用的用户ID的类型 */
680
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
681
- /** 关键词。注意:如果query为空值将返回空的结果 */
682
- query?: string
683
- }
684
-
685
- export interface GetImChatModerationQuery extends Pagination {
686
- /** 此次调用中使用的用户ID的类型 */
687
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
688
- }
689
-
690
- export interface LinkImChatRequest {
691
- /** 群分享链接有效时长,可选值week、year、permanently,分别表示7天、1年以及永久有效 */
692
- validity_period?: 'week' | 'year' | 'permanently'
693
- }
694
-
695
- export interface AddManagersImChatManagersRequest {
696
- /** 要增加的 manager_id */
697
- manager_ids?: string[]
698
- }
699
-
700
- export interface AddManagersImChatManagersQuery {
701
- /** 群成员 id 类型 open_id/user_id/union_id/app_id */
702
- member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
703
- }
704
-
705
- export interface DeleteManagersImChatManagersRequest {
706
- /** 要删除的 manager_id */
707
- manager_ids?: string[]
708
- }
709
-
710
- export interface DeleteManagersImChatManagersQuery {
711
- /** 群成员 id 类型 open_id/user_id/union_id/app_id */
712
- member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
713
- }
714
-
715
- export interface CreateImChatMembersRequest {
716
- /** 成员列表<b>注意:</b>每次请求,最多拉50个用户或者5个机器人,并且群组最多容纳15个机器人 */
717
- id_list?: string[]
718
- }
719
-
720
- export interface CreateImChatMembersQuery {
721
- /** 进群成员 id 类型 open_id/user_id/union_id/app_id<b>注意:</b>拉机器人入群请使用 ==app_id== */
722
- member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
723
- /** 出现不可用ID后的处理方式 0/1/2 */
724
- succeed_type?: 0 | 1 | 2
725
- }
726
-
727
- export interface DeleteImChatMembersRequest {
728
- /** 成员列表 */
729
- id_list?: string[]
730
- }
731
-
732
- export interface DeleteImChatMembersQuery {
733
- /** 出群成员 id 类型 open_id/user_id/union_id/app_id */
734
- member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
735
- }
736
-
737
- export interface GetImChatMembersQuery extends Pagination {
738
- /** 群成员 用户 ID 类型,详情参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
739
- member_id_type?: 'user_id' | 'union_id' | 'open_id'
740
- }
741
-
742
- export interface PatchImChatAnnouncementRequest {
743
- /** 文档当前版本号 int64 类型,get 接口会返回 */
744
- revision: string
745
- /** 修改文档请求的序列化字段更新公告信息的格式和更新[云文档](/ssl:ttdoc/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同 */
746
- requests?: string[]
747
- }
748
-
749
- export interface GetImChatAnnouncementQuery {
750
- /** 此次调用中使用的用户ID的类型 */
751
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
752
- }
753
-
754
- export interface CreateImChatTabRequest {
755
- /** 会话标签页 */
756
- chat_tabs: ChatTab[]
757
- }
758
-
759
- export interface DeleteTabsImChatTabRequest {
760
- /** 会话标签页id列表 */
761
- tab_ids: string[]
762
- }
763
-
764
- export interface UpdateTabsImChatTabRequest {
765
- /** 会话标签页 */
766
- chat_tabs?: ChatTab[]
767
- }
768
-
769
- export interface SortTabsImChatTabRequest {
770
- /** 会话标签页ID列表 */
771
- tab_ids?: string[]
772
- }
773
-
774
- export interface CreateImChatMenuTreeRequest {
775
- /** 要向群内追加的菜单 */
776
- menu_tree: ChatMenuTree
777
- }
778
-
779
- export interface DeleteImChatMenuTreeRequest {
780
- /** 要删除的一级菜单ID列表 */
781
- chat_menu_top_level_ids: string[]
782
- }
783
-
784
- export interface PatchImChatMenuItemRequest {
785
- /** 修改的字段 */
786
- update_fields: ('ICON' | 'NAME' | 'I18N_NAME' | 'REDIRECT_LINK')[]
787
- /** 元信息 */
788
- chat_menu_item: ChatMenuItem
789
- }
790
-
791
- export interface SortImChatMenuTreeRequest {
792
- /** 一级菜单id列表 */
793
- chat_menu_top_level_ids: string[]
794
- }
795
-
796
- export interface CreateImAppFeedCardRequest {
797
- /** 应用消息卡片 */
798
- app_feed_card?: OpenAppFeedCard
799
- /** 用户 ID */
800
- user_ids?: string[]
801
- }
802
-
803
- export interface CreateImAppFeedCardQuery {
804
- /** 用户 ID 类型 */
805
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
806
- }
807
-
808
- export interface UpdateImAppFeedCardBatchRequest {
809
- /** 应用消息卡片 */
810
- feed_cards?: UserOpenAppFeedCardUpdater[]
811
- }
812
-
813
- export interface UpdateImAppFeedCardBatchQuery {
814
- /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
815
- user_id_type?: 'open_id' | 'user_id' | 'union_id'
816
- }
817
-
818
- export interface DeleteImAppFeedCardBatchRequest {
819
- /** 应用消息卡片 */
820
- feed_cards?: UserOpenAppFeedCardDeleter[]
821
- }
822
-
823
- export interface DeleteImAppFeedCardBatchQuery {
824
- /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
825
- user_id_type?: 'open_id' | 'user_id' | 'union_id'
826
- }
827
-
828
- export interface BotTimeSentiveImFeedCardRequest {
829
- /** 临时置顶状态,true-打开,false-关闭 */
830
- time_sensitive: boolean
831
- /** 用户id 列表 */
832
- user_ids: string[]
833
- }
834
-
835
- export interface BotTimeSentiveImFeedCardQuery {
836
- /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
837
- user_id_type: 'open_id' | 'user_id' | 'union_id'
838
- }
839
-
840
- export interface UpdateImChatButtonRequest {
841
- /** 用户 ID 列表 */
842
- user_ids?: string[]
843
- /** 群 ID */
844
- chat_id: string
845
- /** 按钮 */
846
- buttons?: OpenAppFeedCardButtons
847
- }
848
-
849
- export interface UpdateImChatButtonQuery {
850
- /** 用户 ID 类型 */
851
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
852
- }
853
-
854
- export interface PatchImFeedCardRequest {
855
- /** 临时置顶状态,true-打开,false-关闭 */
856
- time_sensitive: boolean
857
- /** 用户id 列表 */
858
- user_ids: string[]
859
- }
860
-
861
- export interface PatchImFeedCardQuery {
862
- /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
863
- user_id_type: 'open_id' | 'user_id' | 'union_id'
864
- }
865
-
866
- export interface GetImBizEntityTagRelationQuery {
867
- /** 业务类型 */
868
- tag_biz_type: 'chat'
869
- /** 业务实体id */
870
- biz_entity_id: string
871
- }
872
-
873
- export interface CreateImTagRequest {
874
- /** 创建标签 */
875
- create_tag: CreateTag
876
- }
877
-
878
- export interface PatchImTagRequest {
879
- /** 编辑标签 */
880
- patch_tag?: PatchTag
881
- }
882
-
883
- export interface CreateImBizEntityTagRelationRequest {
884
- /** 业务类型 */
885
- tag_biz_type: 'chat'
886
- /** 业务实体id */
887
- biz_entity_id: string
888
- /** 标签id */
889
- tag_ids?: string[]
890
- }
891
-
892
- export interface UpdateImBizEntityTagRelationRequest {
893
- /** 业务类型 */
894
- tag_biz_type: 'chat'
895
- /** 业务实体id */
896
- biz_entity_id: string
897
- /** 标签id */
898
- tag_ids?: string[]
899
- }
900
-
901
380
  export interface CreateImMessageResponse {
902
381
  /** 消息id open_message_id */
903
382
  message_id?: string
@@ -929,6 +408,17 @@ export interface CreateImMessageResponse {
929
408
  upper_message_id?: string
930
409
  }
931
410
 
411
+ export interface ReplyImMessageRequest {
412
+ /** 消息内容 json 格式,格式说明参考: [发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */
413
+ content: string
414
+ /** 消息类型,包括:text、post、image、file、audio、media、sticker、interactive、share_card、share_user */
415
+ msg_type: string
416
+ /** 是否以话题形式回复;若群聊已经是话题模式,则自动回复该条消息所在的话题 */
417
+ reply_in_thread?: boolean
418
+ /** 由开发者生成的唯一字符串序列,用于回复消息请求去重;持有相同uuid的请求1小时内至多成功执行一次 */
419
+ uuid?: string
420
+ }
421
+
932
422
  export interface ReplyImMessageResponse {
933
423
  /** 消息id open_message_id */
934
424
  message_id?: string
@@ -960,6 +450,13 @@ export interface ReplyImMessageResponse {
960
450
  upper_message_id?: string
961
451
  }
962
452
 
453
+ export interface UpdateImMessageRequest {
454
+ /** 消息的类型,仅支持文本(text)和富文本(post)类型 */
455
+ msg_type: string
456
+ /** 消息内容,JSON 格式 */
457
+ content: string
458
+ }
459
+
963
460
  export interface UpdateImMessageResponse {
964
461
  /** 消息id open_message_id */
965
462
  message_id?: string
@@ -991,6 +488,18 @@ export interface UpdateImMessageResponse {
991
488
  upper_message_id?: string
992
489
  }
993
490
 
491
+ export interface ForwardImMessageRequest {
492
+ /** 依据receive_id_type的值,填写对应的转发目标的ID */
493
+ receive_id: string
494
+ }
495
+
496
+ export interface ForwardImMessageQuery {
497
+ /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
498
+ receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id'
499
+ /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
500
+ uuid?: string
501
+ }
502
+
994
503
  export interface ForwardImMessageResponse {
995
504
  /** 消息id open_message_id */
996
505
  message_id?: string
@@ -1022,6 +531,20 @@ export interface ForwardImMessageResponse {
1022
531
  upper_message_id?: string
1023
532
  }
1024
533
 
534
+ export interface MergeForwardImMessageRequest {
535
+ /** 依据receive_id_type的值,填写对应的转发目标的ID */
536
+ receive_id: string
537
+ /** 要转发的消息ID列表 */
538
+ message_id_list: string[]
539
+ }
540
+
541
+ export interface MergeForwardImMessageQuery {
542
+ /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
543
+ receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id'
544
+ /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
545
+ uuid?: string
546
+ }
547
+
1025
548
  export interface MergeForwardImMessageResponse {
1026
549
  /** 合并转发生成的新消息 */
1027
550
  message?: Message
@@ -1029,6 +552,18 @@ export interface MergeForwardImMessageResponse {
1029
552
  invalid_message_id_list?: string[]
1030
553
  }
1031
554
 
555
+ export interface ForwardImThreadRequest {
556
+ /** 依据receive_id_type的值,填写对应的转发目标的ID */
557
+ receive_id: string
558
+ }
559
+
560
+ export interface ForwardImThreadQuery {
561
+ /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id/thread_id */
562
+ receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id'
563
+ /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
564
+ uuid?: string
565
+ }
566
+
1032
567
  export interface ForwardImThreadResponse {
1033
568
  /** 消息id open_message_id */
1034
569
  message_id?: string
@@ -1060,6 +595,39 @@ export interface ForwardImThreadResponse {
1060
595
  upper_message_id?: string
1061
596
  }
1062
597
 
598
+ export interface PushFollowUpImMessageRequest {
599
+ /** follow up列表 */
600
+ follow_ups: FollowUp[]
601
+ }
602
+
603
+ export interface ReadUsersImMessageQuery extends Pagination {
604
+ /** 此次调用中使用的用户ID的类型 */
605
+ user_id_type: 'user_id' | 'union_id' | 'open_id'
606
+ }
607
+
608
+ export interface ListImMessageQuery extends Pagination {
609
+ /** 容器类型 ,目前可选值仅有"chat",包含单聊(p2p)和群聊(group) */
610
+ container_id_type: string
611
+ /** 容器的id,即chat的id,详情参见[群ID 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) */
612
+ container_id: string
613
+ /** 历史信息的起始时间(秒级时间戳) */
614
+ start_time?: string
615
+ /** 历史信息的结束时间(秒级时间戳) */
616
+ end_time?: string
617
+ /** 消息排序方式 */
618
+ sort_type?: 'ByCreateTimeAsc' | 'ByCreateTimeDesc'
619
+ }
620
+
621
+ export interface GetImMessageResourceQuery {
622
+ /** 资源类型,可选"image, file“; image对应消息中的 图片,富文本消息中的图片。 file对应消息中的 文件、音频、视频、(表情包除外) */
623
+ type: string
624
+ }
625
+
626
+ export interface GetImMessageQuery {
627
+ /** 此次调用中使用的用户ID的类型 */
628
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
629
+ }
630
+
1063
631
  export interface GetImMessageResponse {
1064
632
  /** message[] */
1065
633
  items?: Message[]
@@ -1076,31 +644,84 @@ export interface GetProgressImBatchMessageResponse {
1076
644
  batch_message_recall_progress?: BatchMessageRecallProgress
1077
645
  }
1078
646
 
647
+ export interface CreateImImageForm {
648
+ /** 图片类型 */
649
+ image_type: 'message' | 'avatar'
650
+ /** 图片内容 **注意:** 上传的图片大小不能超过10MB */
651
+ image: Blob
652
+ }
653
+
1079
654
  export interface CreateImImageResponse {
1080
655
  /** 图片的key */
1081
656
  image_key?: string
1082
657
  }
1083
658
 
659
+ export interface CreateImFileForm {
660
+ /** 文件类型 */
661
+ file_type: 'opus' | 'mp4' | 'pdf' | 'doc' | 'xls' | 'ppt' | 'stream'
662
+ /** 带后缀的文件名 */
663
+ file_name: string
664
+ /** 文件的时长(视频,音频),单位:毫秒。不填充时无法显示具体时长。 */
665
+ duration?: number
666
+ /** 文件内容 */
667
+ file: Blob
668
+ }
669
+
1084
670
  export interface CreateImFileResponse {
1085
671
  /** 文件的key */
1086
672
  file_key?: string
1087
673
  }
1088
674
 
675
+ export interface UrgentAppImMessageRequest {
676
+ /** 该字段标识目标用户的id类型 */
677
+ user_id_list: string[]
678
+ }
679
+
680
+ export interface UrgentAppImMessageQuery {
681
+ /** 此次调用中使用的用户ID的类型 */
682
+ user_id_type: 'user_id' | 'union_id' | 'open_id'
683
+ }
684
+
1089
685
  export interface UrgentAppImMessageResponse {
1090
686
  /** 无效的用户id */
1091
687
  invalid_user_id_list: string[]
1092
688
  }
1093
689
 
690
+ export interface UrgentSmsImMessageRequest {
691
+ /** 该字段标识目标用户的id类型 */
692
+ user_id_list: string[]
693
+ }
694
+
695
+ export interface UrgentSmsImMessageQuery {
696
+ /** 此次调用中使用的用户ID的类型 */
697
+ user_id_type: 'user_id' | 'union_id' | 'open_id'
698
+ }
699
+
1094
700
  export interface UrgentSmsImMessageResponse {
1095
701
  /** 无效的用户id */
1096
702
  invalid_user_id_list: string[]
1097
703
  }
1098
704
 
705
+ export interface UrgentPhoneImMessageRequest {
706
+ /** 该字段标识目标用户的id类型 */
707
+ user_id_list: string[]
708
+ }
709
+
710
+ export interface UrgentPhoneImMessageQuery {
711
+ /** 此次调用中使用的用户ID的类型 */
712
+ user_id_type: 'user_id' | 'union_id' | 'open_id'
713
+ }
714
+
1099
715
  export interface UrgentPhoneImMessageResponse {
1100
716
  /** 无效的用户id */
1101
717
  invalid_user_id_list: string[]
1102
718
  }
1103
719
 
720
+ export interface CreateImMessageReactionRequest {
721
+ /** reaction资源类型 */
722
+ reaction_type: Emoji
723
+ }
724
+
1104
725
  export interface CreateImMessageReactionResponse {
1105
726
  /** reaction资源ID */
1106
727
  reaction_id?: string
@@ -1112,6 +733,13 @@ export interface CreateImMessageReactionResponse {
1112
733
  reaction_type?: Emoji
1113
734
  }
1114
735
 
736
+ export interface ListImMessageReactionQuery extends Pagination {
737
+ /** 待查询消息reaction的类型[emoji类型列举](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)。- 不传入该参数,表示拉取所有类型reaction */
738
+ reaction_type?: string
739
+ /** 当操作人为用户时返回用户ID的类型 */
740
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
741
+ }
742
+
1115
743
  export interface DeleteImMessageReactionResponse {
1116
744
  /** reaction资源ID */
1117
745
  reaction_id?: string
@@ -1123,10 +751,84 @@ export interface DeleteImMessageReactionResponse {
1123
751
  reaction_type?: Emoji
1124
752
  }
1125
753
 
754
+ export interface CreateImPinRequest {
755
+ /** 待Pin的消息ID */
756
+ message_id: string
757
+ }
758
+
1126
759
  export interface CreateImPinResponse {
1127
760
  pin?: Pin
1128
761
  }
1129
762
 
763
+ export interface ListImPinQuery extends Pagination {
764
+ /** 待获取Pin消息的Chat ID */
765
+ chat_id: string
766
+ /** Pin信息的起始时间(毫秒级时间戳) */
767
+ start_time?: string
768
+ /** Pin信息的结束时间(毫秒级时间戳) */
769
+ end_time?: string
770
+ }
771
+
772
+ export interface PatchImMessageRequest {
773
+ /** 消息内容 json 格式,[发送消息 content 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json),参考文档中的卡片格式 */
774
+ content: string
775
+ }
776
+
777
+ export interface BatchUpdateImUrlPreviewRequest {
778
+ /** URL预览的token列表 */
779
+ preview_tokens: string[]
780
+ /** 需要更新URL预览的用户open_id。若不传,则默认更新URL所在会话成员;若用户不在URL所在会话,则无法更新该用户 */
781
+ open_ids?: string[]
782
+ }
783
+
784
+ export interface CreateImChatRequest {
785
+ /** 群头像对应的 Image Key,可通过[上传图片](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */
786
+ avatar?: string
787
+ /** 群名称 **注意:** 公开群名称的长度不得少于2个字符 */
788
+ name?: string
789
+ /** 群描述 */
790
+ description?: string
791
+ /** 群国际化名称 */
792
+ i18n_names?: I18nNames
793
+ /** 创建群时指定的群主,不填时指定建群的机器人为群主。群主 ID,ID值与查询参数中的 user_id_type 对应。不同 ID 的说明参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
794
+ owner_id?: string
795
+ /** 创建群时邀请的群成员,id 类型为 user_id_type */
796
+ user_id_list?: string[]
797
+ /** 创建群时邀请的群机器人 **注意:** 拉机器人入群请使用 ==app_id== */
798
+ bot_id_list?: string[]
799
+ /** 群消息模式 */
800
+ group_message_type?: 'chat' | 'thread'
801
+ /** 群模式**可选值有**:- `group`:群组 */
802
+ chat_mode?: string
803
+ /** 群类型**可选值有**:- `private`:私有群- `public`:公开群 */
804
+ chat_type?: string
805
+ /** 入群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */
806
+ join_message_visibility?: string
807
+ /** 退群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */
808
+ leave_message_visibility?: string
809
+ /** 加群审批**可选值有**:- `no_approval_required`:无需审批- `approval_required`:需要审批 */
810
+ membership_approval?: string
811
+ /** 防泄密模式设置 */
812
+ restricted_mode_setting?: RestrictedModeSetting
813
+ /** 谁可以加急 */
814
+ urgent_setting?: 'only_owner' | 'all_members'
815
+ /** 谁可以发起视频会议 */
816
+ video_conference_setting?: 'only_owner' | 'all_members'
817
+ /** 谁可以编辑群信息 */
818
+ edit_permission?: 'only_owner' | 'all_members'
819
+ /** 隐藏群成员人数设置 */
820
+ hide_member_count_setting?: 'all_members' | 'only_owner'
821
+ }
822
+
823
+ export interface CreateImChatQuery {
824
+ /** 此次调用中使用的用户ID的类型 */
825
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
826
+ /** 如果选择了设置群主为指定用户,可以选择是否同时设置创建此群的机器人为管理员,此标志位用于标记是否设置创建群的机器人为管理员 */
827
+ set_bot_manager?: boolean
828
+ /** 由开发者生成的唯一字符串序列,用于创建群组请求去重;持有相同uuid的请求10小时内只可成功创建1个群聊 */
829
+ uuid?: string
830
+ }
831
+
1130
832
  export interface CreateImChatResponse {
1131
833
  /** 群ID */
1132
834
  chat_id?: string
@@ -1180,6 +882,69 @@ export interface CreateImChatResponse {
1180
882
  hide_member_count_setting?: 'all_members' | 'only_owner'
1181
883
  }
1182
884
 
885
+ export interface UpdateImChatRequest {
886
+ /** 群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */
887
+ avatar?: string
888
+ /** 群名称 */
889
+ name?: string
890
+ /** 群描述 */
891
+ description?: string
892
+ /** 群国际化名称 */
893
+ i18n_names?: I18nNames
894
+ /** 加 user/bot 入群权限(all_members/only_owner) */
895
+ add_member_permission?: string
896
+ /** 群分享权限(allowed/not_allowed) */
897
+ share_card_permission?: string
898
+ /** at 所有人权限(all_members/only_owner) */
899
+ at_all_permission?: string
900
+ /** 群编辑权限(all_members/only_owner) */
901
+ edit_permission?: string
902
+ /** 新群主 ID */
903
+ owner_id?: string
904
+ /** 入群消息可见性(only_owner/all_members/not_anyone) */
905
+ join_message_visibility?: string
906
+ /** 出群消息可见性(only_owner/all_members/not_anyone) */
907
+ leave_message_visibility?: string
908
+ /** 加群审批(no_approval_required/approval_required) */
909
+ membership_approval?: string
910
+ /** 防泄密模式设置 */
911
+ restricted_mode_setting?: RestrictedModeSetting
912
+ /** 群类型 */
913
+ chat_type?: string
914
+ /** 群消息模式 */
915
+ group_message_type?: 'chat' | 'thread'
916
+ /** 谁可以加急 */
917
+ urgent_setting?: 'only_owner' | 'all_members'
918
+ /** 谁可以发起视频会议 */
919
+ video_conference_setting?: 'only_owner' | 'all_members'
920
+ /** 隐藏群成员人数设置 */
921
+ hide_member_count_setting?: 'all_members' | 'only_owner'
922
+ }
923
+
924
+ export interface UpdateImChatQuery {
925
+ /** 此次调用中使用的用户ID的类型 */
926
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
927
+ }
928
+
929
+ export interface UpdateImChatModerationRequest {
930
+ /** 群发言模式(all_members/only_owner/moderator_list,其中 moderator_list 表示部分用户可发言的模式) */
931
+ moderation_setting?: string
932
+ /** 选择部分用户可发言模式时,添加的可发言用户列表(自动过滤不在群内的用户) */
933
+ moderator_added_list?: string[]
934
+ /** 选择部分用户可发言模式时,移除的可发言用户列表(自动过滤不在群内的用户) */
935
+ moderator_removed_list?: string[]
936
+ }
937
+
938
+ export interface UpdateImChatModerationQuery {
939
+ /** 此次调用中使用的用户ID的类型 */
940
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
941
+ }
942
+
943
+ export interface GetImChatQuery {
944
+ /** 此次调用中使用的用户ID的类型 */
945
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
946
+ }
947
+
1183
948
  export interface GetImChatResponse {
1184
949
  /** 群头像URL */
1185
950
  avatar?: string
@@ -1241,6 +1006,30 @@ export interface GetImChatResponse {
1241
1006
  chat_status?: 'normal' | 'dissolved' | 'dissolved_save'
1242
1007
  }
1243
1008
 
1009
+ export interface PutTopNoticeImChatTopNoticeRequest {
1010
+ /** 要进行发布的群置顶 */
1011
+ chat_top_notice: ChatTopNotice[]
1012
+ }
1013
+
1014
+ export interface ListImChatQuery extends Pagination {
1015
+ /** 此次调用中使用的用户ID的类型 */
1016
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
1017
+ /** 群组排序方式 */
1018
+ sort_type?: 'ByCreateTimeAsc' | 'ByActiveTimeDesc'
1019
+ }
1020
+
1021
+ export interface SearchImChatQuery extends Pagination {
1022
+ /** 此次调用中使用的用户ID的类型 */
1023
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
1024
+ /** 关键词。注意:如果query为空值将返回空的结果 */
1025
+ query?: string
1026
+ }
1027
+
1028
+ export interface GetImChatModerationQuery extends Pagination {
1029
+ /** 此次调用中使用的用户ID的类型 */
1030
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
1031
+ }
1032
+
1244
1033
  export interface GetImChatModerationResponse {
1245
1034
  /** 群发言模式 */
1246
1035
  moderation_setting?: string
@@ -1252,6 +1041,11 @@ export interface GetImChatModerationResponse {
1252
1041
  items?: ListModerator[]
1253
1042
  }
1254
1043
 
1044
+ export interface LinkImChatRequest {
1045
+ /** 群分享链接有效时长,可选值week、year、permanently,分别表示7天、1年以及永久有效 */
1046
+ validity_period?: 'week' | 'year' | 'permanently'
1047
+ }
1048
+
1255
1049
  export interface LinkImChatResponse {
1256
1050
  /** 群分享链接 */
1257
1051
  share_link?: string
@@ -1261,6 +1055,16 @@ export interface LinkImChatResponse {
1261
1055
  is_permanent?: boolean
1262
1056
  }
1263
1057
 
1058
+ export interface AddManagersImChatManagersRequest {
1059
+ /** 要增加的 manager_id */
1060
+ manager_ids?: string[]
1061
+ }
1062
+
1063
+ export interface AddManagersImChatManagersQuery {
1064
+ /** 群成员 id 类型 open_id/user_id/union_id/app_id */
1065
+ member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1066
+ }
1067
+
1264
1068
  export interface AddManagersImChatManagersResponse {
1265
1069
  /** 群目前的管理员id */
1266
1070
  chat_managers?: string[]
@@ -1268,6 +1072,16 @@ export interface AddManagersImChatManagersResponse {
1268
1072
  chat_bot_managers?: string[]
1269
1073
  }
1270
1074
 
1075
+ export interface DeleteManagersImChatManagersRequest {
1076
+ /** 要删除的 manager_id */
1077
+ manager_ids?: string[]
1078
+ }
1079
+
1080
+ export interface DeleteManagersImChatManagersQuery {
1081
+ /** 群成员 id 类型 open_id/user_id/union_id/app_id */
1082
+ member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1083
+ }
1084
+
1271
1085
  export interface DeleteManagersImChatManagersResponse {
1272
1086
  /** 群目前的管理员id */
1273
1087
  chat_managers?: string[]
@@ -1275,6 +1089,18 @@ export interface DeleteManagersImChatManagersResponse {
1275
1089
  chat_bot_managers?: string[]
1276
1090
  }
1277
1091
 
1092
+ export interface CreateImChatMembersRequest {
1093
+ /** 成员列表<b>注意:</b>每次请求,最多拉50个用户或者5个机器人,并且群组最多容纳15个机器人 */
1094
+ id_list?: string[]
1095
+ }
1096
+
1097
+ export interface CreateImChatMembersQuery {
1098
+ /** 进群成员 id 类型 open_id/user_id/union_id/app_id<b>注意:</b>拉机器人入群请使用 ==app_id== */
1099
+ member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1100
+ /** 出现不可用ID后的处理方式 0/1/2 */
1101
+ succeed_type?: 0 | 1 | 2
1102
+ }
1103
+
1278
1104
  export interface CreateImChatMembersResponse {
1279
1105
  /** ID无效的成员列表 */
1280
1106
  invalid_id_list?: string[]
@@ -1284,11 +1110,26 @@ export interface CreateImChatMembersResponse {
1284
1110
  pending_approval_id_list?: string[]
1285
1111
  }
1286
1112
 
1113
+ export interface DeleteImChatMembersRequest {
1114
+ /** 成员列表 */
1115
+ id_list?: string[]
1116
+ }
1117
+
1118
+ export interface DeleteImChatMembersQuery {
1119
+ /** 出群成员 id 类型 open_id/user_id/union_id/app_id */
1120
+ member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1121
+ }
1122
+
1287
1123
  export interface DeleteImChatMembersResponse {
1288
1124
  /** 无效成员列表 */
1289
1125
  invalid_id_list?: string[]
1290
1126
  }
1291
1127
 
1128
+ export interface GetImChatMembersQuery extends Pagination {
1129
+ /** 群成员 用户 ID 类型,详情参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
1130
+ member_id_type?: 'user_id' | 'union_id' | 'open_id'
1131
+ }
1132
+
1292
1133
  export interface GetImChatMembersResponse {
1293
1134
  /** member列表 */
1294
1135
  items?: ListMember[]
@@ -1305,6 +1146,18 @@ export interface IsInChatImChatMembersResponse {
1305
1146
  is_in_chat?: boolean
1306
1147
  }
1307
1148
 
1149
+ export interface PatchImChatAnnouncementRequest {
1150
+ /** 文档当前版本号 int64 类型,get 接口会返回 */
1151
+ revision: string
1152
+ /** 修改文档请求的序列化字段更新公告信息的格式和更新[云文档](/ssl:ttdoc/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同 */
1153
+ requests?: string[]
1154
+ }
1155
+
1156
+ export interface GetImChatAnnouncementQuery {
1157
+ /** 此次调用中使用的用户ID的类型 */
1158
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
1159
+ }
1160
+
1308
1161
  export interface GetImChatAnnouncementResponse {
1309
1162
  /** CCM 文档序列化信息 */
1310
1163
  content?: string
@@ -1324,21 +1177,41 @@ export interface GetImChatAnnouncementResponse {
1324
1177
  modifier_id?: string
1325
1178
  }
1326
1179
 
1180
+ export interface CreateImChatTabRequest {
1181
+ /** 会话标签页 */
1182
+ chat_tabs: ChatTab[]
1183
+ }
1184
+
1327
1185
  export interface CreateImChatTabResponse {
1328
1186
  /** 群标签列表 */
1329
1187
  chat_tabs?: ChatTab[]
1330
1188
  }
1331
1189
 
1190
+ export interface DeleteTabsImChatTabRequest {
1191
+ /** 会话标签页id列表 */
1192
+ tab_ids: string[]
1193
+ }
1194
+
1332
1195
  export interface DeleteTabsImChatTabResponse {
1333
1196
  /** 群标签列表 */
1334
1197
  chat_tabs?: ChatTab[]
1335
1198
  }
1336
1199
 
1200
+ export interface UpdateTabsImChatTabRequest {
1201
+ /** 会话标签页 */
1202
+ chat_tabs?: ChatTab[]
1203
+ }
1204
+
1337
1205
  export interface UpdateTabsImChatTabResponse {
1338
1206
  /** 群标签列表 */
1339
1207
  chat_tabs?: ChatTab[]
1340
1208
  }
1341
1209
 
1210
+ export interface SortTabsImChatTabRequest {
1211
+ /** 会话标签页ID列表 */
1212
+ tab_ids?: string[]
1213
+ }
1214
+
1342
1215
  export interface SortTabsImChatTabResponse {
1343
1216
  /** 群标签列表 */
1344
1217
  chat_tabs?: ChatTab[]
@@ -1349,20 +1222,42 @@ export interface ListTabsImChatTabResponse {
1349
1222
  chat_tabs?: ChatTab[]
1350
1223
  }
1351
1224
 
1225
+ export interface CreateImChatMenuTreeRequest {
1226
+ /** 要向群内追加的菜单 */
1227
+ menu_tree: ChatMenuTree
1228
+ }
1229
+
1352
1230
  export interface CreateImChatMenuTreeResponse {
1353
1231
  /** 追加后群内现有菜单 */
1354
1232
  menu_tree?: ChatMenuTree
1355
1233
  }
1356
1234
 
1235
+ export interface DeleteImChatMenuTreeRequest {
1236
+ /** 要删除的一级菜单ID列表 */
1237
+ chat_menu_top_level_ids: string[]
1238
+ }
1239
+
1357
1240
  export interface DeleteImChatMenuTreeResponse {
1358
1241
  /** 群内现有菜单 */
1359
1242
  menu_tree?: ChatMenuTree
1360
1243
  }
1361
1244
 
1245
+ export interface PatchImChatMenuItemRequest {
1246
+ /** 修改的字段 */
1247
+ update_fields: ('ICON' | 'NAME' | 'I18N_NAME' | 'REDIRECT_LINK')[]
1248
+ /** 元信息 */
1249
+ chat_menu_item: ChatMenuItem
1250
+ }
1251
+
1362
1252
  export interface PatchImChatMenuItemResponse {
1363
1253
  chat_menu_item?: ChatMenuItem
1364
1254
  }
1365
1255
 
1256
+ export interface SortImChatMenuTreeRequest {
1257
+ /** 一级菜单id列表 */
1258
+ chat_menu_top_level_ids: string[]
1259
+ }
1260
+
1366
1261
  export interface SortImChatMenuTreeResponse {
1367
1262
  /** 排序后群内菜单 */
1368
1263
  menu_tree?: ChatMenuTree
@@ -1373,6 +1268,18 @@ export interface GetImChatMenuTreeResponse {
1373
1268
  menu_tree?: ChatMenuTree
1374
1269
  }
1375
1270
 
1271
+ export interface CreateImAppFeedCardRequest {
1272
+ /** 应用消息卡片 */
1273
+ app_feed_card?: OpenAppFeedCard
1274
+ /** 用户 ID */
1275
+ user_ids?: string[]
1276
+ }
1277
+
1278
+ export interface CreateImAppFeedCardQuery {
1279
+ /** 用户 ID 类型 */
1280
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
1281
+ }
1282
+
1376
1283
  export interface CreateImAppFeedCardResponse {
1377
1284
  /** 失败的卡片 */
1378
1285
  failed_cards?: OpenFailedUserAppFeedCardItem[]
@@ -1380,36 +1287,106 @@ export interface CreateImAppFeedCardResponse {
1380
1287
  biz_id?: string
1381
1288
  }
1382
1289
 
1290
+ export interface UpdateImAppFeedCardBatchRequest {
1291
+ /** 应用消息卡片 */
1292
+ feed_cards?: UserOpenAppFeedCardUpdater[]
1293
+ }
1294
+
1295
+ export interface UpdateImAppFeedCardBatchQuery {
1296
+ /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1297
+ user_id_type?: 'open_id' | 'user_id' | 'union_id'
1298
+ }
1299
+
1383
1300
  export interface UpdateImAppFeedCardBatchResponse {
1384
1301
  /** 失败的卡片 */
1385
1302
  failed_cards?: OpenFailedUserAppFeedCardItem[]
1386
1303
  }
1387
1304
 
1305
+ export interface DeleteImAppFeedCardBatchRequest {
1306
+ /** 应用消息卡片 */
1307
+ feed_cards?: UserOpenAppFeedCardDeleter[]
1308
+ }
1309
+
1310
+ export interface DeleteImAppFeedCardBatchQuery {
1311
+ /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1312
+ user_id_type?: 'open_id' | 'user_id' | 'union_id'
1313
+ }
1314
+
1388
1315
  export interface DeleteImAppFeedCardBatchResponse {
1389
1316
  /** 失败的卡片 */
1390
1317
  failed_cards?: OpenFailedUserAppFeedCardItem[]
1391
1318
  }
1392
1319
 
1320
+ export interface BotTimeSentiveImFeedCardRequest {
1321
+ /** 临时置顶状态,true-打开,false-关闭 */
1322
+ time_sensitive: boolean
1323
+ /** 用户id 列表 */
1324
+ user_ids: string[]
1325
+ }
1326
+
1327
+ export interface BotTimeSentiveImFeedCardQuery {
1328
+ /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1329
+ user_id_type: 'open_id' | 'user_id' | 'union_id'
1330
+ }
1331
+
1393
1332
  export interface BotTimeSentiveImFeedCardResponse {
1394
1333
  /** 失败原因 */
1395
1334
  failed_user_reasons?: FailedReason[]
1396
1335
  }
1397
1336
 
1337
+ export interface UpdateImChatButtonRequest {
1338
+ /** 用户 ID 列表 */
1339
+ user_ids?: string[]
1340
+ /** 群 ID */
1341
+ chat_id: string
1342
+ /** 按钮 */
1343
+ buttons?: OpenAppFeedCardButtons
1344
+ }
1345
+
1346
+ export interface UpdateImChatButtonQuery {
1347
+ /** 用户 ID 类型 */
1348
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
1349
+ }
1350
+
1398
1351
  export interface UpdateImChatButtonResponse {
1399
1352
  /** 失败的用户 */
1400
1353
  failed_user_reasons?: FailedReason[]
1401
1354
  }
1402
1355
 
1356
+ export interface PatchImFeedCardRequest {
1357
+ /** 临时置顶状态,true-打开,false-关闭 */
1358
+ time_sensitive: boolean
1359
+ /** 用户id 列表 */
1360
+ user_ids: string[]
1361
+ }
1362
+
1363
+ export interface PatchImFeedCardQuery {
1364
+ /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1365
+ user_id_type: 'open_id' | 'user_id' | 'union_id'
1366
+ }
1367
+
1403
1368
  export interface PatchImFeedCardResponse {
1404
1369
  /** 失败原因 */
1405
1370
  failed_user_reasons?: FailedReason[]
1406
1371
  }
1407
1372
 
1373
+ export interface GetImBizEntityTagRelationQuery {
1374
+ /** 业务类型 */
1375
+ tag_biz_type: 'chat'
1376
+ /** 业务实体id */
1377
+ biz_entity_id: string
1378
+ }
1379
+
1408
1380
  export interface GetImBizEntityTagRelationResponse {
1409
1381
  /** 标签内容及绑定时间 */
1410
1382
  tag_info_with_bind_versions?: TagInfoWithBindVersion[]
1411
1383
  }
1412
1384
 
1385
+ export interface CreateImTagRequest {
1386
+ /** 创建标签 */
1387
+ create_tag: CreateTag
1388
+ }
1389
+
1413
1390
  export interface CreateImTagResponse {
1414
1391
  /** 创建的tagid */
1415
1392
  id?: string
@@ -1417,6 +1394,11 @@ export interface CreateImTagResponse {
1417
1394
  create_tag_fail_reason?: CreateTagFailReason
1418
1395
  }
1419
1396
 
1397
+ export interface PatchImTagRequest {
1398
+ /** 编辑标签 */
1399
+ patch_tag?: PatchTag
1400
+ }
1401
+
1420
1402
  export interface PatchImTagResponse {
1421
1403
  /** 编辑后的taginfo */
1422
1404
  tag_info?: TagInfo
@@ -1424,6 +1406,24 @@ export interface PatchImTagResponse {
1424
1406
  patch_tag_fail_reason?: PatchTagFailReason
1425
1407
  }
1426
1408
 
1409
+ export interface CreateImBizEntityTagRelationRequest {
1410
+ /** 业务类型 */
1411
+ tag_biz_type: 'chat'
1412
+ /** 业务实体id */
1413
+ biz_entity_id: string
1414
+ /** 标签id */
1415
+ tag_ids?: string[]
1416
+ }
1417
+
1418
+ export interface UpdateImBizEntityTagRelationRequest {
1419
+ /** 业务类型 */
1420
+ tag_biz_type: 'chat'
1421
+ /** 业务实体id */
1422
+ biz_entity_id: string
1423
+ /** 标签id */
1424
+ tag_ids?: string[]
1425
+ }
1426
+
1427
1427
  Internal.define({
1428
1428
  '/im/v1/messages': {
1429
1429
  POST: 'createImMessage',