twilio 4.14.1 → 4.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/base/Version.js +4 -3
- package/lib/rest/api/v2010/account/conference/participant.d.ts +1 -1
- package/lib/rest/api/v2010/account/message.d.ts +9 -6
- package/lib/rest/api/v2010/account/message.js +2 -0
- package/lib/rest/chat/v3/channel.d.ts +2 -2
- package/lib/rest/conversations/v1/configuration.d.ts +2 -2
- package/lib/rest/conversations/v1/conversation.d.ts +3 -3
- package/lib/rest/conversations/v1/service/configuration.d.ts +8 -8
- package/lib/rest/conversations/v1/service/conversation/participant.d.ts +15 -15
- package/lib/rest/conversations/v1/service/conversation.d.ts +3 -3
- package/lib/rest/insights/v1/callSummaries.d.ts +18 -12
- package/lib/rest/insights/v1/callSummaries.js +11 -8
- package/lib/rest/insights/v1/room/participant.d.ts +3 -3
- package/lib/rest/media/v1/mediaProcessor.d.ts +7 -7
- package/lib/rest/media/v1/mediaRecording.d.ts +1 -1
- package/lib/rest/media/v1/playerStreamer.d.ts +2 -2
- package/lib/rest/messaging/v1/service/channelSender.d.ts +234 -0
- package/lib/rest/messaging/v1/service/channelSender.js +193 -0
- package/lib/rest/messaging/v1/service.d.ts +23 -15
- package/lib/rest/messaging/v1/service.js +13 -0
- package/lib/rest/numbers/V2.d.ts +5 -0
- package/lib/rest/numbers/V2.js +7 -0
- package/lib/rest/numbers/v1/portingPortability.d.ts +32 -1
- package/lib/rest/numbers/v1/portingPortability.js +18 -10
- package/lib/rest/numbers/v2/bulkHostedNumberOrder.d.ts +159 -0
- package/lib/rest/numbers/v2/bulkHostedNumberOrder.js +130 -0
- package/lib/rest/numbers/v2/regulatoryCompliance.d.ts +1 -0
- package/lib/rest/supersim/v1/esimProfile.d.ts +4 -4
- package/lib/rest/supersim/v1/ipCommand.d.ts +3 -3
- package/lib/rest/verify/v2/service/messagingConfiguration.d.ts +3 -3
- package/lib/rest/video/v1/room.d.ts +2 -2
- package/lib/rest/voice/v1/dialingPermissions/country.d.ts +4 -4
- package/lib/rest/wireless/v1/command.d.ts +5 -5
- package/lib/rest/wireless/v1/ratePlan.d.ts +7 -7
- package/lib/rest/wireless/v1/sim/dataSession.d.ts +3 -3
- package/lib/rest/wireless/v1/sim/usageRecord.d.ts +3 -3
- package/lib/rest/wireless/v1/sim.d.ts +9 -9
- package/lib/rest/wireless/v1/usageRecord.d.ts +2 -2
- package/package.json +1 -1
package/lib/base/Version.js
CHANGED
|
@@ -267,7 +267,8 @@ class Version {
|
|
|
267
267
|
onComplete();
|
|
268
268
|
return;
|
|
269
269
|
}
|
|
270
|
-
promise
|
|
270
|
+
promise
|
|
271
|
+
.then((page) => {
|
|
271
272
|
try {
|
|
272
273
|
page.instances.forEach(function (instance) {
|
|
273
274
|
if (done ||
|
|
@@ -290,8 +291,8 @@ class Version {
|
|
|
290
291
|
else {
|
|
291
292
|
onComplete();
|
|
292
293
|
}
|
|
293
|
-
})
|
|
294
|
-
|
|
294
|
+
})
|
|
295
|
+
.catch(onComplete);
|
|
295
296
|
}
|
|
296
297
|
return new Promise((resolve, reject) => {
|
|
297
298
|
pResolve = resolve;
|
|
@@ -115,7 +115,7 @@ export interface ParticipantListInstanceCreateOptions {
|
|
|
115
115
|
recordingTrack?: string;
|
|
116
116
|
/** The maximum duration of the call in seconds. Constraints depend on account and configuration. */
|
|
117
117
|
timeLimit?: number;
|
|
118
|
-
/** Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine.
|
|
118
|
+
/** Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection). */
|
|
119
119
|
machineDetection?: string;
|
|
120
120
|
/** The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds. */
|
|
121
121
|
machineDetectionTimeout?: number;
|
|
@@ -8,6 +8,7 @@ import { MediaListInstance } from "./message/media";
|
|
|
8
8
|
export type MessageAddressRetention = "retain" | "obfuscate";
|
|
9
9
|
export type MessageContentRetention = "retain" | "discard";
|
|
10
10
|
export type MessageDirection = "inbound" | "outbound-api" | "outbound-call" | "outbound-reply";
|
|
11
|
+
export type MessageRiskCheck = "enable" | "disable";
|
|
11
12
|
export type MessageScheduleType = "fixed";
|
|
12
13
|
export type MessageStatus = "queued" | "sending" | "sent" | "failed" | "delivered" | "undelivered" | "receiving" | "received" | "accepted" | "scheduled" | "read" | "partially_delivered" | "canceled";
|
|
13
14
|
export type MessageUpdateStatus = "canceled";
|
|
@@ -24,9 +25,9 @@ export interface MessageContextUpdateOptions {
|
|
|
24
25
|
* Options to pass to create a MessageInstance
|
|
25
26
|
*/
|
|
26
27
|
export interface MessageListInstanceCreateOptions {
|
|
27
|
-
/** The recipient\\\'s phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (for SMS/MMS) or [channel address](https://www.twilio.com/docs/
|
|
28
|
+
/** The recipient\\\'s phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (for SMS/MMS) or [channel address](https://www.twilio.com/docs/messaging/channels), e.g. `whatsapp:+15552229999`. */
|
|
28
29
|
to: string;
|
|
29
|
-
/** The URL of the endpoint to which Twilio sends [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url). URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the `messaging_service_sid`, Twilio uses this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/
|
|
30
|
+
/** The URL of the endpoint to which Twilio sends [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url). URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the `messaging_service_sid`, Twilio uses this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource). */
|
|
30
31
|
statusCallback?: string;
|
|
31
32
|
/** The SID of the associated [TwiML Application](https://www.twilio.com/docs/usage/api/applications). If this parameter is provided, the `status_callback` parameter of this request is ignored; [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) are sent to the TwiML App\\\'s `message_status_callback` URL. */
|
|
32
33
|
applicationSid?: string;
|
|
@@ -58,7 +59,9 @@ export interface MessageListInstanceCreateOptions {
|
|
|
58
59
|
sendAsMms?: boolean;
|
|
59
60
|
/** For [Content Editor/API](https://www.twilio.com/docs/content) only: Key-value pairs of [Template variables](https://www.twilio.com/docs/content/using-variables-with-content-api) and their substitution values. `content_sid` parameter must also be provided. If values are not defined in the `content_variables` parameter, the [Template\\\'s default placeholder values](https://www.twilio.com/docs/content/content-api-resources#create-templates) are used. */
|
|
60
61
|
contentVariables?: string;
|
|
61
|
-
/**
|
|
62
|
+
/** */
|
|
63
|
+
riskCheck?: MessageRiskCheck;
|
|
64
|
+
/** The sender\\\'s Twilio phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/docs/sms/api/short-code), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). The value of the `from` parameter must be a sender that is hosted within Twilio and belong to the Account creating the Message. If you are using `messaging_service_sid`, this parameter can be empty (Twilio assigns a `from` value from the Messaging Service\\\'s Sender Pool) or you can provide a specific sender from your Sender Pool. */
|
|
62
65
|
from?: string;
|
|
63
66
|
/** The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services) you want to associate with the Message. When this parameter is provided and the `from` parameter is omitted, Twilio selects the optimal sender from the Messaging Service\\\'s Sender Pool. You may also provide a `from` parameter if you want to use a specific Sender from the Sender Pool. */
|
|
64
67
|
messagingServiceSid?: string;
|
|
@@ -238,11 +241,11 @@ export declare class MessageInstance {
|
|
|
238
241
|
numSegments: string;
|
|
239
242
|
direction: MessageDirection;
|
|
240
243
|
/**
|
|
241
|
-
* The sender\'s phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/wireless/
|
|
244
|
+
* The sender\'s phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/docs/sms/api/short-code), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). For incoming messages, this is the number or channel address of the sender. For outgoing messages, this value is a Twilio phone number, alphanumeric sender ID, short code, or channel address from which the message is sent.
|
|
242
245
|
*/
|
|
243
246
|
from: string;
|
|
244
247
|
/**
|
|
245
|
-
* The recipient\'s phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format) or [channel address](https://www.twilio.com/docs/
|
|
248
|
+
* The recipient\'s phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format) or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g. `whatsapp:+15552229999`)
|
|
246
249
|
*/
|
|
247
250
|
to: string;
|
|
248
251
|
/**
|
|
@@ -271,7 +274,7 @@ export declare class MessageInstance {
|
|
|
271
274
|
numMedia: string;
|
|
272
275
|
status: MessageStatus;
|
|
273
276
|
/**
|
|
274
|
-
* The SID of the [Messaging Service](https://www.twilio.com/docs/
|
|
277
|
+
* The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) associated with the Message resource. The value is `null` if a Messaging Service was not used.
|
|
275
278
|
*/
|
|
276
279
|
messagingServiceSid: string;
|
|
277
280
|
/**
|
|
@@ -258,6 +258,8 @@ function MessageListInstance(version, accountSid) {
|
|
|
258
258
|
data["SendAsMms"] = serialize.bool(params["sendAsMms"]);
|
|
259
259
|
if (params["contentVariables"] !== undefined)
|
|
260
260
|
data["ContentVariables"] = params["contentVariables"];
|
|
261
|
+
if (params["riskCheck"] !== undefined)
|
|
262
|
+
data["RiskCheck"] = params["riskCheck"];
|
|
261
263
|
if (params["from"] !== undefined)
|
|
262
264
|
data["From"] = params["from"];
|
|
263
265
|
if (params["messagingServiceSid"] !== undefined)
|
|
@@ -11,7 +11,7 @@ export interface ChannelContextUpdateOptions {
|
|
|
11
11
|
xTwilioWebhookEnabled?: ChannelWebhookEnabledType;
|
|
12
12
|
/** */
|
|
13
13
|
type?: ChannelChannelType;
|
|
14
|
-
/** The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
|
14
|
+
/** The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this channel belongs to. */
|
|
15
15
|
messagingServiceSid?: string;
|
|
16
16
|
}
|
|
17
17
|
export interface ChannelContext {
|
|
@@ -123,7 +123,7 @@ export declare class ChannelInstance {
|
|
|
123
123
|
*/
|
|
124
124
|
messagesCount: number;
|
|
125
125
|
/**
|
|
126
|
-
* The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
|
126
|
+
* The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this channel belongs to.
|
|
127
127
|
*/
|
|
128
128
|
messagingServiceSid: string;
|
|
129
129
|
/**
|
|
@@ -8,7 +8,7 @@ import { WebhookListInstance } from "./configuration/webhook";
|
|
|
8
8
|
export interface ConfigurationContextUpdateOptions {
|
|
9
9
|
/** The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation. */
|
|
10
10
|
defaultChatServiceSid?: string;
|
|
11
|
-
/** The SID of the default [Messaging Service](https://www.twilio.com/docs/
|
|
11
|
+
/** The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to use when creating a conversation. */
|
|
12
12
|
defaultMessagingServiceSid?: string;
|
|
13
13
|
/** Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute. */
|
|
14
14
|
defaultInactiveTimer?: string;
|
|
@@ -87,7 +87,7 @@ export declare class ConfigurationInstance {
|
|
|
87
87
|
*/
|
|
88
88
|
defaultChatServiceSid: string;
|
|
89
89
|
/**
|
|
90
|
-
* The SID of the default [Messaging Service](https://www.twilio.com/docs/
|
|
90
|
+
* The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/services/api) used when creating a conversation.
|
|
91
91
|
*/
|
|
92
92
|
defaultMessagingServiceSid: string;
|
|
93
93
|
/**
|
|
@@ -29,7 +29,7 @@ export interface ConversationContextUpdateOptions {
|
|
|
29
29
|
dateUpdated?: Date;
|
|
30
30
|
/** An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \\\"{}\\\" will be returned. */
|
|
31
31
|
attributes?: string;
|
|
32
|
-
/** The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
|
32
|
+
/** The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to. */
|
|
33
33
|
messagingServiceSid?: string;
|
|
34
34
|
/** */
|
|
35
35
|
state?: ConversationState;
|
|
@@ -54,7 +54,7 @@ export interface ConversationListInstanceCreateOptions {
|
|
|
54
54
|
dateCreated?: Date;
|
|
55
55
|
/** The date that this resource was last updated. */
|
|
56
56
|
dateUpdated?: Date;
|
|
57
|
-
/** The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
|
57
|
+
/** The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to. */
|
|
58
58
|
messagingServiceSid?: string;
|
|
59
59
|
/** An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \\\"{}\\\" will be returned. */
|
|
60
60
|
attributes?: string;
|
|
@@ -226,7 +226,7 @@ export declare class ConversationInstance {
|
|
|
226
226
|
*/
|
|
227
227
|
chatServiceSid: string;
|
|
228
228
|
/**
|
|
229
|
-
* The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
|
229
|
+
* The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to.
|
|
230
230
|
*/
|
|
231
231
|
messagingServiceSid: string;
|
|
232
232
|
/**
|
|
@@ -7,13 +7,13 @@ import { WebhookListInstance } from "./configuration/webhook";
|
|
|
7
7
|
* Options to pass to update a ConfigurationInstance
|
|
8
8
|
*/
|
|
9
9
|
export interface ConfigurationContextUpdateOptions {
|
|
10
|
-
/** The conversation-level role assigned to a conversation creator when they join a new conversation. See
|
|
10
|
+
/** The conversation-level role assigned to a conversation creator when they join a new conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. */
|
|
11
11
|
defaultConversationCreatorRoleSid?: string;
|
|
12
|
-
/** The conversation-level role assigned to users when they are added to a conversation. See
|
|
12
|
+
/** The conversation-level role assigned to users when they are added to a conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. */
|
|
13
13
|
defaultConversationRoleSid?: string;
|
|
14
|
-
/** The service-level role assigned to users when they are added to the service. See
|
|
14
|
+
/** The service-level role assigned to users when they are added to the service. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. */
|
|
15
15
|
defaultChatServiceRoleSid?: string;
|
|
16
|
-
/** Whether the [Reachability Indicator](https://www.twilio.com/docs/
|
|
16
|
+
/** Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`. */
|
|
17
17
|
reachabilityEnabled?: boolean;
|
|
18
18
|
}
|
|
19
19
|
export interface ConfigurationContext {
|
|
@@ -85,15 +85,15 @@ export declare class ConfigurationInstance {
|
|
|
85
85
|
*/
|
|
86
86
|
chatServiceSid: string;
|
|
87
87
|
/**
|
|
88
|
-
* The conversation-level role assigned to a conversation creator
|
|
88
|
+
* The conversation-level role assigned to a conversation creator when they join a new conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.
|
|
89
89
|
*/
|
|
90
90
|
defaultConversationCreatorRoleSid: string;
|
|
91
91
|
/**
|
|
92
|
-
* The conversation-level role assigned to users when they are added to a conversation. See
|
|
92
|
+
* The conversation-level role assigned to users when they are added to a conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.
|
|
93
93
|
*/
|
|
94
94
|
defaultConversationRoleSid: string;
|
|
95
95
|
/**
|
|
96
|
-
* The service-level role assigned to users when they are added to the service. See
|
|
96
|
+
* The service-level role assigned to users when they are added to the service. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.
|
|
97
97
|
*/
|
|
98
98
|
defaultChatServiceRoleSid: string;
|
|
99
99
|
/**
|
|
@@ -105,7 +105,7 @@ export declare class ConfigurationInstance {
|
|
|
105
105
|
*/
|
|
106
106
|
links: Record<string, string>;
|
|
107
107
|
/**
|
|
108
|
-
* Whether the [Reachability Indicator](https://www.twilio.com/docs/
|
|
108
|
+
* Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`.
|
|
109
109
|
*/
|
|
110
110
|
reachabilityEnabled: boolean;
|
|
111
111
|
private get _proxy();
|
|
@@ -17,13 +17,13 @@ export interface ParticipantContextRemoveOptions {
|
|
|
17
17
|
export interface ParticipantContextUpdateOptions {
|
|
18
18
|
/** The X-Twilio-Webhook-Enabled HTTP request header */
|
|
19
19
|
xTwilioWebhookEnabled?: ParticipantWebhookEnabledType;
|
|
20
|
-
/** The date
|
|
20
|
+
/** The date on which this resource was created. */
|
|
21
21
|
dateCreated?: Date;
|
|
22
|
-
/** The date
|
|
22
|
+
/** The date on which this resource was last updated. */
|
|
23
23
|
dateUpdated?: Date;
|
|
24
|
-
/** A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters. */
|
|
24
|
+
/** A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters. */
|
|
25
25
|
identity?: string;
|
|
26
|
-
/** An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set
|
|
26
|
+
/** An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned. */
|
|
27
27
|
attributes?: string;
|
|
28
28
|
/** The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. */
|
|
29
29
|
roleSid?: string;
|
|
@@ -42,19 +42,19 @@ export interface ParticipantContextUpdateOptions {
|
|
|
42
42
|
export interface ParticipantListInstanceCreateOptions {
|
|
43
43
|
/** The X-Twilio-Webhook-Enabled HTTP request header */
|
|
44
44
|
xTwilioWebhookEnabled?: ParticipantWebhookEnabledType;
|
|
45
|
-
/** A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters. */
|
|
45
|
+
/** A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters. */
|
|
46
46
|
identity?: string;
|
|
47
|
-
/** The address of the participant\\\'s device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with proxy_address) is only null when the participant is interacting from an SDK endpoint (see the
|
|
47
|
+
/** The address of the participant\\\'s device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with `proxy_address`) is only null when the participant is interacting from an SDK endpoint (see the `identity` field). */
|
|
48
48
|
"messagingBinding.address"?: string;
|
|
49
|
-
/** The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the
|
|
49
|
+
/** The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the `identity` field). */
|
|
50
50
|
"messagingBinding.proxyAddress"?: string;
|
|
51
|
-
/** The date
|
|
51
|
+
/** The date on which this resource was created. */
|
|
52
52
|
dateCreated?: Date;
|
|
53
|
-
/** The date
|
|
53
|
+
/** The date on which this resource was last updated. */
|
|
54
54
|
dateUpdated?: Date;
|
|
55
|
-
/** An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set
|
|
55
|
+
/** An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned. */
|
|
56
56
|
attributes?: string;
|
|
57
|
-
/** The address of the Twilio phone number that is used in Group MMS.
|
|
57
|
+
/** The address of the Twilio phone number that is used in Group MMS. */
|
|
58
58
|
"messagingBinding.projectedAddress"?: string;
|
|
59
59
|
/** The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. */
|
|
60
60
|
roleSid?: string;
|
|
@@ -202,11 +202,11 @@ export declare class ParticipantInstance {
|
|
|
202
202
|
*/
|
|
203
203
|
sid: string;
|
|
204
204
|
/**
|
|
205
|
-
* A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters.
|
|
205
|
+
* A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.
|
|
206
206
|
*/
|
|
207
207
|
identity: string;
|
|
208
208
|
/**
|
|
209
|
-
* An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set
|
|
209
|
+
* An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned.
|
|
210
210
|
*/
|
|
211
211
|
attributes: string;
|
|
212
212
|
/**
|
|
@@ -218,11 +218,11 @@ export declare class ParticipantInstance {
|
|
|
218
218
|
*/
|
|
219
219
|
roleSid: string;
|
|
220
220
|
/**
|
|
221
|
-
* The date
|
|
221
|
+
* The date on which this resource was created.
|
|
222
222
|
*/
|
|
223
223
|
dateCreated: Date;
|
|
224
224
|
/**
|
|
225
|
-
* The date
|
|
225
|
+
* The date on which this resource was last updated.
|
|
226
226
|
*/
|
|
227
227
|
dateUpdated: Date;
|
|
228
228
|
/**
|
|
@@ -29,7 +29,7 @@ export interface ConversationContextUpdateOptions {
|
|
|
29
29
|
dateUpdated?: Date;
|
|
30
30
|
/** An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \\\"{}\\\" will be returned. */
|
|
31
31
|
attributes?: string;
|
|
32
|
-
/** The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
|
32
|
+
/** The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to. */
|
|
33
33
|
messagingServiceSid?: string;
|
|
34
34
|
/** */
|
|
35
35
|
state?: ConversationState;
|
|
@@ -52,7 +52,7 @@ export interface ConversationListInstanceCreateOptions {
|
|
|
52
52
|
uniqueName?: string;
|
|
53
53
|
/** An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \\\"{}\\\" will be returned. */
|
|
54
54
|
attributes?: string;
|
|
55
|
-
/** The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
|
55
|
+
/** The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to. */
|
|
56
56
|
messagingServiceSid?: string;
|
|
57
57
|
/** The date that this resource was created. */
|
|
58
58
|
dateCreated?: Date;
|
|
@@ -227,7 +227,7 @@ export declare class ConversationInstance {
|
|
|
227
227
|
*/
|
|
228
228
|
chatServiceSid: string;
|
|
229
229
|
/**
|
|
230
|
-
* The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
|
230
|
+
* The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to.
|
|
231
231
|
*/
|
|
232
232
|
messagingServiceSid: string;
|
|
233
233
|
/**
|
|
@@ -51,14 +51,16 @@ export interface CallSummariesListInstanceEachOptions {
|
|
|
51
51
|
abnormalSession?: boolean;
|
|
52
52
|
/** An Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`. */
|
|
53
53
|
answeredBy?: CallSummariesAnsweredBy;
|
|
54
|
+
/** Either machine or human. */
|
|
55
|
+
answeredByAnnotation?: string;
|
|
54
56
|
/** A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`. */
|
|
55
|
-
|
|
57
|
+
connectivityIssueAnnotation?: string;
|
|
56
58
|
/** A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. */
|
|
57
|
-
|
|
59
|
+
qualityIssueAnnotation?: string;
|
|
58
60
|
/** A boolean flag indicating spam calls. */
|
|
59
|
-
|
|
61
|
+
spamAnnotation?: boolean;
|
|
60
62
|
/** A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad]. */
|
|
61
|
-
|
|
63
|
+
callScoreAnnotation?: string;
|
|
62
64
|
/** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
|
|
63
65
|
pageSize?: number;
|
|
64
66
|
/** Function to process each record. If this and a positional callback are passed, this one will be used */
|
|
@@ -110,14 +112,16 @@ export interface CallSummariesListInstanceOptions {
|
|
|
110
112
|
abnormalSession?: boolean;
|
|
111
113
|
/** An Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`. */
|
|
112
114
|
answeredBy?: CallSummariesAnsweredBy;
|
|
115
|
+
/** Either machine or human. */
|
|
116
|
+
answeredByAnnotation?: string;
|
|
113
117
|
/** A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`. */
|
|
114
|
-
|
|
118
|
+
connectivityIssueAnnotation?: string;
|
|
115
119
|
/** A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. */
|
|
116
|
-
|
|
120
|
+
qualityIssueAnnotation?: string;
|
|
117
121
|
/** A boolean flag indicating spam calls. */
|
|
118
|
-
|
|
122
|
+
spamAnnotation?: boolean;
|
|
119
123
|
/** A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad]. */
|
|
120
|
-
|
|
124
|
+
callScoreAnnotation?: string;
|
|
121
125
|
/** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
|
|
122
126
|
pageSize?: number;
|
|
123
127
|
/** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
|
|
@@ -165,14 +169,16 @@ export interface CallSummariesListInstancePageOptions {
|
|
|
165
169
|
abnormalSession?: boolean;
|
|
166
170
|
/** An Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`. */
|
|
167
171
|
answeredBy?: CallSummariesAnsweredBy;
|
|
172
|
+
/** Either machine or human. */
|
|
173
|
+
answeredByAnnotation?: string;
|
|
168
174
|
/** A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`. */
|
|
169
|
-
|
|
175
|
+
connectivityIssueAnnotation?: string;
|
|
170
176
|
/** A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. */
|
|
171
|
-
|
|
177
|
+
qualityIssueAnnotation?: string;
|
|
172
178
|
/** A boolean flag indicating spam calls. */
|
|
173
|
-
|
|
179
|
+
spamAnnotation?: boolean;
|
|
174
180
|
/** A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad]. */
|
|
175
|
-
|
|
181
|
+
callScoreAnnotation?: string;
|
|
176
182
|
/** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
|
|
177
183
|
pageSize?: number;
|
|
178
184
|
/** Page Number, this value is simply for client state */
|
|
@@ -73,14 +73,17 @@ function CallSummariesListInstance(version) {
|
|
|
73
73
|
data["AbnormalSession"] = serialize.bool(params["abnormalSession"]);
|
|
74
74
|
if (params["answeredBy"] !== undefined)
|
|
75
75
|
data["AnsweredBy"] = params["answeredBy"];
|
|
76
|
-
if (params["
|
|
77
|
-
data["
|
|
78
|
-
if (params["
|
|
79
|
-
data["
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
76
|
+
if (params["answeredByAnnotation"] !== undefined)
|
|
77
|
+
data["AnsweredByAnnotation"] = params["answeredByAnnotation"];
|
|
78
|
+
if (params["connectivityIssueAnnotation"] !== undefined)
|
|
79
|
+
data["ConnectivityIssueAnnotation"] =
|
|
80
|
+
params["connectivityIssueAnnotation"];
|
|
81
|
+
if (params["qualityIssueAnnotation"] !== undefined)
|
|
82
|
+
data["QualityIssueAnnotation"] = params["qualityIssueAnnotation"];
|
|
83
|
+
if (params["spamAnnotation"] !== undefined)
|
|
84
|
+
data["SpamAnnotation"] = serialize.bool(params["spamAnnotation"]);
|
|
85
|
+
if (params["callScoreAnnotation"] !== undefined)
|
|
86
|
+
data["CallScoreAnnotation"] = params["callScoreAnnotation"];
|
|
84
87
|
if (params["pageSize"] !== undefined)
|
|
85
88
|
data["PageSize"] = params["pageSize"];
|
|
86
89
|
if (params.pageNumber !== undefined)
|
|
@@ -134,7 +134,7 @@ export declare class ParticipantInstance {
|
|
|
134
134
|
*/
|
|
135
135
|
codecs: Array<ParticipantCodec>;
|
|
136
136
|
/**
|
|
137
|
-
* Reason the participant left the room. See [the list of possible values here](https://www.twilio.com/docs/video/
|
|
137
|
+
* Reason the participant left the room. See [the list of possible values here](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#end_reason).
|
|
138
138
|
*/
|
|
139
139
|
endReason: string;
|
|
140
140
|
/**
|
|
@@ -147,12 +147,12 @@ export declare class ParticipantInstance {
|
|
|
147
147
|
errorCodeUrl: string;
|
|
148
148
|
mediaRegion: ParticipantTwilioRealm;
|
|
149
149
|
/**
|
|
150
|
-
* Object containing information about the participant\'s data from the room. See [below](https://www.twilio.com/docs/video/
|
|
150
|
+
* Object containing information about the participant\'s data from the room. See [below](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#properties) for more information.
|
|
151
151
|
*/
|
|
152
152
|
properties: any;
|
|
153
153
|
edgeLocation: ParticipantEdgeLocation;
|
|
154
154
|
/**
|
|
155
|
-
* Object containing information about the SDK name and version. See [below](https://www.twilio.com/docs/video/
|
|
155
|
+
* Object containing information about the SDK name and version. See [below](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#publisher_info) for more information.
|
|
156
156
|
*/
|
|
157
157
|
publisherInfo: any;
|
|
158
158
|
/**
|
|
@@ -17,13 +17,13 @@ export interface MediaProcessorContextUpdateOptions {
|
|
|
17
17
|
* Options to pass to create a MediaProcessorInstance
|
|
18
18
|
*/
|
|
19
19
|
export interface MediaProcessorListInstanceCreateOptions {
|
|
20
|
-
/** The [Media Extension](/docs/live/
|
|
20
|
+
/** The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2` */
|
|
21
21
|
extension: string;
|
|
22
|
-
/** The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/
|
|
22
|
+
/** The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send. */
|
|
23
23
|
extensionContext: string;
|
|
24
|
-
/** User-defined environment variables for the Media Extension, represented as a JSON dictionary of key/value strings. See the documentation for the specific [Media Extension](/docs/live/
|
|
24
|
+
/** User-defined environment variables for the Media Extension, represented as a JSON dictionary of key/value strings. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about whether you need to provide this. */
|
|
25
25
|
extensionEnvironment?: any;
|
|
26
|
-
/** The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) for details. */
|
|
26
|
+
/** The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/api/status-callbacks) for details. */
|
|
27
27
|
statusCallback?: string;
|
|
28
28
|
/** The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`. */
|
|
29
29
|
statusCallbackMethod?: string;
|
|
@@ -156,11 +156,11 @@ export declare class MediaProcessorInstance {
|
|
|
156
156
|
*/
|
|
157
157
|
dateUpdated: Date;
|
|
158
158
|
/**
|
|
159
|
-
* The [Media Extension](/docs/live/
|
|
159
|
+
* The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`
|
|
160
160
|
*/
|
|
161
161
|
extension: string;
|
|
162
162
|
/**
|
|
163
|
-
* The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/
|
|
163
|
+
* The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send.
|
|
164
164
|
*/
|
|
165
165
|
extensionContext: string;
|
|
166
166
|
status: MediaProcessorStatus;
|
|
@@ -173,7 +173,7 @@ export declare class MediaProcessorInstance {
|
|
|
173
173
|
*/
|
|
174
174
|
endedReason: string;
|
|
175
175
|
/**
|
|
176
|
-
* The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) for details.
|
|
176
|
+
* The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/api/status-callbacks) for details.
|
|
177
177
|
*/
|
|
178
178
|
statusCallback: string;
|
|
179
179
|
/**
|
|
@@ -172,7 +172,7 @@ export declare class MediaRecordingInstance {
|
|
|
172
172
|
mediaSize: number;
|
|
173
173
|
status: MediaRecordingStatus;
|
|
174
174
|
/**
|
|
175
|
-
* The URL to which Twilio will send asynchronous webhook requests for every MediaRecording event. See [Status Callbacks](/docs/live/status-callbacks) for more details.
|
|
175
|
+
* The URL to which Twilio will send asynchronous webhook requests for every MediaRecording event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details.
|
|
176
176
|
*/
|
|
177
177
|
statusCallback: string;
|
|
178
178
|
/**
|
|
@@ -21,7 +21,7 @@ export interface PlayerStreamerContextUpdateOptions {
|
|
|
21
21
|
export interface PlayerStreamerListInstanceCreateOptions {
|
|
22
22
|
/** Specifies whether the PlayerStreamer is configured to stream video. Defaults to `true`. */
|
|
23
23
|
video?: boolean;
|
|
24
|
-
/** The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/status-callbacks) for more details. */
|
|
24
|
+
/** The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details. */
|
|
25
25
|
statusCallback?: string;
|
|
26
26
|
/** The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`. */
|
|
27
27
|
statusCallbackMethod?: string;
|
|
@@ -170,7 +170,7 @@ export declare class PlayerStreamerInstance {
|
|
|
170
170
|
*/
|
|
171
171
|
url: string;
|
|
172
172
|
/**
|
|
173
|
-
* The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/status-callbacks) for more details.
|
|
173
|
+
* The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details.
|
|
174
174
|
*/
|
|
175
175
|
statusCallback: string;
|
|
176
176
|
/**
|