会话
列出会话成员
列出 group 类型会话的成员。conversation_id 通过 query 参数传入,并以 cursor / limit 分页。每项返回 peer_id / display_name / avatar_url;role 仅为 member、admin 或 superadmin,其中 superadmin 表示群主或创建者。会话类型不支持成员查询(例如一对一会话)时返回 400。
https://api.unifyport.ai/v1/accounts/{account_id}/conversations/members调用前准备
在服务端使用资源所属工作区的 X-Api-Key。运行示例前替换所有占位符。
参数从哪里取得
- account_id
- 从创建或查询账号的响应取得 data.id。账号标识属于 X-Api-Key 对应的工作区。 获取账号
- conversation_id
- 要查询的会话——即 List conversations 返回的 conversation_id 值。
请求参数
请求头
X-Api-Key工作区 API Key,工作区由该请求头解析得到。
路径参数
account_id用于该 conversations 路由的标识符。
查询参数
conversation_id要查询的会话——即 List conversations 返回的 conversation_id 值。
type用于消歧查询的会话类型(user、group 或 channel)。
enum: user, group, channel
cursor上一响应的 next_cursor。省略或留空从第一页开始;失效或伪造游标在不同渠道上的处理不统一。
limit单页数量范围 1..100;各列表接口的默认值见对应页面说明。
minimum: 1 · maximum: 100
请求体
该接口无需 JSON 请求体。
如何理解结果
按文档解释响应字段和 HTTP 状态。204 成功响应没有响应体,排查时使用 X-Request-Id。下一步操作见相关链接。
响应 200 OK
{
"request_id": "<REQUEST_ID>",
"data": {
"items": [
{
"peer_id": "user_example",
"display_name": "",
"avatar_url": "",
"role": "superadmin"
}
],
"next_cursor": "",
"has_more": false
}
}
响应体
peer_id成员的渠道侧稳定标识,请按不透明字符串保存和使用。
username渠道提供时返回的成员用户名。
display_name成员显示名,缺失时为空字符串。
avatar_url成员头像 URL,缺失时为空字符串。
role归一化群角色:群主或创建者为 superadmin,管理员为 admin,普通或未知角色为 member。
enum: member, admin, superadmin
joined_at渠道提供时返回的成员加入时间。
format: date-time
extra成员的渠道专属字段,例如手机号。
next_cursor指向下一页的不透明游标,回传作为 cursor 使用;空字符串表示没有更多页。
has_more当本页之外还有更多结果时为 true。
响应
200200 OK
请求成功,响应体示例如上。
400请求错误
请求体、路径或参数不合法。
401未授权
X-Api-Key 请求头缺失或无效。
404未找到
未找到请求的渠道资源。
409冲突
当前操作与已有的渠道账号或资源冲突。
500服务端错误
服务端遇到了未预期的错误。
501渠道未实现
所选渠道尚未实现该操作。
502上游网关错误
渠道适配器或上游渠道未能完成该操作。
失败后怎么处理
检查 HTTP 状态和 error.code/numeric_code,保存 request_id 用于排查。按原因修正参数、继续授权或检查运行态。重试发送及其他写操作前先确认上一次结果,避免重复操作。 错误码参考
- invalid_request · 10000 · 400
- 检查必填字段、格式和渠道条件,修正请求后再调用。
- invalid_api_key · 11001 · 401
- 检查 X-Api-Key 是否正确、工作区是否有效。