twilio 5.12.2 → 5.13.1
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/README.md +1 -0
- package/lib/rest/InsightsBase.d.ts +3 -0
- package/lib/rest/InsightsBase.js +5 -0
- package/lib/rest/api/v2010/account/call/payment.d.ts +6 -2
- package/lib/rest/api/v2010/account/call/payment.js +8 -0
- package/lib/rest/api/v2010/account/call/transcription.d.ts +4 -0
- package/lib/rest/api/v2010/account/call/transcription.js +8 -0
- package/lib/rest/api/v2010/account/token.d.ts +1 -0
- package/lib/rest/api/v2010/account/token.js +10 -1
- package/lib/rest/assistants/v1/assistant/feedback.d.ts +1 -0
- package/lib/rest/assistants/v1/assistant/feedback.js +6 -0
- package/lib/rest/assistants/v1/assistant/message.d.ts +1 -0
- package/lib/rest/assistants/v1/assistant/message.js +7 -0
- package/lib/rest/assistants/v1/assistant.d.ts +6 -0
- package/lib/rest/assistants/v1/assistant.js +58 -2
- package/lib/rest/assistants/v1/knowledge.d.ts +3 -0
- package/lib/rest/assistants/v1/knowledge.js +24 -0
- package/lib/rest/assistants/v1/tool.d.ts +4 -0
- package/lib/rest/assistants/v1/tool.js +40 -1
- package/lib/rest/content/v1/content/approvalCreate.d.ts +1 -0
- package/lib/rest/content/v1/content/approvalCreate.js +4 -0
- package/lib/rest/content/v1/content.d.ts +27 -0
- package/lib/rest/content/v1/content.js +171 -0
- package/lib/rest/flexApi/v1/createFlexInstance.d.ts +2 -0
- package/lib/rest/flexApi/v1/createFlexInstance.js +6 -0
- package/lib/rest/iam/v1/oAuthApp.d.ts +4 -0
- package/lib/rest/iam/v1/oAuthApp.js +28 -1
- package/lib/rest/insights/V2.d.ts +21 -0
- package/lib/rest/insights/V2.js +46 -0
- package/lib/rest/insights/v2/inbound.d.ts +436 -0
- package/lib/rest/insights/v2/inbound.js +342 -0
- package/lib/rest/insights/v2/outbound.d.ts +529 -0
- package/lib/rest/insights/v2/outbound.js +392 -0
- package/lib/rest/insights/v2/report.d.ts +783 -0
- package/lib/rest/insights/v2/report.js +550 -0
- package/lib/rest/intelligence/v2/operatorType.d.ts +6 -0
- package/lib/rest/intelligence/v2/operatorType.js +4 -0
- package/lib/rest/knowledge/v1/knowledge.d.ts +3 -0
- package/lib/rest/knowledge/v1/knowledge.js +23 -0
- package/lib/rest/lookups/v2/bucket.d.ts +1 -0
- package/lib/rest/lookups/v2/bucket.js +4 -0
- package/lib/rest/lookups/v2/lookupOverride.d.ts +1 -0
- package/lib/rest/lookups/v2/lookupOverride.js +4 -0
- package/lib/rest/lookups/v2/phoneNumber.d.ts +9 -0
- package/lib/rest/lookups/v2/phoneNumber.js +94 -8
- package/lib/rest/lookups/v2/query.d.ts +15 -0
- package/lib/rest/lookups/v2/query.js +113 -1
- package/lib/rest/lookups/v2/rateLimit.d.ts +1 -0
- package/lib/rest/lookups/v2/rateLimit.js +11 -1
- package/lib/rest/marketplace/v1/installedAddOn/installedAddOnUsage.d.ts +2 -0
- package/lib/rest/marketplace/v1/installedAddOn/installedAddOnUsage.js +13 -1
- package/lib/rest/marketplace/v1/referralConversion.d.ts +1 -0
- package/lib/rest/marketplace/v1/referralConversion.js +3 -0
- package/lib/rest/messaging/v1/service/usAppToPerson.d.ts +78 -5
- package/lib/rest/messaging/v1/service/usAppToPerson.js +60 -20
- package/lib/rest/messaging/v1/tollfreeVerification.d.ts +26 -24
- package/lib/rest/messaging/v2/channelsSender.d.ts +18 -0
- package/lib/rest/messaging/v2/channelsSender.js +115 -6
- package/lib/rest/numbers/V1.d.ts +8 -0
- package/lib/rest/numbers/V1.js +12 -0
- package/lib/rest/numbers/v1/embeddedSession.d.ts +84 -0
- package/lib/rest/numbers/v1/embeddedSession.js +115 -0
- package/lib/rest/numbers/v1/portingPortIn.d.ts +5 -0
- package/lib/rest/numbers/v1/portingPortIn.js +67 -2
- package/lib/rest/numbers/v1/senderIdRegistration.d.ts +181 -0
- package/lib/rest/numbers/v1/senderIdRegistration.js +146 -0
- package/lib/rest/numbers/v2/application.d.ts +194 -4
- package/lib/rest/numbers/v2/application.js +188 -3
- package/lib/rest/previewIam/versionless/organization/roleAssignment.d.ts +1 -0
- package/lib/rest/previewIam/versionless/organization/roleAssignment.js +5 -0
- package/lib/rest/previewIam/versionless/organization/user.d.ts +69 -0
- package/lib/rest/previewIam/versionless/organization/user.js +117 -4
- package/lib/rest/pricing/v1/messaging/country.d.ts +3 -0
- package/lib/rest/pricing/v1/messaging/country.js +26 -2
- package/lib/rest/pricing/v1/phoneNumber/country.d.ts +1 -0
- package/lib/rest/pricing/v1/phoneNumber/country.js +10 -1
- package/lib/rest/pricing/v1/voice/country.d.ts +2 -0
- package/lib/rest/pricing/v1/voice/country.js +21 -2
- package/lib/rest/pricing/v1/voice/number.d.ts +2 -0
- package/lib/rest/pricing/v1/voice/number.js +19 -2
- package/lib/rest/pricing/v2/country.d.ts +2 -0
- package/lib/rest/pricing/v2/country.js +22 -2
- package/lib/rest/pricing/v2/number.d.ts +2 -0
- package/lib/rest/pricing/v2/number.js +22 -2
- package/lib/rest/pricing/v2/voice/country.d.ts +2 -0
- package/lib/rest/pricing/v2/voice/country.js +22 -2
- package/lib/rest/pricing/v2/voice/number.d.ts +2 -0
- package/lib/rest/pricing/v2/voice/number.js +20 -2
- package/lib/rest/studio/v2/flow/execution.d.ts +12 -0
- package/lib/rest/studio/v2/flow/execution.js +4 -0
- package/lib/rest/studio/v2/flow/flowRevision.d.ts +6 -0
- package/lib/rest/studio/v2/flow/flowRevision.js +2 -0
- package/lib/rest/studio/v2/flow.d.ts +6 -0
- package/lib/rest/studio/v2/flow.js +2 -0
- package/lib/rest/verify/v2/service/approveChallenge.d.ts +2 -0
- package/lib/rest/verify/v2/service/approveChallenge.js +13 -0
- package/lib/rest/verify/v2/service/newChallenge.d.ts +1 -0
- package/lib/rest/verify/v2/service/newChallenge.js +4 -0
- package/lib/rest/verify/v2/service/newFactor.d.ts +3 -0
- package/lib/rest/verify/v2/service/newFactor.js +16 -0
- package/lib/rest/verify/v2/service/newVerifyFactor.d.ts +2 -0
- package/lib/rest/verify/v2/service/newVerifyFactor.js +12 -0
- package/lib/rest/verify/v2/service/verification.d.ts +1 -1
- package/lib/rest/video/v1/room/participant/subscribeRules.d.ts +1 -0
- package/lib/rest/video/v1/room/participant/subscribeRules.js +12 -1
- package/lib/rest/video/v1/room/recordingRules.d.ts +1 -0
- package/lib/rest/video/v1/room/recordingRules.js +11 -1
- package/package.json +4 -4
|
@@ -0,0 +1,783 @@
|
|
|
1
|
+
import { inspect, InspectOptions } from "util";
|
|
2
|
+
import V2 from "../V2";
|
|
3
|
+
import { ApiResponse } from "../../../base/ApiResponse";
|
|
4
|
+
export declare class AccountReport {
|
|
5
|
+
/**
|
|
6
|
+
* The call deliverability score measures the network effectiveness in delivering calls by scoring calls reach the intended recipient. The score is a value between 0 and 100, where 100 indicates that all calls were successfully delivered.
|
|
7
|
+
*/
|
|
8
|
+
"callDeliverabilityScore"?: number;
|
|
9
|
+
/**
|
|
10
|
+
* The call answer score measures customers behavior to the delivered calls. The score is a value between 0 and 100, where 100 indicates that all calls were successfully answered.
|
|
11
|
+
*/
|
|
12
|
+
"callAnswerScore"?: number;
|
|
13
|
+
/**
|
|
14
|
+
* Total number of calls made during the report period.
|
|
15
|
+
*/
|
|
16
|
+
"totalCalls"?: number;
|
|
17
|
+
"callDirection"?: AccountReportCallDirection;
|
|
18
|
+
"callState"?: AccountReportCallState;
|
|
19
|
+
"callType"?: AccountReportCallType;
|
|
20
|
+
/**
|
|
21
|
+
* Average length of call in seconds.
|
|
22
|
+
*/
|
|
23
|
+
"aloc"?: number;
|
|
24
|
+
/**
|
|
25
|
+
* Number of calls made in each Twilio Edge location. Refer to [Public Edge Locations](https://www.twilio.com/docs/global-infrastructure/edge-locations#public-edge-locations) for more detail.
|
|
26
|
+
*/
|
|
27
|
+
"twilioEdgeLocation"?: {
|
|
28
|
+
[key: string]: number;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Number of calls originating from each country (ISO alpha-2).
|
|
32
|
+
*/
|
|
33
|
+
"callerCountryCode"?: {
|
|
34
|
+
[key: string]: number;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* Number of calls terminating in each country (ISO alpha-2).
|
|
38
|
+
*/
|
|
39
|
+
"calleeCountryCode"?: {
|
|
40
|
+
[key: string]: number;
|
|
41
|
+
};
|
|
42
|
+
/**
|
|
43
|
+
* Average queue time in milliseconds.
|
|
44
|
+
*/
|
|
45
|
+
"averageQueueTimeMs"?: number;
|
|
46
|
+
/**
|
|
47
|
+
* Percentage of silent calls.
|
|
48
|
+
*/
|
|
49
|
+
"silentCallsPercentage"?: number;
|
|
50
|
+
"networkIssues"?: AccountReportNetworkIssues;
|
|
51
|
+
"kYT"?: AccountReportKYT;
|
|
52
|
+
"answeringMachineDetection"?: AccountReportAnsweringMachineDetection;
|
|
53
|
+
constructor(payload: any);
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Number of calls made in each answering machine detection.
|
|
57
|
+
*/
|
|
58
|
+
export declare class AccountReportAnsweringMachineDetection {
|
|
59
|
+
/**
|
|
60
|
+
* Total number of calls with answering machine detection enabled (AMD).
|
|
61
|
+
*/
|
|
62
|
+
"totalCalls"?: number;
|
|
63
|
+
/**
|
|
64
|
+
* Percentage of calls marked as answered by human.
|
|
65
|
+
*/
|
|
66
|
+
"answeredByHumanPercentage"?: number;
|
|
67
|
+
/**
|
|
68
|
+
* Percentage of calls marked as answered by machined related like the following: `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `fax`
|
|
69
|
+
*/
|
|
70
|
+
"answeredByMachinePercentage"?: number;
|
|
71
|
+
constructor(payload: any);
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Number of calls made in each direction.
|
|
75
|
+
*/
|
|
76
|
+
export declare class AccountReportCallDirection {
|
|
77
|
+
/**
|
|
78
|
+
* Number of outbound calls
|
|
79
|
+
*/
|
|
80
|
+
"outbound"?: number;
|
|
81
|
+
/**
|
|
82
|
+
* Number of inbound calls
|
|
83
|
+
*/
|
|
84
|
+
"inbound"?: number;
|
|
85
|
+
constructor(payload: any);
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Number of calls made in each state.
|
|
89
|
+
*/
|
|
90
|
+
export declare class AccountReportCallState {
|
|
91
|
+
/**
|
|
92
|
+
* Number of completed calls
|
|
93
|
+
*/
|
|
94
|
+
"completed"?: number;
|
|
95
|
+
/**
|
|
96
|
+
* Number of failed calls
|
|
97
|
+
*/
|
|
98
|
+
"fail"?: number;
|
|
99
|
+
/**
|
|
100
|
+
* Number of busy calls
|
|
101
|
+
*/
|
|
102
|
+
"busy"?: number;
|
|
103
|
+
/**
|
|
104
|
+
* Number of no-answer calls
|
|
105
|
+
*/
|
|
106
|
+
"noanswer"?: number;
|
|
107
|
+
/**
|
|
108
|
+
* Number of canceled calls
|
|
109
|
+
*/
|
|
110
|
+
"canceled"?: number;
|
|
111
|
+
constructor(payload: any);
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* Number of calls made in each type. `carrier`, `sip`, `trunking`, `client`, `whatsapp`
|
|
115
|
+
*/
|
|
116
|
+
export declare class AccountReportCallType {
|
|
117
|
+
/**
|
|
118
|
+
* Number of carrier calls
|
|
119
|
+
*/
|
|
120
|
+
"carrier"?: number;
|
|
121
|
+
/**
|
|
122
|
+
* Number of SIP calls
|
|
123
|
+
*/
|
|
124
|
+
"sip"?: number;
|
|
125
|
+
/**
|
|
126
|
+
* Number of trunking calls
|
|
127
|
+
*/
|
|
128
|
+
"trunking"?: number;
|
|
129
|
+
/**
|
|
130
|
+
* Number of client calls
|
|
131
|
+
*/
|
|
132
|
+
"client"?: number;
|
|
133
|
+
/**
|
|
134
|
+
* Number of WhatsApp Business calls
|
|
135
|
+
*/
|
|
136
|
+
"whatsapp"?: number;
|
|
137
|
+
constructor(payload: any);
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* Know Your Traffic (KYT) metrics focused on outbound carrier performance and trust signals for the report period.
|
|
141
|
+
*/
|
|
142
|
+
export declare class AccountReportKYT {
|
|
143
|
+
"outboundCarrierCalling"?: AccountReportKYTOutboundCarrierCalling;
|
|
144
|
+
constructor(payload: any);
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* KYT metrics for outbound carrier calling.
|
|
148
|
+
*/
|
|
149
|
+
export declare class AccountReportKYTOutboundCarrierCalling {
|
|
150
|
+
/**
|
|
151
|
+
* Number of unique PSTN calling numbers to non-Twilio numbers during the report period.
|
|
152
|
+
*/
|
|
153
|
+
"uniqueCallingNumbers"?: number;
|
|
154
|
+
/**
|
|
155
|
+
* Number of unique non-Twilio PSTN called numbers during the report period.
|
|
156
|
+
*/
|
|
157
|
+
"uniqueCalledNumbers"?: number;
|
|
158
|
+
/**
|
|
159
|
+
* Percentage of blocked calls by carrier per country.
|
|
160
|
+
*/
|
|
161
|
+
"blockedCallsByCarrier"?: Array<CountyCarrierValue>;
|
|
162
|
+
/**
|
|
163
|
+
* Percentage of completed outbound calls under 10 seconds (PSTN Short call tags); More than 15% is typically low trust measured.
|
|
164
|
+
*/
|
|
165
|
+
"shortDurationCallsPercentage"?: number;
|
|
166
|
+
/**
|
|
167
|
+
* Percentage of long duration calls ( >= 60 seconds)
|
|
168
|
+
*/
|
|
169
|
+
"longDurationCallsPercentage"?: number;
|
|
170
|
+
/**
|
|
171
|
+
* Percentage of completed outbound calls to unassigned or unallocated phone numbers.
|
|
172
|
+
*/
|
|
173
|
+
"potentialRobocallsPercentage"?: number;
|
|
174
|
+
"brandedCalling"?: BrandedCalling;
|
|
175
|
+
"voiceIntegrity"?: VoiceIntegrity;
|
|
176
|
+
"stirShaken"?: StirShaken;
|
|
177
|
+
constructor(payload: any);
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* Network-quality indicators for SDK and Twilio Gateway traffic during the report period.
|
|
181
|
+
*/
|
|
182
|
+
export declare class AccountReportNetworkIssues {
|
|
183
|
+
"sdk"?: AccountReportNetworkIssuesSdk;
|
|
184
|
+
"twilioGateway"?: AccountReportNetworkIssuesTwilioGateway;
|
|
185
|
+
constructor(payload: any);
|
|
186
|
+
}
|
|
187
|
+
/**
|
|
188
|
+
* Network issues of calls for client type. This is indicative of local network issues.
|
|
189
|
+
*/
|
|
190
|
+
export declare class AccountReportNetworkIssuesSdk {
|
|
191
|
+
/**
|
|
192
|
+
* Percentage of ICE connection failure tag that ICE candidates have failed to find compatible connection.
|
|
193
|
+
*/
|
|
194
|
+
"iceFailuresPercentage"?: number;
|
|
195
|
+
/**
|
|
196
|
+
* Percentage of calls with high latency.
|
|
197
|
+
*/
|
|
198
|
+
"highLatencyPercentage"?: number;
|
|
199
|
+
/**
|
|
200
|
+
* Percentage of calls with high packet loss.
|
|
201
|
+
*/
|
|
202
|
+
"highPacketLossPercentage"?: number;
|
|
203
|
+
/**
|
|
204
|
+
* Percentage of calls with high jitter.
|
|
205
|
+
*/
|
|
206
|
+
"highJitterPercentage"?: number;
|
|
207
|
+
constructor(payload: any);
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* Network related metrics for Twilio Gateway calls only.
|
|
211
|
+
*/
|
|
212
|
+
export declare class AccountReportNetworkIssuesTwilioGateway {
|
|
213
|
+
/**
|
|
214
|
+
* Percentage of calls with high latency.
|
|
215
|
+
*/
|
|
216
|
+
"highLatencyPercentage"?: number;
|
|
217
|
+
/**
|
|
218
|
+
* Percentage of calls with high packet loss.
|
|
219
|
+
*/
|
|
220
|
+
"highPacketLossPercentage"?: number;
|
|
221
|
+
/**
|
|
222
|
+
* Percentage of calls with high jitter.
|
|
223
|
+
*/
|
|
224
|
+
"highJitterPercentage"?: number;
|
|
225
|
+
constructor(payload: any);
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* Metrics related to Branded Calling bundled calls including CTIA for the report period.
|
|
229
|
+
*/
|
|
230
|
+
export declare class BrandedCalling {
|
|
231
|
+
/**
|
|
232
|
+
* Total number of Branded bundled calls.
|
|
233
|
+
*/
|
|
234
|
+
"totalBrandedCalls"?: number;
|
|
235
|
+
/**
|
|
236
|
+
* Percentage of Branded bundled calls over total outbound calls.
|
|
237
|
+
*/
|
|
238
|
+
"percentBrandedCalls"?: number;
|
|
239
|
+
/**
|
|
240
|
+
* Answer rate for Branded bundled calls.
|
|
241
|
+
*/
|
|
242
|
+
"answerRate"?: number;
|
|
243
|
+
/**
|
|
244
|
+
* Rate of Branded bundled calls that were answered by Human.
|
|
245
|
+
*/
|
|
246
|
+
"humanAnswerRate"?: number;
|
|
247
|
+
/**
|
|
248
|
+
* Engagement Rate for Branded bundled calls where its call length is longer than 60 seconds.
|
|
249
|
+
*/
|
|
250
|
+
"engagementRate"?: number;
|
|
251
|
+
/**
|
|
252
|
+
* Details of branded calls by use case.
|
|
253
|
+
*/
|
|
254
|
+
"byUseCase"?: Array<BrandedUseCaseDetail>;
|
|
255
|
+
constructor(payload: any);
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* Associated metrics for Branded calls grouped by each use case.
|
|
259
|
+
*/
|
|
260
|
+
export declare class BrandedUseCaseDetail {
|
|
261
|
+
/**
|
|
262
|
+
* The name of supported use case for Branded calls.
|
|
263
|
+
*/
|
|
264
|
+
"useCase"?: string;
|
|
265
|
+
/**
|
|
266
|
+
* The number of phone numbers enabled Branded calls.
|
|
267
|
+
*/
|
|
268
|
+
"enabledPhonenumbers"?: number;
|
|
269
|
+
/**
|
|
270
|
+
* The number of total outbound calls for the use case.
|
|
271
|
+
*/
|
|
272
|
+
"totalCalls"?: number;
|
|
273
|
+
/**
|
|
274
|
+
* Answer rate per each use case for Branded bundled calls.
|
|
275
|
+
*/
|
|
276
|
+
"answerRate"?: number;
|
|
277
|
+
/**
|
|
278
|
+
* Rate of Branded bundled calls that were answered by Human per each use case for Branded bundled calls.
|
|
279
|
+
*/
|
|
280
|
+
"humanAnswerRate"?: number;
|
|
281
|
+
/**
|
|
282
|
+
* Engagement Rate for Branded bundled calls where its call length is longer than 60 seconds per each use case for Branded bundled calls.
|
|
283
|
+
*/
|
|
284
|
+
"engagementRate"?: number;
|
|
285
|
+
constructor(payload: any);
|
|
286
|
+
}
|
|
287
|
+
export declare class CountyCarrierValue {
|
|
288
|
+
"country"?: string;
|
|
289
|
+
"carriers"?: Array<CountyCarrierValueCarriers>;
|
|
290
|
+
constructor(payload: any);
|
|
291
|
+
}
|
|
292
|
+
export declare class CountyCarrierValueCarriers {
|
|
293
|
+
/**
|
|
294
|
+
* The name of the carrier.
|
|
295
|
+
*/
|
|
296
|
+
"carrier"?: string;
|
|
297
|
+
/**
|
|
298
|
+
* Total number of outbound calls for the carrier in the country.
|
|
299
|
+
*/
|
|
300
|
+
"totalCalls"?: number;
|
|
301
|
+
/**
|
|
302
|
+
* Total number of blocked outbound calls for the carrier in the country.
|
|
303
|
+
*/
|
|
304
|
+
"blockedCalls"?: number;
|
|
305
|
+
/**
|
|
306
|
+
* Percentage of blocked outbound calls for the carrier in the country.
|
|
307
|
+
*/
|
|
308
|
+
"blockedCallsPercentage"?: number;
|
|
309
|
+
constructor(payload: any);
|
|
310
|
+
}
|
|
311
|
+
export declare class InsightsV2CreateAccountReportRequest {
|
|
312
|
+
"timeRange"?: InsightsV2CreateAccountReportRequestTimeRange;
|
|
313
|
+
"filters"?: Array<ReportFilter>;
|
|
314
|
+
constructor(payload: any);
|
|
315
|
+
}
|
|
316
|
+
/**
|
|
317
|
+
* Optional start and end date time for the report window. Defaults to the most recent 7 days when omitted.
|
|
318
|
+
*/
|
|
319
|
+
export declare class InsightsV2CreateAccountReportRequestTimeRange {
|
|
320
|
+
/**
|
|
321
|
+
* Start time of the report
|
|
322
|
+
*/
|
|
323
|
+
"startTime"?: Date;
|
|
324
|
+
/**
|
|
325
|
+
* End time of the report
|
|
326
|
+
*/
|
|
327
|
+
"endTime"?: Date;
|
|
328
|
+
constructor(payload: any);
|
|
329
|
+
}
|
|
330
|
+
/**
|
|
331
|
+
* Percentage of calls made in each state.
|
|
332
|
+
*/
|
|
333
|
+
export declare class InsightsV2InboundPhoneNumberReportCallStatePercentage {
|
|
334
|
+
/**
|
|
335
|
+
* Percentage of completed inbound calls.
|
|
336
|
+
*/
|
|
337
|
+
"completed"?: number;
|
|
338
|
+
/**
|
|
339
|
+
* Percentage of failed inbound calls.
|
|
340
|
+
*/
|
|
341
|
+
"fail"?: number;
|
|
342
|
+
/**
|
|
343
|
+
* Percentage of busy inbound calls.
|
|
344
|
+
*/
|
|
345
|
+
"busy"?: number;
|
|
346
|
+
/**
|
|
347
|
+
* Percentage of no-answer inbound calls.
|
|
348
|
+
*/
|
|
349
|
+
"noanswer"?: number;
|
|
350
|
+
/**
|
|
351
|
+
* Percentage of canceled inbound calls.
|
|
352
|
+
*/
|
|
353
|
+
"canceled"?: number;
|
|
354
|
+
constructor(payload: any);
|
|
355
|
+
}
|
|
356
|
+
/**
|
|
357
|
+
* Number of calls made in answering machine detection (AMD) enabled.
|
|
358
|
+
*/
|
|
359
|
+
export declare class InsightsV2OutboundPhoneNumberReportAnsweringMachineDetection {
|
|
360
|
+
/**
|
|
361
|
+
* Total number of calls with answering machine detection (AMD) enabled.
|
|
362
|
+
*/
|
|
363
|
+
"totalCalls"?: number;
|
|
364
|
+
/**
|
|
365
|
+
* Percentage of calls marked as answered by human.
|
|
366
|
+
*/
|
|
367
|
+
"answeredByHumanPercentage"?: number;
|
|
368
|
+
/**
|
|
369
|
+
* Percentage of calls marked as answered by machined related like the following: `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `fax`
|
|
370
|
+
*/
|
|
371
|
+
"answeredByMachinePercentage"?: number;
|
|
372
|
+
constructor(payload: any);
|
|
373
|
+
}
|
|
374
|
+
export declare class ReportFilter {
|
|
375
|
+
/**
|
|
376
|
+
* The name of the filter \'call_state\', \'call_direction\', \'call_type\', \'twilio_regions\', \'caller_country_code\', \'callee_country_code\', \'silent\'
|
|
377
|
+
*/
|
|
378
|
+
"key"?: string;
|
|
379
|
+
/**
|
|
380
|
+
* List of supported filter values for the field name
|
|
381
|
+
*/
|
|
382
|
+
"values"?: Array<string>;
|
|
383
|
+
constructor(payload: any);
|
|
384
|
+
}
|
|
385
|
+
export declare class ReportMetadata {
|
|
386
|
+
/**
|
|
387
|
+
* Start time of the report
|
|
388
|
+
*/
|
|
389
|
+
"startTime"?: Date;
|
|
390
|
+
/**
|
|
391
|
+
* End time of the report
|
|
392
|
+
*/
|
|
393
|
+
"endTime"?: Date;
|
|
394
|
+
/**
|
|
395
|
+
* Filter values applied to the report
|
|
396
|
+
*/
|
|
397
|
+
"filters"?: Array<ReportFilter>;
|
|
398
|
+
constructor(payload: any);
|
|
399
|
+
}
|
|
400
|
+
/**
|
|
401
|
+
* The status of the report.
|
|
402
|
+
*/
|
|
403
|
+
export type ReportStatus = "created" | "running" | "completed";
|
|
404
|
+
/**
|
|
405
|
+
* Metrics related to STIR/SHAKEN attestation A, B, and C for the report period.
|
|
406
|
+
*/
|
|
407
|
+
export declare class StirShaken {
|
|
408
|
+
"callCount"?: StirShakenCallCount;
|
|
409
|
+
"percentage"?: StirShakenPercentage;
|
|
410
|
+
"answerRate"?: StirShakenAnswerRate;
|
|
411
|
+
constructor(payload: any);
|
|
412
|
+
}
|
|
413
|
+
/**
|
|
414
|
+
* Answer rate for each STIR/SHAKEN attestation category.
|
|
415
|
+
*/
|
|
416
|
+
export declare class StirShakenAnswerRate {
|
|
417
|
+
/**
|
|
418
|
+
* Answer rate for Stir Shaken category A.
|
|
419
|
+
*/
|
|
420
|
+
"stshA"?: number;
|
|
421
|
+
/**
|
|
422
|
+
* Answer rate for Stir Shaken category B.
|
|
423
|
+
*/
|
|
424
|
+
"stshB"?: number;
|
|
425
|
+
/**
|
|
426
|
+
* Answer rate for Stir Shaken category C.
|
|
427
|
+
*/
|
|
428
|
+
"stshC"?: number;
|
|
429
|
+
constructor(payload: any);
|
|
430
|
+
}
|
|
431
|
+
/**
|
|
432
|
+
* Total number of calls for each STIR/SHAKEN attestation category.
|
|
433
|
+
*/
|
|
434
|
+
export declare class StirShakenCallCount {
|
|
435
|
+
/**
|
|
436
|
+
* Total number of calls for Stir Shaken category A.
|
|
437
|
+
*/
|
|
438
|
+
"stshA"?: number;
|
|
439
|
+
/**
|
|
440
|
+
* Total number of calls for Stir Shaken category B.
|
|
441
|
+
*/
|
|
442
|
+
"stshB"?: number;
|
|
443
|
+
/**
|
|
444
|
+
* Total number of calls for Stir Shaken category C.
|
|
445
|
+
*/
|
|
446
|
+
"stshC"?: number;
|
|
447
|
+
constructor(payload: any);
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
450
|
+
* Percentage of calls for each STIR/SHAKEN attestation category.
|
|
451
|
+
*/
|
|
452
|
+
export declare class StirShakenPercentage {
|
|
453
|
+
/**
|
|
454
|
+
* Percentage of calls for Stir Shaken category A.
|
|
455
|
+
*/
|
|
456
|
+
"stshA"?: number;
|
|
457
|
+
/**
|
|
458
|
+
* Percentage of calls for Stir Shaken category B.
|
|
459
|
+
*/
|
|
460
|
+
"stshB"?: number;
|
|
461
|
+
/**
|
|
462
|
+
* Percentage of calls for Stir Shaken category C.
|
|
463
|
+
*/
|
|
464
|
+
"stshC"?: number;
|
|
465
|
+
constructor(payload: any);
|
|
466
|
+
}
|
|
467
|
+
/**
|
|
468
|
+
* Metrics related to Voice Integrity enabled calls for the report period.
|
|
469
|
+
*/
|
|
470
|
+
export declare class VoiceIntegrity {
|
|
471
|
+
/**
|
|
472
|
+
* Total number of calls with Voice Integrity enabled.
|
|
473
|
+
*/
|
|
474
|
+
"enabledCalls"?: number;
|
|
475
|
+
/**
|
|
476
|
+
* Percentage of calls with Voice Integrity enabled.
|
|
477
|
+
*/
|
|
478
|
+
"enabledPercentage"?: number;
|
|
479
|
+
/**
|
|
480
|
+
* Number of calls per Voice Integrity enabled Bundle Sid.
|
|
481
|
+
*/
|
|
482
|
+
"callsPerBundle"?: Array<VoiceIntegrityCallsPerBundle>;
|
|
483
|
+
constructor(payload: any);
|
|
484
|
+
}
|
|
485
|
+
export declare class VoiceIntegrityCallsPerBundle {
|
|
486
|
+
/**
|
|
487
|
+
* Voice Integrity Approved Profile Sid.
|
|
488
|
+
*/
|
|
489
|
+
"bundleSid"?: string;
|
|
490
|
+
/**
|
|
491
|
+
* The number of Voice Integrity enabled and registered phone numbers per Bundle Sid.
|
|
492
|
+
*/
|
|
493
|
+
"enabledPhonenumbers"?: number;
|
|
494
|
+
/**
|
|
495
|
+
* The number of outbound calls on Voice Integrity enabled and registered number per Bundle Sid.
|
|
496
|
+
*/
|
|
497
|
+
"totalCalls"?: number;
|
|
498
|
+
/**
|
|
499
|
+
* Answer rate for calls on Voice Integrity enabled and registered number per Bundle Sid.
|
|
500
|
+
*/
|
|
501
|
+
"answerRate"?: number;
|
|
502
|
+
/**
|
|
503
|
+
* Rate for calls on Voice Integrity enabled and registered number per Bundle Sid that were answered by Human per each use case for Branded bundled calls.
|
|
504
|
+
*/
|
|
505
|
+
"humanAnswerRate"?: number;
|
|
506
|
+
constructor(payload: any);
|
|
507
|
+
}
|
|
508
|
+
/**
|
|
509
|
+
* Options to pass to create a ReportInstance
|
|
510
|
+
*/
|
|
511
|
+
export interface ReportContextCreateOptions {
|
|
512
|
+
/** */
|
|
513
|
+
insightsV2CreateAccountReportRequest?: InsightsV2CreateAccountReportRequest;
|
|
514
|
+
}
|
|
515
|
+
export interface ReportContext {
|
|
516
|
+
/**
|
|
517
|
+
* Create a ReportInstance
|
|
518
|
+
*
|
|
519
|
+
* @param callback - Callback to handle processed record
|
|
520
|
+
*
|
|
521
|
+
* @returns Resolves to processed ReportInstance
|
|
522
|
+
*/
|
|
523
|
+
create(callback?: (error: Error | null, item?: ReportInstance) => any): Promise<ReportInstance>;
|
|
524
|
+
/**
|
|
525
|
+
* Create a ReportInstance
|
|
526
|
+
*
|
|
527
|
+
* @param params - Body for request
|
|
528
|
+
* @param headers - header params for request
|
|
529
|
+
* @param callback - Callback to handle processed record
|
|
530
|
+
*
|
|
531
|
+
* @returns Resolves to processed ReportInstance
|
|
532
|
+
*/
|
|
533
|
+
create(params: InsightsV2CreateAccountReportRequest, headers?: any, callback?: (error: Error | null, item?: ReportInstance) => any): Promise<ReportInstance>;
|
|
534
|
+
/**
|
|
535
|
+
* Create a ReportInstance and return HTTP info
|
|
536
|
+
*
|
|
537
|
+
* @param callback - Callback to handle processed record
|
|
538
|
+
*
|
|
539
|
+
* @returns Resolves to processed ReportInstance with HTTP metadata
|
|
540
|
+
*/
|
|
541
|
+
createWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ReportInstance>) => any): Promise<ApiResponse<ReportInstance>>;
|
|
542
|
+
/**
|
|
543
|
+
* Create a ReportInstance and return HTTP info
|
|
544
|
+
*
|
|
545
|
+
* @param params - Body for request
|
|
546
|
+
* @param headers - header params for request
|
|
547
|
+
* @param callback - Callback to handle processed record
|
|
548
|
+
*
|
|
549
|
+
* @returns Resolves to processed ReportInstance with HTTP metadata
|
|
550
|
+
*/
|
|
551
|
+
createWithHttpInfo(params: InsightsV2CreateAccountReportRequest, headers?: any, callback?: (error: Error | null, item?: ApiResponse<ReportInstance>) => any): Promise<ApiResponse<ReportInstance>>;
|
|
552
|
+
/**
|
|
553
|
+
* Fetch a ReportInstance
|
|
554
|
+
*
|
|
555
|
+
* @param callback - Callback to handle processed record
|
|
556
|
+
*
|
|
557
|
+
* @returns Resolves to processed ReportInstance
|
|
558
|
+
*/
|
|
559
|
+
fetch(callback?: (error: Error | null, item?: ReportInstance) => any): Promise<ReportInstance>;
|
|
560
|
+
/**
|
|
561
|
+
* Fetch a ReportInstance and return HTTP info
|
|
562
|
+
*
|
|
563
|
+
* @param callback - Callback to handle processed record
|
|
564
|
+
*
|
|
565
|
+
* @returns Resolves to processed ReportInstance with HTTP metadata
|
|
566
|
+
*/
|
|
567
|
+
fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ReportInstance>) => any): Promise<ApiResponse<ReportInstance>>;
|
|
568
|
+
/**
|
|
569
|
+
* Provide a user-friendly representation
|
|
570
|
+
*/
|
|
571
|
+
toJSON(): any;
|
|
572
|
+
[inspect.custom](_depth: any, options: InspectOptions): any;
|
|
573
|
+
}
|
|
574
|
+
export interface ReportContextSolution {
|
|
575
|
+
reportId: string;
|
|
576
|
+
}
|
|
577
|
+
export declare class ReportContextImpl implements ReportContext {
|
|
578
|
+
protected _version: V2;
|
|
579
|
+
protected _solution: ReportContextSolution;
|
|
580
|
+
protected _uri: string;
|
|
581
|
+
constructor(_version: V2, reportId: string);
|
|
582
|
+
create(params?: InsightsV2CreateAccountReportRequest | ((error: Error | null, item?: ReportInstance) => any), headers?: any, callback?: (error: Error | null, item?: ReportInstance) => any): Promise<ReportInstance>;
|
|
583
|
+
createWithHttpInfo(params?: InsightsV2CreateAccountReportRequest | ((error: Error | null, item?: ApiResponse<ReportInstance>) => any), headers?: any, callback?: (error: Error | null, item?: ApiResponse<ReportInstance>) => any): Promise<ApiResponse<ReportInstance>>;
|
|
584
|
+
fetch(callback?: (error: Error | null, item?: ReportInstance) => any): Promise<ReportInstance>;
|
|
585
|
+
fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ReportInstance>) => any): Promise<ApiResponse<ReportInstance>>;
|
|
586
|
+
/**
|
|
587
|
+
* Provide a user-friendly representation
|
|
588
|
+
*
|
|
589
|
+
* @returns Object
|
|
590
|
+
*/
|
|
591
|
+
toJSON(): ReportContextSolution;
|
|
592
|
+
[inspect.custom](_depth: any, options: InspectOptions): string;
|
|
593
|
+
}
|
|
594
|
+
interface ReportResource {
|
|
595
|
+
account_sid: string;
|
|
596
|
+
report_id: string;
|
|
597
|
+
status: ReportStatus;
|
|
598
|
+
request_meta: ReportMetadata;
|
|
599
|
+
url: string;
|
|
600
|
+
handle: string;
|
|
601
|
+
total_calls: number;
|
|
602
|
+
call_answer_score: number;
|
|
603
|
+
call_state_percentage: InsightsV2InboundPhoneNumberReportCallStatePercentage;
|
|
604
|
+
silent_calls_percentage: number;
|
|
605
|
+
calls_by_device_type: {
|
|
606
|
+
[key: string]: number;
|
|
607
|
+
};
|
|
608
|
+
answer_rate_device_type: {
|
|
609
|
+
[key: string]: number;
|
|
610
|
+
};
|
|
611
|
+
blocked_calls_by_carrier: Array<CountyCarrierValue>;
|
|
612
|
+
short_duration_calls_percentage: number;
|
|
613
|
+
long_duration_calls_percentage: number;
|
|
614
|
+
potential_robocalls_percentage: number;
|
|
615
|
+
answering_machine_detection: InsightsV2OutboundPhoneNumberReportAnsweringMachineDetection;
|
|
616
|
+
report: AccountReport;
|
|
617
|
+
}
|
|
618
|
+
export declare class ReportInstance {
|
|
619
|
+
protected _version: V2;
|
|
620
|
+
protected _solution: ReportContextSolution;
|
|
621
|
+
protected _context?: ReportContext;
|
|
622
|
+
constructor(_version: V2, payload: ReportResource, reportId?: string);
|
|
623
|
+
/**
|
|
624
|
+
* The unique SID identifier of the Account.
|
|
625
|
+
*/
|
|
626
|
+
accountSid: string;
|
|
627
|
+
/**
|
|
628
|
+
* The report identifier as Voice Insights Report TTID.
|
|
629
|
+
*/
|
|
630
|
+
reportId: string;
|
|
631
|
+
status: ReportStatus;
|
|
632
|
+
requestMeta: ReportMetadata;
|
|
633
|
+
/**
|
|
634
|
+
* The URL of this resource.
|
|
635
|
+
*/
|
|
636
|
+
url: string;
|
|
637
|
+
/**
|
|
638
|
+
* Inbound phone number handle represented in the report.
|
|
639
|
+
*/
|
|
640
|
+
handle: string;
|
|
641
|
+
/**
|
|
642
|
+
* Total number of calls made with the given handle during the report period.
|
|
643
|
+
*/
|
|
644
|
+
totalCalls: number;
|
|
645
|
+
/**
|
|
646
|
+
* The call answer score measures customers behavior to the delivered calls. The score is a value between 0 and 100, where 100 indicates that all calls were successfully answered.
|
|
647
|
+
*/
|
|
648
|
+
callAnswerScore: number;
|
|
649
|
+
callStatePercentage: InsightsV2InboundPhoneNumberReportCallStatePercentage;
|
|
650
|
+
/**
|
|
651
|
+
* Percentage of inbound calls with silence tags over total outbound calls. A silent tag is indicative of a connectivity issue or muted audio.
|
|
652
|
+
*/
|
|
653
|
+
silentCallsPercentage: number;
|
|
654
|
+
/**
|
|
655
|
+
* Number of calls made with each device type. `voip`, `mobile`, `landline`, `unknown`
|
|
656
|
+
*/
|
|
657
|
+
callsByDeviceType: {
|
|
658
|
+
[key: string]: number;
|
|
659
|
+
};
|
|
660
|
+
/**
|
|
661
|
+
* Answer rate for each device type. `voip`, `mobile`, `landline`, `unknown`
|
|
662
|
+
*/
|
|
663
|
+
answerRateDeviceType: {
|
|
664
|
+
[key: string]: number;
|
|
665
|
+
};
|
|
666
|
+
/**
|
|
667
|
+
* Percentage of blocked calls by carrier per country.
|
|
668
|
+
*/
|
|
669
|
+
blockedCallsByCarrier: Array<CountyCarrierValue>;
|
|
670
|
+
/**
|
|
671
|
+
* Percentage of completed outbound calls under 10 seconds (PSTN Short call tags); More than 15% is typically low trust measured.
|
|
672
|
+
*/
|
|
673
|
+
shortDurationCallsPercentage: number;
|
|
674
|
+
/**
|
|
675
|
+
* Percentage of long duration calls ( >= 60 seconds)
|
|
676
|
+
*/
|
|
677
|
+
longDurationCallsPercentage: number;
|
|
678
|
+
/**
|
|
679
|
+
* Percentage of completed outbound calls to unassigned or unallocated phone numbers.
|
|
680
|
+
*/
|
|
681
|
+
potentialRobocallsPercentage: number;
|
|
682
|
+
answeringMachineDetection: InsightsV2OutboundPhoneNumberReportAnsweringMachineDetection;
|
|
683
|
+
report: AccountReport;
|
|
684
|
+
private get _proxy();
|
|
685
|
+
/**
|
|
686
|
+
* Create a ReportInstance
|
|
687
|
+
*
|
|
688
|
+
* @param callback - Callback to handle processed record
|
|
689
|
+
*
|
|
690
|
+
* @returns Resolves to processed ReportInstance
|
|
691
|
+
*/
|
|
692
|
+
create(callback?: (error: Error | null, item?: ReportInstance) => any): Promise<ReportInstance>;
|
|
693
|
+
/**
|
|
694
|
+
* Create a ReportInstance
|
|
695
|
+
*
|
|
696
|
+
* @param params - Body for request
|
|
697
|
+
* @param headers - header params for request
|
|
698
|
+
* @param callback - Callback to handle processed record
|
|
699
|
+
*
|
|
700
|
+
* @returns Resolves to processed ReportInstance
|
|
701
|
+
*/
|
|
702
|
+
create(params: InsightsV2CreateAccountReportRequest, headers?: any, callback?: (error: Error | null, item?: ReportInstance) => any): Promise<ReportInstance>;
|
|
703
|
+
/**
|
|
704
|
+
* Create a ReportInstance and return HTTP info
|
|
705
|
+
*
|
|
706
|
+
* @param callback - Callback to handle processed record
|
|
707
|
+
*
|
|
708
|
+
* @returns Resolves to processed ReportInstance with HTTP metadata
|
|
709
|
+
*/
|
|
710
|
+
createWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ReportInstance>) => any): Promise<ApiResponse<ReportInstance>>;
|
|
711
|
+
/**
|
|
712
|
+
* Create a ReportInstance and return HTTP info
|
|
713
|
+
*
|
|
714
|
+
* @param params - Body for request
|
|
715
|
+
* @param headers - header params for request
|
|
716
|
+
* @param callback - Callback to handle processed record
|
|
717
|
+
*
|
|
718
|
+
* @returns Resolves to processed ReportInstance with HTTP metadata
|
|
719
|
+
*/
|
|
720
|
+
createWithHttpInfo(params: InsightsV2CreateAccountReportRequest, headers?: any, callback?: (error: Error | null, item?: ApiResponse<ReportInstance>) => any): Promise<ApiResponse<ReportInstance>>;
|
|
721
|
+
/**
|
|
722
|
+
* Fetch a ReportInstance
|
|
723
|
+
*
|
|
724
|
+
* @param callback - Callback to handle processed record
|
|
725
|
+
*
|
|
726
|
+
* @returns Resolves to processed ReportInstance
|
|
727
|
+
*/
|
|
728
|
+
fetch(callback?: (error: Error | null, item?: ReportInstance) => any): Promise<ReportInstance>;
|
|
729
|
+
/**
|
|
730
|
+
* Fetch a ReportInstance and return HTTP info
|
|
731
|
+
*
|
|
732
|
+
* @param callback - Callback to handle processed record
|
|
733
|
+
*
|
|
734
|
+
* @returns Resolves to processed ReportInstance with HTTP metadata
|
|
735
|
+
*/
|
|
736
|
+
fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ReportInstance>) => any): Promise<ApiResponse<ReportInstance>>;
|
|
737
|
+
/**
|
|
738
|
+
* Provide a user-friendly representation
|
|
739
|
+
*
|
|
740
|
+
* @returns Object
|
|
741
|
+
*/
|
|
742
|
+
toJSON(): {
|
|
743
|
+
accountSid: string;
|
|
744
|
+
reportId: string;
|
|
745
|
+
status: ReportStatus;
|
|
746
|
+
requestMeta: ReportMetadata;
|
|
747
|
+
url: string;
|
|
748
|
+
handle: string;
|
|
749
|
+
totalCalls: number;
|
|
750
|
+
callAnswerScore: number;
|
|
751
|
+
callStatePercentage: InsightsV2InboundPhoneNumberReportCallStatePercentage;
|
|
752
|
+
silentCallsPercentage: number;
|
|
753
|
+
callsByDeviceType: {
|
|
754
|
+
[key: string]: number;
|
|
755
|
+
};
|
|
756
|
+
answerRateDeviceType: {
|
|
757
|
+
[key: string]: number;
|
|
758
|
+
};
|
|
759
|
+
blockedCallsByCarrier: CountyCarrierValue[];
|
|
760
|
+
shortDurationCallsPercentage: number;
|
|
761
|
+
longDurationCallsPercentage: number;
|
|
762
|
+
potentialRobocallsPercentage: number;
|
|
763
|
+
answeringMachineDetection: InsightsV2OutboundPhoneNumberReportAnsweringMachineDetection;
|
|
764
|
+
report: AccountReport;
|
|
765
|
+
};
|
|
766
|
+
[inspect.custom](_depth: any, options: InspectOptions): string;
|
|
767
|
+
}
|
|
768
|
+
export interface ReportSolution {
|
|
769
|
+
}
|
|
770
|
+
export interface ReportListInstance {
|
|
771
|
+
_version: V2;
|
|
772
|
+
_solution: ReportSolution;
|
|
773
|
+
_uri: string;
|
|
774
|
+
(reportId: string): ReportContext;
|
|
775
|
+
get(reportId: string): ReportContext;
|
|
776
|
+
/**
|
|
777
|
+
* Provide a user-friendly representation
|
|
778
|
+
*/
|
|
779
|
+
toJSON(): any;
|
|
780
|
+
[inspect.custom](_depth: any, options: InspectOptions): any;
|
|
781
|
+
}
|
|
782
|
+
export declare function ReportListInstance(version: V2): ReportListInstance;
|
|
783
|
+
export {};
|