Wapi.js Docs / ContactMessageEvent

Class: ContactMessageEvent

Represents an event that occurs when a contact message is received.

Implements

Extends

Implements

Constructors

new ContactMessageEvent()

new ContactMessageEvent(params): ContactMessageEvent

Creates a new instance of ContactMessageEvent.

Parameters

params

The parameters for creating the event.

params.client: Client

The client associated with the event.

params.data

The data associated with the event.

params.data.contact: ContactMessage

params.data.from: string

params.data.isForwarded: boolean

params.data.messageId: string

params.data.timestamp: string

Returns

ContactMessageEvent

Overrides

MessageEvent.constructor

Source

packages/wapi.js/src/webhook/events/contacts/index.ts:34

Properties

client

client: Client

The client instance associated with the event.

Implementation of

ContactMessageEventInterface.client

Inherited from

MessageEvent.client

Source

packages/wapi.js/src/webhook/events/base/index.ts:20


contact

contact: ContactMessage

The contact message associated with this event.

Memberof

ContactMessageEvent

Implementation of

ContactMessageEventInterface.contact

Source

packages/wapi.js/src/webhook/events/contacts/index.ts:21


context

context: MessageContext

The context of the message.

Implementation of

ContactMessageEventInterface.context

Inherited from

MessageEvent.context

Source

packages/wapi.js/src/webhook/events/base/index.ts:37


isForwarded

isForwarded: boolean

Inherited from

MessageEvent.isForwarded

Source

packages/wapi.js/src/webhook/events/base/index.ts:39


messageId

messageId: string

The ID of the message.

Implementation of

ContactMessageEventInterface.messageId

Inherited from

MessageEvent.messageId

Source

packages/wapi.js/src/webhook/events/base/index.ts:36


timestamp

timestamp: number

The timestamp of the message.

Implementation of

ContactMessageEventInterface.timestamp

Inherited from

MessageEvent.timestamp

Source

packages/wapi.js/src/webhook/events/base/index.ts:38

Methods

react()

react(params): Promise<object | object>

Reacts to the message with an emoji.

Parameters

params

The parameters for the reaction.

params.emoji: string

The emoji to react with.

params.phoneNumber: string

The phone number of the sender.

Returns

Promise<object | object>

  • A promise that resolves with the reaction response.

Inherited from

MessageEvent.react

Source

packages/wapi.js/src/webhook/events/base/index.ts:100


read()

read(): Promise<object | object | object | object | object>

Marks the message as read.

Returns

Promise<object | object | object | object | object>

  • A promise that resolves with the read response.

Inherited from

MessageEvent.read

Memberof

MessageEvent

Source

packages/wapi.js/src/webhook/events/base/index.ts:121


reply()

reply<T>(props): Promise<object | object>

Sends a reply to the message.

Type parameters

T extends BaseMessage<string>

Parameters

props

The properties for the reply.

props.message: T

The message to send as a reply.

Returns

Promise<object | object>

  • A promise that resolves when the reply is sent.

Inherited from

MessageEvent.reply

Throws

  • If the context message ID is not found.

Source

packages/wapi.js/src/webhook/events/base/index.ts:75