跳转到正文

上传宿主头像 ​

上传一张图片作为当前宿主用户的头像。

POST /app/auth/avatar

调用方: 随附宿主应用 · 认证: PHPSID 宿主会话

浏览器发送 PHPSID Cookie;原生端也可发送同名请求头。先通过宿主账号登录。

上传方式:multipart/form-data。使用 curl 的 -F 时会自动设置包含 boundary 的 Content-Type,无需手写此请求头。

请求参数 ​

Form 文件 ​

参数类型必填说明
filefile是要上传的本地文件。

请求示例 ​

bash
curl 'https://example.com/app/auth/avatar' \
  -H "PHPSID: $POPOIM_SESSION" \
  -F 'file=@/path/to/sunset.jpg'

使用说明 ​

  • 只提交 file 文件,不提交普通文本字段。服务器会检查图片实际内容并生成头像。
  • 界面使用返回的 user.avatar,不自行拼接上传路径。

返回参数 ​

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

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

data 字段 ​

字段类型说明
changedboolean本次操作是否实际改变了服务器数据;设置值原本相同时为 false。
userHostUser更新头像后的用户资料。

返回示例 ​

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

json
{
  "code": 0,
  "msg": "ok",
  "data": {
    "changed": true,
    "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
    }
  }
}

返回对象字段 ​

数组中的每个对象使用同一套字段。点击名称跳到说明:

宿主用户资料

宿主用户资料(HostUser) ​

字段类型说明
idstringIM 内部用户 ID,以十进制字符串返回。调用用户相关接口时使用下面的 user_id。
user_idstring宿主系统提供的用户 ID,例如 chenyue;用于识别同一个人。
usernamestring | null可用于精确搜索的账号;没有设置时为 null。
nicknamestring显示昵称。
avatarstring头像地址。
signaturestring个性签名;未设置时为空字符串。
profile_updated_atinteger公开资料最后更新时间,Unix 毫秒时间戳。
ip_regionstring | nullIP 属地展示文字;没有信息时为 null。

错误处理 ​

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

返回随附宿主账号接口列表 · HTTP 请求约定