跳到主要内容

设置用户免打扰时段

设置用户免打扰时段与免打扰级别。

  • 该接口会设置一个免打扰时间窗口。在再次设置或删除用户免打扰时间段之前，当次设置的免打扰时间窗口会每日重复生效。例如，App 用户希望设置永久全天免打扰，可设置 startTime 为 00:00:00，period 为 1439。

  • 单个用户仅支持设置一个时间段，重复设置会覆盖该用户之前设置的时间窗口。

方法说明​

POST： https://数据中心域名/user/blockPushPeriod/set.json

调用频率：每秒钟限 100 次

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数​

HTTP 请求正文数据格式为 application/x-www-form-urlencoded，支持以下 HTTP 表单参数：

参数类型必传说明
userIdString是用户 ID
startTimeString是开始时间，精确到秒。格式为 HH:MM:SS，示例：22:00:00。注意：startTime 与应用所属数据中心有关。如您的 App 业务使用国内数据中心，请使用北京时间。如您的 App 业务使用海外数据中心，请使用 UTC 时间。
periodNumber是免打扰时间窗口大小，单位为分钟。支持范围为 [1-1439] 的整数。0 表示未设置。
levelNumber是免打扰级别。1：仅 @消息进行通知，普通消息不进行通知。5：所有消息都不进行通知。
timezoneString否时区。 如果您使用的是北京数据中心，时区的默认值为 Asia/Shanghai；如果您使用海外数据中心，则默认值为 UTC。

请求示例​

HTTP
POST /user/blockPushPeriod/set.json  HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0soslx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7as7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX(最大长度36)

userId=userId&startTime=23:59:59&period=120&level=1

返回结果​

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回值返回类型说明
codeNumber返回码，200 为正常。

返回结果示例​

HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}