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