telnyx 6.64.0 → 6.65.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.
Files changed (149) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/client.d.mts +10 -11
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +10 -11
  5. package/client.d.ts.map +1 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/ai/ai.d.mts +116 -114
  10. package/resources/ai/ai.d.mts.map +1 -1
  11. package/resources/ai/ai.d.ts +116 -114
  12. package/resources/ai/ai.d.ts.map +1 -1
  13. package/resources/ai/ai.js.map +1 -1
  14. package/resources/ai/ai.mjs.map +1 -1
  15. package/resources/ai/assistants/assistants.d.mts +332 -112
  16. package/resources/ai/assistants/assistants.d.mts.map +1 -1
  17. package/resources/ai/assistants/assistants.d.ts +332 -112
  18. package/resources/ai/assistants/assistants.d.ts.map +1 -1
  19. package/resources/ai/assistants/assistants.js.map +1 -1
  20. package/resources/ai/assistants/assistants.mjs.map +1 -1
  21. package/resources/ai/assistants/canary-deploys.d.mts +241 -70
  22. package/resources/ai/assistants/canary-deploys.d.mts.map +1 -1
  23. package/resources/ai/assistants/canary-deploys.d.ts +241 -70
  24. package/resources/ai/assistants/canary-deploys.d.ts.map +1 -1
  25. package/resources/ai/assistants/index.d.mts +2 -2
  26. package/resources/ai/assistants/index.d.mts.map +1 -1
  27. package/resources/ai/assistants/index.d.ts +2 -2
  28. package/resources/ai/assistants/index.d.ts.map +1 -1
  29. package/resources/ai/assistants/index.js.map +1 -1
  30. package/resources/ai/assistants/index.mjs.map +1 -1
  31. package/resources/ai/assistants/versions.d.mts +220 -6
  32. package/resources/ai/assistants/versions.d.mts.map +1 -1
  33. package/resources/ai/assistants/versions.d.ts +220 -6
  34. package/resources/ai/assistants/versions.d.ts.map +1 -1
  35. package/resources/ai/index.d.mts +2 -2
  36. package/resources/ai/index.d.mts.map +1 -1
  37. package/resources/ai/index.d.ts +2 -2
  38. package/resources/ai/index.d.ts.map +1 -1
  39. package/resources/ai/index.js.map +1 -1
  40. package/resources/ai/index.mjs.map +1 -1
  41. package/resources/ai/openai/openai.d.mts +113 -2
  42. package/resources/ai/openai/openai.d.mts.map +1 -1
  43. package/resources/ai/openai/openai.d.ts +113 -2
  44. package/resources/ai/openai/openai.d.ts.map +1 -1
  45. package/resources/ai/openai/openai.js.map +1 -1
  46. package/resources/ai/openai/openai.mjs.map +1 -1
  47. package/resources/calls/actions.d.mts +398 -41
  48. package/resources/calls/actions.d.mts.map +1 -1
  49. package/resources/calls/actions.d.ts +398 -41
  50. package/resources/calls/actions.d.ts.map +1 -1
  51. package/resources/calls/actions.js +46 -0
  52. package/resources/calls/actions.js.map +1 -1
  53. package/resources/calls/actions.mjs +46 -0
  54. package/resources/calls/actions.mjs.map +1 -1
  55. package/resources/calls/calls.d.mts +2 -2
  56. package/resources/calls/calls.d.mts.map +1 -1
  57. package/resources/calls/calls.d.ts +2 -2
  58. package/resources/calls/calls.d.ts.map +1 -1
  59. package/resources/calls/calls.js.map +1 -1
  60. package/resources/calls/calls.mjs.map +1 -1
  61. package/resources/calls/index.d.mts +1 -1
  62. package/resources/calls/index.d.mts.map +1 -1
  63. package/resources/calls/index.d.ts +1 -1
  64. package/resources/calls/index.d.ts.map +1 -1
  65. package/resources/calls/index.js.map +1 -1
  66. package/resources/calls/index.mjs.map +1 -1
  67. package/resources/conferences/actions.d.mts +11 -1
  68. package/resources/conferences/actions.d.mts.map +1 -1
  69. package/resources/conferences/actions.d.ts +11 -1
  70. package/resources/conferences/actions.d.ts.map +1 -1
  71. package/resources/index.d.mts +5 -5
  72. package/resources/index.d.mts.map +1 -1
  73. package/resources/index.d.ts +5 -5
  74. package/resources/index.d.ts.map +1 -1
  75. package/resources/index.js.map +1 -1
  76. package/resources/index.mjs.map +1 -1
  77. package/resources/networks/networks.d.mts +2 -25
  78. package/resources/networks/networks.d.mts.map +1 -1
  79. package/resources/networks/networks.d.ts +2 -25
  80. package/resources/networks/networks.d.ts.map +1 -1
  81. package/resources/networks/networks.js.map +1 -1
  82. package/resources/networks/networks.mjs.map +1 -1
  83. package/resources/public-internet-gateways.d.mts +50 -40
  84. package/resources/public-internet-gateways.d.mts.map +1 -1
  85. package/resources/public-internet-gateways.d.ts +50 -40
  86. package/resources/public-internet-gateways.d.ts.map +1 -1
  87. package/resources/public-internet-gateways.js +1 -1
  88. package/resources/public-internet-gateways.js.map +1 -1
  89. package/resources/public-internet-gateways.mjs +1 -1
  90. package/resources/public-internet-gateways.mjs.map +1 -1
  91. package/resources/shared.d.mts +0 -10
  92. package/resources/shared.d.mts.map +1 -1
  93. package/resources/shared.d.ts +0 -10
  94. package/resources/shared.d.ts.map +1 -1
  95. package/resources/uac-connections/index.d.mts +1 -1
  96. package/resources/uac-connections/index.d.mts.map +1 -1
  97. package/resources/uac-connections/index.d.ts +1 -1
  98. package/resources/uac-connections/index.d.ts.map +1 -1
  99. package/resources/uac-connections/index.js.map +1 -1
  100. package/resources/uac-connections/index.mjs.map +1 -1
  101. package/resources/uac-connections/uac-connections.d.mts +1861 -211
  102. package/resources/uac-connections/uac-connections.d.mts.map +1 -1
  103. package/resources/uac-connections/uac-connections.d.ts +1861 -211
  104. package/resources/uac-connections/uac-connections.d.ts.map +1 -1
  105. package/resources/uac-connections/uac-connections.js +1 -1
  106. package/resources/uac-connections/uac-connections.js.map +1 -1
  107. package/resources/uac-connections/uac-connections.mjs +1 -1
  108. package/resources/uac-connections/uac-connections.mjs.map +1 -1
  109. package/resources/virtual-cross-connects.d.mts +504 -48
  110. package/resources/virtual-cross-connects.d.mts.map +1 -1
  111. package/resources/virtual-cross-connects.d.ts +504 -48
  112. package/resources/virtual-cross-connects.d.ts.map +1 -1
  113. package/resources/virtual-cross-connects.js +1 -1
  114. package/resources/virtual-cross-connects.js.map +1 -1
  115. package/resources/virtual-cross-connects.mjs +1 -1
  116. package/resources/virtual-cross-connects.mjs.map +1 -1
  117. package/resources/wireguard-interfaces.d.mts +127 -43
  118. package/resources/wireguard-interfaces.d.mts.map +1 -1
  119. package/resources/wireguard-interfaces.d.ts +127 -43
  120. package/resources/wireguard-interfaces.d.ts.map +1 -1
  121. package/resources/wireguard-interfaces.js +2 -5
  122. package/resources/wireguard-interfaces.js.map +1 -1
  123. package/resources/wireguard-interfaces.mjs +2 -5
  124. package/resources/wireguard-interfaces.mjs.map +1 -1
  125. package/src/client.ts +16 -27
  126. package/src/resources/ai/ai.ts +130 -139
  127. package/src/resources/ai/assistants/assistants.ts +362 -133
  128. package/src/resources/ai/assistants/canary-deploys.ts +266 -75
  129. package/src/resources/ai/assistants/index.ts +0 -10
  130. package/src/resources/ai/assistants/versions.ts +244 -6
  131. package/src/resources/ai/index.ts +0 -6
  132. package/src/resources/ai/openai/openai.ts +131 -2
  133. package/src/resources/calls/actions.ts +543 -76
  134. package/src/resources/calls/calls.ts +8 -4
  135. package/src/resources/calls/index.ts +4 -2
  136. package/src/resources/conferences/actions.ts +13 -1
  137. package/src/resources/index.ts +8 -13
  138. package/src/resources/networks/networks.ts +4 -31
  139. package/src/resources/public-internet-gateways.ts +55 -46
  140. package/src/resources/shared.ts +0 -12
  141. package/src/resources/uac-connections/index.ts +2 -6
  142. package/src/resources/uac-connections/uac-connections.ts +2377 -378
  143. package/src/resources/virtual-cross-connects.ts +595 -54
  144. package/src/resources/wireguard-interfaces.ts +158 -53
  145. package/src/version.ts +1 -1
  146. package/version.d.mts +1 -1
  147. package/version.d.ts +1 -1
  148. package/version.js +1 -1
  149. package/version.mjs +1 -1
@@ -75,7 +75,7 @@ export class UacConnections extends APIResource {
75
75
  * @example
76
76
  * ```ts
77
77
  * // Automatically fetches more pages as needed.
78
- * for await (const uacConnection of client.uacConnections.list()) {
78
+ * for await (const uacConnectionListResponse of client.uacConnections.list()) {
79
79
  * // ...
80
80
  * }
81
81
  * ```
@@ -83,8 +83,8 @@ export class UacConnections extends APIResource {
83
83
  list(
84
84
  query: UacConnectionListParams | null | undefined = {},
85
85
  options?: RequestOptions,
86
- ): PagePromise<UacConnectionsDefaultFlatPagination, UacConnection> {
87
- return this._client.getAPIList('/uac_connections', DefaultFlatPagination<UacConnection>, {
86
+ ): PagePromise<UacConnectionListResponsesDefaultFlatPagination, UacConnectionListResponse> {
87
+ return this._client.getAPIList('/uac_connections', DefaultFlatPagination<UacConnectionListResponse>, {
88
88
  query,
89
89
  ...options,
90
90
  });
@@ -105,7 +105,1337 @@ export class UacConnections extends APIResource {
105
105
  }
106
106
  }
107
107
 
108
- export type UacConnectionsDefaultFlatPagination = DefaultFlatPagination<UacConnection>;
108
+ export type UacConnectionListResponsesDefaultFlatPagination =
109
+ DefaultFlatPagination<UacConnectionListResponse>;
110
+
111
+ export interface UacConnectionCreateResponse {
112
+ /**
113
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
114
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
115
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
116
+ * registration.
117
+ */
118
+ data?: UacConnectionCreateResponse.Data;
119
+ }
120
+
121
+ export namespace UacConnectionCreateResponse {
122
+ /**
123
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
124
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
125
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
126
+ * registration.
127
+ */
128
+ export interface Data {
129
+ /**
130
+ * Identifies the type of resource.
131
+ */
132
+ id?: string;
133
+
134
+ /**
135
+ * Defaults to true
136
+ */
137
+ active?: boolean;
138
+
139
+ /**
140
+ * `Latency` directs Telnyx to route media through the site with the lowest
141
+ * round-trip time to the user's connection. Telnyx calculates this time using ICMP
142
+ * ping messages. This can be disabled by specifying a site to handle all media.
143
+ */
144
+ anchorsite_override?: CredentialConnectionsAPI.AnchorsiteOverride;
145
+
146
+ /**
147
+ * The uuid of the push credential for Android
148
+ */
149
+ android_push_credential_id?: string | null;
150
+
151
+ /**
152
+ * The authentication strategy used by this connection.
153
+ */
154
+ authentication?: 'uac-authentication';
155
+
156
+ /**
157
+ * Specifies if call cost webhooks should be sent for this connection.
158
+ */
159
+ call_cost_in_webhooks?: boolean;
160
+
161
+ connection_name?: string;
162
+
163
+ /**
164
+ * ISO-8601 formatted date indicating when the resource was created.
165
+ */
166
+ created_at?: string;
167
+
168
+ /**
169
+ * When enabled, Telnyx will generate comfort noise when you place the call on
170
+ * hold. If disabled, you will need to generate comfort noise or on hold music to
171
+ * avoid RTP timeout.
172
+ */
173
+ default_on_hold_comfort_noise_enabled?: boolean;
174
+
175
+ /**
176
+ * Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
177
+ * digits sent to Telnyx will be accepted in all formats.
178
+ */
179
+ dtmf_type?: CredentialConnectionsAPI.DtmfType;
180
+
181
+ /**
182
+ * Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
183
+ * scenarios.
184
+ */
185
+ encode_contact_header_enabled?: boolean;
186
+
187
+ /**
188
+ * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
189
+ * TLS.
190
+ */
191
+ encrypted_media?: CredentialConnectionsAPI.EncryptedMedia | null;
192
+
193
+ /**
194
+ * External SIP peer settings used by Telnyx when registering to your PBX and
195
+ * routing outbound calls.
196
+ */
197
+ external_uac_settings?: Data.ExternalUacSettings;
198
+
199
+ /**
200
+ * The Telnyx-managed FQDN generated for the UAC connection.
201
+ */
202
+ fqdn?: string;
203
+
204
+ /**
205
+ * The fixed outbound authentication mode used by UAC FQDN records.
206
+ */
207
+ fqdn_outbound_authentication?: 'credential-authentication';
208
+
209
+ /**
210
+ * FQDN records managed automatically by the UAC connection lifecycle.
211
+ */
212
+ fqdns?: Array<FqdnsAPI.Fqdn>;
213
+
214
+ inbound?: Data.Inbound;
215
+
216
+ /**
217
+ * Internal Telnyx-side settings for a UAC connection.
218
+ */
219
+ internal_uac_settings?: Data.InternalUacSettings;
220
+
221
+ /**
222
+ * The uuid of the push credential for Ios
223
+ */
224
+ ios_push_credential_id?: string | null;
225
+
226
+ /**
227
+ * Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams
228
+ * of SIP Trunking calls. The feature is off unless enabled. You may define min and
229
+ * max values in msec for customized buffering behaviors. Larger values add latency
230
+ * but tolerate more jitter, while smaller values reduce latency but are more
231
+ * sensitive to jitter and reordering.
232
+ */
233
+ jitter_buffer?: Shared.ConnectionJitterBuffer;
234
+
235
+ /**
236
+ * Controls when noise suppression is applied to calls. When set to 'inbound',
237
+ * noise suppression is applied to incoming audio. When set to 'outbound', it's
238
+ * applied to outgoing audio. When set to 'both', it's applied in both directions.
239
+ * When set to 'disabled', noise suppression is turned off.
240
+ */
241
+ noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
242
+
243
+ /**
244
+ * Configuration options for noise suppression. These settings are stored
245
+ * regardless of the noise_suppression value, but only take effect when
246
+ * noise_suppression is not 'disabled'. If you disable noise suppression and later
247
+ * re-enable it, the previously configured settings will be used.
248
+ */
249
+ noise_suppression_details?: Shared.ConnectionNoiseSuppressionDetails;
250
+
251
+ /**
252
+ * Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
253
+ * if both are on the Telnyx network. If this is disabled, Telnyx will be able to
254
+ * use T38 on just one leg of the call depending on each leg's settings.
255
+ */
256
+ onnet_t38_passthrough_enabled?: boolean;
257
+
258
+ outbound?: Data.Outbound;
259
+
260
+ /**
261
+ * The password to be used as part of the credentials. Must be 8 to 128 characters
262
+ * long.
263
+ */
264
+ password?: string;
265
+
266
+ /**
267
+ * Identifies the type of the resource.
268
+ */
269
+ record_type?: string;
270
+
271
+ /**
272
+ * The most recently known SIP registration status for this UAC connection.
273
+ */
274
+ registration_status?: string | null;
275
+
276
+ /**
277
+ * ISO 8601 formatted date indicating when the registration status was last
278
+ * updated.
279
+ */
280
+ registration_status_updated_at?: string | null;
281
+
282
+ rtcp_settings?: CredentialConnectionsAPI.ConnectionRtcpSettings;
283
+
284
+ /**
285
+ * This feature enables inbound SIP URI calls to your Credential Auth Connection.
286
+ * If enabled for all (unrestricted) then anyone who calls the SIP URI
287
+ * <your-username>@telnyx.com will be connected to your Connection. You can also
288
+ * choose to allow only calls that are originated on any Connections under your
289
+ * account (internal).
290
+ */
291
+ sip_uri_calling_preference?: 'disabled' | 'unrestricted' | 'internal';
292
+
293
+ /**
294
+ * Tags associated with the connection.
295
+ */
296
+ tags?: Array<string>;
297
+
298
+ /**
299
+ * ISO-8601 formatted date indicating when the resource was updated.
300
+ */
301
+ updated_at?: string;
302
+
303
+ /**
304
+ * The user name to be used as part of the credentials. Must be 4-32 characters
305
+ * long and alphanumeric values only (no spaces or special characters). At least
306
+ * one of the first 5 characters must be a letter.
307
+ */
308
+ user_name?: string;
309
+
310
+ /**
311
+ * Determines which webhook format will be used, Telnyx API v1 or v2.
312
+ */
313
+ webhook_api_version?: '1' | '2';
314
+
315
+ /**
316
+ * The failover URL where webhooks related to this connection will be sent if
317
+ * sending to the primary URL fails. Must include a scheme, such as 'https'.
318
+ */
319
+ webhook_event_failover_url?: string | null;
320
+
321
+ /**
322
+ * The URL where webhooks related to this connection will be sent. Must include a
323
+ * scheme, such as 'https'.
324
+ */
325
+ webhook_event_url?: string;
326
+
327
+ /**
328
+ * Specifies how many seconds to wait before timing out a webhook.
329
+ */
330
+ webhook_timeout_secs?: number | null;
331
+ }
332
+
333
+ export namespace Data {
334
+ /**
335
+ * External SIP peer settings used by Telnyx when registering to your PBX and
336
+ * routing outbound calls.
337
+ */
338
+ export interface ExternalUacSettings {
339
+ /**
340
+ * The authentication username used in SIP digest authentication. If not set, the
341
+ * Username value will be used.
342
+ */
343
+ auth_username?: string | null;
344
+
345
+ /**
346
+ * The registration interval, in seconds, indicating how often the system refreshes
347
+ * the SIP registration with the external SIP peer.
348
+ */
349
+ expiration_sec?: number | null;
350
+
351
+ /**
352
+ * The user portion of the SIP From header used in outbound requests. This controls
353
+ * the caller identity presented to the external SIP peer.
354
+ */
355
+ from_user?: string | null;
356
+
357
+ /**
358
+ * An optional SIP proxy used to route outbound requests before reaching the
359
+ * external SIP peer.
360
+ */
361
+ outbound_proxy?: string | null;
362
+
363
+ /**
364
+ * The SIP password used for digest authentication with the external SIP peer.
365
+ */
366
+ password?: string;
367
+
368
+ /**
369
+ * The SIP proxy address of the external SIP peer used for registrations and
370
+ * outbound call routing.
371
+ */
372
+ proxy?: string;
373
+
374
+ /**
375
+ * The transport protocol used for SIP signaling when communicating with the
376
+ * external SIP peer. One of UDP, TLS, or TCP.
377
+ */
378
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
379
+
380
+ /**
381
+ * The SIP username used to authenticate with the external SIP peer for
382
+ * registrations and outbound calls. Must start with a letter or number and contain
383
+ * only letters, numbers, hyphens, and underscores.
384
+ */
385
+ username?: string;
386
+ }
387
+
388
+ export interface Inbound {
389
+ /**
390
+ * This setting allows you to set the format with which the caller's number (ANI)
391
+ * is sent for inbound phone calls.
392
+ */
393
+ ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
394
+
395
+ /**
396
+ * When set, this will limit the total number of inbound calls to phone numbers
397
+ * associated with this connection.
398
+ */
399
+ channel_limit?: number;
400
+
401
+ /**
402
+ * Defines the list of codecs that Telnyx will send for inbound calls to a specific
403
+ * number on your portal account, in priority order. This only works when the
404
+ * Connection the number is assigned to uses Media Handling mode: default. OPUS and
405
+ * H.264 codecs are available only when using TCP or TLS transport for SIP.
406
+ */
407
+ codecs?: Array<string>;
408
+
409
+ /**
410
+ * Default routing method to be used when a number is associated with the
411
+ * connection. Must be one of the routing method types or left blank, other values
412
+ * are not allowed.
413
+ */
414
+ default_routing_method?: 'sequential' | 'round-robin';
415
+
416
+ dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
417
+
418
+ /**
419
+ * Generate ringback tone through 183 session progress message with early media.
420
+ */
421
+ generate_ringback_tone?: boolean;
422
+
423
+ /**
424
+ * When set, inbound phone calls will receive ISUP parameters via SIP headers.
425
+ * (Only when available and only when using TCP or TLS transport.)
426
+ */
427
+ isup_headers_enabled?: boolean;
428
+
429
+ /**
430
+ * Enable PRACK messages as defined in RFC3262.
431
+ */
432
+ prack_enabled?: boolean;
433
+
434
+ /**
435
+ * When enabled the SIP Connection will receive the Identity header with
436
+ * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
437
+ * transport.
438
+ */
439
+ shaken_stir_enabled?: boolean;
440
+
441
+ /**
442
+ * When enabled, allows multiple devices to ring simultaneously on incoming calls.
443
+ */
444
+ simultaneous_ringing?: 'disabled' | 'enabled';
445
+
446
+ /**
447
+ * Defaults to true.
448
+ */
449
+ sip_compact_headers_enabled?: boolean;
450
+
451
+ /**
452
+ * The Telnyx-generated SIP subdomain for this UAC connection.
453
+ */
454
+ sip_subdomain?: string;
455
+
456
+ /**
457
+ * Controls which SIP URI callers may reach this connection.
458
+ */
459
+ sip_subdomain_receive_settings?: 'only_my_connections' | 'from_anyone';
460
+
461
+ /**
462
+ * Time(sec) before aborting if connection is not made.
463
+ */
464
+ timeout_1xx_secs?: number;
465
+
466
+ /**
467
+ * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
468
+ */
469
+ timeout_2xx_secs?: number;
470
+ }
471
+
472
+ /**
473
+ * Internal Telnyx-side settings for a UAC connection.
474
+ */
475
+ export interface InternalUacSettings {
476
+ /**
477
+ * The SIP URI that Telnyx will call when handling an inbound request from the
478
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
479
+ * `userinfo@<subdomain.>sip.telnyx.com` or
480
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
481
+ * letters, digits, hyphens, and underscores.
482
+ */
483
+ destination_uri?: string;
484
+ }
485
+
486
+ export interface Outbound {
487
+ /**
488
+ * Set a phone number as the ani_override value to override caller id number on
489
+ * outbound calls.
490
+ */
491
+ ani_override?: string;
492
+
493
+ /**
494
+ * Specifies when we apply your ani_override setting. Only applies when
495
+ * ani_override is not blank.
496
+ */
497
+ ani_override_type?: 'always' | 'normal' | 'emergency';
498
+
499
+ /**
500
+ * Forces all SIP calls originated on this connection to be "parked" instead of
501
+ * "bridged" to the destination specified on the URI. Parked calls will return
502
+ * ringback to the caller and will await for a Call Control command to define which
503
+ * action will be taken next.
504
+ */
505
+ call_parking_enabled?: boolean | null;
506
+
507
+ /**
508
+ * When set, this will limit the total number of outbound calls to phone numbers
509
+ * associated with this connection.
510
+ */
511
+ channel_limit?: number;
512
+
513
+ /**
514
+ * Generate ringback tone through 183 session progress message with early media.
515
+ */
516
+ generate_ringback_tone?: boolean;
517
+
518
+ /**
519
+ * When set, ringback will not wait for indication before sending ringback tone to
520
+ * calling party.
521
+ */
522
+ instant_ringback_enabled?: boolean;
523
+
524
+ /**
525
+ * A 2-character country code specifying the country whose national dialing rules
526
+ * should be used. For example, if set to `US` then any US number can be dialed
527
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
528
+ * dialing rules, in that order, by default.
529
+ */
530
+ localization?: string;
531
+
532
+ /**
533
+ * Identifies the associated outbound voice profile.
534
+ */
535
+ outbound_voice_profile_id?: string;
536
+
537
+ /**
538
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
539
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
540
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
541
+ * expected to send the t.38 reinvite.
542
+ */
543
+ t38_reinvite_source?:
544
+ | 'telnyx'
545
+ | 'customer'
546
+ | 'disabled'
547
+ | 'passthru'
548
+ | 'caller-passthru'
549
+ | 'callee-passthru';
550
+ }
551
+ }
552
+ }
553
+
554
+ export interface UacConnectionRetrieveResponse {
555
+ /**
556
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
557
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
558
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
559
+ * registration.
560
+ */
561
+ data?: UacConnectionRetrieveResponse.Data;
562
+ }
563
+
564
+ export namespace UacConnectionRetrieveResponse {
565
+ /**
566
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
567
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
568
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
569
+ * registration.
570
+ */
571
+ export interface Data {
572
+ /**
573
+ * Identifies the type of resource.
574
+ */
575
+ id?: string;
576
+
577
+ /**
578
+ * Defaults to true
579
+ */
580
+ active?: boolean;
581
+
582
+ /**
583
+ * `Latency` directs Telnyx to route media through the site with the lowest
584
+ * round-trip time to the user's connection. Telnyx calculates this time using ICMP
585
+ * ping messages. This can be disabled by specifying a site to handle all media.
586
+ */
587
+ anchorsite_override?: CredentialConnectionsAPI.AnchorsiteOverride;
588
+
589
+ /**
590
+ * The uuid of the push credential for Android
591
+ */
592
+ android_push_credential_id?: string | null;
593
+
594
+ /**
595
+ * The authentication strategy used by this connection.
596
+ */
597
+ authentication?: 'uac-authentication';
598
+
599
+ /**
600
+ * Specifies if call cost webhooks should be sent for this connection.
601
+ */
602
+ call_cost_in_webhooks?: boolean;
603
+
604
+ connection_name?: string;
605
+
606
+ /**
607
+ * ISO-8601 formatted date indicating when the resource was created.
608
+ */
609
+ created_at?: string;
610
+
611
+ /**
612
+ * When enabled, Telnyx will generate comfort noise when you place the call on
613
+ * hold. If disabled, you will need to generate comfort noise or on hold music to
614
+ * avoid RTP timeout.
615
+ */
616
+ default_on_hold_comfort_noise_enabled?: boolean;
617
+
618
+ /**
619
+ * Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
620
+ * digits sent to Telnyx will be accepted in all formats.
621
+ */
622
+ dtmf_type?: CredentialConnectionsAPI.DtmfType;
623
+
624
+ /**
625
+ * Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
626
+ * scenarios.
627
+ */
628
+ encode_contact_header_enabled?: boolean;
629
+
630
+ /**
631
+ * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
632
+ * TLS.
633
+ */
634
+ encrypted_media?: CredentialConnectionsAPI.EncryptedMedia | null;
635
+
636
+ /**
637
+ * External SIP peer settings used by Telnyx when registering to your PBX and
638
+ * routing outbound calls.
639
+ */
640
+ external_uac_settings?: Data.ExternalUacSettings;
641
+
642
+ /**
643
+ * The Telnyx-managed FQDN generated for the UAC connection.
644
+ */
645
+ fqdn?: string;
646
+
647
+ /**
648
+ * The fixed outbound authentication mode used by UAC FQDN records.
649
+ */
650
+ fqdn_outbound_authentication?: 'credential-authentication';
651
+
652
+ /**
653
+ * FQDN records managed automatically by the UAC connection lifecycle.
654
+ */
655
+ fqdns?: Array<FqdnsAPI.Fqdn>;
656
+
657
+ inbound?: Data.Inbound;
658
+
659
+ /**
660
+ * Internal Telnyx-side settings for a UAC connection.
661
+ */
662
+ internal_uac_settings?: Data.InternalUacSettings;
663
+
664
+ /**
665
+ * The uuid of the push credential for Ios
666
+ */
667
+ ios_push_credential_id?: string | null;
668
+
669
+ /**
670
+ * Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams
671
+ * of SIP Trunking calls. The feature is off unless enabled. You may define min and
672
+ * max values in msec for customized buffering behaviors. Larger values add latency
673
+ * but tolerate more jitter, while smaller values reduce latency but are more
674
+ * sensitive to jitter and reordering.
675
+ */
676
+ jitter_buffer?: Shared.ConnectionJitterBuffer;
677
+
678
+ /**
679
+ * Controls when noise suppression is applied to calls. When set to 'inbound',
680
+ * noise suppression is applied to incoming audio. When set to 'outbound', it's
681
+ * applied to outgoing audio. When set to 'both', it's applied in both directions.
682
+ * When set to 'disabled', noise suppression is turned off.
683
+ */
684
+ noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
685
+
686
+ /**
687
+ * Configuration options for noise suppression. These settings are stored
688
+ * regardless of the noise_suppression value, but only take effect when
689
+ * noise_suppression is not 'disabled'. If you disable noise suppression and later
690
+ * re-enable it, the previously configured settings will be used.
691
+ */
692
+ noise_suppression_details?: Shared.ConnectionNoiseSuppressionDetails;
693
+
694
+ /**
695
+ * Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
696
+ * if both are on the Telnyx network. If this is disabled, Telnyx will be able to
697
+ * use T38 on just one leg of the call depending on each leg's settings.
698
+ */
699
+ onnet_t38_passthrough_enabled?: boolean;
700
+
701
+ outbound?: Data.Outbound;
702
+
703
+ /**
704
+ * The password to be used as part of the credentials. Must be 8 to 128 characters
705
+ * long.
706
+ */
707
+ password?: string;
708
+
709
+ /**
710
+ * Identifies the type of the resource.
711
+ */
712
+ record_type?: string;
713
+
714
+ /**
715
+ * The most recently known SIP registration status for this UAC connection.
716
+ */
717
+ registration_status?: string | null;
718
+
719
+ /**
720
+ * ISO 8601 formatted date indicating when the registration status was last
721
+ * updated.
722
+ */
723
+ registration_status_updated_at?: string | null;
724
+
725
+ rtcp_settings?: CredentialConnectionsAPI.ConnectionRtcpSettings;
726
+
727
+ /**
728
+ * This feature enables inbound SIP URI calls to your Credential Auth Connection.
729
+ * If enabled for all (unrestricted) then anyone who calls the SIP URI
730
+ * <your-username>@telnyx.com will be connected to your Connection. You can also
731
+ * choose to allow only calls that are originated on any Connections under your
732
+ * account (internal).
733
+ */
734
+ sip_uri_calling_preference?: 'disabled' | 'unrestricted' | 'internal';
735
+
736
+ /**
737
+ * Tags associated with the connection.
738
+ */
739
+ tags?: Array<string>;
740
+
741
+ /**
742
+ * ISO-8601 formatted date indicating when the resource was updated.
743
+ */
744
+ updated_at?: string;
745
+
746
+ /**
747
+ * The user name to be used as part of the credentials. Must be 4-32 characters
748
+ * long and alphanumeric values only (no spaces or special characters). At least
749
+ * one of the first 5 characters must be a letter.
750
+ */
751
+ user_name?: string;
752
+
753
+ /**
754
+ * Determines which webhook format will be used, Telnyx API v1 or v2.
755
+ */
756
+ webhook_api_version?: '1' | '2';
757
+
758
+ /**
759
+ * The failover URL where webhooks related to this connection will be sent if
760
+ * sending to the primary URL fails. Must include a scheme, such as 'https'.
761
+ */
762
+ webhook_event_failover_url?: string | null;
763
+
764
+ /**
765
+ * The URL where webhooks related to this connection will be sent. Must include a
766
+ * scheme, such as 'https'.
767
+ */
768
+ webhook_event_url?: string;
769
+
770
+ /**
771
+ * Specifies how many seconds to wait before timing out a webhook.
772
+ */
773
+ webhook_timeout_secs?: number | null;
774
+ }
775
+
776
+ export namespace Data {
777
+ /**
778
+ * External SIP peer settings used by Telnyx when registering to your PBX and
779
+ * routing outbound calls.
780
+ */
781
+ export interface ExternalUacSettings {
782
+ /**
783
+ * The authentication username used in SIP digest authentication. If not set, the
784
+ * Username value will be used.
785
+ */
786
+ auth_username?: string | null;
787
+
788
+ /**
789
+ * The registration interval, in seconds, indicating how often the system refreshes
790
+ * the SIP registration with the external SIP peer.
791
+ */
792
+ expiration_sec?: number | null;
793
+
794
+ /**
795
+ * The user portion of the SIP From header used in outbound requests. This controls
796
+ * the caller identity presented to the external SIP peer.
797
+ */
798
+ from_user?: string | null;
799
+
800
+ /**
801
+ * An optional SIP proxy used to route outbound requests before reaching the
802
+ * external SIP peer.
803
+ */
804
+ outbound_proxy?: string | null;
805
+
806
+ /**
807
+ * The SIP password used for digest authentication with the external SIP peer.
808
+ */
809
+ password?: string;
810
+
811
+ /**
812
+ * The SIP proxy address of the external SIP peer used for registrations and
813
+ * outbound call routing.
814
+ */
815
+ proxy?: string;
816
+
817
+ /**
818
+ * The transport protocol used for SIP signaling when communicating with the
819
+ * external SIP peer. One of UDP, TLS, or TCP.
820
+ */
821
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
822
+
823
+ /**
824
+ * The SIP username used to authenticate with the external SIP peer for
825
+ * registrations and outbound calls. Must start with a letter or number and contain
826
+ * only letters, numbers, hyphens, and underscores.
827
+ */
828
+ username?: string;
829
+ }
830
+
831
+ export interface Inbound {
832
+ /**
833
+ * This setting allows you to set the format with which the caller's number (ANI)
834
+ * is sent for inbound phone calls.
835
+ */
836
+ ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
837
+
838
+ /**
839
+ * When set, this will limit the total number of inbound calls to phone numbers
840
+ * associated with this connection.
841
+ */
842
+ channel_limit?: number;
843
+
844
+ /**
845
+ * Defines the list of codecs that Telnyx will send for inbound calls to a specific
846
+ * number on your portal account, in priority order. This only works when the
847
+ * Connection the number is assigned to uses Media Handling mode: default. OPUS and
848
+ * H.264 codecs are available only when using TCP or TLS transport for SIP.
849
+ */
850
+ codecs?: Array<string>;
851
+
852
+ /**
853
+ * Default routing method to be used when a number is associated with the
854
+ * connection. Must be one of the routing method types or left blank, other values
855
+ * are not allowed.
856
+ */
857
+ default_routing_method?: 'sequential' | 'round-robin';
858
+
859
+ dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
860
+
861
+ /**
862
+ * Generate ringback tone through 183 session progress message with early media.
863
+ */
864
+ generate_ringback_tone?: boolean;
865
+
866
+ /**
867
+ * When set, inbound phone calls will receive ISUP parameters via SIP headers.
868
+ * (Only when available and only when using TCP or TLS transport.)
869
+ */
870
+ isup_headers_enabled?: boolean;
871
+
872
+ /**
873
+ * Enable PRACK messages as defined in RFC3262.
874
+ */
875
+ prack_enabled?: boolean;
876
+
877
+ /**
878
+ * When enabled the SIP Connection will receive the Identity header with
879
+ * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
880
+ * transport.
881
+ */
882
+ shaken_stir_enabled?: boolean;
883
+
884
+ /**
885
+ * When enabled, allows multiple devices to ring simultaneously on incoming calls.
886
+ */
887
+ simultaneous_ringing?: 'disabled' | 'enabled';
888
+
889
+ /**
890
+ * Defaults to true.
891
+ */
892
+ sip_compact_headers_enabled?: boolean;
893
+
894
+ /**
895
+ * The Telnyx-generated SIP subdomain for this UAC connection.
896
+ */
897
+ sip_subdomain?: string;
898
+
899
+ /**
900
+ * Controls which SIP URI callers may reach this connection.
901
+ */
902
+ sip_subdomain_receive_settings?: 'only_my_connections' | 'from_anyone';
903
+
904
+ /**
905
+ * Time(sec) before aborting if connection is not made.
906
+ */
907
+ timeout_1xx_secs?: number;
908
+
909
+ /**
910
+ * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
911
+ */
912
+ timeout_2xx_secs?: number;
913
+ }
914
+
915
+ /**
916
+ * Internal Telnyx-side settings for a UAC connection.
917
+ */
918
+ export interface InternalUacSettings {
919
+ /**
920
+ * The SIP URI that Telnyx will call when handling an inbound request from the
921
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
922
+ * `userinfo@<subdomain.>sip.telnyx.com` or
923
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
924
+ * letters, digits, hyphens, and underscores.
925
+ */
926
+ destination_uri?: string;
927
+ }
928
+
929
+ export interface Outbound {
930
+ /**
931
+ * Set a phone number as the ani_override value to override caller id number on
932
+ * outbound calls.
933
+ */
934
+ ani_override?: string;
935
+
936
+ /**
937
+ * Specifies when we apply your ani_override setting. Only applies when
938
+ * ani_override is not blank.
939
+ */
940
+ ani_override_type?: 'always' | 'normal' | 'emergency';
941
+
942
+ /**
943
+ * Forces all SIP calls originated on this connection to be "parked" instead of
944
+ * "bridged" to the destination specified on the URI. Parked calls will return
945
+ * ringback to the caller and will await for a Call Control command to define which
946
+ * action will be taken next.
947
+ */
948
+ call_parking_enabled?: boolean | null;
949
+
950
+ /**
951
+ * When set, this will limit the total number of outbound calls to phone numbers
952
+ * associated with this connection.
953
+ */
954
+ channel_limit?: number;
955
+
956
+ /**
957
+ * Generate ringback tone through 183 session progress message with early media.
958
+ */
959
+ generate_ringback_tone?: boolean;
960
+
961
+ /**
962
+ * When set, ringback will not wait for indication before sending ringback tone to
963
+ * calling party.
964
+ */
965
+ instant_ringback_enabled?: boolean;
966
+
967
+ /**
968
+ * A 2-character country code specifying the country whose national dialing rules
969
+ * should be used. For example, if set to `US` then any US number can be dialed
970
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
971
+ * dialing rules, in that order, by default.
972
+ */
973
+ localization?: string;
974
+
975
+ /**
976
+ * Identifies the associated outbound voice profile.
977
+ */
978
+ outbound_voice_profile_id?: string;
979
+
980
+ /**
981
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
982
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
983
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
984
+ * expected to send the t.38 reinvite.
985
+ */
986
+ t38_reinvite_source?:
987
+ | 'telnyx'
988
+ | 'customer'
989
+ | 'disabled'
990
+ | 'passthru'
991
+ | 'caller-passthru'
992
+ | 'callee-passthru';
993
+ }
994
+ }
995
+ }
996
+
997
+ export interface UacConnectionUpdateResponse {
998
+ /**
999
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
1000
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
1001
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
1002
+ * registration.
1003
+ */
1004
+ data?: UacConnectionUpdateResponse.Data;
1005
+ }
1006
+
1007
+ export namespace UacConnectionUpdateResponse {
1008
+ /**
1009
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
1010
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
1011
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
1012
+ * registration.
1013
+ */
1014
+ export interface Data {
1015
+ /**
1016
+ * Identifies the type of resource.
1017
+ */
1018
+ id?: string;
1019
+
1020
+ /**
1021
+ * Defaults to true
1022
+ */
1023
+ active?: boolean;
1024
+
1025
+ /**
1026
+ * `Latency` directs Telnyx to route media through the site with the lowest
1027
+ * round-trip time to the user's connection. Telnyx calculates this time using ICMP
1028
+ * ping messages. This can be disabled by specifying a site to handle all media.
1029
+ */
1030
+ anchorsite_override?: CredentialConnectionsAPI.AnchorsiteOverride;
1031
+
1032
+ /**
1033
+ * The uuid of the push credential for Android
1034
+ */
1035
+ android_push_credential_id?: string | null;
1036
+
1037
+ /**
1038
+ * The authentication strategy used by this connection.
1039
+ */
1040
+ authentication?: 'uac-authentication';
1041
+
1042
+ /**
1043
+ * Specifies if call cost webhooks should be sent for this connection.
1044
+ */
1045
+ call_cost_in_webhooks?: boolean;
1046
+
1047
+ connection_name?: string;
1048
+
1049
+ /**
1050
+ * ISO-8601 formatted date indicating when the resource was created.
1051
+ */
1052
+ created_at?: string;
1053
+
1054
+ /**
1055
+ * When enabled, Telnyx will generate comfort noise when you place the call on
1056
+ * hold. If disabled, you will need to generate comfort noise or on hold music to
1057
+ * avoid RTP timeout.
1058
+ */
1059
+ default_on_hold_comfort_noise_enabled?: boolean;
1060
+
1061
+ /**
1062
+ * Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
1063
+ * digits sent to Telnyx will be accepted in all formats.
1064
+ */
1065
+ dtmf_type?: CredentialConnectionsAPI.DtmfType;
1066
+
1067
+ /**
1068
+ * Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
1069
+ * scenarios.
1070
+ */
1071
+ encode_contact_header_enabled?: boolean;
1072
+
1073
+ /**
1074
+ * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
1075
+ * TLS.
1076
+ */
1077
+ encrypted_media?: CredentialConnectionsAPI.EncryptedMedia | null;
1078
+
1079
+ /**
1080
+ * External SIP peer settings used by Telnyx when registering to your PBX and
1081
+ * routing outbound calls.
1082
+ */
1083
+ external_uac_settings?: Data.ExternalUacSettings;
1084
+
1085
+ /**
1086
+ * The Telnyx-managed FQDN generated for the UAC connection.
1087
+ */
1088
+ fqdn?: string;
1089
+
1090
+ /**
1091
+ * The fixed outbound authentication mode used by UAC FQDN records.
1092
+ */
1093
+ fqdn_outbound_authentication?: 'credential-authentication';
1094
+
1095
+ /**
1096
+ * FQDN records managed automatically by the UAC connection lifecycle.
1097
+ */
1098
+ fqdns?: Array<FqdnsAPI.Fqdn>;
1099
+
1100
+ inbound?: Data.Inbound;
1101
+
1102
+ /**
1103
+ * Internal Telnyx-side settings for a UAC connection.
1104
+ */
1105
+ internal_uac_settings?: Data.InternalUacSettings;
1106
+
1107
+ /**
1108
+ * The uuid of the push credential for Ios
1109
+ */
1110
+ ios_push_credential_id?: string | null;
1111
+
1112
+ /**
1113
+ * Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams
1114
+ * of SIP Trunking calls. The feature is off unless enabled. You may define min and
1115
+ * max values in msec for customized buffering behaviors. Larger values add latency
1116
+ * but tolerate more jitter, while smaller values reduce latency but are more
1117
+ * sensitive to jitter and reordering.
1118
+ */
1119
+ jitter_buffer?: Shared.ConnectionJitterBuffer;
1120
+
1121
+ /**
1122
+ * Controls when noise suppression is applied to calls. When set to 'inbound',
1123
+ * noise suppression is applied to incoming audio. When set to 'outbound', it's
1124
+ * applied to outgoing audio. When set to 'both', it's applied in both directions.
1125
+ * When set to 'disabled', noise suppression is turned off.
1126
+ */
1127
+ noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
1128
+
1129
+ /**
1130
+ * Configuration options for noise suppression. These settings are stored
1131
+ * regardless of the noise_suppression value, but only take effect when
1132
+ * noise_suppression is not 'disabled'. If you disable noise suppression and later
1133
+ * re-enable it, the previously configured settings will be used.
1134
+ */
1135
+ noise_suppression_details?: Shared.ConnectionNoiseSuppressionDetails;
1136
+
1137
+ /**
1138
+ * Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
1139
+ * if both are on the Telnyx network. If this is disabled, Telnyx will be able to
1140
+ * use T38 on just one leg of the call depending on each leg's settings.
1141
+ */
1142
+ onnet_t38_passthrough_enabled?: boolean;
1143
+
1144
+ outbound?: Data.Outbound;
1145
+
1146
+ /**
1147
+ * The password to be used as part of the credentials. Must be 8 to 128 characters
1148
+ * long.
1149
+ */
1150
+ password?: string;
1151
+
1152
+ /**
1153
+ * Identifies the type of the resource.
1154
+ */
1155
+ record_type?: string;
1156
+
1157
+ /**
1158
+ * The most recently known SIP registration status for this UAC connection.
1159
+ */
1160
+ registration_status?: string | null;
1161
+
1162
+ /**
1163
+ * ISO 8601 formatted date indicating when the registration status was last
1164
+ * updated.
1165
+ */
1166
+ registration_status_updated_at?: string | null;
1167
+
1168
+ rtcp_settings?: CredentialConnectionsAPI.ConnectionRtcpSettings;
1169
+
1170
+ /**
1171
+ * This feature enables inbound SIP URI calls to your Credential Auth Connection.
1172
+ * If enabled for all (unrestricted) then anyone who calls the SIP URI
1173
+ * <your-username>@telnyx.com will be connected to your Connection. You can also
1174
+ * choose to allow only calls that are originated on any Connections under your
1175
+ * account (internal).
1176
+ */
1177
+ sip_uri_calling_preference?: 'disabled' | 'unrestricted' | 'internal';
1178
+
1179
+ /**
1180
+ * Tags associated with the connection.
1181
+ */
1182
+ tags?: Array<string>;
1183
+
1184
+ /**
1185
+ * ISO-8601 formatted date indicating when the resource was updated.
1186
+ */
1187
+ updated_at?: string;
1188
+
1189
+ /**
1190
+ * The user name to be used as part of the credentials. Must be 4-32 characters
1191
+ * long and alphanumeric values only (no spaces or special characters). At least
1192
+ * one of the first 5 characters must be a letter.
1193
+ */
1194
+ user_name?: string;
1195
+
1196
+ /**
1197
+ * Determines which webhook format will be used, Telnyx API v1 or v2.
1198
+ */
1199
+ webhook_api_version?: '1' | '2';
1200
+
1201
+ /**
1202
+ * The failover URL where webhooks related to this connection will be sent if
1203
+ * sending to the primary URL fails. Must include a scheme, such as 'https'.
1204
+ */
1205
+ webhook_event_failover_url?: string | null;
1206
+
1207
+ /**
1208
+ * The URL where webhooks related to this connection will be sent. Must include a
1209
+ * scheme, such as 'https'.
1210
+ */
1211
+ webhook_event_url?: string;
1212
+
1213
+ /**
1214
+ * Specifies how many seconds to wait before timing out a webhook.
1215
+ */
1216
+ webhook_timeout_secs?: number | null;
1217
+ }
1218
+
1219
+ export namespace Data {
1220
+ /**
1221
+ * External SIP peer settings used by Telnyx when registering to your PBX and
1222
+ * routing outbound calls.
1223
+ */
1224
+ export interface ExternalUacSettings {
1225
+ /**
1226
+ * The authentication username used in SIP digest authentication. If not set, the
1227
+ * Username value will be used.
1228
+ */
1229
+ auth_username?: string | null;
1230
+
1231
+ /**
1232
+ * The registration interval, in seconds, indicating how often the system refreshes
1233
+ * the SIP registration with the external SIP peer.
1234
+ */
1235
+ expiration_sec?: number | null;
1236
+
1237
+ /**
1238
+ * The user portion of the SIP From header used in outbound requests. This controls
1239
+ * the caller identity presented to the external SIP peer.
1240
+ */
1241
+ from_user?: string | null;
1242
+
1243
+ /**
1244
+ * An optional SIP proxy used to route outbound requests before reaching the
1245
+ * external SIP peer.
1246
+ */
1247
+ outbound_proxy?: string | null;
1248
+
1249
+ /**
1250
+ * The SIP password used for digest authentication with the external SIP peer.
1251
+ */
1252
+ password?: string;
1253
+
1254
+ /**
1255
+ * The SIP proxy address of the external SIP peer used for registrations and
1256
+ * outbound call routing.
1257
+ */
1258
+ proxy?: string;
1259
+
1260
+ /**
1261
+ * The transport protocol used for SIP signaling when communicating with the
1262
+ * external SIP peer. One of UDP, TLS, or TCP.
1263
+ */
1264
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
1265
+
1266
+ /**
1267
+ * The SIP username used to authenticate with the external SIP peer for
1268
+ * registrations and outbound calls. Must start with a letter or number and contain
1269
+ * only letters, numbers, hyphens, and underscores.
1270
+ */
1271
+ username?: string;
1272
+ }
1273
+
1274
+ export interface Inbound {
1275
+ /**
1276
+ * This setting allows you to set the format with which the caller's number (ANI)
1277
+ * is sent for inbound phone calls.
1278
+ */
1279
+ ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
1280
+
1281
+ /**
1282
+ * When set, this will limit the total number of inbound calls to phone numbers
1283
+ * associated with this connection.
1284
+ */
1285
+ channel_limit?: number;
1286
+
1287
+ /**
1288
+ * Defines the list of codecs that Telnyx will send for inbound calls to a specific
1289
+ * number on your portal account, in priority order. This only works when the
1290
+ * Connection the number is assigned to uses Media Handling mode: default. OPUS and
1291
+ * H.264 codecs are available only when using TCP or TLS transport for SIP.
1292
+ */
1293
+ codecs?: Array<string>;
1294
+
1295
+ /**
1296
+ * Default routing method to be used when a number is associated with the
1297
+ * connection. Must be one of the routing method types or left blank, other values
1298
+ * are not allowed.
1299
+ */
1300
+ default_routing_method?: 'sequential' | 'round-robin';
1301
+
1302
+ dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
1303
+
1304
+ /**
1305
+ * Generate ringback tone through 183 session progress message with early media.
1306
+ */
1307
+ generate_ringback_tone?: boolean;
1308
+
1309
+ /**
1310
+ * When set, inbound phone calls will receive ISUP parameters via SIP headers.
1311
+ * (Only when available and only when using TCP or TLS transport.)
1312
+ */
1313
+ isup_headers_enabled?: boolean;
1314
+
1315
+ /**
1316
+ * Enable PRACK messages as defined in RFC3262.
1317
+ */
1318
+ prack_enabled?: boolean;
1319
+
1320
+ /**
1321
+ * When enabled the SIP Connection will receive the Identity header with
1322
+ * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
1323
+ * transport.
1324
+ */
1325
+ shaken_stir_enabled?: boolean;
1326
+
1327
+ /**
1328
+ * When enabled, allows multiple devices to ring simultaneously on incoming calls.
1329
+ */
1330
+ simultaneous_ringing?: 'disabled' | 'enabled';
1331
+
1332
+ /**
1333
+ * Defaults to true.
1334
+ */
1335
+ sip_compact_headers_enabled?: boolean;
1336
+
1337
+ /**
1338
+ * The Telnyx-generated SIP subdomain for this UAC connection.
1339
+ */
1340
+ sip_subdomain?: string;
1341
+
1342
+ /**
1343
+ * Controls which SIP URI callers may reach this connection.
1344
+ */
1345
+ sip_subdomain_receive_settings?: 'only_my_connections' | 'from_anyone';
1346
+
1347
+ /**
1348
+ * Time(sec) before aborting if connection is not made.
1349
+ */
1350
+ timeout_1xx_secs?: number;
1351
+
1352
+ /**
1353
+ * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
1354
+ */
1355
+ timeout_2xx_secs?: number;
1356
+ }
1357
+
1358
+ /**
1359
+ * Internal Telnyx-side settings for a UAC connection.
1360
+ */
1361
+ export interface InternalUacSettings {
1362
+ /**
1363
+ * The SIP URI that Telnyx will call when handling an inbound request from the
1364
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
1365
+ * `userinfo@<subdomain.>sip.telnyx.com` or
1366
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
1367
+ * letters, digits, hyphens, and underscores.
1368
+ */
1369
+ destination_uri?: string;
1370
+ }
1371
+
1372
+ export interface Outbound {
1373
+ /**
1374
+ * Set a phone number as the ani_override value to override caller id number on
1375
+ * outbound calls.
1376
+ */
1377
+ ani_override?: string;
1378
+
1379
+ /**
1380
+ * Specifies when we apply your ani_override setting. Only applies when
1381
+ * ani_override is not blank.
1382
+ */
1383
+ ani_override_type?: 'always' | 'normal' | 'emergency';
1384
+
1385
+ /**
1386
+ * Forces all SIP calls originated on this connection to be "parked" instead of
1387
+ * "bridged" to the destination specified on the URI. Parked calls will return
1388
+ * ringback to the caller and will await for a Call Control command to define which
1389
+ * action will be taken next.
1390
+ */
1391
+ call_parking_enabled?: boolean | null;
1392
+
1393
+ /**
1394
+ * When set, this will limit the total number of outbound calls to phone numbers
1395
+ * associated with this connection.
1396
+ */
1397
+ channel_limit?: number;
1398
+
1399
+ /**
1400
+ * Generate ringback tone through 183 session progress message with early media.
1401
+ */
1402
+ generate_ringback_tone?: boolean;
1403
+
1404
+ /**
1405
+ * When set, ringback will not wait for indication before sending ringback tone to
1406
+ * calling party.
1407
+ */
1408
+ instant_ringback_enabled?: boolean;
1409
+
1410
+ /**
1411
+ * A 2-character country code specifying the country whose national dialing rules
1412
+ * should be used. For example, if set to `US` then any US number can be dialed
1413
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
1414
+ * dialing rules, in that order, by default.
1415
+ */
1416
+ localization?: string;
1417
+
1418
+ /**
1419
+ * Identifies the associated outbound voice profile.
1420
+ */
1421
+ outbound_voice_profile_id?: string;
1422
+
1423
+ /**
1424
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
1425
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
1426
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
1427
+ * expected to send the t.38 reinvite.
1428
+ */
1429
+ t38_reinvite_source?:
1430
+ | 'telnyx'
1431
+ | 'customer'
1432
+ | 'disabled'
1433
+ | 'passthru'
1434
+ | 'caller-passthru'
1435
+ | 'callee-passthru';
1436
+ }
1437
+ }
1438
+ }
109
1439
 
110
1440
  /**
111
1441
  * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
@@ -113,467 +1443,872 @@ export type UacConnectionsDefaultFlatPagination = DefaultFlatPagination<UacConne
113
1443
  * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
114
1444
  * registration.
115
1445
  */
116
- export interface UacConnection {
1446
+ export interface UacConnectionListResponse {
1447
+ /**
1448
+ * Identifies the type of resource.
1449
+ */
1450
+ id?: string;
1451
+
1452
+ /**
1453
+ * Defaults to true
1454
+ */
1455
+ active?: boolean;
1456
+
1457
+ /**
1458
+ * `Latency` directs Telnyx to route media through the site with the lowest
1459
+ * round-trip time to the user's connection. Telnyx calculates this time using ICMP
1460
+ * ping messages. This can be disabled by specifying a site to handle all media.
1461
+ */
1462
+ anchorsite_override?: CredentialConnectionsAPI.AnchorsiteOverride;
1463
+
1464
+ /**
1465
+ * The uuid of the push credential for Android
1466
+ */
1467
+ android_push_credential_id?: string | null;
1468
+
1469
+ /**
1470
+ * The authentication strategy used by this connection.
1471
+ */
1472
+ authentication?: 'uac-authentication';
1473
+
1474
+ /**
1475
+ * Specifies if call cost webhooks should be sent for this connection.
1476
+ */
1477
+ call_cost_in_webhooks?: boolean;
1478
+
1479
+ connection_name?: string;
1480
+
1481
+ /**
1482
+ * ISO-8601 formatted date indicating when the resource was created.
1483
+ */
1484
+ created_at?: string;
1485
+
1486
+ /**
1487
+ * When enabled, Telnyx will generate comfort noise when you place the call on
1488
+ * hold. If disabled, you will need to generate comfort noise or on hold music to
1489
+ * avoid RTP timeout.
1490
+ */
1491
+ default_on_hold_comfort_noise_enabled?: boolean;
1492
+
1493
+ /**
1494
+ * Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
1495
+ * digits sent to Telnyx will be accepted in all formats.
1496
+ */
1497
+ dtmf_type?: CredentialConnectionsAPI.DtmfType;
1498
+
1499
+ /**
1500
+ * Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
1501
+ * scenarios.
1502
+ */
1503
+ encode_contact_header_enabled?: boolean;
1504
+
1505
+ /**
1506
+ * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
1507
+ * TLS.
1508
+ */
1509
+ encrypted_media?: CredentialConnectionsAPI.EncryptedMedia | null;
1510
+
1511
+ /**
1512
+ * External SIP peer settings used by Telnyx when registering to your PBX and
1513
+ * routing outbound calls.
1514
+ */
1515
+ external_uac_settings?: UacConnectionListResponse.ExternalUacSettings;
1516
+
1517
+ /**
1518
+ * The Telnyx-managed FQDN generated for the UAC connection.
1519
+ */
1520
+ fqdn?: string;
1521
+
1522
+ /**
1523
+ * The fixed outbound authentication mode used by UAC FQDN records.
1524
+ */
1525
+ fqdn_outbound_authentication?: 'credential-authentication';
1526
+
1527
+ /**
1528
+ * FQDN records managed automatically by the UAC connection lifecycle.
1529
+ */
1530
+ fqdns?: Array<FqdnsAPI.Fqdn>;
1531
+
1532
+ inbound?: UacConnectionListResponse.Inbound;
1533
+
1534
+ /**
1535
+ * Internal Telnyx-side settings for a UAC connection.
1536
+ */
1537
+ internal_uac_settings?: UacConnectionListResponse.InternalUacSettings;
1538
+
1539
+ /**
1540
+ * The uuid of the push credential for Ios
1541
+ */
1542
+ ios_push_credential_id?: string | null;
1543
+
117
1544
  /**
118
- * Identifies the type of resource.
1545
+ * Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams
1546
+ * of SIP Trunking calls. The feature is off unless enabled. You may define min and
1547
+ * max values in msec for customized buffering behaviors. Larger values add latency
1548
+ * but tolerate more jitter, while smaller values reduce latency but are more
1549
+ * sensitive to jitter and reordering.
119
1550
  */
120
- id?: string;
1551
+ jitter_buffer?: Shared.ConnectionJitterBuffer;
121
1552
 
122
1553
  /**
123
- * Defaults to true
1554
+ * Controls when noise suppression is applied to calls. When set to 'inbound',
1555
+ * noise suppression is applied to incoming audio. When set to 'outbound', it's
1556
+ * applied to outgoing audio. When set to 'both', it's applied in both directions.
1557
+ * When set to 'disabled', noise suppression is turned off.
124
1558
  */
125
- active?: boolean;
1559
+ noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
126
1560
 
127
1561
  /**
128
- * `Latency` directs Telnyx to route media through the site with the lowest
129
- * round-trip time to the user's connection. Telnyx calculates this time using ICMP
130
- * ping messages. This can be disabled by specifying a site to handle all media.
1562
+ * Configuration options for noise suppression. These settings are stored
1563
+ * regardless of the noise_suppression value, but only take effect when
1564
+ * noise_suppression is not 'disabled'. If you disable noise suppression and later
1565
+ * re-enable it, the previously configured settings will be used.
131
1566
  */
132
- anchorsite_override?: CredentialConnectionsAPI.AnchorsiteOverride;
1567
+ noise_suppression_details?: Shared.ConnectionNoiseSuppressionDetails;
133
1568
 
134
1569
  /**
135
- * The uuid of the push credential for Android
1570
+ * Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
1571
+ * if both are on the Telnyx network. If this is disabled, Telnyx will be able to
1572
+ * use T38 on just one leg of the call depending on each leg's settings.
136
1573
  */
137
- android_push_credential_id?: string | null;
1574
+ onnet_t38_passthrough_enabled?: boolean;
1575
+
1576
+ outbound?: UacConnectionListResponse.Outbound;
138
1577
 
139
1578
  /**
140
- * The authentication strategy used by this connection.
1579
+ * The password to be used as part of the credentials. Must be 8 to 128 characters
1580
+ * long.
141
1581
  */
142
- authentication?: 'uac-authentication';
1582
+ password?: string;
143
1583
 
144
1584
  /**
145
- * Specifies if call cost webhooks should be sent for this connection.
1585
+ * Identifies the type of the resource.
146
1586
  */
147
- call_cost_in_webhooks?: boolean;
1587
+ record_type?: string;
148
1588
 
149
- connection_name?: string;
1589
+ /**
1590
+ * The most recently known SIP registration status for this UAC connection.
1591
+ */
1592
+ registration_status?: string | null;
150
1593
 
151
1594
  /**
152
- * ISO-8601 formatted date indicating when the resource was created.
1595
+ * ISO 8601 formatted date indicating when the registration status was last
1596
+ * updated.
153
1597
  */
154
- created_at?: string;
1598
+ registration_status_updated_at?: string | null;
1599
+
1600
+ rtcp_settings?: CredentialConnectionsAPI.ConnectionRtcpSettings;
155
1601
 
156
1602
  /**
157
- * When enabled, Telnyx will generate comfort noise when you place the call on
158
- * hold. If disabled, you will need to generate comfort noise or on hold music to
159
- * avoid RTP timeout.
1603
+ * This feature enables inbound SIP URI calls to your Credential Auth Connection.
1604
+ * If enabled for all (unrestricted) then anyone who calls the SIP URI
1605
+ * <your-username>@telnyx.com will be connected to your Connection. You can also
1606
+ * choose to allow only calls that are originated on any Connections under your
1607
+ * account (internal).
160
1608
  */
161
- default_on_hold_comfort_noise_enabled?: boolean;
1609
+ sip_uri_calling_preference?: 'disabled' | 'unrestricted' | 'internal';
162
1610
 
163
1611
  /**
164
- * Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
165
- * digits sent to Telnyx will be accepted in all formats.
1612
+ * Tags associated with the connection.
166
1613
  */
167
- dtmf_type?: CredentialConnectionsAPI.DtmfType;
1614
+ tags?: Array<string>;
168
1615
 
169
1616
  /**
170
- * Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
171
- * scenarios.
1617
+ * ISO-8601 formatted date indicating when the resource was updated.
172
1618
  */
173
- encode_contact_header_enabled?: boolean;
1619
+ updated_at?: string;
174
1620
 
175
1621
  /**
176
- * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
177
- * TLS.
1622
+ * The user name to be used as part of the credentials. Must be 4-32 characters
1623
+ * long and alphanumeric values only (no spaces or special characters). At least
1624
+ * one of the first 5 characters must be a letter.
178
1625
  */
179
- encrypted_media?: CredentialConnectionsAPI.EncryptedMedia | null;
1626
+ user_name?: string;
1627
+
1628
+ /**
1629
+ * Determines which webhook format will be used, Telnyx API v1 or v2.
1630
+ */
1631
+ webhook_api_version?: '1' | '2';
1632
+
1633
+ /**
1634
+ * The failover URL where webhooks related to this connection will be sent if
1635
+ * sending to the primary URL fails. Must include a scheme, such as 'https'.
1636
+ */
1637
+ webhook_event_failover_url?: string | null;
1638
+
1639
+ /**
1640
+ * The URL where webhooks related to this connection will be sent. Must include a
1641
+ * scheme, such as 'https'.
1642
+ */
1643
+ webhook_event_url?: string;
1644
+
1645
+ /**
1646
+ * Specifies how many seconds to wait before timing out a webhook.
1647
+ */
1648
+ webhook_timeout_secs?: number | null;
1649
+ }
1650
+
1651
+ export namespace UacConnectionListResponse {
1652
+ /**
1653
+ * External SIP peer settings used by Telnyx when registering to your PBX and
1654
+ * routing outbound calls.
1655
+ */
1656
+ export interface ExternalUacSettings {
1657
+ /**
1658
+ * The authentication username used in SIP digest authentication. If not set, the
1659
+ * Username value will be used.
1660
+ */
1661
+ auth_username?: string | null;
1662
+
1663
+ /**
1664
+ * The registration interval, in seconds, indicating how often the system refreshes
1665
+ * the SIP registration with the external SIP peer.
1666
+ */
1667
+ expiration_sec?: number | null;
1668
+
1669
+ /**
1670
+ * The user portion of the SIP From header used in outbound requests. This controls
1671
+ * the caller identity presented to the external SIP peer.
1672
+ */
1673
+ from_user?: string | null;
1674
+
1675
+ /**
1676
+ * An optional SIP proxy used to route outbound requests before reaching the
1677
+ * external SIP peer.
1678
+ */
1679
+ outbound_proxy?: string | null;
1680
+
1681
+ /**
1682
+ * The SIP password used for digest authentication with the external SIP peer.
1683
+ */
1684
+ password?: string;
1685
+
1686
+ /**
1687
+ * The SIP proxy address of the external SIP peer used for registrations and
1688
+ * outbound call routing.
1689
+ */
1690
+ proxy?: string;
1691
+
1692
+ /**
1693
+ * The transport protocol used for SIP signaling when communicating with the
1694
+ * external SIP peer. One of UDP, TLS, or TCP.
1695
+ */
1696
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
1697
+
1698
+ /**
1699
+ * The SIP username used to authenticate with the external SIP peer for
1700
+ * registrations and outbound calls. Must start with a letter or number and contain
1701
+ * only letters, numbers, hyphens, and underscores.
1702
+ */
1703
+ username?: string;
1704
+ }
1705
+
1706
+ export interface Inbound {
1707
+ /**
1708
+ * This setting allows you to set the format with which the caller's number (ANI)
1709
+ * is sent for inbound phone calls.
1710
+ */
1711
+ ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
1712
+
1713
+ /**
1714
+ * When set, this will limit the total number of inbound calls to phone numbers
1715
+ * associated with this connection.
1716
+ */
1717
+ channel_limit?: number;
1718
+
1719
+ /**
1720
+ * Defines the list of codecs that Telnyx will send for inbound calls to a specific
1721
+ * number on your portal account, in priority order. This only works when the
1722
+ * Connection the number is assigned to uses Media Handling mode: default. OPUS and
1723
+ * H.264 codecs are available only when using TCP or TLS transport for SIP.
1724
+ */
1725
+ codecs?: Array<string>;
1726
+
1727
+ /**
1728
+ * Default routing method to be used when a number is associated with the
1729
+ * connection. Must be one of the routing method types or left blank, other values
1730
+ * are not allowed.
1731
+ */
1732
+ default_routing_method?: 'sequential' | 'round-robin';
1733
+
1734
+ dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
1735
+
1736
+ /**
1737
+ * Generate ringback tone through 183 session progress message with early media.
1738
+ */
1739
+ generate_ringback_tone?: boolean;
1740
+
1741
+ /**
1742
+ * When set, inbound phone calls will receive ISUP parameters via SIP headers.
1743
+ * (Only when available and only when using TCP or TLS transport.)
1744
+ */
1745
+ isup_headers_enabled?: boolean;
1746
+
1747
+ /**
1748
+ * Enable PRACK messages as defined in RFC3262.
1749
+ */
1750
+ prack_enabled?: boolean;
1751
+
1752
+ /**
1753
+ * When enabled the SIP Connection will receive the Identity header with
1754
+ * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
1755
+ * transport.
1756
+ */
1757
+ shaken_stir_enabled?: boolean;
1758
+
1759
+ /**
1760
+ * When enabled, allows multiple devices to ring simultaneously on incoming calls.
1761
+ */
1762
+ simultaneous_ringing?: 'disabled' | 'enabled';
1763
+
1764
+ /**
1765
+ * Defaults to true.
1766
+ */
1767
+ sip_compact_headers_enabled?: boolean;
1768
+
1769
+ /**
1770
+ * The Telnyx-generated SIP subdomain for this UAC connection.
1771
+ */
1772
+ sip_subdomain?: string;
1773
+
1774
+ /**
1775
+ * Controls which SIP URI callers may reach this connection.
1776
+ */
1777
+ sip_subdomain_receive_settings?: 'only_my_connections' | 'from_anyone';
1778
+
1779
+ /**
1780
+ * Time(sec) before aborting if connection is not made.
1781
+ */
1782
+ timeout_1xx_secs?: number;
1783
+
1784
+ /**
1785
+ * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
1786
+ */
1787
+ timeout_2xx_secs?: number;
1788
+ }
1789
+
1790
+ /**
1791
+ * Internal Telnyx-side settings for a UAC connection.
1792
+ */
1793
+ export interface InternalUacSettings {
1794
+ /**
1795
+ * The SIP URI that Telnyx will call when handling an inbound request from the
1796
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
1797
+ * `userinfo@<subdomain.>sip.telnyx.com` or
1798
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
1799
+ * letters, digits, hyphens, and underscores.
1800
+ */
1801
+ destination_uri?: string;
1802
+ }
1803
+
1804
+ export interface Outbound {
1805
+ /**
1806
+ * Set a phone number as the ani_override value to override caller id number on
1807
+ * outbound calls.
1808
+ */
1809
+ ani_override?: string;
1810
+
1811
+ /**
1812
+ * Specifies when we apply your ani_override setting. Only applies when
1813
+ * ani_override is not blank.
1814
+ */
1815
+ ani_override_type?: 'always' | 'normal' | 'emergency';
1816
+
1817
+ /**
1818
+ * Forces all SIP calls originated on this connection to be "parked" instead of
1819
+ * "bridged" to the destination specified on the URI. Parked calls will return
1820
+ * ringback to the caller and will await for a Call Control command to define which
1821
+ * action will be taken next.
1822
+ */
1823
+ call_parking_enabled?: boolean | null;
1824
+
1825
+ /**
1826
+ * When set, this will limit the total number of outbound calls to phone numbers
1827
+ * associated with this connection.
1828
+ */
1829
+ channel_limit?: number;
1830
+
1831
+ /**
1832
+ * Generate ringback tone through 183 session progress message with early media.
1833
+ */
1834
+ generate_ringback_tone?: boolean;
1835
+
1836
+ /**
1837
+ * When set, ringback will not wait for indication before sending ringback tone to
1838
+ * calling party.
1839
+ */
1840
+ instant_ringback_enabled?: boolean;
1841
+
1842
+ /**
1843
+ * A 2-character country code specifying the country whose national dialing rules
1844
+ * should be used. For example, if set to `US` then any US number can be dialed
1845
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
1846
+ * dialing rules, in that order, by default.
1847
+ */
1848
+ localization?: string;
1849
+
1850
+ /**
1851
+ * Identifies the associated outbound voice profile.
1852
+ */
1853
+ outbound_voice_profile_id?: string;
1854
+
1855
+ /**
1856
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
1857
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
1858
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
1859
+ * expected to send the t.38 reinvite.
1860
+ */
1861
+ t38_reinvite_source?:
1862
+ | 'telnyx'
1863
+ | 'customer'
1864
+ | 'disabled'
1865
+ | 'passthru'
1866
+ | 'caller-passthru'
1867
+ | 'callee-passthru';
1868
+ }
1869
+ }
180
1870
 
1871
+ export interface UacConnectionDeleteResponse {
181
1872
  /**
182
- * External SIP peer settings used by Telnyx when registering to your PBX and
183
- * routing outbound calls.
1873
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
1874
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
1875
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
1876
+ * registration.
184
1877
  */
185
- external_uac_settings?: UacExternalSettings;
1878
+ data?: UacConnectionDeleteResponse.Data;
1879
+ }
186
1880
 
1881
+ export namespace UacConnectionDeleteResponse {
187
1882
  /**
188
- * The Telnyx-managed FQDN generated for the UAC connection.
1883
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX the opposite
1884
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
1885
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
1886
+ * registration.
189
1887
  */
190
- fqdn?: string;
1888
+ export interface Data {
1889
+ /**
1890
+ * Identifies the type of resource.
1891
+ */
1892
+ id?: string;
191
1893
 
192
- /**
193
- * The fixed outbound authentication mode used by UAC FQDN records.
194
- */
195
- fqdn_outbound_authentication?: 'credential-authentication';
1894
+ /**
1895
+ * Defaults to true
1896
+ */
1897
+ active?: boolean;
196
1898
 
197
- /**
198
- * FQDN records managed automatically by the UAC connection lifecycle.
199
- */
200
- fqdns?: Array<FqdnsAPI.Fqdn>;
1899
+ /**
1900
+ * `Latency` directs Telnyx to route media through the site with the lowest
1901
+ * round-trip time to the user's connection. Telnyx calculates this time using ICMP
1902
+ * ping messages. This can be disabled by specifying a site to handle all media.
1903
+ */
1904
+ anchorsite_override?: CredentialConnectionsAPI.AnchorsiteOverride;
201
1905
 
202
- inbound?: UacInbound;
1906
+ /**
1907
+ * The uuid of the push credential for Android
1908
+ */
1909
+ android_push_credential_id?: string | null;
203
1910
 
204
- /**
205
- * Internal Telnyx-side settings for a UAC connection.
206
- */
207
- internal_uac_settings?: UacInternalSettings;
1911
+ /**
1912
+ * The authentication strategy used by this connection.
1913
+ */
1914
+ authentication?: 'uac-authentication';
208
1915
 
209
- /**
210
- * The uuid of the push credential for Ios
211
- */
212
- ios_push_credential_id?: string | null;
1916
+ /**
1917
+ * Specifies if call cost webhooks should be sent for this connection.
1918
+ */
1919
+ call_cost_in_webhooks?: boolean;
213
1920
 
214
- /**
215
- * Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams
216
- * of SIP Trunking calls. The feature is off unless enabled. You may define min and
217
- * max values in msec for customized buffering behaviors. Larger values add latency
218
- * but tolerate more jitter, while smaller values reduce latency but are more
219
- * sensitive to jitter and reordering.
220
- */
221
- jitter_buffer?: Shared.ConnectionJitterBuffer;
1921
+ connection_name?: string;
222
1922
 
223
- /**
224
- * Controls when noise suppression is applied to calls. When set to 'inbound',
225
- * noise suppression is applied to incoming audio. When set to 'outbound', it's
226
- * applied to outgoing audio. When set to 'both', it's applied in both directions.
227
- * When set to 'disabled', noise suppression is turned off.
228
- */
229
- noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
1923
+ /**
1924
+ * ISO-8601 formatted date indicating when the resource was created.
1925
+ */
1926
+ created_at?: string;
230
1927
 
231
- /**
232
- * Configuration options for noise suppression. These settings are stored
233
- * regardless of the noise_suppression value, but only take effect when
234
- * noise_suppression is not 'disabled'. If you disable noise suppression and later
235
- * re-enable it, the previously configured settings will be used.
236
- */
237
- noise_suppression_details?: Shared.ConnectionNoiseSuppressionDetails;
1928
+ /**
1929
+ * When enabled, Telnyx will generate comfort noise when you place the call on
1930
+ * hold. If disabled, you will need to generate comfort noise or on hold music to
1931
+ * avoid RTP timeout.
1932
+ */
1933
+ default_on_hold_comfort_noise_enabled?: boolean;
238
1934
 
239
- /**
240
- * Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
241
- * if both are on the Telnyx network. If this is disabled, Telnyx will be able to
242
- * use T38 on just one leg of the call depending on each leg's settings.
243
- */
244
- onnet_t38_passthrough_enabled?: boolean;
1935
+ /**
1936
+ * Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
1937
+ * digits sent to Telnyx will be accepted in all formats.
1938
+ */
1939
+ dtmf_type?: CredentialConnectionsAPI.DtmfType;
245
1940
 
246
- outbound?: UacOutbound;
1941
+ /**
1942
+ * Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
1943
+ * scenarios.
1944
+ */
1945
+ encode_contact_header_enabled?: boolean;
247
1946
 
248
- /**
249
- * The password to be used as part of the credentials. Must be 8 to 128 characters
250
- * long.
251
- */
252
- password?: string;
1947
+ /**
1948
+ * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
1949
+ * TLS.
1950
+ */
1951
+ encrypted_media?: CredentialConnectionsAPI.EncryptedMedia | null;
253
1952
 
254
- /**
255
- * Identifies the type of the resource.
256
- */
257
- record_type?: string;
1953
+ /**
1954
+ * External SIP peer settings used by Telnyx when registering to your PBX and
1955
+ * routing outbound calls.
1956
+ */
1957
+ external_uac_settings?: Data.ExternalUacSettings;
258
1958
 
259
- /**
260
- * The most recently known SIP registration status for this UAC connection.
261
- */
262
- registration_status?: string | null;
1959
+ /**
1960
+ * The Telnyx-managed FQDN generated for the UAC connection.
1961
+ */
1962
+ fqdn?: string;
263
1963
 
264
- /**
265
- * ISO 8601 formatted date indicating when the registration status was last
266
- * updated.
267
- */
268
- registration_status_updated_at?: string | null;
1964
+ /**
1965
+ * The fixed outbound authentication mode used by UAC FQDN records.
1966
+ */
1967
+ fqdn_outbound_authentication?: 'credential-authentication';
269
1968
 
270
- rtcp_settings?: CredentialConnectionsAPI.ConnectionRtcpSettings;
1969
+ /**
1970
+ * FQDN records managed automatically by the UAC connection lifecycle.
1971
+ */
1972
+ fqdns?: Array<FqdnsAPI.Fqdn>;
271
1973
 
272
- /**
273
- * This feature enables inbound SIP URI calls to your Credential Auth Connection.
274
- * If enabled for all (unrestricted) then anyone who calls the SIP URI
275
- * <your-username>@telnyx.com will be connected to your Connection. You can also
276
- * choose to allow only calls that are originated on any Connections under your
277
- * account (internal).
278
- */
279
- sip_uri_calling_preference?: 'disabled' | 'unrestricted' | 'internal';
1974
+ inbound?: Data.Inbound;
280
1975
 
281
- /**
282
- * Tags associated with the connection.
283
- */
284
- tags?: Array<string>;
1976
+ /**
1977
+ * Internal Telnyx-side settings for a UAC connection.
1978
+ */
1979
+ internal_uac_settings?: Data.InternalUacSettings;
285
1980
 
286
- /**
287
- * ISO-8601 formatted date indicating when the resource was updated.
288
- */
289
- updated_at?: string;
1981
+ /**
1982
+ * The uuid of the push credential for Ios
1983
+ */
1984
+ ios_push_credential_id?: string | null;
290
1985
 
291
- /**
292
- * The user name to be used as part of the credentials. Must be 4-32 characters
293
- * long and alphanumeric values only (no spaces or special characters). At least
294
- * one of the first 5 characters must be a letter.
295
- */
296
- user_name?: string;
1986
+ /**
1987
+ * Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams
1988
+ * of SIP Trunking calls. The feature is off unless enabled. You may define min and
1989
+ * max values in msec for customized buffering behaviors. Larger values add latency
1990
+ * but tolerate more jitter, while smaller values reduce latency but are more
1991
+ * sensitive to jitter and reordering.
1992
+ */
1993
+ jitter_buffer?: Shared.ConnectionJitterBuffer;
297
1994
 
298
- /**
299
- * Determines which webhook format will be used, Telnyx API v1 or v2.
300
- */
301
- webhook_api_version?: '1' | '2';
1995
+ /**
1996
+ * Controls when noise suppression is applied to calls. When set to 'inbound',
1997
+ * noise suppression is applied to incoming audio. When set to 'outbound', it's
1998
+ * applied to outgoing audio. When set to 'both', it's applied in both directions.
1999
+ * When set to 'disabled', noise suppression is turned off.
2000
+ */
2001
+ noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
302
2002
 
303
- /**
304
- * The failover URL where webhooks related to this connection will be sent if
305
- * sending to the primary URL fails. Must include a scheme, such as 'https'.
306
- */
307
- webhook_event_failover_url?: string | null;
2003
+ /**
2004
+ * Configuration options for noise suppression. These settings are stored
2005
+ * regardless of the noise_suppression value, but only take effect when
2006
+ * noise_suppression is not 'disabled'. If you disable noise suppression and later
2007
+ * re-enable it, the previously configured settings will be used.
2008
+ */
2009
+ noise_suppression_details?: Shared.ConnectionNoiseSuppressionDetails;
308
2010
 
309
- /**
310
- * The URL where webhooks related to this connection will be sent. Must include a
311
- * scheme, such as 'https'.
312
- */
313
- webhook_event_url?: string;
2011
+ /**
2012
+ * Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
2013
+ * if both are on the Telnyx network. If this is disabled, Telnyx will be able to
2014
+ * use T38 on just one leg of the call depending on each leg's settings.
2015
+ */
2016
+ onnet_t38_passthrough_enabled?: boolean;
314
2017
 
315
- /**
316
- * Specifies how many seconds to wait before timing out a webhook.
317
- */
318
- webhook_timeout_secs?: number | null;
319
- }
2018
+ outbound?: Data.Outbound;
320
2019
 
321
- /**
322
- * External SIP peer settings used by Telnyx when registering to your PBX and
323
- * routing outbound calls.
324
- */
325
- export interface UacExternalSettings {
326
- /**
327
- * The authentication username used in SIP digest authentication. If not set, the
328
- * Username value will be used.
329
- */
330
- auth_username?: string | null;
2020
+ /**
2021
+ * The password to be used as part of the credentials. Must be 8 to 128 characters
2022
+ * long.
2023
+ */
2024
+ password?: string;
331
2025
 
332
- /**
333
- * The registration interval, in seconds, indicating how often the system refreshes
334
- * the SIP registration with the external SIP peer.
335
- */
336
- expiration_sec?: number | null;
2026
+ /**
2027
+ * Identifies the type of the resource.
2028
+ */
2029
+ record_type?: string;
337
2030
 
338
- /**
339
- * The user portion of the SIP From header used in outbound requests. This controls
340
- * the caller identity presented to the external SIP peer.
341
- */
342
- from_user?: string | null;
2031
+ /**
2032
+ * The most recently known SIP registration status for this UAC connection.
2033
+ */
2034
+ registration_status?: string | null;
343
2035
 
344
- /**
345
- * An optional SIP proxy used to route outbound requests before reaching the
346
- * external SIP peer.
347
- */
348
- outbound_proxy?: string | null;
2036
+ /**
2037
+ * ISO 8601 formatted date indicating when the registration status was last
2038
+ * updated.
2039
+ */
2040
+ registration_status_updated_at?: string | null;
349
2041
 
350
- /**
351
- * The SIP password used for digest authentication with the external SIP peer.
352
- */
353
- password?: string;
2042
+ rtcp_settings?: CredentialConnectionsAPI.ConnectionRtcpSettings;
354
2043
 
355
- /**
356
- * The SIP proxy address of the external SIP peer used for registrations and
357
- * outbound call routing.
358
- */
359
- proxy?: string;
2044
+ /**
2045
+ * This feature enables inbound SIP URI calls to your Credential Auth Connection.
2046
+ * If enabled for all (unrestricted) then anyone who calls the SIP URI
2047
+ * <your-username>@telnyx.com will be connected to your Connection. You can also
2048
+ * choose to allow only calls that are originated on any Connections under your
2049
+ * account (internal).
2050
+ */
2051
+ sip_uri_calling_preference?: 'disabled' | 'unrestricted' | 'internal';
360
2052
 
361
- /**
362
- * The transport protocol used for SIP signaling when communicating with the
363
- * external SIP peer. One of UDP, TLS, or TCP.
364
- */
365
- transport?: 'UDP' | 'TLS' | 'TCP' | null;
2053
+ /**
2054
+ * Tags associated with the connection.
2055
+ */
2056
+ tags?: Array<string>;
366
2057
 
367
- /**
368
- * The SIP username used to authenticate with the external SIP peer for
369
- * registrations and outbound calls. Must start with a letter or number and contain
370
- * only letters, numbers, hyphens, and underscores.
371
- */
372
- username?: string;
373
- }
2058
+ /**
2059
+ * ISO-8601 formatted date indicating when the resource was updated.
2060
+ */
2061
+ updated_at?: string;
374
2062
 
375
- export interface UacInbound {
376
- /**
377
- * This setting allows you to set the format with which the caller's number (ANI)
378
- * is sent for inbound phone calls.
379
- */
380
- ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
2063
+ /**
2064
+ * The user name to be used as part of the credentials. Must be 4-32 characters
2065
+ * long and alphanumeric values only (no spaces or special characters). At least
2066
+ * one of the first 5 characters must be a letter.
2067
+ */
2068
+ user_name?: string;
381
2069
 
382
- /**
383
- * When set, this will limit the total number of inbound calls to phone numbers
384
- * associated with this connection.
385
- */
386
- channel_limit?: number;
2070
+ /**
2071
+ * Determines which webhook format will be used, Telnyx API v1 or v2.
2072
+ */
2073
+ webhook_api_version?: '1' | '2';
387
2074
 
388
- /**
389
- * Defines the list of codecs that Telnyx will send for inbound calls to a specific
390
- * number on your portal account, in priority order. This only works when the
391
- * Connection the number is assigned to uses Media Handling mode: default. OPUS and
392
- * H.264 codecs are available only when using TCP or TLS transport for SIP.
393
- */
394
- codecs?: Array<string>;
2075
+ /**
2076
+ * The failover URL where webhooks related to this connection will be sent if
2077
+ * sending to the primary URL fails. Must include a scheme, such as 'https'.
2078
+ */
2079
+ webhook_event_failover_url?: string | null;
395
2080
 
396
- /**
397
- * Default routing method to be used when a number is associated with the
398
- * connection. Must be one of the routing method types or left blank, other values
399
- * are not allowed.
400
- */
401
- default_routing_method?: 'sequential' | 'round-robin';
2081
+ /**
2082
+ * The URL where webhooks related to this connection will be sent. Must include a
2083
+ * scheme, such as 'https'.
2084
+ */
2085
+ webhook_event_url?: string;
402
2086
 
403
- dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
2087
+ /**
2088
+ * Specifies how many seconds to wait before timing out a webhook.
2089
+ */
2090
+ webhook_timeout_secs?: number | null;
2091
+ }
404
2092
 
405
- /**
406
- * Generate ringback tone through 183 session progress message with early media.
407
- */
408
- generate_ringback_tone?: boolean;
2093
+ export namespace Data {
2094
+ /**
2095
+ * External SIP peer settings used by Telnyx when registering to your PBX and
2096
+ * routing outbound calls.
2097
+ */
2098
+ export interface ExternalUacSettings {
2099
+ /**
2100
+ * The authentication username used in SIP digest authentication. If not set, the
2101
+ * Username value will be used.
2102
+ */
2103
+ auth_username?: string | null;
409
2104
 
410
- /**
411
- * When set, inbound phone calls will receive ISUP parameters via SIP headers.
412
- * (Only when available and only when using TCP or TLS transport.)
413
- */
414
- isup_headers_enabled?: boolean;
2105
+ /**
2106
+ * The registration interval, in seconds, indicating how often the system refreshes
2107
+ * the SIP registration with the external SIP peer.
2108
+ */
2109
+ expiration_sec?: number | null;
415
2110
 
416
- /**
417
- * Enable PRACK messages as defined in RFC3262.
418
- */
419
- prack_enabled?: boolean;
2111
+ /**
2112
+ * The user portion of the SIP From header used in outbound requests. This controls
2113
+ * the caller identity presented to the external SIP peer.
2114
+ */
2115
+ from_user?: string | null;
2116
+
2117
+ /**
2118
+ * An optional SIP proxy used to route outbound requests before reaching the
2119
+ * external SIP peer.
2120
+ */
2121
+ outbound_proxy?: string | null;
2122
+
2123
+ /**
2124
+ * The SIP password used for digest authentication with the external SIP peer.
2125
+ */
2126
+ password?: string;
2127
+
2128
+ /**
2129
+ * The SIP proxy address of the external SIP peer used for registrations and
2130
+ * outbound call routing.
2131
+ */
2132
+ proxy?: string;
2133
+
2134
+ /**
2135
+ * The transport protocol used for SIP signaling when communicating with the
2136
+ * external SIP peer. One of UDP, TLS, or TCP.
2137
+ */
2138
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
2139
+
2140
+ /**
2141
+ * The SIP username used to authenticate with the external SIP peer for
2142
+ * registrations and outbound calls. Must start with a letter or number and contain
2143
+ * only letters, numbers, hyphens, and underscores.
2144
+ */
2145
+ username?: string;
2146
+ }
2147
+
2148
+ export interface Inbound {
2149
+ /**
2150
+ * This setting allows you to set the format with which the caller's number (ANI)
2151
+ * is sent for inbound phone calls.
2152
+ */
2153
+ ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
2154
+
2155
+ /**
2156
+ * When set, this will limit the total number of inbound calls to phone numbers
2157
+ * associated with this connection.
2158
+ */
2159
+ channel_limit?: number;
2160
+
2161
+ /**
2162
+ * Defines the list of codecs that Telnyx will send for inbound calls to a specific
2163
+ * number on your portal account, in priority order. This only works when the
2164
+ * Connection the number is assigned to uses Media Handling mode: default. OPUS and
2165
+ * H.264 codecs are available only when using TCP or TLS transport for SIP.
2166
+ */
2167
+ codecs?: Array<string>;
2168
+
2169
+ /**
2170
+ * Default routing method to be used when a number is associated with the
2171
+ * connection. Must be one of the routing method types or left blank, other values
2172
+ * are not allowed.
2173
+ */
2174
+ default_routing_method?: 'sequential' | 'round-robin';
420
2175
 
421
- /**
422
- * When enabled the SIP Connection will receive the Identity header with
423
- * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
424
- * transport.
425
- */
426
- shaken_stir_enabled?: boolean;
2176
+ dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
427
2177
 
428
- /**
429
- * When enabled, allows multiple devices to ring simultaneously on incoming calls.
430
- */
431
- simultaneous_ringing?: 'disabled' | 'enabled';
2178
+ /**
2179
+ * Generate ringback tone through 183 session progress message with early media.
2180
+ */
2181
+ generate_ringback_tone?: boolean;
432
2182
 
433
- /**
434
- * Defaults to true.
435
- */
436
- sip_compact_headers_enabled?: boolean;
2183
+ /**
2184
+ * When set, inbound phone calls will receive ISUP parameters via SIP headers.
2185
+ * (Only when available and only when using TCP or TLS transport.)
2186
+ */
2187
+ isup_headers_enabled?: boolean;
437
2188
 
438
- /**
439
- * The Telnyx-generated SIP subdomain for this UAC connection.
440
- */
441
- sip_subdomain?: string;
2189
+ /**
2190
+ * Enable PRACK messages as defined in RFC3262.
2191
+ */
2192
+ prack_enabled?: boolean;
442
2193
 
443
- /**
444
- * Controls which SIP URI callers may reach this connection.
445
- */
446
- sip_subdomain_receive_settings?: 'only_my_connections' | 'from_anyone';
2194
+ /**
2195
+ * When enabled the SIP Connection will receive the Identity header with
2196
+ * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
2197
+ * transport.
2198
+ */
2199
+ shaken_stir_enabled?: boolean;
447
2200
 
448
- /**
449
- * Time(sec) before aborting if connection is not made.
450
- */
451
- timeout_1xx_secs?: number;
2201
+ /**
2202
+ * When enabled, allows multiple devices to ring simultaneously on incoming calls.
2203
+ */
2204
+ simultaneous_ringing?: 'disabled' | 'enabled';
452
2205
 
453
- /**
454
- * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
455
- */
456
- timeout_2xx_secs?: number;
457
- }
2206
+ /**
2207
+ * Defaults to true.
2208
+ */
2209
+ sip_compact_headers_enabled?: boolean;
458
2210
 
459
- /**
460
- * Internal Telnyx-side settings for a UAC connection.
461
- */
462
- export interface UacInternalSettings {
463
- /**
464
- * The SIP URI that Telnyx will call when handling an inbound request from the
465
- * external peer. Do not include a `sip:` prefix. The value must be in the format
466
- * `userinfo@<subdomain.>sip.telnyx.com` or
467
- * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
468
- * letters, digits, hyphens, and underscores.
469
- */
470
- destination_uri?: string;
471
- }
2211
+ /**
2212
+ * The Telnyx-generated SIP subdomain for this UAC connection.
2213
+ */
2214
+ sip_subdomain?: string;
472
2215
 
473
- export interface UacOutbound {
474
- /**
475
- * Set a phone number as the ani_override value to override caller id number on
476
- * outbound calls.
477
- */
478
- ani_override?: string;
2216
+ /**
2217
+ * Controls which SIP URI callers may reach this connection.
2218
+ */
2219
+ sip_subdomain_receive_settings?: 'only_my_connections' | 'from_anyone';
479
2220
 
480
- /**
481
- * Specifies when we apply your ani_override setting. Only applies when
482
- * ani_override is not blank.
483
- */
484
- ani_override_type?: 'always' | 'normal' | 'emergency';
2221
+ /**
2222
+ * Time(sec) before aborting if connection is not made.
2223
+ */
2224
+ timeout_1xx_secs?: number;
485
2225
 
486
- /**
487
- * Forces all SIP calls originated on this connection to be "parked" instead of
488
- * "bridged" to the destination specified on the URI. Parked calls will return
489
- * ringback to the caller and will await for a Call Control command to define which
490
- * action will be taken next.
491
- */
492
- call_parking_enabled?: boolean | null;
2226
+ /**
2227
+ * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
2228
+ */
2229
+ timeout_2xx_secs?: number;
2230
+ }
493
2231
 
494
- /**
495
- * When set, this will limit the total number of outbound calls to phone numbers
496
- * associated with this connection.
497
- */
498
- channel_limit?: number;
2232
+ /**
2233
+ * Internal Telnyx-side settings for a UAC connection.
2234
+ */
2235
+ export interface InternalUacSettings {
2236
+ /**
2237
+ * The SIP URI that Telnyx will call when handling an inbound request from the
2238
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
2239
+ * `userinfo@<subdomain.>sip.telnyx.com` or
2240
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
2241
+ * letters, digits, hyphens, and underscores.
2242
+ */
2243
+ destination_uri?: string;
2244
+ }
499
2245
 
500
- /**
501
- * Generate ringback tone through 183 session progress message with early media.
502
- */
503
- generate_ringback_tone?: boolean;
2246
+ export interface Outbound {
2247
+ /**
2248
+ * Set a phone number as the ani_override value to override caller id number on
2249
+ * outbound calls.
2250
+ */
2251
+ ani_override?: string;
504
2252
 
505
- /**
506
- * When set, ringback will not wait for indication before sending ringback tone to
507
- * calling party.
508
- */
509
- instant_ringback_enabled?: boolean;
2253
+ /**
2254
+ * Specifies when we apply your ani_override setting. Only applies when
2255
+ * ani_override is not blank.
2256
+ */
2257
+ ani_override_type?: 'always' | 'normal' | 'emergency';
510
2258
 
511
- /**
512
- * A 2-character country code specifying the country whose national dialing rules
513
- * should be used. For example, if set to `US` then any US number can be dialed
514
- * without preprending +1 to the number. When left blank, Telnyx will try US and GB
515
- * dialing rules, in that order, by default.
516
- */
517
- localization?: string;
2259
+ /**
2260
+ * Forces all SIP calls originated on this connection to be "parked" instead of
2261
+ * "bridged" to the destination specified on the URI. Parked calls will return
2262
+ * ringback to the caller and will await for a Call Control command to define which
2263
+ * action will be taken next.
2264
+ */
2265
+ call_parking_enabled?: boolean | null;
518
2266
 
519
- /**
520
- * Identifies the associated outbound voice profile.
521
- */
522
- outbound_voice_profile_id?: string;
2267
+ /**
2268
+ * When set, this will limit the total number of outbound calls to phone numbers
2269
+ * associated with this connection.
2270
+ */
2271
+ channel_limit?: number;
523
2272
 
524
- /**
525
- * This setting only affects connections with Fax-type Outbound Voice Profiles. The
526
- * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
527
- * default, Telnyx will send the re-invite. If set to `customer`, the caller is
528
- * expected to send the t.38 reinvite.
529
- */
530
- t38_reinvite_source?:
531
- | 'telnyx'
532
- | 'customer'
533
- | 'disabled'
534
- | 'passthru'
535
- | 'caller-passthru'
536
- | 'callee-passthru';
537
- }
2273
+ /**
2274
+ * Generate ringback tone through 183 session progress message with early media.
2275
+ */
2276
+ generate_ringback_tone?: boolean;
538
2277
 
539
- export interface UacConnectionCreateResponse {
540
- /**
541
- * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
542
- * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
543
- * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
544
- * registration.
545
- */
546
- data?: UacConnection;
547
- }
2278
+ /**
2279
+ * When set, ringback will not wait for indication before sending ringback tone to
2280
+ * calling party.
2281
+ */
2282
+ instant_ringback_enabled?: boolean;
548
2283
 
549
- export interface UacConnectionRetrieveResponse {
550
- /**
551
- * A UAC (User Agent Client) Connection registers Telnyx to your PBX the opposite
552
- * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
553
- * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
554
- * registration.
555
- */
556
- data?: UacConnection;
557
- }
2284
+ /**
2285
+ * A 2-character country code specifying the country whose national dialing rules
2286
+ * should be used. For example, if set to `US` then any US number can be dialed
2287
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
2288
+ * dialing rules, in that order, by default.
2289
+ */
2290
+ localization?: string;
558
2291
 
559
- export interface UacConnectionUpdateResponse {
560
- /**
561
- * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
562
- * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
563
- * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
564
- * registration.
565
- */
566
- data?: UacConnection;
567
- }
2292
+ /**
2293
+ * Identifies the associated outbound voice profile.
2294
+ */
2295
+ outbound_voice_profile_id?: string;
568
2296
 
569
- export interface UacConnectionDeleteResponse {
570
- /**
571
- * A UAC (User Agent Client) Connection registers Telnyx to your PBX the opposite
572
- * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
573
- * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
574
- * registration.
575
- */
576
- data?: UacConnection;
2297
+ /**
2298
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
2299
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
2300
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
2301
+ * expected to send the t.38 reinvite.
2302
+ */
2303
+ t38_reinvite_source?:
2304
+ | 'telnyx'
2305
+ | 'customer'
2306
+ | 'disabled'
2307
+ | 'passthru'
2308
+ | 'caller-passthru'
2309
+ | 'callee-passthru';
2310
+ }
2311
+ }
577
2312
  }
578
2313
 
579
2314
  export interface UacConnectionCreateParams {
@@ -633,7 +2368,7 @@ export interface UacConnectionCreateParams {
633
2368
  * External SIP peer settings used by Telnyx when registering to your PBX and
634
2369
  * routing outbound calls.
635
2370
  */
636
- external_uac_settings?: UacExternalSettings;
2371
+ external_uac_settings?: UacConnectionCreateParams.ExternalUacSettings;
637
2372
 
638
2373
  /**
639
2374
  * Inbound settings that can be supplied when creating or updating a UAC
@@ -645,7 +2380,7 @@ export interface UacConnectionCreateParams {
645
2380
  /**
646
2381
  * Internal Telnyx-side settings for a UAC connection.
647
2382
  */
648
- internal_uac_settings?: UacInternalSettings;
2383
+ internal_uac_settings?: UacConnectionCreateParams.InternalUacSettings;
649
2384
 
650
2385
  /**
651
2386
  * The uuid of the push credential for Ios
@@ -684,7 +2419,7 @@ export interface UacConnectionCreateParams {
684
2419
  */
685
2420
  onnet_t38_passthrough_enabled?: boolean;
686
2421
 
687
- outbound?: UacOutbound;
2422
+ outbound?: UacConnectionCreateParams.Outbound;
688
2423
 
689
2424
  /**
690
2425
  * The password to be used as part of the credentials. Must be 8 to 128 characters
@@ -740,6 +2475,60 @@ export interface UacConnectionCreateParams {
740
2475
  }
741
2476
 
742
2477
  export namespace UacConnectionCreateParams {
2478
+ /**
2479
+ * External SIP peer settings used by Telnyx when registering to your PBX and
2480
+ * routing outbound calls.
2481
+ */
2482
+ export interface ExternalUacSettings {
2483
+ /**
2484
+ * The authentication username used in SIP digest authentication. If not set, the
2485
+ * Username value will be used.
2486
+ */
2487
+ auth_username?: string | null;
2488
+
2489
+ /**
2490
+ * The registration interval, in seconds, indicating how often the system refreshes
2491
+ * the SIP registration with the external SIP peer.
2492
+ */
2493
+ expiration_sec?: number | null;
2494
+
2495
+ /**
2496
+ * The user portion of the SIP From header used in outbound requests. This controls
2497
+ * the caller identity presented to the external SIP peer.
2498
+ */
2499
+ from_user?: string | null;
2500
+
2501
+ /**
2502
+ * An optional SIP proxy used to route outbound requests before reaching the
2503
+ * external SIP peer.
2504
+ */
2505
+ outbound_proxy?: string | null;
2506
+
2507
+ /**
2508
+ * The SIP password used for digest authentication with the external SIP peer.
2509
+ */
2510
+ password?: string;
2511
+
2512
+ /**
2513
+ * The SIP proxy address of the external SIP peer used for registrations and
2514
+ * outbound call routing.
2515
+ */
2516
+ proxy?: string;
2517
+
2518
+ /**
2519
+ * The transport protocol used for SIP signaling when communicating with the
2520
+ * external SIP peer. One of UDP, TLS, or TCP.
2521
+ */
2522
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
2523
+
2524
+ /**
2525
+ * The SIP username used to authenticate with the external SIP peer for
2526
+ * registrations and outbound calls. Must start with a letter or number and contain
2527
+ * only letters, numbers, hyphens, and underscores.
2528
+ */
2529
+ username?: string;
2530
+ }
2531
+
743
2532
  /**
744
2533
  * Inbound settings that can be supplied when creating or updating a UAC
745
2534
  * connection. The SIP subdomain fields returned in UAC connection responses are
@@ -818,6 +2607,86 @@ export namespace UacConnectionCreateParams {
818
2607
  */
819
2608
  timeout_2xx_secs?: number;
820
2609
  }
2610
+
2611
+ /**
2612
+ * Internal Telnyx-side settings for a UAC connection.
2613
+ */
2614
+ export interface InternalUacSettings {
2615
+ /**
2616
+ * The SIP URI that Telnyx will call when handling an inbound request from the
2617
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
2618
+ * `userinfo@<subdomain.>sip.telnyx.com` or
2619
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
2620
+ * letters, digits, hyphens, and underscores.
2621
+ */
2622
+ destination_uri?: string;
2623
+ }
2624
+
2625
+ export interface Outbound {
2626
+ /**
2627
+ * Set a phone number as the ani_override value to override caller id number on
2628
+ * outbound calls.
2629
+ */
2630
+ ani_override?: string;
2631
+
2632
+ /**
2633
+ * Specifies when we apply your ani_override setting. Only applies when
2634
+ * ani_override is not blank.
2635
+ */
2636
+ ani_override_type?: 'always' | 'normal' | 'emergency';
2637
+
2638
+ /**
2639
+ * Forces all SIP calls originated on this connection to be "parked" instead of
2640
+ * "bridged" to the destination specified on the URI. Parked calls will return
2641
+ * ringback to the caller and will await for a Call Control command to define which
2642
+ * action will be taken next.
2643
+ */
2644
+ call_parking_enabled?: boolean | null;
2645
+
2646
+ /**
2647
+ * When set, this will limit the total number of outbound calls to phone numbers
2648
+ * associated with this connection.
2649
+ */
2650
+ channel_limit?: number;
2651
+
2652
+ /**
2653
+ * Generate ringback tone through 183 session progress message with early media.
2654
+ */
2655
+ generate_ringback_tone?: boolean;
2656
+
2657
+ /**
2658
+ * When set, ringback will not wait for indication before sending ringback tone to
2659
+ * calling party.
2660
+ */
2661
+ instant_ringback_enabled?: boolean;
2662
+
2663
+ /**
2664
+ * A 2-character country code specifying the country whose national dialing rules
2665
+ * should be used. For example, if set to `US` then any US number can be dialed
2666
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
2667
+ * dialing rules, in that order, by default.
2668
+ */
2669
+ localization?: string;
2670
+
2671
+ /**
2672
+ * Identifies the associated outbound voice profile.
2673
+ */
2674
+ outbound_voice_profile_id?: string;
2675
+
2676
+ /**
2677
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
2678
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
2679
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
2680
+ * expected to send the t.38 reinvite.
2681
+ */
2682
+ t38_reinvite_source?:
2683
+ | 'telnyx'
2684
+ | 'customer'
2685
+ | 'disabled'
2686
+ | 'passthru'
2687
+ | 'caller-passthru'
2688
+ | 'callee-passthru';
2689
+ }
821
2690
  }
822
2691
 
823
2692
  export interface UacConnectionUpdateParams {
@@ -877,7 +2746,7 @@ export interface UacConnectionUpdateParams {
877
2746
  * External SIP peer settings used by Telnyx when registering to your PBX and
878
2747
  * routing outbound calls.
879
2748
  */
880
- external_uac_settings?: UacExternalSettings;
2749
+ external_uac_settings?: UacConnectionUpdateParams.ExternalUacSettings;
881
2750
 
882
2751
  /**
883
2752
  * Inbound settings that can be supplied when creating or updating a UAC
@@ -889,7 +2758,7 @@ export interface UacConnectionUpdateParams {
889
2758
  /**
890
2759
  * Internal Telnyx-side settings for a UAC connection.
891
2760
  */
892
- internal_uac_settings?: UacInternalSettings;
2761
+ internal_uac_settings?: UacConnectionUpdateParams.InternalUacSettings;
893
2762
 
894
2763
  /**
895
2764
  * The uuid of the push credential for Ios
@@ -928,7 +2797,7 @@ export interface UacConnectionUpdateParams {
928
2797
  */
929
2798
  onnet_t38_passthrough_enabled?: boolean;
930
2799
 
931
- outbound?: UacOutbound;
2800
+ outbound?: UacConnectionUpdateParams.Outbound;
932
2801
 
933
2802
  /**
934
2803
  * The password to be used as part of the credentials. Must be 8 to 128 characters
@@ -982,6 +2851,60 @@ export interface UacConnectionUpdateParams {
982
2851
  }
983
2852
 
984
2853
  export namespace UacConnectionUpdateParams {
2854
+ /**
2855
+ * External SIP peer settings used by Telnyx when registering to your PBX and
2856
+ * routing outbound calls.
2857
+ */
2858
+ export interface ExternalUacSettings {
2859
+ /**
2860
+ * The authentication username used in SIP digest authentication. If not set, the
2861
+ * Username value will be used.
2862
+ */
2863
+ auth_username?: string | null;
2864
+
2865
+ /**
2866
+ * The registration interval, in seconds, indicating how often the system refreshes
2867
+ * the SIP registration with the external SIP peer.
2868
+ */
2869
+ expiration_sec?: number | null;
2870
+
2871
+ /**
2872
+ * The user portion of the SIP From header used in outbound requests. This controls
2873
+ * the caller identity presented to the external SIP peer.
2874
+ */
2875
+ from_user?: string | null;
2876
+
2877
+ /**
2878
+ * An optional SIP proxy used to route outbound requests before reaching the
2879
+ * external SIP peer.
2880
+ */
2881
+ outbound_proxy?: string | null;
2882
+
2883
+ /**
2884
+ * The SIP password used for digest authentication with the external SIP peer.
2885
+ */
2886
+ password?: string;
2887
+
2888
+ /**
2889
+ * The SIP proxy address of the external SIP peer used for registrations and
2890
+ * outbound call routing.
2891
+ */
2892
+ proxy?: string;
2893
+
2894
+ /**
2895
+ * The transport protocol used for SIP signaling when communicating with the
2896
+ * external SIP peer. One of UDP, TLS, or TCP.
2897
+ */
2898
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
2899
+
2900
+ /**
2901
+ * The SIP username used to authenticate with the external SIP peer for
2902
+ * registrations and outbound calls. Must start with a letter or number and contain
2903
+ * only letters, numbers, hyphens, and underscores.
2904
+ */
2905
+ username?: string;
2906
+ }
2907
+
985
2908
  /**
986
2909
  * Inbound settings that can be supplied when creating or updating a UAC
987
2910
  * connection. The SIP subdomain fields returned in UAC connection responses are
@@ -1060,6 +2983,86 @@ export namespace UacConnectionUpdateParams {
1060
2983
  */
1061
2984
  timeout_2xx_secs?: number;
1062
2985
  }
2986
+
2987
+ /**
2988
+ * Internal Telnyx-side settings for a UAC connection.
2989
+ */
2990
+ export interface InternalUacSettings {
2991
+ /**
2992
+ * The SIP URI that Telnyx will call when handling an inbound request from the
2993
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
2994
+ * `userinfo@<subdomain.>sip.telnyx.com` or
2995
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
2996
+ * letters, digits, hyphens, and underscores.
2997
+ */
2998
+ destination_uri?: string;
2999
+ }
3000
+
3001
+ export interface Outbound {
3002
+ /**
3003
+ * Set a phone number as the ani_override value to override caller id number on
3004
+ * outbound calls.
3005
+ */
3006
+ ani_override?: string;
3007
+
3008
+ /**
3009
+ * Specifies when we apply your ani_override setting. Only applies when
3010
+ * ani_override is not blank.
3011
+ */
3012
+ ani_override_type?: 'always' | 'normal' | 'emergency';
3013
+
3014
+ /**
3015
+ * Forces all SIP calls originated on this connection to be "parked" instead of
3016
+ * "bridged" to the destination specified on the URI. Parked calls will return
3017
+ * ringback to the caller and will await for a Call Control command to define which
3018
+ * action will be taken next.
3019
+ */
3020
+ call_parking_enabled?: boolean | null;
3021
+
3022
+ /**
3023
+ * When set, this will limit the total number of outbound calls to phone numbers
3024
+ * associated with this connection.
3025
+ */
3026
+ channel_limit?: number;
3027
+
3028
+ /**
3029
+ * Generate ringback tone through 183 session progress message with early media.
3030
+ */
3031
+ generate_ringback_tone?: boolean;
3032
+
3033
+ /**
3034
+ * When set, ringback will not wait for indication before sending ringback tone to
3035
+ * calling party.
3036
+ */
3037
+ instant_ringback_enabled?: boolean;
3038
+
3039
+ /**
3040
+ * A 2-character country code specifying the country whose national dialing rules
3041
+ * should be used. For example, if set to `US` then any US number can be dialed
3042
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
3043
+ * dialing rules, in that order, by default.
3044
+ */
3045
+ localization?: string;
3046
+
3047
+ /**
3048
+ * Identifies the associated outbound voice profile.
3049
+ */
3050
+ outbound_voice_profile_id?: string;
3051
+
3052
+ /**
3053
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
3054
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
3055
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
3056
+ * expected to send the t.38 reinvite.
3057
+ */
3058
+ t38_reinvite_source?:
3059
+ | 'telnyx'
3060
+ | 'customer'
3061
+ | 'disabled'
3062
+ | 'passthru'
3063
+ | 'caller-passthru'
3064
+ | 'callee-passthru';
3065
+ }
1063
3066
  }
1064
3067
 
1065
3068
  export interface UacConnectionListParams extends DefaultFlatPaginationParams {
@@ -1132,16 +3135,12 @@ UacConnections.Actions = Actions;
1132
3135
 
1133
3136
  export declare namespace UacConnections {
1134
3137
  export {
1135
- type UacConnection as UacConnection,
1136
- type UacExternalSettings as UacExternalSettings,
1137
- type UacInbound as UacInbound,
1138
- type UacInternalSettings as UacInternalSettings,
1139
- type UacOutbound as UacOutbound,
1140
3138
  type UacConnectionCreateResponse as UacConnectionCreateResponse,
1141
3139
  type UacConnectionRetrieveResponse as UacConnectionRetrieveResponse,
1142
3140
  type UacConnectionUpdateResponse as UacConnectionUpdateResponse,
3141
+ type UacConnectionListResponse as UacConnectionListResponse,
1143
3142
  type UacConnectionDeleteResponse as UacConnectionDeleteResponse,
1144
- type UacConnectionsDefaultFlatPagination as UacConnectionsDefaultFlatPagination,
3143
+ type UacConnectionListResponsesDefaultFlatPagination as UacConnectionListResponsesDefaultFlatPagination,
1145
3144
  type UacConnectionCreateParams as UacConnectionCreateParams,
1146
3145
  type UacConnectionUpdateParams as UacConnectionUpdateParams,
1147
3146
  type UacConnectionListParams as UacConnectionListParams,