-
Notifications
You must be signed in to change notification settings - Fork 180
/
WhatsAppImageRequest.ts
56 lines (49 loc) · 1.13 KB
/
WhatsAppImageRequest.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
/**
* Represents a request for sending an image 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 WhatsAppImageRequest = {
/**
* A client-defined reference string for the message.
*/
client_ref: string;
/**
* The type of the message, which is 'image' for an image message.
*/
message_type: 'image';
/**
* The image content of the message, including the URL of the image and an optional caption.
*/
image: {
/**
* The URL of the image to be sent.
*/
url: string;
/**
* An optional caption for the image.
*/
caption?: string;
};
/**
* 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 amount of time in seconds the message will live for
*/
ttl?: number;
};