@vonage/messages
Version:
Multi-channel messaging that integrates WhatsApp, Facebook, Viber, SMS, and MMS
43 lines • 1.44 kB
TypeScript
import { AbstractImageMessage } from '../AbstractImageMessage';
import { RCSImageParams } from '../../types';
import { Channels } from '../../enums';
/**
* Represents an image message for the RCS channel.
*
* @group RCS
*/
export declare class RCSImage extends AbstractImageMessage implements RCSImageParams {
/**
* 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 image message.
*
* @param {RCSImageParams} params - The parameters for creating the image message.
* @example
* ```ts
* import { RCSImage } from '@vonage/messages';
*
* const { messageUUID } = await messagesClient.send(new RCSImage({
* to: TO_NUMBER,
* from: FROM_NUMBER,
* image: {
* url: 'https://example.com/image.jpg',
* },
* clientRef: 'my-personal-reference',
* }));
*
* console.log(`Message sent successfully with UUID ${messageUUID}`);
* ```
*/
constructor(params: RCSImageParams);
}
//# sourceMappingURL=RCSImage.d.ts.map