API接口文档

邮箱验证码接口

GET 发送验证码 /api/ems/send

发送验证码

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
event	string	否	事件名称：login/register/changeemail/changepwd/resetpwd（登录请传login；不传默认register）

正文

无

参数

event

响应输出

返回参数

无

无

GET 检测验证码 /api/ems/check

检测验证码

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
event	string	是	事件名称：login/register/changeemail/changepwd/resetpwd（需与发送验证码时保持一致）
captcha	string	是	验证码

正文

无

参数

event

captcha

响应输出

返回参数

无

无

朋友圈接口

GET 朋友圈分享记录 /api/friend/public_list

朋友圈分享记录。根据用户ID获取其朋友圈分享列表，支持分页与排序。每条记录包含分享内容、发布者昵称/头像、是否已赞、点赞数、回复数等，用于展示朋友圈动态。

Headers

无

参数

名称	类型	必选	描述
uid	integer	是	用户ID，当前登录用户或要查看其朋友圈的用户ID
start	integer	否	分页起始偏移，如 0 表示从第一条开始，与 limit 配合使用
limit	string	否	条数限制，如 "0, 10" 表示取前10条；不传时由服务端默认
order	string	否	排序方式，如 createtime desc（按创建时间倒序），默认 createtime desc

正文

无

参数

uid

start

limit

order

响应输出

返回参数

data 为朋友圈分享记录数组。每条包含：id 分享ID、user_id 发布者ID、nickname 昵称、headsmall/avatar 头像、ispraise 当前用户是否已赞、praises 点赞数、replys 回复数，以及分享内容、图片/视频等字段，具体以实际返回为准。

无

手机短信接口

POST 发送短信验证码 /api/sms/send

发送短信验证码

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号（中国大陆11位，以1开头）
event	string	是	事件名称：register（注册，手机号需未注册）/login（登录）/changemobile（换绑手机号，手机号需未被占用）/changepwd（修改密码，手机号需已注册）/resetpwd（重置密码，手机号需已注册）；不传默认register

正文

无

参数

mobile

event

响应输出

返回参数

无

{
            "code": 0,
            "msg": "发送成功",
            "time": "1770776462",
            "data": {}
       }

POST 检测验证码 /api/sms/check

检测验证码

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号码
event	string	是	事件名称register/login
captcha	string	是	验证码

正文

无

参数

mobile

event

captcha

响应输出

返回参数

无

{
            "code": 0,
            "msg": "正确",
            "time": "1770776462",
            "data": {}
       }

群组接口

POST 创建群组 /api/team/create

创建群组

Headers

无

参数

名称	类型	必选	描述
id	string	是	群组ID
name	string	是	群组名称
addfriend	integer	否	是否允许添加好友 0=否 1=是，默认0
sync_im	string	否	是否同步网易云信 1=先上传网易云再保存本地 0=只保存本地，默认1
tid	string	否	网易云信群组ID，sync_im=0 时必传

正文

无

参数

name

addfriend

sync_im

tid

响应输出

返回参数

名称	描述
id	群组ID
tid	网易云信群组ID

{
            "code": 0,
            "msg": "创建成功",
            "time": "1770776462",
            "data": { "id": "群组ID", "tid": "网易云信群组ID" }
        }

GET 设置群消息撤回 /api/team/setTeamRecall

设置群消息撤回。用于开启或关闭指定群的消息撤回能力（isrecall 字段）。需传入群组ID；不传 isrecall 时默认为 1（开启）。

Headers

无

参数

名称	类型	必选	描述
id	string	是	群组ID
isrecall	string	否	是否允许消息撤回，默认 1（开启）；0=关闭

正文

无

参数

isrecall

响应输出

返回参数

成功时提示「设置成功」；失败返回相应错误信息。

无

GET 群红包白名单 /api/team/redpacketWhiteList

群红包白名单

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 红包限制状态 /api/team/getRedPacketLimit

红包限制状态

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 红包限制开启/关闭 /api/team/redPacketLimit

红包限制开启/关闭

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 设置群是否允许撤回 /api/team/setIsRecall

设置群是否允许撤回。根据群组ID更新该群的 isrecall 字段，用于开启或关闭群内消息撤回功能。

Headers

无

参数

名称	类型	必选	描述
id	string	是	群组ID
isrecall	string	是	是否允许消息撤回，如 1=开启 0=关闭

正文

无

参数

isrecall

响应输出

返回参数

成功时提示「设置成功」；失败返回相应错误信息。

无

GET 获取群是否允许撤回 /api/team/getIsRecall

获取群是否允许撤回。根据群组ID查询该群的 isrecall 配置，返回群ID及是否允许消息撤回状态。

Headers

无

参数

名称	类型	必选	描述
id	string	是	群组ID

正文

无

参数

响应输出

返回参数

data 包含：id 群组ID、isrecall 是否允许消息撤回（如 1=开启 0=关闭）。

无

GET 获取群到期时间 /api/team/getExpiresTime

获取群到期时间

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 清除群聊天记录校验 /api/team/clearTeamMessage

清除群聊天记录校验

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

POST 修改群配置 /api/team/setTeamAllSetting

修改群配置。传入群组ID(tid)，可设置是否允许私下交流(tprivate)、普通成员能否发口令红包(isred)；至少传 tprivate 或 isred 之一。

Headers

无

参数

名称	类型	必选	描述
tid	string	是	群组ID
tprivate	integer	否	是否允许私下交流 1=是 0=否，会同时设置 canAddFriend、canMemberInfo
isred	integer	否	普通成员能否发口令红包 1=是 0=否；至少传 tprivate 或 isred 之一

正文

无

参数

tid

tprivate

isred

响应输出

返回参数

无

无

GET 获取指定群配置 /api/team/getTeamAllSetting

获取指定群配置。传入群组ID(tid)，返回该群的隐私与权限配置：是否允许私下交流、群内能否加好友/查看资料、是否允许发口令红包、客服列表、群基数等。

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

名称	类型	必选	描述
tid	string	是	群组ID

正文

无

参数

响应输出

返回参数

名称	类型	描述
tprivate	integer	是否允许群成员私下交流 1=是 0=否
canAddFriend	integer	群内能否添加好友 1=是 0=否
canMemberInfo	integer	群内能否查看好友资料 1=是 0=否
isred	integer	群内普通成员能否发口令红包 1=是 0=否
serviceList	array	客服列表（用户ID数组）
base	integer	群基数

{
  "code": 1,
  "msg": "",
  "time": "1707292800",
  "data": {
    "tprivate": 1,
    "canAddFriend": 1,
    "canMemberInfo": 1,
    "isred": 1,
    "serviceList": ["123", "456"],
    "base": 0
  }
}

GET 设置群内普通成员能否发口令红包 /api/team/setTeamRed

设置群内普通成员能否发口令红包

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

POST 解散群组 /api/team/destory

解散群组

Headers

无

参数

名称	类型	必选	描述
id	string	是	群组ID

正文

无

参数

响应输出

返回参数

无

{
            "code": 0,
            "msg": "解散成功",
            "time": "1770776462",
            "data": null
        }

GET 设置群是否允许私下交流 /api/team/setTeamPrivate

设置群是否允许私下交流。根据群组ID更新该群的 tprivate 字段；若群不存在则先根据 name、user_id 创建群再设置。1=允许群成员私下交流，0=不允许。

Headers

无

参数

名称	类型	必选	描述
id	string	是	群组ID，要操作的群唯一标识
tprivate	string	否	是否允许私下交流：1=允许，0=不允许；不传默认 0
name	string	否	群名称，仅当根据 id 查不到群时用于新建群记录
user_id	string	否	群主用户ID，仅当群不存在时用于创建群

正文

无

参数

tprivate

name

user_id

响应输出

返回参数

成功时 msg 为「设置成功」；失败返回相应错误信息。

{"code":0,"msg":"设置成功","time":"1770776462","data":null}

GET 获取群设置详情 /api/team/getTeamSetting

获取群设置详情。根据群组ID查询该群的隐私与发红包设置，返回是否允许私下交流（tprivate）、普通成员是否可发口令红包（isred）。

Headers

无

参数

名称	类型	必选	描述
id	string	是	群组ID，要查询的群唯一标识

正文

无

参数

响应输出

返回参数

data 包含：tprivate 是否允许私下交流（1=是 0=否）、isred 普通成员是否可发口令红包（1=是 0=否）。

{"code":0,"msg":"","time":"1770776462","data":{"tprivate":"1","isred":"0"}}

GET 获取群基数/虚拟群人数 /api/team/getTeamBaseNum

获取群基数（虚拟群人数）。根据群组ID查询该群在 team 表中的 base 字段，用于展示虚拟群人数；结果会做缓存，减少数据库查询。

Headers

无

参数

名称	类型	必选	描述
id	string	是	群组ID，要查询的群唯一标识

正文

无

参数

响应输出

返回参数

data 包含：base 虚拟群人数/群基数，群不存在或未设置时为 0。

{"code":0,"msg":"","time":"1770776462","data":{"base":100}}

GET 创建群人数限制 /api/team/getTeamMaxNum

创建群人数限制

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 修改群成员权限 /api/team/modifymemberauthority

修改群成员权限

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 获取群成员权限 /api/team/getmemberauthority

获取群成员权限

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 查询客服ID /api/team/teamservice

查询客服ID

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 修改群客服 /api/team/modifyservice

修改群客服

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 修改群主 /api/team/modifyowner

修改群主

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

POST 修改群组信息 /api/team/modifyname

修改群组信息

Headers

无

参数

名称	类型	必选	描述
id	string	是	群组ID
name	string	否	群组名称，传空则只更新其他字段
addfriend	integer	否	是否允许添加好友/群组隐私设置 0=否 1=是，默认0

正文

无

参数

name

addfriend

响应输出

返回参数

无

{
            "code": 0,
            "msg": "同步成功",
            "time": "1770776462",
            "data": null
        }

GET 群红包白名单处理 /api/team/handleRedpacketWhiteList

群红包白名单处理

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 群分组列表 /api/team_group/list

获取当前登录用户的群分组列表（含每个分组群数量）

Headers

无

参数

无

正文

返回数据结构说明：
1. data.default_group：默认“未分组”分组，包含当前所有未分组的群。
2. data.groups：当前用户创建的自定义群分组列表。每个分组下直接返回 team_ids、team_list 和 team_count，前端可直接渲染分组卡片。
3. data.all_teams：当前用户可参与分组的全部群列表，每条数据都带当前所属分组 group_id 和 group_name，可直接用于“添加分组/编辑分组”的勾选弹窗。
4. team_list 内单个群对象结构：id 群ID、name 群名称、createtime 创建时间、avatar 群头像、announcement 群公告、group_id 当前所属分组ID、relation_updatetime 群分组关系更新时间。
5. 列表页通常优先展示 default_group 和 groups；all_teams 主要用于新增/编辑分组时的可选群数据源。
6. 下方“返回示例”即为实际接口返回格式，可直接作为前端联调参考。

参数

响应输出

{
  "code": 0,
  "msg": "",
  "time": "1773233030",
  "data": {
    "default_group": { // 默认“未分组”分组，包含当前所有未分组的群列表
      "id": 0,
      "name": "未分组",
      "team_count": 6,
      "team_ids": [
        "73126426385",
        "73126426384",
        "73126426383",
        "73126426379",
        "73126426378",
        "73126426377"
      ],
      "team_list": [ // 未分组群列表
        {
          "id": "73126426385",
          "name": "大三群",
          "createtime": 1773174468,
          "avatar": "",
          "announcement": "",
          "group_id": 0,
          "relation_updatetime": 0
        },
        {
          "id": "73126426384",
          "name": "大二群",
          "createtime": 1773174429,
          "avatar": "",
          "announcement": "",
          "group_id": 0,
          "relation_updatetime": 0
        },
        {
          "id": "73126426383",
          "name": "大一群",
          "createtime": 1773174421,
          "avatar": "",
          "announcement": "",
          "group_id": 0,
          "relation_updatetime": 0
        },
        {
          "id": "73126426379",
          "name": "初三群",
          "createtime": 1773173832,
          "avatar": "",
          "announcement": "",
          "group_id": 0,
          "relation_updatetime": 0
        },
        {
          "id": "73126426378",
          "name": "初二群",
          "createtime": 1773173804,
          "avatar": "",
          "announcement": "",
          "group_id": 0,
          "relation_updatetime": 0
        },
        {
          "id": "73126426377",
          "name": "初一群",
          "createtime": 1773171718,
          "avatar": "",
          "announcement": "",
          "group_id": 0,
          "relation_updatetime": 0
        }
      ]
    },
    "groups": [ // 分组列表
      {
        "id": 1,
        "user_id": 204148277,
        "name": "初中组",
        "sort": 0,
        "createtime": 1773172645,
        "updatetime": 1773172794,
        "team_list": [],
        "team_ids": [],
        "team_count": 0
      },
      {
        "id": 2,
        "user_id": 204148277,
        "name": "高中组",
        "sort": 0,
        "createtime": 1773174792,
        "updatetime": 1773174792,
        "team_list": [  // 分组下的群列表
          {
            "id": "73126426380",
            "name": "高一群",
            "createtime": 1773174393,
            "avatar": "",
            "announcement": "",
            "group_id": 2,
            "relation_updatetime": 1773174792
          },
          {
            "id": "73126426381",
            "name": "高二群",
            "createtime": 1773174399,
            "avatar": "",
            "announcement": "",
            "group_id": 2,
            "relation_updatetime": 1773174792
          },
          {
            "id": "73126426382",
            "name": "高三群",
            "createtime": 1773174415,
            "avatar": "",
            "announcement": "",
            "group_id": 2,
            "relation_updatetime": 1773174792
          }
        ],
        "team_ids": [
          "73126426380",
          "73126426381",
          "73126426382"
        ],
        "team_count": 3
      }
    ],
    "all_teams": [ // 所有群列表，包含分组信息，用于创建/编辑分组时的可选数据源
      {
        "id": "73126426385",
        "name": "大三群",
        "createtime": 1773174468,
        "avatar": "",
        "announcement": "",
        "group_id": 0,
        "group_name": "未分组"
      },
      {
        "id": "73126426384",
        "name": "大二群",
        "createtime": 1773174429,
        "avatar": "",
        "announcement": "",
        "group_id": 0,
        "group_name": "未分组"
      },
      {
        "id": "73126426383",
        "name": "大一群",
        "createtime": 1773174421,
        "avatar": "",
        "announcement": "",
        "group_id": 0,
        "group_name": "未分组"
      },
      {
        "id": "73126426382",
        "name": "高三群",
        "createtime": 1773174415,
        "avatar": "",
        "announcement": "",
        "group_id": 2,
        "group_name": "高中组"
      },
      {
        "id": "73126426381",
        "name": "高二群",
        "createtime": 1773174399,
        "avatar": "",
        "announcement": "",
        "group_id": 2,
        "group_name": "高中组"
      },
      {
        "id": "73126426380",
        "name": "高一群",
        "createtime": 1773174393,
        "avatar": "",
        "announcement": "",
        "group_id": 2,
        "group_name": "高中组"
      },
      {
        "id": "73126426379",
        "name": "初三群",
        "createtime": 1773173832,
        "avatar": "",
        "announcement": "",
        "group_id": 0,
        "group_name": "未分组"
      },
      {
        "id": "73126426378",
        "name": "初二群",
        "createtime": 1773173804,
        "avatar": "",
        "announcement": "",
        "group_id": 0,
        "group_name": "未分组"
      },
      {
        "id": "73126426377",
        "name": "初一群",
        "createtime": 1773171718,
        "avatar": "",
        "announcement": "",
        "group_id": 0,
        "group_name": "未分组"
      }
    ]
  }
}

POST 创建群分组 /api/team_group/create

创建群分组

Headers

token: 用户登录Token

参数

名称	类型	必选	描述
name	string	是	分组名称，最多20个字符
sort	integer	否	排序值，默认0，值越大越靠前
team_ids	string	否	创建时立即勾选的群ID列表。支持两种格式：team001,team002 或 ["team001","team002"]

正文

对应“添加分组”操作。先调用 /api/team_group/list 获取 all_teams 展示可勾选群，再把组名和选中的 team_ids 一起提交，即可立即创建分组并绑定群。

返回示例

{ "code": 0, "msg": "", "time": "1773174800", "data": { "default_group": { "id": 0, "name": "未分组", "team_count": 6, "team_ids": [ "73126426385", "73126426384", "73126426383", "73126426379", "73126426378", "73126426377" ], "team_list": [ { "id": "73126426385", "name": "大三群", "createtime": 1773174468, "avatar": "", "announcement": "", "group_id": 0, "relation_updatetime": 0 }, { "id": "73126426384", "name": "大二群", "createtime": 1773174429, "avatar": "", "announcement": "", "group_id": 0, "relation_updatetime": 0 }, { "id": "73126426383", "name": "大一群", "createtime": 1773174421, "avatar": "", "announcement": "", "group_id": 0, "relation_updatetime": 0 }, { "id": "73126426379", "name": "初三群", "createtime": 1773173832, "avatar": "", "announcement": "", "group_id": 0, "relation_updatetime": 0 }, { "id": "73126426378", "name": "初二群", "createtime": 1773173804, "avatar": "", "announcement": "", "group_id": 0, "relation_updatetime": 0 }, { "id": "73126426377", "name": "初一群", "createtime": 1773171718, "avatar": "", "announcement": "", "group_id": 0, "relation_updatetime": 0 } ] }, "groups": [ { "id": 1, "user_id": 204148277, "name": "初中组", "sort": 0, "createtime": 1773172645, "updatetime": 1773172794, "team_list": [], "team_ids": [], "team_count": 0 }, { "id": 2, "user_id": 204148277, "name": "高中组", "sort": 0, "createtime": 1773174792, "updatetime": 1773174792, "team_list": [ { "id": "73126426380", "name": "高一群", "createtime": 1773174393, "avatar": "", "announcement": "", "group_id": 2, "relation_updatetime": 1773174792 }, { "id": "73126426381", "name": "高二群", "createtime": 1773174399, "avatar": "", "announcement": "", "group_id": 2, "relation_updatetime": 1773174792 }, { "id": "73126426382", "name": "高三群", "createtime": 1773174415, "avatar": "", "announcement": "", "group_id": 2, "relation_updatetime": 1773174792 } ], "team_ids": [ "73126426380", "73126426381", "73126426382" ], "team_count": 3 } ], "all_teams": [ { "id": "73126426385", "name": "大三群", "createtime": 1773174468, "avatar": "", "announcement": "", "group_id": 0, "group_name": "未分组" }, { "id": "73126426384", "name": "大二群", "createtime": 1773174429, "avatar": "", "announcement": "", "group_id": 0, "group_name": "未分组" }, { "id": "73126426383", "name": "大一群", "createtime": 1773174421, "avatar": "", "announcement": "", "group_id": 0, "group_name": "未分组" }, { "id": "73126426382", "name": "高三群", "createtime": 1773174415, "avatar": "", "announcement": "", "group_id": 2, "group_name": "高中组" }, { "id": "73126426381", "name": "高二群", "createtime": 1773174399, "avatar": "", "announcement": "", "group_id": 2, "group_name": "高中组" }, { "id": "73126426380", "name": "高一群", "createtime": 1773174393, "avatar": "", "announcement": "", "group_id": 2, "group_name": "高中组" }, { "id": "73126426379", "name": "初三群", "createtime": 1773173832, "avatar": "", "announcement": "", "group_id": 0, "group_name": "未分组" }, { "id": "73126426378", "name": "初二群", "createtime": 1773173804, "avatar": "", "announcement": "", "group_id": 0, "group_name": "未分组" }, { "id": "73126426377", "name": "初一群", "createtime": 1773171718, "avatar": "", "announcement": "", "group_id": 0, "group_name": "未分组" } ] } }

参数

name

sort

team_ids

响应输出

返回参数

名称	类型	描述
data.id	integer	分组ID
data.name	string	分组名称
data.sort	integer	排序值
data.team_ids	array	本次绑定成功的群ID列表

{
    "code": 1,
    "msg": "创建成功",
    "time": "1707292800",
    "data": {
        "id": 12,
        "name": "工作群",
        "sort": 10,
        "team_ids": ["team001", "team002"]
    }
}

POST 修改群分组 /api/team_group/update

修改群分组

Headers

token: 用户登录Token

参数

名称	类型	必选	描述
id	integer	是	分组ID
name	string	否	新的分组名称，最多20个字符
sort	integer	否	新的排序值；只改排序时传 id+sort 即可
team_ids	string	否	编辑后重新提交的群ID列表。支持两种格式：team001,team002 或 ["team001","team002"]；传 [] 表示清空该分组下全部群

正文

对应“编辑分组”保存。推荐先调 /api/team_group/detail 回显，再把最终勾选结果通过 team_ids 整体提交。

参数

name

sort

team_ids

响应输出

返回参数

名称	类型	描述
data.id	integer	分组ID
data.name	string	修改后的分组名称
data.sort	integer	修改后的排序值
data.team_ids	array	当前分组下最终保存的群ID列表

{
    "code": 1,
    "msg": "修改成功",
    "time": "1707292800",
    "data": {
        "id": 12,
        "name": "工作群",
        "sort": 20,
        "team_ids": ["team001", "team003"]
    }
}

POST 删除群分组 /api/team_group/delete

删除群分组（分组下群自动归入未分组）

{"code":0,"msg":"删除成功","time":"1700000000","data":null}

POST 设置单个群分组 /api/team_group/set_team_group

设置单个群分组

{"code":0,"msg":"设置成功","time":"1700000000","data":null}

POST 批量设置群分组 /api/team_group/batch_set_team_group

批量设置群分组

{"code":0,"msg":"设置成功","time":"1700000000","data":null}

GET 群分组映射 /api/team_group/map

获取分组映射(mapping/grouped)

{"code":0,"msg":"","time":"1700000000","data":{"mapping":[{"team_id":"10001","group_id":2}],"grouped":{"2":["10001"]}}}

Token接口

GET 检测Token是否过期 /api/token/check

检测Token是否过期

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 刷新Token /api/token/refresh

刷新Token

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

无

无

GET 发送图片消息 /api/user/sendImg

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

POST 获取用户状态及上次登录时间 /api/user/getPreleavetime

获取用户状态及上次登录时间

Headers

无

参数

名称	类型	必选	描述
uid	array	是	目标用户ID

正文

无

参数

响应输出

返回参数

无

{
        "code": 0,
        "msg": "",
        "time": "1770776462",
        "data": {
                "uid": "用户ID",
                "username": "用户账号",
                "nickname": "用户昵称",
                "preleavetime": "上次离开时间戳"
            }
        }

GET 获取好友聊天记录删除权限 /api/user/getFriendDeleteChatPermission

获取当前用户与指定好友之间的聊天记录双向删除权限。返回双方配置：我是否允许对方删除我本机记录，以及对方是否允许我删除对方本机记录。

Headers

token: 用户登录Token

参数

名称	类型	必选	描述
friend_id	integer	是	好友用户ID

正文

删除聊天记录前，删除方可先调用本接口读取 peer_allow_peer_delete_chat，判断是否需要同步通知对方客户端删除本地聊天记录。

参数

响应输出

返回参数

名称	类型	描述
data.friend_id	integer	好友用户ID
data.my_allow_peer_delete_chat	integer	我是否允许该好友删除我本机聊天记录，1允许 0禁止
data.peer_allow_peer_delete_chat	integer	对方是否允许我删除对方本机聊天记录，1允许 0禁止

{
    "code": 1,
    "msg": "",
    "time": "1773200000",
    "data": {
        "friend_id": 204202302,
        "my_allow_peer_delete_chat": 1,
        "peer_allow_peer_delete_chat": 0
    }
}

POST 设置好友聊天记录删除权限 /api/user/setFriendDeleteChatPermission

设置“我是否允许指定好友删除我本机聊天记录”的开关。该开关是好友关系级别配置，不是用户全局配置。

Headers

token: 用户登录Token

参数

名称	类型	必选	描述
friend_id	integer	是	好友用户ID
allow_peer_delete_chat	integer	是	可选值：1=允许该好友删除我本机聊天记录，0=禁止该好友删除我本机聊天记录

正文

例如我对好友 A 设置为 0，则 A 删除与我的聊天记录时，只能删除他自己本机里的记录，不能影响我本机里的记录。

参数

friend_id

allow_peer_delete_chat

响应输出

返回参数

名称	类型	描述
data.friend_id	integer	好友用户ID
data.allow_peer_delete_chat	integer	当前保存后的权限值，1允许 0禁止

{
    "code": 1,
    "msg": "设置成功",
    "time": "1773200000",
    "data": {
        "friend_id": 204202302,
        "allow_peer_delete_chat": 0
    }
}

会员接口

POST 会员登录 /api/user/login

会员登录

Headers

无

参数

名称	类型	必选	描述
client	string	是	登录端 PC/Android/IOS
type	string	是	登录验证类型：passwd=密码登录，sms=验证码登录
v	string	是	客户端版本号
account	string	是	账号（支持用户名/手机号/邮箱）
password	string	否	密码（type=passwd时必填）
captcha	string	否	验证码（type=sms时必填，邮箱/短信验证码）

正文

无

参数

client

type

account

password

captcha

响应输出

返回参数

无

{
            "code": 0,
            "msg": "登录成功",
            "time": "1770776462",
            "data": {}
       }

GET 重置密码 /api/user/resetpwd

重置密码

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
newpassword	string	是	新密码
captcha	string	是	验证码

正文

无

参数

mobile

newpassword

captcha

响应输出

返回参数

无

无

GET 上传头像 /api/user/saveAvatar

向指定用户或群组发送一条图片消息。

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 获取用户好友设置 /api/user/getUserSetup

根据目标用户ID(tuid)查询该用户的添加好友权限设置(friendpermission)，返回 id 与 friendpermission。

Headers

无

参数

名称	类型	必选	描述
tuid	string	是	目标用户ID

正文

无

参数

响应输出

返回参数

无

无

GET 设置用户好友设置 /api/user/setUserSetup

根据目标用户ID获取该用户的好友添加权限设置。

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 解绑/更换手机号 /api/user/unbindingmobile

设置当前用户的添加好友权限（如是否允许被添加等）。

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 生成账号签名 /api/user/createSign

根据账号(account)生成签名：sign = md5(md5(account) + md5(固定盐值))，用于登录等接口的签名校验（当前校验逻辑已注释）。

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 获取超级会员列表 /api/user/getSupMemberList

获取超级会员列表。查询所有标记为超级会员(issup=1)的用户，返回其用户ID列表，用于展示或筛选超级会员。

Headers

无

参数

无（无需传参）

正文

无

参数

响应输出

返回参数

成功时 data 为超级会员用户ID字符串数组，如 ["1","2","3"]；无超级会员时为空数组 []。

无

GET 获取用户最后登录信息 /api/user/getUserLastLoginId

根据用户ID获取该用户上次登录信息，包括用户ID、用户名、登录IP及根据IP解析的登录地区。若用户不存在或无登录IP则报错。

Headers

无

参数

名称	类型	必选	描述
id	string	是	用户ID

正文

无

参数

响应输出

返回参数

data 包含：id 用户ID、username 用户名、ip 上次登录IP、location 根据IP解析的登录地区。

无

GET 上传图片 /api/user/uploadImage

上传图片

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 修改手机号 /api/user/changemobile

修改手机号

Headers

无

参数

名称	类型	必选	描述
email	string	是	手机号
captcha	string	是	验证码

正文

无

参数

captcha

响应输出

返回参数

无

无

POST 会员注册 /api/user/register

会员注册

Headers

无

参数

名称	类型	必选	描述
client	string	是	注册端标识，建议：PC/Android/IOS（用于记录日志与端侧识别）
type	string	是	注册类型：passwd=普通注册；sms=第三方/扩展注册场景（当前以实际后端配置为准）
account	string	是	登录账号；支持用户名/手机号/邮箱（邮箱注册时请配合 emailcode）
password	string	是	登录密码；需满足密码强度校验（建议8位及以上，含字母+数字）
nickname	string	是	用户昵称（必填）
invitecode	string	否	邀请码；当后台开启“注册必须邀请码”时必填，且需为有效可用邀请码
mobilecode	string	否	手机验证码；当后台开启“注册需手机校验”时使用，需与 account 对应
emailcode	string	否	邮箱验证码；当 account 为邮箱时必填，取值来自 /api/ems/send（event=register）
openid	string	否	微信OpenID；第三方注册或绑定场景下传入
image	file	否	头像文件；当后台开启“注册必须上传头像”时必传（multipart/form-data）
question	string	否	密保问题；当后台开启“注册强制密保”时必填
answer	string	否	密保答案；当后台开启“注册强制密保”时必填，需与问题对应

正文

无

参数

client

type

account

password

nickname

invitecode

mobilecode

emailcode

openid

image

question

answer

响应输出

返回参数

无

{
            "code": 0,
            "msg": "注册成功",
            "time": "1770776462",
            "data": {}
        }

GET 修改邮箱 /api/user/changeemail

修改邮箱

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
captcha	string	是	验证码

正文

无

参数

captcha

响应输出

返回参数

无

无

GET 修改会员个人信息 /api/user/profile

修改会员个人信息

Headers

无

参数

名称	类型	必选	描述
avatar	string	是	头像地址
username	string	是	用户名
nickname	string	是	昵称
bio	string	是	个人简介

正文

无

参数

avatar

username

nickname

bio

响应输出

返回参数

无

无

GET 注销登录 /api/user/logout

注销登录

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 添加好友 /api/user/addFriend

添加好友。传入要添加的好友用户ID（fuid），当前登录用户与 fuid 对应的用户将互为好友，并插入 user_friend 双向记录；成功后会向对方发送一条系统消息。若双方已经是好友，则返回 code=0, msg=已经是好友, data.already_friend=true，不再插入、不发消息。需登录后调用。

Headers

无

参数

名称	类型	必选	描述
fuid	string	是	要添加的好友用户ID，必填

正文

无

参数

响应输出

返回参数

成功：msg=添加成功，data=null。已是好友：code=0, msg=已经是好友, data.already_friend=true。失败返回相应错误信息。

// 添加成功
{
            "code": 0,
            "msg": "添加成功",
            "time": "1770776462",
            "data": null
        }

// 已是好友
{
            "code": 0,
            "msg": "已经是好友",
            "time": "1770776462",
            "data": { "already_friend": true }
        }

GET 修改密码 /api/user/modifyPass

修改密码

Headers

无

参数

名称	类型	必选	描述
type	string	否	修改类型；可选值：secret=通过密保重置密码，mobile=通过手机验证码找回，email=通过邮箱验证码找回，不传或传空=正常修改密码
account	string	否	用户名；当 type=secret 时必填
question	string	否	密保问题；当 type=secret 时必填
answer	string	否	密保答案；当 type=secret 时必填
mobile	string	否	手机号；当 type=mobile 时必填
email	string	否	邮箱；当 type=email 时必填
captcha	string	否	验证码；当 type=mobile 或 type=email 时必填。手机验证码来自 /api/sms/send?event=resetpwd，邮箱验证码来自 /api/ems/send?event=resetpwd
oldpass	string	否	旧密码；正常修改密码时必填
newpass	string	是	新密码；至少6位，且需通过密码强度校验
renewpass	string	是	确认新密码；必须与 newpass 一致

正文

支持4种方式：1. 正常修改密码：oldpass、newpass、renewpass；2. 密保找回：type=secret、account、question、answer、newpass、renewpass；3. 手机验证码找回：type=mobile、mobile、captcha、newpass、renewpass；4. 邮箱验证码找回：type=email、email、captcha、newpass、renewpass。

参数

type

account

question

answer

mobile

captcha

oldpass

newpass

renewpass

响应输出

返回参数

无

{
    "code": 1,
    "msg": "密码已修改",
    "time": "1707292800",
    "data": null
}

GET 删除好友 /api/user/deleteFriend

删除好友

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 是否允许加好友 /api/user/checkAddFriendEx

是否允许加好友

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 编辑用户信息 /api/user/edit

编辑用户信息

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 用户信息 /api/user/detail

用户信息

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 搜索好友名字和群名字 /api/user/searchAll

搜索好友名字和群名字

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 查找好友/api/user/searchs

查找好友H5

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

POST 根据用户ID查找好友 /api/user/search_userid

根据用户ID查找好友

Headers

无

参数

名称	类型	必选	描述
userid	string	是	用户ID

正文

无

参数

响应输出

返回参数

无

{
            "code": 0,
            "msg": "",
            "time": "1770776462",
            "data": {
                "uid": "用户ID",
                "nickname": "用户昵称",
                "avatar": "用户头像",
                "username": "用户账号"
            }
        }

POST 根据用户账号查找好友 /api/user/search

根据用户账号查找好友

Headers

无

参数

名称	类型	必选	描述
account	string	是	用户账号

正文

无

参数

响应输出

返回参数

无

{
            "code": 0,
            "msg": "",
            "time": "1770776462",
            "data": {
                "uid": "用户ID",
                "nickname": "用户昵称",
                "avatar": "用户头像",
                "username": "用户账号"
            }
        }

签到接口

GET 签到奖励信息 /api/sign/signInfo

全局签到—奖励信息、已连续签到天数、今天是否签到、本月签到日期列表、累计签到总金币等。需开启客户端签到(client_globalsign=1)。

Headers

名称	类型	必选	描述
token	string	是	用户登录后获得的 Token，用于识别用户

请求参数

无（无需 URL 参数或 Body）

返回参数

名称	类型	描述
code	integer	状态码，1 表示成功
msg	string	提示信息
data	object	返回数据
data.issign	string	今天是否已签到：1 已签，0 未签
data.lianxu	integer	当前连续签到天数（今日未签时为下一签将累计的天数）
data.thisMonthSignList	array	本月已签到日期列表，如 ["2026-03-01","2026-03-02"]
data.total	integer	累计签到获得的总金币数
data.gold_count	string	每日签到基础金币数（配置）
data.day_count	string	连续签到满 N 天可领额外奖励（配置）
data.gold_count_ex	string	连续满 day_count 天时的额外金币（配置）

正文

无

参数

响应输出

返回参数

见上方「基础信息」- 返回参数表格

{"code":1,"msg":"","data":{...}}

GET 本月签到记录 /api/sign/monthSign

查询当前用户本月已签到的日期列表。需登录。

Headers

名称	类型	必选	描述
token	string	是	用户登录后获得的 Token

请求参数

无

返回参数

名称	类型	描述
code	integer	状态码，1 表示成功
msg	string	提示信息
data	array	本月签到记录数组
data[].id	integer	签到记录 ID
data[].user_id	integer	用户 ID
data[].day	string	签到日期，格式 Ymd 如 20260301
data[].lianxu	integer	该次签到时的连续天数
data[].createtime	integer	签到时间戳

正文

无

参数

响应输出

返回参数

见上方「基础信息」- 返回参数表格

{"code":1,"msg":"","data":[...]}

GET 执行签到 /api/sign/globalsign

全局签到—执行签到，写入记录并发放金币到钱包。需开启签到功能且用户已设置钱包密码；同一天重复调用会报“今天已签到~”。

Headers

名称	类型	必选	描述
token	string	是	用户登录后获得的 Token

请求参数

无

返回参数

名称	类型	描述
code	integer	状态码，1 表示成功
msg	string	提示信息，成功时为「签到成功」
data	null	成功时无数据

失败时 code 非 1，常见：未开放(3)、未设置钱包密码(4)、今天已签到(5)、系统错误(2/6/7/8) 等。

正文

无

参数

响应输出

返回参数

见上方「基础信息」- 返回参数表格

{"code":1,"msg":"签到成功","data":null}

GET 今天是否已签到 /api/sign/isglobalsign

全局签到—查询今天是否已签到及本次可得金币数。需开启客户端签到(client_globalsign=1)。

Headers

名称	类型	必选	描述
token	string	是	用户登录后获得的 Token

请求参数

无

返回参数

名称	类型	描述
code	integer	状态码，1 表示成功
msg	string	提示信息
data	object	返回数据
data.issign	integer	今天是否已签到：1 已签，0 未签
data.gold	integer	本次签到可得金币数（连续满 N 天会含额外奖励）

正文

无

参数

响应输出

返回参数

见上方「基础信息」- 返回参数表格

{"code":1,"msg":"","data":{"issign":0,"gold":10}}

无

GET 领红包 /api/wallet/acceptRed

领红包

用户根据红包ID领取该红包中的一份金额，每人仅可领取一次。需登录且已设置钱包支付密码。

群红包且开启限领时（type=1、redpacket_limit=1）：用户须在群白名单且为群主或管理员方可领取。红包有效期为 24 小时。

Headers

无

参数

名称	类型	必选	描述
redid	string	是	红包ID，对应 yl_wallet_red.id，要领取的红包唯一标识

正文

无

参数

响应输出

返回参数

成功时 data 包含：

isGetDone (boolean)：该红包是否已被领完
receiveMoney (number)：本次领取的金额

{
  "code": 1,
  "msg": "红包已领取",
  "data": {
    "isGetDone": false,
    "receiveMoney": 1.25
  }
}

GET 发红包 /api/wallet/giveRed

发红包

用户扣减钱包余额创建红包，可发单人红包或群红包；需登录、已设置钱包支付密码，且配置 client_redpacket=1 时开放。总金额按 count 份预分配，支持平分或随机金额。

Headers

无

参数

名称	类型	必选	描述
type	string	是	红包类型：0=单人，1=群红包
recv_id	string	是	接收方ID（单人=对方 user_id，群=群 ID）
count	int	是	红包个数（拆成几份）
amount	float	是	红包总金额（元），每份至少 0.01 元
password	string	是	钱包支付密码
words	string	否	祝福语，默认「恭喜发财大吉大利」
rand	string	否	金额分配：0=平分，1=随机，默认 0

正文

无

参数

type

recv_id

count

amount

password

words

rand

响应输出

返回参数

成功时 data 包含：

redid (int/string)：红包ID，用于领红包接口及展示
words (string)：祝福语

{
  "code": 1,
  "msg": "红包已发送",
  "data": {
    "redid": 12345,
    "words": "恭喜发财 大吉大利"
  }
}

GET 修改用户密保问题 /api/wallet/modifyAnswer

修改用户密保问题

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 设置用户密保问题 /api/wallet/setAnswer

设置用户密保问题

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 查询密保问题列表 /api/wallet/questionList

查询密保问题列表

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 设置支付密码 /api/wallet/setPass

设置支付密码

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 账单查询 /api/wallet/billList

账单查询

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 提现申请 /api/wallet/withdraw

提现申请

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 充值（新版） /api/wallet/rechargenew

充值（新版）。提交充值金额与支付方式，创建充值订单并获取支付参数（当前实现为支付宝），用于调起支付。需已登录且已设置钱包密码；若后台关闭充值功能则不可用。

Headers

无

参数

名称	类型	必选	描述
amount	number	是	充值金额
type	string	否	支付类型：0=支付宝，1=微信
channel	string	否	与 type 二选一。支付渠道：alipay=支付宝，wx=微信

正文

无

参数

amount

type

channel

响应输出

返回参数

成功时 data 为支付参数（如支付宝订单信息等），用于客户端调起支付；需审核或异步回调后到账。未设置钱包密码时提示设置。

无

GET 充值 /api/wallet/recharge

充值

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 余额查看 /api/wallet/detail

余额查看

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 修改密码 /api/wallet/modifyPass

修改密码

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 密保问题重置密码 /api/wallet/resetWalletPassEx

密保问题重置密码

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

无

无

GET 重置密码 /api/wallet/resetPass

重置密码

Headers

无

参数

名称	类型	必选	描述
account	string	是	注册账号（需与当前登录账号一致）
password	string	是	新的钱包密码，长度必须为6位

正文

无

参数

account

password

响应输出

返回参数

无

无

GET 可参与红包列表 /api/wallet/redPackageJoin

可参与红包列表。查询当前未领完、未退款的红包（left>0 且 refundtime=0），并同步 Redis 中的红包信息与可领金额队列，供抢红包使用。无需登录即可调用。

Headers

无

参数

无（无需传参）

正文

无

参数

响应输出

返回参数

直接返回红包记录数组（JSON）。每条记录包含红包表 yl_wallet_red 的字段，如 id、剩余个数 left、剩余金额 leftamount、类型 type、接收方 recv_id 等，具体以实际返回为准。

无

朋友圈

POST 发布分享 /api/friend/add

发布朋友圈分享内容，支持文字和图片

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

名称	类型	必选	描述
content	string	否	分享内容文字
lng	string	否	经度
lat	string	否	纬度
address	string	否	地址信息
visible	string	否	可见性设置
files	file	否	上传的图片文件，最多6张

正文

无

Headers

token

参数

content

lng

lat

address

visible

files

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳

{
	 "code": 1,
	 "msg": "分享成功",
	 "time": "1707292800"
	 }

POST 发布视频 /api/friend/addvideo

发布朋友圈视频内容

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

名称	类型	必选	描述
content	string	否	视频描述内容
files	file	是	上传的视频文件(mp3格式

正文

无

Headers

token

参数

content

files

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳

{
	 "code": 1,
	 "msg": "分享成功",
	 "time": "1707292800"
	 }

POST 删除分享 /api/friend/delete

删除用户自己发布的朋友圈分享

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

名称	类型	必选	描述
fsid	integer	是	分享ID

正文

无

Headers

token

参数

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳

{
	 "code": 1,
	 "msg": "删除成功",
	 "time": "1707292800"
	 }

GET 分享详细 /api/friend/detail

获取指定分享的详细信息，包括回复和点赞列表

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

名称	类型	必选	描述
fsid	integer	是	分享ID

正文

无

Headers

token

参数

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳
data	object	分享详细信息
data.id	integer	分享ID
data.user_id	integer	用户ID
data.nickname	string	用户昵称
data.content	string	分享内容
data.replylist	array	回复列表
data.praiselist	array	点赞列表

{
	 "code": 1,
	 "msg": "",
	 "time": "1707292800",
	 "data": {
	 "id": 1,
	 "user_id": 123,
	 "nickname": "用户昵称",
	 "content": "这是一条朋友圈",
	 "replylist": [],
	 "praiselist": []
	 }
	 }

POST 点赞/取消点赞 /api/friend/sharePraise

对朋友圈分享进行点赞或取消点赞操作

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

名称	类型	必选	描述
fsid	integer	是	分享ID

正文

无

Headers

token

参数

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳

{
	 "code": 1,
	 "msg": "赞成功",
	 "time": "1707292800"
	 }

POST 回复分享 /api/friend/shareReply

对朋友圈分享进行回复

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

名称	类型	必选	描述
fsid	integer	是	分享ID
fuid	integer	是	被回复用户ID
content	string	是	回复内容

正文

无

Headers

token

参数

fsid

fuid

content

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳

{
	 "code": 1,
	 "msg": "回复成功",
	 "time": "1707292800"
	 }

POST 删除回复 /api/friend/deletereply

删除用户自己的回复

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

名称	类型	必选	描述
replyid	integer	是	回复ID

正文

无

Headers

token

参数

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳

{
	 "code": 1,
	 "msg": "删除成功",
	 "time": "1707292800"
	 }

POST 设置朋友圈封面 /api/friend/setCover

设置用户朋友圈背景封面图片

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

名称	类型	必选	描述
file	file	是	封面图片文件

正文

无

Headers

token

参数

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳
data	object	返回数据
data.cover	string	封面图片URL

{
	 "code": 1,
	 "msg": "设置成功",
	 "time": "1707292800",
	 "data": {
	 "cover": "http://example.com/cover.jpg"
	 }
	 }

GET 获取朋友圈封面 /api/friend/getCover

获取用户朋友圈背景封面图片

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

无

正文

无

Headers

token

参数

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳
data	array	封面信息列表

{
	 "code": 1,
	 "msg": "获取成功",
	 "time": "1707292800",
	 "data": [
	 {
	 "uid": 123,
	 "cover": "http://example.com/cover.jpg",
	 "createtime": 1707292800
	 }
	 ]
	 }

GET 获取用户信息 /api/friend/getUser

获取指定用户的基本信息和朋友圈封面

Headers

无

参数

名称	类型	必选	描述
uid	integer	是	用户ID

正文

无

参数

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳
data	object	用户信息
data.uid	integer	用户ID
data.nickname	string	用户昵称
data.avatar	string	用户头像
data.signature	string	个人签名
data.cover	string	朋友圈封面

{
	 "code": 1,
	 "msg": "",
	 "time": "1707292800",
	 "data": {
	 "uid": 123,
	 "nickname": "用户昵称",
	 "avatar": "http://example.com/avatar.jpg",
	 "signature": "个人签名",
	 "cover": "http://example.com/cover.jpg"
	 }
	 }

GET 朋友圈列表 /api/friend/shareList

获取朋友圈分页列表，支持权限过滤和分页查询

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

名称	类型	必选	描述
page	integer	否	页码，默认为1
pageSize	integer	否	每页数量，默认为10，最大50
fsid	integer	否	指定分享ID，用于查询单条记录
sinceID	integer	否	获取ID大于此值的记录（兼容旧版）
maxID	integer	否	获取ID小于此值的记录（兼容旧版）

正文

无

Headers

token

参数

page

pageSize

fsid

sinceID

maxID

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳
data	object	返回数据对象
data.data	array	朋友圈列表数据
data.pagination	object	分页信息对象
data.pagination.current_page	integer	当前页码
data.pagination.page_size	integer	每页数量
data.pagination.total	integer	总记录数
data.pagination.total_pages	integer	总页数

{
	 "code": 1,
	 "msg": "",
	 "time": "1707292800",
	 "data": {
	 "data": [
	 {
	 "id": 1,
	 "user_id": 123,
	 "nickname": "用户昵称",
	 "avatar": "http://example.com/avatar.jpg",
	 "headsmall": "http://example.com/avatar.jpg",
	 "content": "这是一条朋友圈",
	 "picture": [],
	 "video": [],
	 "lng": "116.404",
	 "lat": "39.915",
	 "address": "北京市",
	 "praises": 5,
	 "replys": 3,
	 "ispraise": 0,
	 "createtime": 1707292800,
	 "replylist": [],
	 "praiselist": []
	 }
	 ],
	 "pagination": {
	 "current_page": 1,
	 "page_size": 10,
	 "total": 100,
	 "total_pages": 10
	 }
	 }
	 }

GET 用户相册 /api/friend/userAlbum

获取用户相册分页列表

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

名称	类型	必选	描述
page	integer	否	页码，默认为1
pageSize	integer	否	每页数量，默认为10，最大50
fuid	integer	否	查看的用户ID，不传则查看自己

正文

无

Headers

token

参数

page

pageSize

fuid

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳
data	object	返回数据对象
data.data	array	相册列表数据
data.pagination	object	分页信息对象
data.pagination.current_page	integer	当前页码
data.pagination.page_size	integer	每页数量
data.pagination.total	integer	总记录数
data.pagination.total_pages	integer	总页数

{
	 "code": 1,
	 "msg": "",
	 "time": "1707292800",
	 "data": {
	 "data": [
	 {
	 "id": 1,
	 "user_id": 123,
	 "nickname": "用户昵称",
	 "avatar": "http://example.com/avatar.jpg",
	 "headsmall": "http://example.com/avatar.jpg",
	 "content": "这是一条朋友圈",
	 "picture": [],
	 "video": [],
	 "lng": "116.404",
	 "lat": "39.915",
	 "address": "北京市",
	 "praises": 5,
	 "replys": 3,
	 "ispraise": 0,
	 "createtime": 1707292800,
	 "replylist": [],
	 "praiselist": []
	 }
	 ],
	 "pagination": {
	 "current_page": 1,
	 "page_size": 10,
	 "total": 100,
	 "total_pages": 10
	 }
	 }
	 }

GET 朋友圈未读数量 /api/friend/friendNum

获取用户朋友圈未读的点赞和回复数量

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

无

正文

无

Headers

token

参数

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	未读数量
time	string	服务器时间戳

{
	 "code": 1,
	 "msg": "5",
	 "time": "1707292800"
	 }

POST 删除文件 /api/friend/deleteFile

递归删除目录及其所有文件

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳

{
	 "code": 1,
	 "msg": "删除成功",
	 "time": "1707292800"
	 }

GET 朋友圈未读消息详情 /api/friend/friendNoRead

获取用户朋友圈未读的点赞和回复详细列表

Headers

名称	类型	必选	描述
token	string	是	登录Token

参数

无

正文

无

Headers

token

参数

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳
data	array	未读消息列表
data[].type	integer	消息类型：1-点赞，2-回复
data[].fsid	integer	分享ID
data[].content	string	回复内容(仅回复类型有
data[].createtime	integer	创建时间
data[].uid	integer	操作用户ID
data[].nickname	string	操作用户昵称

{
	 "code": 1,
	 "msg": "",
	 "time": "1707292800",
	 "data": [
	 {
	 "type": 1,
	 "fsid": 123,
	 "content": null,
	 "createtime": 1707292800,
	 "uid": 456,
	 "nickname": "操作用户昵称",
	 "avatar": "http://example.com/avatar.jpg"
	 }
	 ]
	 }

GET 所有朋友圈列表 /api/friend/shareAllList

获取所有用户的朋友圈分享列表

Headers

无

参数

无

正文

无

参数

响应输出

返回参数

名称	类型	描述
code	integer	状态码，1表示成功
msg	string	提示信息
time	string	服务器时间戳
data	array	朋友圈列表数据

{
	 "code": 1,
	 "msg": "",
	 "time": "1707292800",
	 "data": []
	 }

邮箱验证码接口

GET 发送验证码 /api/ems/send

GET 检测验证码 /api/ems/check

朋友圈接口

GET 朋友圈分享记录 /api/friend/public_list

手机短信接口

POST 发送短信验证码 /api/sms/send

POST 检测验证码 /api/sms/check

群组接口

POST 创建群组 /api/team/create

GET 设置群消息撤回 /api/team/setTeamRecall

GET 群红包白名单 /api/team/redpacketWhiteList

GET 红包限制 状态 /api/team/getRedPacketLimit

GET 红包限制 开启/关闭 /api/team/redPacketLimit

GET 设置群是否允许撤回 /api/team/setIsRecall

GET 获取群是否允许撤回 /api/team/getIsRecall

GET 获取群到期时间 /api/team/getExpiresTime

GET 清除群聊天记录校验 /api/team/clearTeamMessage

POST 修改群配置 /api/team/setTeamAllSetting

GET 获取指定群配置 /api/team/getTeamAllSetting

GET 设置群内普通成员能否发口令红包 /api/team/setTeamRed

POST 解散群组 /api/team/destory

GET 设置群是否允许私下交流 /api/team/setTeamPrivate

GET 获取群设置详情 /api/team/getTeamSetting

GET 获取群基数/虚拟群人数 /api/team/getTeamBaseNum

GET 创建群人数限制 /api/team/getTeamMaxNum

GET 修改群成员权限 /api/team/modifymemberauthority

GET 获取群成员权限 /api/team/getmemberauthority

GET 查询客服ID /api/team/teamservice

GET 修改群客服 /api/team/modifyservice

GET 修改群主 /api/team/modifyowner

POST 修改群组信息 /api/team/modifyname

GET 群红包白名单处理 /api/team/handleRedpacketWhiteList

GET 群分组列表 /api/team_group/list

POST 创建群分组 /api/team_group/create

POST 修改群分组 /api/team_group/update

POST 删除群分组 /api/team_group/delete

POST 设置单个群分组 /api/team_group/set_team_group

POST 批量设置群分组 /api/team_group/batch_set_team_group

GET 群分组映射 /api/team_group/map

Token接口

GET 检测Token是否过期 /api/token/check

GET 刷新Token /api/token/refresh

Trtc接口

GET 通过 Token 获取用户信息和 UserSig /api/trtc/getUserInfo

GET 获取 UserSig /api/trtc/getUserSig

GET 发起通话 /api/trtc/startCall

GET 接听通话 /api/trtc/acceptCall

GET 拒绝通话 /api/trtc/rejectCall

GET 结束通话 /api/trtc/endCall

聊天接口

GET 用户清除聊天记录校验 /api/user/clearUserMessage

GET 上传聊天图片文件 /api/user/uploadChatImage

GET 上传聊天图片 /api/user/saveChatImg

GET 发送图片消息 /api/user/sendImg

POST 获取用户状态及上次登录时间 /api/user/getPreleavetime

GET 获取好友聊天记录删除权限 /api/user/getFriendDeleteChatPermission

POST 设置好友聊天记录删除权限 /api/user/setFriendDeleteChatPermission

会员接口

POST 会员登录 /api/user/login

GET 重置密码 /api/user/resetpwd

GET 上传头像 /api/user/saveAvatar

GET 获取用户好友设置 /api/user/getUserSetup

GET 设置用户好友设置 /api/user/setUserSetup

GET 解绑/更换手机号 /api/user/unbindingmobile

GET 生成账号签名 /api/user/createSign

GET 获取超级会员列表 /api/user/getSupMemberList

GET 获取用户最后登录信息 /api/user/getUserLastLoginId

GET 上传图片 /api/user/uploadImage

GET 修改手机号 /api/user/changemobile

POST 会员注册 /api/user/register

GET 修改邮箱 /api/user/changeemail

GET 修改会员个人信息 /api/user/profile

GET 注销登录 /api/user/logout

GET 添加好友 /api/user/addFriend

GET 修改密码 /api/user/modifyPass

GET 删除好友 /api/user/deleteFriend

GET 是否允许加好友 /api/user/checkAddFriendEx

GET 编辑用户信息 /api/user/edit

GET 用户信息 /api/user/detail

GET 红包限制状态 /api/team/getRedPacketLimit

GET 红包限制开启/关闭 /api/team/redPacketLimit