频道API

获取频道系统内BOT的资料

终结点: /get_guild_service_profile

响应数据

字段类型说明
nicknamestring昵称
tiny_idstring自身的ID
avatar_urlstring头像链接

获取频道列表

终结点: /get_guild_list

响应数据

正常情况下响应 GuildInfo 数组, 未加入任何频道响应 null

GuildInfo:

字段类型说明
guild_idstring频道ID
guild_namestring频道名称
guild_display_idint64频道显示ID, 公测后可能作为搜索ID使用

通过访客获取频道元数据

终结点: /get_guild_meta_by_guest

参数

字段类型说明
guild_idstring频道ID

响应数据

字段类型说明
guild_idstring频道ID
guild_namestring频道名称
guild_profilestring频道简介
create_timeint64创建时间
max_member_countint64频道人数上限
max_robot_countint64频道BOT数上限
max_admin_countint64频道管理员人数上限
member_countint64已加入人数
owner_idstring创建者ID

获取子频道列表

终结点: /get_guild_channel_list

参数

字段类型说明
guild_idstring频道ID
no_cachebool是否无视缓存

响应数据

正常情况下响应 ChannelInfo 数组, 未找到任何子频道响应 null

ChannelInfo:

字段类型说明
owner_guild_idstring所属频道ID
channel_idstring子频道ID
channel_typeint32子频道类型
channel_namestring子频道名称
create_timeint64创建时间
creator_tiny_idstring创建者ID
talk_permissionint32发言权限类型
visible_typeint32可视性类型
current_slow_modeint32当前启用的慢速模式Key
slow_modes[]SlowModeInfo频道内可用慢速模式类型列表

SlowModeInfo:

字段类型说明
slow_mode_keyint32慢速模式Key
slow_mode_textstring慢速模式说明
speak_frequencyint32周期内发言频率限制
slow_mode_circleint32单位周期时间, 单位秒

已知子频道类型列表

类型说明
1文字频道
2语音频道
5直播频道
7主题频道

获取频道成员列表

终结点: /get_guild_member_list

由于频道人数较多(数万), 请尽量不要全量拉取成员列表, 这将会导致严重的性能问题

尽量使用 get_guild_member_profile 接口代替全量拉取

参数

字段类型说明
guild_idstring频道ID
next_tokenstring翻页Token

next_token 为空的情况下, 将返回第一页的数据, 并在返回值附带下一页的 token

响应数据

字段类型说明
members[]GuildMemberInfo成员列表
finishedbool是否最终页
next_tokenstring翻页Token

GuildMemberInfo:

字段类型说明
tiny_idstring成员ID
titlestring成员头衔
nicknamestring成员昵称
role_idstring所在权限组ID
role_namestring所在权限组名称

默认情况下频道管理员的权限组ID为 2, 部分频道可能会另行创建, 需手动判断

此接口仅展现最新的权限组, 获取用户加入的所有权限组请使用 get_guild_member_profile 接口

单独获取频道成员信息

终结点: /get_guild_member_profile

参数

字段类型说明
guild_idstring频道ID
user_idstring用户ID

响应数据

字段类型说明
tiny_idstring用户ID
nicknamestring用户昵称
avatar_urlstring头像地址
join_timeint64加入时间
roles[]RoleInfo加入的所有权限组

RoleInfo:

字段类型说明
role_idstring权限组ID
role_namestring权限组名称

发送信息到子频道

终结点: /send_guild_channel_msg

参数

字段类型说明
guild_idstring频道ID
channel_idstring子频道ID
messageMessage消息, 与原有消息类型相同

响应数据

字段类型说明
message_idstring消息ID

获取话题频道帖子

终结点: /get_topic_channel_feeds

参数

字段类型说明
guild_idstring频道ID
channel_idstring子频道ID

响应数据

返回 FeedInfo 数组

FeedInfo:

字段类型说明
idstring帖子ID
channel_idstring子频道ID
guild_idstring频道ID
create_timeint64发帖时间
titlestring帖子标题
sub_titlestring帖子副标题
poster_infoPosterInfo发帖人信息
resourceResourceInfo媒体资源信息
resource.images[]FeedMedia帖子附带的图片列表
resource.videos[]FeedMedia帖子附带的视频列表
contents[]FeedContent帖子内容

PosterInfo:

字段类型说明
tiny_idstring发帖人ID
nicknamestring发帖人昵称
icon_urlstring发帖人头像链接

FeedMedia:

字段类型说明
file_idstring媒体ID
pattern_idstring控件ID?(不确定)
urlstring媒体链接
heightint32媒体高度
widthint32媒体宽度

FeedContent:

字段类型说明
typestring内容类型
dataData内容数据

内容类型列表:

类型说明
text文本
face表情
atAt
url_quote链接引用
channel_quote子频道引用

内容类型对应数据列表:

  • text
字段类型说明
textstring文本内容
  • face
字段类型说明
idstring表情ID
  • at
字段类型说明
idstring目标ID
qqstring目标ID, 为确保和 array message 的一致性保留
  • url_quote
字段类型说明
display_textstring显示文本
urlstring链接
  • channel_quote
字段类型说明
display_textstring显示文本
guild_idstring频道ID
channel_idstring子频道ID

删除频道角色

终结点: /delete_guild_role

参数

字段类型说明
guild_idstring频道ID
role_idstring角色ID

提示

该 API 无响应数据

获取频道消息

终结点: /get_guild_msg

参数

字段类型默认值说明
message_idstring-频道消息ID
no_cacheboolfalse是否不使用缓存(使用缓存可能更新不及时, 但响应更快)

响应数据

字段名数据类型说明
channel_idstring子频道ID
guild_idstring频道ID
messagestring消息内容
message_idstring消息ID
message_seqint64消息序号(你可以理解为第几条消息,历史)
message_sourcestring消息来源(channel,direct)
senderobject发送人信息
reactionsarray未知,目前恒定为空
timeint64发送消息时时间戳(10位)
  • sender
字段类型说明
nicknamestring发送人昵称
tiny_idstring发送人ID
user_idint64发送人ID

获取频道角色列表

终结点: /get_guild_roles

参数

字段类型默认值说明
guild_idstring-频道ID

响应数据(数组)

字段名数据类型说明
argb_colorint64颜色值(示例:4294927682)
disabledbool是否启用
independentbool未知
max_countint32最大多少人拥有此角色
member_countint32多少人拥有此角色
ownedbool未知
role_idstring角色id
role_namestring角色名

设置用户在频道中的角色

终结点: /set_guild_member_role

参数

字段类型默认值说明
guild_idstring-频道ID
setboolfalse是否设置(默认假,取消)
role_idstring-频道ID
usersstringarray-

提示

该 API 无响应数据

修改频道角色

终结点: /update_guild_role

参数

字段类型默认值说明
guild_idstring-频道ID
role_idstring-角色ID
namestring-角色名
colorstring-颜色(示例:4294927682)
independentboolfalse未知

提示

该 API 无响应数据

创建频道角色

终结点: /create_guild_role

参数

字段类型默认值说明
guild_idstring-频道ID
colorstring-颜色
namestring-角色名
independentboolfalse未知
initial_usersarraystring-

响应数据(数组)

字段名数据类型说明
role_idint64角色id