@vonage/messages
Version:
Multi-channel messaging that integrates WhatsApp, Facebook, Viber, SMS, and MMS
44 lines • 1.43 kB
TypeScript
import { AbstractVideoMessage } from '../';
import { RCSVideoParams } from '../../types';
import { Channels } from '../../enums';
/**
* Represents an video message for the RCS channel.
*
* @group RCS
*/
export declare class RCSVideo extends AbstractVideoMessage implements RCSVideoParams {
/**
* The channel through which the message will be sent. Always `rcs`
*/
channel: Channels.RCS;
/**
* The duration in seconds the delivery of a message will be attempted. By
* default Vonage attempts delivery for 72 hours, however the maximum effective
* value depends on the operator and is typically 24 - 48 hours. We recommend
* this value should be kept at its default or at least 30 minutes.
*/
ttl?: number;
/**
* Send an RCS video message.
*
* @param {RCSVideoParams} params - The parameters for creating the video message.
*
* @example
* ```ts
* import { RCSVideo } from '@vonage/messages';
*
* const { messageUUID } = await messagesClient.send(new RCSVideo({
* to: TO_NUMBER,
* from: FROM_NUMBER,
* audio: {
* url: 'https://example.com/video.mp4',
* },
* clientRef: 'my-personal-reference',
* }));
*
* console.log(`Message sent successfully with UUID ${messageUUID}`);
* ```
*/
constructor(params: RCSVideoParams);
}
//# sourceMappingURL=RCSVideo.d.ts.map