群组白名单
橙旭园儿童编程
把用户加入白名单
Method and URL Structure
Method |
Method Resource URL |
Descriptions |
Authentications Required |
POST |
/server/im/group/white_list_add/ |
把用户加入白名单 |
YES |
Request Parameters
Name |
Description |
Required |
Default |
group_id |
群组id |
YES |
|
user_id |
用户id |
YES |
|
Request Data
{
"group_id": "test-009",
"user_id": "user-003"
}
cURL Example
curl -X POST -H 'Content-Type: application/json' --data '{...}' http://127.0.0.1:8000/server/im/group/white_list_add/
Response
{
"status":0,
"message":"",
"code":200
}
从白名单删除用户
Method and URL Structure
Method |
Method Resource URL |
Descriptions |
Authentications Required |
POST |
/server/im/group/white_list_rollback/ |
从白名单删除用户 |
YES |
Request Parameters
Name |
Description |
Required |
Default |
group_id |
群组id |
YES |
|
user_id |
用户id |
YES |
|
Request Data
{
"group_id": "test-009",
"user_id": "user-003"
}
cURL Example
curl -X POST -H 'Content-Type: application/json' --data '{...}' http://127.0.0.1:8000/server/im/group/white_list_rollback/
Response
{
"status":0,
"message":"",
"code":200
}
查询群组白名单用户
Method and URL Structure
Method |
Method Resource URL |
Descriptions |
Authentications Required |
GET |
/server/im/group/white_list_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/white_list_query/?group_id=test-009
Response
{
"status":0,
"message":"",
"code":200,
"userIds":["user-002","user-001"]
}
Response Data Description
Name |
Description |
userIds |
白名单列表 |