添加单个用户至聊天室白名单

功能说明

将单个用户添加至聊天室白名单。

调用频率上限

100 次/秒/App Key

请求 URL

POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users/{username}

参数	类型	是否必需	描述
chatroom_id	String	是	聊天室 ID。
username	String	是	要添加聊天室白名单的用户 ID。

关于请求 URL 中的参数说明，详见 请求 URL 参数介绍。

请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X POST 'https://XXXX/XXXX/XXXX/chatrooms/{66XXXX33}/white/users/{username}'  \
-H 'Accept: application/json'   \
-H 'Authorization: Bearer <YourAppToken>' 

请求 header 参数

关于 Accept 和 Authorization 字段的说明，详见 请求 header 参数说明。

响应示例

{
  "action": "post",
  "application": "5cXXXX75d",
  "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/white/users/wzy_xiaomi",
  "entities": [],
  "data": {
    "result": true,
    "action": "add_user_whitelist",
    "user": "wzy_xiaomi",
    "chatroomid": "66XXXX33"
  },
  "timestamp": 1594724293063,
  "duration": 4,
  "organization": "XXXX",
  "applicationName": "testapp"
}

响应 body 字段

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中的 data 字段的说明如下：

字段	类型	描述
data	JSON	响应数据。
- result	Bool	是否成功将单个用户添加至聊天室白名单： - true：是； - false：否。
- chatroomid	String	聊天室 ID。
- action	String	执行操作。在该响应中，该字段的值为 add_user_whitelist，表示将用户添加至聊天室白名单中。
- user	String	添加的用户 ID。

响应体中的其他参数说明如下表所示：

参数	类型	描述
action	String	请求方法。
application	String	应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。
uri	String	请求 URL。
entities	JSON Array	响应实体。
timestamp	Long	Unix 时间戳，单位为毫秒。
duration	Int	从发送请求到响应的时长，单位为毫秒。
organization	String	环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 org_name 相同。
applicationName	String	你在环信控制台创建应用时填入的应用名称，与请求参数 app_name 相同。

错误码

如果返回的 HTTP 状态码非 200，表示请求失败，可能提示以下错误码：

HTTP 状态码	错误类型	错误提示	可能原因	处理建议
401	unauthorized	Unable to authenticate (OAuth)	token 不合法，可能过期或 token 错误。	使用新的 token 访问。
400	forbidden_op	users [XX] are not members of this group!	要添加白名单的用户 ID 不在聊天室中。	传入聊天室成员的用户 ID。
404	resource_not_found	grpID XX does not exist!	聊天室不存在。	使用合法的聊天室 ID。

关于其他错误，你可以参考 响应状态码 了解可能的原因。