• default
    • UserMessage


appleCriticalAlertOptions: null | AppleCriticalAlertOptions = null

The apple critical alert options of the message.

channelType: ChannelType = ChannelType.BASE

The ChannelType of the channel this message belongs to.

channelUrl: string

The channel URL of the channel this message belongs to.

createdAt: number = 0

The creation time of the message in milliseconds.

customType: string

The custom type of the message.

data: string

The custom type of the message.

errorCode: number = 0

The error code of them message if the sendingStatus is FAILED.

extendedMessage: object = {}

The template for the message.

extendedMessagePayload?: Record<string, unknown>

The datas for the message.

forms: null | default[] = null

List of Form that allow users to input their information or opinions

isOperatorMessage: boolean = false

Whether the message was sent from an operator.

mentionType: null | MentionType = null

The mention type. Refer to MentionType.

mentionedMessageTemplate: string

The mentioned message template of the message.

mentionedUserIds: null | string[] = null

The mentioned user ids of the message.

mentionedUsers: null | User[] = null

The mentioned users of the message.

message: string = ''

The message text of the message.

messageId: number

The ID of the message.

messageParams: null | UserMessageCreateParams = null

The messageParams object that used for sending this message For more details.

messageReviewInfo?: MessageReviewInfo
messageSurvivalSeconds: number = -1
messageType: MessageType = MessageType.BASE
metaArrays: MessageMetaArray[] = []

Gets an array of meta arrays sorted by chronological order.

myFeedback: null | Feedback = null

My feedback of the message. Not null, if its FeedbackStatus is FeedbackStatus.SUBMITTED Null, if its FeedbackStatus is FeedbackStatus.NOT_APPLICABLE or FeedbackStatus.NO_FEEDBACK/b>.

myFeedbackStatus: FeedbackStatus = 'NOT_APPLICABLE'

My feedback status of the message.

ogMetaData: null | OGMetaData

The OGMetaData of the message. Might be null if

parentMessage: null | BaseMessage = null

The parent message of this message. Only NonNull if this message is a reply message. It does not contain all properties of the parent message.

parentMessageId: number

The parent message's ID if this is a reply message.

plugins: Plugin[] = []
reactions: Reaction[] = []

The reactions on the message.

replyToChannel: boolean = false

Determines whether the current message is a replied message and also a message was replied to the channel.

reqId: string = ''
scheduledInfo: null | ScheduledInfo = null

The scheduled info of the message if this is a scheduled message

sender: Sender

Sender of the message. This is represented by Sender class.

sendingStatus: SendingStatus

The sending status of the message.

silent: boolean = false

Checks whether the message is silent or not.

suggestedReplies: null | string[] = null

The suggested replies of the message.

threadInfo: null | ThreadInfo = null

The thread info of the message.

translationTargetLanguages: string[] = []
translations: object = {}
updatedAt: number = 0

The updated time of the message in milliseconds.


  • get isResendable(): boolean
  • Returns boolean

  • get poll(): null | Poll
  • Returns null | Poll


  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    Returns void

  • Parameters

    Returns boolean

  • Parameters

    • feedbackId: number

    Returns Promise<void>

  • Parameters

    • message: default

    Returns boolean

  • Returns this is FileMessage

  • Parameters

    • message: default

    Returns boolean

  • Returns this is UserMessage

  • Returns Promise<void>

  • Returns object

  • Parameters

    • pushEnabled: boolean

    Returns Promise<void>

  • Message Feedback


    • data: Pick<Feedback, "rating" | "comment">

    Returns Promise<void>

  • Parameters

    • data: {
          answers?: Record<string, string>;
          formId?: string;
      • Optional answers?: Record<string, string>
      • Optional formId?: string

    Returns Promise<void>


    since v4.10.6. Use submitForm({ form: Form }) instead.

  • Parameters

    Returns Promise<void>

Generated using TypeDoc