@vonage/messages
Version:
Multi-channel messaging that integrates WhatsApp, Facebook, Viber, SMS, and MMS
44 lines • 1.55 kB
TypeScript
import { AbstractImageMessage } from '../AbstractImageMessage';
import { MessengerImageParams } from '../../types';
import { Channels } from '../../enums';
/**
* Represents an image message for the Messenger channel.
*
* This class extends the `AbstractImageMessage` class and implements the `MessengerImageParams` interface.
* It is used for sending image messages on the Messenger channel.
*
* @group Messenger
*/
export declare class MessengerImage extends AbstractImageMessage implements MessengerImageParams {
/**
* The channel for this message (always 'messenger').
*/
channel: Channels.MESSENGER;
/**
* Additional Messenger-specific parameters for the image message.
*/
messenger: import("../../types").MessengerType;
/**
* Send an image message using the Facebook Messenger channel.
*
* @param {MessengerImageParams} params - The parameters for the image message.
* @example
* ```ts
* import { MessengerImage } from '@vonage/messages';
*
* const { messageUUID } = await messagesClient.send(new MessengerImage({
* to: TO_NUMBER,
* from: FROM_NUMBER,
* image: {
* url: 'https://example.com/image.jpg',
* caption: 'This is an image',
* },
* clientRef: 'my-personal-reference',
* }));
*
* console.log(`Message sent successfully with UUID ${messageUUID}`);
* ```
*/
constructor(params: Omit<MessengerImageParams, 'channel' | 'messageType'>);
}
//# sourceMappingURL=MessengerImage.d.ts.map