-
Notifications
You must be signed in to change notification settings - Fork 180
/
MessageParams.ts
36 lines (32 loc) · 1010 Bytes
/
MessageParams.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
/**
* Represents the parameters for a message.
*/
export type MessageParams = {
/**
* The ID of the message recipient.
*/
to: string;
/**
* The ID of the message sender.
*/
from: string;
/**
* Client reference of up to 100 characters.
* The reference will be present in every message status.
*/
clientRef?: string;
/**
* Specifies the URL to which Status Webhook messages will be sent for this
* particular message. Over-rides account-level and application-level Status
* Webhook url settings on a per-message basis.
*/
webhookUrl?: string;
/**
* Specifies which version of the Messages API will be used to send Status
* Webhook messages for this particular message. For example, if v0.1 is
* set, then the JSON body of Status Webhook messages for this message will
* be sent in Messages v0.1 format. Over-rides account-level and
* application-level API version settings on a per-message basis.
*/
webhookVersion?: 'v0.1' | 'v1';
};