修改群组公告

功能说明

• 修改指定群组 ID 的群组公告。
• 群组公告不能超过 512 个字符。

调用频率上限

100 次/秒/App Key

请求 URL

POST https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/announcement

参数	类型	是否必需	描述
group_id	String	是	群组 ID。

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

请求示例

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

curl -X POST 'https://XXXX/XXXX/XXXX/chatgroups/6XXXX7/announcement'   \
-H 'Content-Type: application/json'   \
-H 'Accept: application/json'  \
-H 'Authorization: Bearer <YourAppToken>'  \
-d '{"announcement" : "群组公告…"}' 

请求 header 参数

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

请求 body 参数

参数	类型	是否必需	描述
announcement	String	是	新的群组通告内容。

响应示例

{
  "action": "post",
  "application": "8bXXXX02",
  "uri": "https://XXXX/XXXX/XXXX/chatgroups/6XXXX7/announcement",
  "entities": [],
  "data": {
    "id": "6XXXX7",
    "result": true
  },
  "timestamp": 1542363546590,
  "duration": 0,
  "organization": "XXXX",
  "applicationName": "testapp"
}

响应 body 字段

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

字段	类型	描述
data.id	String	群组 ID。
data.result	Bool	修改结果： - true：修改成功； - false：修改失败。

其他字段的描述如下表所示：

字段	类型	描述
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 状态码非 200，表示请求失败，可能提示以下错误码：

HTTP 状态码	错误类型	错误提示	可能原因	处理建议
400	illegal_argument	announcement is null	没有传递公告内容。	需传递公告内容。
403	group_announce_violation	group announcement is violation, please change it.	群公告不合法。	使用合法的群公告。
401	unauthorized	Unable to authenticate (OAuth)	token 不合法，可能过期或 token 错误。	使用新的 token 访问。
404	resource_not_found	grpID XX does not exist!	群组不存在。	使用合法的群 ID。
403	FORBIDDEN	announce info length exceeds limit!	设置公告长度超限制。	设置较短的公告

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