Hierarchy
- NIMMessage
Index
Properties
- apns
- attach
- callback
Ext - cc
- content
- custom
- delete
- env
- file
- flow
- from
- from
Client Type - from
Device Id - from
Nick - geo
- id
Client - id
Server - is
Historyable - is
In Black List - is
Local - is
Muted - is
Offlinable - is
Pushable - is
Reply Msg - is
Roamingable - is
Syncable - is
Unreadable - local
Custom - need
Push Nick - need
Update Session - push
Content - push
Payload - reply
Msg From Account - reply
Msg Id Client - reply
Msg Id Server - reply
Msg Time - reply
Msg To Account - resend
- scene
- session
Id - status
- sub
Type - target
- temp
Team Member Count - text
- thread
Msg From Account - thread
Msg Id Client - thread
Msg Id Server - thread
Msg Time - thread
Msg To Account - time
- tip
- to
- type
- user
Update Time - yidun
Anti Spam Res
Properties
Optional apns
Special option for the push service, used only in group chats.
Type declaration
Optional accounts?: string[]
A list of accounts for push notifications. If unspecified, all members in the conversation will receive push notifications.
Optional content?: string
Body of a push notification
Optional force
Push?: boolean whether force push notification is required, The default value is false
True: send a push notification even if the user has muted the conversation,
Optional attach
additional Information about a group notification. Valid if type=notification.
Optional callback
Custom webhook extension field
Optional cc
Whether the notification is synced using the messaging webhook, The default value is true
Optional content
The body of a custom message, you can use custom text. It is recommended to wrap it in a JSON string. The field is valid if type=custom
Optional custom
Extension field
Note that the data must be in JSON string
Optional delete
Whether the message has been unsent or deleted for the current user. The field is required when getting the thread message list.
Optional env
Specifies the environment name of webhooks for the current message. If you have enabled messaging webhooks or custom webhooks, you can configure the environment name in the CommsEase console with a maximum of 32 characters.
- note
- For information about how to enable and configure messaging webhooks, see Enable messaging webhooks.
- For information about custom webhooks, see Custom webhooks overview.
Optional file
the file in a file message with type = image, audio, video or file and status = success,
flow
Message direction
'in': received messages 'out' sent messages
from
account of a sender
Optional from
Client type of the sender
Optional from
Device ID of the sender
Optional from
Nickname of the message sender
Optional geo
Geolocation object in a local message with type = geo
id
The message ID generated by the client test can be used as the unique primary key of the message.
Optional id
The ID used by the server to distinguish messages, used to get message history and keywords for searching message history.
Note: This field may not be available. For example, the message is filtered by anti-spam.
Optional is
Whether is the message is stored on the server. The default value is true
Optional is
Whether the sender 'from' is in the blacklist of the recipient 'to'
Optional is
Whether a message is a local message stored in the database, The default value is false.
Optional is
Whether the recipient is muted
Optional is
Whether the message is stored for offline messages. Default value: true
Optional is
Whether a push notification is required. Default value: true
Optional is
Whether it is a response message (for response message content such as robots and similar scenarios)
Optional is
Whether the message is stored for synchronization on new devices. Default value: true
Optional is
Whether the message is synced across devices. Default value: true
Optional is
Whether the message is counted as unread. Default value: true
Optional local
Custom extension field of a conversation in the local database if database is enabled.
Optional need
Whether a push notification is required with the nickname
Optional need
Whether to refresh the list of conversations on the server. The default value is true.
Optional push
Custom text for push notifications
Optional push
Custom property of a push notification. For more information about push notifications, see Configure parameters for the payload of the push notification service.</ a>
Note that the data must be in JSON string
Optional reply
Sender of a replied message
Optional reply
idClient of a replied message
Optional reply
idServer of a replied message
Optional reply
Sent time of a replied message
Optional reply
Recipient of a replied message.
Optional resend
Whether the message is resent. The default value is false.
scene
Messaging use case:
- p2p: Private chat
- team: group chat
- superteam: supergroup chat
session
The ID of the conversation to which the message belongs
status
State of a message
'sending' 'success' 'fail'
Optional sub
Custom message subtype, an integer greater than 0.
target
Target account, account ID or group ID
Optional temp
The snapshot of the group's read messages ( the number of people in the group when the message is sent - 1)
Optional text
body of a text message, if type = text
Optional thread
Sender of a message in a thread
Optional thread
idClient of a thread message
Optional thread
idServer of a thread message
Optional thread
Sent time of a thread message
Optional thread
Recipient of a thread message
time
Timestamp
Optional tip
body of an alert with type=tip
to
ID of a recipient, account ID or group ID
type
Message type
user
Update time of the message
Optional yidun
The result returned by GuardEase
Note: If GuardEase Moderator is enabled, and the text or image is hit by the moderation rule, the client will transmit the result field.
message body for private chats, group chats and supergroup chats