跳转至

消息白名单

设置消息类型,确保在服务器负载高时聊天室中重要类型的消息不被丢弃,设置后 2 小时生效。

此服务在开通 IM 商用版的情况下,可申请开通,详细请联系商务,电话:13161856839。

添加

说明:添加聊天室消息类型白名单,支持添加多个,最多不超过 20 个消息类型。

方法名:/chatroom/whitelist/add

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/chatroom/whitelist/add.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
objectnames String 消息标识,最多不超过 20 个,自定义消息类型,长度不超过 32 个字符,参见内置消息类型表(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<code>200</code>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

POST /chatroom/whitelist/add.json HTTP/1.1
Host: apiqa.cn.ronghub.com
App-Key: c9kqb3rdkbb7j
Nonce: 1167631608
Timestamp: 1408710653491
Signature: c8ef4d25e5684e9fca820140eaf6a36abc4fbc93
Content-Type: application/x-www-form-urlencoded

objectnames=RC:VcMsg&objectnames=RC:ImgTextMsg&objectnames=RC:ImgMsg

HTTP 响应:

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

{"code":200}

移除

方法名:/chatroom/whitelist/delete

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/chatroom/whitelist/delete.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
objectnames String 消息标识,最多不超过 20 个,自定义消息类型,长度不超过 32 个字符,参见内置消息类型表

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<code>200</code>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

POST /chatroom/whitelist/delete.json HTTP/1.1
Host: apiqa.cn.ronghub.com
App-Key: c9kqb3rdkbb7j
Nonce: 1167631608
Timestamp: 1408710653491
Signature: c8ef4d25e5684e9fca820140eaf6a36abc4fbc93
Content-Type: application/x-www-form-urlencoded

objectnames=RC:VcMsg&objectnames=RC:ImgTextMsg&objectnames=RC:ImgMsg

HTTP 响应:

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

{"code":200}

查询

方法名:/chatroom/whitelist/query

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/chatroom/whitelist/query.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

返回值

名称 类型 说明
code Int 返回码,200 为正常。
whitlistMsgType String[] 消息类型数组。

JSON 格式:

{
  "code":200,
  "whitlistMsgType":["RC:ImgMsg","RC:ImgTextMsg","RC:VcMsg"]
}

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

POST /chatroom/whitelist/query.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce:14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

HTTP 响应:

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

{
  "code":200,
  "whitlistMsgType":["RC:ImgMsg","RC:ImgTextMsg","RC:VcMsg"]
}