Set channel send restriction

Operation boundary

Caller: Trusted backend only
Scope: Restriction for the actual source Channel; person IDs must be canonical and CMD-derived keys are invalid; login, receiving and protocol ACKs remain allowed.
Atomicity: The policy and its independent uint64 version change atomically in one Slot apply; an identical value does not increment the version.
Success: 200 returns the applied policy with a decimal-string version; terminal disband is irreversible.
Recovery: A timeout or 503 may follow a commit; GET the current policy first. After 409, reload and make a new mutation decision instead of blindly retrying the old expected_version.

POST/channel/send_ban

Atomically set one send policy with optional decimal-string CAS; unchanged values retain the version.

Request Body

application/json

Strict bounded policy mutation.

TypeScript Definitions

Use the request body type in TypeScript.

One strict JSON object, at most 4096 bytes. Unknown fields and trailing JSON are rejected; numeric fields use Go integer syntax.

channel_id*string

Actual source Channel ID, at most 1024 UTF-8 bytes; person IDs must be canonical and CMD-derived IDs are rejected.

Match^\S(?:[\s\S]*\S)?$

Length1 <= length <= 1024

channel_type*integer

Source Channel type; 1 denotes a canonical person Channel, 2 a group.

Range1 <= value <= 255

uid?|

Must be absent, empty or null for a Channel policy.

Value in

""
null

send_ban*integer

Required integer flag: 1 restricts application SEND, 0 clears it. Login, receiving and protocol ACKs remain allowed.

Value in

expected_version?|

Optional apply-time CAS version; omitted or null means unconditional. Overflow, leading zeros and signs are rejected.

Match

^(?:0|[1-9][0-9]{0,18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]{1}|1844674407370955161[0-4]|18446744073709551615)$

Response Body

`application/json`

{  "status": 200,  "data": {    "channel_id": "string",    "channel_type": 1,    "send_ban": 0,    "send_ban_version": "string"  }}

Set channel send restriction

Request Body

Response Body

200application/json

400application/json

404application/json

409application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`