# 群名称保护
[异步回调]
可调用该接口禁止群成员修改群名称。
目前企业微信客户端,该开关开启后,群成员仍旧可以成功修改群名称,修改成功后系统又自动将群名称修改回之前的群名。
接口设置条件:
- 仅群主和群管理员可设置群名保护开关。
- 群聊已设置群名称。
接口效果:
内部群:目前不支持
外部群:开关启用后,群成员将无权限修改群名称,只有群主和群管理员可更改群名。
请求方式:POST
请求地址:https://$basehost/gateway/qopen/RestrictGroupNameChange
body参数:
{
"robot_id": "机器人id",
"group_id": "群id",
"switch": true
}
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
robot_id | string | 是 | 机器人id |
group_id | string | 是 | 群id |
switch | bool | 是 | true开启群名称保护,false关闭群名称保护 |
返回值:
{
"data": {
"serial_no": ""
},
"errcode": 0,
"errmsg": "",
"hint": ""
}
返回说明
字段 | 类型 | 说明 |
---|---|---|
errcode | int | 状态码,0为正常,非0代表错误 |
errmsg | string | 错误信息 |
data | json | json返回值 |
serial_no | string | 操作序列号 |
hint | string | 请求日志ID |
encoding_content解密后的结构:
{
"event_type": 40026,
"serial_no": "操作序列号",
"err_code": 0,
"err_msg": "success",
"data": {
"robot_id": "机器人id",
"group_id": "群id",
"switch": true
}
}
说明
字段 | 类型 | 说明 |
---|---|---|
event_type | int | 事件类型,40026 |
serial_no | string | 操作序列号 |
err_code | int | 状态码,0为正常,非0代表错误 |
err_msg | string | 错误信息 |
robot_id | string | 机器人id |
group_id | string | 群id |
switch | bool | 开关状态 |
完整请求示例:
curl -X POST \
https://$basehost/gateway/qopen/RestrictGroupNameChange \
-H 'Content-Type: application/json; charset=UTF-8' \
-H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
-d '{
"robot_id": "机器人id",
"group_id": "群id",
"switch": true
}'
← 设置群管理员(废弃) 设置群内昵称 →