@vonage/messages
Version:
Multi-channel messaging that integrates WhatsApp, Facebook, Viber, SMS, and MMS
38 lines • 1.27 kB
TypeScript
import { AbstractImageMessage } from '../AbstractImageMessage';
import { WhatsAppImageParams, WhatsAppContext } from '../../types';
import { Channels } from '../../enums';
/**
* Represents an image message for WhatsApp.
*
* @group WhatsApp
*/
export declare class WhatsAppImage extends AbstractImageMessage implements WhatsAppImageParams {
/**
* The channel for this message (always 'whatsapp').
*/
channel: Channels.WHATSAPP;
context?: WhatsAppContext;
/**
* Sends an image message to a WhatsApp user.
*
* @param {WhatsAppImageParams} params - The parameters for creating a WhatsApp image message.
* @example
* ```ts
* import { WhatsAppImage } from '@vonage/messages';
*
* const { messageUUID } = await messagesClient.send(new WhatsAppImage({
* to: TO_NUMBER,
* from: FROM_NUMBER,
* image: {
* url: 'https://example.com/image.jpg',
* caption: 'This is an image message',
* },
* clientRef: 'my-personal-reference',
* }));
*
* console.log(`Message sent successfully with UUID ${messageUUID}`);
* ```
*/
constructor(params: Omit<WhatsAppImageParams, 'channel' | 'messageType'>);
}
//# sourceMappingURL=WhatsAppImage.d.ts.map