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

{
  "status": "ok"
}

​
Overview

Add subscribers (members) to a channel, supporting batch addition and reset mode.

​
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 add
​
subscribers[]
string
User ID

​
Optional Parameters

​
reset
integer
default:0
Whether to reset existing subscribers
  • 0 - Do not reset, append new subscribers
  • 1 - Reset, replace all existing subscribers
​
temp_subscriber
integer
default:0
Whether as temporary subscriber
  • 0 - Permanent subscriber
  • 1 - Temporary subscriber
curl -X POST "http://localhost:5001/channel/subscriber_add" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_id": "group123",
    "channel_type": 2,
    "subscribers": ["user4", "user5", "user6"],
    "reset": 0,
    "temp_subscriber": 0
  }'

{
  "status": "ok"
}

​
Response Fields

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

​
Status Codes

Status CodeDescription
200Subscribers added successfully
400Request parameter error
403No operation permission
404Channel does not exist
500Internal server error

​
Parameter Description

​
Reset Mode (reset)

ValueModeDescriptionUse Case
0Append modeAdd new members to existing membersInvite new members to join
1Reset modeClear existing members, set as new member listRebuild group

​
Temporary Subscriber (temp_subscriber)

ValueTypeFeaturesApplicable Scenario
0Permanent subscriberPersistent member relationshipOfficial group members
1Temporary subscriberTemporary member relationshipTemporary visitors, meeting participants

​
Use Cases

​
Group Management

  • Invite new members: Group owner or admin invites new users to join the group
  • Batch import: Batch import member lists from other platforms
  • Rebuild group: Use reset mode to rebuild group members