创建封禁权限 编辑文档

说明

创建封禁用户权限的规则。被封禁的用户会被踢出频道

请求URL

/ban/{appKey} POST

请求头

X-Auth-Token

请求参数

参数名	类型	必须	描述
appKey	string	是	指定的appKey
-	request body	是	请求body 封禁策略优先级按以下顺序执行，只有以下4种组合有效: 1. 如果指定了channel和uid，则封禁指定uid加入指定channel; 2. 如果指定了ip则封禁所有来自指定ip的请求; 3. 如果指定了uid则封禁指定uid加入所有channel; 4. 如果指定了channel，则封禁所有uid加入指定channel. 如果封禁策略下包含正在通话的用户，他们将会被服务器直接踢掉。

请求体

{
	"channel":"string //the channel to be banned",
	"uid":"long //the uid to be banned",
	"ip":"string //the ipv4 to be banned",
	"time":"int //ban expiration, -1: for ever, 0: just kick user, >0: time in seconds"
}

返回结果

{
	"status":"int //the status code compatible with http code",
	"message":"string //the extra explain message, always 'ok' if success",
	"data":{
		"id":"long //the global unique id, if time is 0, this id would be 0",
		"channel":"string //the channel to be banned",
		"uid":"long //the uid to be banned",
		"ip":"string //the ipv4 to be banned"
	}
}

上次更新：2022-04-24