@vonage/messages
Version:
Multi-channel messaging that integrates WhatsApp, Facebook, Viber, SMS, and MMS
35 lines • 1.15 kB
TypeScript
import { AbstractTextMessage } from '../AbstractTextMessage';
import { WhatsAppTextParams, WhatsAppContext } from '../../types';
import { Channels } from '../../enums';
/**
* Represents a text message for WhatsApp.
*
* @group WhatsApp
*/
export declare class WhatsAppText extends AbstractTextMessage implements WhatsAppTextParams {
/**
* The channel for this message (always 'whatsapp').
*/
channel: Channels.WHATSAPP;
context?: WhatsAppContext;
/**
* Send a WhatsApp text message.
*
* @param {WhatsAppTextParams} params - The parameters for creating a WhatsApp text message.
* @example
* ```ts
* import { WhatsAppText } from '@vonage/messages';
*
* const { messageUUID } = await messagesClient.send(new WhatsAppText({
* to: TO_NUMBER,
* from: FROM_NUMBER,
* text: 'Hello world',
* clientRef: 'my-personal-reference',
* }));
*
* console.log(`Message sent successfully with UUID ${messageUUID}`);
* ```
*/
constructor(params: Omit<WhatsAppTextParams, 'channel' | 'messageType'>);
}
//# sourceMappingURL=WhatsAppText.d.ts.map