设置用户单聊禁言
设置指定用户单聊会话场景下禁言,或解除禁言。如果用户被设置为单聊禁言状态,则该用户无法发送单聊消息。
提示
服务端(Server API)发送单聊消息接口不受禁言状态的限制,被禁言用户可通过 Server API 往单聊会话中发送消息。
请求方法
POST: https://数据中心域名/user/chat/fb/set.json
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
频率限制: 每秒钟限 100 次
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 被禁言用户 ID,支持批量设置,最多不超过 1000 个。 |
state | Int | 是 | 禁言状态,0 解除禁言、1 添加禁言 |
type | String | 是 | 会话类型,目前支持单聊会话 PERSON |
请求示例
POST /user/chat/fb/set.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
userId=123&userId=456&state=1&type=PERSON
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 为正常。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}