Update Channel Info

Update or add channel basic information

POST /channel/info

Try it

cURL

curl -X POST "http://localhost:5001/channel/info" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_id": "group123",
    "channel_type": 2,
    "large": 1,
    "ban": 0
  }'

Success Response

{
  "status": "ok"
}

Overview

Update or add basic information for channels, including channel type, large group identifier, mute status, etc.

Request Body

Required Parameters

channel_id · string · required

Channel ID

channel_type · integer · required

Channel type

• 1 - Personal channel
• 2 - Group channel

Optional Parameters

ban · integer · default: 0

Whether to mute

• 0 - Allow speaking
• 1 - Mute all members

disband · integer · default: 0

Whether to disband channel

• 1 - Disband channel (irreversible)

send_ban · integer · default: 0

Whether to prohibit sending messages (0=not prohibited, 1=prohibited). When prohibited, all members in the channel cannot send messages. Personal channels can receive messages but cannot send messages.

allow_stranger · integer · default: 0

Whether to allow strangers to send messages (0=not allowed, 1=allowed) (this configuration currently only supports personal channels) Personal channel: If AllowStranger is 1, strangers can send messages to the current user. For example: if the current account needs to accept stranger messages, channel_id is the current user’s uid

cURL

curl -X POST "http://localhost:5001/channel/info" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_id": "group123",
    "channel_type": 2,
    "large": 1,
    "ban": 0
  }'

Success Response

{
  "status": "ok"
}

Response Fields

status · string · required

Operation status, returns "ok" on success

Status Codes

Status Code	Description
200	Channel info updated successfully
400	Request parameter error
404	Channel does not exist
500	Internal server error

Parameter Details

Channel Type (channel_type)

Value	Type	Description	Features
1	Personal channel	One-on-one private chat	Only two members, no group features
2	Group channel	Multi-user group chat	Supports multiple members, group management features

Mute Status (ban)

Value	Description	Scope	Management Permission
0	Allow speaking	All members can send messages normally	Group owner and admins can modify
1	Mute all	Only admins can send messages	Only group owner can modify