Class ChatThread

constructor

• new ChatThread(chatThreadId: string, manager: ChatThreadManager): ChatThread

  Parameters

  • chatThreadId: string
  • manager: ChatThreadManager

  Returns ChatThread

ReadonlychatThreadId

getInfo

• getInfo(): Promise<ChatThreadSummary>

  获取当前子区详情。

  Returns Promise<ChatThreadSummary>

  返回子区详情。

  Example: 调用示例（获取详情）

  const thread = client.chatThreadManager.getChatThread('thread-1');
  const detail = await thread.getInfo();
  Copy

  可能出现的错误码

  Code	含义	HTTP	处理建议	可重试
  110	参数无效	-	通过有效的 chatThreadId 创建 ChatThread 实体	否
  201	用户未登录	401	重新登录后再查询子区详情	否
  210	无权限查询子区详情	403	确认当前用户已加入父群组或目标子区	否
  606	子区不存在	404	确认子区 ID 正确且子区仍存在	否
  301	请求服务超时	504	稍后重试	是
  303	服务请求通用错误	500	稍后重试或联系服务端排查	是

refresh

• refresh(): Promise<ChatThreadSummary>

  刷新并返回当前子区详情，等价于 getInfo()。

  Returns Promise<ChatThreadSummary>

  返回最新子区详情。

  Example: 调用示例（刷新详情）

  const detail = await thread.refresh();
  Copy

  可能出现的错误码

  Code	含义	HTTP	处理建议	可重试
  110	参数无效	-	通过有效的 chatThreadId 创建 ChatThread 实体	否
  201	用户未登录	401	重新登录后再查询子区详情	否
  210	无权限查询子区详情	403	确认当前用户已加入父群组或目标子区	否
  606	子区不存在	404	确认子区 ID 正确且子区仍存在	否
  301	请求服务超时	504	稍后重试	是
  303	服务请求通用错误	500	稍后重试或联系服务端排查	是

join

• join(): Promise<void>

  加入当前子区。

  Returns Promise<void>

  成功时无返回业务数据。

  Example: 调用示例（加入子区）

  await thread.join();
  Copy

  可能出现的错误码

  Code	含义	HTTP	处理建议	可重试
  110	参数无效	-	通过有效的 chatThreadId 创建 ChatThread 实体	否
  201	用户未登录	401	重新登录后再加入子区	否
  210	无权限加入子区	403	确认当前用户已加入父群组且目标子区可加入	否
  606	子区不存在	404	确认子区 ID 正确且子区仍存在	否
  4	超过服务限制	400	减少操作频率或联系服务端提升配额	否
  301	请求服务超时	504	稍后重试	是
  303	服务请求通用错误	500	稍后重试或联系服务端排查	是

leave

• leave(): Promise<void>

  退出当前子区。

  Returns Promise<void>

  成功时无返回业务数据。

  Example: 调用示例（退出子区）

  await thread.leave();
  Copy

  可能出现的错误码

  Code	含义	HTTP	处理建议	可重试
  110	参数无效	-	通过有效的 chatThreadId 创建 ChatThread 实体	否
  201	用户未登录	401	重新登录后再退出子区	否
  210	无权限退出子区	403	确认当前用户已加入目标子区且允许退出	否
  606	子区不存在	404	确认子区 ID 正确且子区仍存在	否
  301	请求服务超时	504	稍后重试	是
  303	服务请求通用错误	500	稍后重试或联系服务端排查	是

destroy

• destroy(): Promise<void>

  解散当前子区。

  Returns Promise<void>

  成功时无返回业务数据。

  Example: 调用示例（解散子区）

  await thread.destroy();
  Copy

  可能出现的错误码

  Code	含义	HTTP	处理建议	可重试
  110	参数无效	-	通过有效的 chatThreadId 创建 ChatThread 实体	否
  201	用户未登录	401	重新登录后再解散子区	否
  210	无权限解散子区	403	使用有管理权限的账号重试	否
  606	子区不存在	404	确认子区 ID 正确且子区仍存在	否
  301	请求服务超时	504	稍后重试	是
  303	服务请求通用错误	500	稍后重试或联系服务端排查	是

updateName

• updateName(input: { name: string }): Promise<void>

  更新当前子区名称。

  Parameters

  • input: { name: string }

    更新输入，name 为新子区名称。

  Returns Promise<void>

  成功时无返回业务数据。

  Example: 调用示例（更新名称）

  await thread.updateName({ name: 'New topic' });
  Copy

  可能出现的错误码

  Code	含义	HTTP	处理建议	可重试
  110	参数无效	-	通过有效的 chatThreadId 创建实体，并传入有效的新名称	否
  201	用户未登录	401	重新登录后再更新子区名称	否
  210	无权限更新子区名称	403	使用群主、管理员或有权限的账号重试	否
  606	子区不存在	404	确认子区 ID 正确且子区仍存在	否
  301	请求服务超时	504	稍后重试	是
  303	服务请求通用错误	500	稍后重试或联系服务端排查	是

getMemberList

• getMemberList(
      query?: ChatThreadMemberListQuery,
  ): Promise<ChatThreadMemberListResult>

  获取当前子区成员列表。

  Parameters

  • query: ChatThreadMemberListQuery = {}

    游标分页参数：pageSize 可选，默认 20、范围 1-50；cursor 首次调用时不传或传空字符串，后续传入上一次返回的游标。

  Returns Promise<ChatThreadMemberListResult>

  返回成员列表和下一页游标。

  Example: 调用示例（查询成员）

  const page = await thread.getMemberList({ pageSize: 20 });
  Copy

  可能出现的错误码

  Code	含义	HTTP	处理建议	可重试
  110	参数无效	-	通过有效的 chatThreadId 创建实体，并传入有效分页参数	否
  201	用户未登录	401	重新登录后再查询子区成员	否
  210	无权限查询子区成员	403	确认当前用户已加入父群组或目标子区	否
  606	子区不存在	404	确认子区 ID 正确且子区仍存在	否
  301	请求服务超时	504	稍后重试	是
  303	服务请求通用错误	500	稍后重试或联系服务端排查	是

removeMember

• removeMember(
      input: Omit<RemoveChatThreadMemberParams, "chatThreadId">,
  ): Promise<void>

  从当前子区移除成员。

  Parameters

  • input: Omit<RemoveChatThreadMemberParams, "chatThreadId">

    移除输入，包含成员 ID。

  Returns Promise<void>

  成功时无返回业务数据。

  Example: 调用示例（移除成员）

  await thread.removeMember({ memberId: 'user-1' });
  Copy

  可能出现的错误码

  Code	含义	HTTP	处理建议	可重试
  110	参数无效	-	通过有效的 chatThreadId 创建实体，并传入有效成员 ID	否
  201	用户未登录	401	重新登录后再移除子区成员	否
  210	无权限移除子区成员	403	使用群主、管理员或有权限的账号重试	否
  606	子区或成员不存在	404	确认子区和目标成员关系仍存在	否
  301	请求服务超时	504	稍后重试	是
  303	服务请求通用错误	500	稍后重试或联系服务端排查	是