-
Notifications
You must be signed in to change notification settings - Fork 180
/
WhatsAppTemplateRequest.ts
48 lines (41 loc) · 1.09 KB
/
WhatsAppTemplateRequest.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
import { WhatsAppPolicyType, WhatsAppTemplateType } from '../Channels';
/**
* Represents a request for sending a template message via the WhatsApp channel.
*
* @group WhatsApp
* @category Requests
*
* @remarks
* Vonage API's will return information using `snake_case`. This represents the
* pure response before the client will transform the keys into `camelCase`.
*/
export type WhatsAppTemplateRequest = {
/**
* A client-defined reference string for the message.
*/
client_ref: string;
/**
* The type of the message, which is 'template' for a template message.
*/
message_type: 'template';
/**
* The template content of the message, including the template type.
*/
template: WhatsAppTemplateType;
/**
* The recipient's identifier.
*/
to: string;
/**
* The sender's identifier.
*/
from: string;
/**
* The channel through which the message will be sent, which is 'whatsapp' for WhatsApp.
*/
channel: 'whatsapp';
/**
* The policy and locale settings for sending the WhatsApp template message.
*/
whatsapp: WhatsAppPolicyType;
}