@vonage/messages
Version:
Multi-channel messaging that integrates WhatsApp, Facebook, Viber, SMS, and MMS
52 lines • 1.66 kB
TypeScript
import { AbstractMessage } from '../AbstractMessage';
import { MessageParamsContent, MessageContentObject } from '../../types';
import { Channels } from '../../enums';
import { MessageTypes } from '../../enums/MessageTypes';
/**
* Represents a custom message for the MMS channel.
*
* @group MMS
*/
export declare class MMSContent extends AbstractMessage {
/**
* The channel for this message (always 'mms').
*/
channel: Channels.MMS;
/**
* The type of message (always 'content').
*/
messageType: MessageTypes.CONTENT;
/**
* 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;
content: Array<MessageContentObject>;
/**
* Send an MMS custom message.
*
* @param {MessageParamsContent} params - The parameters for creating the custom message.
* @example
* ```ts
* import { MMSContent } from '@vonage/messages';
*
* const { messageUUID } = await messagesClient.send(new MMSContent({
* to: TO_NUMBER,
* from: FROM_NUMBER,
* custom: [
* {
* type: 'image',
* url: 'https://example.com/image.jpg',
* caption: 'My cool image',
* }
* ],
* });
*
* console.log(`Message sent successfully with UUID ${messageUUID}`);
* ```
*/
constructor(params: Omit<MessageParamsContent, 'channel' | 'messageType'>);
}
//# sourceMappingURL=MMSContent.d.ts.map