群组禁言
橙旭园儿童编程
群组禁言
Method and URL Structure
Method |
Method Resource URL |
Descriptions |
Authentications Required |
POST |
/server/im/group/ban_group/ |
群组禁言 |
YES |
Request Parameters
Name |
Description |
Required |
Default |
group_id |
群组id |
YES |
|
except_admin |
是否把管理员加入白名单 |
NO |
False |
Request Data
{
"group_id": "test-009",
"except_admin": true
}
cURL Example
curl -X POST -H 'Content-Type: application/json' --data '{...}' http://127.0.0.1:8000/server/im/group/ban_group/
Response
{
"status":0,
"message":"",
"code":200
}
群组解除禁言
Method and URL Structure
Method |
Method Resource URL |
Descriptions |
Authentications Required |
POST |
/server/im/group/ban_group_rollback/ |
群组解除禁言 |
YES |
Request Parameters
Name |
Description |
Required |
Default |
group_id |
群组id |
YES |
|
Request Data
{
"group_id": "test-009"
}
cURL Example
curl -X POST -H 'Content-Type: application/json' --data '{...}' http://127.0.0.1:8000/server/im/group/ban_group/
Response
{
"status":0,
"message":"",
"code":200
}
查询群组禁言状态
Method and URL Structure
Method |
Method Resource URL |
Descriptions |
Authentications Required |
GET |
/server/im/group/ban_group_query/ |
查询群组禁言状态 |
YES |
Request Parameters
Name |
Description |
Required |
Default |
group_id |
群组id |
YES |
|
Request Data
{
"group_id": "test-009"
}
cURL Example
curl http://127.0.0.1:8000/server/im/group/ban_group_query/ ?group_id=test-009
Response
{
"status":0,
"message":"",
"code":200,
"groupinfo":[{
"stat":0,
"groupId":"test-003"
}]
}
Response Data Description
Name |
Description |
groupinfo |
群组信息 |
stat |
禁言状态: 0, 未禁言; 1, 已禁言; |