Remove Channel Subscribers

Remove subscribers (members) from a channel

POST /channel/subscriber_remove

Try it

cURL

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
  }'

Success Response

{
  "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

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
  }'

Success Response

{
  "status": "ok"
}

Response Fields

status · string · required

Operation status, returns "ok" on success

Status Codes

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

Parameter Description

Temporary Subscriber (temp_subscriber)

Value	Type	Description	Impact
0	Permanent subscriber	Remove official member	Completely remove member relationship
1	Temporary subscriber	Remove temporary member	Remove 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