Submit a message

Operation boundary

Caller: Trusted backend only
Scope: Messages are submitted by a trusted backend; optional X-WK-Trace-ID must be 32 hexadecimal characters or the server ignores it and generates a new value.
Success: Even with HTTP 200, inspect reason; only a success Reason Code means the message was accepted.

POST/message/send

Accepts the complete compatibility parser, including legacy aliases, transient flags, and request-scoped subscribers; inspect reason on HTTP 200.

Header Parameters

X-WK-Trace-ID?string

Optional 32-character hexadecimal trace ID; an invalid value is ignored and replaced with a generated ID.

Match^[0-9a-fA-F]{32}$

Request Body

application/json

Message and delivery options submitted by the trusted backend.

TypeScript Definitions

Use the request body type in TypeScript.

Complete compatibility message-send parameters.

from_uid?string

Message sender UID; when empty, sender_uid is consulted, and when both are empty the system account configured by message.system_uid is used.

sender_uid?string

Deprecated

Deprecated sender-UID alias used only when from_uid is empty; when both are empty, the configured system account is used.

device_id?string

Caller-supplied sending-device identifier; it may be empty.

channel_id?string

Target Channel ID; required for an ordinary send and required to be empty for a request-scoped subscribers send.

channel_type?integer

Target Channel type; it must be greater than 0 for an ordinary send and is 0 for a request-scoped subscribers send.

Formatuint8

Range0 <= value <= 255

client_msg_no?string

Optional client idempotency key; an empty string disables idempotency lookup.

setting?integer

WKProto Setting bitset; combine SDK constants instead of writing unknown bits by hand.

Formatuint8

Range0 <= value <= 255

topic?string

Optional Topic; it has protocol meaning only when the matching Setting bit and client capability are present.

expire?integer

Caller-supplied message expiration in seconds; 0 means no expiration is set.

Formatuint32

Range0 <= value

payload*string

Base64-encoded message payload; decoding failure returns 400.

Length1 <= length

subscribers?array<string>|

Request-scoped delivery UIDs; when non-empty, channel_id must be empty and sync_once must be enabled; the field may be omitted, empty, or null.

header?|

Optional compatibility header flags; it may be an object, null, or omitted.

no_persist?integer

Top-level compatibility flag; non-zero means non-durable and is ORed with header.no_persist.

Default0

sync_once?integer

Top-level compatibility flag; non-zero means a one-shot command message and is ORed with header.sync_once.

Default0

[key: string]?any

Response Body

`application/json`

{  "message_id": 0,  "message_seq": 0,  "reason": 1}

Submit a message

Header Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

408application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`