获取聊天室自定义属性

功能说明

获取指定聊天室的自定义属性信息。

调用频率上限

100 次/秒/App Key

请求 URL

POST https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}

参数	类型	是否必需	描述
chatroom_id	String	是	聊天室 ID。

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

请求示例

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

curl -X POST 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13'   \
-H 'Content-Type: application/json'   \
-H 'Accept: application/json'   \
-H 'Authorization: Bearer <YourAppToken>'   \
-d '{
    "keys": ["key1","key2"]
 }' 

请求 header 参数

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

请求 body 参数

参数	类型	是否必需	描述
keys	Array	否	聊天室自定义属性名称列表。

响应示例

{
  "uri": "https://XXXX/XXXX/XXXX/metadata/chatroom", 
  "timestamp": 1716891388636, 
  "action": "post", 
  "data": {
    "key1": "value1", 
    "key2": "value2"
  }
}

响应 body 字段

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

字段	类型	描述
data	Object	聊天室自定义属性，为键值对格式，key 为属性名称，value 为属性值。

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

参数	类型	描述
uri	String	请求 URL。
timestamp	Long	Unix 时间戳，单位为毫秒。
action	String	请求方法。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 错误码 了解可能的原因。

错误码

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

HTTP 状态码	错误类型	错误提示	可能原因	处理建议
401	unauthorized	Unable to authenticate (OAuth)	token 不合法，可能过期或 token 错误。	使用新的 token 访问。
404	resource_not_found	grpID XX does not exist!	聊天室 ID 不存在。	传入存在的合法的聊天室 ID。

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