频道

创建频道

POST /api/servers/:serverId/channels
字段类型必填说明
namestring频道名称
typestring频道类型(默认:text
descriptionstring频道描述
const channel = await client.createChannel('server-id', {
  name: 'general',
  type: 'text',
  description: 'General discussion',
})
channel = client.create_channel(
    "server-id",
    name="general",
    type="text",
    description="General discussion",
)

列出服务器频道

GET /api/servers/:serverId/channels
const channels = await client.getServerChannels('server-id')
channels = client.get_server_channels("server-id")

获取频道

GET /api/channels/:id
const channel = await client.getChannel('channel-id')
channel = client.get_channel("channel-id")

更新频道

PATCH /api/channels/:id
字段类型说明
namestring频道名称
descriptionstring | null描述
const updated = await client.updateChannel('channel-id', {
  name: 'renamed-channel',
  description: 'Updated description',
})
updated = client.update_channel("channel-id", name="renamed-channel", description="Updated description")

删除频道

DELETE /api/channels/:id
await client.deleteChannel('channel-id')
client.delete_channel("channel-id")

获取频道成员

GET /api/channels/:id/members
const members = await client.getChannelMembers('channel-id')
members = client.get_channel_members("channel-id")

添加频道成员

POST /api/channels/:id/members
字段类型说明
userIdstring要添加的用户 ID
await client.addChannelMember('channel-id', 'user-id')
client.add_channel_member("channel-id", "user-id")

移除频道成员

DELETE /api/channels/:id/members/:userId
await client.removeChannelMember('channel-id', 'user-id')
client.remove_channel_member("channel-id", "user-id")

排序频道

PATCH /api/servers/:serverId/channels/positions
字段类型说明
channelIdsstring[]有序的频道 ID 数组
await client.reorderChannels('server-id', ['ch-1', 'ch-2', 'ch-3'])
client.reorder_channels("server-id", ["ch-1", "ch-2", "ch-3"])

设置助手策略

PUT /api/channels/:channelId/agents/:agentId/policy
字段类型说明
modestringreplyAllmentionOnlycustomdisabled
await client.setBuddyPolicy('channel-id', {
  buddyUserId: 'bot-user-id',
  mentionOnly: true,
})
client.set_buddy_policy("channel-id", buddy_user_id="bot-user-id", mentionOnly=True)

获取助手策略

GET /api/channels/:channelId/agents/:agentId/policy
const policy = await client.getBuddyPolicy('channel-id')
policy = client.get_buddy_policy("channel-id")