@vonage/messages
Version:
Multi-channel messaging that integrates WhatsApp, Facebook, Viber, SMS, and MMS
44 lines • 1.42 kB
TypeScript
import { AbstractAudioMessage } from '../AbstractAudioMessage';
import { MessageParamsAudio } from '../../types';
import { Channels } from '../../enums';
/**
* Represents an audio message for the MMS channel.
*
* @group MMS
*/
export declare class MMSAudio extends AbstractAudioMessage implements MessageParamsAudio {
/**
* The channel for this message (always 'mms').
*/
channel: Channels.MMS;
/**
* Time-To-Live (how long a message should exist before it is delivered
* successfully) in seconds. If a message is not delivered successfully within
* the TTL time, the message is considered expired and will be rejected if TTL
* is supported.
*/
ttl?: number;
/**
* Send an MMS audio message.
*
* @param {MessageParamsAudio} params - The parameters for creating the audio message.
*
* @example
* ```ts
* import { MMSAudio } from '@vonage/messages';
*
* const { messageUUID } = await messagesClient.send(new MMSAudio({
* to: TO_NUMBER,
* from: FROM_NUMBER,
* audio: {
* url: 'https://example.com/audio.mp3',
* },
* clientRef: 'my-personal-reference',
* }));
*
* console.log(`Message sent successfully with UUID ${messageUUID}`);
* ```
*/
constructor(params: Omit<MessageParamsAudio, 'channel' | 'messageType'>);
}
//# sourceMappingURL=MMSAudio.d.ts.map