Skip to main content
POST
/
channel
/
subscriber_remove
curl -X POST "http://localhost:5001/channel/subscriber_remove" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_id": "group123",
    "channel_type": 2,
    "subscribers": ["user4", "user5"],
    "temp_subscriber": 0
  }'

{
  "status": "ok"
}

​
Overview

Remove subscribers (members) from a channel, supporting batch removal operations.

​
Request Body

​
Required Parameters

​
channel_id
string
required
Channel ID
​
channel_type
integer
required
Channel type
  • 1 - Personal channel
  • 2 - Group channel
​
subscribers
array
required
List of subscriber user IDs to remove
​
subscribers[]
string
User ID

​
Optional Parameters

​
temp_subscriber
integer
default:0
Whether as temporary subscriber
  • 0 - Permanent subscriber
  • 1 - Temporary subscriber
curl -X POST "http://localhost:5001/channel/subscriber_remove" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_id": "group123",
    "channel_type": 2,
    "subscribers": ["user4", "user5"],
    "temp_subscriber": 0
  }'

{
  "status": "ok"
}

​
Response Fields

​
status
string
required
Operation status, returns "ok" on success

​
Status Codes

Status CodeDescription
200Subscribers removed successfully
400Request parameter error
403No operation permission
404Channel does not exist or user not in channel
500Internal server error

​
Parameter Description

​
Temporary Subscriber (temp_subscriber)

ValueTypeDescriptionImpact
0Permanent subscriberRemove official memberCompletely remove member relationship
1Temporary subscriberRemove temporary memberRemove temporary access permission

​
Use Cases

​
Group Management

  • Kick members: Group owner or admin removes violating members
  • Member leaves: User voluntarily leaves the group
  • Batch cleanup: Clean up inactive or invalid members