├── .commitlintrc.js
├── .eslintignore
├── .eslintrc.js
├── .github
└── workflows
│ ├── issues.yml
│ ├── pr-merged.yml
│ └── pr-open-check.yml
├── .gitignore
├── .gitpod.yml
├── .husky
├── commit-msg
└── pre-commit
├── .prettierrc
├── .remarkignore
├── .remarkrc
├── .textlintignore
├── .textlintrc.js
├── Dockerfile
├── License
├── README.md
├── docs
├── .vuepress
│ ├── common.js
│ ├── components
│ │ ├── MySWUpdatePopup.vue
│ │ ├── NpmBadge.vue
│ │ ├── PrivateDomain.vue
│ │ ├── Qrcode.vue
│ │ └── TuXiaoChao.vue
│ ├── config.js
│ ├── enhanceApp.js
│ ├── plugins
│ │ ├── plugin-active-header-links
│ │ │ ├── clientRootMixin.js
│ │ │ └── index.js
│ │ └── vuepress-plugin-contributors
│ │ │ ├── Contributors.vue
│ │ │ ├── README.md
│ │ │ ├── enhanceAppFile.js
│ │ │ ├── index.js
│ │ │ └── screenshot.png
│ ├── public
│ │ ├── favicon-32px.png
│ │ ├── favicon-64px.png
│ │ ├── favicon.ico
│ │ ├── favicon.png
│ │ └── images
│ │ │ ├── api-231017
│ │ │ ├── 23.png
│ │ │ ├── 24.png
│ │ │ ├── 37.png
│ │ │ ├── chat-c2c.jpg
│ │ │ ├── chat-group.jpg
│ │ │ ├── chat-single.jpg
│ │ │ ├── chat-text-channel.jpg
│ │ │ ├── command-banner-1.jpg
│ │ │ ├── command-banner-2.jpg
│ │ │ ├── custum-menu.jpg
│ │ │ ├── error.png
│ │ │ ├── event_subscription.png
│ │ │ ├── feedback_bot.png
│ │ │ ├── interface-base-framework.png
│ │ │ ├── interface-framework.png
│ │ │ ├── message-btn.jpg
│ │ │ ├── message-embed.jpg
│ │ │ ├── post_api_permission_demand.png
│ │ │ ├── qqrobot-feedback.jpg
│ │ │ └── text-chain.jpg
│ │ │ ├── introduce
│ │ │ ├── Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.001.png
│ │ │ ├── Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.002.png
│ │ │ ├── Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.003.jpeg
│ │ │ ├── Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.004.png
│ │ │ ├── Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.004_1.jpeg
│ │ │ ├── Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.005.png
│ │ │ ├── Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.006.png
│ │ │ ├── Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.008.png
│ │ │ ├── Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.009.png
│ │ │ ├── Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.010.png
│ │ │ ├── Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.011.png
│ │ │ ├── Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.012.png
│ │ │ ├── Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.013.png
│ │ │ ├── account.png
│ │ │ ├── add_robot_to_sandbox_1.png
│ │ │ ├── add_robot_to_sandbox_2.png
│ │ │ ├── add_sandbox_c2c_list.png
│ │ │ ├── add_to_sandbox_group_1.png
│ │ │ ├── add_to_sandbox_group_2.png
│ │ │ ├── audit.png
│ │ │ ├── auth.png
│ │ │ ├── bot_add_robot_to_sandbox.png
│ │ │ ├── bot_add_to_sandbox_group_2.png
│ │ │ ├── bot_base_info_set.png
│ │ │ ├── bot_baseinfo_set.png
│ │ │ ├── bot_func_config_command.png
│ │ │ ├── bot_func_config_selftest_report.png
│ │ │ ├── bot_func_config_selftest_report_2.png
│ │ │ ├── bot_func_config_server.png
│ │ │ ├── bot_func_config_shortcut.png
│ │ │ ├── bot_func_config_shortcut_com.png
│ │ │ ├── bot_func_config_shortcut_server.png
│ │ │ ├── bot_publish_process.png
│ │ │ ├── bot_pulish_set.png
│ │ │ ├── bot_sandbox_set.png
│ │ │ ├── bot_scope_manage.png
│ │ │ ├── bot_scope_set.png
│ │ │ ├── callback-info-url.png
│ │ │ ├── callback_url.png
│ │ │ ├── channel_user_feedback.png
│ │ │ ├── choice-body.png
│ │ │ ├── config.png
│ │ │ ├── create-robot.png
│ │ │ ├── feedback.png
│ │ │ ├── finish-register.png
│ │ │ ├── info_url_white_set.png
│ │ │ ├── ip_white_list.png
│ │ │ ├── join_c2c_sandbox.png
│ │ │ ├── mail.png
│ │ │ ├── manager.png
│ │ │ ├── open_platform_audit.png
│ │ │ ├── open_platform_audit_detail.png
│ │ │ ├── open_platform_bind_manager.png
│ │ │ ├── open_platform_bot_list.png
│ │ │ ├── open_platform_certificate_detail.png
│ │ │ ├── open_platform_choose_business.png
│ │ │ ├── open_platform_choose_individual.png
│ │ │ ├── open_platform_create_app.png
│ │ │ ├── open_platform_individual_bind_manager.png
│ │ │ ├── open_platform_individual_mail.png
│ │ │ ├── open_platform_individual_mail_active.png
│ │ │ ├── open_platform_individual_register.png
│ │ │ ├── open_platform_individual_step.png
│ │ │ ├── open_platform_mail.png
│ │ │ ├── open_platform_mail_active.png
│ │ │ ├── open_platform_miniapp_certificate.png
│ │ │ ├── open_platform_miniapp_info.png
│ │ │ ├── open_platform_register.png
│ │ │ ├── open_platform_robot_info.png
│ │ │ ├── open_platform_robot_info_231017.png
│ │ │ ├── open_platform_step.png
│ │ │ ├── open_platform_upload_business.png
│ │ │ ├── permission_manage.png
│ │ │ ├── robot_appid.png
│ │ │ └── sandbox_set.png
│ │ │ ├── newfeature
│ │ │ ├── eleven
│ │ │ │ ├── all_domain_1.png
│ │ │ │ ├── all_domain_2.png
│ │ │ │ ├── customize_pub_scope.png
│ │ │ │ ├── func_preview.png
│ │ │ │ ├── join_process_manage.png
│ │ │ │ └── mutiple_scene.png
│ │ │ ├── five
│ │ │ │ ├── add_channel_permission.jpg
│ │ │ │ ├── ark_template.jpg
│ │ │ │ ├── channel_permission_1.jpg
│ │ │ │ ├── channel_permission_2.jpg
│ │ │ │ ├── channel_permission_obj_1.jpg
│ │ │ │ ├── channel_permission_obj_2.jpg
│ │ │ │ ├── channel_sub_type.jpg
│ │ │ │ ├── default_roles_after.jpg
│ │ │ │ ├── default_roles_before.jpg
│ │ │ │ ├── message_format.jpg
│ │ │ │ ├── put_guild_member_role.jpg
│ │ │ │ └── remove_channel_permission.jpg
│ │ │ ├── nine
│ │ │ │ ├── add_blacklist.jpg
│ │ │ │ ├── create_channel.jpg
│ │ │ │ ├── emoji_iframe.jpg
│ │ │ │ ├── emot.jpg
│ │ │ │ ├── function_config_directive.jpg
│ │ │ │ ├── function_config_serve.jpg
│ │ │ │ ├── github_datacard.jpg
│ │ │ │ ├── robot_message_channel.jpg
│ │ │ │ └── value_message.jpg
│ │ │ ├── seven
│ │ │ │ ├── child_channel_permission.jpg
│ │ │ │ ├── child_channel_robot_directive.jpg
│ │ │ │ ├── mute_all.jpg
│ │ │ │ ├── mute_special.jpg
│ │ │ │ ├── public_announce.jpg
│ │ │ │ ├── public_robot_other_channel.jpg
│ │ │ │ └── robot_client_remind.jpg
│ │ │ ├── six
│ │ │ │ ├── avatar.jpg
│ │ │ │ ├── create_sub_channel_announce.jpg
│ │ │ │ ├── delete_schedule.jpg
│ │ │ │ ├── delete_sub_channel_announce.jpg
│ │ │ │ ├── feedback_1.jpg
│ │ │ │ ├── feedback_2.jpg
│ │ │ │ ├── feedback_3.jpg
│ │ │ │ ├── get_schedule.jpg
│ │ │ │ ├── get_schedules.jpg
│ │ │ │ ├── message-reaction-add-intents-guild-message-reactions.jpg
│ │ │ │ ├── message-reaction-remove-intents-guild-message-reactions.jpg
│ │ │ │ ├── patch_schedule.jpg
│ │ │ │ ├── post_schedule.jpg
│ │ │ │ └── serve_directive_same_panel.jpg
│ │ │ └── ten
│ │ │ │ ├── daily_update.jpg
│ │ │ │ ├── direct_message_delete.jpg
│ │ │ │ ├── optimize-private-message.jpg
│ │ │ │ ├── optimize-robot-ui.jpg
│ │ │ │ ├── optimize-robot.jpg
│ │ │ │ ├── right.png
│ │ │ │ └── withdraw-a-message.jpg
│ │ │ └── node-sdk
│ │ │ ├── api-client.png
│ │ │ ├── embed.png
│ │ │ ├── framework.png
│ │ │ ├── keyboard.png
│ │ │ ├── msg-tpl-23.png
│ │ │ ├── msg-tpl-24.png
│ │ │ ├── msg-tpl-34.png
│ │ │ ├── msg-tpl-37.png
│ │ │ └── ws-client.png
│ ├── styles
│ │ ├── index.styl
│ │ └── palette.styl
│ └── theme-qq
│ │ ├── LICENSE
│ │ ├── README.md
│ │ ├── components
│ │ ├── AlgoliaSearchBox.vue
│ │ ├── DropdownLink.vue
│ │ ├── DropdownTransition.vue
│ │ ├── Home.vue
│ │ ├── NavLink.vue
│ │ ├── NavLinks.vue
│ │ ├── Navbar.vue
│ │ ├── Page.vue
│ │ ├── PageEdit.vue
│ │ ├── PageNav.vue
│ │ ├── Sidebar.vue
│ │ ├── SidebarButton.vue
│ │ ├── SidebarGroup.vue
│ │ ├── SidebarLink.vue
│ │ └── SidebarLinks.vue
│ │ ├── global-components
│ │ ├── Badge.vue
│ │ ├── CodeBlock.vue
│ │ └── CodeGroup.vue
│ │ ├── index.js
│ │ ├── layouts
│ │ ├── 404.vue
│ │ └── Layout.vue
│ │ ├── noopModule.js
│ │ ├── package.json
│ │ ├── styles
│ │ ├── arrow.styl
│ │ ├── code.styl
│ │ ├── config.styl
│ │ ├── custom-blocks.styl
│ │ ├── index.styl
│ │ ├── mobile.styl
│ │ ├── toc.styl
│ │ └── wrapper.styl
│ │ └── util
│ │ └── index.js
├── README.md
├── business
│ └── README.md
├── changelog
│ └── README.md
├── develop
│ ├── api-v2
│ │ ├── README.md
│ │ ├── client-func
│ │ │ └── intro
│ │ │ │ ├── baseinfo.md
│ │ │ │ ├── datacard.md
│ │ │ │ └── find.md
│ │ ├── config.js
│ │ ├── dev-prepare
│ │ │ ├── error-trace
│ │ │ │ ├── README.md
│ │ │ │ ├── openapi.md
│ │ │ │ └── websocket.md
│ │ │ ├── interface-framework
│ │ │ │ ├── README.md
│ │ │ │ ├── api-use.md
│ │ │ │ ├── event-emit.md
│ │ │ │ ├── opcode.md
│ │ │ │ ├── reference.md
│ │ │ │ └── sign.md
│ │ │ └── unique-id.md
│ │ ├── gateway
│ │ │ └── error
│ │ │ │ ├── data
│ │ │ │ └── model.md
│ │ │ │ └── error.md
│ │ ├── openapi
│ │ │ ├── emoji
│ │ │ │ └── model.md
│ │ │ ├── error
│ │ │ │ ├── data
│ │ │ │ │ └── model.md
│ │ │ │ └── error.md
│ │ │ ├── member
│ │ │ │ ├── delete_member.md
│ │ │ │ ├── get_member.md
│ │ │ │ ├── get_members.md
│ │ │ │ └── model.md
│ │ │ ├── reaction
│ │ │ │ └── model.md
│ │ │ ├── user
│ │ │ │ ├── guilds.md
│ │ │ │ ├── me.md
│ │ │ │ └── model.md
│ │ │ └── wss
│ │ │ │ ├── shard_url_get.md
│ │ │ │ └── url_get.md
│ │ └── server-inter
│ │ │ ├── channel
│ │ │ ├── README.md
│ │ │ ├── api_permissions
│ │ │ │ ├── README.md
│ │ │ │ ├── get_guild_api_permission.md
│ │ │ │ ├── model.md
│ │ │ │ └── post_api_permission_demand.md
│ │ │ ├── content
│ │ │ │ ├── README.md
│ │ │ │ ├── announces
│ │ │ │ │ ├── delete_channel_announces.md
│ │ │ │ │ ├── delete_guild_announces.md
│ │ │ │ │ ├── model.md
│ │ │ │ │ ├── post_channel_announces.md
│ │ │ │ │ └── post_guild_announces.md
│ │ │ │ ├── audio
│ │ │ │ │ ├── audio_control.md
│ │ │ │ │ ├── delete_mic.md
│ │ │ │ │ ├── model.md
│ │ │ │ │ └── put_mic.md
│ │ │ │ ├── forum
│ │ │ │ │ ├── delete_thread.md
│ │ │ │ │ ├── forum.md
│ │ │ │ │ ├── get_thread.md
│ │ │ │ │ ├── get_threads_list.md
│ │ │ │ │ ├── model.md
│ │ │ │ │ ├── open_forum.md
│ │ │ │ │ └── put_thread.md
│ │ │ │ ├── pins
│ │ │ │ │ ├── delete_pins_message.md
│ │ │ │ │ ├── get_pins_message.md
│ │ │ │ │ ├── model.md
│ │ │ │ │ └── put_pins_message.md
│ │ │ │ └── schedule
│ │ │ │ │ ├── delete_schedule.md
│ │ │ │ │ ├── get_schedule.md
│ │ │ │ │ ├── get_schedules.md
│ │ │ │ │ ├── model.md
│ │ │ │ │ ├── patch_schedule.md
│ │ │ │ │ └── post_schedule.md
│ │ │ ├── manage
│ │ │ │ ├── README.md
│ │ │ │ ├── channel
│ │ │ │ │ ├── delete_channel.md
│ │ │ │ │ ├── get_channel.md
│ │ │ │ │ ├── get_channels.md
│ │ │ │ │ ├── model.md
│ │ │ │ │ ├── patch_channel.md
│ │ │ │ │ └── post_channels.md
│ │ │ │ ├── event
│ │ │ │ │ ├── channel.md
│ │ │ │ │ └── guild.md
│ │ │ │ ├── guild
│ │ │ │ │ ├── get_guild.md
│ │ │ │ │ ├── guilds.md
│ │ │ │ │ └── model.md
│ │ │ │ └── user
│ │ │ │ │ ├── me.md
│ │ │ │ │ └── model.md
│ │ │ ├── miniapp
│ │ │ │ ├── README.md
│ │ │ │ ├── interface.md
│ │ │ │ └── opendata.md
│ │ │ ├── role-group
│ │ │ │ ├── README.md
│ │ │ │ ├── channel_permissions
│ │ │ │ │ ├── get_channel_permissions.md
│ │ │ │ │ ├── get_channel_roles_permissions.md
│ │ │ │ │ ├── model.md
│ │ │ │ │ ├── put_channel_permissions.md
│ │ │ │ │ └── put_channel_roles_permissions.md
│ │ │ │ ├── delete_guild_member_role.md
│ │ │ │ ├── delete_guild_role.md
│ │ │ │ ├── get_guild_roles.md
│ │ │ │ ├── patch_guild_role.md
│ │ │ │ ├── post_guild_role.md
│ │ │ │ └── put_guild_member_role.md
│ │ │ ├── role
│ │ │ │ ├── README.md
│ │ │ │ ├── audio_or_live_channel_member.md
│ │ │ │ ├── get_online_nums.md
│ │ │ │ ├── guild_member.md
│ │ │ │ └── member
│ │ │ │ │ ├── delete_member.md
│ │ │ │ │ ├── get_member.md
│ │ │ │ │ ├── get_members.md
│ │ │ │ │ ├── get_role_members.md
│ │ │ │ │ ├── model.md
│ │ │ │ │ └── role_model.md
│ │ │ └── speak
│ │ │ │ ├── README.md
│ │ │ │ ├── patch_guild_member_mute.md
│ │ │ │ ├── patch_guild_mute.md
│ │ │ │ ├── patch_guild_mute_multi_member.md
│ │ │ │ └── setting
│ │ │ │ ├── message_setting.md
│ │ │ │ └── model.md
│ │ │ ├── group
│ │ │ ├── README.md
│ │ │ └── manage
│ │ │ │ ├── README.md
│ │ │ │ └── event.md
│ │ │ ├── message
│ │ │ ├── README.md
│ │ │ ├── dms
│ │ │ │ ├── delete_dms.md
│ │ │ │ ├── direct_message.md
│ │ │ │ ├── model.md
│ │ │ │ ├── post_dms.md
│ │ │ │ └── post_dms_messages.md
│ │ │ ├── message.md
│ │ │ ├── message_format.md
│ │ │ ├── post_messages.md
│ │ │ ├── send-receive
│ │ │ │ ├── README.md
│ │ │ │ ├── event.md
│ │ │ │ ├── reset.md
│ │ │ │ ├── rich-media.md
│ │ │ │ └── send.md
│ │ │ ├── template
│ │ │ │ └── model.md
│ │ │ ├── trans
│ │ │ │ ├── README.md
│ │ │ │ ├── emoji.md
│ │ │ │ ├── msg-btn.md
│ │ │ │ └── text-chain.md
│ │ │ └── type
│ │ │ │ ├── README.md
│ │ │ │ ├── ark.md
│ │ │ │ ├── audio.md
│ │ │ │ ├── embed.md
│ │ │ │ ├── file.md
│ │ │ │ ├── image.md
│ │ │ │ ├── markdown.md
│ │ │ │ ├── rich-text.md
│ │ │ │ ├── sticker.md
│ │ │ │ ├── template
│ │ │ │ ├── template_23.md
│ │ │ │ ├── template_24.md
│ │ │ │ └── template_37.md
│ │ │ │ ├── text.md
│ │ │ │ └── video.md
│ │ │ └── user
│ │ │ ├── README.md
│ │ │ └── manage
│ │ │ ├── README.md
│ │ │ └── event.md
│ ├── gosdk
│ │ ├── README.md
│ │ ├── api
│ │ │ ├── announce
│ │ │ │ ├── create_channel_announce.md
│ │ │ │ ├── create_guild_announce.md
│ │ │ │ ├── delete_channel_announce.md
│ │ │ │ ├── delete_guild_announce.md
│ │ │ │ └── post_recommended_channels.md
│ │ │ ├── api_permissions
│ │ │ │ ├── get_permissions.md
│ │ │ │ └── post_permission.md
│ │ │ ├── audio
│ │ │ │ └── post_audio.md
│ │ │ ├── channel
│ │ │ │ ├── create_channel.md
│ │ │ │ ├── delete_channel.md
│ │ │ │ ├── get_channel.md
│ │ │ │ ├── get_channels.md
│ │ │ │ └── update_channel.md
│ │ │ ├── channel_permissions
│ │ │ │ ├── get_channel_permissions.md
│ │ │ │ ├── get_channel_roles_permissions.md
│ │ │ │ ├── update_channel_permissions.md
│ │ │ │ └── update_channel_roles_permissions.md
│ │ │ ├── direct_msg
│ │ │ │ ├── create_direct_message.md
│ │ │ │ └── post_direct_message.md
│ │ │ ├── guild
│ │ │ │ ├── get_guild.md
│ │ │ │ └── guild_role
│ │ │ │ │ ├── create_guild_role.md
│ │ │ │ │ ├── create_guild_role_member.md
│ │ │ │ │ ├── delete_guild_role.md
│ │ │ │ │ ├── delete_guild_role_member.md
│ │ │ │ │ ├── get_guild_roles.md
│ │ │ │ │ └── update_guild_role.md
│ │ │ ├── member
│ │ │ │ ├── delete_guild_member.md
│ │ │ │ ├── get_guild_member.md
│ │ │ │ └── get_guild_members.md
│ │ │ ├── message
│ │ │ │ ├── get_message.md
│ │ │ │ ├── get_messages.md
│ │ │ │ ├── message_format.md
│ │ │ │ ├── message_reference.md
│ │ │ │ ├── message_template.md
│ │ │ │ ├── post_ark_message.md
│ │ │ │ ├── post_message.md
│ │ │ │ └── recall_message.md
│ │ │ ├── mute
│ │ │ │ ├── mute_all.md
│ │ │ │ └── mute_member.md
│ │ │ ├── pins_message
│ │ │ │ ├── delete_pins_message.md
│ │ │ │ ├── get_pins_message.md
│ │ │ │ └── put_pins_message.md
│ │ │ ├── reaction
│ │ │ │ ├── delete_reaction.md
│ │ │ │ └── post_reaction.md
│ │ │ ├── schedule
│ │ │ │ ├── delete_schedule.md
│ │ │ │ ├── get_schedule.md
│ │ │ │ ├── get_schedules.md
│ │ │ │ ├── post_schedule.md
│ │ │ │ └── update_schedule.md
│ │ │ └── user
│ │ │ │ ├── me.md
│ │ │ │ └── me_guilds.md
│ │ ├── config.js
│ │ ├── model
│ │ │ ├── announce.md
│ │ │ ├── api_permission.md
│ │ │ ├── audio.md
│ │ │ ├── channel.md
│ │ │ ├── channel_permission.md
│ │ │ ├── dms.md
│ │ │ ├── emoji.md
│ │ │ ├── guild.md
│ │ │ ├── member.md
│ │ │ ├── message.md
│ │ │ ├── pins_message.md
│ │ │ ├── reaction.md
│ │ │ ├── role.md
│ │ │ ├── schedule.md
│ │ │ └── user.md
│ │ └── websocket
│ │ │ └── listen_events.md
│ ├── nodesdk
│ │ ├── README.md
│ │ ├── announce
│ │ │ ├── delete_channel_announce.md
│ │ │ ├── delete_guild_announce.md
│ │ │ ├── patch_guild_recommend.md
│ │ │ ├── post_channel_announce.md
│ │ │ ├── post_guild_announce.md
│ │ │ └── post_guild_recommend.md
│ │ ├── api_permissions
│ │ │ ├── get_permissions.md
│ │ │ └── post_permission.md
│ │ ├── audio
│ │ │ ├── audio_control.md
│ │ │ ├── bot_off_mic.md
│ │ │ └── bot_on_mic.md
│ │ ├── changelog
│ │ │ └── README.md
│ │ ├── channel
│ │ │ ├── delete_channel.md
│ │ │ ├── get_channel.md
│ │ │ ├── get_channels.md
│ │ │ ├── patch_channel.md
│ │ │ └── post_channels.md
│ │ ├── channel_permissions
│ │ │ ├── get_channel_permissions.md
│ │ │ ├── get_channel_role_permissions.md
│ │ │ ├── put_channel_permissions.md
│ │ │ └── put_channel_role_permissions.md
│ │ ├── config.js
│ │ ├── dms
│ │ │ ├── post_dms.md
│ │ │ └── post_dms_messages.md
│ │ ├── error
│ │ │ ├── error.md
│ │ │ └── error.png
│ │ ├── guild
│ │ │ ├── delete_guild_member_role.md
│ │ │ ├── delete_guild_role.md
│ │ │ ├── get_guild.md
│ │ │ ├── get_guild_roles.md
│ │ │ ├── guilds.md
│ │ │ ├── patch_guild_role.md
│ │ │ ├── post_guild_role.md
│ │ │ └── put_guild_member_role.md
│ │ ├── member
│ │ │ ├── delete_member.md
│ │ │ ├── get_member.md
│ │ │ ├── get_members.md
│ │ │ └── get_voice_members.md
│ │ ├── message
│ │ │ ├── delete_message.md
│ │ │ ├── get_message_of_id.md
│ │ │ ├── message_format.md
│ │ │ ├── message_template.md
│ │ │ ├── post_ark_messages.md
│ │ │ ├── post_keyboard_message.md
│ │ │ ├── post_messages.md
│ │ │ └── post_reference_messages.md
│ │ ├── model
│ │ │ ├── announce.md
│ │ │ ├── api_permission.md
│ │ │ ├── audio.md
│ │ │ ├── channel.md
│ │ │ ├── channel_permission.md
│ │ │ ├── dms.md
│ │ │ ├── emoji.md
│ │ │ ├── guild.md
│ │ │ ├── inline_keyboard.md
│ │ │ ├── member.md
│ │ │ ├── message.md
│ │ │ ├── pins_message.md
│ │ │ ├── reaction.md
│ │ │ ├── role.md
│ │ │ ├── schedule.md
│ │ │ └── user.md
│ │ ├── mute
│ │ │ ├── mute_all.md
│ │ │ ├── mute_member.md
│ │ │ └── mute_members.md
│ │ ├── pins_message
│ │ │ ├── delete_pins_message.md
│ │ │ ├── get_pins_message.md
│ │ │ └── put_pins_message.md
│ │ ├── reaction
│ │ │ ├── delete_reaction.md
│ │ │ ├── get_reaction_user_list.md
│ │ │ └── post_reaction.md
│ │ ├── schedule
│ │ │ ├── delete_schedule.md
│ │ │ ├── get_schedule.md
│ │ │ ├── get_schedules.md
│ │ │ ├── patch_schedule.md
│ │ │ └── post_schedule.md
│ │ ├── user
│ │ │ ├── guilds.md
│ │ │ └── me.md
│ │ └── wss
│ │ │ └── model.md
│ └── pythonsdk
│ │ ├── README.md
│ │ ├── api
│ │ ├── announce
│ │ │ ├── create_channel_announce.md
│ │ │ ├── create_guild_announce.md
│ │ │ ├── delete_channel_announce.md
│ │ │ └── delete_guild_announce.md
│ │ ├── api_permissions
│ │ │ ├── get_permissions.md
│ │ │ └── post_permission.md
│ │ ├── audio
│ │ │ ├── audio_off_mic.md
│ │ │ ├── audio_on_mic.md
│ │ │ └── post_audio.md
│ │ ├── channel
│ │ │ ├── create_channel.md
│ │ │ ├── delete_channel.md
│ │ │ ├── get_channel.md
│ │ │ ├── get_channels.md
│ │ │ └── update_channel.md
│ │ ├── channel_permissions
│ │ │ ├── get_channel_permissions.md
│ │ │ ├── get_channel_role_permissions.md
│ │ │ ├── update_channel_permissions.md
│ │ │ └── update_channel_role_permissions.md
│ │ ├── dms
│ │ │ ├── create_dms.md
│ │ │ └── post_dms.md
│ │ ├── guild
│ │ │ ├── get_guild.md
│ │ │ └── guild_role
│ │ │ │ ├── create_guild_role.md
│ │ │ │ ├── create_guild_role_member.md
│ │ │ │ ├── delete_guild_role.md
│ │ │ │ ├── delete_guild_role_member.md
│ │ │ │ ├── get_guild_roles.md
│ │ │ │ └── update_guild_role.md
│ │ ├── member
│ │ │ ├── delete_guild_member.md
│ │ │ ├── get_guild_member.md
│ │ │ └── get_guild_members.md
│ │ ├── message
│ │ │ ├── get_message.md
│ │ │ ├── message_format.md
│ │ │ ├── message_template.md
│ │ │ ├── post_ark_message.md
│ │ │ ├── post_keyboard_message.md
│ │ │ ├── post_message.md
│ │ │ ├── post_reference_messages.md
│ │ │ └── recall_message.md
│ │ ├── mute
│ │ │ ├── mute_all.md
│ │ │ ├── mute_member.md
│ │ │ └── mute_multi_member.md
│ │ ├── pins_message
│ │ │ ├── delete_pins_message.md
│ │ │ ├── get_pins_message.md
│ │ │ └── put_pins_message.md
│ │ ├── reaction
│ │ │ ├── delete_reaction.md
│ │ │ ├── get_reaction_users.md
│ │ │ └── post_reaction.md
│ │ ├── schedule
│ │ │ ├── delete_schedule.md
│ │ │ ├── get_schedule.md
│ │ │ ├── get_schedules.md
│ │ │ ├── post_schedule.md
│ │ │ └── update_schedule.md
│ │ └── user
│ │ │ ├── me.md
│ │ │ └── me_guilds.md
│ │ ├── changelog
│ │ └── README.md
│ │ ├── config.js
│ │ ├── model
│ │ ├── announce.md
│ │ ├── api_permission.md
│ │ ├── audio.md
│ │ ├── channel.md
│ │ ├── channel_permission.md
│ │ ├── dms.md
│ │ ├── emoji.md
│ │ ├── guild.md
│ │ ├── inline_keyboard.md
│ │ ├── member.md
│ │ ├── message.md
│ │ ├── pins_message.md
│ │ ├── reaction.md
│ │ ├── role.md
│ │ ├── schedule.md
│ │ └── user.md
│ │ └── websocket
│ │ └── listen_events.md
└── newfeature
│ ├── README.md
│ ├── config.js
│ ├── eleven
│ └── README.md
│ ├── five
│ └── README.md
│ ├── nine
│ └── README.md
│ ├── seven
│ └── README.md
│ ├── six
│ └── README.md
│ └── ten
│ └── README.md
├── nginx.conf
├── package.json
├── patches
└── @vuepress+plugin-pwa+1.9.5.patch
└── scripts
├── add-build-tag.js
├── change-log.js
├── sync-inner-docs
├── default-docs
│ ├── README.md
│ └── config.js
├── index.js
└── summary-to-vuepress.js
└── utils.js
/.commitlintrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | extends: ['@commitlint/config-conventional']
3 | }
4 |
--------------------------------------------------------------------------------
/.eslintignore:
--------------------------------------------------------------------------------
1 | **/node_modules
2 | !.eslintrc.js
3 | !.commitlintrc.js
4 | !.vuepress
--------------------------------------------------------------------------------
/.eslintrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | root: true,
3 | env: {
4 | node: false,
5 | jest: true,
6 | },
7 | extends: [],
8 | rules: {
9 | 'arrow-parens': ['warn', 'as-needed'],
10 | indent: ['error', 2, { MemberExpression: 'off' }],
11 |
12 | 'no-undef': ['error'],
13 |
14 | 'operator-linebreak': ['error', 'before'],
15 |
16 | 'vue/match-component-file-name': [
17 | 'error',
18 | {
19 | extensions: ['js', 'vue'],
20 | shouldMatchCase: false,
21 | },
22 | ],
23 | },
24 | globals: {},
25 | };
26 |
--------------------------------------------------------------------------------
/.github/workflows/issues.yml:
--------------------------------------------------------------------------------
1 | name: Issues Notifier
2 | on:
3 | issues:
4 | types: [opened, reopened]
5 | jobs:
6 | add-assigness:
7 | runs-on: ubuntu-latest
8 | steps:
9 | - name: Work Weixin Notifier
10 | uses: jerray/work-weixin-notifier@v1.1.0
11 | with:
12 | key: ${{ secrets.weixin_bot_key }}
13 | content: |
14 | # 【机器人文档】 ISSUE [ ${{github.event.issue.state}} ]
15 |
16 | > Detail： [${{ github.event.issue.html_url }}](${{ github.event.issue.html_url }})
17 | > Title： ${{ github.event.issue.title }}
18 | > Body： ${{github.event.issue.body}}
19 | > User： ${{ github.event.issue.user.login }}
20 | > Attention： <@nillwang><@jackqqxu>
21 |
22 | type: markdown
23 | status: ${{ job.status }}
24 |
--------------------------------------------------------------------------------
/.github/workflows/pr-merged.yml:
--------------------------------------------------------------------------------
1 | on:
2 | pull_request:
3 | branches: ['main']
4 | types: [closed]
5 |
6 | jobs:
7 | pr-approved-notice:
8 | runs-on: ubuntu-latest
9 | if: github.event.pull_request.merged == true
10 | steps:
11 | - name: Work Weixin Notifier
12 | uses: jerray/work-weixin-notifier@v1.1.0
13 | with:
14 | key: ${{ secrets.weixin_bot_key }}
15 | content: |
16 | # 【机器人文档】 PR [ merged ]
17 |
18 | > 标题： ${{ github.event.pull_request.title }}
19 | > 合并人： ${{ github.event.pull_request.merged_by.login }}
20 |
21 | > 详情： [${{github.event.pull_request.html_url}}](${{github.event.pull_request.html_url}})
22 | > 请关注： <@nillwang> <@jackqqxu>
23 |
24 | type: markdown
25 | status: ${{ job.status }}
26 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | dist/
3 | package-lock.json
4 | yarn.lock
5 | yarn-error.log
6 |
7 | # General
8 | .DS_Store
9 | .AppleDouble
10 | .LSOverride
11 | .idea
12 |
13 | # Thumbnails
14 | ._*
15 |
16 | _book
17 | *.pdf
18 | docs/develop/api/index.html
19 | .temp
20 |
21 | .temp_docs
22 | docs/develop/api
23 | botpy
--------------------------------------------------------------------------------
/.gitpod.yml:
--------------------------------------------------------------------------------
1 | ports:
2 | - port: 8080
3 | onOpen: open-preview
4 | tasks:
5 | - init: yarn
6 | command: yarn dev
--------------------------------------------------------------------------------
/.husky/commit-msg:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | . "$(dirname "$0")/_/husky.sh"
3 |
4 | npx --no -- commitlint --edit
5 |
--------------------------------------------------------------------------------
/.husky/pre-commit:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | . "$(dirname "$0")/_/husky.sh"
3 | npx lint-staged
4 |
--------------------------------------------------------------------------------
/.prettierrc:
--------------------------------------------------------------------------------
1 | {
2 | "printWidth": 100,
3 | "singleQuote": true,
4 | "trailingComma": "all",
5 | "arrowParens": "avoid",
6 | "htmlWhitespaceSensitivity": "strict",
7 | "useTabs": false,
8 | "tabWidth": 2,
9 | "semi": true,
10 | "overrides": [
11 | {
12 | "files": "*.html",
13 | "options": {
14 | "printWidth": 999
15 | }
16 | }
17 | ]
18 | }
19 |
--------------------------------------------------------------------------------
/.remarkignore:
--------------------------------------------------------------------------------
1 | /docs/develop/api/*
2 | /docs/changelog/*
3 | /docs/develop/pythonsdk/changelog/*
--------------------------------------------------------------------------------
/.remarkrc:
--------------------------------------------------------------------------------
1 | {
2 | "plugins": [
3 | "preset-lint-recommended",
4 | "preset-lint-consistent",
5 |
6 | ["lint-list-item-indent", "space"],
7 | ["lint-heading-style", false]
8 | ]
9 | }
--------------------------------------------------------------------------------
/.textlintignore:
--------------------------------------------------------------------------------
1 | /docs/develop/api/SUMMARY-PUBLIC.md
2 |
--------------------------------------------------------------------------------
/.textlintrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | rules: {
3 | '@textlint-rule/no-unmatched-pair': true,
4 | apostrophe: true,
5 | 'common-misspellings': true,
6 | diacritics: true,
7 | 'stop-words': {
8 | severity: 'warning',
9 | },
10 | 'write-good': {
11 | severity: 'warning',
12 | },
13 | },
14 | filters: {
15 | comments: true,
16 | },
17 | };
18 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM nginx
2 |
3 |
4 | COPY nginx.conf /etc/nginx/
5 |
6 | COPY ./dist /usr/share/nginx/html
7 |
8 |
9 |
--------------------------------------------------------------------------------
/License:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2021 Tencent
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
--------------------------------------------------------------------------------
/docs/.vuepress/common.js:
--------------------------------------------------------------------------------
1 |
2 | module.exports = {
3 | cdnBase: 'https://mpqq.gtimg.cn/',
4 | cdnPath: typeof process !== 'undefined' && process.env && process.env.BUILD_ENV === 'test' ? 'bot-wiki/test/' : 'bot-wiki/online/',
5 | };
6 |
--------------------------------------------------------------------------------
/docs/.vuepress/components/MySWUpdatePopup.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 |
12 |
13 |
14 |
15 |
22 |
23 |
--------------------------------------------------------------------------------
/docs/.vuepress/components/NpmBadge.vue:
--------------------------------------------------------------------------------
1 |
2 |
7 | ![]()
10 |
11 |
12 |
13 |
31 |
32 |
--------------------------------------------------------------------------------
/docs/.vuepress/components/PrivateDomain.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 |
注意
4 |
5 | - 公域机器人暂不支持申请，仅私域机器人可用，选择私域机器人后默认开通。
6 | - 注意: 开通后需要先将机器人从频道移除，然后重新添加，方可生效。
7 |
8 |
3 |
手机QQ扫码
4 |
6 |
加入官方频道开发者社区
7 |
6 |
7 |
8 |
9 |
10 |
30 |
31 |
42 |
--------------------------------------------------------------------------------
/docs/.vuepress/theme-qq/noopModule.js:
--------------------------------------------------------------------------------
1 | export default {}
2 |
--------------------------------------------------------------------------------
/docs/.vuepress/theme-qq/styles/arrow.styl:
--------------------------------------------------------------------------------
1 | @require './config'
2 |
3 | .arrow
4 | display inline-block
5 | width 0
6 | height 0
7 | &.up
8 | border-left 4px solid transparent
9 | border-right 4px solid transparent
10 | border-bottom 6px solid $arrowBgColor
11 | &.down
12 | border-left 4px solid transparent
13 | border-right 4px solid transparent
14 | border-top 6px solid $arrowBgColor
15 | &.right
16 | border-top 4px solid transparent
17 | border-bottom 4px solid transparent
18 | border-left 6px solid $arrowBgColor
19 | &.left
20 | border-top 4px solid transparent
21 | border-bottom 4px solid transparent
22 | border-right 6px solid $arrowBgColor
23 |
--------------------------------------------------------------------------------
/docs/.vuepress/theme-qq/styles/config.styl:
--------------------------------------------------------------------------------
1 | $contentClass = '.theme-default-content'
2 |
--------------------------------------------------------------------------------
/docs/.vuepress/theme-qq/styles/custom-blocks.styl:
--------------------------------------------------------------------------------
1 | .custom-block
2 | .custom-block-title
3 | font-weight 600
4 | margin-bottom -0.4rem
5 | &.tip, &.warning, &.danger
6 | padding .1rem 1.5rem
7 | border-left-width .5rem
8 | border-left-style solid
9 | margin 1rem 0
10 | &.tip
11 | background-color #f3f5f7
12 | border-color #42b983
13 | &.warning
14 | background-color rgba(255,229,100,.3)
15 | border-color darken(#ffe564, 35%)
16 | color darken(#ffe564, 70%)
17 | .custom-block-title
18 | color darken(#ffe564, 50%)
19 | a
20 | color $textColor
21 | &.danger
22 | background-color #ffe6e6
23 | border-color darken(red, 20%)
24 | color darken(red, 70%)
25 | .custom-block-title
26 | color darken(red, 40%)
27 | a
28 | color $textColor
29 | &.details
30 | display block
31 | position relative
32 | border-radius 2px
33 | margin 1.6em 0
34 | padding 1.6em
35 | background-color #eee
36 | h4
37 | margin-top 0
38 | figure, p
39 | &:last-child
40 | margin-bottom 0
41 | padding-bottom 0
42 | summary
43 | outline none
44 | cursor pointer
45 |
--------------------------------------------------------------------------------
/docs/.vuepress/theme-qq/styles/mobile.styl:
--------------------------------------------------------------------------------
1 | @require './config'
2 |
3 | $mobileSidebarWidth = $sidebarWidth * 0.82
4 |
5 | // narrow desktop / iPad
6 | @media (max-width: $MQNarrow)
7 | .sidebar
8 | font-size 15px
9 | width $mobileSidebarWidth
10 | .page
11 | padding-left $mobileSidebarWidth
12 |
13 | // wide mobile
14 | @media (max-width: $MQMobile)
15 | .sidebar
16 | top 0
17 | padding-top $navbarHeight
18 | transform translateX(-100%)
19 | transition transform .2s ease
20 | .page
21 | padding-left 0
22 | .theme-container
23 | &.sidebar-open
24 | .sidebar
25 | transform translateX(0)
26 | &.no-navbar
27 | .sidebar
28 | padding-top: 0
29 |
30 | // narrow mobile
31 | @media (max-width: $MQMobileNarrow)
32 | h1
33 | font-size 1.9rem
34 | {$contentClass}
35 | div[class*="language-"]
36 | margin 0.85rem -1.5rem
37 | border-radius 0
38 |
--------------------------------------------------------------------------------
/docs/.vuepress/theme-qq/styles/toc.styl:
--------------------------------------------------------------------------------
1 | .table-of-contents
2 | .badge
3 | vertical-align middle
4 |
--------------------------------------------------------------------------------
/docs/.vuepress/theme-qq/styles/wrapper.styl:
--------------------------------------------------------------------------------
1 | $wrapper
2 | max-width $contentWidth
3 | margin 0 auto
4 | padding 2rem 2.5rem
5 | @media (max-width: $MQNarrow)
6 | padding 2rem
7 | @media (max-width: $MQMobileNarrow)
8 | padding 1.5rem
9 |
10 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/README.md:
--------------------------------------------------------------------------------
1 | # 账号注册
2 |
3 | QQ 机器人：一个机器人可以被添加到 `群聊/频道` 内对话，QQ 用户也可以直接跟机器人 `单独对话`。
4 |
5 | 开发者账号主体要求：
6 | - 单聊对话：【定向邀请】
7 | - 群聊场景：仅支持企业主体【个人主体暂不支持】
8 | - 频道场景：企业主体与个人主体均可申请
9 |
10 |
11 | 注册地址：[QQ 开放平台](https://q.qq.com/#/)
12 |
13 | 注册创建机器人后：获得的开发机器人接入票据 `AppID` `AppSecret` `Token`
14 |
15 | | 名称 | 描述 | 备注 |
16 | |-----------|-----------|--------------------------------------------|
17 | | AppID | 机器人 ID | 必须使用 |
18 | | AppSecret | 机器人密钥 | 用于在 `oauth` 场景进行请求签名的密钥 |
19 | | Token | 机器人 Token | 可用于调用开放接口的鉴权，建议使用更安全的 `access token` 的鉴权方式 |
20 |
21 | 开发过程中如遇任何问题，可联系QQ机器人反馈助手开通。
22 |
23 | ![QQ机器人反馈助手]()
24 |
25 | 快速搭建机器人服务端请参考：[botgo sdk](https://github.com/tencent-connect/botgo)
26 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/client-func/intro/datacard.md:
--------------------------------------------------------------------------------
1 | # 资料卡与设置
2 |
3 |
8 |
9 | ::: tip 说明
10 | 在机器人资料页里，包含有基本介绍展示、服务跳转、指令介绍与使用、基本设置、添加删除机器人等功能。
11 | - 功能介绍
12 | - 服务与指令
13 | - 设置相关
14 | - 添加使用
15 | :::
16 |
17 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/client-func/intro/find.md:
--------------------------------------------------------------------------------
1 | # 分享推荐与搜索
2 |
3 |
4 |
5 | ::: tip 说明
6 | 在添加与发现场景内，逐步开放更多的发现路径。
7 | :::
8 |
9 |
10 |
11 | | 分享机器人 | 群管理推荐位 | 频道管理推荐位 | 群聊加号面板 |
12 | | --- | --- | --- | --- |
13 | | 支持 | 支持 | 支持 | 暂未支持 |
14 |
15 | | 机器人QQ号搜索 | 昵称搜索 | 机器人分类搜索 |
16 | | --- | --- | --- | --- |
17 | | 支持 | 暂未支持 | 暂未支持 |
18 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/dev-prepare/error-trace/README.md:
--------------------------------------------------------------------------------
1 | # 错误与调试
2 |
3 | ## 错误码
4 |
5 | ## 有关 traceID
6 |
7 | 在 openapi 的返回 http 头上，有一个 `X-Tps-trace-ID` 自定义头部，是平台的链路追踪 ID，如果开发者有无法自己定位的问题，需要找平台协助的时候，可以提取这个 ID，提交给平台方。
8 |
9 | 方便查询相关日志。
10 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/dev-prepare/error-trace/websocket.md:
--------------------------------------------------------------------------------
1 | # websocket
2 |
3 | ### 错误码 code
4 | | 值 | 含义 | 是否可以重试 RESUME | 是否可以重试 IDENTIFY |
5 | | :-------------- | :------------------------------------- | :--- | :--- |
6 | | 4001 | 无效的 opcode | 否 | 否 |
7 | | 4002 | 无效的 payload | 否 | 否 |
8 | | 4007 | seq 错误 | 否 | **是** |
9 | | 4006 | 无效的 session id，无法继续 resume，请 identify | 否 | **是** |
10 | | 4008 | 发送 payload 过快，请重新连接，并遵守连接后返回的频控信息 | **是** | **是** |
11 | | 4009 | 连接过期，请重连并执行 resume 进行重新连接 | **是** | **是** |
12 | | 4010 | 无效的 shard | 否 | 否 |
13 | | 4011 | 连接需要处理的 guild 过多，请进行合理的分片 | 否 | 否 |
14 | | 4012 | 无效的 version | 否 | 否 |
15 | | 4013 | 无效的 intent | 否 | 否 |
16 | | 4014 | intent 无权限 | 否 | 否 |
17 | | 4014 | intent 无权限 | 否 | 否 |
18 | | 4900~4913| 内部错误，请重连 | 否 | **是** |
19 | | 4914| 机器人已下架,只允许连接沙箱环境,请断开连接,检验当前连接环境 | 否 | 否 |
20 | | 4915| 机器人已封禁,不允许连接,请断开连接,申请解封后再连接 | 否 | 否 |
21 |
22 | ### 针对 websocket 错误码的简单处理逻辑
23 |
24 | - 4009 可以重新发起 resume
25 | - 4914，4915 不可以连接，请联系官方解封
26 | - 其他错误，请重新发起 identify
27 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/dev-prepare/interface-framework/README.md:
--------------------------------------------------------------------------------
1 | # 接口通信基础框架
2 |
3 | 接口通信基础框架，BOT 开发者对接 QQ 机器人开放平台提供的接口能力，开发出一款让普通 QQ 用户可用的机器人。
4 |
5 | ![单聊]()
6 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/dev-prepare/interface-framework/opcode.md:
--------------------------------------------------------------------------------
1 | # opcode
2 |
3 | 所有opcode列表如下：
4 |
5 | | CODE | 名称 | 客户端操作 | 描述 |
6 | |------|-------------------|---------------|--------------------------------------|
7 | | 0 | Dispatch | Receive | 服务端进行消息推送 |
8 | | 1 | Heartbeat | Send/Receive | 客户端或服务端发送心跳 |
9 | | 2 | Identify | Send | 客户端发送鉴权 |
10 | | 6 | Resume | Send | 客户端恢复连接 |
11 | | 7 | Reconnect | Receive | 服务端通知客户端重新连接 |
12 | | 9 | Invalid Session | Receive | 当identify或resume的时候，如果参数有错，服务端会返回该消息 |
13 | | 10 | Hello | Receive | 当客户端与网关建立ws连接之后，网关下发的第一条消息 |
14 | | 11 | Heartbeat ACK | Receive/Reply | 当发送心跳成功之后，就会收到该消息 |
15 | | 12 | HTTP Callback ACK | Reply | 仅用于 http 回调模式的回包，代表机器人收到了平台推送的数据() |
16 | | 13 | 回调地址验证 | Receive | 开放平台对机器人服务端进行验证 |
17 |
18 |
19 | 客户端操作含义如下：
20 |
21 | - `Receive` 客户端接收到服务端 push 的消息
22 | - `Send` 客户端发送消息
23 | - `Reply` 客户端接收到服务端发送的消息之后的回包（HTTP 回调模式）
24 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/dev-prepare/unique-id.md:
--------------------------------------------------------------------------------
1 | # 唯一身份机制
2 |
3 | 不同的 `bot(AppID)` 获取到的用户 `openid`，群 `openid`，频道 `openid` 均不相同，若跨业务有关联用户身份需求，后续提供跨 `AppID` 绑定后，使用类似 `unionid` 的机制打通身份。
4 |
5 | ::: tip 举例
6 | - 不同 `bot` 在单聊场景，获取到的用户唯一识别 `openid` 不一样，称为 `user_openid`
7 | - 不同 `bot` 在群聊场景，获取到的群唯一识别号 `openid` 不一样，称为 `group_openid`
8 | - 相同 `bot` 在不同的群，获取到同一个用户在群内的唯一识别号 `openid` 不一样，称为 `member_openid`
9 | :::
10 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/gateway/error/data/model.md:
--------------------------------------------------------------------------------
1 | # 业务报错返回的数据信息(Data)
2 |
3 | ### Data
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ---------------- | ------------------------------------------------ | ---------------------- |
7 | | message_audit | [MessageAudited](../../message/model.md#messageaudited) 对象 | 消息审核信息，只会填充该对象的 audit_id 字段 |
8 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/gateway/error/error.md:
--------------------------------------------------------------------------------
1 | # websocket 错误
2 |
3 | ### code
4 | | 值 | 含义 | 是否可以重试 RESUME | 是否可以重试 IDENTIFY |
5 | | :-------------- | :------------------------------------- | :--- | :--- |
6 | | 4001 | 无效的 opcode | 否 | 否 |
7 | | 4002 | 无效的 payload | 否 | 否 |
8 | | 4007 | seq 错误 | 否 | **是** |
9 | | 4006 | 无效的 session id，无法继续 resume，请 identify | 否 | **是** |
10 | | 4008 | 发送 payload 过快，请重新连接，并遵守连接后返回的频控信息 | **是** | **是** |
11 | | 4009 | 连接过期，请重连并执行 resume 进行重新连接 | **是** | **是** |
12 | | 4010 | 无效的 shard | 否 | 否 |
13 | | 4011 | 连接需要处理的 guild 过多，请进行合理的分片 | 否 | 否 |
14 | | 4012 | 无效的 version | 否 | 否 |
15 | | 4013 | 无效的 intent | 否 | 否 |
16 | | 4014 | intent 无权限 | 否 | 否 |
17 | | 4014 | intent 无权限 | 否 | 否 |
18 | | 4900~4913| 内部错误，请重连 | 否 | **是** |
19 | | 4914| 机器人已下架,只允许连接沙箱环境,请断开连接,检验当前连接环境 | 否 | 否 |
20 | | 4915| 机器人已封禁,不允许连接,请断开连接,申请解封后再连接 | 否 | 否 |
21 |
22 | ### 针对 websocket 错误码的简单处理逻辑
23 |
24 | - 4009 可以重新发起 resume
25 | - 4914，4915 不可以连接，请联系官方解封
26 | - 其他错误，请重新发起 identify
27 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/openapi/error/data/model.md:
--------------------------------------------------------------------------------
1 | # 业务报错返回的数据信息(Data)
2 |
3 | ## Data
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ---------------- | ------------------------------------------------ | ---------------------- |
7 | | message_audit | [MessageAudited](../../../server-inter/message/template/model.md#messageaudited) 对象 | 消息审核信息，只会填充该对象的 audit_id 字段 |
8 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/openapi/member/delete_member.md:
--------------------------------------------------------------------------------
1 | # 删除频道成员
2 |
3 | ### 接口
4 |
5 | ```http
6 | DELETE /guilds/{guild_id}/members/{user_id}
7 | ```
8 |
9 | ### 功能描述
10 |
11 | 用于删除 `guild_id` 指定的频道下的成员 `user_id`。
12 | - 需要使用的 `token` 对应的用户具备踢人权限。如果是机器人，要求被添加为管理员。
13 | - 操作成功后，会触发**频道成员删除事件**。
14 | - 无法移除身份为管理员的成员
15 |
16 |
17 |
18 | ### Content-Type
19 | ```http
20 | application/json
21 | ```
22 |
23 | ### 参数
24 | | 字段名 | 类型 | 描述 |
25 | | ------------- | ---- | ------------------------------------|
26 | | add_blacklist | bool | 删除成员的同时，将该用户添加到频道黑名单中 |
27 | | delete_history_msg_days | int | 删除成员的同时，撤回该成员的消息，可以指定撤回消息的时间范围 |
28 |
29 | 注：消息撤回时间范围仅支持固定的天数：`3`，`7`，`15`，`30`。 特殊的时间范围：`-1: 撤回全部消息`。默认值为`0`不撤回任何消息。
30 |
31 | ### 返回
32 |
33 | 成功返回 HTTP 状态码 `204`。
34 |
35 | ### 错误码
36 |
37 | 详见[错误码](../error/error.md)。
38 |
39 | ### 示例
40 |
41 | 请求数据包
42 |
43 | ```shell
44 | DELETE /guilds/123456/members/112233
45 | {
46 | "add_blacklist": true,
47 | "delete_history_msg_days": -1
48 | }
49 | ```
50 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/openapi/member/get_member.md:
--------------------------------------------------------------------------------
1 | # 获取成员详情
2 |
3 | ## 接口
4 |
5 | ```http
6 | GET /guilds/{guild_id}/members/{user_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于获取 `guild_id` 指定的频道中 `user_id` 对应成员的详细信息。
12 |
13 | ## Content-Type
14 |
15 | ```http
16 | application/json
17 | ```
18 |
19 | ## 返回
20 |
21 | 返回[Member](model.md#member) 成员对象。
22 |
23 | ## 错误码
24 |
25 | 详见[错误码](../error/error.md)。
26 |
27 | ## 示例
28 |
29 | 请求数据包
30 |
31 | ```shell
32 | GET /guilds/123456/members/112233
33 | ```
34 |
35 | 响应数据包
36 |
37 | ```json
38 | {
39 | "user": {
40 | "id": "2823701233424295228",
41 | "username": "xxx",
42 | "avatar": "https://qqchannel-profile-1251316161.file.myqcloud.com/xxxxxxx",
43 | "bot": false,
44 | "union_openid": "",
45 | "union_user_account": ""
46 | },
47 | "nick": "",
48 | "roles": [
49 | "1"
50 | ],
51 | "joined_at": "2021-12-05T14:08:29+08:00"
52 | }
53 | ```
54 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/openapi/member/model.md:
--------------------------------------------------------------------------------
1 | # 成员对象(Member)
2 |
3 | ### Member
4 | | 字段名 | 类型 | 描述 |
5 | | ------------ | ----------------- | ---------------|
6 | | user | [User](../user/model.md#user) | 用户的频道基础信息，只有成员相关接口中会填充此信息 |
7 | | nick | string | 用户的昵称 |
8 | | roles | string 数组 | 用户在频道内的身份组ID, 默认值可参考[DefaultRoles](../guild/role_model.md#DefaultRoles) |
9 | | joined_at | ISO8601 timestamp | 用户加入频道的时间 |
10 |
11 | ### MemberWithGuildID
12 | | 字段名 | 类型 | 描述 |
13 | | ------------ | ----------------- | ---------------|
14 | | guild_id | string | 频道id |
15 | | user | [User](../user/model.md#user) | 用户的频道基础信息 |
16 | | nick | string | 用户的昵称 |
17 | | roles | string 数组 | 用户在频道内的身份 |
18 | | joined_at | ISO8601 timestamp | 用户加入频道的时间 |
19 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/openapi/reaction/model.md:
--------------------------------------------------------------------------------
1 | # 表情表态对象
2 |
3 | ### MessageReaction
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | --- | --- | --- |
7 | | user_id | string | 用户ID |
8 | | guild_id | string | 频道ID |
9 | | channel_id | string | 子频道ID |
10 | | target | ReactionTarget | 表态对象 |
11 | | emoji | [Emoji](../emoji/model.md#Emoji) | 表态所用表情 |
12 |
13 |
14 | ### ReactionTarget
15 |
16 | | 字段名 | 类型 | 描述 |
17 | | --- | --- | --- |
18 | | id | string | 表态对象ID |
19 | | type | ReactionTargetType | 表态对象类型，参考 ReactionTargetType |
20 |
21 | ### ReactionTargetType
22 |
23 | | 值 | 描述 |
24 | | --- | --- |
25 | | 0 | 消息 |
26 | | 1 | 帖子 |
27 | | 2 | 评论 |
28 | | 3 | 回复 |
29 |
30 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/openapi/user/me.md:
--------------------------------------------------------------------------------
1 | # 获取用户详情
2 |
3 | ### 接口
4 |
5 | ```http
6 | GET /users/@me
7 | ```
8 |
9 | ### 功能描述
10 |
11 | 用于获取当前用户（机器人）详情。
12 |
13 | ### Content-Type
14 |
15 | ```http
16 | application/json
17 | ```
18 |
19 | ### 返回
20 |
21 | 返回 [User](model.md#user) 对象。
22 |
23 | ### 错误码
24 |
25 | 详见[错误码](../error/error.md)。
26 |
27 | ### 示例
28 |
29 | 响应数据包
30 |
31 | ```json
32 | {
33 | "id": "11586990140073229091",
34 | "username": "gitsub",
35 | "avatar": "https://thirdqq.qlogo.cn/g?b=oidb&k=M5TibpXicS7Jt4z89BZxiamAA&s=100&t=1641802698",
36 | "union_openid": "74F138F7F3AF68C4B8E8325013FCA295",
37 | "union_user_account": ""
38 | }
39 | ```
40 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/openapi/user/model.md:
--------------------------------------------------------------------------------
1 | # 用户对象(User)
2 |
3 | 用户对象中所涉及的 ID 类数据，都仅在机器人场景流通，与真实的 ID 无关。请不要理解为真实的 ID
4 |
5 | ### User
6 |
7 | | 字段名 | 类型 | 描述 |
8 | |--------------------|--------|--------------------------------------------------------|
9 | | id | string | 用户 id |
10 | | username | string | 用户名 |
11 | | avatar | string | 用户头像地址 |
12 | | bot | bool | 是否是机器人 |
13 | | union_openid | string | 特殊关联应用的 openid，需要特殊申请并配置后才会返回。如需申请，请联系平台运营人员。 |
14 | | union_user_account | string | 机器人关联的互联应用的用户信息，与union_openid关联的应用是同一个。如需申请，请联系平台运营人员。 |
15 |
16 | ### 提示
17 |
18 | `union_openid` 与 `union_user_account` 只有在单独拉取 member 信息的时候才会提供，在其他的事件中所携带的 user 对象，均无这两个字段的内容。
19 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/openapi/wss/url_get.md:
--------------------------------------------------------------------------------
1 | # 获取通用 WSS 接入点
2 |
3 | ### 接口
4 |
5 | ```http
6 | GET /gateway
7 | ```
8 |
9 | ### 功能描述
10 |
11 | 用于获取 WSS 接入地址，通过该地址可建立 `websocket` 长连接。
12 |
13 | ### Content-Type
14 |
15 | ```http
16 | application/json
17 | ```
18 |
19 | ### 返回
20 |
21 | 返回一个用于连接 `websocket` 的地址。
22 |
23 | ### 错误码
24 |
25 | 详见[错误码](../../openapi/error/error.md)。
26 |
27 | ### 示例
28 |
29 | 响应数据包
30 |
31 | ```json
32 | {
33 | "url": "wss://api.sgroup.qq.com/websocket/"
34 | }
35 | ```
36 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/README.md:
--------------------------------------------------------------------------------
1 | # 频道模块
2 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/api_permissions/README.md:
--------------------------------------------------------------------------------
1 | # 频道模块
2 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/api_permissions/get_guild_api_permission.md:
--------------------------------------------------------------------------------
1 | # 获取机器人在频道可用权限列表
2 |
3 | ## 接口
4 |
5 | ```http
6 | GET /guilds/{guild_id}/api_permission
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于获取机器人在频道 `guild_id` 内可以使用的权限列表。
12 |
13 | ## Content-Type
14 |
15 | ```http
16 | application/json
17 | ```
18 |
19 | ## 返回
20 |
21 | | 字段名 | 类型 | 描述 |
22 | | ------ | ------------------------------------------------ | ------------------ |
23 | | apis | [APIPermission](model.md#APIPermission) 对象数组 | 机器人可用权限列表 |
24 |
25 | ## 错误码
26 |
27 | 详见[错误码](../../../openapi/error/error.md)。
28 |
29 | ## 示例
30 |
31 | 响应数据包
32 |
33 | ```json
34 | {
35 | "apis": [
36 | {
37 | "path": "/guilds/{guild_id}/members/{user_id}",
38 | "method": "GET",
39 | "desc": "获取当前频道成员信息",
40 | "auth_status": 0
41 | },
42 | {
43 | "path": "/channels/{channel_id}/messages",
44 | "method": "POST",
45 | "desc": "创建消息",
46 | "auth_status": 1
47 | }
48 | ]
49 | }
50 | ```
51 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/README.md:
--------------------------------------------------------------------------------
1 | # 频道模块
2 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/announces/delete_channel_announces.md:
--------------------------------------------------------------------------------
1 | # 删除子频道公告（2022年3月15日后废弃）
2 |
3 | ## 接口
4 |
5 | ```http
6 | DELETE /channels/{channel_id}/announces/{message_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于删除子频道 `channel_id` 下指定 `message_id` 的子频道公告（）。
12 | - **此接口在 APP `v8.8.65` 后不保证完全兼容并且2022年3月15日后会废弃，如需此功能请使用 [删除精华消息](../pins/delete_pins_message.md)**
13 | - `message_id` 有值时，会校验 `message_id` 合法性，若不校验校验 `message_id`，请将 `message_id` 设置为 `all`。
14 |
15 | ## Content-Type
16 |
17 | ```http
18 | application/json
19 | ```
20 |
21 | ## 返回
22 |
23 | 成功返回 HTTP 状态码 `204`。
24 |
25 | ## 错误码
26 |
27 | 详见[错误码](../../../../openapi/error/error.md)。
28 |
29 | ## 示例
30 |
31 | 请求数据包
32 |
33 | ```code
34 | DELETE /channels/123456/announces/112233
35 | ```
36 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/announces/delete_guild_announces.md:
--------------------------------------------------------------------------------
1 | # 删除频道公告
2 |
3 | ## 接口
4 |
5 | ```http
6 | DELETE /guilds/{guild_id}/announces/{message_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于删除频道 `guild_id` 下指定 `message_id` 的全局公告。
12 |
13 | - `message_id` 有值时，会校验 `message_id` 合法性，若不校验校验 `message_id`，请将 `message_id` 设置为 `all`。
14 |
15 | ## Content-Type
16 |
17 | ```http
18 | application/json
19 | ```
20 |
21 | ## 返回
22 |
23 | 成功返回 HTTP 状态码 `204`。
24 |
25 | ## 错误码
26 |
27 | 详见[错误码](../../../../openapi/error/error.md)。
28 |
29 | ## 示例
30 |
31 | 请求数据包
32 |
33 | ```code
34 | DELETE /guilds/123456/announces/112233
35 | ```
36 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/announces/model.md:
--------------------------------------------------------------------------------
1 | # 公告对象(Announces)
2 |
3 | ## Announces
4 |
5 | | 字段名 | 类型 | 描述 |
6 | |--------------------|-------------------------------------------|---------------------------|
7 | | guild_id | string | 频道 id |
8 | | channel_id | string | 子频道 id |
9 | | message_id | string | 消息 id |
10 | | announces_type | uint32 | 公告类别 0:成员公告 1:欢迎公告，默认成员公告 |
11 | | recommend_channels | [RecommendChannel](#RecommendChannel) 数组 | 推荐子频道详情列表 |
12 |
13 | # 推荐子频道对象(RecommendChannel)
14 |
15 | ## RecommendChannel
16 |
17 | | 字段名 | 类型 | 描述 |
18 | |:-----------|--------|--------|
19 | | channel_id | string | 子频道 id |
20 | | introduce | string | 推荐语 |
21 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/announces/post_channel_announces.md:
--------------------------------------------------------------------------------
1 | # 创建子频道公告（2022年3月15日后废弃）
2 |
3 | ## 接口
4 |
5 | ```http
6 | POST /channels/{channel_id}/announces
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于将子频道 `channel_id` 内的某条消息设置为子频道公告。
12 | - **此接口在 APP `v8.8.65` 后不保证完全兼容并且2022年3月15日后会废弃，如需此功能请使用 [添加精华消息](../pins/put_pins_message.md)**
13 |
14 | ## Content-Type
15 |
16 | ```http
17 | application/json
18 | ```
19 |
20 | ## 参数
21 |
22 | | 字段名 | 类型 | 描述 |
23 | |------------|--------|-------|
24 | | message_id | string | 消息 id |
25 |
26 | ## 返回
27 |
28 | 返回[Announces](model.md#Announces) 对象。
29 |
30 | ## 错误码
31 |
32 | 详见[错误码](../../../../openapi/error/error.md)。
33 |
34 | ## 示例
35 |
36 | 请求数据包
37 |
38 | ```json
39 | {
40 | "message_id": "xxxxxx"
41 | }
42 | ```
43 |
44 | 响应数据包
45 |
46 | ```json
47 | {
48 | "guild_id": "xxxxxx",
49 | "channel_id": "xxxxxx",
50 | "message_id": "xxxxxx"
51 | }
52 | ```
53 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/audio/audio_control.md:
--------------------------------------------------------------------------------
1 | # 音频控制
2 |
3 | ## 接口
4 |
5 | ```http
6 | POST /channels/{channel_id}/audio
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于控制子频道 `channel_id` 下的音频。
12 |
13 | - 音频接口：仅限**音频类机器人**才能使用，后续会根据机器人类型自动开通接口权限，现如需调用，需联系平台申请权限。
14 |
15 | ## Content-Type
16 |
17 | ```http
18 | application/json
19 | ```
20 |
21 | ## 参数
22 |
23 | 参照 [AudioControl](model.md#audiocontrol)。
24 |
25 | ## 返回
26 |
27 | 成功返回空对象。
28 |
29 | ```json
30 | {}
31 | ```
32 |
33 | ## 错误码
34 |
35 | 详见[错误码](../../../../openapi/error/error.md)。
36 |
37 | ## 示例
38 |
39 | 请求数据包
40 |
41 | ```json
42 | {
43 | "audio_url": "http:/xxxxx.mp3",
44 | "text": "xxx",
45 | "status": 0
46 | }
47 | ```
48 |
49 | 响应数据包
50 |
51 | ```json
52 | {}
53 | ```
54 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/audio/delete_mic.md:
--------------------------------------------------------------------------------
1 | # 机器人下麦
2 |
3 | ## 接口
4 |
5 | ```http
6 | DELETE /channels/{channel_id}/mic
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 机器人在 `channel_id` 对应的语音子频道下麦。
12 |
13 | 音频接口：仅限音频类机器人才能使用，后续会根据机器人类型自动开通接口权限，现如需调用，需联系平台申请权限。
14 |
15 | ## Content-Type
16 |
17 | ```http
18 | application/json
19 | ```
20 |
21 | ## 参数
22 |
23 | url参数：channel_id
24 |
25 | ## 返回
26 |
27 | 成功返回空对象。
28 |
29 | ```json
30 | {}
31 | ```
32 |
33 | ## 错误码
34 |
35 | 详见[错误码](../../../../openapi/error/error.md)。
36 |
37 | ## 示例
38 |
39 | 请求数据包
40 |
41 | ```json
42 | {}
43 | ```
44 |
45 | 响应数据包
46 |
47 | ```json
48 | {}
49 | ```
50 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/audio/model.md:
--------------------------------------------------------------------------------
1 | # 语音对象
2 |
3 | ## AudioControl
4 | | 字段名 | 类型 | 描述 |
5 | | --------- | ------ | ------------------------------------------------------------------ |
6 | | audio_url | string | 音频数据的url status为0时传 |
7 | | text | string | 状态文本（比如：简单爱-周杰伦），可选，status为0时传，其他操作不传 |
8 | | status | STATUS | 播放状态，参考 STATUS |
9 |
10 | ## STATUS
11 | | 字段名 | 值 | 描述 |
12 | | ------ | --- | ------------ |
13 | | START | 0 | 开始播放操作 |
14 | | PAUSE | 1 | 暂停播放操作 |
15 | | RESUME | 2 | 继续播放操作 |
16 | | STOP | 3 | 停止播放操作 |
17 |
18 |
19 | ## AudioAction
20 | | 字段名 | 类型 | 描述 |
21 | | ---------- | ------ | ------------------------------------------------------------------ |
22 | | guild_id | string | 频道id |
23 | | channel_id | string | 子频道id |
24 | | audio_url | string | 音频数据的url status为0时传 |
25 | | text | string | 状态文本（比如：简单爱-周杰伦），可选，status为0时传，其他操作不传 |
26 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/audio/put_mic.md:
--------------------------------------------------------------------------------
1 | # 机器人上麦
2 |
3 | ## 接口
4 |
5 | ```http
6 | PUT /channels/{channel_id}/mic
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 机器人在 `channel_id` 对应的语音子频道上麦。
12 |
13 | 音频接口：仅限音频类机器人才能使用，后续会根据机器人类型自动开通接口权限，现如需调用，需联系平台申请权限。
14 |
15 | ## Content-Type
16 |
17 | ```http
18 | application/json
19 | ```
20 |
21 | ## 参数
22 |
23 | url参数：channel_id
24 |
25 | ## 返回
26 |
27 | 成功返回空对象。
28 |
29 | ```json
30 | {}
31 | ```
32 |
33 | ## 错误码
34 |
35 | 详见[错误码](../../../../openapi/error/error.md)。
36 |
37 | ## 示例
38 |
39 | 请求数据包
40 |
41 | ```json
42 | {}
43 | ```
44 |
45 | 响应数据包
46 |
47 | ```json
48 | {}
49 | ```
50 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/forum/delete_thread.md:
--------------------------------------------------------------------------------
1 | # 删除帖子
2 |
3 | ## 接口
4 |
5 | ```http
6 | DELETE /channels/{channel_id}/threads/{thread_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | - 该接口用于删除指定子频道下的某个帖子。
12 |
13 |
14 |
15 | ## Content-Type
16 |
17 | ```http
18 | application/json
19 | ```
20 |
21 | ## 错误码
22 |
23 | 详见[错误码](../../../../openapi/error/error.md)。
24 |
25 | ## 返回
26 |
27 | HTTP 状态码 `204`
28 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/forum/open_forum.md:
--------------------------------------------------------------------------------
1 | # 开放论坛事件对象(OpenForumEvent)
2 |
3 | ## OEPN_FORUM_EVENT（intents OPEN_FORUM_EVENT）
4 |
5 | **发送时机**
6 | - 用户在话题子频道内发帖、评论、回复评论时产生该事件
7 |
8 | ## 主题事件
9 | - OPEN_FORUM_THREAD_CREATE
10 | - OPEN_FORUM_THREAD_UPDATE
11 | - OPEN_FORUM_THREAD_DELETE
12 |
13 | ### 示例
14 | ```json
15 | {
16 | "guild_id": "47129941624960822",
17 | "channel_id": "1661124",
18 | "author_id": "144115218182563108",
19 | }
20 | ```
21 |
22 | ## 帖子事件
23 | - OPEN_FORUM_POST_CREATE
24 | - OPEN_FORUM_POST_DELETE
25 |
26 | ### 示例
27 | ```json
28 | {
29 | "guild_id": "47129941624960822",
30 | "channel_id": "1661124",
31 | "author_id": "144115218182563108",
32 | }
33 | ```
34 |
35 | ## 回复事件
36 | - OPEN_FORUM_REPLY_CREATE
37 | - OPEN_FORUM_REPLY_DELETE
38 |
39 | ### 示例
40 | ```json
41 | {
42 | "guild_id": "47129941624960822",
43 | "channel_id": "1661124",
44 | "author_id": "144115218182563108",
45 | }
46 | ```
47 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/pins/delete_pins_message.md:
--------------------------------------------------------------------------------
1 | # 删除精华消息
2 |
3 | ## 接口
4 |
5 | ```http
6 | DELETE /channels/{channel_id}/pins/{message_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于删除子频道 `channel_id` 下指定 `message_id` 的精华消息。
12 |
13 | - 删除子频道内全部精华消息，请将 `message_id` 设置为 `all`。
14 |
15 | ## Content-Type
16 |
17 | ```http
18 | application/json
19 | ```
20 |
21 | ## 返回
22 |
23 | 成功返回 HTTP 状态码 `204`。
24 |
25 | ## 错误码
26 |
27 | 详见[错误码](../../../../openapi/error/error.md)。
28 |
29 | ## 示例
30 |
31 | 请求数据包
32 |
33 | ```code
34 | DELETE /channels/123456/pins/112233
35 | ```
36 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/pins/get_pins_message.md:
--------------------------------------------------------------------------------
1 | # 获取精华消息
2 |
3 | ## 接口
4 |
5 | ```http
6 | GET /channels/{channel_id}/pins
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于获取子频道 `channel_id` 内的精华消息。
12 |
13 | ## Content-Type
14 |
15 | ```http
16 | application/json
17 | ```
18 |
19 | ## 返回
20 |
21 | 返回 [PinsMessage](model.md#PinsMessage) 对象。
22 |
23 | ## 错误码
24 |
25 | 详见[错误码](../../../../openapi/error/error.md)。
26 |
27 | ## 示例
28 |
29 | 响应数据包
30 |
31 | ```json
32 | {
33 | "guild_id": "xxxxxx",
34 | "channel_id": "xxxxxx",
35 | "message_ids": ["xxxxx"]
36 | }
37 | ```
38 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/pins/model.md:
--------------------------------------------------------------------------------
1 | # 精华消息对象(PinsMessage)
2 |
3 | ## PinsMessage
4 |
5 | | 字段名 | 类型 | 描述 |
6 | |-------------|-----------|-----------------|
7 | | guild_id | string | 频道 id |
8 | | channel_id | string | 子频道 id |
9 | | message_ids | string 数组 | 子频道内精华消息 id 数组 |
10 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/pins/put_pins_message.md:
--------------------------------------------------------------------------------
1 | # 添加精华消息
2 |
3 | ## 接口
4 |
5 | ```http
6 | PUT /channels/{channel_id}/pins/{message_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于添加子频道 `channel_id` 内的精华消息。
12 |
13 | - 精华消息在一个子频道内最多只能创建 `20` 条。
14 | - 只有可见的消息才能被设置为精华消息。
15 | - 接口返回对象中 `message_ids` 为当前请求后子频道内所有精华消息 `message_id` 数组。
16 |
17 | ## Content-Type
18 |
19 | ```http
20 | application/json
21 | ```
22 |
23 | ## 返回
24 |
25 | 返回 [PinsMessage](model.md#PinsMessage) 对象。
26 |
27 | ## 错误码
28 |
29 | 详见[错误码](../../../../openapi/error/error.md)。
30 |
31 | ## 示例
32 |
33 | 请求数据包
34 |
35 | ```code
36 | PUT /channels/123456/pins/112233
37 | ```
38 |
39 | 响应数据包
40 |
41 | ```json
42 | {
43 | "guild_id": "xxxxxx",
44 | "channel_id": "xxxxxx",
45 | "message_ids": ["xxxxx"]
46 | }
47 | ```
48 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/schedule/delete_schedule.md:
--------------------------------------------------------------------------------
1 | # 删除日程
2 |
3 | ## 接口
4 |
5 | ```http
6 | DELETE /channels/{channel_id}/schedules/{schedule_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于删除日程子频道 `channel_id` 下 `schedule_id` 指定的日程。
12 |
13 | - 要求操作人具有`管理频道`的权限，如果是机器人，则需要将机器人设置为管理员。
14 |
15 | ## Content-Type
16 |
17 | ```http
18 | application/json
19 | ```
20 |
21 | ## 返回
22 |
23 | 成功返回 HTTP 状态码 `204`。
24 |
25 | ## 错误码
26 |
27 | 详见[错误码](../../../../openapi/error/error.md)。
28 |
29 | ## 示例
30 |
31 | 请求数据包
32 |
33 | ```shell
34 | DELETE /channels/123456/schedules/112233
35 | ```
36 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/schedule/get_schedule.md:
--------------------------------------------------------------------------------
1 | # 获取日程详情
2 |
3 | ## 接口
4 |
5 | ```http
6 | GET /channels/{channel_id}/schedules/{schedule_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 获取日程子频道 `channel_id` 下 `schedule_id` 指定的的日程的详情。
12 |
13 | ## Content-Type
14 |
15 | ```http
16 | application/json
17 | ```
18 |
19 | ## 返回
20 |
21 | 返回 [Schedule](model.md#schedule) 对象。
22 |
23 | ## 错误码
24 |
25 | 详见[错误码](../../../../openapi/error/error.md)。
26 |
27 | ## 示例
28 |
29 | 请求数据包
30 |
31 | ```shell
32 | GET /channels/123455/schedules/112233
33 | ```
34 |
35 | 响应数据包
36 |
37 | ```json
38 | {
39 | "id": "112233",
40 | "name": "上王者",
41 | "start_timestamp": "1642076400000",
42 | "end_timestamp": "1642083600000",
43 | "creator": {
44 | "user": {
45 | "id": "xxxxxx",
46 | "username": "xxxxxx",
47 | "bot": true
48 | },
49 | "nick": "",
50 | "joined_at": "2022-01-11T10:24:13+08:00"
51 | },
52 | "jump_channel_id": "0",
53 | "remind_type": "0"
54 | }
55 | ```
56 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/content/schedule/get_schedules.md:
--------------------------------------------------------------------------------
1 | # 获取频道日程列表
2 |
3 | ## 接口
4 |
5 | ```http
6 | GET /channels/{channel_id}/schedules
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于获取`channel_id`指定的子频道中当天的日程列表。
12 |
13 | - 若带了参数 `since`，则返回结束时间在 `since` 之后的日程列表；若未带参数 `since`，则默认返回当天的日程列表。
14 |
15 | ## Content-Type
16 |
17 | ```http
18 | application/json
19 | ```
20 |
21 | ## 参数
22 |
23 | | 字段名 | 类型 | 描述 |
24 | | ------ | ------ | ------------------ |
25 | | since | uint64 | 起始时间戳(**ms**) |
26 |
27 | ## 返回
28 |
29 | 返回 [Schedule](model.md#schedule) 对象数组。
30 |
31 | ## 错误码
32 |
33 | 详见[错误码](../../../../openapi/error/error.md)。
34 |
35 | ## 示例
36 |
37 | 请求数据包
38 |
39 | ```json
40 | {
41 | "since": 1642076400000
42 | }
43 | ```
44 |
45 | 响应数据包
46 |
47 | ```json
48 | [
49 | {
50 | "id": "xxxxxx",
51 | "name": "上王者",
52 | "start_timestamp": "1642076400000",
53 | "end_timestamp": "1642083600000",
54 | "creator": {
55 | "user": {
56 | "id": "xxxxxx",
57 | "username": "xxxxxx",
58 | "bot": true
59 | },
60 | "nick": "",
61 | "joined_at": "2022-01-11T10:24:13+08:00"
62 | },
63 | "jump_channel_id": "0",
64 | "remind_type": "0"
65 | }
66 | ]
67 | ```
68 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/manage/README.md:
--------------------------------------------------------------------------------
1 | # 频道模块
2 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/manage/channel/delete_channel.md:
--------------------------------------------------------------------------------
1 | # 删除子频道
2 |
3 | ## 接口
4 |
5 | ```http
6 | DELETE /channels/{channel_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于删除 `channel_id` 指定的子频道。
12 |
13 | - 要求操作人具有`管理子频道`的权限，如果是机器人，则需要将机器人设置为管理员。
14 | - 修改成功后，会触发**子频道删除事件**。
15 |
16 |
17 |
18 | ## Content-Type
19 |
20 | ```http
21 | application/json
22 | ```
23 |
24 | ## 返回
25 |
26 | 成功返回 HTTP 状态码 `200`。
27 |
28 | ## 错误码
29 |
30 | 详见[错误码](../../../../openapi/error/error.md)。
31 |
32 | ## 示例
33 |
34 | 请求数据包
35 |
36 | ```shell
37 | DELETE /channels/123456
38 | ```
39 |
40 | ## 注意
41 |
42 | **子频道的删除是无法撤回的，一旦删除，将无法恢复。**
43 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/manage/channel/get_channel.md:
--------------------------------------------------------------------------------
1 | # 获取子频道详情
2 |
3 | ## 接口
4 |
5 | ```http
6 | GET /channels/{channel_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于获取 `channel_id` 指定的子频道的详情。
12 |
13 | ## Content-Type
14 |
15 | ```http
16 | application/json
17 | ```
18 |
19 | ## 返回
20 |
21 | 返回[Channel](model.md#channel) 对象。
22 |
23 | ## 错误码
24 |
25 | 详见[错误码](../../../../openapi/error/error.md)。
26 |
27 | ## 示例
28 |
29 | 请求数据包
30 |
31 | ```shell
32 | GET /channels/123456
33 | ```
34 |
35 | 响应数据包
36 |
37 | ```json
38 | {
39 | "id": "123456",
40 | "guild_id": "xxxxxx",
41 | "name": "很高兴遇见你",
42 | "type": 4,
43 | "position": 2,
44 | "owner_id": "0",
45 | "sub_type": 0,
46 | "private_type": 0,
47 | "speak_permission": 0,
48 | "application_id": "0"
49 | }
50 | ```
51 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/manage/event/channel.md:
--------------------------------------------------------------------------------
1 | # 子频道事件
2 |
3 | ## 内容
4 |
5 | 在 [Channel](../channel/model.md#channel) 的**部分字段**基础上，增加 `op_user_id` 代表操作人。
6 |
7 | ## CHANNEL_CREATE
8 |
9 | ### 发送时机
10 |
11 | - 子频道被创建
12 |
13 | ### 示例
14 |
15 | ```json
16 | {
17 | "guild_id": "200000000",
18 | "id": "2943679",
19 | "name": "测试",
20 | "op_user_id": "100000000",
21 | "owner_id": "100000000",
22 | "sub_type": 0,
23 | "type": 0
24 | }
25 | ```
26 |
27 | ## CHANNEL_UPDATE
28 |
29 | ### 发送时机
30 |
31 | - 子频道信息变更
32 |
33 | ### 示例
34 |
35 | ```json
36 | {
37 | "guild_id": "200000000",
38 | "id": "2943679",
39 | "name": "测试2",
40 | "op_user_id": "100000000",
41 | "owner_id": "100000000",
42 | "sub_type": 0,
43 | "type": 0
44 | }
45 | ```
46 |
47 | ## CHANNEL_DELETE
48 |
49 | ### 发送时机
50 |
51 | - 子频道被删除
52 |
53 | ### 示例
54 |
55 | ```json
56 | {
57 | "guild_id": "200000000",
58 | "id": "2943679",
59 | "name": "测试2",
60 | "op_user_id": "100000000",
61 | "owner_id": "100000000",
62 | "sub_type": 0,
63 | "type": 0
64 | }
65 | ```
66 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/manage/guild/get_guild.md:
--------------------------------------------------------------------------------
1 | # 获取频道详情
2 |
3 | ## 接口
4 |
5 | ```http
6 | GET /guilds/{guild_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于获取 `guild_id` 指定的频道的详情。
12 |
13 | ## Content-Type
14 |
15 | ```http
16 | application/json
17 | ```
18 |
19 | ## 返回
20 |
21 | 返回[Guild](model.md#guild) 对象。
22 |
23 | ## 错误码
24 |
25 | 详见[错误码](../../../../openapi/error/error.md)。
26 |
27 | ## 示例
28 |
29 | 请求数据包
30 |
31 | ```shell
32 | GET /guilds/123456
33 | ```
34 |
35 | 响应数据包
36 |
37 | ```json
38 | {
39 | "id": "123456",
40 | "name": "xxxxxx",
41 | "icon": "xxxxxx",
42 | "owner_id": "xxxxxx",
43 | "owner": false,
44 | "joined_at": "2022-01-13T11:02:21+08:00",
45 | "member_count": 5,
46 | "max_members": 300,
47 | "description": "千江有水千江月，万里无云万里天"
48 | }
49 | ```
50 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/manage/guild/model.md:
--------------------------------------------------------------------------------
1 | # 频道对象(Guild)
2 |
3 | 频道对象中所涉及的 ID 类数据，都仅在机器人场景流通，与真实的 ID 无关。请不要理解为真实的 ID
4 |
5 | ## Guild
6 | | 字段名 | 类型 | 描述 |
7 | | --- | --- | --- |
8 | | id | string | 频道ID |
9 | | name | string | 频道名称 |
10 | | icon | string | 频道头像地址 |
11 | | owner_id | string | 创建人用户ID |
12 | | owner | bool | 当前人是否是创建人 |
13 | | member_count | int | 成员数 |
14 | | max_members | int | 最大成员数 |
15 | | description | string | 描述 |
16 | | joined_at | string | 加入时间 |
17 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/manage/user/me.md:
--------------------------------------------------------------------------------
1 | # 获取用户详情
2 |
3 | ## 接口
4 |
5 | ```http
6 | GET /users/@me
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于获取当前用户（机器人）详情。
12 |
13 | ## Content-Type
14 |
15 | ```http
16 | application/json
17 | ```
18 |
19 | ## 返回
20 |
21 | 返回 [User](model.md#user) 对象。
22 |
23 | ## 错误码
24 |
25 | 详见[错误码](../../../../openapi/error/error.md)。
26 |
27 | ## 示例
28 |
29 | 响应数据包
30 |
31 | ```json
32 | {
33 | "id": "11586990140073229091",
34 | "username": "gitsub",
35 | "avatar": "https://thirdqq.qlogo.cn/g?b=oidb&k=M5TibpXicS7Jt4z89BZxiamAA&s=100&t=1641802698",
36 | "union_openid": "74F138F7F3AF68C4B8E8325013FCA295",
37 | "union_user_account": ""
38 | }
39 | ```
40 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/manage/user/model.md:
--------------------------------------------------------------------------------
1 | # 用户对象(User)
2 |
3 | 用户对象中所涉及的 ID 类数据，都仅在机器人场景流通，与真实的 ID 无关。请不要理解为真实的 ID
4 |
5 | ## User
6 |
7 | | 字段名 | 类型 | 描述 |
8 | |--------------------|--------|--------------------------------------------------------|
9 | | id | string | 用户 id |
10 | | username | string | 用户名 |
11 | | avatar | string | 用户头像地址 |
12 | | bot | bool | 是否是机器人 |
13 | | union_openid | string | 特殊关联应用的 openid，需要特殊申请并配置后才会返回。如需申请，请联系平台运营人员。 |
14 | | union_user_account | string | 机器人关联的互联应用的用户信息，与union_openid关联的应用是同一个。如需申请，请联系平台运营人员。 |
15 |
16 | ## 提示
17 |
18 | `union_openid` 与 `union_user_account` 只有在单独拉取 member 信息的时候才会提供，在其他的事件中所携带的 user 对象，均无这两个字段的内容。
19 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/miniapp/README.md:
--------------------------------------------------------------------------------
1 | # 频道模块
2 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/miniapp/opendata.md:
--------------------------------------------------------------------------------
1 | # 开放数据域加密
2 |
3 | ## 背景
4 |
5 | 由于小程序没有用于跟平台接口进行后台鉴权使用的用户票据。
6 | 所以开发者在小程序前端鉴权会后，如果还需要将鉴权结果传递给自己的后台，做后台鉴权，这个时候在后台中需要机遇 session key 针对 rawData 进行签名验证来保证数据没有被篡改过。
7 |
8 | ## 开放数据加密-参考文档
9 |
10 | https://q.qq.com/wiki/develop/game/frame/open-ability/signature.html
11 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role-group/README.md:
--------------------------------------------------------------------------------
1 | # 频道模块
2 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role-group/channel_permissions/get_channel_permissions.md:
--------------------------------------------------------------------------------
1 | # 获取子频道用户权限
2 |
3 | ## 接口
4 |
5 | ```http
6 | GET /channels/{channel_id}/members/{user_id}/permissions
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于获取 子频道`channel_id` 下用户 `user_id` 的权限。
12 |
13 | - 获取子频道用户权限。
14 | - 要求操作人具有管理子频道的权限，如果是机器人，则需要将机器人设置为管理员。
15 |
16 | ## Content-Type
17 |
18 | ```http
19 | application/json
20 | ```
21 |
22 | ## 返回
23 |
24 | 返回 [ChannelPermissions](model.md#channelpermissions) 对象。
25 |
26 | ## 错误码
27 |
28 | 详见[错误码](../../../../openapi/error/error.md)。
29 |
30 |
31 | ## 示例
32 |
33 | 请求数据包
34 |
35 | ```shell
36 | GET /channels/123456/members/112233/permissions
37 | ```
38 |
39 | 响应数据包
40 |
41 | ```json
42 | {
43 | "channel_id": "123456",
44 | "user_id": "112233",
45 | "permissions": "4"
46 | }
47 | ```
48 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role-group/channel_permissions/get_channel_roles_permissions.md:
--------------------------------------------------------------------------------
1 | # 获取子频道身份组权限
2 |
3 | ## 接口
4 |
5 | ```http
6 | GET /channels/{channel_id}/roles/{role_id}/permissions
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于获取子频道 `channel_id` 下身份组 `role_id` 的权限。
12 |
13 | - 要求操作人具有管理子频道的权限，如果是机器人，则需要将机器人设置为管理员。
14 |
15 | ## Content-Type
16 |
17 | ```http
18 | application/json
19 | ```
20 |
21 | ## 返回
22 |
23 | 返回 [ChannelPermissions](model.md#channelpermissions) 对象。
24 |
25 | ## 错误码
26 |
27 | 详见[错误码](../../../../openapi/error/error.md)。
28 |
29 | ## 示例
30 |
31 | 请求数据包
32 |
33 | ```shell
34 | GET /channels/123456/roles/112233/permissions
35 | ```
36 |
37 | 响应数据包
38 |
39 | ```json
40 | {
41 | "channel_id": "123456",
42 | "role_id": "112233",
43 | "permissions": "5"
44 | }
45 | ```
46 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role-group/channel_permissions/model.md:
--------------------------------------------------------------------------------
1 | # 子频道权限对象(ChannelPermissions)
2 |
3 | ## ChannelPermissions
4 | | 字段名 | 类型 | 描述 |
5 | | --- | --- | --- |
6 | | channel_id | string | 子频道 id |
7 | | user_id/role_id | string | 用户 id 或 身份组 id，只会返回其中之一|
8 | | [permissions](#Permissions) | string | 用户拥有的子频道权限 |
9 |
10 | ## Permissions
11 |
12 | 权限是QQ频道管理频道成员的一种方式，管理员可以对不同的人、不同的子频道设置特定的权限。用户的权限包括**个人权限**和**身份组权限**两部分，最终生效是取两种权限的并集。
13 |
14 | 权限使用位图表示，传递时序列化为十进制数值字符串。如权限值为`0x6FFF`，会被序列化为十进制`"28671"`。
15 |
16 | | 权限 | 值 | 描述 |
17 | | --- | --- | --- |
18 | | 可查看子频道 | 0x0000000001 (1 << 0) | 支持`指定成员`可见类型，支持`身份组`可见类型 |
19 | | 可管理子频道 | 0x0000000002 (1 << 1) | 创建者、管理员、子频道管理员都具有此权限 |
20 | | 可发言子频道 | 0x0000000004 (1 << 2) | 支持`指定成员`发言类型，支持`身份组`发言类型 |
21 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role-group/channel_permissions/put_channel_permissions.md:
--------------------------------------------------------------------------------
1 | # 修改子频道用户权限
2 |
3 | ## 接口
4 |
5 | ```http
6 | PUT /channels/{channel_id}/members/{user_id}/permissions
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于修改子频道 `channel_id` 下用户 `user_id` 的权限。
12 |
13 | - 要求操作人具有`管理子频道`的权限，如果是机器人，则需要将机器人设置为管理员。
14 | - 参数包括`add`和`remove`两个字段，分别表示授予的权限以及删除的权限。要授予用户权限即把`add`对应位置 1，删除用户权限即把`remove`对应位置 1。当两个字段同一位都为 1，表现为删除权限。
15 | - 本接口不支持修改`可管理子频道`权限。
16 |
17 | ## Content-Type
18 |
19 | ```http
20 | application/json
21 | ```
22 |
23 | ## 参数
24 |
25 | | 字段名 | 类型 | 描述 |
26 | | ----------------------------- | ------ | ---------------------------------- |
27 | | [add](model.md#permission) | string | 字符串形式的位图表示赋予用户的权限 |
28 | | [remove](model.md#permission) | string | 字符串形式的位图表示删除用户的权限 |
29 |
30 | ## 返回
31 |
32 | 成功返回 HTTP 状态码 `204`。
33 |
34 | ## 错误码
35 |
36 | 详见[错误码](../../../../openapi/error/error.md)。
37 |
38 | ## 示例
39 |
40 | 请求数据包
41 |
42 | ```json
43 | {
44 | "add": "1",
45 | "remove": "4"
46 | }
47 | ```
48 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role-group/channel_permissions/put_channel_roles_permissions.md:
--------------------------------------------------------------------------------
1 | # 修改子频道身份组权限
2 |
3 | ## 接口
4 |
5 | ```http
6 | PUT /channels/{channel_id}/roles/{role_id}/permissions
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于修改子频道 channel_id 下身份组 role_id 的权限。
12 |
13 | - 要求操作人具有`管理子频道`的权限，如果是机器人，则需要将机器人设置为管理员。
14 | - 参数包括`add`和`remove`两个字段，分别表示授予的权限以及删除的权限。要授予身份组权限即把`add`对应位置 1，删除身份组权限即把`remove`对应位置 1。当两个字段同一位都为 1，表现为删除权限。
15 | - 本接口不支持修改`可管理子频道`权限。
16 |
17 | ## Content-Type
18 |
19 | ```http
20 | application/json
21 | ```
22 |
23 | ## 参数
24 |
25 | | 字段名 | 类型 | 描述 |
26 | | ----------------------------- | ------ | ---------------------------------- |
27 | | [add](model.md#permission) | string | 字符串形式的位图表示赋予用户的权限 |
28 | | [remove](model.md#permission) | string | 字符串形式的位图表示删除用户的权限 |
29 |
30 | ## 返回
31 |
32 | 成功返回 HTTP 状态码 `204`。
33 |
34 | ## 错误码
35 |
36 | 详见[错误码](../../../../openapi/error/error.md)。
37 |
38 | ## 示例
39 |
40 | 请求数据包
41 |
42 | ```json
43 | {
44 | "add": "1",
45 | "remove": "4"
46 | }
47 | ```
48 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role-group/delete_guild_member_role.md:
--------------------------------------------------------------------------------
1 | # 删除频道身份组成员
2 |
3 | ## 接口
4 |
5 | ```http
6 | DELETE /guilds/{guild_id}/members/{user_id}/roles/{role_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于将 用户 `user_id` 从 频道 `guild_id` 的 `role_id` 身份组中移除。
12 |
13 | - 需要使用的 `token` 对应的用户具备删除身份组成员权限。如果是机器人，要求被添加为管理员。
14 | - 如果要删除的身份组 `ID` 是`5-子频道管理员`，需要增加 channel 对象来指定具体是哪个子频道。
15 |
16 | ## Content-Type
17 |
18 | ```http
19 | application/json
20 | ```
21 |
22 | ## 参数
23 |
24 | | 字段名 | 类型 | 描述 |
25 | | ------- | ------------------------------------------- | ------------------------------------ |
26 | | channel | [Channel](../manage/channel/model.md#Channel) 对象 | 接收一个只填充了子频道 id 字段的对象 |
27 |
28 | ## 返回
29 |
30 | 成功返回 HTTP 状态码 `204`。
31 |
32 | ## 错误码
33 |
34 | 详见[错误码](../../../openapi/error/error.md)。
35 |
36 | ## 示例
37 |
38 | 请求数据包
39 |
40 | ```shell
41 | DELETE /guilds/123456/members/112233/roles/445566
42 | ```
43 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role-group/delete_guild_role.md:
--------------------------------------------------------------------------------
1 | # 删除频道身份组
2 |
3 | ## 接口
4 |
5 | ```http
6 | DELETE /guilds/{guild_id}/roles/{role_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于删除频道`guild_id`下 `role_id` 对应的身份组。
12 |
13 | - 需要使用的 `token` 对应的用户具备删除身份组权限。如果是机器人，要求被添加为管理员。
14 |
15 | ## Content-Type
16 |
17 | ```http
18 | application/json
19 | ```
20 |
21 | ## 返回
22 |
23 | 成功返回 HTTP 状态码 `204`。
24 |
25 | ## 错误码
26 |
27 | 详见[错误码](../../../openapi/error/error.md)。
28 |
29 | ## 示例
30 |
31 | 请求数据包
32 |
33 | ```shell
34 | DELETE /guilds/123456/roles/112233
35 | ```
36 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role-group/put_guild_member_role.md:
--------------------------------------------------------------------------------
1 | # 创建频道身份组成员
2 |
3 | ## 接口
4 |
5 | ```http
6 | PUT /guilds/{guild_id}/members/{user_id}/roles/{role_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于将频道`guild_id`下的用户 `user_id` 添加到身份组 `role_id` 。
12 |
13 | - 需要使用的 `token` 对应的用户具备增加身份组成员权限。如果是机器人，要求被添加为管理员。
14 | - 如果要增加的身份组 `ID` 是`5-子频道管理员`，需要增加 `channel` 对象来指定具体是哪个子频道。
15 |
16 | ## Content-Type
17 |
18 | ```http
19 | application/json
20 | ```
21 |
22 | ## 参数
23 |
24 | | 字段名 | 类型 | 描述 |
25 | | ------- | ------------------------------------------- | ------------------------------------ |
26 | | channel | [Channel](../manage/channel/model.md#Channel) 对象 | 接收一个只填充了子频道 id 字段的对象 |
27 |
28 | ## 返回
29 |
30 | 成功返回 HTTP 状态码 `204`。
31 |
32 | ## 错误码
33 |
34 | 详见[错误码](../../../openapi/error/error.md)。
35 |
36 |
37 | ## 示例
38 |
39 | 请求数据包
40 |
41 | ```json
42 | {
43 | "channel": {
44 | "id": "1744939"
45 | }
46 | }
47 | ```
48 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role/README.md:
--------------------------------------------------------------------------------
1 | # 频道模块
2 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role/audio_or_live_channel_member.md:
--------------------------------------------------------------------------------
1 | # 音视频/直播子频道成员进出事件
2 |
3 | ## AUDIO_OR_LIVE_CHANNEL_MEMBER_ENTER
4 |
5 | ### 发送时机
6 | - 用户进入音视频/直播子频道时
7 |
8 | ### 示例
9 | ```json
10 | {
11 | "guild_id": "47129941624960822",
12 | "channel_id": "1661124",
13 | "channel_type": 2, // 2-音视频子频道 5-直播子频道
14 | "user_id": "144115218182563108"
15 | }
16 | ```
17 |
18 | ## AUDIO_OR_LIVE_CHANNEL_MEMBER_EXIT
19 |
20 | ### 发送时机
21 | - 用户离开音视频/直播子频道时
22 |
23 | ### 示例
24 | ```json
25 | {
26 | "guild_id": "47129941624960822",
27 | "channel_id": "1661124",
28 | "channel_type": 2, // 2-音视频子频道 5-直播子频道
29 | "user_id": "144115218182563108"
30 | }
31 | ```
32 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role/get_online_nums.md:
--------------------------------------------------------------------------------
1 | # 获取子频道在线成员数
2 |
3 | ## 接口
4 |
5 | ```http
6 | GET /channels/{channel_id}/online_nums
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于查询音视频/直播子频道 `channel_id` 的在线成员数。
12 |
13 | ## Content-Type
14 |
15 | ```http
16 | application/json
17 | ```
18 |
19 | ## 返回
20 | 成功返回空对象。
21 |
22 | ```json
23 | {
24 | "online_nums": 1
25 | }
26 | ```
27 | ## 错误码
28 | 详见[错误码](../../../openapi/error/error.md)。
29 |
30 | ## 示例
31 |
32 | 请求数据包
33 | ```http
34 | GET /channels/123456/online_nums
35 | ```
36 |
37 | 响应数据包
38 | ```json
39 | {
40 | "online_nums": 1
41 | }
42 | ```
43 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role/member/delete_member.md:
--------------------------------------------------------------------------------
1 | # 删除频道成员
2 |
3 | ## 接口
4 |
5 | ```http
6 | DELETE /guilds/{guild_id}/members/{user_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于删除 `guild_id` 指定的频道下的成员 `user_id`。
12 | - 需要使用的 `token` 对应的用户具备踢人权限。如果是机器人，要求被添加为管理员。
13 | - 操作成功后，会触发**频道成员删除事件**。
14 | - 无法移除身份为管理员的成员
15 |
16 |
17 |
18 | ## Content-Type
19 | ```http
20 | application/json
21 | ```
22 |
23 | ## 参数
24 | | 字段名 | 类型 | 描述 |
25 | | ------------- | ---- | ------------------------------------|
26 | | add_blacklist | bool | 删除成员的同时，将该用户添加到频道黑名单中 |
27 | | delete_history_msg_days | int | 删除成员的同时，撤回该成员的消息，可以指定撤回消息的时间范围 |
28 |
29 | 注：消息撤回时间范围仅支持固定的天数：`3`，`7`，`15`，`30`。 特殊的时间范围：`-1: 撤回全部消息`。默认值为`0`不撤回任何消息。
30 |
31 | ## 返回
32 |
33 | 成功返回 HTTP 状态码 `204`。
34 |
35 | ## 错误码
36 | 详见[错误码](../../../../openapi/error/error.md)。
37 |
38 | ## 示例
39 |
40 | 请求数据包
41 |
42 | ```shell
43 | DELETE /guilds/123456/members/112233
44 | {
45 | "add_blacklist": true,
46 | "delete_history_msg_days": -1
47 | }
48 | ```
49 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role/member/get_member.md:
--------------------------------------------------------------------------------
1 | # 获取频道成员详情
2 |
3 | ## 接口
4 |
5 | ```http
6 | GET /guilds/{guild_id}/members/{user_id}
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于获取 `guild_id` 指定的频道中 `user_id` 对应成员的详细信息。
12 |
13 | ## Content-Type
14 |
15 | ```http
16 | application/json
17 | ```
18 |
19 | ## 返回
20 |
21 | 返回[Member](model.md#member) 成员对象。
22 |
23 | ## 错误码
24 |
25 | 详见[错误码](../../../../openapi/error/error.md)。
26 |
27 | ## 示例
28 |
29 | 请求数据包
30 |
31 | ```shell
32 | GET /guilds/123456/members/112233
33 | ```
34 |
35 | 响应数据包
36 |
37 | ```json
38 | {
39 | "user": {
40 | "id": "2823701233424295228",
41 | "username": "xxx",
42 | "avatar": "https://qqchannel-profile-1251316161.file.myqcloud.com/xxxxxxx",
43 | "bot": false,
44 | "union_openid": "",
45 | "union_user_account": ""
46 | },
47 | "nick": "",
48 | "roles": [
49 | "1"
50 | ],
51 | "joined_at": "2021-12-05T14:08:29+08:00"
52 | }
53 | ```
54 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role/member/get_role_members.md:
--------------------------------------------------------------------------------
1 | # 获取频道身份组成员列表
2 |
3 | ## 接口
4 | ```http
5 | GET /guilds/{guild_id}/roles/{role_id}/members
6 | ```
7 |
8 | ## 功能描述
9 | 用于获取 `guild_id` 频道中指定`role_id`身份组下所有成员的详情列表，支持分页。
10 |
11 |
12 |
13 | ## Content-Type
14 | ```http
15 | application/json
16 | ```
17 |
18 | ## 参数
19 | |字段名 |类型 |描述|
20 | | ---- | ---- | ----- |
21 | |start_index |string |将上一次回包中`next`填入， 如果是第一次请求填 0，默认为 0|
22 | |limit |uint32 |分页大小，1-400，默认是 1。成员较多的频道尽量使用较大的`limit`值，以减少请求数|
23 |
24 | ## 返回
25 | |字段名 |类型 |描述|
26 | | ---- | ---- | ----- |
27 | |data |[Member](model.md#member) 对象数组| 一组用户信息对象|
28 | |next |string |下一次请求的分页标识|
29 |
30 | ## 有关返回结果的说明
31 | 每次返回的member数量与limit不一定完全相等。特定管理身份组下的成员可能存在一次性返回全部的情况
32 |
33 | ## 错误码
34 | 详见[错误码](../../../../openapi/error/error.md)。
35 |
36 | ## 示例
37 |
38 | 请求
39 | ```http
40 | GET /guilds/123456/roles/4/members?limit=2
41 | ```
42 |
43 | 响应数据包
44 | ```json
45 | {
46 | "data": [
47 | {
48 | "user": {
49 | "id": "xxx",
50 | "username": "xxx",
51 | "avatar": "xxx",
52 | "bot": false
53 | },
54 | "nick": "xxx",
55 | "joined_at": "2021-11-03T20:41:36+08:00"
56 | }
57 | ],
58 | "next": "0"
59 | }
60 | ```
61 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role/member/model.md:
--------------------------------------------------------------------------------
1 | # 成员对象(Member)
2 |
3 | ## Member
4 | | 字段名 | 类型 | 描述 |
5 | | ------------ | ----------------- | ---------------|
6 | | user | [User](../../manage/user/model.md#user) | 用户的频道基础信息，只有成员相关接口中会填充此信息 |
7 | | nick | string | 用户的昵称 |
8 | | roles | string 数组 | 用户在频道内的身份组ID, 默认值可参考[DefaultRoles](role_model.md#DefaultRoles) |
9 | | joined_at | ISO8601 timestamp | 用户加入频道的时间 |
10 |
11 | ## MemberWithGuildID
12 | | 字段名 | 类型 | 描述 |
13 | | ------------ | ----------------- | ---------------|
14 | | guild_id | string | 频道id |
15 | | user | [User](../../manage/user/model.md#user) | 用户的频道基础信息 |
16 | | nick | string | 用户的昵称 |
17 | | roles | string 数组 | 用户在频道内的身份 |
18 | | joined_at | ISO8601 timestamp | 用户加入频道的时间 |
19 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/role/member/role_model.md:
--------------------------------------------------------------------------------
1 | # 频道身份组对象(Role)
2 |
3 | ## Role
4 | | 字段名 | 类型 | 描述 |
5 | | ------------ | ----------------------------------------------------- | ------------------------------ |
6 | | id | string | 身份组ID |
7 | | name | string | 名称 |
8 | | color | uint32 | ARGB的HEX十六进制颜色值转换后的十进制数值 |
9 | | hoist | uint32 | 是否在成员列表中单独展示: 0-否, 1-是 |
10 | | number | uint32 | 人数 |
11 | | member_limit | uint32 | 成员上限 |
12 |
13 | ## DefaultRoleIDs(系统默认生成下列身份组ID)
14 | | 身份组ID默认值 | 描述 |
15 | | --- | --- |
16 | | 1 | 全体成员 |
17 | | 2 | 管理员 |
18 | | 4 | 群主/创建者 |
19 | | 5 | 子频道管理员 |
20 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/speak/README.md:
--------------------------------------------------------------------------------
1 | # 频道模块
2 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/speak/patch_guild_member_mute.md:
--------------------------------------------------------------------------------
1 | # 频道指定成员禁言
2 |
3 | ## 接口
4 |
5 | ```http
6 | PATCH /guilds/{guild_id}/members/{user_id}/mute
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于禁言频道 `guild_id` 下的成员 `user_id`。
12 |
13 | - 需要使用的 `token` 对应的用户具备管理员权限。如果是机器人，要求被添加为管理员。
14 |
15 | 该接口同样可用于解除禁言，具体使用见[解除指定成员禁言](#解除禁言)。
16 |
17 | ## Content-Type
18 |
19 | ```http
20 | application/json
21 | ```
22 |
23 | ## 参数
24 |
25 | | 字段名 | 类型 | 描述 |
26 | | ------------------ | ------ | -------------------------------------------------------------------------------------- | --- |
27 | | mute_end_timestamp | string | 禁言到期时间戳，绝对时间戳，单位：秒（与 mute_seconds 字段同时赋值的话，以该字段为准） |
28 | | mute_seconds | string | 禁言多少秒（两个字段二选一，默认以 mute_end_timestamp 为准） | 、 |
29 |
30 | ### 解除禁言
31 |
32 | 该接口同样支持**解除指定成员禁言**，将`mute_end_timestamp`或`mute_seconds`传值为字符串`'0'`即可。
33 |
34 | ## 返回
35 |
36 | 成功返回 HTTP 状态码 `204`。
37 |
38 | ## 错误码
39 |
40 | 详见[错误码](../../../openapi/error/error.md)。
41 |
42 | ## 示例
43 |
44 | 请求数据包
45 |
46 | ```json
47 | {
48 | "mute_end_timestamp": "1641916800",
49 | "mute_seconds": "120"
50 | }
51 | ```
52 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/speak/patch_guild_mute.md:
--------------------------------------------------------------------------------
1 | # 频道全员禁言
2 |
3 | ## 接口
4 |
5 | ```http
6 | PATCH /guilds/{guild_id}/mute
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于将频道的全体成员（非管理员）禁言。
12 |
13 | - 需要使用的 `token` 对应的用户具备管理员权限。如果是机器人，要求被添加为管理员。
14 |
15 | 该接口同样可用于解除禁言，具体使用见[解除全员禁言](#解除禁言)。
16 |
17 | ## Content-Type
18 |
19 | ```http
20 | application/json
21 | ```
22 |
23 | ## 参数
24 |
25 | | 字段名 | 类型 | 描述 |
26 | | ------------------ | ------ | -------------------------------------------------------------------------------------- |
27 | | mute_end_timestamp | string | 禁言到期时间戳，绝对时间戳，单位：秒（与 mute_seconds 字段同时赋值的话，以该字段为准） |
28 | | mute_seconds | string | 禁言多少秒（两个字段二选一，默认以 mute_end_timestamp 为准） |
29 |
30 | ### 解除禁言
31 |
32 | 该接口同样支持**解除全员禁言**，将`mute_end_timestamp`或`mute_seconds`传值为字符串`'0'`即可。
33 |
34 | ## 返回
35 |
36 | 成功返回 HTTP 状态码 `204`。
37 |
38 | ## 错误码
39 |
40 | 详见[错误码](../../../openapi/error/error.md)。
41 |
42 | ## 示例
43 |
44 | 请求数据包
45 |
46 | ```json
47 | {
48 | "mute_end_timestamp": "1641916800",
49 | "mute_seconds": "120"
50 | }
51 | ```
52 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/speak/setting/message_setting.md:
--------------------------------------------------------------------------------
1 | # 获取频道消息频率的设置详情
2 |
3 | ## 接口
4 |
5 | ```http
6 | GET /guilds/{guild_id}/message/setting
7 | ```
8 |
9 | ## 功能描述
10 |
11 | 用于获取机器人在频道 `guild_id` 内的消息频率设置。
12 |
13 | ## Content-Type
14 |
15 | ```http
16 | application/json
17 | ```
18 |
19 | ## 返回
20 |
21 | 返回[MessageSetting](model.md#MessageSetting) 对象。
22 |
23 | ## 错误码
24 |
25 | 详见[错误码](../../../../openapi/error/error.md)。
26 |
27 | ## 示例
28 |
29 | 响应数据包
30 |
31 | ```json
32 | {
33 | "disable_create_dm": true,
34 | "disable_push_msg": false,
35 | "channel_ids": [
36 | "1146313",
37 | "2651849",
38 | "2651149"
39 | ],
40 | "channel_push_max_num": 12
41 | }
42 | ```
43 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/channel/speak/setting/model.md:
--------------------------------------------------------------------------------
1 | # 频道消息频率设置对象 (MessageSetting)
2 |
3 | ## MessageSetting
4 |
5 | | 字段名 | 类型 | 描述 |
6 | |----------------------|-----------|---------------------|
7 | | disable_create_dm | string | 是否允许创建私信 |
8 | | disable_push_msg | string | 是否允许发主动消息 |
9 | | channel_ids | string 数组 | 子频道 id 数组 |
10 | | channel_push_max_num | uint32 | 每个子频道允许主动推送消息最大消息条数 |
11 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/group/README.md:
--------------------------------------------------------------------------------
1 | # 群组模块
2 |
3 |
5 |
6 | ::: tip 说明
7 | 开放平台支持的功能设置的配置项：
8 | - 进群破冰消息配置
9 | :::
10 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/group/manage/README.md:
--------------------------------------------------------------------------------
1 | # 群管理
2 |
3 |
10 |
11 |
60 |
61 |
76 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/README.md:
--------------------------------------------------------------------------------
1 | # 消息相关
2 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/dms/delete_dms.md:
--------------------------------------------------------------------------------
1 | # 撤回私信
2 |
3 | ### 接口
4 |
5 | ```http
6 | DELETE /dms/{guild_id}/messages/{message_id}?hidetip=false
7 | ```
8 |
9 | ### 参数
10 |
11 | | 字段名 | 类型 | 描述 |
12 | | ------- | ---- | ---------------------------------------------------------------- |
13 | | hidetip | bool | 选填，是否隐藏提示小灰条，true 为隐藏，false 为显示。默认为false |
14 |
15 | ### 功能描述
16 |
17 | 用于撤回私信频道 `guild_id` 中 `message_id` 指定的私信消息。只能用于撤回机器人自己发送的私信。
18 |
19 |
20 |
21 | ### Content-Type
22 |
23 | ```http
24 | application/json
25 | ```
26 |
27 | ### 返回
28 |
29 | 成功返回 HTTP 状态码 `200`。
30 |
31 | ### 错误码
32 |
33 | 详见[错误码](../error/error.md)。
34 |
35 | ### 示例
36 |
37 | 请求数据包
38 |
39 | ```http
40 | DELETE /dms/123456/messages/112233
41 | ```
42 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/dms/direct_message.md:
--------------------------------------------------------------------------------
1 | # 私信消息事件
2 |
3 | ## DIRECT_MESSAGE_CREATE (intents DIRECT_MESSAGE)
4 |
5 | ### 发送时机
6 |
7 | - 用户通过私信发消息给机器人时
8 | - 由于私信场景无法设置沙箱频道，目前私信事件不支持沙箱环境，开发者可以通过用户 id 白名单的方式来调试私信
9 |
10 | ## 内容
11 |
12 | 内容为 [Message](../template/model.md#message) 对象
13 |
14 | ## 示例
15 |
16 | ```json
17 | {
18 | "author": {
19 | "avatar": "http://thirdqq.qlogo.cn/0",
20 | "bot": false,
21 | "id": "1234",
22 | "username": "abc"
23 | },
24 | "channel_id": "100010",
25 | "content": "ndnnd",
26 | "guild_id": "18700000000001",
27 | "id": "0812345677890abcdef",
28 | "member": {
29 | "joined_at": "2021-04-12T16:34:42+08:00",
30 | "roles": [
31 | "1"
32 | ]
33 | },
34 | "timestamp": "2021-05-20T15:14:58+08:00"
35 | }
36 | ```
37 |
38 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/dms/model.md:
--------------------------------------------------------------------------------
1 | # 私信会话对象（DMS）
2 |
3 | ## DMS
4 | | 字段名 | 类型 | 描述 |
5 | | ------------ | ----------------- | ---------------|
6 | | guild_id | string | 私信会话关联的频道 id |
7 | | channel_id | string | 私信会话关联的子频道 id |
8 | | create_time | string | 创建私信会话时间戳 |
9 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/dms/post_dms.md:
--------------------------------------------------------------------------------
1 | # 创建私信会话
2 |
3 | ### 接口
4 |
5 | ```http
6 | POST /users/@me/dms
7 | ```
8 |
9 | ### 功能描述
10 |
11 | 用于机器人和在同一个频道内的成员创建私信会话。
12 |
13 | - 机器人和用户存在共同频道才能创建私信会话。
14 | - 创建成功后，返回创建成功的频道 `id` ，子频道 `id` 和创建时间。
15 |
16 | ### Content-Type
17 |
18 | ```http
19 | application/json
20 | ```
21 |
22 | ### 参数
23 |
24 | | 字段名 | 类型 | 描述 |
25 | | --------------- | ------ | --------- |
26 | | recipient_id | string | 接收者 id |
27 | | source_guild_id | string | 源频道 id |
28 |
29 | ### 返回
30 |
31 | 返回[DMS](model.md#dms)对象。
32 |
33 | ### 错误码
34 |
35 | 详见[错误码](../../../openapi/error/error.md)。
36 |
37 | ### 示例
38 |
39 | 请求数据包
40 |
41 | ```json
42 | {
43 | "recipient_id": "123456",
44 | "source_guild_id": "112233"
45 | }
46 | ```
47 |
48 | 响应数据包
49 |
50 | ```json
51 | {
52 | "guild_id": "xxxxxx",
53 | "channel_id": "xxxxxx",
54 | "create_time": "1642545606"
55 | }
56 | ```
57 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/dms/post_dms_messages.md:
--------------------------------------------------------------------------------
1 | # 发送私信
2 |
3 | ### 接口
4 |
5 | ```http
6 | POST /dms/{guild_id}/messages
7 | ```
8 |
9 | ### 功能描述
10 |
11 | 用于发送私信消息，前提是已经创建了私信会话。
12 |
13 | - 私信的 `guild_id` 在[创建私信会话](post_dms.md)时以及[私信消息事件](direct_message.md)中获取。
14 | - 私信场景下，每个机器人每天可以对一个用户发 2 条主动消息。
15 | - 私信场景下，每个机器人每天累计可以发 200 条主动消息。
16 | - 私信场景下，被动消息没有条数限制。
17 |
18 | ### Content-Type
19 |
20 | ```http
21 | application/json
22 | ```
23 |
24 | ### 参数
25 |
26 | 和[发送消息](../post_messages.md)参数一致。
27 |
28 | ### 返回
29 |
30 | 和[发送消息](../post_messages.md)返回一致。
31 |
32 | ### 错误码
33 |
34 | 详见[错误码](../../../openapi/error/error.md)。
35 |
36 | ### 示例
37 |
38 | 参见[发送消息](../post_messages.md#示例)示例。
39 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/send-receive/README.md:
--------------------------------------------------------------------------------
1 | # 消息收发
2 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/trans/README.md:
--------------------------------------------------------------------------------
1 | # 消息交互
2 |
3 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/type/README.md:
--------------------------------------------------------------------------------
1 | # 消息类型
2 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/type/audio.md:
--------------------------------------------------------------------------------
1 | # 语音
2 |
3 | | | **单聊** | **群聊** | **文字子频道** | **频道私信** |
4 | | --- | --- | --- | --- | --- |
5 | | 机器人接收 | 支持 | - | - | - |
6 | | 机器人发送 | 支持 | 支持 | - | - |
7 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/type/file.md:
--------------------------------------------------------------------------------
1 | # 文件
2 |
3 | 目前接收文件仅支持，pdf、doc、txt 格式
4 |
5 | | | **单聊** | **群聊** | **文字子频道** | **频道私信** |
6 | | --- | --- | --- | --- | --- |
7 | | 机器人接收 | 支持 | - | - | - |
8 | | 机器人发送 | 未开放 | 未开放 | - | - |
9 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/type/image.md:
--------------------------------------------------------------------------------
1 | # 图片
2 |
3 | | | **单聊** | **群聊** | **文字子频道** | **频道私信** |
4 | | --- | --- | --- | --- | --- |
5 | | 机器人接收 | 支持 | - | - | 支持 |
6 | | 机器人发送 | 支持 | 支持 | 支持 | 支持 |
7 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/type/rich-text.md:
--------------------------------------------------------------------------------
1 | # 图文消息
2 |
3 | | | **单聊** | **群聊** | **文字子频道** | **频道私信** |
4 | | --- | --- | --- | --- | --- |
5 | | 机器人接收 | 支持 | 支持 | 支持 | 支持 |
6 | | 机器人发送 | 近期支持 | 近期支持 | 支持 | 支持 |
7 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/type/sticker.md:
--------------------------------------------------------------------------------
1 | # 表情
2 |
3 | 内测中，近期支持
4 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/type/text.md:
--------------------------------------------------------------------------------
1 | # 文本消息
2 |
3 | | | **单聊** | **群聊** | **文字子频道** | **频道私信** |
4 | | --- | --- | --- | --- | --- |
5 | | 机器人接收 | 支持 | 支持 | 支持 | 支持 |
6 | | 机器人发送 | 支持 | 支持 | 支持 | 支持 |
7 |
8 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/message/type/video.md:
--------------------------------------------------------------------------------
1 | # 视频
2 |
3 | | | **单聊** | **群聊** | **文字子频道** | **频道私信** |
4 | | --- | --- | --- | --- | --- |
5 | | 机器人接收 | 支持 | - | - | 支持 |
6 | | 机器人发送 | 支持 | 支持 | 支持 | 支持 |
7 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/user/README.md:
--------------------------------------------------------------------------------
1 | # 用户模块
2 |
3 |
6 | ::: tip 说明
7 | 开放平台支持的功能设置的配置项：
8 | - 添加好友后的破冰消息文案；
9 | - 主动消息变更后自动推送给用户的消息文案；
10 | :::
11 |
--------------------------------------------------------------------------------
/docs/develop/api-v2/server-inter/user/manage/README.md:
--------------------------------------------------------------------------------
1 | # 用户管理
2 |
3 |
6 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/api/announce/delete_channel_announce.md:
--------------------------------------------------------------------------------
1 | # 删除子频道公告
2 |
3 | 删除子频道公告。
4 |
5 | ## 使用示例
6 |
7 | ```go
8 | token := token.BotToken("appid", "token")
9 | api := botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
10 | ctx := context.Background()
11 |
12 | err := api.DeleteChannelAnnounces(ctx, channelId, msgId)
13 | if err != nil {
14 | log.Fatalln("调用 DeleteChannelAnnounces 接口失败, err = ", err)
15 | }
16 | ```
17 |
18 | ## 参数说明
19 |
20 | | 字段名 | 必填 | 类型 | 描述 |
21 | | --------- | ---- | ------ | ------------------------------ |
22 | | channelId | 是 | string | 子频道 ID |
23 | | msgId | 是 | string | 消息 ID |
24 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/api/announce/delete_guild_announce.md:
--------------------------------------------------------------------------------
1 | # 删除频道全局公告
2 |
3 | 删除频道全局公告。
4 |
5 | ## 使用示例
6 |
7 | ```go
8 | token := token.BotToken("appid", "token")
9 | api := botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
10 | ctx := context.Background()
11 |
12 | err := api.DeleteGuildAnnounces(ctx, guildId, msgId)
13 | if err != nil {
14 | log.Fatalln("调用 DeleteGuildAnnounces 接口失败, err = ", err)
15 | }
16 | ```
17 |
18 | ## 参数说明
19 |
20 | | 字段名 | 必填 | 类型 | 描述 |
21 | | --------- | ---- | ------ | ------------------------------ |
22 | | guildId | 是 | string | 频道 ID |
23 | | msgId | 是 | string | 消息 ID |
24 |
25 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/api/channel/delete_channel.md:
--------------------------------------------------------------------------------
1 | # 删除子频道
2 |
3 | 移除一个子频道。
4 |
5 |
6 |
7 | ## 使用示例
8 |
9 | ```go
10 | token := token.BotToken("appid", "token")
11 | api := botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
12 | ctx := context.Background()
13 |
14 | err := api.DeleteChannel(ctx, channelId)
15 | if err != nil {
16 | log.Fatalln("调用 DeleteChannel 接口失败, err = ", err)
17 | }
18 | ```
19 |
20 | ::: warning 注意
21 |
22 | - 要求操作人具有`管理频道`的权限，如果是机器人，则需要将机器人设置为管理员。
23 | - 创建成功后，返回创建成功的子频道对象，同时会触发一个频道创建的事件通知。
24 | - 子频道的删除是无法撤回的，一旦删除，将无法恢复。
25 |
26 | :::
27 |
28 | ## 参数说明
29 |
30 | | 字段名 | 必填 | 类型 | 描述 |
31 | | --------- | ---- | ------ | --------- |
32 | | channelId | 是 | string | 子频道 ID |
33 |
34 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/api/guild/guild_role/delete_guild_role.md:
--------------------------------------------------------------------------------
1 | # 删除频道身份组
2 |
3 | 删除频道身份组。
4 |
5 | ```go
6 | token := token.BotToken("appid", "token")
7 | api := botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
8 | ctx := context.Background()
9 |
10 | err := api.DeleteRole(ctx, guildId, dto.RoleID(roleId))
11 | if err != nil {
12 | log.Fatalln("调用 DeleteRole 接口失败, err = ", err)
13 | }
14 | ```
15 |
16 | ### 参数说明
17 |
18 | | 参数 | 必填 | 类型 | 说明 |
19 | | ------- | ---- | ------ | --------- |
20 | | guildId | 是 | string | 频道 ID |
21 | | roleId | 是 | string | 身份组 ID |
22 |
23 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/api/member/delete_guild_member.md:
--------------------------------------------------------------------------------
1 | # 删除频道成员
2 |
3 | 移除频道的某个成员。
4 |
5 |
6 |
7 | ## 使用示例
8 |
9 | ```python
10 | token := token.BotToken("appid", "token")
11 | api := botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
12 | ctx := context.Background()
13 |
14 | err := api.DeleteGuildMember(ctx, guildId, userId)
15 | if err != nil {
16 | log.Fatalln("调用 DeleteGuildMember 接口失败, err = ", err)
17 | }
18 | ```
19 |
20 | ::: warning 注意
21 |
22 | - 需要使用的 token 对应的用户具备踢人权限。如果是机器人，要求被添加为管理员。
23 | - 操作成功后，会触发频道成员删除事件
24 | :::
25 |
26 | ## 参数说明
27 |
28 | | 字段名 | 必填 | 类型 | 描述 |
29 | | ------- | ---- | ------ | ------- |
30 | | guildId | 是 | string | 频道 ID |
31 | | userId | 是 | string | 用户 ID |
32 | | MemberDeleteOption | 否 | [MemberDeleteOption](#MemberDeleteOption) | 删除用户的选项 |
33 |
34 | ## MemberDeleteOption
35 |
36 | | 字段名 | 必填 | 类型 | 描述 |
37 | | ------- | ---- | ------ | ------- |
38 | | AddBlackList | 否 | bool | 删除成员的同时，将该用户添加到频道黑名单中|
39 | | DeleteHistoryMsgDays | 否 | int | 删除成员的同时，撤回该成员的消息，可以指定撤回消息的时间范围 |
40 |
41 | >注：消息撤回时间范围仅支持固定的天数：3，7，15，30。 特殊的时间范围：-1: 撤回全部消息。默认值为0不撤回任何消息
42 |
43 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/api/message/message_reference.md:
--------------------------------------------------------------------------------
1 | # 发送引用消息
2 |
3 | ::: warning 注意
4 |
5 | - 只支持引用机器人自己发送到的消息以及用户@机器人产生的消息。
6 | - 发送成功之后，会触发一个创建消息的事件。
7 |
8 | :::
9 |
10 | ## 使用示例
11 |
12 | 使用方式同发送消息，在`PostMessage`中设置 `MessageReference` 即可发送引用消息。
13 |
14 | ```go
15 | token := token.BotToken("appid", "token")
16 | api := botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
17 | ctx := context.Background()
18 |
19 | message, err := api.PostMessage(ctx, channelId, &dto.MessageToCreate{
20 | MsgID: msgId,
21 | Content: "这是一条引用消息",
22 | MessageReference: &dto.MessageReference{
23 | MessageID: msgId,
24 | IgnoreGetMessageError: false,
25 | },
26 | })
27 | if err != nil {
28 | log.Fatalln("调用 PostMessage 接口失败, err = ", err)
29 | }
30 | ```
31 |
32 | ## 返回示例
33 |
34 | `data`:
35 |
36 | ```json
37 | {
38 | "id": "xxxxxx",
39 | "channel_id": "xxxxxx",
40 | "guild_id": "xxxxxx",
41 | "content": "",
42 | "timestamp": "2021-05-13T14:45:45+08:00",
43 | "tts": false,
44 | "mention_everyone": false,
45 | "author": {
46 | "id": "xxxxxx",
47 | "username": "xxxxxx",
48 | "avatar": "",
49 | "bot": true
50 | },
51 | "pinned": false,
52 | "type": 0,
53 | "flags": 0
54 | }
55 | ```
56 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/api/message/recall_message.md:
--------------------------------------------------------------------------------
1 | # 撤回消息
2 |
3 | 撤回子频道内的消息
4 |
5 | ::: warning 注意
6 |
7 | - 管理员可以撤回普通成员的消息。
8 | - 频道主可以撤回所有人的消息。
9 |
10 | :::
11 |
12 | ## 使用示例
13 |
14 | ```go
15 | token := token.BotToken("appid", "token")
16 | api := botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
17 | ctx := context.Background()
18 |
19 | err := api.RetractMessage(ctx, channelId, msgId)
20 | if err != nil {
21 | log.Fatalln("调用 RetractMessage 接口失败, err = ", err)
22 | }
23 | ```
24 |
25 | ## 参数说明
26 |
27 | | 参数 | 必填 | 类型 | 说明 |
28 | | --------- | ---- | ------ | --------- |
29 | | channelId | 是 | string | 子频道 ID |
30 | | msgId | 是 | string | 消息 ID |
31 | | RetractMessageOption | 否 | [RetractMessageOption](#RetractMessageOption)|是否隐藏提示小灰条|
32 |
33 | ### RetractMessageOption
34 |
35 | |选项|含义|
36 | |---|----|
37 | |RetractMessageOptionHidetip|撤回消息隐藏小灰条可选参数|
38 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/api/mute/mute_all.md:
--------------------------------------------------------------------------------
1 | # 禁言全员
2 |
3 | 将频道内全部成员（非管理员）禁言。
4 |
5 | ## 使用示例
6 |
7 | ```go
8 | token := token.BotToken("appid", "token")
9 | api := botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
10 | ctx := context.Background()
11 |
12 | err := api.GuildMute(ctx, guildId, &dto.UpdateGuildMute{
13 | MuteSeconds: "60",
14 | })
15 | if err != nil {
16 | log.Fatalln("调用 GuildMute 接口失败, err = ", err)
17 | }
18 | ```
19 |
20 |
21 | ## 参数说明
22 |
23 | | 字段名 | 必填 | 类型 | 描述 |
24 | | ------- | ---- | ------------------------- | ---------------------------- |
25 | | guildId | 是 | string | [频道 ID](../../model/guild.md) |
26 | | UpdateGuildMute | 是 | [UpdateGuildMute](#UpdateGuildMute) | 禁言时长控制参数 |
27 |
28 | ### UpdateGuildMute
29 |
30 | | 字段名 | 类型 | 描述 |
31 | | ------- | ------ | --------------------------------------------------------------------------------------- |
32 | | MuteEndTimestamp | string | 禁言到期时间戳，`绝对时间戳`，单位：`秒`（与 `seconds` 字段同时赋值的话，以该字段为准） |
33 | | MuteSeconds | string | 禁言多少秒（两个字段二选一，**默认以 `mute_end_timstamp` 为准**） |
34 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/api/pins_message/delete_pins_message.md:
--------------------------------------------------------------------------------
1 | # 删除精华消息
2 |
3 | 用于移除子频道 `channelId` 下的精华消息 `messageId` 。
4 |
5 | ## 使用示例
6 |
7 | ```go
8 | token := token.BotToken("appid", "token")
9 | api := botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
10 | ctx := context.Background()
11 |
12 | err := api.DeletePins(ctx, channelId, msgId)
13 | if err != nil {
14 | log.Fatalln("调用 DeletePins 接口失败, err = ", err)
15 | }
16 | ```
17 |
18 | ## 参数说明
19 |
20 | | 字段名 | 必填 | 类型 | 描述 |
21 | | --------- | ---- | ------ | -------------------------------- |
22 | | channelId | 是 | string | 子频道 ID |
23 | | msgId | 是 | string | 消息 ID |
24 |
25 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/api/pins_message/get_pins_message.md:
--------------------------------------------------------------------------------
1 | # 获取精华消息
2 |
3 | 用于获取子频道 `channelId` 内的精华消息。
4 |
5 | ## 使用示例
6 |
7 | ```go
8 | token := token.BotToken("appid", "token")
9 | api := botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
10 | ctx := context.Background()
11 |
12 | pinsMessage, err := api.GetPins(ctx, channelId)
13 | if err != nil {
14 | log.Fatalln("调用 GetPins 接口失败, err = ", err)
15 | }
16 | ```
17 |
18 | ## 参数说明
19 |
20 | | 字段名 | 必填 | 类型 | 描述 |
21 | | --------- | ---- | ------ | -------------------------------- |
22 | | channelId | 是 | string | 子频道 ID |
23 |
24 | ## 返回说明
25 |
26 | 返回 [PinsMessage](#PinsMessage) 对象。
27 |
28 | ### PinsMessage
29 |
30 | | 字段名 | 类型 | 描述 |
31 | | ----------- | -------- | ---------------------------------- |
32 | | GuildID | string | 频道 ID |
33 | | ChannelID | string | 子频道 ID |
34 | | MessageIDs | string[] | 消息 ID |
35 |
36 | ## 返回示例
37 |
38 | `data`：
39 |
40 | ```json
41 | {
42 | "guild_id": "xxxxxx",
43 | "channel_id": "xxxxxx",
44 | "message_ids": ["xxxxx"]
45 | }
46 | ```
47 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/api/schedule/delete_schedule.md:
--------------------------------------------------------------------------------
1 | # 删除日程
2 |
3 | 删除`日程子频道`里的一个日程。
4 |
5 | ::: warning 注意
6 |
7 | 要求操作人具有管理频道的权限，如果是机器人，则需要将机器人设置为管理员。
8 |
9 | :::
10 |
11 | ## 使用示例
12 |
13 | ```go
14 | token := token.BotToken("appid", "token")
15 | api := botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
16 | ctx := context.Background()
17 |
18 | err := api.DeleteSchedule(ctx, channelId, scheduleId)
19 | if err != nil {
20 | log.Fatalln("调用 DeleteSchedule 接口失败, err = ", err)
21 | }
22 | ```
23 |
24 | ## 参数说明
25 |
26 | | 字段名 | 必填 | 类型 | 描述 |
27 | | ---------- | ---- | ------ | -------------------------------- |
28 | | channelId | 是 | string | [子频道 ID](../../model/channel.md) |
29 | | scheduleId | 是 | string | 日程 ID |
30 |
31 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/model/announce.md:
--------------------------------------------------------------------------------
1 | # 公告对象（Announces）
2 |
3 | ## Announces
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ------------ | ------ | ------------------------- |
7 | | GuildID | string | 频道 ID |
8 | | ChannelID | string | 子频道 ID |
9 | | MessageID | string | 消息 ID |
10 | | AnnouncesType | uint32 | 公告类别 0:成员公告，1:欢迎公告，默认为成员公告|
11 | | RecommendChannels | []* [RecommendChannel](#RecommendChannel) | 推荐子频道列表||
12 |
13 | ## RecommendChannel
14 |
15 | | 字段名 | 类型 | 描述 |
16 | | ---------- | ------ | ------------------------- |
17 | | ChannelID | string | 子频道 ID |
18 | | Introduce | string | 推荐语 |
19 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/model/audio.md:
--------------------------------------------------------------------------------
1 | # 语音对象(AudioControl)
2 |
3 | ## AudioControl
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | --------- | ------ | --------------------------------------------------------------------- |
7 | | URL | string | 音频数据的 url status 为 0 时传 |
8 | | Text | string | 状态文本（比如：简单爱-周杰伦），可选，status 为 0 时传，其他操作不传 |
9 | | Status | STATUS | 播放状态，参考 [AudioStatus](#AudioStatus) |
10 |
11 | ### AudioStatus
12 |
13 | | 字段名 | 值 | 描述 |
14 | | ------ | --- | ------------ |
15 | | START | 0 | 开始播放操作 |
16 | | PAUSE | 1 | 暂停播放操作 |
17 | | RESUME | 2 | 继续播放操作 |
18 | | STOP | 3 | 停止播放操作 |
19 |
20 | ## AudioAction
21 |
22 | | 字段名 | 类型 | 描述 |
23 | | ---------- | ------ | --------------------------------------------------------------------- |
24 | | GuildID | string | 频道 ID |
25 | | ChannelID | string | 子频道 ID |
26 | | URL | string | 音频数据的 url status 为 0 时传 |
27 | | Text | string | 状态文本（比如：简单爱-周杰伦），可选，status 为 0 时传，其他操作不传 |
28 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/model/channel_permission.md:
--------------------------------------------------------------------------------
1 | # 子频道权限对象(ChannelPermissions)
2 |
3 | ### ChannelPermissions
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ----------- | --------------------------- | --------------------------------- |
7 | | ChannelID | string | 子频道 ID |
8 | | UserID | string | 用户 ID |
9 | | Permissions | [permissions](#permissions) | 用户拥有的子频道权限，是个 string |
10 |
11 | ### Permissions
12 |
13 | 权限是 QQ 频道管理频道成员的一种方式，管理员可以对不同的人、不同的子频道设置特定的权限。用户的权限包括**个人权限**和**身份组权限**两部分，最终生效是取两种权限的并集。
14 |
15 | 权限使用位图表示，传递时序列化为十进制数值字符串。如权限值为`0x6FFF`，会被序列化为十进制`"28671"`。
16 |
17 | | 权限 | 值 | 描述 |
18 | | ------------ | --------------------- | ---------------------------------------------------- |
19 | | 可查看子频道 | 0x0000000001 (1 << 0) | 目前仅支持`指定成员`可见类型，不支持`身份组`可见类型 |
20 | | 可管理子频道 | 0x0000000002 (1 << 1) | 创建者、管理员、子频道管理员都具有此权限 |
21 |
22 | ##### 参数参考
23 |
24 | | 字段名 | 类型 | 描述 |
25 | | ------ | ------ | ---------------------------------- |
26 | | add | string | 字符串形式的位图表示赋予用户的权限 |
27 | | remove | string | 字符串形式的位图表示删除用户的权限 |
28 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/model/dms.md:
--------------------------------------------------------------------------------
1 | # 私信会话对象（DirectMessage）
2 |
3 | ## DirectMessage
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ----------- | ------ | --------- |
7 | | GuildID | string | 频道 ID |
8 | | ChannelID | string | 子频道 ID |
9 | | CreateTime | string | 创建时间 |
10 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/model/guild.md:
--------------------------------------------------------------------------------
1 | # 频道对象(Guild)
2 |
3 | 频道对象中所涉及的 ID 类数据，都仅在机器人场景流通，与真实的 ID 无关，请不要理解为真实的 ID。
4 |
5 | ## Guild
6 |
7 | | 字段名 | 类型 | 描述 |
8 | | ------------ | ------- | ------------------ |
9 | | ID | string | 频道 ID |
10 | | Name | string | 频道名称 |
11 | | Icon | string | 频道头像 |
12 | | OwnerID | string | 拥有者ID |
13 | | IsOwner | bool | 当前人是否是创建人 |
14 | | MemberCount | int | 成员数 |
15 | | MaxMembers | int64 | 最大成员数 |
16 | | Desc | string | 描述 |
17 | | JoinedAt | Timestamp | 当前用户加入群的时间，此字段只在GUILD_CREATE事件中使用|
18 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/model/member.md:
--------------------------------------------------------------------------------
1 | # 成员对象(Member)
2 |
3 | ## Member
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | --------- | ------------- | -------------------------------------------------------------------------------------------- |
7 | | GuildID | string | 频道ID |
8 | | User | [User](user) | 用户基础信息，来自 QQ 资料，只有成员相关接口中会填充此信息 |
9 | | Nick | string | 用户在频道内的昵称 |
10 | | Roles | string[] | 用户在频道内的身份组 ID，默认值可参考[DefaultRoleIDs](../guild/role_model.md#DefaultRoleIDs) |
11 | | JoinedAt | [Timestamp](#Timestamp) | 用户加入频道的时间，是个 `ISO8601 timestamp` 字符串，例："2021-11-23T15:16:48+08:00" |
12 |
13 | ## Timestamp
14 |
15 | | 字段名 | 类型 | 描述 |
16 | | ------------------ | ------- | -------------|
17 | | Timestamp | string | 时间 |
18 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/model/pins_message.md:
--------------------------------------------------------------------------------
1 | # 精华消息对象(PinsMessage)
2 |
3 | ## PinsMessage
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ----------- | -------- | --------------------------- |
7 | | guild_id | string | [频道 ID](./guild.md) |
8 | | channel_id | string | [子频道 ID](./channel.md) |
9 | | message_ids | string 列表 | [消息 ID](./message.md) 列表 |
10 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/model/role.md:
--------------------------------------------------------------------------------
1 | # 频道身份组对象(Role)
2 |
3 | ### Role
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ------------ | ------ | -------------------------------------------------------------- |
7 | | id | string | 身份组 ID |
8 | | name | string | 名称 |
9 | | color | number | ARGB 的 HEX 十六进制颜色值转换后的十进制数值（例：4294927682） |
10 | | hoist | number | 是否在成员列表中单独展示: 0-否, 1-是 |
11 | | number | number | 人数 |
12 | | member_limit | number | 成员上限 |
13 |
14 | ### DefaultRoleIDs(系统默认生成下列身份组 ID)
15 |
16 | | 身份组 ID 默认值 | 描述 |
17 | | ---------------- | ------------ |
18 | | 1 | 全体成员 |
19 | | 2 | 管理员 |
20 | | 4 | 群主/创建者 |
21 | | 5 | 子频道管理员 |
22 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/model/schedule.md:
--------------------------------------------------------------------------------
1 | # 日程对象(Schedule)
2 |
3 | ## Schedule
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | --------------- | ----------------- | ----------------------------------------------- |
7 | | ID | string | 日程 ID |
8 | | Name | string | 日程名称 |
9 | | Description | string | 日程描述 |
10 | | StartTimestamp | string | 日程开始时间戳(**`ms`**) |
11 | | EndTimestamp | string | 日程结束时间戳(**`ms`**) |
12 | | Creator | [Member](#member) | 创建者 |
13 | | JumpChannelID | string | 日程开始时跳转到的子频道 ID |
14 | | RemindType | string | 日程提醒类型，取值参考[RemindType](#remindtype) |
15 |
16 | ## RemindType
17 |
18 | | 提醒类型 id | 描述 |
19 | | ----------- | ------------------ |
20 | | 0 | 不提醒 |
21 | | 1 | 开始时提醒 |
22 | | 2 | 开始前 5 分钟提醒 |
23 | | 3 | 开始前 15 分钟提醒 |
24 | | 4 | 开始前 30 分钟提醒 |
25 | | 5 | 开始前 60 分钟提醒 |
26 |
--------------------------------------------------------------------------------
/docs/develop/gosdk/model/user.md:
--------------------------------------------------------------------------------
1 | # 用户对象(User)
2 |
3 | 用户对象中所涉及的 ID 类数据，都仅在机器人场景流通，与真实的 ID 无关，请不要理解为真实的 ID。
4 |
5 | ## User
6 |
7 | | 字段名 | 类型 | 描述 |
8 | | ------------------ | ------- | -------------------------------------------------------------------------------------------------- |
9 | | ID | string | 用户 ID |
10 | | Username | string | 用户名 |
11 | | Avatar | string | 用户头像地址 |
12 | | Bot | bool | 是否是机器人 |
13 | | UnionOpenID | string | 特殊关联应用的 openid，需要特殊申请并配置后才会返回。如需申请，请联系平台运营人员。 |
14 | | UnionUserAccount | string | 机器人关联的互联应用的用户信息，与 union_openid 关联的应用是同一个。如需申请，请联系平台运营人员。 |
15 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/announce/delete_channel_announce.md:
--------------------------------------------------------------------------------
1 | # 删除子频道公告
2 |
3 | 删除子频道公告。
4 |
5 | ## 使用示例
6 |
7 | ```javascript
8 | async function demo() {
9 | let { data } = await client.announceApi.deleteChannelAnnounce(channelId, messageId);
10 | }
11 | ```
12 |
13 | ## 参数说明
14 |
15 | | 字段名 | 必填 | 类型 | 描述 |
16 | | --------- | ---- | ------ | ------------------------------ |
17 | | channelId | 是 | string | [子频道 ID](./channel.md) |
18 | | messageId | 是 | string | [消息 ID](../model/message.md) |
19 |
20 | ## 返回说明
21 |
22 | 成功返回空对象。
23 |
24 | ## 返回示例
25 |
26 | `data`：
27 |
28 | ```js
29 | {
30 | }
31 | ```
32 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/announce/delete_guild_announce.md:
--------------------------------------------------------------------------------
1 | # 删除频道全局公告
2 |
3 | 删除频道全局公告。
4 |
5 | ## 使用示例
6 |
7 | ```javascript
8 | async function demo() {
9 | let { data } = await client.announceApi.deleteGuildAnnounce(guildId, messageId);
10 | }
11 | ```
12 |
13 | ## 参数说明
14 |
15 | | 字段名 | 必填 | 类型 | 描述 |
16 | | --------- | ---- | ------ | ------------------------------ |
17 | | guildId | 是 | string | [频道 ID](../model/guild.md) |
18 | | messageId | 是 | string | [消息 ID](../model/message.md) |
19 |
20 | ## 返回说明
21 |
22 | 成功返回空对象。
23 |
24 | ## 返回示例
25 |
26 | `data`：
27 |
28 | ```js
29 | {
30 | }
31 | ```
32 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/audio/bot_off_mic.md:
--------------------------------------------------------------------------------
1 | # 机器人下麦
2 |
3 | 机器人在 channel_id 对应的语音子频道下麦。
4 |
5 | 音频接口：仅限音频类机器人才能使用，后续会根据机器人类型自动开通接口权限，现如需调用，需联系平台申请权限。
6 |
7 | ## 使用示例
8 |
9 | ```javascript
10 | async function demo() {
11 | let { data } = await client.audioApi.botOffMic(channelID);
12 | }
13 | ```
14 |
15 | ## 参数说明
16 |
17 | | 字段名 | 必填 | 类型 | 描述 |
18 | | ------------ | ---- | ----------------------------- | -------------- |
19 | | channelID | 是 | string | 语音子频道 ID |
20 |
21 |
22 | ## 返回说明
23 |
24 | 成功返回空对象。
25 |
26 | ## 返回示例
27 |
28 | `data`：
29 |
30 | ```js
31 | {
32 | }
33 | ```
34 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/audio/bot_on_mic.md:
--------------------------------------------------------------------------------
1 | # 机器人上麦
2 |
3 | 机器人在 channel_id 对应的语音子频道上麦。
4 |
5 | 音频接口：仅限音频类机器人才能使用，后续会根据机器人类型自动开通接口权限，现如需调用，需联系平台申请权限。
6 |
7 | ## 使用示例
8 |
9 | ```javascript
10 | async function demo() {
11 | let { data } = await client.audioApi.botOnMic(channelID);
12 | }
13 | ```
14 |
15 | ## 参数说明
16 |
17 | | 字段名 | 必填 | 类型 | 描述 |
18 | | ------------ | ---- | ----------------------------- | -------------- |
19 | | channelID | 是 | string | 语音子频道 ID |
20 |
21 |
22 | ## 返回说明
23 |
24 | 成功返回空对象。
25 |
26 | ## 返回示例
27 |
28 | `data`：
29 |
30 | ```js
31 | {
32 | }
33 | ```
34 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/dms/post_dms_messages.md:
--------------------------------------------------------------------------------
1 | # 发送私信消息
2 |
3 | 用于发送私信消息，前提是已经创建了私信会话。
4 |
5 | ## 功能描述
6 |
7 | - 私信的 `guild_id` 在[创建私信会话](post_dms.md)时以及[私信消息事件](../../api/gateway/direct_message.md)中获取。
8 | - 私信场景下，每个机器人每天可以对一个用户发 `2` 条主动消息。
9 | - 私信场景下，每个机器人每天累计可以发 `200` 条主动消息。
10 | - 私信场景下，被动消息没有条数限制。
11 |
12 | ## 使用示例
13 |
14 | ```js
15 | async function demo() {
16 | const res = await client.directMessageApi.postDirectMessage(guildId, msgObj);
17 | }
18 | ```
19 |
20 | ## 参数说明
21 |
22 | | 字段名 | 必填 | 类型 | 描述 |
23 | | ------- | ---- | -------------------------------------------------------------- | ---------------------------------------------------- |
24 | | guildId | 是 | string | [私信频道 ID](../model/dms.md) |
25 | | msgObj | 是 | [MessageToCreate](../message/post_messages.md#messagetocreate) | 消息体 ，参考[发送消息](../message/post_messages.md) |
26 |
27 | ## 返回说明
28 |
29 | 同[发送消息返回说明](../message/post_messages.md#返回说明)，返回[Message](../message/post_messages.md#message) 对象。
30 |
31 | ## 返回示例
32 |
33 | 参考[发送消息返回示例](../message/post_messages.md#返回示例)。
34 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/error/error.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/tencent-connect/bot-docs/645787a45937e5d9c4f0f61afefdffde0f38696e/docs/develop/nodesdk/error/error.png
--------------------------------------------------------------------------------
/docs/develop/nodesdk/guild/delete_guild_role.md:
--------------------------------------------------------------------------------
1 | # 删除频道身份组
2 |
3 | 删除频道身份组。
4 |
5 | ## 使用示例
6 |
7 | ```javascript
8 | async function demo() {
9 | let { data } = await client.roleApi.deleteRole(guildId, roleId);
10 | }
11 | ```
12 |
13 | ::: warning 注意
14 |
15 | - 需要使用的 `token` 对应的用户具备增加身份组成员权限。如果是机器人，要求被添加为管理员。
16 | - 如果要删除的身份组 ID 是[5-子频道管理员](#defaultroleids)，需要增加 channel 对象来指定具体是哪个子频道
17 |
18 | :::
19 |
20 | ### DefaultRoleIDs
21 |
22 | 系统默认生成下列身份组 ID:
23 |
24 | | 身份组 ID 默认值 | 描述 |
25 | | ---------------- | ------------ |
26 | | 1 | 全体成员 |
27 | | 2 | 管理员 |
28 | | 4 | 群主/创建者 |
29 | | 5 | 子频道管理员 |
30 |
31 | ## 参数说明
32 |
33 | | 参数 | 必填 | 类型 | 说明 |
34 | | ------- | ---- | ------ | --------- |
35 | | guildId | 是 | string | 频道 ID |
36 | | roleId | 是 | string | 身份组 ID |
37 |
38 | ## 返回说明
39 |
40 | 返回结果为空。
41 |
42 | ## 返回示例
43 |
44 | `data`：
45 |
46 | ```js
47 | '';
48 | ```
49 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/guild/get_guild.md:
--------------------------------------------------------------------------------
1 | # 获取频道详情
2 |
3 | 获取频道详情。
4 |
5 | ## 使用示例
6 |
7 | ```javascript
8 | async function demo() {
9 | let { data } = await client.guildApi.guild(guildId);
10 | }
11 | ```
12 |
13 | ## 参数说明
14 |
15 | | 字段名 | 必填 | 类型 | 描述 |
16 | | ------- | ---- | ------ | ------- |
17 | | guildId | 是 | string | 频道 ID |
18 |
19 | ## 返回说明
20 |
21 | 返回 [Guild](#guild) 对象。
22 |
23 | ### Guild
24 |
25 | | 字段名 | 类型 | 描述 |
26 | | ------------ | ------- | ------------------ |
27 | | id | string | 频道 ID |
28 | | name | string | 频道名称 |
29 | | owner_id | string | 创建人用户 ID |
30 | | owner | boolean | 当前人是否是创建人 |
31 | | member_count | number | 成员数 |
32 | | max_members | number | 最大成员数 |
33 | | description | string | 描述 |
34 |
35 | ## 返回示例
36 |
37 | `data`：
38 |
39 | ```js
40 | {
41 | "id": "GUILD_ID",
42 | "name": "Ost测试频道",
43 | "owner_id": "OWNER_ID",
44 | "owner": false,
45 | "member_count": 10,
46 | "max_members": 300,
47 | "description": "测试用"
48 | }
49 | ```
50 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/member/delete_member.md:
--------------------------------------------------------------------------------
1 | # 删除频道成员
2 |
3 | 移除频道的某个成员。
4 |
5 |
6 |
7 | ## 使用示例
8 |
9 | ```javascript
10 | async function demo() {
11 | let { data } = await client.guildApi.deleteGuildMember(guildId, userId);
12 | }
13 | ```
14 |
15 | ::: warning 注意
16 |
17 | - 需要使用的 token 对应的用户具备踢人权限。如果是机器人，要求被添加为管理员。
18 | - 操作成功后，会触发频道成员删除事件
19 |
20 | :::
21 |
22 | ## 参数说明
23 |
24 | | 字段名 | 必填 | 类型 | 描述 |
25 | | ------- | ---- | ------ | ------- |
26 | | guildId | 是 | string | 频道 ID |
27 | | userId | 是 | string | 用户 ID |
28 |
29 | ## 返回说明
30 |
31 | 返回结果为空。
32 |
33 | ## 返回示例
34 |
35 | `data`:
36 |
37 | ```js
38 | '';
39 | ```
40 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/message/delete_message.md:
--------------------------------------------------------------------------------
1 | # 撤回消息
2 |
3 | 撤回子频道内的消息。
4 |
5 | ::: warning 注意
6 |
7 | - 管理员可以撤回普通成员的消息。
8 | - 频道主可以撤回所有人的消息。
9 | - 增加hideTip选项，控制是否显示撤回消息的小灰条。
10 |
11 | :::
12 |
13 | ## 使用示例
14 |
15 | ```javascript
16 | async function demo() {
17 | let { data } = await client.messageApi.deleteMessage(channelID, messageID, hideTip);
18 | }
19 | ```
20 |
21 | ## 参数说明
22 |
23 | | 参数 | 必填 | 类型 | 说明 |
24 | | --------- | ---- | ------ | -------------------------------- |
25 | | channelID | 是 | string | [子频道 ID](../model/channel.md) |
26 | | messageID | 是 | string | [消息 ID](../model/message.md) |
27 | | hideTip | 否 | boolean | 选填，是否隐藏提示小灰条，true 为隐藏，false 为显示。默认为false |
28 |
29 | ## 返回说明
30 |
31 | 返回结果为空。
32 |
33 | ## 返回示例
34 |
35 | `data`：
36 |
37 | ```js
38 | '';
39 | ```
40 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/model/announce.md:
--------------------------------------------------------------------------------
1 | # 公告对象（Announce）
2 |
3 | ## Announce
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ------------------ | -------------------------------------------- | ------------------------------- |
7 | | guild_id | string | [频道 ID](./guild.md) |
8 | | channel_id | string | [子频道 ID](./channel.md) |
9 | | message_id | string | [消息 ID](./message.md) |
10 | | announce_type | number | 推荐类别 0:成员公告; 1:欢迎公告 |
11 | | recommend_channels | [RecommendChannel[]](#recommendchannel) 数组 | 推荐子频道详情列表 |
12 |
13 | ## RecommendChannel
14 |
15 | 子频道对象
16 |
17 | | 字段名 | 类型 | 描述 |
18 | | ---------- | ------ | ------------------------- |
19 | | channel_id | string | [子频道 ID](./channel.md) |
20 | | introduce | string | 推荐语 |
21 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/model/dms.md:
--------------------------------------------------------------------------------
1 | # 私信会话对象（DMS）
2 |
3 | ## DMS
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ----------- | ------ | ----------------------- |
7 | | guild_id | string | 私信会话关联的频道 ID |
8 | | channel_id | string | 私信会话关联的子频道 ID |
9 | | create_time | string | 创建私信会话时间戳 |
10 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/model/guild.md:
--------------------------------------------------------------------------------
1 | # 频道对象(Guild)
2 |
3 | 频道对象中所涉及的 ID 类数据，都仅在机器人场景流通，与真实的 ID 无关，请不要理解为真实的 ID。
4 |
5 | ### Guild
6 |
7 | | 字段名 | 类型 | 描述 |
8 | | --- | --- | --- |
9 | | id | string | 频道ID |
10 | | name | string | 频道名称 |
11 | | icon | string | 频道头像地址 |
12 | | owner_id | string | 创建人用户ID |
13 | | owner | boolean | 当前人是否是创建人 |
14 | | member_count | number | 成员数 |
15 | | max_members | number | 最大成员数 |
16 | | description | string | 描述 |
17 | | joined_at | string | 加入时间 |
18 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/model/pins_message.md:
--------------------------------------------------------------------------------
1 | # 精华消息对象(PinsMessage)
2 |
3 | ## PinsMessage
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ----------- | -------- | --------------------------- |
7 | | guild_id | string | [频道 ID](./guild.md) |
8 | | channel_id | string | [子频道 ID](./channel.md) |
9 | | message_ids | string[] | [消息 ID](./message.md)数组 |
10 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/model/role.md:
--------------------------------------------------------------------------------
1 | # 频道身份组对象(Role)
2 |
3 | ## Role
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ------------ | ------ | -------------------------------------------------------------- |
7 | | id | string | 身份组 ID |
8 | | name | string | 名称 |
9 | | color | number | ARGB 的 HEX 十六进制颜色值转换后的十进制数值（例：4294927682） |
10 | | hoist | number | 是否在成员列表中单独展示: 0-否, 1-是 |
11 | | number | number | 人数 |
12 | | member_limit | number | 成员上限 |
13 |
14 | ## DefaultRoleIDs(系统默认生成下列身份组 ID)
15 |
16 | | 身份组 ID 默认值 | 描述 |
17 | | ---------------- | ------------ |
18 | | 1 | 全体成员 |
19 | | 2 | 管理员 |
20 | | 4 | 群主/创建者 |
21 | | 5 | 子频道管理员 |
22 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/model/user.md:
--------------------------------------------------------------------------------
1 | # 用户对象(User)
2 |
3 | 用户对象中所涉及的 ID 类数据，都仅在机器人场景流通，与真实的 ID 无关，请不要理解为真实的 ID。
4 |
5 | ## User
6 |
7 | | 字段名 | 类型 | 描述 |
8 | | ------------------ | ------ | -------------------------------------------------------------------------------------------------- |
9 | | id | string | 用户 ID |
10 | | username | string | 用户名 |
11 | | avatar | string | 用户头像地址 |
12 | | bot | boolean | 是否是机器人 |
13 | | union_openid | string | 特殊关联应用的 openid，需要特殊申请并配置后才会返回。如需申请，请联系平台运营人员。 |
14 | | union_user_account | string | 机器人关联的互联应用的用户信息，与 union_openid 关联的应用是同一个。如需申请，请联系平台运营人员。 |
15 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/pins_message/delete_pins_message.md:
--------------------------------------------------------------------------------
1 | # 删除精华消息
2 |
3 | 用于移除子频道 `channelId` 下的精华消息 `messageId` 。
4 |
5 | ## 使用示例
6 |
7 | ```javascript
8 | async function demo() {
9 | let { data } = await client.pinsMessageApi.deletePinsMessage(channelId, messageId);
10 | }
11 | ```
12 |
13 | ## 参数说明
14 |
15 | | 字段名 | 必填 | 类型 | 描述 |
16 | | --------- | ---- | ------ | -------------------------------- |
17 | | channelId | 是 | string | [子频道 ID](../model/channel.md) |
18 | | messageId | 是 | string | [消息 ID](../model/message.md) |
19 |
20 | ## 返回说明
21 |
22 | 成功返回空对象。
23 |
24 | ## 返回示例
25 |
26 | `data`：
27 |
28 | ```js
29 | {
30 | }
31 | ```
32 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/pins_message/get_pins_message.md:
--------------------------------------------------------------------------------
1 | # 获取精华消息
2 |
3 | 用于获取子频道 `channelId` 内的精华消息。
4 |
5 | ## 使用示例
6 |
7 | ```javascript
8 | async function demo() {
9 | let { data } = await client.pinsMessageApi.pinsMessage(channelId);
10 | }
11 | ```
12 |
13 | ## 参数说明
14 |
15 | | 字段名 | 必填 | 类型 | 描述 |
16 | | --------- | ---- | ------ | -------------------------------- |
17 | | channelId | 是 | string | [子频道 ID](../model/channel.md) |
18 |
19 | ## 返回说明
20 |
21 | 返回 [PinsMessage](#pinsmessage) 对象。
22 |
23 | ### PinsMessage
24 |
25 | | 字段名 | 类型 | 描述 |
26 | | ----------- | -------- | ---------------------------------- |
27 | | guild_id | string | [频道 ID](../model/guild.md) |
28 | | channel_id | string | [子频道 ID](../model/channel.md) |
29 | | message_ids | string[] | [消息 ID](../model/message.md)数组 |
30 |
31 | ## 返回示例
32 |
33 | `data`：
34 |
35 | ```json
36 | {
37 | "guild_id": "xxxxxx",
38 | "channel_id": "xxxxxx",
39 | "message_ids": ["xxxxx"]
40 | }
41 | ```
42 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/schedule/delete_schedule.md:
--------------------------------------------------------------------------------
1 | # 删除日程
2 |
3 | 删除`日程子频道`里的一个日程。
4 |
5 | ::: warning 注意
6 |
7 | 要求操作人具有管理频道的权限，如果是机器人，则需要将机器人设置为管理员。
8 |
9 | :::
10 |
11 | ## 使用示例
12 |
13 | ```javascript
14 | async function demo() {
15 | let { data } = await client.scheduleApi.deleteSchedule(channelId, scheduleId);
16 | }
17 | ```
18 |
19 | ## 参数说明
20 |
21 | | 字段名 | 必填 | 类型 | 描述 |
22 | | ---------- | ---- | ------ | -------------------------------- |
23 | | channelId | 是 | string | [子频道 ID](../model/channel.md) |
24 | | scheduleId | 是 | string | 日程 ID |
25 |
26 | ## 返回说明
27 |
28 | 返回结果为空。
29 |
30 | ## 返回示例
31 |
32 | `data`：
33 |
34 | ```js
35 | '';
36 | ```
37 |
--------------------------------------------------------------------------------
/docs/develop/nodesdk/user/guilds.md:
--------------------------------------------------------------------------------
1 | # 获取当前用户频道列表
2 |
3 | ## 接口
4 |
5 | `GET /users/@me/guilds`
6 |
7 | ## 返回
8 |
9 | 当前用户所加入的 [Guild](../guild/model.md#guild) 对象列表
10 |
11 | ## 参数
12 |
13 | | 字段名 | 类型 | 描述 | 要求 |
14 | | ------ | ------ | ------------------ | --------------------------------- |
15 | | before | string | 读此 id 之前的数据 | guild id, before/after 只能带一个 |
16 | | after | string | 读此 id 之后的数据 | guild id, before/after 只能带一个 |
17 | | limit | number | 每次拉取多少条数据 | 最大不超过 100，默认 100 |
18 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/announce/create_channel_announce.md:
--------------------------------------------------------------------------------
1 | # 创建子频道公告
2 |
3 | 将某条消息创建为子频道的公告。
4 |
5 | ## 使用示例
6 |
7 | ```python
8 | import botpy
9 | from botpy.message import Message
10 |
11 | class MyClient(botpy.Client):
12 | async def on_at_message_create(self, message: Message):
13 | message_id = "088de19cbeb883e7e97110a2e39c0138d401"
14 | await self.api.create_announce(message.guild_id, message.channel_id, message_id)
15 |
16 | intents = botpy.Intents(public_guild_messages=True)
17 | client = MyClient(intents=intents)
18 | client.run(appid={appid}, token={token})
19 | ```
20 |
21 | ## 参数说明
22 |
23 | | 字段名 | 必填 | 类型 | 描述 |
24 | | --------- | ---- | ------ | -------------------------------- |
25 | | guild_id | 是 | string | 频道 ID |
26 | | channel_id | 是 | string | 子频道 ID |
27 | | message_id | string | 消息 ID |
28 |
29 |
30 | ## 返回示例
31 |
32 | `data`：
33 |
34 | ```json
35 | {
36 | "guild_id":"guild_id",
37 | "channel_id":"channel_id",
38 | "message_id":"message_id"
39 | }
40 | ```
41 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/announce/delete_channel_announce.md:
--------------------------------------------------------------------------------
1 | # 删除子频道公告
2 |
3 | 删除子频道公告。
4 |
5 | ## 使用示例
6 |
7 | ```python
8 | import botpy
9 | from botpy.message import Message
10 |
11 | class MyClient(botpy.Client):
12 | async def on_at_message_create(self, message: Message):
13 | message_id = "088de19cbeb883e7e97110a2e39c0138d401"
14 | await self.api.delete_announce(message.guild_id, message_id)
15 |
16 | intents = botpy.Intents(public_guild_messages=True)
17 | client = MyClient(intents=intents)
18 | client.run(appid={appid}, token={token})
19 | ```
20 |
21 | ## 参数说明
22 |
23 | | 字段名 | 必填 | 类型 | 描述 |
24 | | --------- | ---- | ------ | -------------------------------- |
25 | | guild_id | 是 | string | 频道 ID |
26 | | message_id | string | 消息 ID |
27 |
28 | ## 返回说明
29 |
30 | 成功返回空对象。
31 |
32 | ## 返回示例
33 |
34 | `data`：
35 |
36 | ```python
37 | True
38 | ```
39 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/announce/delete_guild_announce.md:
--------------------------------------------------------------------------------
1 | # 删除频道推荐子频道
2 |
3 | 删除频道推荐子频道。
4 |
5 | ## 使用示例
6 |
7 | ```python
8 | import botpy
9 | from botpy.message import Message
10 |
11 | class MyClient(botpy.Client):
12 | async def on_at_message_create(self, message: Message):
13 | await self.api.delete_announce(message.guild_id, "all")
14 |
15 | intents = botpy.Intents(public_guild_messages=True)
16 | client = MyClient(intents=intents)
17 | client.run(appid={appid}, token={token})
18 | ```
19 |
20 | ## 参数说明
21 |
22 | | 字段名 | 必填 | 类型 | 描述 |
23 | | --------- | ---- | ------ | ------------------------------ |
24 | | guild_id | 是 | string | 频道 ID |
25 | | message_id | 是 | string | 消息 ID |
26 |
27 | ## 返回说明
28 |
29 | 成功返回空对象。
30 |
31 | ## 返回示例
32 |
33 | `data`：
34 |
35 | ```python
36 | True
37 | ```
38 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/audio/audio_off_mic.md:
--------------------------------------------------------------------------------
1 | # 机器人下麦
2 |
3 | ## 使用示例
4 |
5 | ```py
6 | import botpy
7 | from botpy.audio import Audio
8 |
9 | class MyClient(botpy.Client):
10 | async def on_audio_start(self, audio: Audio):
11 | await self.api.off_microphone(audio.channel_id)
12 |
13 | intents = botpy.Intents(audio_action=True)
14 | client = MyClient(intents=intents)
15 | client.run(appid={appid}, token={token})
16 |
17 | ```
18 |
19 | ## 参数说明
20 |
21 | | 字段名 | 类型 | 描述 |
22 | | ------------ | ------------------------------------- | -------------- |
23 | | channel_id | String | 子频道 id |
24 |
25 | ## 返回说明
26 |
27 | ```json
28 | {}
29 | ```
30 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/audio/audio_on_mic.md:
--------------------------------------------------------------------------------
1 | # 机器人上麦
2 |
3 | ## 使用示例
4 |
5 | ```py
6 | import botpy
7 | from botpy.audio import Audio
8 |
9 | class MyClient(botpy.Client):
10 | async def on_audio_start(self, audio: Audio):
11 | await self.api.on_microphone(audio.channel_id)
12 |
13 | intents = botpy.Intents(audio_action=True)
14 | client = MyClient(intents=intents)
15 | client.run(appid={appid}, token={token})
16 |
17 | ```
18 |
19 | ## 参数说明
20 |
21 | | 字段名 | 类型 | 描述 |
22 | | ------------ | ------------------------------------- | -------------- |
23 | | channel_id | String | 子频道 id |
24 |
25 | ## 返回说明
26 |
27 | ```json
28 | {}
29 | ```
30 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/channel/delete_channel.md:
--------------------------------------------------------------------------------
1 | # 删除子频道
2 |
3 | 移除一个子频道。
4 |
5 |
6 |
7 | ## 使用示例
8 |
9 | ```python
10 | import botpy
11 | from botpy.message import Message
12 |
13 | class MyClient(botpy.Client):
14 | async def on_at_message_create(self, message: Message):
15 | await self.api.delete_channel(channel_id="xxxx")
16 |
17 | intents = botpy.Intents(public_guild_messages=True)
18 | client = MyClient(intents=intents)
19 | client.run(appid={appid}, token={token})
20 | ```
21 |
22 | ::: warning 注意
23 |
24 | - 要求操作人具有`管理频道`的权限，如果是机器人，则需要将机器人设置为管理员。
25 | - 创建成功后，返回创建成功的子频道对象，同时会触发一个频道创建的事件通知。
26 | - 子频道的删除是无法撤回的，一旦删除，将无法恢复。
27 |
28 | :::
29 |
30 | ## 参数说明
31 |
32 | | 字段名 | 必填 | 类型 | 描述 |
33 | | --------- | ---- | ------ | --------- |
34 | | channel_id | 是 | string | 子频道 ID |
35 |
36 | ## 返回说明
37 |
38 | 成功返回 HTTP 状态码 200
39 |
40 | ## 返回示例
41 |
42 | `data`：
43 |
44 | ```json
45 | {}
46 | ```
47 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/dms/create_dms.md:
--------------------------------------------------------------------------------
1 | # 创建私信会话
2 |
3 | 用于机器人和在同一个频道内的成员创建私信会话。
4 |
5 | :::warning 注意
6 |
7 | 机器人和用户存在共同频道才能创建私信会话。
8 |
9 | :::
10 |
11 | ## 使用示例
12 |
13 | ```python
14 | import botpy
15 | from botpy.message import Message
16 |
17 | class MyClient(botpy.Client):
18 | async def on_at_message_create(self, message: Message):
19 | await self.api.create_dms(guild_id="xxxx", user_id="xxxx")
20 |
21 | intents = botpy.Intents(public_guild_messages=True)
22 | client = MyClient(intents=intents)
23 | client.run(appid={appid}, token={token})
24 | ```
25 |
26 | ## 参数说明
27 |
28 | | 字段名 | 必填 | 类型 | 描述 |
29 | | ------ | ---- | --------------------------- | -------------- |
30 | | guild_id | 是 | string | [源频道 ID](../../model/guild.md) |
31 | | user_id | 是 | string | [接收者 ID](../../model/user.md) |
32 |
33 | ## 返回说明
34 |
35 | 返回[DMS](#dms)对象。
36 |
37 | ### DMS
38 |
39 | | 字段名 | 类型 | 描述 |
40 | | ----------- | ------ | ----------------------- |
41 | | guild_id | string | 私信会话关联的频道 ID |
42 | | channel_id | string | 私信会话关联的子频道 ID |
43 | | create_time | string | 创建私信会话时间戳 |
44 |
45 | ## 返回示例
46 |
47 | ```json
48 | {
49 | "guild_id": "xxxxxx",
50 | "channel_id": "xxxxxx",
51 | "create_time": "1642545606"
52 | }
53 | ```
54 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/guild/guild_role/delete_guild_role.md:
--------------------------------------------------------------------------------
1 | # 删除频道身份组
2 |
3 | 删除频道身份组。
4 |
5 | ```python
6 | import botpy
7 | from botpy.message import Message
8 |
9 | class MyClient(botpy.Client):
10 | async def on_at_message_create(self, message: Message):
11 | await self.api.delete_guild_role(guild_id="xxxx", role_id="xxxx")
12 |
13 | intents = botpy.Intents(public_guild_messages=True)
14 | client = MyClient(intents=intents)
15 | client.run(appid={appid}, token={token})
16 | ```
17 |
18 | ### 参数说明
19 |
20 | | 参数 | 必填 | 类型 | 说明 |
21 | | ------- | ---- | ------ | --------- |
22 | | guild_id | 是 | string | 频道 ID |
23 | | role_id | 是 | string | 身份组 ID |
24 |
25 | ### 返回说明
26 |
27 | 是否删除成功
28 |
29 | ### 返回示例
30 |
31 | `data`：
32 |
33 | ```python
34 | True
35 | ```
36 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/member/delete_guild_member.md:
--------------------------------------------------------------------------------
1 | # 删除频道成员
2 |
3 | 移除频道的某个成员。
4 |
5 |
6 |
7 | ## 使用示例
8 |
9 | ```python
10 | import botpy
11 | from botpy.message import Message
12 |
13 | class MyClient(botpy.Client):
14 | async def on_at_message_create(self, message: Message):
15 | await self.api.get_delete_member(
16 | guild_id="xxxx",
17 | user_id="xxx",
18 | add_blacklist=True,
19 | delete_history_msg_days=7
20 | )
21 |
22 | intents = botpy.Intents(public_guild_messages=True)
23 | client = MyClient(intents=intents)
24 | client.run(appid={appid}, token={token})
25 | ```
26 |
27 | ::: warning 注意
28 |
29 | - 需要使用的 token 对应的用户具备踢人权限。如果是机器人，要求被添加为管理员。
30 | - 操作成功后，会触发频道成员删除事件
31 | :::
32 |
33 | ## 参数说明
34 |
35 | | 字段名 | 必填 | 类型 | 描述 |
36 | | ------- | ---- | ------ | ------- |
37 | | guild_id | 是 | string | 频道 ID |
38 | | user_id | 是 | string | 用户 ID |
39 | | add_blacklist | 是 | bool | 是否拉入黑名单 |
40 | | delete_history_msg_days | 是 | int | 撤回移除成员的消息，可指定撤回消息的时间范围 |
41 |
42 | > 注：消息撤回时间范围仅支持固定的天数：3，7，15，30。 特殊的时间范围：-1: 撤回全部消息。默认值为0不撤回任何消息。
43 |
44 |
45 | ## 返回说明
46 |
47 | 无
48 |
49 | ## 返回示例
50 |
51 | `data`:
52 |
53 | ```js
54 | {}
55 | ```
56 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/message/recall_message.md:
--------------------------------------------------------------------------------
1 | # 撤回消息
2 |
3 | 撤回子频道内的消息。
4 |
5 | ::: warning 注意
6 |
7 | - 管理员可以撤回普通成员的消息。
8 | - 频道主可以撤回所有人的消息。
9 |
10 | :::
11 |
12 | ## 使用示例
13 |
14 | ```python
15 | import botpy
16 |
17 | from botpy.message import Message
18 |
19 | class MyClient(botpy.Client):
20 | async def on_at_message_create(self, message: Message):
21 | await self.api.recall_message(channel_id=message.channel_id, message_id="xxx", hidetip=True)
22 |
23 | intents = botpy.Intents(public_guild_messages=True)
24 | client = MyClient(intents=intents)
25 | client.run(appid={appid}, token={token})
26 | ```
27 |
28 | ## 参数说明
29 |
30 | | 参数 | 必填 | 类型 | 说明 |
31 | | --------- | ---- | ------ | -------------------------------- |
32 | | channel_id | 是 | string | 子频道 ID |
33 | | message_id | 是 | string | 消息 ID |
34 | | hide_tip | 否 | bool | 是否隐藏提示小灰条，true 为隐藏，false 为显示。默认为false |
35 |
36 | ## 返回说明
37 |
38 | 返回是否更新成功
39 |
40 | ## 返回示例
41 |
42 | `data`：
43 |
44 | ```python
45 | True
46 | ```
47 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/mute/mute_all.md:
--------------------------------------------------------------------------------
1 | # 禁言全员
2 |
3 | 将频道内全部成员（非管理员）禁言。
4 |
5 | ## 使用示例
6 |
7 | ```python
8 | import botpy
9 |
10 | from botpy.message import Message
11 |
12 | class MyClient(botpy.Client):
13 | async def on_at_message_create(self, message: Message):
14 | await self.api.mute_all(guild_id="xxxx", mute_end_timestamp="xxxx", mute_seconds="xxxx")
15 |
16 | intents = botpy.Intents(public_guild_messages=True)
17 | client = MyClient(intents=intents)
18 | client.run(appid={appid}, token={token})
19 | ```
20 |
21 | ## 参数说明
22 |
23 | | 字段名 | 必填 | 类型 | 描述 |
24 | | ------- | ---- | ------------------------- | ---------------------------- |
25 | | guild_id | 是 | string | [频道 ID](../../model/guild.md) |
26 | | mute_end_timestamp | string | 禁言到期时间戳，`绝对时间戳`，单位：`秒`（与 `seconds` 字段同时赋值的话，以该字段为准） |
27 | | mute_seconds | string | 禁言多少秒（两个字段二选一，**默认以 `mute_end_timstamp` 为准**） |
28 |
29 | ## 返回说明
30 |
31 | 成功返回空对象。
32 |
33 | ## 返回示例
34 |
35 | `data`：
36 |
37 | ```python
38 | True
39 | ```
40 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/mute/mute_member.md:
--------------------------------------------------------------------------------
1 | # 禁言指定成员
2 |
3 | 将频道指定成员（非管理员）禁言。
4 |
5 | ## 使用示例
6 |
7 | ```python
8 | import botpy
9 |
10 | from botpy.message import Message
11 |
12 | class MyClient(botpy.Client):
13 | async def on_at_message_create(self, message: Message):
14 | await self.api.mute_member(guild_id="xxxx", user_id="xxxx", mute_end_timestamp="xxxx", mute_seconds="xxxx")
15 |
16 | intents = botpy.Intents(public_guild_messages=True)
17 | client = MyClient(intents=intents)
18 | client.run(appid={appid}, token={token})
19 | ```
20 |
21 | ## 参数说明
22 |
23 | | 字段名 | 必填 | 类型 | 描述 |
24 | | ------- | ---- | ------------------------- | ---------------------------- |
25 | | guild_id | 是 | string | [频道 ID](../../model/guild.md) |
26 | | user_id | 是 | string | [成员 ID](../../model/user.md) |
27 | | mute_end_timestamp | string | 禁言到期时间戳，`绝对时间戳`，单位：`秒`（与 `seconds` 字段同时赋值的话，以该字段为准） |
28 | | mute_seconds | string | 禁言多少秒（两个字段二选一，**默认以 `mute_end_timstamp` 为准**） |
29 |
30 | ## 返回说明
31 |
32 | 成功返回空对象。
33 |
34 | ## 返回示例
35 |
36 | `data`：
37 |
38 | ```python
39 | True
40 | ```
41 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/pins_message/delete_pins_message.md:
--------------------------------------------------------------------------------
1 | # 删除精华消息
2 |
3 | 用于移除子频道 `channelId` 下的精华消息 `messageId` 。
4 |
5 | ## 使用示例
6 |
7 | ```python
8 | import botpy
9 |
10 | from botpy.message import Message
11 |
12 | class MyClient(botpy.Client):
13 | async def on_at_message_create(self, message: Message):
14 | await self.api.delete_pin(channel_id=message.channel_id, message_id=message.id)
15 |
16 | intents = botpy.Intents(public_guild_messages=True)
17 | client = MyClient(intents=intents)
18 | client.run(appid={appid}, token={token})
19 | ```
20 |
21 | ## 参数说明
22 |
23 | | 字段名 | 必填 | 类型 | 描述 |
24 | | --------- | ---- | ------ | -------------------------------- |
25 | | channel_id | 是 | string | 子频道 ID |
26 | | message_id | 是 | string | 消息 ID |
27 |
28 | ## 返回说明
29 |
30 | 成功返回空对象。
31 |
32 | ## 返回示例
33 |
34 | `data`：
35 |
36 | ```Python
37 | True
38 | ```
39 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/pins_message/get_pins_message.md:
--------------------------------------------------------------------------------
1 | # 获取精华消息
2 |
3 | 用于获取子频道 `channelId` 内的精华消息。
4 |
5 | ## 使用示例
6 |
7 | ```python
8 | import botpy
9 |
10 | from botpy.message import Message
11 |
12 | class MyClient(botpy.Client):
13 | async def on_at_message_create(self, message: Message):
14 | await self.api.get_pins(channel_id=message.channel_id)
15 |
16 | intents = botpy.Intents(public_guild_messages=True)
17 | client = MyClient(intents=intents)
18 | client.run(appid={appid}, token={token})
19 | ```
20 |
21 | ## 参数说明
22 |
23 | | 字段名 | 必填 | 类型 | 描述 |
24 | | --------- | ---- | ------ | -------------------------------- |
25 | | channel_id | 是 | string | 子频道 ID |
26 |
27 | ## 返回说明
28 |
29 | 返回 [PinsMessage](#pinsmessage) 对象。
30 |
31 | ### PinsMessage
32 |
33 | | 字段名 | 类型 | 描述 |
34 | | ----------- | -------- | ---------------------------------- |
35 | | guild_id | string | 频道 ID |
36 | | channel_id | string | 子频道 ID |
37 | | message_ids | string[] | 消息 ID |
38 |
39 | ## 返回示例
40 |
41 | `data`：
42 |
43 | ```json
44 | {
45 | "guild_id": "xxxxxx",
46 | "channel_id": "xxxxxx",
47 | "message_ids": ["xxxxx"]
48 | }
49 | ```
50 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/reaction/post_reaction.md:
--------------------------------------------------------------------------------
1 | # 发表表情表态
2 |
3 | 用于在指定子频道向某条消息发表表情表态。
4 |
5 | ## 使用示例
6 |
7 | ```python
8 | import botpy
9 |
10 | from botpy.message import Message
11 |
12 | class MyClient(botpy.Client):
13 | async def on_at_message_create(self, message: Message):
14 | await self.api.put_reaction(channel_id="xxxx", message_id="xxxx", emoji_type=1, emoji_id="4")
15 |
16 | intents = botpy.Intents(public_guild_messages=True)
17 | client = MyClient(intents=intents)
18 | client.run(appid={appid}, token={token})
19 | ```
20 |
21 | ## 参数说明
22 |
23 | | 字段名 | 必填 | 类型 | 描述 |
24 | | ----------- | ---- | ------------------------------------- | -------------------------------- |
25 | | channel_id | 是 | string | 子频道 ID |
26 | | message_id | 是 | string | 消息 ID |
27 | | emoji_type | 是 | int | 表情类型，参考[EmojiType](../../model/emoji.md#EmojiType) |
28 | | emoji_id | 是 | string | 表情 ID，参考 [Emoji 列表](../../model/emoji.md#Emoji-列表)
29 |
30 | ## 返回说明
31 |
32 | 返回是否更新成功
33 |
34 | ## 返回示例
35 |
36 | `data`：
37 |
38 | ```Python
39 | True
40 | ```
41 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/api/schedule/delete_schedule.md:
--------------------------------------------------------------------------------
1 | # 删除日程
2 |
3 | 删除`日程子频道`里的一个日程。
4 |
5 | ::: warning 注意
6 |
7 | 要求操作人具有管理频道的权限，如果是机器人，则需要将机器人设置为管理员。
8 |
9 | :::
10 |
11 | ## 使用示例
12 |
13 | ```python
14 | import botpy
15 | from botpy.message import Message
16 |
17 | class MyClient(botpy.Client):
18 | async def on_at_message_create(self, message: Message):
19 | await self.api.delete_schedule(channel_id="日程子频道ID", schedule_id="日程ID")
20 |
21 | intents = botpy.Intents(public_guild_messages=True)
22 | client = MyClient(intents=intents)
23 | client.run(appid={appid}, token={token})
24 | ```
25 |
26 | ## 参数说明
27 |
28 | | 字段名 | 必填 | 类型 | 描述 |
29 | | ---------- | ---- | ------ | -------------------------------- |
30 | | channel_id | 是 | string | [子频道 ID](../../model/channel.md) |
31 | | schedule_id | 是 | string | 日程 ID |
32 |
33 | ## 返回说明
34 |
35 | 返回结果为空。
36 |
37 | ## 返回示例
38 |
39 | `data`：
40 |
41 | ```python
42 | True
43 | ```
44 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/model/announce.md:
--------------------------------------------------------------------------------
1 | # 公告对象（Announce）
2 |
3 | ## Announce
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ---------- | ------ | --------- |
7 | | guild_id | string | 频道 ID |
8 | | channel_id | string | 子频道 ID |
9 | | message_id | string | 消息 ID |
10 | | announce_type | number | 推荐类别 0:成员公告; 1:欢迎公告 |
11 | | recommend_channels | [RecommendChannel](#recommendchannel) 列表 | 推荐子频道详情列表 |
12 |
13 | ## RecommendChannel
14 |
15 | | 字段名 | 类型 | 描述 |
16 | | ---------- | ------ | --------- |
17 | | channel_id | string | 子频道 ID |
18 | | introduce | string | 消息 ID |
19 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/model/dms.md:
--------------------------------------------------------------------------------
1 | # 私信会话对象（DMS）
2 |
3 | ## DMS
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ----------- | ------ | ----------------------- |
7 | | guild_id | string | 私信会话关联的频道 ID |
8 | | channel_id | string | 私信会话关联的子频道 ID |
9 | | create_time | string | 创建私信会话时间戳 |
10 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/model/guild.md:
--------------------------------------------------------------------------------
1 | # 频道对象(Guild)
2 |
3 | 频道对象中所涉及的 ID 类数据，都仅在机器人场景流通，与真实的 ID 无关，请不要理解为真实的 ID。
4 |
5 | ### Guild
6 |
7 | | 字段名 | 类型 | 描述 |
8 | | --- | --- | --- |
9 | | id | string | 频道ID |
10 | | name | string | 频道名称 |
11 | | icon | string | 频道头像地址 |
12 | | owner_id | string | 创建人用户ID |
13 | | owner | boolean | 当前人是否是创建人 |
14 | | member_count | number | 成员数 |
15 | | max_members | number | 最大成员数 |
16 | | description | string | 描述 |
17 | | joined_at | string | 加入时间 |
18 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/model/pins_message.md:
--------------------------------------------------------------------------------
1 | # 精华消息对象(PinsMessage)
2 |
3 | ## PinsMessage
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ----------- | -------- | --------------------------- |
7 | | guild_id | string | [频道 ID](./guild.md) |
8 | | channel_id | string | [子频道 ID](./channel.md) |
9 | | message_ids | string 列表 | [消息 ID](./message.md) 列表 |
10 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/model/role.md:
--------------------------------------------------------------------------------
1 | # 频道身份组对象(Role)
2 |
3 | ### Role
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | ------------ | ------ | -------------------------------------------------------------- |
7 | | id | string | 身份组 ID |
8 | | name | string | 名称 |
9 | | color | number | ARGB 的 HEX 十六进制颜色值转换后的十进制数值（例：4294927682） |
10 | | hoist | number | 是否在成员列表中单独展示: 0-否, 1-是 |
11 | | number | number | 人数 |
12 | | member_limit | number | 成员上限 |
13 |
14 | ### DefaultRoleIDs(系统默认生成下列身份组 ID)
15 |
16 | | 身份组 ID 默认值 | 描述 |
17 | | ---------------- | ------------ |
18 | | 1 | 全体成员 |
19 | | 2 | 管理员 |
20 | | 4 | 群主/创建者 |
21 | | 5 | 子频道管理员 |
22 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/model/schedule.md:
--------------------------------------------------------------------------------
1 | # 日程对象(Schedule)
2 |
3 | ## Schedule
4 |
5 | | 字段名 | 类型 | 描述 |
6 | | --------------- | --------------------- | ----------------------------------------------- |
7 | | id | string | 日程 ID |
8 | | name | string | 日程名称 |
9 | | description | string | 日程描述 |
10 | | start_timestamp | string | 日程开始时间戳(ms) |
11 | | end_timestamp | string | 日程结束时间戳(ms) |
12 | | creator | [Member](./member.md) | 创建者 |
13 | | jump_channel_id | string | 日程开始时跳转到的子频道 ID |
14 | | remind_type | string | 日程提醒类型，取值参考[RemindType](#remindtype) |
15 |
16 | ## RemindType
17 |
18 | | 提醒类型 id | 描述 |
19 | | ----------- | ------------------ |
20 | | 0 | 不提醒 |
21 | | 1 | 开始时提醒 |
22 | | 2 | 开始前 5 分钟提醒 |
23 | | 3 | 开始前 15 分钟提醒 |
24 | | 4 | 开始前 30 分钟提醒 |
25 | | 5 | 开始前 60 分钟提醒 |
26 |
--------------------------------------------------------------------------------
/docs/develop/pythonsdk/model/user.md:
--------------------------------------------------------------------------------
1 | # 用户对象(User)
2 |
3 | 用户对象中所涉及的 ID 类数据，都仅在机器人场景流通，与真实的 ID 无关，请不要理解为真实的 ID。
4 |
5 | ## User
6 |
7 | | 字段名 | 类型 | 描述 |
8 | | ------------------ | ------ | -------------------------------------------------------------------------------------------------- |
9 | | id | string | 用户 ID |
10 | | username | string | 用户名 |
11 | | avatar | string | 用户头像地址 |
12 | | bot | boolean | 是否是机器人 |
13 | | union_openid | string | 特殊关联应用的 openid，需要特殊申请并配置后才会返回。如需申请，请联系平台运营人员。 |
14 | | union_user_account | string | 机器人关联的互联应用的用户信息，与 union_openid 关联的应用是同一个。如需申请，请联系平台运营人员。 |
15 |
--------------------------------------------------------------------------------
/docs/newfeature/README.md:
--------------------------------------------------------------------------------
1 | QQ开放平台更新介绍
2 |
3 | - [v.5(2023.11.08)](/newfeature/eleven/)
4 | - [v.4(2022.04.08)](/newfeature/ten/)
5 | - [v.3(2022.03.11)](/newfeature/nine/)
6 | - [v.2(2022.01.20)](/newfeature/seven/)
7 | - [v.1(2021.12.15)](/newfeature/six/)
8 | - [v.0(2021.11.30)](/newfeature/five/)
9 |
--------------------------------------------------------------------------------
/docs/newfeature/config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | "linkConst": "/newfeature/",
3 | "nav": {
4 | "text": "新特性",
5 | "link": "/newfeature/"
6 | },
7 | "sidebar": {
8 | "/newfeature/": [
9 | {
10 | "title": "QQ开放平台更新介绍",
11 | "children": [
12 | [
13 | "/newfeature/eleven/",
14 | "v.5(2023.11.08)"
15 | ] ,
16 | [
17 | "/newfeature/ten/",
18 | "v.4(2022.04.08)"
19 | ],
20 | [
21 | "/newfeature/nine/",
22 | "v.3(2022.03.11)",
23 | ],
24 | [
25 | "/newfeature/seven/",
26 | "v.2(2022.01.20)",
27 | ],
28 | [
29 | "/newfeature/six/",
30 | "v.1(2021.12.15)",
31 | ],
32 | [
33 | "/newfeature/five/",
34 | "v.0(2021.11.30)",
35 | ],
36 | ]
37 | }
38 | ],
39 | }
40 | }
--------------------------------------------------------------------------------
/docs/newfeature/eleven/README.md:
--------------------------------------------------------------------------------
1 | # v.5(2023.11.08)
2 |
3 | ## 一、全域融合
4 |
5 | ![全域融合1]()
6 |
7 | ![全域融合2]()
8 |
9 | ## 二、开发者入驻全流程管理
10 |
11 | ![入驻全流程管理]()
12 |
13 | ### 1.机器人创建 – 支持多场景选择
14 |
15 | ![多场景选择]()
16 |
17 | ### 2.机器人开发 – 效果预览
18 |
19 | ![效果预览]()
20 |
21 | ### 3.机器人发布 – 自定义发布范围
22 |
23 | ![自定义发布范围]()
24 |
25 |
--------------------------------------------------------------------------------
/patches/@vuepress+plugin-pwa+1.9.5.patch:
--------------------------------------------------------------------------------
1 | diff --git a/node_modules/@vuepress/plugin-pwa/lib/SWUpdatePopup.vue b/node_modules/@vuepress/plugin-pwa/lib/SWUpdatePopup.vue
2 | index 1cced58..4daba59 100644
3 | --- a/node_modules/@vuepress/plugin-pwa/lib/SWUpdatePopup.vue
4 | +++ b/node_modules/@vuepress/plugin-pwa/lib/SWUpdatePopup.vue
5 | @@ -7,7 +7,7 @@
6 | :buttonText="buttonText"
7 | >
8 |