@vonage/messages
Version:
Multi-channel messaging that integrates WhatsApp, Facebook, Viber, SMS, and MMS
53 lines • 1.71 kB
TypeScript
import { AbstractMessage } from '../AbstractMessage';
import { WhatsAppTemplateParams, WhatsAppPolicyType, WhatsAppTemplateType, WhatsAppContext } from '../../types';
import { MessageTypes } from '../../enums/MessageTypes';
import { Channels } from '../../enums';
/**
* Represents a template message for WhatsApp.
*
* @group WhatsApp
*/
export declare class WhatsAppTemplate extends AbstractMessage implements WhatsAppTemplateParams {
/**
* The channel for this message (always 'whatsapp').
*/
channel: Channels.WHATSAPP;
/**
* The type of message (always 'template').
*/
messageType: MessageTypes.TEMPLATE;
whatsapp: WhatsAppPolicyType;
template: WhatsAppTemplateType;
context?: WhatsAppContext;
/**
* Send a template message to a WhatsApp user.
*
* @param {WhatsAppTemplateParams} params - The parameters for creating a WhatsApp template message.
*
* @example
* ```ts
* import { WhatsAppTemplate, WhatsAppLanguageCode } from '@vonage/messages';
*
* const { messageUUID } = await messagesClient.send(new WhatsAppTemplate({
* to: TO_NUMBER,
* from: FROM_NUMBER,
* whatsapp: {
* policy: 'deterministic',
* locale: WhatsAppLanguageCode.EN,
* },
* template: {
* name: 'your-template-name',
* parameters: [
* 'foo',
* 'bar',
* ],
* },
* clientRef: 'my-personal-reference',
* }));
*
* console.log(`Message sent successfully with UUID ${messageUUID}`);
* ```
*/
constructor(params: Omit<WhatsAppTemplateParams, 'channel' | 'messageType'>);
}
//# sourceMappingURL=WhatsAppTemplate.d.ts.map