沟通频道相关接口

列出我加入的频道 #

列出项目中我加入的频道。

请求 #

url: /project/{projectId}/channel/my?accessToken={accessToken}

参数:

参数名 说明
projectId 项目ID
accessToken 访问令牌

响应 #

成功返回200,失败返回500。

响应为ChannelInfo[]数组。

列出我未加入的频道 #

列出项目中我未加入的频道。

提示

需要管理员权限

请求 #

url: /project/{projectId}/channel/notJoin?accessToken={accessToken}

参数:

参数名 说明
projectId 项目ID
accessToken 访问令牌

响应 #

成功返回200,失败返回500。

响应为ChannelInfo[]数组。

列出孤儿频道 #

列出项目中的孤儿频道。

提示

需要管理员权限

请求 #

url: /project/{projectId}/channel/orphan?accessToken={accessToken}

参数:

参数名 说明
projectId 项目ID
accessToken 访问令牌

响应 #

成功返回200,失败返回500。

响应为ChannelInfo[]数组。

列出聊天内容 #

获取频道中聊天内容(从后往前)。

请求 #

url: /project/{projectId}/channel/msg/{channelId}?accessToken={accessToken}&refMsgId={refMsgId}&limit={limit}

参数:

参数名 说明
projectId 项目ID
channelId 频道ID
accessToken 访问令牌
refMsgId 相关内容ID(为空表示频道最后一条聊天内容)
limit 获取记录数量

响应 #

成功返回200,失败返回500。

响应为消息列表

消息结构: #

属性 类型 说明
msgId string 消息ID
channelId string 频道ID
content string 消息内容
senderUserId string 发送用户ID
senderDisplayName string 发送者名称
senderType string 发送者类型(member:项目成员,robot:机器人)
sendTime long 发送时间
hasUpdateTime bool 是否有修改
updateTime long 修改时间

通用结构 #

频道信息(ChannelInfo) #

属性 类型 说明
channelId string 频道ID
name string 频道名称
pubChannel bool 是否是公开频道
systemChannel bool 是否是系统频道
readonly bool 是否是只读状态
closed bool 是否是关闭状态
ownerUserId bool 创建者ID
createTime long 创建时间
updateTime long 更新时间