即时通讯

  • 即时通讯 > API 文档 > 服务端API > 好友管理接口

    好友管理接口

    最近更新时间:2021-06-29 09:48:15

    好友管理接口

    拒绝好友申请

    基本信息

    Path: /roster/decline

    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

    名称类型是否必须默认值备注其他信息
    reasonstring非必须拒绝的原因
    user_idinteger必须拒绝的用户ID

    format: int64

    返回数据

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

    format: int32

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

    从黑名单移除

    基本信息

    Path: /roster/unblock

    Method: POST

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    删除好友

    基本信息

    Path: /roster/delete

    Method: POST

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    删除好友

    基本信息

    Path: /roster/delete

    Method: DELETE

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    同意好友申请

    基本信息

    Path: /roster/accept

    Method: POST

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    同意好友申请

    基本信息

    Path: /roster/accept

    Method: PUT

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    好友列表

    基本信息

    Path: /roster/list

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

    参数名称 是否必须 示例 备注
    cursor cursor
    limit limit

    返回数据

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

    format: int32

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

    item 类型: integer

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

    format: int64

    好友申请列表

    基本信息

    Path: /roster/apply/list

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

    参数名称 是否必须 示例 备注
    cursor cursor
    limit limit

    返回数据

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

    format: int32

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

    item 类型: object

    ├─ expired_timeinteger非必须过期时间

    format: int64

    ├─ reasonstring非必须申请描述
    ├─ statusinteger非必须

    format: int32

    ├─ user_idinteger非必须发起加好友申请的用户ID

    format: int64

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

    format: int64

    好友详情列表

    基本信息

    Path: /roster/list

    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

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

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

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

    format: int32

    ├─ auth_questionstring非必须验证问题
    ├─ avatarstring非必须头像
    ├─ descriptionstring非必须描述信息
    ├─ extstring非必须
    ├─ mute_notificationboolean非必须
    ├─ nick_namestring非必须昵称或名称
    ├─ public_infostring非必须公开信息,好友和陌生人可见
    ├─ relationinteger非必须

    format: int32

    ├─ user_idinteger非必须好友用户ID

    format: int64

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

    批量添加好友

    基本信息

    Path: /roster/apply/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

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

    item 类型: object

    ├─ aliasstring非必须备注名称
    ├─ reasonstring非必须申请描述
    ├─ user_idinteger必须被申请用户 ID

    format: int64

    返回数据

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

    format: int32

    dataobject非必须批量添加好友返回结果
    ├─ failsobject []非必须

    item 类型: object

    ├─ reasonstring非必须失败原因
    ├─ user_idinteger非必须用户ID

    format: int64

    ├─ successinteger []非必须

    item 类型: integer

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

    拒绝好友申请

    基本信息

    Path: /roster/decline

    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

    名称类型是否必须默认值备注其他信息
    reasonstring非必须拒绝的原因
    user_idinteger必须拒绝的用户ID

    format: int64

    返回数据

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

    format: int32

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

    从黑名单移除

    基本信息

    Path: /roster/unblock

    Method: DELETE

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    是否允许发消息

    基本信息

    Path: /roster/may_message

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

    参数名称 是否必须 示例 备注
    roster_id roster_id
    user_id user_id

    返回数据

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

    format: int32

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

    更新好友扩展信息

    基本信息

    Path: /roster/ext

    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非必须备注名称
    extstring非必须扩展信息
    mute_notificationboolean非必须是否接收消息提醒
    user_idinteger必须好友用户ID

    format: int64

    返回数据

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

    format: int32

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

    更新好友扩展信息

    基本信息

    Path: /roster/ext

    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

    名称类型是否必须默认值备注其他信息
    aliasstring非必须备注名称
    extstring非必须扩展信息
    mute_notificationboolean非必须是否接收消息提醒
    user_idinteger必须好友用户ID

    format: int64

    返回数据

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

    format: int32

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

    添加黑名单

    基本信息

    Path: /roster/block

    Method: POST

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    添加黑名单

    基本信息

    Path: /roster/block

    Method: PUT

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    用ID搜索用户

    基本信息

    Path: /roster/id

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

    参数名称 是否必须 示例 备注
    user_id 用户ID

    返回数据

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

    format: int32

    dataobject非必须好友列表
    ├─ aliasstring非必须
    ├─ auth_modeinteger非必须验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请

    format: int32

    ├─ auth_questionstring非必须验证问题
    ├─ avatarstring非必须头像
    ├─ descriptionstring非必须描述信息
    ├─ extstring非必须
    ├─ mute_notificationboolean非必须
    ├─ nick_namestring非必须昵称或名称
    ├─ public_infostring非必须公开信息,好友和陌生人可见
    ├─ relationinteger非必须

    format: int32

    ├─ user_idinteger非必须好友用户ID

    format: int64

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

    用手机号搜索用户

    基本信息

    Path: /roster/mobile

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    dataobject非必须好友列表
    ├─ aliasstring非必须
    ├─ auth_modeinteger非必须验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请

    format: int32

    ├─ auth_questionstring非必须验证问题
    ├─ avatarstring非必须头像
    ├─ descriptionstring非必须描述信息
    ├─ extstring非必须
    ├─ mute_notificationboolean非必须
    ├─ nick_namestring非必须昵称或名称
    ├─ public_infostring非必须公开信息,好友和陌生人可见
    ├─ relationinteger非必须

    format: int32

    ├─ user_idinteger非必须好友用户ID

    format: int64

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

    用用户名搜索用户

    基本信息

    Path: /roster/name

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    dataobject非必须好友列表
    ├─ aliasstring非必须
    ├─ auth_modeinteger非必须验证方式, 0 - 无需验证,任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请

    format: int32

    ├─ auth_questionstring非必须验证问题
    ├─ avatarstring非必须头像
    ├─ descriptionstring非必须描述信息
    ├─ extstring非必须
    ├─ mute_notificationboolean非必须
    ├─ nick_namestring非必须昵称或名称
    ├─ public_infostring非必须公开信息,好友和陌生人可见
    ├─ relationinteger非必须

    format: int32

    ├─ user_idinteger非必须好友用户ID

    format: int64

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

    申请加好友

    基本信息

    Path: /roster/apply

    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非必须备注名称
    auth_answerstring非必须问题答案
    reasonstring非必须申请描述
    user_idinteger必须被申请用户 ID

    format: int64

    返回数据

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

    format: int32

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

    黑名单列表

    基本信息

    Path: /roster/blocked_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

    datainteger []非必须结果数据

    item 类型: integer

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