外观
读取申请列表
分页读取好友申请、入群申请和群邀请。
GET /app/sdk/notices
调用方: SDK 客户端 · 认证: IM Token
请求头:Authorization: Bearer <IM Token>。先通过宿主后端获取 Token,再交给 SDK 使用。
请求参数
Query
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
cursor | string | 否 | 上一次返回的 next_cursor,1–2048 字符;首次读取时不传。游标已包含原筛选条件,不能自行修改或跨账号使用。 |
请求示例
bash
curl 'https://example.com/app/sdk/notices' \
-H "Authorization: Bearer $POPOIM_TOKEN"返回参数
成功响应的最外层字段如下。下面所有业务字段都位于 data 中。
| 字段 | 类型 | 说明 |
|---|---|---|
code | integer | 0 表示成功;非 0 时查看 msg,不把 data 当成功结果使用。 |
msg | string | 成功通常为 ok,失败时为错误说明。 |
data | object | 本次请求的业务结果,字段见下表。 |
data 字段
| 字段 | 类型 | 说明 |
|---|---|---|
items | Notice[] | 本页申请,最多 30 项。 |
unread_notice_count | integer | 当前账号未读申请数,0–100。 |
next_cursor | string | null | 下一页游标;没有下一页时为 null。 |
has_more | boolean | 是否还有下一页。 |
返回示例
示例展示字段结构;ID、时间和资料仅作说明,请使用实际回包。
展开完整返回示例
json
{
"code": 0,
"msg": "ok",
"data": {
"items": [
{
"notice_id": "3101",
"type": "friend_request",
"direction": "received",
"status": "pending",
"message": "我是行政部陈悦,一起确认秋日海岸出游安排吧。",
"source": "search",
"created_at": 1792301400000,
"updated_at": 1792301400000,
"handled_at": null,
"actor": {
"id": "1024",
"user_id": "chenyue",
"username": "chenyue",
"nickname": "陈悦",
"avatar": "https://example.com/uploads/avatars/chenyue.jpg",
"signature": "一起发现沿途的风景",
"profile_updated_at": 1792301400000
},
"recipient": {
"id": "1025",
"user_id": "linzhou",
"username": "linzhou",
"nickname": "林舟",
"avatar": "https://example.com/uploads/avatars/linzhou.jpg",
"signature": "把每一次出发安排妥当",
"profile_updated_at": 1792301400000
},
"subject": null,
"group": null,
"permissions": {
"accept": true,
"reject": true
}
}
],
"unread_notice_count": 1,
"next_cursor": null,
"has_more": false
}
}返回对象字段
数组中的每个对象使用同一套字段。点击名称跳到说明:
申请或邀请(Notice)
| 字段 | 类型 | 说明 |
|---|---|---|
notice_id | string | 申请 ID;读取时为十进制字符串,提交处理请求时使用正整数。 |
type | string | friend_request 好友申请、group_join_request 入群申请、group_invitation 群邀请。 |
direction | string | received 表示收到的申请,sent 表示本人发出的申请。 |
status | string | pending 待处理、accepted 已同意、rejected 已拒绝、expired 已过期、revoked 已撤销。 |
message | string | 申请说明;可能为空字符串。 |
source | string | 申请来源,例如 search、profile、qr;由具体业务产生。 |
created_at | integer | 申请创建时间,Unix 毫秒时间戳。 |
updated_at | integer | 申请最后更新时间,Unix 毫秒时间戳。 |
handled_at | integer | null | 申请处理时间,Unix 毫秒时间戳;尚未发生或不适用时为 null。 |
actor | User | 发起人资料。 |
recipient | User | 接收人资料。 |
subject | User | null | 群邀请中被邀请人的资料;其他申请通常为 null。 |
group | Group | null | 关联群资料;好友申请为 null。 |
permissions | NoticePermissions | 当前账号能否同意或拒绝。 |
用户资料(User)
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | IM 内部用户 ID,以十进制字符串返回。调用用户相关接口时使用下面的 user_id。 |
user_id | string | 宿主系统提供的用户 ID,例如 chenyue;用于识别同一个人。 |
username | string | null | 可用于精确搜索的账号;没有设置时为 null。 |
nickname | string | 显示昵称。 |
avatar | string | 头像地址。 |
signature | string | 个性签名;未设置时为空字符串。 |
profile_updated_at | integer | 公开资料最后更新时间,Unix 毫秒时间戳。 |
群资料(Group)
| 字段 | 类型 | 说明 |
|---|---|---|
group_id | string | 公开群 ID,群相关请求使用这个值。 |
owner_id | string | 群主的外部 user_id。 |
name | string | 群名称。 |
avatar | string | 群头像地址。 |
avatar_custom | boolean | 是否由用户上传头像;false 表示服务器生成的组合头像。 |
announcement | string | null | 群公告正文;没有公告时为 null。 |
announcement_author_id | string | null | 最近一次公告发布者的外部 user_id;没有公告时可为 null。 |
announcement_author_name | string | null | 公告发布者的显示名;没有公告时可为 null。 |
announcement_updated_at | integer | 公告更新时间;尚未设置时为 0,Unix 毫秒时间戳。 |
status | string | 群状态:active 正常、disabled 停用、dissolved 已解散。 |
all_muted | boolean | 是否开启全员禁言。 |
join_approval_required | boolean | 扫码加入是否需要群主或管理员审批。 |
member_count | integer | 当前成员人数。 |
unread_mode | string | 未读计算方式:fanout 按成员累计;sequence 按消息序号计算。客户端使用返回的未读数即可。 |
last_mid | string | 最新消息 ID;还没有消息时为 "0"。 |
last_seq | string | 最新消息在群内的序号;没有消息时为 "0"。 |
last_message_at | integer | 最近一条消息的发送时间;没有消息时为 0,Unix 毫秒时间戳。 |
conversation_updated_at | integer | 群会话内容最后更新时间,Unix 毫秒时间戳。 |
created_at | integer | 建群时间,Unix 毫秒时间戳。 |
updated_at | integer | 群资料最后更新时间,Unix 毫秒时间戳。 |
申请处理权限(NoticePermissions)
| 字段 | 类型 | 说明 |
|---|---|---|
accept | boolean | 当前账号是否可以同意此申请。 |
reject | boolean | 当前账号是否可以拒绝此申请。 |
错误处理
先检查 HTTP 状态,再检查 code。业务失败可能仍为 HTTP 200;非 0 的 code 都不能当成功。完整错误码见请求约定。
