IM

  • IM > API 文档 > 服务端API > 用户操作

    用户操作

    最近更新时间:2021-06-29 09:47:59

    用户操作

    设备列表

    基本信息

    Path: /user/device/list

    Method: GET

    接口描述:

    请求参数

    Headers

    参数名称 参数值 是否必须 示例 备注
    access-token 令牌
    app_id 应用ID
    group_id 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口
    user_id 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    cursorstring非必须游标,返回结果中缺失 cursor,表示已经返回最后一页
    dataobject []非必须结果数据

    item 类型: object

    ├─ device_sninteger非必须

    format: int32

    ├─ platforminteger非必须设备平台, 1:ios, 2:android, 3:windows, 4:mac, 5:linux, 6:web

    format: int32

    ├─ user_agentstring非必须
    ├─ user_idinteger非必须用户 ID

    format: int64

    messagestring非必须错误信息,如果成功,该项为null
    versioninteger非必须版本

    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_passwordstring非必须new_password 新密码
    old_passwordstring非必须old_password 旧密码

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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_answerstring非必须验证问题答案
    auth_modeinteger非必须验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请

    format: int32

    auth_questionstring非必须验证问题
    auto_downloadboolean非必须是否自动下载
    group_confirmboolean非必须邀请入群时是否需要用户确认: true - 需要用户同意才可加入, false - 自动同意邀请
    idinteger非必须

    format: int64

    no_pushboolean非必须是否关闭推送消息
    no_push_detailboolean非必须是否推送详情
    no_push_end_hourinteger非必须推送免打扰结束时间

    format: int32

    no_push_start_hourinteger非必须推送免打扰开始时间

    format: int32

    no_soundsboolean非必须收到消息时是否静音
    push_nick_namestring非必须推送昵称
    push_tokenstring非必须推送token
    silence_end_timeinteger非必须推送不提醒结束时间

    format: int32

    silence_start_timeinteger非必须推送不提醒开始时间

    format: int32

    user_idinteger必须用户ID

    format: int64

    vibratoryboolean非必须收到消息时否振动

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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_answerstring非必须验证问题答案
    auth_modeinteger非必须验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请

    format: int32

    auth_questionstring非必须验证问题
    auto_downloadboolean非必须是否自动下载
    group_confirmboolean非必须邀请入群时是否需要用户确认: true - 需要用户同意才可加入, false - 自动同意邀请
    idinteger非必须

    format: int64

    no_pushboolean非必须是否关闭推送消息
    no_push_detailboolean非必须是否推送详情
    no_push_end_hourinteger非必须推送免打扰结束时间

    format: int32

    no_push_start_hourinteger非必须推送免打扰开始时间

    format: int32

    no_soundsboolean非必须收到消息时是否静音
    push_nick_namestring非必须推送昵称
    push_tokenstring非必须推送token
    silence_end_timeinteger非必须推送不提醒结束时间

    format: int32

    silence_start_timeinteger非必须推送不提醒开始时间

    format: int32

    user_idinteger必须用户ID

    format: int64

    vibratoryboolean非必须收到消息时否振动

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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的身份来调用此接口

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为null

    将openid绑定到账号.(绑定建议使用/app/wechat/bind;解绑建议使用/app/wechat/unbind)

    基本信息

    Path: /user/bind_openid

    Method: GET

    接口描述:

    请求参数

    Headers

    参数名称 参数值 是否必须 示例 备注
    access-token 令牌
    app_id 应用ID
    group_id 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口
    user_id 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

    Query

    参数名称 是否必须 示例 备注
    open_id open_id
    type type

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    listobject []非必须

    item 类型: object

    ├─ descriptionstring非必须描述信息
    ├─ nick_namestring非必须昵称
    ├─ private_infostring非必须私有信息,仅自己可见
    ├─ public_infostring非必须公开信息,好友和陌生人可见
    ├─ user_idinteger非必须用户ID

    format: int64

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须失败原因
    ├─ successboolean非必须是否成功
    ├─ user_idinteger非必须用户ID

    format: int64

    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    listobject []非必须

    item 类型: object

    ├─ descriptionstring非必须描述信息
    ├─ nick_namestring非必须昵称
    ├─ private_infostring非必须私有信息,仅自己可见
    ├─ public_infostring非必须公开信息,好友和陌生人可见
    ├─ user_idinteger非必须用户ID

    format: int64

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须失败原因
    ├─ successboolean非必须是否成功
    ├─ user_idinteger非必须用户ID

    format: int64

    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    listobject []非必须

    item 类型: object

    ├─ passwordstring必须
    ├─ usernamestring必须

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须失败原因
    ├─ successboolean非必须是否成功
    ├─ user_idinteger非必须用户ID

    format: int64

    ├─ usernamestring非必须用户名
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    listobject []非必须

    item 类型: object

    ├─ avatarstring必须头像 url
    ├─ user_idinteger非必须用户ID

    format: int64

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须失败原因
    ├─ successboolean非必须是否成功
    ├─ user_idinteger非必须用户ID

    format: int64

    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    listobject []非必须

    item 类型: object

    ├─ avatarstring必须头像 url
    ├─ user_idinteger非必须用户ID

    format: int64

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须失败原因
    ├─ successboolean非必须是否成功
    ├─ user_idinteger非必须用户ID

    format: int64

    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    descriptionstring非必须描述信息
    nick_namestring非必须昵称
    private_infostring非必须私有信息,仅自己可见
    public_infostring非必须公开信息,好友和陌生人可见

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    descriptionstring非必须描述信息
    nick_namestring非必须昵称
    private_infostring非必须私有信息,仅自己可见
    public_infostring非必须公开信息,好友和陌生人可见

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    aliasstring非必须别名
    device_guidstring非必须设备ID
    passwordstring必须
    push_tokenstring非必须推送token
    signstring非必须签名
    usernamestring必须

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject非必须用户设置信息
    ├─ auth_answerstring非必须验证问题答案
    ├─ auth_modeinteger非必须验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请

    format: int32

    ├─ auth_questionstring非必须验证问题
    ├─ auto_downloadboolean非必须是否自动下载
    ├─ group_confirmboolean非必须邀请入群时是否需要用户确认: true - 需要用户同意才可加入, false - 自动同意邀请
    ├─ idinteger非必须

    format: int64

    ├─ no_pushboolean非必须是否关闭推送消息
    ├─ no_push_detailboolean非必须是否推送详情
    ├─ no_push_end_hourinteger非必须推送免打扰结束时间

    format: int32

    ├─ no_push_start_hourinteger非必须推送免打扰开始时间

    format: int32

    ├─ no_soundsboolean非必须收到消息时是否静音
    ├─ push_nick_namestring非必须推送昵称
    ├─ push_tokenstring非必须推送token
    ├─ silence_end_timeinteger非必须推送不提醒结束时间

    format: int32

    ├─ silence_start_timeinteger非必须推送不提醒开始时间

    format: int32

    ├─ user_idinteger必须用户ID

    format: int64

    ├─ vibratoryboolean非必须收到消息时否振动
    messagestring非必须错误信息,如果成功,该项为null

    注册用户

    基本信息

    Path: /user/register

    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

    名称类型是否必须默认值备注其他信息
    emailstring非必须email
    mobilestring非必须手机号码
    passwordstring必须
    usernamestring非必须用户名
    verification_codestring必须验证码,结合手机或邮箱使用

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject非必须用户设置信息
    ├─ auth_answerstring非必须验证问题答案
    ├─ auth_modeinteger非必须验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请

    format: int32

    ├─ auth_questionstring非必须验证问题
    ├─ auto_downloadboolean非必须是否自动下载
    ├─ group_confirmboolean非必须邀请入群时是否需要用户确认: true - 需要用户同意才可加入, false - 自动同意邀请
    ├─ idinteger非必须

    format: int64

    ├─ no_pushboolean非必须是否关闭推送消息
    ├─ no_push_detailboolean非必须是否推送详情
    ├─ no_push_end_hourinteger非必须推送免打扰结束时间

    format: int32

    ├─ no_push_start_hourinteger非必须推送免打扰开始时间

    format: int32

    ├─ no_soundsboolean非必须收到消息时是否静音
    ├─ push_nick_namestring非必须推送昵称
    ├─ push_tokenstring非必须推送token
    ├─ silence_end_timeinteger非必须推送不提醒结束时间

    format: int32

    ├─ silence_start_timeinteger非必须推送不提醒开始时间

    format: int32

    ├─ user_idinteger必须用户ID

    format: int64

    ├─ vibratoryboolean非必须收到消息时否振动
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    passwordstring必须
    usernamestring必须

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject非必须用户设置信息
    ├─ auth_answerstring非必须验证问题答案
    ├─ auth_modeinteger非必须验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请

    format: int32

    ├─ auth_questionstring非必须验证问题
    ├─ auto_downloadboolean非必须是否自动下载
    ├─ group_confirmboolean非必须邀请入群时是否需要用户确认: true - 需要用户同意才可加入, false - 自动同意邀请
    ├─ idinteger非必须

    format: int64

    ├─ no_pushboolean非必须是否关闭推送消息
    ├─ no_push_detailboolean非必须是否推送详情
    ├─ no_push_end_hourinteger非必须推送免打扰结束时间

    format: int32

    ├─ no_push_start_hourinteger非必须推送免打扰开始时间

    format: int32

    ├─ no_soundsboolean非必须收到消息时是否静音
    ├─ push_nick_namestring非必须推送昵称
    ├─ push_tokenstring非必须推送token
    ├─ silence_end_timeinteger非必须推送不提醒结束时间

    format: int32

    ├─ silence_start_timeinteger非必须推送不提醒开始时间

    format: int32

    ├─ user_idinteger必须用户ID

    format: int64

    ├─ vibratoryboolean非必须收到消息时否振动
    messagestring非必须错误信息,如果成功,该项为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_sninteger必须设备SN

    format: int32

    device_tokenstring必须device token
    notifier_namestring必须证书名称

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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_sninteger必须设备SN

    format: int32

    device_tokenstring必须device token
    notifier_namestring必须证书名称

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    aliasstring必须别名
    push_tokenstring非必须推送token

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    tagsstring []非必须

    item 类型: string

    ├─ 非必须

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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的身份来调用此接口

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    datastring []非必须结果数据

    item 类型: string

    ├─ 非必须
    messagestring非必须错误信息,如果成功,该项为null

    获取用户信息

    基本信息

    Path: /user/profile

    Method: GET

    接口描述:

    请求参数

    Headers

    参数名称 参数值 是否必须 示例 备注
    access-token 令牌
    app_id 应用ID
    group_id 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口
    user_id 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject非必须用户信息
    ├─ avatarstring非必须头像 url
    ├─ descriptionstring非必须描述信息
    ├─ emailstring非必须邮箱
    ├─ mobilestring非必须手机号码
    ├─ nick_namestring非必须昵称
    ├─ private_infostring非必须私有信息,仅自己可见
    ├─ public_infostring非必须公开信息,好友和陌生人可见
    ├─ user_idinteger非必须用户ID

    format: int64

    ├─ usernamestring非必须用户名
    messagestring非必须错误信息,如果成功,该项为null

    获取用户设置

    基本信息

    Path: /user/settings

    Method: GET

    接口描述:

    请求参数

    Headers

    参数名称 参数值 是否必须 示例 备注
    access-token 令牌
    app_id 应用ID
    group_id 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口
    user_id 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject非必须用户设置信息
    ├─ auth_answerstring非必须验证问题答案
    ├─ auth_modeinteger非必须验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请

    format: int32

    ├─ auth_questionstring非必须验证问题
    ├─ auto_downloadboolean非必须是否自动下载
    ├─ group_confirmboolean非必须邀请入群时是否需要用户确认: true - 需要用户同意才可加入, false - 自动同意邀请
    ├─ idinteger非必须

    format: int64

    ├─ no_pushboolean非必须是否关闭推送消息
    ├─ no_push_detailboolean非必须是否推送详情
    ├─ no_push_end_hourinteger非必须推送免打扰结束时间

    format: int32

    ├─ no_push_start_hourinteger非必须推送免打扰开始时间

    format: int32

    ├─ no_soundsboolean非必须收到消息时是否静音
    ├─ push_nick_namestring非必须推送昵称
    ├─ push_tokenstring非必须推送token
    ├─ silence_end_timeinteger非必须推送不提醒结束时间

    format: int32

    ├─ silence_start_timeinteger非必须推送不提醒开始时间

    format: int32

    ├─ user_idinteger必须用户ID

    format: int64

    ├─ vibratoryboolean非必须收到消息时否振动
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    tagsstring []非必须

    item 类型: string

    ├─ 非必须

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    badgeinteger必须badge

    format: int32

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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非必须

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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非必须

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    avatarstring必须头像 url

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    avatarstring必须头像 url

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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非必须

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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非必须

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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表示踢所有设备

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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表示踢所有设备

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为null
    以上内容是否对您有帮助?
  • Qvm free helper
    Close