设备列表
基本信息
Path: /user/device/list
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
cursor | string | 非必须 | 游标,返回结果中缺失 cursor,表示已经返回最后一页 | ||
data | object [] | 非必须 | 结果数据 | item 类型: object | |
├─ device_sn | integer | 非必须 | format: int32 | ||
├─ platform | integer | 非必须 | 设备平台, 1:ios, 2:android, 3:windows, 4:mac, 5:linux, 6:web | format: int32 | |
├─ user_agent | string | 非必须 | |||
├─ user_id | integer | 非必须 | 用户 ID | format: int64 | |
message | string | 非必须 | 错误信息,如果成功,该项为null | ||
version | integer | 非必须 | 版本 | format: int64 |
修改密码
基本信息
Path: /user/change_password
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
new_password | string | 非必须 | new_password 新密码 | ||
old_password | string | 非必须 | old_password 旧密码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
修改用户名
基本信息
Path: /user/username
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
username | 是 | username |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
修改用户设置
基本信息
Path: /user/settings
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
auth_answer | string | 非必须 | 验证问题答案 | ||
auth_mode | integer | 非必须 | 验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请 | format: int32 | |
auth_question | string | 非必须 | 验证问题 | ||
auto_download | boolean | 非必须 | 是否自动下载 | ||
group_confirm | boolean | 非必须 | 邀请入群时是否需要用户确认: true - 需要用户同意才可加入, false - 自动同意邀请 | ||
id | integer | 非必须 | format: int64 | ||
no_push | boolean | 非必须 | 是否关闭推送消息 | ||
no_push_detail | boolean | 非必须 | 是否推送详情 | ||
no_push_end_hour | integer | 非必须 | 推送免打扰结束时间 | format: int32 | |
no_push_start_hour | integer | 非必须 | 推送免打扰开始时间 | format: int32 | |
no_sounds | boolean | 非必须 | 收到消息时是否静音 | ||
push_nick_name | string | 非必须 | 推送昵称 | ||
push_token | string | 非必须 | 推送token | ||
silence_end_time | integer | 非必须 | 推送不提醒结束时间 | format: int32 | |
silence_start_time | integer | 非必须 | 推送不提醒开始时间 | format: int32 | |
user_id | integer | 必须 | 用户ID | format: int64 | |
vibratory | boolean | 非必须 | 收到消息时否振动 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
修改用户设置
基本信息
Path: /user/settings
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
auth_answer | string | 非必须 | 验证问题答案 | ||
auth_mode | integer | 非必须 | 验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请 | format: int32 | |
auth_question | string | 非必须 | 验证问题 | ||
auto_download | boolean | 非必须 | 是否自动下载 | ||
group_confirm | boolean | 非必须 | 邀请入群时是否需要用户确认: true - 需要用户同意才可加入, false - 自动同意邀请 | ||
id | integer | 非必须 | format: int64 | ||
no_push | boolean | 非必须 | 是否关闭推送消息 | ||
no_push_detail | boolean | 非必须 | 是否推送详情 | ||
no_push_end_hour | integer | 非必须 | 推送免打扰结束时间 | format: int32 | |
no_push_start_hour | integer | 非必须 | 推送免打扰开始时间 | format: int32 | |
no_sounds | boolean | 非必须 | 收到消息时是否静音 | ||
push_nick_name | string | 非必须 | 推送昵称 | ||
push_token | string | 非必须 | 推送token | ||
silence_end_time | integer | 非必须 | 推送不提醒结束时间 | format: int32 | |
silence_start_time | integer | 非必须 | 推送不提醒开始时间 | format: int32 | |
user_id | integer | 必须 | 用户ID | format: int64 | |
vibratory | boolean | 非必须 | 收到消息时否振动 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
删除device
基本信息
Path: /user/device/remove
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
device_sn | 是 | device_sn |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
删除device
基本信息
Path: /user/device/remove
Method: DELETE
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
device_sn | 是 | device_sn |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
删除所有标签
基本信息
Path: /user/push/tag/all
Method: DELETE
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
批量更新用户信息
基本信息
Path: /user/profile/batch
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
list | object [] | 非必须 | item 类型: object | ||
├─ description | string | 非必须 | 描述信息 | ||
├─ nick_name | string | 非必须 | 昵称 | ||
├─ private_info | string | 非必须 | 私有信息,仅自己可见 | ||
├─ public_info | string | 非必须 | 公开信息,好友和陌生人可见 | ||
├─ user_id | integer | 非必须 | 用户ID | format: int64 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | object [] | 非必须 | 结果数据 | item 类型: object | |
├─ reason | string | 非必须 | 失败原因 | ||
├─ success | boolean | 非必须 | 是否成功 | ||
├─ user_id | integer | 非必须 | 用户ID | format: int64 | |
message | string | 非必须 | 错误信息,如果成功,该项为null |
批量更新用户信息
基本信息
Path: /user/profile/batch
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
list | object [] | 非必须 | item 类型: object | ||
├─ description | string | 非必须 | 描述信息 | ||
├─ nick_name | string | 非必须 | 昵称 | ||
├─ private_info | string | 非必须 | 私有信息,仅自己可见 | ||
├─ public_info | string | 非必须 | 公开信息,好友和陌生人可见 | ||
├─ user_id | integer | 非必须 | 用户ID | format: int64 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | object [] | 非必须 | 结果数据 | item 类型: object | |
├─ reason | string | 非必须 | 失败原因 | ||
├─ success | boolean | 非必须 | 是否成功 | ||
├─ user_id | integer | 非必须 | 用户ID | format: int64 | |
message | string | 非必须 | 错误信息,如果成功,该项为null |
批量注册用户
基本信息
Path: /user/register/batch
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
list | object [] | 非必须 | item 类型: object | ||
├─ password | string | 必须 | |||
├─ username | string | 必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | object [] | 非必须 | 结果数据 | item 类型: object | |
├─ reason | string | 非必须 | 失败原因 | ||
├─ success | boolean | 非必须 | 是否成功 | ||
├─ user_id | integer | 非必须 | 用户ID | format: int64 | |
├─ username | string | 非必须 | 用户名 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
批量设置头像
基本信息
Path: /user/avatar/batch
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
list | object [] | 非必须 | item 类型: object | ||
├─ avatar | string | 必须 | 头像 url | ||
├─ user_id | integer | 非必须 | 用户ID | format: int64 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | object [] | 非必须 | 结果数据 | item 类型: object | |
├─ reason | string | 非必须 | 失败原因 | ||
├─ success | boolean | 非必须 | 是否成功 | ||
├─ user_id | integer | 非必须 | 用户ID | format: int64 | |
message | string | 非必须 | 错误信息,如果成功,该项为null |
批量设置头像
基本信息
Path: /user/avatar/batch
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
list | object [] | 非必须 | item 类型: object | ||
├─ avatar | string | 必须 | 头像 url | ||
├─ user_id | integer | 非必须 | 用户ID | format: int64 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | object [] | 非必须 | 结果数据 | item 类型: object | |
├─ reason | string | 非必须 | 失败原因 | ||
├─ success | boolean | 非必须 | 是否成功 | ||
├─ user_id | integer | 非必须 | 用户ID | format: int64 | |
message | string | 非必须 | 错误信息,如果成功,该项为null |
更新用户信息
基本信息
Path: /user/profile
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
description | string | 非必须 | 描述信息 | ||
nick_name | string | 非必须 | 昵称 | ||
private_info | string | 非必须 | 私有信息,仅自己可见 | ||
public_info | string | 非必须 | 公开信息,好友和陌生人可见 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
更新用户信息
基本信息
Path: /user/profile
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
description | string | 非必须 | 描述信息 | ||
nick_name | string | 非必须 | 昵称 | ||
private_info | string | 非必须 | 私有信息,仅自己可见 | ||
public_info | string | 非必须 | 公开信息,好友和陌生人可见 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
注册推送用户
基本信息
Path: /user/register/push
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
alias | string | 非必须 | 别名 | ||
device_guid | string | 非必须 | 设备ID | ||
password | string | 必须 | |||
push_token | string | 非必须 | 推送token | ||
sign | string | 非必须 | 签名 | ||
username | string | 必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | object | 非必须 | 用户设置信息 | ||
├─ auth_answer | string | 非必须 | 验证问题答案 | ||
├─ auth_mode | integer | 非必须 | 验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请 | format: int32 | |
├─ auth_question | string | 非必须 | 验证问题 | ||
├─ auto_download | boolean | 非必须 | 是否自动下载 | ||
├─ group_confirm | boolean | 非必须 | 邀请入群时是否需要用户确认: true - 需要用户同意才可加入, false - 自动同意邀请 | ||
├─ id | integer | 非必须 | format: int64 | ||
├─ no_push | boolean | 非必须 | 是否关闭推送消息 | ||
├─ no_push_detail | boolean | 非必须 | 是否推送详情 | ||
├─ no_push_end_hour | integer | 非必须 | 推送免打扰结束时间 | format: int32 | |
├─ no_push_start_hour | integer | 非必须 | 推送免打扰开始时间 | format: int32 | |
├─ no_sounds | boolean | 非必须 | 收到消息时是否静音 | ||
├─ push_nick_name | string | 非必须 | 推送昵称 | ||
├─ push_token | string | 非必须 | 推送token | ||
├─ silence_end_time | integer | 非必须 | 推送不提醒结束时间 | format: int32 | |
├─ silence_start_time | integer | 非必须 | 推送不提醒开始时间 | format: int32 | |
├─ user_id | integer | 必须 | 用户ID | format: int64 | |
├─ vibratory | boolean | 非必须 | 收到消息时否振动 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
注册用户
基本信息
Path: /user/register/v2
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
password | string | 必须 | |||
username | string | 必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | object | 非必须 | 用户设置信息 | ||
├─ auth_answer | string | 非必须 | 验证问题答案 | ||
├─ auth_mode | integer | 非必须 | 验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请 | format: int32 | |
├─ auth_question | string | 非必须 | 验证问题 | ||
├─ auto_download | boolean | 非必须 | 是否自动下载 | ||
├─ group_confirm | boolean | 非必须 | 邀请入群时是否需要用户确认: true - 需要用户同意才可加入, false - 自动同意邀请 | ||
├─ id | integer | 非必须 | format: int64 | ||
├─ no_push | boolean | 非必须 | 是否关闭推送消息 | ||
├─ no_push_detail | boolean | 非必须 | 是否推送详情 | ||
├─ no_push_end_hour | integer | 非必须 | 推送免打扰结束时间 | format: int32 | |
├─ no_push_start_hour | integer | 非必须 | 推送免打扰开始时间 | format: int32 | |
├─ no_sounds | boolean | 非必须 | 收到消息时是否静音 | ||
├─ push_nick_name | string | 非必须 | 推送昵称 | ||
├─ push_token | string | 非必须 | 推送token | ||
├─ silence_end_time | integer | 非必须 | 推送不提醒结束时间 | format: int32 | |
├─ silence_start_time | integer | 非必须 | 推送不提醒开始时间 | format: int32 | |
├─ user_id | integer | 必须 | 用户ID | format: int64 | |
├─ vibratory | boolean | 非必须 | 收到消息时否振动 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
绑定token
基本信息
Path: /user/token/bind
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
device_sn | integer | 必须 | 设备SN | format: int32 | |
device_token | string | 必须 | device token | ||
notifier_name | string | 必须 | 证书名称 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
绑定token
基本信息
Path: /user/token/bind
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
device_sn | integer | 必须 | 设备SN | format: int32 | |
device_token | string | 必须 | device token | ||
notifier_name | string | 必须 | 证书名称 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
绑定别名
基本信息
Path: /user/push/alias
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
alias | string | 必须 | 别名 | ||
push_token | string | 非必须 | 推送token |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
绑定标签
基本信息
Path: /user/push/tag
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
tags | string [] | 非必须 | item 类型: string | ||
├─ | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
获取标签
基本信息
Path: /user/push/tag
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | string [] | 非必须 | 结果数据 | item 类型: string | |
├─ | 非必须 | ||||
message | string | 非必须 | 错误信息,如果成功,该项为null |
获取用户信息
基本信息
Path: /user/profile
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | object | 非必须 | 用户信息 | ||
├─ avatar | string | 非必须 | 头像 url | ||
├─ description | string | 非必须 | 描述信息 | ||
string | 非必须 | 邮箱 | |||
├─ mobile | string | 非必须 | 手机号码 | ||
├─ nick_name | string | 非必须 | 昵称 | ||
├─ private_info | string | 非必须 | 私有信息,仅自己可见 | ||
├─ public_info | string | 非必须 | 公开信息,好友和陌生人可见 | ||
├─ user_id | integer | 非必须 | 用户ID | format: int64 | |
├─ username | string | 非必须 | 用户名 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
获取用户设置
基本信息
Path: /user/settings
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | object | 非必须 | 用户设置信息 | ||
├─ auth_answer | string | 非必须 | 验证问题答案 | ||
├─ auth_mode | integer | 非必须 | 验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请 | format: int32 | |
├─ auth_question | string | 非必须 | 验证问题 | ||
├─ auto_download | boolean | 非必须 | 是否自动下载 | ||
├─ group_confirm | boolean | 非必须 | 邀请入群时是否需要用户确认: true - 需要用户同意才可加入, false - 自动同意邀请 | ||
├─ id | integer | 非必须 | format: int64 | ||
├─ no_push | boolean | 非必须 | 是否关闭推送消息 | ||
├─ no_push_detail | boolean | 非必须 | 是否推送详情 | ||
├─ no_push_end_hour | integer | 非必须 | 推送免打扰结束时间 | format: int32 | |
├─ no_push_start_hour | integer | 非必须 | 推送免打扰开始时间 | format: int32 | |
├─ no_sounds | boolean | 非必须 | 收到消息时是否静音 | ||
├─ push_nick_name | string | 非必须 | 推送昵称 | ||
├─ push_token | string | 非必须 | 推送token | ||
├─ silence_end_time | integer | 非必须 | 推送不提醒结束时间 | format: int32 | |
├─ silence_start_time | integer | 非必须 | 推送不提醒开始时间 | format: int32 | |
├─ user_id | integer | 必须 | 用户ID | format: int64 | |
├─ vibratory | boolean | 非必须 | 收到消息时否振动 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
解绑token
基本信息
Path: /user/token/unbind
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
deviceSn | 是 | deviceSn |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | object | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
解绑token
基本信息
Path: /user/token/unbind
Method: DELETE
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
deviceSn | 是 | deviceSn |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | object | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
解绑标签
基本信息
Path: /user/push/tag
Method: DELETE
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
tags | string [] | 非必须 | item 类型: string | ||
├─ | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
修改用户名
基本信息
Path: /user/username
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
username | 是 | username |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置badge
基本信息
Path: /user/push/badge
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
badge | integer | 必须 | badge | format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置公开扩展信息
基本信息
Path: /user/public
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
string | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置公开扩展信息
基本信息
Path: /user/public
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
string | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置加好友验证方式
基本信息
Path: /user/authmode
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置加好友验证方式
基本信息
Path: /user/authmode
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置头像
基本信息
Path: /user/avatar
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
avatar | string | 必须 | 头像 url |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置头像
基本信息
Path: /user/avatar
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
avatar | string | 必须 | 头像 url |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置手机号码
基本信息
Path: /user/mobile
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
mobile | 是 | mobile |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置手机号码
基本信息
Path: /user/mobile
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
mobile | 是 | mobile |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置推送免打扰时间
基本信息
Path: /user/push/limit
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
no_push_end_hour | 是 | no_push_end_hour | |
no_push_start_hour | 是 | no_push_start_hour |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置推送免打扰时间
基本信息
Path: /user/push/limit
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
no_push_end_hour | 是 | no_push_end_hour | |
no_push_start_hour | 是 | no_push_start_hour |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置推送昵称
基本信息
Path: /user/push/nickname
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置推送昵称
基本信息
Path: /user/push/nickname
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置新消息是否关闭声音提醒
基本信息
Path: /user/sounds
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置新消息是否关闭声音提醒
基本信息
Path: /user/sounds
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置新消息是否振动
基本信息
Path: /user/vibratory
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置新消息是否振动
基本信息
Path: /user/vibratory
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置是否关闭推送
基本信息
Path: /user/push
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置是否关闭推送
基本信息
Path: /user/push
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置是否关闭推送详情
基本信息
Path: /user/push/detail
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置是否关闭推送详情
基本信息
Path: /user/push/detail
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置是否自动下载缩略图和文件
基本信息
Path: /user/download
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置是否自动下载缩略图和文件
基本信息
Path: /user/download
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
value | 是 | value |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置昵称
基本信息
Path: /user/nickname
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
nick_name | 是 | nick_name |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置昵称
基本信息
Path: /user/nickname
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
nick_name | 是 | nick_name |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置私有扩展信息
基本信息
Path: /user/private
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
string | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
设置私有扩展信息
基本信息
Path: /user/private
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
string | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
踢指定设备下线
基本信息
Path: /user/kick
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
device_sn | 否 | 不传device_sn表示踢所有设备 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
踢指定设备下线
基本信息
Path: /user/kick
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
device_sn | 否 | 不传device_sn表示踢所有设备 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
封禁用户
基本信息
Path: /user/disable
Method: PUT
接口描述: 封禁用户,被封禁的用户无法登录IM。
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body |
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
list | 是 | 需要封禁的用户ID 列表 |
Example
{
"list": [
0
]
}
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
message | string | 非必须 | 错误信息,如果成功,该项为null< | ||
data | boolean | 非必须 | 结果数据 |
Example
{
"code": 0,
"data": true,
"message": "string"
}
解禁用户
基本信息
Path: /user/enable
Method: PUT
接口描述: 解除封禁用户,被解禁的用户恢复可以使用IM。
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
list | 是 | 需要封禁的用户ID 列表 |
Example
{
"list": [
0
]
}
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
message | string | 非必须 | 错误信息,如果成功,该项为null< | ||
data | boolean | 非必须 | 结果数据 |
Example
{
"code": 0,
"data": true,
"message": "string"
}