Skip to content

Latest commit

 

History

History
25 lines (22 loc) · 2.95 KB

GroupChannelMessageSendRequest.md

File metadata and controls

25 lines (22 loc) · 2.95 KB

GroupChannelMessageSendRequest

Properties

Name Type Description Notes
from_user_id string Sender user ID. Server-side sending does not require the sender to be a group member, but push display works best when the sender has an access token.
to_channel_ids string[] Target group channel IDs. Up to 3 groups are supported per request. Targeted messages support only one group.
to_user_ids string[] Recipient member user IDs for a targeted group message. Only effective when sending to a single group. [optional]
message_type string Message type. Supports built-in types and custom types registered in the client SDK. Custom types must not start with `RC:` and must not exceed 32 characters.
content string Message content payload serialized as a string. Built-in message types should use a JSON object string. Maximum size is 128 KB.
push_content string Push notification text for offline recipients. Optional for built-in user content messages and required for push-enabled custom or notification messages. [optional]
push_data string Custom push payload data. Exposed as `appData` on mobile push payloads. [optional]
is_echo_to_sender int Whether to sync the sent message to the sender's client while online. `1` enables sync and `0` disables it. [optional]
should_persist int Whether to store the message in cloud message history. `0` means do not store and `1` means store. [optional]
has_mention int Whether this is an @mention message. Set to `1` when `content` contains `mentionedInfo`. [optional]
content_available int iOS silent-push flag. `1` enables background delivery and `0` disables it. [optional]
has_metadata bool Whether to enable message metadata for this message. Only effective when sending to a single group channel. [optional]
metadata array<string,mixed> Custom message metadata entries. Only effective when `hasMetadata` is `true` and the request targets a single group. [optional]
disable_push bool Whether to suppress push notifications. Only effective when the request targets a single group channel. [optional]
push_ext string Extended push configuration (JSON string as accepted by `GroupChannelMsgSendInput`). [optional]
disable_update_last_msg bool Whether to keep this message from updating the channel's last-message preview. [optional]
need_read_receipt int Whether to request read receipts for this persisted message. `1` requests read receipts and `0` disables them. [optional]

[Back to Model list] [Back to API list] [Back to README]