| user_id |
str |
Specifies the user ID of the sender. |
|
| message_type |
str |
Specifies the type of the message as MESG, FILE or ADMM |
|
| message |
str |
Specifies the content of the message. |
|
| channel_type |
str |
Specifies the type of the channel. Either open_channels or group_channels. |
[optional] |
| channel_url |
str |
Specifies the URL of the channel to send a message to. |
[optional] |
| custom_type |
str |
Specifies a custom message type which is used for message grouping. The length is limited to 128 characters.<br /><br /> Custom types are also used within Sendbird's Advanced analytics to segment metrics, which enables the sub-classification of data views. |
[optional] |
| data |
str |
Specifies additional message information such as custom font size, font type or `JSON` formatted string. |
[optional] |
| send_push |
bool |
Determines whether to send a push notification for the message to the members of the channel (applicable to group channels only). Unlike text and file messages, a push notification for an admin message is not sent by default. (Default: true) |
[optional] |
| mention_type |
str |
Specifies the mentioning type which indicates the user scope who will get a notification for the message. Acceptable values are users and channel. If set to users, only the specified users with the mentioned_users property below will get notified. If set to channel, all users in the channel will get notified. (Default: users) |
[optional] |
| mentioned_user_ids |
[str] |
Specifies an array of one or more IDs of the users who will get a notification for the message. |
[optional] |
| is_silent |
bool |
Determines whether to send a message without updating some of the channel properties. If a message is sent in a channel, with this property set to true, the channel's last_message is updated only for the sender while its unread_message_count remains unchanged for all channel members. Also, the message doesn't send a push notification to message receivers. If the message is sent to a hidden channel, the channel still remains hidden. (Default: false)</br></br> Once the value of this property is set, it can't be reverted. |
[optional] |
| sorted_metaarray |
str |
Specifies a `JSON` object of one or more key-values items which store additional message information. Each item consists of a key and the values in an array. Items are saved and will be returned in the exact order they've been specified. |
[optional] |
| created_at |
int |
Specifies the time that the message was sent, in Unix milliseconds format. This property can be used when migrating the messages of other system to Sendbird server. If specified, the server sets the message's creation time as the property value. |
[optional] |
| dedup_id |
str |
Specifies the unique message ID created by other system. In general, this property is used to prevent the same message data from getting inserted when migrating the messages of the other system to Sendbird server. If specified, the server performs a duplicate check using the property value. |
[optional] |
| apns_bundle_id |
str |
Specifies the bundle ID of the client app in order to send a push notification to iOS devices. You can find this in Settings > Chat > Notifications > Push notification services |
[optional] |
| sound |
str |
Specifies the name of the file that sounds for critical alerts. |
[optional] |
| volume |
float |
Specifies the volume of the critical alert sound. The volume ranges from 0.0 to 1.0, which indicates silent and full volume, respectively. (Default 1.0) |
[optional] |
| url |
str |
|
[optional] |
| file |
str |
|
[optional] |
| file_name |
str |
|
[optional] |
| file_size |
float |
|
[optional] |
| file_type |
str |
|
[optional] |
| thumbnails |
[str] |
|
[optional] |
| thumbnail1 |
str |
|
[optional] |
| thumbnail2 |
str |
|
[optional] |
| thumbnail3 |
str |
|
[optional] |
| any string name |
bool, date, datetime, dict, float, int, list, str, none_type |
any string name can be used but the value must be the correct type |
[optional] |