群组
获取群详情
实时返回单个群的详情。group_id 通过 query 参数传入(可能含 @ / : 等字符,故不放在 path)。找不到群时返回 404。
https://api.unifyport.ai/v1/accounts/{account_id}/groups/info调用前准备
在服务端使用资源所属工作区的 X-Api-Key。运行示例前替换所有占位符。
参数从哪里取得
- account_id
- 从创建或查询账号的响应取得 data.id。账号标识属于 X-Api-Key 对应的工作区。 获取账号
- group_id
- 要操作的群——即 List groups 返回的 id。因渠道侧 id 可能含 @ 或 : 等字符,故保留在 query 字符串中。
请求参数
请求头
X-Api-Key工作区 API Key,工作区由该请求头解析得到。
路径参数
account_id用于该 groups 路由的标识符。
查询参数
group_id要操作的群——即 List groups 返回的 id。因渠道侧 id 可能含 @ 或 : 等字符,故保留在 query 字符串中。
请求体
该接口无需 JSON 请求体。
如何理解结果
按文档解释响应字段和 HTTP 状态。204 成功响应没有响应体,排查时使用 X-Request-Id。下一步操作见相关链接。
响应 200 OK
{
"request_id": "<REQUEST_ID>",
"data": {
"id": "group_example",
"conversation_id": "group_example",
"name": "Project team",
"avatar_url": "",
"member_count": 5,
"description": "..."
}
}
响应体
id群组标识。对于群组,conversation_id 等于该 id。
conversation_id群组的会话标识;等于 id。
name群组名称。
avatar_url群组头像 URL,未设置时为空字符串。
member_count群组成员数量。
format: int64
joined_at渠道提供时返回的当前账号入群时间。
format: date-time
created_at渠道提供时返回的群组创建时间。
format: date-time
description群组描述,存在时返回。
permissionsobjectGroup-wide speaking permissions, returned only when explicitly supplied by the source. Missing means unknown; admins_only=false permits ordinary members to speak, but does not guarantee this account can send.
permissionsGroup-wide speaking permissions, returned only when explicitly supplied by the source. Missing means unknown; admins_only=false permits ordinary members to speak, but does not guarantee this account can send.
admins_onlytrue means only administrators may speak; false is an explicit state, not an omitted or default value.
extraobject渠道扩展的群字段;WhatsApp 群资料可包含公告群分类,是否返回取决于本次查询可用资料。
extra渠道扩展的群字段;WhatsApp 群资料可包含公告群分类,是否返回取决于本次查询可用资料。
is_announcement_group仅 WhatsApp 群提供。true 表示已确认是社群公告群,false 表示本次资料已确认不符合公告群条件;缺失表示未知,不返回 null。此分类不表示当前账号具备发送消息的权限。 独立于 permissions.admins_only。
响应
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 是否正确、工作区是否有效。