-
Notifications
You must be signed in to change notification settings - Fork 180
/
WhatsAppTemplate.ts
64 lines (61 loc) · 1.56 KB
/
WhatsAppTemplate.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
import { AbstractMessage } from '../AbstractMessage';
import {
WhatsAppTemplateParams,
WhatsAppPolicyType,
WhatsAppTemplateType,
WhatsAppContext,
} from '../../types';
/**
* Represents a template message for WhatsApp.
*
* @group WhatsApp
*/
export class WhatsAppTemplate
extends AbstractMessage
implements WhatsAppTemplateParams
{
public channel: 'whatsapp';
public messageType: 'template';
public whatsapp: WhatsAppPolicyType;
public template: WhatsAppTemplateType;
public 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}`);
* ```
*/
public constructor(params: WhatsAppTemplateParams) {
super(params);
this.whatsapp = params.whatsapp;
this.template = params.template;
this.channel = 'whatsapp';
this.messageType = 'template';
if (params.context) {
this.context = params.context;
}
}
}