WuKongIM Docs
WuKongIM HTTP APIUsers

Read user send restriction

Edit this pageReport a docs issue

Operation boundary

  • Caller: Trusted backend only
  • Scope: Global application-send restriction for one UID; login, receiving and protocol ACKs remain allowed.
  • Success: Reads current UID Slot authority; an unknown UID returns allow/version 0.
  • Recovery: On 503, keep the policy unknown and retry reads with backoff; unavailable authority is not evidence of allow.
GET/user/send_ban

Read one current Slot-owned send policy without returning credentials.

Query Parameters

uid*string

UID with no surrounding whitespace; runtime limits its UTF-8 encoding to 512 bytes.

Match^\S(?:[\s\S]*\S)?$
Length1 <= length <= 512

Response Body

application/json

application/json

application/json

{  "status": 200,  "data": {    "uid": "string",    "send_ban": 0,    "send_ban_version": "string"  }}

Remove node-local system UID cache entries

Mutates only the current process cache and does not change durable system identities.

Set user send restriction

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