-
Notifications
You must be signed in to change notification settings - Fork 180
/
createConversationRequest.ts
68 lines (58 loc) · 1.36 KB
/
createConversationRequest.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
65
66
67
68
import { PhoneNumberChannel } from '../phoneNumberChannel';
import { SipChannel } from '../sipChannel';
import { AppChannel } from '../appChannel';
import { WebSocketChannel } from '../websocketChannel';
import { VbcChannel } from '../vbcChannel';
import { ConversationCallbackRequest } from './conversationCallbackRequest';
/**
* Type representing a request to create a conversation.
*/
export type CreateConversationRequest = {
/**
* Your internal conversation name.
*/
name: string;
/**
* The public-facing name of the conversation.
*/
display_name: string;
/**
* An image URL associated with the conversation.
*/
image_url: string;
/**
* Conversation properties (optional).
*/
properties?: {
/**
* Time to leave in seconds for an empty conversation (optional).
*/
ttl?: number;
/**
* Custom conversation type (optional).
*/
type?: string;
/**
* Custom sort key (optional).
*/
custom_sort_key?: string;
/**
* Custom data as key-value pairs (optional).
*/
custom_data?: Record<string, unknown>;
};
/**
* Communication channels (optional).
*/
numbers?: Array<
PhoneNumberChannel |
SipChannel |
AppChannel |
WebSocketChannel |
VbcChannel
>;
/**
* Callback information (optional).
*/
callback?: ConversationCallbackRequest;
};