即时通讯

  • 即时通讯 > API 文档 > 服务端API > 群操作

    群操作

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

    群接口

    更新群设置–群成员是否可修改群信息

    基本信息

    Path: /group/settings/allow_member_modify

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valueboolean必须更新内容

    返回数据

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

    format: int32

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

    上传群文件

    基本信息

    Path: /group/file/upload

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    namestring必须文件名称
    sizeinteger必须文件大小

    format: int64

    typestring非必须文件类型
    urlstring必须文件url

    返回数据

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

    format: int32

    dataobject非必须群共享文件返回格式
    ├─ created_atinteger非必须

    format: int64

    ├─ file_idinteger非必须共享文件id

    format: int64

    ├─ group_idinteger非必须群id

    format: int64

    ├─ namestring非必须共享文件名称
    ├─ sizeinteger非必须共享文件大小

    format: int64

    ├─ typestring非必须共享文件类型
    ├─ updated_atinteger非必须

    format: int64

    ├─ uploaderinteger非必须共享文件上传者

    format: int64

    ├─ urlstring非必须共享文件url
    messagestring非必须错误信息,如果成功,该项为null

    二维码邀请入群

    基本信息

    Path: /group/qrcode/invite

    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

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

    返回数据

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

    format: int32

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

    从禁言列表移除用户

    基本信息

    Path: /group/unban

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    user_listinteger []必须用户id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    从黑名单移除用户

    基本信息

    Path: /group/unblock

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    user_listinteger []必须用户id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    从黑名单移除用户

    基本信息

    Path: /group/unblock

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    user_listinteger []必须用户id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    创建群

    基本信息

    Path: /group/create

    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非必须群头像
    descriptionstring非必须群描述
    namestring非必须群名称
    typeinteger非必须群类型 1表示公开群,0表示私有群, 2表示聊天室

    最大值: 2

    最小值: 0

    format: int32

    user_listinteger []非必须邀请入群的用户id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

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

    删除公告

    基本信息

    Path: /group/announcement/delete

    Method: POST

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    删除公告

    基本信息

    Path: /group/announcement/delete

    Method: DELETE

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    删除群文件

    基本信息

    Path: /group/file/delete

    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

    名称类型是否必须默认值备注其他信息
    file_listinteger []必须文件id列表

    item 类型: integer

    ├─ 非必须
    group_idinteger必须群id

    format: int64

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ file_idinteger非必须

    format: int64

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

    删除群文件

    基本信息

    Path: /group/file/delete

    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

    名称类型是否必须默认值备注其他信息
    file_listinteger []必须文件id列表

    item 类型: integer

    ├─ 非必须
    group_idinteger必须群id

    format: int64

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ file_idinteger非必须

    format: int64

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

    将成员踢出群

    基本信息

    Path: /group/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的身份来调用此接口

    Body

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    user_listinteger []必须用户id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    将成员踢出群

    基本信息

    Path: /group/kick

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    user_listinteger []必须用户id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    将用户加入黑名单

    基本信息

    Path: /group/block

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    user_listinteger []必须用户id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    将用户禁言

    基本信息

    Path: /group/ban

    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

    名称类型是否必须默认值备注其他信息
    durationinteger必须禁言时长,单位为分钟

    format: int64

    group_idinteger必须群id

    format: int64

    user_listinteger []必须用户id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    成员退出群

    基本信息

    Path: /group/leave

    Method: POST

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    成员退出群

    基本信息

    Path: /group/leave

    Method: DELETE

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    批量获取群成员的群名片

    基本信息

    Path: /group/members/display_name

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    user_listinteger []必须用户id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ display_namestring非必须成员群名片
    ├─ join_timeinteger非必须成员入群时间

    format: int64

    ├─ user_idinteger非必须用户id

    format: int64

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

    更新扩展信息

    基本信息

    Path: /group/info/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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valuestring必须更新内容

    返回数据

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

    format: int32

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

    更新扩展信息

    基本信息

    Path: /group/info/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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valuestring必须更新内容

    返回数据

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

    format: int32

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

    更新群名片

    基本信息

    Path: /group/display_name

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valuestring必须更新内容

    返回数据

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

    format: int32

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

    更新群名片

    基本信息

    Path: /group/display_name

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valuestring必须更新内容

    返回数据

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

    format: int32

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

    更新群名称

    基本信息

    Path: /group/info/name

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valuestring必须更新内容

    返回数据

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

    format: int32

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

    更新群名称

    基本信息

    Path: /group/info/name

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valuestring必须更新内容

    返回数据

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

    format: int32

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

    更新群头像

    基本信息

    Path: /group/info/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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valuestring必须更新内容

    返回数据

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

    format: int32

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

    更新群头像

    基本信息

    Path: /group/info/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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valuestring必须更新内容

    返回数据

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

    format: int32

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

    更新群描述

    基本信息

    Path: /group/info/description

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valuestring必须更新内容

    返回数据

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

    format: int32

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

    更新群描述

    基本信息

    Path: /group/info/description

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valuestring必须更新内容

    返回数据

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

    format: int32

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

    更新群文件名称

    基本信息

    Path: /group/file/update_name

    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

    名称类型是否必须默认值备注其他信息
    file_idinteger必须文件id

    format: int64

    group_idinteger必须群id

    format: int64

    namestring必须文件新名称

    返回数据

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

    format: int32

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

    更新群文件名称

    基本信息

    Path: /group/file/update_name

    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

    名称类型是否必须默认值备注其他信息
    file_idinteger必须文件id

    format: int64

    group_idinteger必须群id

    format: int64

    namestring必须文件新名称

    返回数据

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

    format: int32

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

    更新群设置–新成员是否可见群历史聊天记录

    基本信息

    Path: /group/settings/history_visible

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valueboolean必须更新内容

    返回数据

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

    format: int32

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

    更新群设置–新成员是否可见群历史聊天记录

    基本信息

    Path: /group/settings/history_visible

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valueboolean必须更新内容

    返回数据

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

    format: int32

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

    更新群设置–是否允许成员邀请

    基本信息

    Path: /group/settings/allow_member_invitation

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valueboolean必须更新内容

    返回数据

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

    format: int32

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

    更新群设置–是否允许成员邀请

    基本信息

    Path: /group/settings/allow_member_invitation

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valueboolean必须更新内容

    返回数据

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

    format: int32

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

    更新群设置–是否开启群消息已读功能

    基本信息

    Path: /group/settings/enable_read_ack

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valueboolean必须更新内容

    返回数据

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

    format: int32

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

    更新群设置–是否开启群消息已读功能

    基本信息

    Path: /group/settings/enable_read_ack

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valueboolean必须更新内容

    返回数据

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

    format: int32

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

    更新群设置–群成员是否可修改群信息

    基本信息

    Path: /group/settings/allow_member_modify

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    valueboolean必须更新内容

    返回数据

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

    format: int32

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

    下载群文件

    基本信息

    Path: /group/file

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    dataobject非必须群共享文件返回格式
    ├─ created_atinteger非必须

    format: int64

    ├─ file_idinteger非必须共享文件id

    format: int64

    ├─ group_idinteger非必须群id

    format: int64

    ├─ namestring非必须共享文件名称
    ├─ sizeinteger非必须共享文件大小

    format: int64

    ├─ typestring非必须共享文件类型
    ├─ updated_atinteger非必须

    format: int64

    ├─ uploaderinteger非必须共享文件上传者

    format: int64

    ├─ urlstring非必须共享文件url
    messagestring非必须错误信息,如果成功,该项为null

    更新群设置–群申请是否需要管理员审批

    基本信息

    Path: /group/settings/require_admin_approval

    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

    名称类型是否必须默认值备注其他信息
    apply_approvalinteger必须入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请

    format: int32

    group_idinteger必须群id

    format: int64

    返回数据

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

    format: int32

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

    更新群设置–群申请是否需要管理员审批

    基本信息

    Path: /group/settings/require_admin_approval

    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

    名称类型是否必须默认值备注其他信息
    apply_approvalinteger必须入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请

    format: int32

    group_idinteger必须群id

    format: int64

    返回数据

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

    format: int32

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

    根据group id获取群信息

    <a id=根据group id获取群信息>

    基本信息

    Path: /group/info

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    dataobject非必须
    ├─ apply_approvalinteger非必须入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请

    format: int32

    ├─ avatarstring非必须群头像
    ├─ created_atinteger非必须创建时间

    format: int64

    ├─ descriptionstring非必须群描述
    ├─ extstring非必须群扩展信息
    ├─ group_idinteger非必须群id

    format: int64

    ├─ history_visibleboolean非必须新成员可见历史聊天记录设置
    ├─ member_inviteboolean非必须群成员邀请设置
    ├─ member_modifyboolean非必须群成员修改群信息设置
    ├─ msg_mute_modeinteger非必须群消息屏蔽模式

    format: int32

    ├─ msg_push_modeinteger非必须群消息推送模式

    format: int32

    ├─ namestring非必须群名称
    ├─ owner_idinteger非必须群主id

    format: int64

    ├─ read_ackboolean非必须群消息已读功能设置
    ├─ statusinteger非必须群状态, 0:正常, 1:已解散

    format: int32

    ├─ typeinteger非必须群类型

    format: int32

    ├─ updated_atinteger非必须更新时间

    format: int64

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

    根据group id获取群信息

    <a id=根据group id获取群信息>

    基本信息

    Path: /group/info/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

    名称类型是否必须默认值备注其他信息
    group_listinteger []必须群id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ apply_approvalinteger非必须入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请

    format: int32

    ├─ avatarstring非必须
    ├─ capacityinteger非必须

    format: int64

    ├─ countinteger非必须

    format: int64

    ├─ group_idinteger非必须

    format: int64

    ├─ msg_mute_modeinteger非必须群消息屏蔽设置

    format: int32

    ├─ msg_push_modeinteger非必须群消息推送设置

    format: int32

    ├─ namestring非必须
    ├─ ownerinteger非必须

    format: int64

    ├─ statusinteger非必须群状态, 0:正常, 1:已解散

    format: int32

    ├─ typeinteger非必须

    format: int32

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

    根据group id获取群成员列表

    <a id=根据group id获取群成员列表>

    基本信息

    Path: /group/member_list

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    cursorstring非必须游标,用于翻页
    dataobject []非必须结果数据

    item 类型: object

    ├─ display_namestring非必须成员群名片
    ├─ join_timeinteger非必须成员入群时间

    format: int64

    ├─ user_idinteger非必须用户id

    format: int64

    messagestring非必须错误信息,如果成功,该项为null
    totalinteger非必须总数

    format: int64

    versioninteger非必须版本,目前没用到,留作扩展

    format: int64

    根据群id和公告id获取群公告详情

    基本信息

    Path: /group/announcement

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    dataobject非必须
    ├─ authorinteger非必须公告发布者

    format: int64

    ├─ contentstring非必须公告内容
    ├─ created_atinteger非必须公告发布时间

    format: int64

    ├─ group_idinteger非必须群id

    format: int64

    ├─ idinteger非必须公告id

    format: int64

    ├─ titlestring非必须公告标题
    messagestring非必须错误信息,如果成功,该项为null

    添加群管理员

    基本信息

    Path: /group/admin/add

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    user_listinteger []必须用户id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    用户处理入群邀请

    基本信息

    Path: /group/invite/handle

    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

    名称类型是否必须默认值备注其他信息
    approvalboolean必须审批,bool类型,true为同意,false为拒绝
    group_idinteger必须群id

    format: int64

    user_idinteger必须用户id

    format: int64

    返回数据

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

    format: int32

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

    用户处理入群邀请

    基本信息

    Path: /group/invite/handle

    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

    名称类型是否必须默认值备注其他信息
    approvalboolean必须审批,bool类型,true为同意,false为拒绝
    group_idinteger必须群id

    format: int64

    user_idinteger必须用户id

    format: int64

    返回数据

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

    format: int32

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

    申请入群

    基本信息

    Path: /group/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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    reasonstring非必须申请入群原因

    返回数据

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

    format: int32

    dataobject非必须
    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    移除群管理员

    基本信息

    Path: /group/admin/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的身份来调用此接口

    Body

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    user_listinteger []必须用户id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    移除群管理员

    基本信息

    Path: /group/admin/remove

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    user_listinteger []必须用户id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    管理员处理入群申请

    基本信息

    Path: /group/apply/handle

    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

    名称类型是否必须默认值备注其他信息
    approvalboolean必须审批,bool类型,true为同意,false为拒绝
    group_idinteger必须群id

    format: int64

    user_idinteger必须用户id

    format: int64

    返回数据

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

    format: int32

    dataobject非必须
    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    管理员处理入群申请

    基本信息

    Path: /group/apply/handle

    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

    名称类型是否必须默认值备注其他信息
    approvalboolean必须审批,bool类型,true为同意,false为拒绝
    group_idinteger必须群id

    format: int64

    user_idinteger必须用户id

    format: int64

    返回数据

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

    format: int32

    dataobject非必须
    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    编辑群公告

    基本信息

    Path: /group/announcement/edit

    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

    名称类型是否必须默认值备注其他信息
    contentstring必须公告内容
    group_idinteger必须群组id

    format: int64

    titlestring必须公告标题

    返回数据

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

    format: int32

    dataobject非必须
    ├─ authorinteger非必须公告发布者

    format: int64

    ├─ contentstring非必须公告内容
    ├─ created_atinteger非必须公告发布时间

    format: int64

    ├─ group_idinteger非必须群id

    format: int64

    ├─ idinteger非必须公告id

    format: int64

    ├─ titlestring非必须公告标题
    messagestring非必须错误信息,如果成功,该项为null

    获取公开群列表

    基本信息

    Path: /group/public_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

    获取最新一条群公告详情

    基本信息

    Path: /group/announcement/last

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    dataobject非必须
    ├─ authorinteger非必须公告发布者

    format: int64

    ├─ contentstring非必须公告内容
    ├─ created_atinteger非必须公告发布时间

    format: int64

    ├─ group_idinteger非必须群id

    format: int64

    ├─ idinteger非必须公告id

    format: int64

    ├─ titlestring非必须公告标题
    messagestring非必须错误信息,如果成功,该项为null

    获取用户的群组列表

    基本信息

    Path: /group/user_joined

    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

    获取禁言列表

    基本信息

    Path: /group/banned_list

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    cursorstring非必须游标,用于翻页
    dataobject非必须结果数据
    messagestring非必须错误信息,如果成功,该项为null
    totalinteger非必须总数

    format: int64

    versioninteger非必须版本,目前没用到,留作扩展

    format: int64

    获取群公告列表

    基本信息

    Path: /group/announcement/list

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ authorinteger非必须公告发布者

    format: int64

    ├─ contentstring非必须公告内容
    ├─ created_atinteger非必须公告发布时间

    format: int64

    ├─ group_idinteger非必须群id

    format: int64

    ├─ idinteger非必须公告id

    format: int64

    ├─ titlestring非必须公告标题
    messagestring非必须错误信息,如果成功,该项为null

    获取群文件列表

    基本信息

    Path: /group/file/list

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ created_atinteger非必须

    format: int64

    ├─ file_idinteger非必须共享文件id

    format: int64

    ├─ group_idinteger非必须群id

    format: int64

    ├─ namestring非必须共享文件名称
    ├─ sizeinteger非必须共享文件大小

    format: int64

    ├─ typestring非必须共享文件类型
    ├─ updated_atinteger非必须

    format: int64

    ├─ uploaderinteger非必须共享文件上传者

    format: int64

    ├─ urlstring非必须共享文件url
    messagestring非必须错误信息,如果成功,该项为null

    获取群申请列表

    基本信息

    Path: /group/application_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的身份来调用此接口

    Query

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

    Body

    名称类型是否必须默认值备注其他信息
    group_listinteger []必须群id列表

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    cursorstring非必须游标,用于翻页
    dataobject非必须结果数据
    messagestring非必须错误信息,如果成功,该项为null
    totalinteger非必须总数

    format: int64

    versioninteger非必须版本,目前没用到,留作扩展

    format: int64

    获取群管理员列表

    基本信息

    Path: /group/admin_list

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ display_namestring非必须成员群名片
    ├─ join_timeinteger非必须成员入群时间

    format: int64

    ├─ user_idinteger非必须用户id

    format: int64

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

    获取群设置

    基本信息

    Path: /group/settings

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    dataobject非必须
    ├─ apply_approvalinteger非必须入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请

    format: int32

    ├─ avatarstring非必须群头像
    ├─ created_atinteger非必须创建时间

    format: int64

    ├─ descriptionstring非必须群描述
    ├─ extstring非必须群扩展信息
    ├─ group_idinteger非必须群id

    format: int64

    ├─ history_visibleboolean非必须新成员可见历史聊天记录设置
    ├─ member_inviteboolean非必须群成员邀请设置
    ├─ member_modifyboolean非必须群成员修改群信息设置
    ├─ msg_mute_modeinteger非必须群消息屏蔽模式

    format: int32

    ├─ msg_push_modeinteger非必须群消息推送模式

    format: int32

    ├─ namestring非必须群名称
    ├─ owner_idinteger非必须群主id

    format: int64

    ├─ read_ackboolean非必须群消息已读功能设置
    ├─ statusinteger非必须群状态, 0:正常, 1:已解散

    format: int32

    ├─ typeinteger非必须群类型

    format: int32

    ├─ updated_atinteger非必须更新时间

    format: int64

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

    获取群邀请二维码信息

    基本信息

    Path: /group/qrcode/sign

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    dataobject非必须
    ├─ create_atinteger非必须二维码生成时间

    format: int64

    ├─ expire_atinteger非必须二维码过期时间

    format: int64

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

    获取群邀请列表

    基本信息

    Path: /group/invitation_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
    version version

    返回数据

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

    format: int32

    cursorstring非必须游标,用于翻页
    dataobject非必须结果数据
    messagestring非必须错误信息,如果成功,该项为null
    totalinteger非必须总数

    format: int64

    versioninteger非必须版本,目前没用到,留作扩展

    format: int64

    获取黑名单列表

    基本信息

    Path: /group/blocked_list

    Method: GET

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

    cursorstring非必须游标,用于翻页
    dataobject非必须结果数据
    messagestring非必须错误信息,如果成功,该项为null
    totalinteger非必须总数

    format: int64

    versioninteger非必须版本,目前没用到,留作扩展

    format: int64

    解散群

    基本信息

    Path: /group/destroy

    Method: POST

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    解散群

    基本信息

    Path: /group/destroy

    Method: DELETE

    接口描述:

    请求参数

    Headers

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

    Query

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

    返回数据

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

    format: int32

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

    设置群消息屏蔽模式

    基本信息

    Path: /group/msg/mute_mode

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    msg_mute_modeinteger必须群消息屏蔽模式: 0 不屏蔽1 屏蔽本地消息通知2 屏蔽消息,不接收消息

    format: int32

    返回数据

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

    format: int32

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

    设置群消息屏蔽模式

    基本信息

    Path: /group/msg/mute_mode

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    msg_mute_modeinteger必须群消息屏蔽模式: 0 不屏蔽1 屏蔽本地消息通知2 屏蔽消息,不接收消息

    format: int32

    返回数据

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

    format: int32

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

    设置群消息推送模式

    基本信息

    Path: /group/msg/push_mode

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    msg_push_modeinteger必须群消息推送类型: 0:接收所有推送;1:不接受推送;2:接收管理员和@消息推送;3:只接收管理员消息推送;4:只接收@消息推送

    format: int32

    返回数据

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

    format: int32

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

    设置群消息推送模式

    基本信息

    Path: /group/msg/push_mode

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    msg_push_modeinteger必须群消息推送类型: 0:接收所有推送;1:不接受推送;2:接收管理员和@消息推送;3:只接收管理员消息推送;4:只接收@消息推送

    format: int32

    返回数据

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

    format: int32

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

    转让群

    基本信息

    Path: /group/transfer

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    new_ownerinteger必须新群主的user_id

    format: int64

    返回数据

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

    format: int32

    dataobject非必须
    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    转让群

    基本信息

    Path: /group/transfer

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    new_ownerinteger必须新群主的user_id

    format: int64

    返回数据

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

    format: int32

    dataobject非必须
    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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

    邀请入群

    基本信息

    Path: /group/invite

    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

    名称类型是否必须默认值备注其他信息
    group_idinteger必须群id

    format: int64

    reasonstring非必须邀请理由
    user_listinteger []必须受邀请者id,List类型,单次可邀请多个用户入群

    item 类型: integer

    ├─ 非必须

    返回数据

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

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ reasonstring非必须
    ├─ resultstring非必须
    ├─ user_idinteger非必须

    format: int64

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