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