添加单个聊天室成员

功能说明

• 向聊天室添加一个成员。
• 添加聊天室成员会触发发送后回调，详见 聊天室加人事件。

调用频率上限

100 次/秒/App Key

请求 URL

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

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

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

请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token

curl -X POST 'https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/users/user1'  \
-H 'Content-Type: application/json'  \
-H 'Accept: application/json'  \
-H 'Authorization: Bearer <YourAppToken>' 

请求 header 参数

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

响应示例

若要添加的用户已在聊天室中，会返回响应成功。

{
  "action": "post",
  "application": "8beXXXX02",
  "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/users/user1",
  "entities": [],
  "data": {
    "result": true,
    "action": "add_member",
    "id": "66XXXX33",
    "user": "user1"
  },
  "timestamp": 1542554038353,
  "duration": 0,
  "organization": "XXXX",
  "applicationName": "testapp"
}

响应 body 字段

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

参数	类型	描述
data	JSON	响应数据。
- result	Bool	是否添加成功： - true：是； - false：否。
- action	String	执行的操作，add_member 表示向聊天室添加成员。
- id	String	聊天室 ID，聊天室唯一标识符，由环信即时通讯 IM 服务器生成。
- user	String	添加到聊天室的用户。

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

参数	类型	描述
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 访问。
404	resource_not_found	grpID XX does not exist!	聊天室 ID 不存在。	传入存在的合法的聊天室 ID。
404	resource_not_found	username XXX doesn't exist!	要添加的用户 ID 不存在。	传入存在的用户 ID。
403	exceeded_limit	can not join this group, reason:user XXX has joined too many chatrooms!	要添加的用户已加入了太多的聊天室。	传入其他用户 ID。

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