外观
读取宿主当前用户
根据 PHPSID 读取当前登录用户和应用名称,可用于恢复宿主登录状态。
GET /app/auth/me
调用方: 随附宿主应用 · 认证: PHPSID 宿主会话
浏览器发送 PHPSID Cookie;原生端也可发送同名请求头。先通过宿主账号登录。
请求参数
无业务参数。
请求示例
bash
curl 'https://example.com/app/auth/me' \
-H "PHPSID: $POPOIM_SESSION"使用说明
- 宿主会话与 IM Token 分开管理。浏览器保留 PHPSID Cookie;原生端可保存响应头 PHPSID,并在后续请求中使用同名请求头发送。
- 登录或换票后若响应给出新的 PHPSID,后续请求使用新值。
返回参数
成功响应的最外层字段如下。下面所有业务字段都位于 data 中。
| 字段 | 类型 | 说明 |
|---|---|---|
code | integer | 0 表示成功;非 0 时查看 msg,不把 data 当成功结果使用。 |
msg | string | 成功通常为 ok,失败时为错误说明。 |
data | object | 本次请求的业务结果,字段见下表。 |
data 字段
| 字段 | 类型 | 说明 |
|---|---|---|
user | HostUser | 当前登录用户资料。 |
app_name | string | 后台配置的应用名称。 |
返回示例
示例展示字段结构;ID、时间和资料仅作说明,请使用实际回包。
json
{
"code": 0,
"msg": "ok",
"data": {
"user": {
"id": "1024",
"user_id": "chenyue",
"username": "chenyue",
"nickname": "陈悦",
"avatar": "https://example.com/uploads/avatars/chenyue.jpg",
"signature": "一起发现沿途的风景",
"profile_updated_at": 1792301400000,
"ip_region": null
},
"app_name": "PopoIM"
}
}返回对象字段
数组中的每个对象使用同一套字段。点击名称跳到说明:
宿主用户资料(HostUser)
| 字段 | 类型 | 说明 |
|---|---|---|
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 毫秒时间戳。 |
ip_region | string | null | IP 属地展示文字;没有信息时为 null。 |
错误处理
没有有效登录会话时为 HTTP 401、code=3002。
先检查 HTTP 状态,再检查 code。业务失败可能仍为 HTTP 200;非 0 的 code 都不能当成功。完整错误码见请求约定。
