«
用户组相关API请求文档

时间:2021-9-9    作者:admin    分类: api接口文档


无条件列出所有组 GET /v1/group.htm
    排序是创建时间 降序
    要求参数:limit:int #一次列出多少条,如果不传的话,只给10条
             page:int #第几页,如果不传的话,只给第一页

列出所有公开的组(就是不需要密码就可以加入的组) GET /v1/group/public_group.htm
    排序是创建时间 降序
    要求参数:limit:int #一次列出多少条,如果不传的话,只给10条
                    page:int #第几页,如果不传的话,只给第一页

列出组的所有成员 GET /v1/group/users.htm
    排序是加入时间降序
    权限要求:须登录状态且是这个组的creator(创建者)或master(管理员)才可以,否则会报异常
    参数要求:limit:int #一次列出多少条,如果不传的话,只给10条
                    page:int #第几页,如果不传的话,只给第一页
                    group_id:int * #要列出的组ID

将某个人踢出组 GET /v1/group/out.htm
    权限要求:必须是登录状态且是这个缚的creator或master才可以,否则会报异常(not you business!)
    要求参数:group_id:int * #要操作的组ID
                    user_id:string * #要操作的用户ID(user_uniq_id的值)
    返回参数:正确或错误的通用返回

将某人设置成管理员 GET /v1/group/set_master.htm
    权限要求:操作人必须是登录状态下,且必须是组的创建者(group.p_type=creator),
             且被操作人在该组必须是user或者visitor
    要求参数:group_id:int * #要操作的组ID
                    user_id:string * #要操作的用户ID(user_uniq_id的值)
    返回参数:正确或错误的通用返回

将某人禁言 GET /v1/group/disable_talk.htm
    权限要求:操作人必须是登录状态下,且是组的管理员或创建者(group.p_type的值是creator或master)
             且被操作人必须是该组的成员,group.p_type=user或visitor
    要求参数:group_id:int * #要操作的组ID
                    user_id:string * #要操作的用户ID(user_uniq_id的值)
    返回参数:正确或错误的通用返回

解除某人的禁言管制 GET /v1/group/enable_talk.htm
    权限要求:操作人必须是登录状态下,且是组的管理员或创建者(group.p_type的值是creator或master)
             且被操作人必须是该组的成员,group.p_type=user或visitor
    要求参数:group_id:int * #要操作的组ID
                    user_id:string * #要操作的用户ID(user_uniq_id的值)
    返回参数:正确或错误的通用返回

更新组的简单说明 POST /v1/group/set_desc.htm
    权限要求:操作人必须登录状态下,且是组的管理员或创建者(group.p_type的值是creator或master)
    要求参数:group_id:int * #要操作的组ID
                    g_desc:string * #更新的内容,最多85个汉字,超出后将会报未知异常
    返回参数:正确或错误的通用返回

删除一个组 GET /v1/group/del.htm
    权限要求:操作人必须登录状态下,且是组的创建者
    要求参数:group_id:int * #要删除的组
    返回参数:正确或错误的通用返回
    其它说明:组被删除后,组内所有成员均被解散