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