跳至主要內容

user

yh-third-dev2025/8/3大约 10 分钟

未特别说明情况下请求域名均为 https://chat-go.jwzhd.com
没写请求/响应项目表示不需要相关参数.

获取人机验证图片

POST /v1/user/captcha

响应体:

{
  "code": 1, // 请求状态码，1为正常
  "data": {
    "b64s": "image//png;base64...", // 人机验证图片base64
    "id": "123" // 人机验证ID
  },
  "msg": "success" // 返回消息
}

短信验证码登录

POST /v1/user/verification-login

请求体:

{
  "mobile": "12312312300", // 登录手机号
  "captcha": "123123", // 手机验证码
  "deviceId": "awa", // 登录设备唯一标识符，可自定义
  "platform": "windows" // 登录平台名称,一般为windows,web等可自定义
}

响应体:

{
  "code": 1, // 请求状态码，1为正常
  "data": {
    "token": "f87TJHF9-****-****-************" // 账户登录token
  },
  "msg": "success" // 返回消息
}

获取用户自身信息

GET /v1/user/info

请求头:

名称必须备注
token是无

响应体:

status {
  number: 114514
  code: 1 // 请求状态码，1为正常
  msg: "success" // 返回消息
}
data {
  id: "123" // 用户id
  name: "测试用户" // 用户名
  avatar_url: "https://..." // 头像URL
  avatar_id: 123 //头像ID
  phone: "12312312300" // 手机号
  email: "123@123.com" // 邮箱
  coin: 123 // 金币数
  is_vip: 0 // 是否为VIP
  vip_expired_time: 1231231230 // VIP过期时间
  invitation_code: "123" // 邀请码
}
ProtoBuf数据结构
// 用户自身信息
message info {

    Status status = 1;
    message Data {
        // 11是描述手机号长整数的,懒得解析了
        string id = 1; // 用户id
        string name = 2; // 用户名
        string avatar_url = 4; // 头像URL
        uint64 avatar_id = 5; // 头像ID
        string phone = 6; // 手机号
        string email = 7; // 邮箱
        double coin = 8; // 金币数
        int32 is_vip = 9; // 是否为VIP
        uint64 vip_expired_time = 10; // VIP过期时间
        string invitation_code = 12; // 邀请码
    }
    Data data = 2;
}

获取用户信息

POST /v1/user/get-user

请求头:

名称必须备注
token是可以瞎写一个

请求体:

id: "用户id"
ProtoBuf数据结构
message get_user_send {
    string id = 2;
}

响应体:

status {
  number: 123456
  code: 1 // 请求状态码，1为正常
  msg: "success" // 返回消息
}
data {
  id: "123" // 用户ID
  name: "测试用户" // 用户名
  name_id: 123 // 名称ID
  avatar_url: "https://..." // 头像URL
  avatar_id: 123 // 头像ID
  medal {
    id: 1 // 勋章ID
    name: "测试勋章" // 勋章名称
    sort: 100 // 勋章顺序
  }
  // ...
  register_time: "1234-12-12 12:12:12" // 注册时间(YYYY-MM-DD hh:mm:ss)
  ban_time: 123123123 // 封禁结束时间(时间戳)
  online_day: 123 // 在线时长
  continuous_online_day: 123 // 连续在线时长
  is_vip: 1 // 是否为VIP
  vip_expired_time: 123123123 // VIP过期时间(时间戳)
}
ProtoBuf数据结构
// 勋章信息
message Medal_info {
    uint64 id = 1; // 勋章ID
    string name = 2; // 勋章名称
    uint64 sort = 5;  // 勋章顺序
}

message Remark_info {
    string remark_name = 1; // 备注名
    string phone_number = 2; // 手机号
    string extra_remark = 3; // 其他备注（格式为JSON，示例：'[{"key":"他是","value":"我的朋友"},{"key":"职业","value":"打工人"}]'
}

message Profile_info {
    string last_active_time = 1; // 该用户上次活跃时间
    string introduction = 2; // 简介
    int32 gender = 3; // 性别（1-男，2-女，3-其他）
    uint64 birthday_timestamp = 4; // 生日时间戳
    string city = 5; // 城市
    string district = 6; // 地区
    string address = 7; // 详细地址
}

// 获取用户信息
message get_user {
    Status status = 1; // 状态码
    Data data = 2; //数据
    message Data {
        string id = 1; // 用户id
        string name = 2; // 用户名
        uint64 name_id = 3; // 名称ID
        string avatar_url = 4; //头像URL
        uint64 avatar_id = 5; // 头像ID
        repeated Medal_info medal = 6; // 勋章信息
        string register_time = 7; // 注册时间,格式: YYYY-MM-DD hh:mm:ss
        uint64 ban_time = 10; // 封禁结束时间(时间戳)
        uint64 online_day = 11; // 在线天数
        uint64 continuous_online_day = 12; // 连续在线天数
        int32 is_vip = 13; // 是否为vip
        uint64 vip_expired_time = 14; // VIP过期时间(时间戳)
        Remark_info remark_info = 18; // 备注信息
        Profile_info profile_info = 19; // 用户资料信息
        string ipGeo = 20; // IP归属地（国家）
    }
}

用户勋章

POST /v1/user/medal

请求头:

名称必须备注
token是空

响应体:

status {
  number: 114514
  code: 1 // 请求状态码，1为正常
  msg: "success" // 返回消息
}
medal {
  id: 1 // 勋章ID
  name: "测试勋章" // 勋章名称
  sort: 100 // 勋章顺序
}
ProtoBuf数据结构
// 勋章
message medal {
    Status status = 1; // 状态信息
    repeated Medal_info medal = 2; // 勋章信息
}

// 勋章信息
message Medal_info {
    uint64 id = 1; // 勋章ID
    string name = 2; // 勋章名称
    uint64 sort = 5;  // 勋章顺序
}

更改用户名称

POST /v1/user/edit-nickname

请求头:

名称必须备注
token是空

请求体:

name: "123" // 用户名称
ProtoBuf数据结构
message edit_nickname_send {
    string name = 3;
}

响应体:

status {
  number: 114514
  code: 1 // 请求状态码，1为正常
  msg: "success" // 返回消息
}
ProtoBuf数据结构
// 更改名称状态信息
message edit_nickname {
    Status status = 1; // 状态信息
}

更改用户头像

POST /v1/user/edit-avatar

请求头:

名称必须备注
token是空

请求体:

url: "https://..." // 用户头像url
ProtoBuf数据结构
message edit_avatar_send {
    string url = 2;
}

响应体:

status {
  number: 114514
  code: 1 // 请求状态码，1为正常
  msg: "success" // 返回消息
}
ProtoBuf数据结构
// 更改名称状态信息
message edit_avatar {
    Status status = 1; // 状态信息
}

用户邮箱密码登录

POST /v1/user/email-login

请求体：

{
    "email": "123456@example.com", // 登录邮箱
    "password": "123456", // 登录密码
    "deviceId": "awa", // 登录设备唯一标识符
    "platform": "android" // 登录平台名称
}

响应体:

{
    "code": 1, // 请求状态码，1为正常
    "data": {
        "token": "abcdefg1-xxxx-xxxx-xxxxxxxxxx" // 登录效验令牌
    },
    "msg": "success" // 返回消息
}

退出登录

POST /v1/user/logout

请求头:

名称必须备注
token是空

请求体:

{
  "device-id": "123123123" // 设备ID
}

响应体:

{
    "code": 1, // 请求状态码，1为正常
    "msg": "success" // 返回消息
}

获取发现群聊分区

POST /v1/user/recommend-category-list

请求头:

名称必须备注
token是空

请求体：

{
 "appChannel": "default"
}

响应体：

{
  "code": 1, // 状态码，正常为1
  "data": {
    "categories": [ // 群聊类别
      "精选",
      "粉丝群",
      "地区",
      "IT/互联网",
      "玩机",
      "游戏",
      "资讯订阅"
    ]
  },
  "msg": "success" // 状态信息
}

获取发现群聊列表

POST /v1/user/recommend-list

请求头:

名称必须备注
token是空

请求体：

{
  "category": "精选", // 群聊类别
  "keyword": "", // 关键词
  "size": 30, // 尺寸
  "page": 1 // 页码
}

响应体：

{
  "code": 1, // 状态码，正常为1
  "data": {
    "groupList": [
      {
        "chatId": "123", // 群聊id
        "banId": 0, // 顾名思义
        "nickname": "测试群聊名称", // 群聊名字
        "introduction": "测试群聊简介", // 群聊介绍
        "avatarUrl": "https://...", // 群聊头像
        "headcount": 123, // 群聊内人数
        "createTime": 1231231230 // 创建时间戳
      }
     // ...
    ]
  },
  "msg": "success" // 状态信息
}

获取机器人推荐列表

POST /v1/user/recommend

请求头:

名称必须备注
token是空

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "data": {
    "botList": [
      {
        "chatId": "123", // 机器人id
        "chatType": "3", // 识别对象类别，1-用户，2-群聊，3-机器人
        "headcount": "123", // 使用人数
        "nickname": "测试机器人名称", // 机器人名称
        "introduction": "测试机器人简介", // 机器人简介
        "introductions": "",
        "avatarUrl": "https://...", // 机器人头像url
        "isAdd": 1, // 是否添加（1为可添加，0为不可添加）
        "isApply": 0, // 是否应用
        "alwaysAgree": 0 // 是否总是同意
      }
    // ...
    ]
  },
  "msg": "success" // 返回消息
}

模块忽略信息获取

POST /v1/user/module-ignore-info

请求头:

名称必须备注
token是需要vip

请求体：

{
 "deviceId": "1234"
}

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "data": {
    "ignore": {
      "id": 0, // 可能是模块设置id
      "userId": "1234567", // 用户id
      "updateTime": 123455660, // 更新时间戳
      "deviceId": "1234", // 设备id
      "ignore": ",30,20,10" // 模块id，10-隐藏社区页面，20-隐藏发现页面，30-精简我的界面
    }
  },
  "msg": "success" // 返回消息
}

设置自定义模块

POST /v1/user/module-ignore

请求头:

名称必须备注
token是需要vip

请求体：

{
 "deviceId": "1234"
 "ignore": ",30,20,10" // 模块id，10-隐藏社区页面，20-隐藏发现页面，30-精简我的界面
}

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "msg": "success" // 返回消息
}

获取通知状态

POST /v1/user/notification-status

请求头:

名称必须备注
token是空

请求体：

{
  "deviceId": "1114514", // 设备id
  "registrationId": "114514" // 注册id
}

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "data": {
    "notification": { // 通知json
      "id": 110061, // 注册id
      "userId": "114514", // 用户id
      "deviceId": "114514", // 设备id
      "registrationId": "114514", // 通知注册id
      "isOpen": 1, // 是否打开系统消息通知（设置”系统消息通知“选项可控制这个数值，1-打开，0-关闭）
      "type": 2, // 类型
      "delFlag": 0,
      "createTime": 1231231230, // 创建时间戳
      "updateTime": 1231231230 // 更新时间戳
    }
  },
  "msg": "success" // 返回消息
}

获取通知注册信息

POST /v1/user/notification-info

请求头:

名称必须备注
token是空

请求体：

{
  "deviceId": "114514", // 设备id
  "registrationId": "114514", // 注册通知id
  "isOpen": 1, // // 是否打开系统消息通知（设置”系统消息通知“选项可控制这个数值，1-打开，0-关闭）
  "type": 2 // 类型
}

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "msg": "success" // 返回消息
}

金币增减记录

POST /v1/user/gold-coin-increase-decrease-record

请求头:

名称必须备注
token是无

请求体：

{
  "size": 20, // 尺寸
  "page": 1 // 页数
}

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "data": {
    "goldCoinRecord": [
      {
        "id": 193275, // 金币记录id
        "userId": "用户id",
        "typ": 8, // 类型
        "beforeAmount": 55.01, // 之前金币数量
        "afterAmount": 57.01, // 之后的金币数量
        "changeAmount": 2, // 增加/减少的金币数量
        "reason": "抽奖金币", // 增加/减少金币的原因
        "remark": "", // 备注
        "createTime": 1754669040 // 创建时间戳
      }
    // ...
    ],
    "total": 243 // 总共的金币记录
  },
  "msg": "success" // 返回消息
}

绑定手机号

POST /v1/user/bing-phone

请求头:

名称必须备注
token是无

请求体：

{
  "phone": "12312311230", // 欲绑定手机号
  "captcha": "123123" // 短信验证码
}

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "msg": "success" // 返回消息
}

绑定邮箱

POST /v1/user/bing-email

请求头:

名称必须备注
token是无

请求体：

{
  "email": "123@123.com", // 欲绑定邮箱
  "captcha": "123123" // 邮件验证码
}

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "msg": "success" // 返回消息
}

更改绑定手机号

POST /v1/user/change-phone-check

请求头:

名称必须备注
token是无

请求体：

{
  "phone": "12312341230", // 欲绑定手机号
  "captcha": "123123" // 短信验证码
}

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "msg": "success" // 返回消息
}

更改绑定邮箱

POST /v1/user/change-email-check

请求头:

名称必须备注
token是无

请求体：

{
  "email": "123@123.com", // 欲绑定邮箱
  "captcha": "123123" // 邮件验证码
}

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "msg": "success" // 返回消息
}

更改登录密码

POST /v1/user/forget-password

请求体：

{
  "email": "123@123.com", // 欲绑定邮箱
  "captcha": "123123", // 邮件验证码
  "password": "测试登录密码" // 登录密码
}

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "msg": "success" // 返回消息
}

修改自身个人资料

POST /v1/user/save-user-data

请求头:

名称必须备注
token是空

请求体：

{
  "introduction": "111", // 个人简介
  "gender": 3, // 性别，1-男，2-女，3-其他
  "birthday": 1231231230, // 生日时间戳
  "province": "北京市", // 所在地省份
  "city": "北京城区", // 所在地城市
  "district": "东城区", // 所在地城区
  "locationCode": "110101" // 所在地邮政编码
}

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "msg": "success" // 返回消息
}

获取自身个人资料

POST /v1/user/get-user-data

请求头:

名称必须备注
token是空

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "data": {
    "data": {
      "id": 123, // 个人简介ID
      "userId": "123", // 用户ID
      "lastLoginTime": 1231231230, // 最后登录时间戳
      "update_time": 1231231230, // 个人简介最后更新时间戳
      "introduction": "测试个人简介", // 个人简介
      "gender": 3, // 性别，1-男，2-女，3-其他
      "birthday": 1231231230, // 生日时间戳
      "province": "北京市", // 所在地省份
      "city": "北京城区", // 所在地城市
      "district": "东城区", // 所在地城区
     "locationCode": "110101" // 所在地邮政编码
    }
  },
  "msg": "success" // 返回消息
}

获取用户显示广告

POST /v1/user/get-user-show-adv

请求头:

名称必须备注
token是空

响应体：

{
  "code": 1, // 请求状态码，1为正常
  "data": {
    "androidCodeId": "123", // Android代码ID
    "bottomHeight": 123, // 底部高度
    "iosCodeId": "123", // IOS代码ID
    "isShow": 0 // 是否显示，0-不显示，1-显示
  },
  "msg": "success" // 返回消息
}
在 GitHub 上编辑此页
最近更新
贡献者: yyyytawa,QianLin-Jiaxi,1ctrl-cv,shanfishapp,B84F2246,Kauid323,MarisaDAZA
云湖非官方 API 文档
Copyright © 2026 yh-third-dev