跳转到正文

读取未读数 ​

只获取当前账号的消息和申请未读数,不需要加载整个首页。

GET /app/sdk/unread

调用方: SDK 客户端 · 认证: IM Token

请求头:Authorization: Bearer <IM Token>。先通过宿主后端获取 Token,再交给 SDK 使用。

请求参数 ​

无业务参数。

请求示例 ​

bash
curl 'https://example.com/app/sdk/unread' \
  -H "Authorization: Bearer $POPOIM_TOKEN"

返回参数 ​

成功响应的最外层字段如下。下面所有业务字段都位于 data 中。

字段类型说明
codeinteger0 表示成功;非 0 时查看 msg,不把 data 当成功结果使用。
msgstring成功通常为 ok,失败时为错误说明。
dataobject本次请求的业务结果,字段见下表。

data 字段 ​

字段类型说明
messageinteger未读消息数,0–100;100 表示至少 100 条。
noticeinteger未读申请数,0–100;100 表示至少 100 条。

返回示例 ​

示例展示字段结构;ID、时间和资料仅作说明,请使用实际回包。

json
{
  "code": 0,
  "msg": "ok",
  "data": {
    "message": 3,
    "notice": 1
  }
}

错误处理 ​

先检查 HTTP 状态,再检查 code。业务失败可能仍为 HTTP 200;非 0 的 code 都不能当成功。完整错误码见请求约定。

返回首页与会话接口列表 · HTTP 请求约定