1 用户操作
1.1 设置加好友验证方式
PUT /user/authmode
POST /user/authmode
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| value | int32 | true | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.2 设置头像
PUT /user/avatar
POST /user/avatar
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| avatar | string | true | 头像 url |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.3 批量设置头像
PUT /user/avatar/batch
POST /user/avatar/batch
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| list | array[object] | false | ||
| ⇥ avatar | string | true | 头像 url | |
| ⇥ user_id | int64 | true | 用户ID |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | array[object] | 结果数据 |
| ⇥ reason | string | 失败原因 |
| ⇥ success | boolean | 是否成功 |
| ⇥ user_id | int64 | 用户ID |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.4 修改密码
POST /user/change_password
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| new_password | string | true | 新密码 | |
| old_password | string | true | 旧密码 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.5 管理员修改密码
POST /user/change_password_admin
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| password | string | true | 密码 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.6 删除用户
DELETE /user/delete
POST /user/delete
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| password | string | false | 用户密码：如果是用户TOKEN,需要设置此字段；如果是管理员TOKEN则不需设置 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.7 设备列表
GET /user/device/list
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| cursor | string | 游标，返回结果中缺失 cursor，表示已经返回最后一页 |
| data | array[object] | 结果数据 |
| ⇥ device_sn | int32 | 设备序号 |
| ⇥ platform | int32 | 设备平台, 1:ios, 2:android, 3:windows, 4:mac, 5:linux, 6:web |
| ⇥ user_agent | string | 设备信息 |
| ⇥ user_id | int64 | 用户 ID |
| message | string | 错误信息，如果成功，该项为null |
| version | int64 | 版本 |
接口描述
1.8 删除device
DELETE /user/device/remove
POST /user/device/remove
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| device_sn | int32 | true | 设备序号 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.9 封禁用户
PUT /user/disable
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| list | array[int64] | true | 用户ID列表 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.10 设置是否自动下载缩略图和文件
PUT /user/download
POST /user/download
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| value | boolean | true | 是否自动下载缩略图和文件： true - 是， false - 否 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.11 解禁用户
PUT /user/enable
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| list | array[int64] | true | 用户ID列表 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.12 踢指定设备下线
PUT /user/kick
POST /user/kick
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| device_sn | int32 | false | 设备序号：不设置表示踢所有设备 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.13 列出APP下所有用户
GET /user/list
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| page_num | int32 | false | 页数：必须大于0，默认为1 |
| page_size | int32 | false | 每页大小：默认每页50条 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | array[object] | 结果数据 |
| ⇥ status | int32 | 0-正常，1-封禁 |
| ⇥ user_id | int64 | 用户ID |
| ⇥ username | string | 用户名 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.14 设置手机号码
PUT /user/mobile
POST /user/mobile
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| mobile | string | true | 手机号码 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.15 设置昵称
PUT /user/nickname
POST /user/nickname
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| nick_name | string | true | 昵称 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.16 查询用户在线状态
GET /user/online_status
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | object | 结果数据 |
| ⇥ online | boolean | 是否在线： true - 在线 ，false - 离线 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.17 设置私有扩展信息
PUT /user/private
POST /user/private
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| string | true | 私有扩展信息 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.18 获取用户信息
GET /user/profile
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | object | 结果数据 |
| ⇥ avatar | string | 头像 url |
| ⇥ description | string | 描述信息 |
| string | 邮箱 | |
| ⇥ mobile | string | 手机号码 |
| ⇥ nick_name | string | 昵称 |
| ⇥ private_info | string | 私有信息，仅自己可见 |
| ⇥ public_info | string | 公开信息，好友和陌生人可见 |
| ⇥ user_id | int64 | 用户ID |
| ⇥ username | string | 用户名 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.19 更新用户信息
PUT /user/profile
POST /user/profile
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| description | string | false | 描述信息 | |
| nick_name | string | false | 昵称 | |
| private_info | string | false | 私有信息，仅自己可见 | |
| public_info | string | false | 公开信息，好友和陌生人可见 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.20 批量更新用户信息
PUT /user/profile/batch
POST /user/profile/batch
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| list | array[object] | false | ||
| ⇥ description | string | false | 描述信息 | |
| ⇥ nick_name | string | false | 昵称 | |
| ⇥ private_info | string | false | 私有信息，仅自己可见 | |
| ⇥ public_info | string | false | 公开信息，好友和陌生人可见 | |
| ⇥ user_id | int64 | false | 用户ID |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | array[object] | 结果数据 |
| ⇥ reason | string | 失败原因 |
| ⇥ success | boolean | 是否成功 |
| ⇥ user_id | int64 | 用户ID |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.21 设置公开扩展信息
PUT /user/public
POST /user/public
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| string | true | 公开扩展信息 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.22 设置是否关闭推送
PUT /user/push
POST /user/push
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| value | boolean | true | 是否关闭推送： true - 关闭推送， false - 不关闭推送 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.23 绑定别名
POST /user/push/alias
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| alias | string | true | 别名 | |
| push_token | string | false | 推送token |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.24 设置badge
POST /user/push/badge
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| badge | int32 | true | badge |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.25 设置是否关闭推送详情
PUT /user/push/detail
POST /user/push/detail
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| value | boolean | true | 是否关闭推送详情: true - 关闭推送详情, false - 不关闭推送详情 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.26 设置推送免打扰时间
PUT /user/push/limit
POST /user/push/limit
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| no_push_end_hour | int32 | true | 推送免打扰结束的小时（0-23） |
| no_push_start_hour | int32 | true | 推送免打扰开始的小时（0-23） |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.27 设置推送昵称
PUT /user/push/nickname
POST /user/push/nickname
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| value | string | true | 推送昵称 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.28 获取标签
GET /user/push/tag
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | array[string] | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.29 绑定标签
POST /user/push/tag
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| tags | array[string] | true | 标签列表 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.30 解绑标签
DELETE /user/push/tag
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| tags | array[string] | true | 标签列表 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.31 删除所有标签
DELETE /user/push/tag/all
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.32 批量注册用户
POST /user/register/batch
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| list | array[object] | false | ||
| ⇥ password | string | true | 密码 | |
| ⇥ username | string | true | 用户名 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | array[object] | 结果数据 |
| ⇥ reason | string | 失败原因 |
| ⇥ success | boolean | 是否成功 |
| ⇥ user_id | int64 | 用户ID |
| ⇥ username | string | 用户名 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.33 注册推送用户
POST /user/register/push
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| alias | string | false | 别名 | |
| device_guid | string | false | 设备ID | |
| password | string | true | 密码 | |
| push_token | string | false | 推送token | |
| sign | string | false | 签名 | |
| username | string | true | 用户名 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | object | 结果数据 |
| ⇥ auth_answer | string | 验证问题答案 |
| ⇥ auth_mode | int32 | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请 |
| ⇥ auth_question | string | 验证问题 |
| ⇥ auto_download | boolean | 是否自动下载: true - 自动下载, false - 不自动下载 |
| ⇥ group_confirm | boolean | 邀请入群时是否需要用户确认: true - 需要用户同意才可加入， false - 自动同意邀请 |
| ⇥ id | int64 | |
| ⇥ no_push | boolean | 是否关闭推送消息: true - 关闭推送消息, false - 不关闭推送消息 |
| ⇥ no_push_detail | boolean | 是否推送详情: true - 推送详情, false - 不推送详情 |
| ⇥ no_push_end_hour | int32 | 推送免打扰结束时间（小时 0-23） |
| ⇥ no_push_start_hour | int32 | 推送免打扰开始时间（小时 0-23） |
| ⇥ no_sounds | boolean | 收到消息时是否静音: true - 静音, false - 不静音 |
| ⇥ push_nick_name | string | 推送昵称 |
| ⇥ push_token | string | 推送token |
| ⇥ silence_end_time | int32 | 推送不提醒结束时间（小时 0-23） |
| ⇥ silence_start_time | int32 | 推送不提醒开始时间（小时 0-23） |
| ⇥ user_id | int64 | 用户ID |
| ⇥ vibratory | boolean | 收到消息时否振动: true - 振动， false - 不振动 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.34 注册用户
POST /user/register/v2
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| password | string | true | 密码 | |
| username | string | true | 用户名 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | object | 结果数据 |
| ⇥ auth_answer | string | 验证问题答案 |
| ⇥ auth_mode | int32 | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请 |
| ⇥ auth_question | string | 验证问题 |
| ⇥ auto_download | boolean | 是否自动下载: true - 自动下载, false - 不自动下载 |
| ⇥ group_confirm | boolean | 邀请入群时是否需要用户确认: true - 需要用户同意才可加入， false - 自动同意邀请 |
| ⇥ id | int64 | |
| ⇥ no_push | boolean | 是否关闭推送消息: true - 关闭推送消息, false - 不关闭推送消息 |
| ⇥ no_push_detail | boolean | 是否推送详情: true - 推送详情, false - 不推送详情 |
| ⇥ no_push_end_hour | int32 | 推送免打扰结束时间（小时 0-23） |
| ⇥ no_push_start_hour | int32 | 推送免打扰开始时间（小时 0-23） |
| ⇥ no_sounds | boolean | 收到消息时是否静音: true - 静音, false - 不静音 |
| ⇥ push_nick_name | string | 推送昵称 |
| ⇥ push_token | string | 推送token |
| ⇥ silence_end_time | int32 | 推送不提醒结束时间（小时 0-23） |
| ⇥ silence_start_time | int32 | 推送不提醒开始时间（小时 0-23） |
| ⇥ user_id | int64 | 用户ID |
| ⇥ vibratory | boolean | 收到消息时否振动: true - 振动， false - 不振动 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.35 获取用户设置
GET /user/settings
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | object | 结果数据 |
| ⇥ auth_answer | string | 验证问题答案 |
| ⇥ auth_mode | int32 | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请 |
| ⇥ auth_question | string | 验证问题 |
| ⇥ auto_download | boolean | 是否自动下载: true - 自动下载, false - 不自动下载 |
| ⇥ group_confirm | boolean | 邀请入群时是否需要用户确认: true - 需要用户同意才可加入， false - 自动同意邀请 |
| ⇥ id | int64 | |
| ⇥ no_push | boolean | 是否关闭推送消息: true - 关闭推送消息, false - 不关闭推送消息 |
| ⇥ no_push_detail | boolean | 是否推送详情: true - 推送详情, false - 不推送详情 |
| ⇥ no_push_end_hour | int32 | 推送免打扰结束时间（小时 0-23） |
| ⇥ no_push_start_hour | int32 | 推送免打扰开始时间（小时 0-23） |
| ⇥ no_sounds | boolean | 收到消息时是否静音: true - 静音, false - 不静音 |
| ⇥ push_nick_name | string | 推送昵称 |
| ⇥ push_token | string | 推送token |
| ⇥ silence_end_time | int32 | 推送不提醒结束时间（小时 0-23） |
| ⇥ silence_start_time | int32 | 推送不提醒开始时间（小时 0-23） |
| ⇥ user_id | int64 | 用户ID |
| ⇥ vibratory | boolean | 收到消息时否振动: true - 振动， false - 不振动 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.36 修改用户设置
PUT /user/settings
POST /user/settings
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| auth_answer | string | false | 验证问题答案 | |
| auth_mode | int32 | false | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请 | |
| auth_question | string | false | 验证问题 | |
| auto_download | boolean | false | 是否自动下载: true - 自动下载, false - 不自动下载 | |
| group_confirm | boolean | false | 邀请入群时是否需要用户确认: true - 需要用户同意才可加入， false - 自动同意邀请 | |
| id | int64 | false | ||
| no_push | boolean | false | 是否关闭推送消息: true - 关闭推送消息, false - 不关闭推送消息 | |
| no_push_detail | boolean | false | 是否推送详情: true - 推送详情, false - 不推送详情 | |
| no_push_end_hour | int32 | false | 推送免打扰结束时间（小时 0-23） | |
| no_push_start_hour | int32 | false | 推送免打扰开始时间（小时 0-23） | |
| no_sounds | boolean | false | 收到消息时是否静音: true - 静音, false - 不静音 | |
| push_nick_name | string | false | 推送昵称 | |
| push_token | string | false | 推送token | |
| silence_end_time | int32 | false | 推送不提醒结束时间（小时 0-23） | |
| silence_start_time | int32 | false | 推送不提醒开始时间（小时 0-23） | |
| user_id | int64 | true | 用户ID | |
| vibratory | boolean | false | 收到消息时否振动: true - 振动， false - 不振动 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.37 设置新消息是否关闭声音提醒
PUT /user/sounds
POST /user/sounds
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| value | boolean | true | 是否关闭声音提醒: true - 关闭声音提醒, false - 不关闭声音提醒 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.38 绑定token
PUT /user/token/bind
POST /user/token/bind
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求体(Request Body)
| 参数名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| device_sn | int32 | true | 设备序号 | |
| device_token | string | true | device token | |
| notifier_name | string | true | 证书名称 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.39 解绑token
DELETE /user/token/unbind
POST /user/token/unbind
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| deviceSn | int32 | true | 设备序号 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | object | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.40 修改用户名
PUT /user/username
POST /user/username
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| username | string | true | 用户名 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |
接口描述
1.41 设置新消息是否振动
PUT /user/vibratory
POST /user/vibratory
请求头
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | 令牌 |
| app_id | string | true | 应用ID |
| group_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 |
| user_id | int64 | false | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 |
请求参数(Query Param)
| 参数名称 | 数据类型 | 必填 | 描述 |
|---|---|---|---|
| value | boolean | true | 是否振动： true-振动, false-不振动 |
响应体
● 200 响应数据格式：JSON
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int32 | 返回码，200是成功 |
| data | boolean | 结果数据 |
| message | string | 错误信息，如果成功，该项为null |