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
@@ -57,12 +57,12 @@ export declare class UacConnections extends APIResource {
57
57
  * @example
58
58
  * ```ts
59
59
  * // Automatically fetches more pages as needed.
60
- * for await (const uacConnection of client.uacConnections.list()) {
60
+ * for await (const uacConnectionListResponse of client.uacConnections.list()) {
61
61
  * // ...
62
62
  * }
63
63
  * ```
64
64
  */
65
- list(query?: UacConnectionListParams | null | undefined, options?: RequestOptions): PagePromise<UacConnectionsDefaultFlatPagination, UacConnection>;
65
+ list(query?: UacConnectionListParams | null | undefined, options?: RequestOptions): PagePromise<UacConnectionListResponsesDefaultFlatPagination, UacConnectionListResponse>;
66
66
  /**
67
67
  * Deletes an existing UAC connection.
68
68
  *
@@ -75,14 +75,1112 @@ export declare class UacConnections extends APIResource {
75
75
  */
76
76
  delete(id: string, options?: RequestOptions): APIPromise<UacConnectionDeleteResponse>;
77
77
  }
78
- export type UacConnectionsDefaultFlatPagination = DefaultFlatPagination<UacConnection>;
78
+ export type UacConnectionListResponsesDefaultFlatPagination = DefaultFlatPagination<UacConnectionListResponse>;
79
+ export interface UacConnectionCreateResponse {
80
+ /**
81
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
82
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
83
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
84
+ * registration.
85
+ */
86
+ data?: UacConnectionCreateResponse.Data;
87
+ }
88
+ export declare namespace UacConnectionCreateResponse {
89
+ /**
90
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
91
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
92
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
93
+ * registration.
94
+ */
95
+ interface Data {
96
+ /**
97
+ * Identifies the type of resource.
98
+ */
99
+ id?: string;
100
+ /**
101
+ * Defaults to true
102
+ */
103
+ active?: boolean;
104
+ /**
105
+ * `Latency` directs Telnyx to route media through the site with the lowest
106
+ * round-trip time to the user's connection. Telnyx calculates this time using ICMP
107
+ * ping messages. This can be disabled by specifying a site to handle all media.
108
+ */
109
+ anchorsite_override?: CredentialConnectionsAPI.AnchorsiteOverride;
110
+ /**
111
+ * The uuid of the push credential for Android
112
+ */
113
+ android_push_credential_id?: string | null;
114
+ /**
115
+ * The authentication strategy used by this connection.
116
+ */
117
+ authentication?: 'uac-authentication';
118
+ /**
119
+ * Specifies if call cost webhooks should be sent for this connection.
120
+ */
121
+ call_cost_in_webhooks?: boolean;
122
+ connection_name?: string;
123
+ /**
124
+ * ISO-8601 formatted date indicating when the resource was created.
125
+ */
126
+ created_at?: string;
127
+ /**
128
+ * When enabled, Telnyx will generate comfort noise when you place the call on
129
+ * hold. If disabled, you will need to generate comfort noise or on hold music to
130
+ * avoid RTP timeout.
131
+ */
132
+ default_on_hold_comfort_noise_enabled?: boolean;
133
+ /**
134
+ * Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
135
+ * digits sent to Telnyx will be accepted in all formats.
136
+ */
137
+ dtmf_type?: CredentialConnectionsAPI.DtmfType;
138
+ /**
139
+ * Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
140
+ * scenarios.
141
+ */
142
+ encode_contact_header_enabled?: boolean;
143
+ /**
144
+ * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
145
+ * TLS.
146
+ */
147
+ encrypted_media?: CredentialConnectionsAPI.EncryptedMedia | null;
148
+ /**
149
+ * External SIP peer settings used by Telnyx when registering to your PBX and
150
+ * routing outbound calls.
151
+ */
152
+ external_uac_settings?: Data.ExternalUacSettings;
153
+ /**
154
+ * The Telnyx-managed FQDN generated for the UAC connection.
155
+ */
156
+ fqdn?: string;
157
+ /**
158
+ * The fixed outbound authentication mode used by UAC FQDN records.
159
+ */
160
+ fqdn_outbound_authentication?: 'credential-authentication';
161
+ /**
162
+ * FQDN records managed automatically by the UAC connection lifecycle.
163
+ */
164
+ fqdns?: Array<FqdnsAPI.Fqdn>;
165
+ inbound?: Data.Inbound;
166
+ /**
167
+ * Internal Telnyx-side settings for a UAC connection.
168
+ */
169
+ internal_uac_settings?: Data.InternalUacSettings;
170
+ /**
171
+ * The uuid of the push credential for Ios
172
+ */
173
+ ios_push_credential_id?: string | null;
174
+ /**
175
+ * Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams
176
+ * of SIP Trunking calls. The feature is off unless enabled. You may define min and
177
+ * max values in msec for customized buffering behaviors. Larger values add latency
178
+ * but tolerate more jitter, while smaller values reduce latency but are more
179
+ * sensitive to jitter and reordering.
180
+ */
181
+ jitter_buffer?: Shared.ConnectionJitterBuffer;
182
+ /**
183
+ * Controls when noise suppression is applied to calls. When set to 'inbound',
184
+ * noise suppression is applied to incoming audio. When set to 'outbound', it's
185
+ * applied to outgoing audio. When set to 'both', it's applied in both directions.
186
+ * When set to 'disabled', noise suppression is turned off.
187
+ */
188
+ noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
189
+ /**
190
+ * Configuration options for noise suppression. These settings are stored
191
+ * regardless of the noise_suppression value, but only take effect when
192
+ * noise_suppression is not 'disabled'. If you disable noise suppression and later
193
+ * re-enable it, the previously configured settings will be used.
194
+ */
195
+ noise_suppression_details?: Shared.ConnectionNoiseSuppressionDetails;
196
+ /**
197
+ * Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
198
+ * if both are on the Telnyx network. If this is disabled, Telnyx will be able to
199
+ * use T38 on just one leg of the call depending on each leg's settings.
200
+ */
201
+ onnet_t38_passthrough_enabled?: boolean;
202
+ outbound?: Data.Outbound;
203
+ /**
204
+ * The password to be used as part of the credentials. Must be 8 to 128 characters
205
+ * long.
206
+ */
207
+ password?: string;
208
+ /**
209
+ * Identifies the type of the resource.
210
+ */
211
+ record_type?: string;
212
+ /**
213
+ * The most recently known SIP registration status for this UAC connection.
214
+ */
215
+ registration_status?: string | null;
216
+ /**
217
+ * ISO 8601 formatted date indicating when the registration status was last
218
+ * updated.
219
+ */
220
+ registration_status_updated_at?: string | null;
221
+ rtcp_settings?: CredentialConnectionsAPI.ConnectionRtcpSettings;
222
+ /**
223
+ * This feature enables inbound SIP URI calls to your Credential Auth Connection.
224
+ * If enabled for all (unrestricted) then anyone who calls the SIP URI
225
+ * <your-username>@telnyx.com will be connected to your Connection. You can also
226
+ * choose to allow only calls that are originated on any Connections under your
227
+ * account (internal).
228
+ */
229
+ sip_uri_calling_preference?: 'disabled' | 'unrestricted' | 'internal';
230
+ /**
231
+ * Tags associated with the connection.
232
+ */
233
+ tags?: Array<string>;
234
+ /**
235
+ * ISO-8601 formatted date indicating when the resource was updated.
236
+ */
237
+ updated_at?: string;
238
+ /**
239
+ * The user name to be used as part of the credentials. Must be 4-32 characters
240
+ * long and alphanumeric values only (no spaces or special characters). At least
241
+ * one of the first 5 characters must be a letter.
242
+ */
243
+ user_name?: string;
244
+ /**
245
+ * Determines which webhook format will be used, Telnyx API v1 or v2.
246
+ */
247
+ webhook_api_version?: '1' | '2';
248
+ /**
249
+ * The failover URL where webhooks related to this connection will be sent if
250
+ * sending to the primary URL fails. Must include a scheme, such as 'https'.
251
+ */
252
+ webhook_event_failover_url?: string | null;
253
+ /**
254
+ * The URL where webhooks related to this connection will be sent. Must include a
255
+ * scheme, such as 'https'.
256
+ */
257
+ webhook_event_url?: string;
258
+ /**
259
+ * Specifies how many seconds to wait before timing out a webhook.
260
+ */
261
+ webhook_timeout_secs?: number | null;
262
+ }
263
+ namespace Data {
264
+ /**
265
+ * External SIP peer settings used by Telnyx when registering to your PBX and
266
+ * routing outbound calls.
267
+ */
268
+ interface ExternalUacSettings {
269
+ /**
270
+ * The authentication username used in SIP digest authentication. If not set, the
271
+ * Username value will be used.
272
+ */
273
+ auth_username?: string | null;
274
+ /**
275
+ * The registration interval, in seconds, indicating how often the system refreshes
276
+ * the SIP registration with the external SIP peer.
277
+ */
278
+ expiration_sec?: number | null;
279
+ /**
280
+ * The user portion of the SIP From header used in outbound requests. This controls
281
+ * the caller identity presented to the external SIP peer.
282
+ */
283
+ from_user?: string | null;
284
+ /**
285
+ * An optional SIP proxy used to route outbound requests before reaching the
286
+ * external SIP peer.
287
+ */
288
+ outbound_proxy?: string | null;
289
+ /**
290
+ * The SIP password used for digest authentication with the external SIP peer.
291
+ */
292
+ password?: string;
293
+ /**
294
+ * The SIP proxy address of the external SIP peer used for registrations and
295
+ * outbound call routing.
296
+ */
297
+ proxy?: string;
298
+ /**
299
+ * The transport protocol used for SIP signaling when communicating with the
300
+ * external SIP peer. One of UDP, TLS, or TCP.
301
+ */
302
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
303
+ /**
304
+ * The SIP username used to authenticate with the external SIP peer for
305
+ * registrations and outbound calls. Must start with a letter or number and contain
306
+ * only letters, numbers, hyphens, and underscores.
307
+ */
308
+ username?: string;
309
+ }
310
+ interface Inbound {
311
+ /**
312
+ * This setting allows you to set the format with which the caller's number (ANI)
313
+ * is sent for inbound phone calls.
314
+ */
315
+ ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
316
+ /**
317
+ * When set, this will limit the total number of inbound calls to phone numbers
318
+ * associated with this connection.
319
+ */
320
+ channel_limit?: number;
321
+ /**
322
+ * Defines the list of codecs that Telnyx will send for inbound calls to a specific
323
+ * number on your portal account, in priority order. This only works when the
324
+ * Connection the number is assigned to uses Media Handling mode: default. OPUS and
325
+ * H.264 codecs are available only when using TCP or TLS transport for SIP.
326
+ */
327
+ codecs?: Array<string>;
328
+ /**
329
+ * Default routing method to be used when a number is associated with the
330
+ * connection. Must be one of the routing method types or left blank, other values
331
+ * are not allowed.
332
+ */
333
+ default_routing_method?: 'sequential' | 'round-robin';
334
+ dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
335
+ /**
336
+ * Generate ringback tone through 183 session progress message with early media.
337
+ */
338
+ generate_ringback_tone?: boolean;
339
+ /**
340
+ * When set, inbound phone calls will receive ISUP parameters via SIP headers.
341
+ * (Only when available and only when using TCP or TLS transport.)
342
+ */
343
+ isup_headers_enabled?: boolean;
344
+ /**
345
+ * Enable PRACK messages as defined in RFC3262.
346
+ */
347
+ prack_enabled?: boolean;
348
+ /**
349
+ * When enabled the SIP Connection will receive the Identity header with
350
+ * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
351
+ * transport.
352
+ */
353
+ shaken_stir_enabled?: boolean;
354
+ /**
355
+ * When enabled, allows multiple devices to ring simultaneously on incoming calls.
356
+ */
357
+ simultaneous_ringing?: 'disabled' | 'enabled';
358
+ /**
359
+ * Defaults to true.
360
+ */
361
+ sip_compact_headers_enabled?: boolean;
362
+ /**
363
+ * The Telnyx-generated SIP subdomain for this UAC connection.
364
+ */
365
+ sip_subdomain?: string;
366
+ /**
367
+ * Controls which SIP URI callers may reach this connection.
368
+ */
369
+ sip_subdomain_receive_settings?: 'only_my_connections' | 'from_anyone';
370
+ /**
371
+ * Time(sec) before aborting if connection is not made.
372
+ */
373
+ timeout_1xx_secs?: number;
374
+ /**
375
+ * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
376
+ */
377
+ timeout_2xx_secs?: number;
378
+ }
379
+ /**
380
+ * Internal Telnyx-side settings for a UAC connection.
381
+ */
382
+ interface InternalUacSettings {
383
+ /**
384
+ * The SIP URI that Telnyx will call when handling an inbound request from the
385
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
386
+ * `userinfo@<subdomain.>sip.telnyx.com` or
387
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
388
+ * letters, digits, hyphens, and underscores.
389
+ */
390
+ destination_uri?: string;
391
+ }
392
+ interface Outbound {
393
+ /**
394
+ * Set a phone number as the ani_override value to override caller id number on
395
+ * outbound calls.
396
+ */
397
+ ani_override?: string;
398
+ /**
399
+ * Specifies when we apply your ani_override setting. Only applies when
400
+ * ani_override is not blank.
401
+ */
402
+ ani_override_type?: 'always' | 'normal' | 'emergency';
403
+ /**
404
+ * Forces all SIP calls originated on this connection to be "parked" instead of
405
+ * "bridged" to the destination specified on the URI. Parked calls will return
406
+ * ringback to the caller and will await for a Call Control command to define which
407
+ * action will be taken next.
408
+ */
409
+ call_parking_enabled?: boolean | null;
410
+ /**
411
+ * When set, this will limit the total number of outbound calls to phone numbers
412
+ * associated with this connection.
413
+ */
414
+ channel_limit?: number;
415
+ /**
416
+ * Generate ringback tone through 183 session progress message with early media.
417
+ */
418
+ generate_ringback_tone?: boolean;
419
+ /**
420
+ * When set, ringback will not wait for indication before sending ringback tone to
421
+ * calling party.
422
+ */
423
+ instant_ringback_enabled?: boolean;
424
+ /**
425
+ * A 2-character country code specifying the country whose national dialing rules
426
+ * should be used. For example, if set to `US` then any US number can be dialed
427
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
428
+ * dialing rules, in that order, by default.
429
+ */
430
+ localization?: string;
431
+ /**
432
+ * Identifies the associated outbound voice profile.
433
+ */
434
+ outbound_voice_profile_id?: string;
435
+ /**
436
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
437
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
438
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
439
+ * expected to send the t.38 reinvite.
440
+ */
441
+ t38_reinvite_source?: 'telnyx' | 'customer' | 'disabled' | 'passthru' | 'caller-passthru' | 'callee-passthru';
442
+ }
443
+ }
444
+ }
445
+ export interface UacConnectionRetrieveResponse {
446
+ /**
447
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
448
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
449
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
450
+ * registration.
451
+ */
452
+ data?: UacConnectionRetrieveResponse.Data;
453
+ }
454
+ export declare namespace UacConnectionRetrieveResponse {
455
+ /**
456
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
457
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
458
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
459
+ * registration.
460
+ */
461
+ interface Data {
462
+ /**
463
+ * Identifies the type of resource.
464
+ */
465
+ id?: string;
466
+ /**
467
+ * Defaults to true
468
+ */
469
+ active?: boolean;
470
+ /**
471
+ * `Latency` directs Telnyx to route media through the site with the lowest
472
+ * round-trip time to the user's connection. Telnyx calculates this time using ICMP
473
+ * ping messages. This can be disabled by specifying a site to handle all media.
474
+ */
475
+ anchorsite_override?: CredentialConnectionsAPI.AnchorsiteOverride;
476
+ /**
477
+ * The uuid of the push credential for Android
478
+ */
479
+ android_push_credential_id?: string | null;
480
+ /**
481
+ * The authentication strategy used by this connection.
482
+ */
483
+ authentication?: 'uac-authentication';
484
+ /**
485
+ * Specifies if call cost webhooks should be sent for this connection.
486
+ */
487
+ call_cost_in_webhooks?: boolean;
488
+ connection_name?: string;
489
+ /**
490
+ * ISO-8601 formatted date indicating when the resource was created.
491
+ */
492
+ created_at?: string;
493
+ /**
494
+ * When enabled, Telnyx will generate comfort noise when you place the call on
495
+ * hold. If disabled, you will need to generate comfort noise or on hold music to
496
+ * avoid RTP timeout.
497
+ */
498
+ default_on_hold_comfort_noise_enabled?: boolean;
499
+ /**
500
+ * Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
501
+ * digits sent to Telnyx will be accepted in all formats.
502
+ */
503
+ dtmf_type?: CredentialConnectionsAPI.DtmfType;
504
+ /**
505
+ * Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
506
+ * scenarios.
507
+ */
508
+ encode_contact_header_enabled?: boolean;
509
+ /**
510
+ * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
511
+ * TLS.
512
+ */
513
+ encrypted_media?: CredentialConnectionsAPI.EncryptedMedia | null;
514
+ /**
515
+ * External SIP peer settings used by Telnyx when registering to your PBX and
516
+ * routing outbound calls.
517
+ */
518
+ external_uac_settings?: Data.ExternalUacSettings;
519
+ /**
520
+ * The Telnyx-managed FQDN generated for the UAC connection.
521
+ */
522
+ fqdn?: string;
523
+ /**
524
+ * The fixed outbound authentication mode used by UAC FQDN records.
525
+ */
526
+ fqdn_outbound_authentication?: 'credential-authentication';
527
+ /**
528
+ * FQDN records managed automatically by the UAC connection lifecycle.
529
+ */
530
+ fqdns?: Array<FqdnsAPI.Fqdn>;
531
+ inbound?: Data.Inbound;
532
+ /**
533
+ * Internal Telnyx-side settings for a UAC connection.
534
+ */
535
+ internal_uac_settings?: Data.InternalUacSettings;
536
+ /**
537
+ * The uuid of the push credential for Ios
538
+ */
539
+ ios_push_credential_id?: string | null;
540
+ /**
541
+ * Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams
542
+ * of SIP Trunking calls. The feature is off unless enabled. You may define min and
543
+ * max values in msec for customized buffering behaviors. Larger values add latency
544
+ * but tolerate more jitter, while smaller values reduce latency but are more
545
+ * sensitive to jitter and reordering.
546
+ */
547
+ jitter_buffer?: Shared.ConnectionJitterBuffer;
548
+ /**
549
+ * Controls when noise suppression is applied to calls. When set to 'inbound',
550
+ * noise suppression is applied to incoming audio. When set to 'outbound', it's
551
+ * applied to outgoing audio. When set to 'both', it's applied in both directions.
552
+ * When set to 'disabled', noise suppression is turned off.
553
+ */
554
+ noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
555
+ /**
556
+ * Configuration options for noise suppression. These settings are stored
557
+ * regardless of the noise_suppression value, but only take effect when
558
+ * noise_suppression is not 'disabled'. If you disable noise suppression and later
559
+ * re-enable it, the previously configured settings will be used.
560
+ */
561
+ noise_suppression_details?: Shared.ConnectionNoiseSuppressionDetails;
562
+ /**
563
+ * Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
564
+ * if both are on the Telnyx network. If this is disabled, Telnyx will be able to
565
+ * use T38 on just one leg of the call depending on each leg's settings.
566
+ */
567
+ onnet_t38_passthrough_enabled?: boolean;
568
+ outbound?: Data.Outbound;
569
+ /**
570
+ * The password to be used as part of the credentials. Must be 8 to 128 characters
571
+ * long.
572
+ */
573
+ password?: string;
574
+ /**
575
+ * Identifies the type of the resource.
576
+ */
577
+ record_type?: string;
578
+ /**
579
+ * The most recently known SIP registration status for this UAC connection.
580
+ */
581
+ registration_status?: string | null;
582
+ /**
583
+ * ISO 8601 formatted date indicating when the registration status was last
584
+ * updated.
585
+ */
586
+ registration_status_updated_at?: string | null;
587
+ rtcp_settings?: CredentialConnectionsAPI.ConnectionRtcpSettings;
588
+ /**
589
+ * This feature enables inbound SIP URI calls to your Credential Auth Connection.
590
+ * If enabled for all (unrestricted) then anyone who calls the SIP URI
591
+ * <your-username>@telnyx.com will be connected to your Connection. You can also
592
+ * choose to allow only calls that are originated on any Connections under your
593
+ * account (internal).
594
+ */
595
+ sip_uri_calling_preference?: 'disabled' | 'unrestricted' | 'internal';
596
+ /**
597
+ * Tags associated with the connection.
598
+ */
599
+ tags?: Array<string>;
600
+ /**
601
+ * ISO-8601 formatted date indicating when the resource was updated.
602
+ */
603
+ updated_at?: string;
604
+ /**
605
+ * The user name to be used as part of the credentials. Must be 4-32 characters
606
+ * long and alphanumeric values only (no spaces or special characters). At least
607
+ * one of the first 5 characters must be a letter.
608
+ */
609
+ user_name?: string;
610
+ /**
611
+ * Determines which webhook format will be used, Telnyx API v1 or v2.
612
+ */
613
+ webhook_api_version?: '1' | '2';
614
+ /**
615
+ * The failover URL where webhooks related to this connection will be sent if
616
+ * sending to the primary URL fails. Must include a scheme, such as 'https'.
617
+ */
618
+ webhook_event_failover_url?: string | null;
619
+ /**
620
+ * The URL where webhooks related to this connection will be sent. Must include a
621
+ * scheme, such as 'https'.
622
+ */
623
+ webhook_event_url?: string;
624
+ /**
625
+ * Specifies how many seconds to wait before timing out a webhook.
626
+ */
627
+ webhook_timeout_secs?: number | null;
628
+ }
629
+ namespace Data {
630
+ /**
631
+ * External SIP peer settings used by Telnyx when registering to your PBX and
632
+ * routing outbound calls.
633
+ */
634
+ interface ExternalUacSettings {
635
+ /**
636
+ * The authentication username used in SIP digest authentication. If not set, the
637
+ * Username value will be used.
638
+ */
639
+ auth_username?: string | null;
640
+ /**
641
+ * The registration interval, in seconds, indicating how often the system refreshes
642
+ * the SIP registration with the external SIP peer.
643
+ */
644
+ expiration_sec?: number | null;
645
+ /**
646
+ * The user portion of the SIP From header used in outbound requests. This controls
647
+ * the caller identity presented to the external SIP peer.
648
+ */
649
+ from_user?: string | null;
650
+ /**
651
+ * An optional SIP proxy used to route outbound requests before reaching the
652
+ * external SIP peer.
653
+ */
654
+ outbound_proxy?: string | null;
655
+ /**
656
+ * The SIP password used for digest authentication with the external SIP peer.
657
+ */
658
+ password?: string;
659
+ /**
660
+ * The SIP proxy address of the external SIP peer used for registrations and
661
+ * outbound call routing.
662
+ */
663
+ proxy?: string;
664
+ /**
665
+ * The transport protocol used for SIP signaling when communicating with the
666
+ * external SIP peer. One of UDP, TLS, or TCP.
667
+ */
668
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
669
+ /**
670
+ * The SIP username used to authenticate with the external SIP peer for
671
+ * registrations and outbound calls. Must start with a letter or number and contain
672
+ * only letters, numbers, hyphens, and underscores.
673
+ */
674
+ username?: string;
675
+ }
676
+ interface Inbound {
677
+ /**
678
+ * This setting allows you to set the format with which the caller's number (ANI)
679
+ * is sent for inbound phone calls.
680
+ */
681
+ ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
682
+ /**
683
+ * When set, this will limit the total number of inbound calls to phone numbers
684
+ * associated with this connection.
685
+ */
686
+ channel_limit?: number;
687
+ /**
688
+ * Defines the list of codecs that Telnyx will send for inbound calls to a specific
689
+ * number on your portal account, in priority order. This only works when the
690
+ * Connection the number is assigned to uses Media Handling mode: default. OPUS and
691
+ * H.264 codecs are available only when using TCP or TLS transport for SIP.
692
+ */
693
+ codecs?: Array<string>;
694
+ /**
695
+ * Default routing method to be used when a number is associated with the
696
+ * connection. Must be one of the routing method types or left blank, other values
697
+ * are not allowed.
698
+ */
699
+ default_routing_method?: 'sequential' | 'round-robin';
700
+ dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
701
+ /**
702
+ * Generate ringback tone through 183 session progress message with early media.
703
+ */
704
+ generate_ringback_tone?: boolean;
705
+ /**
706
+ * When set, inbound phone calls will receive ISUP parameters via SIP headers.
707
+ * (Only when available and only when using TCP or TLS transport.)
708
+ */
709
+ isup_headers_enabled?: boolean;
710
+ /**
711
+ * Enable PRACK messages as defined in RFC3262.
712
+ */
713
+ prack_enabled?: boolean;
714
+ /**
715
+ * When enabled the SIP Connection will receive the Identity header with
716
+ * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
717
+ * transport.
718
+ */
719
+ shaken_stir_enabled?: boolean;
720
+ /**
721
+ * When enabled, allows multiple devices to ring simultaneously on incoming calls.
722
+ */
723
+ simultaneous_ringing?: 'disabled' | 'enabled';
724
+ /**
725
+ * Defaults to true.
726
+ */
727
+ sip_compact_headers_enabled?: boolean;
728
+ /**
729
+ * The Telnyx-generated SIP subdomain for this UAC connection.
730
+ */
731
+ sip_subdomain?: string;
732
+ /**
733
+ * Controls which SIP URI callers may reach this connection.
734
+ */
735
+ sip_subdomain_receive_settings?: 'only_my_connections' | 'from_anyone';
736
+ /**
737
+ * Time(sec) before aborting if connection is not made.
738
+ */
739
+ timeout_1xx_secs?: number;
740
+ /**
741
+ * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
742
+ */
743
+ timeout_2xx_secs?: number;
744
+ }
745
+ /**
746
+ * Internal Telnyx-side settings for a UAC connection.
747
+ */
748
+ interface InternalUacSettings {
749
+ /**
750
+ * The SIP URI that Telnyx will call when handling an inbound request from the
751
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
752
+ * `userinfo@<subdomain.>sip.telnyx.com` or
753
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
754
+ * letters, digits, hyphens, and underscores.
755
+ */
756
+ destination_uri?: string;
757
+ }
758
+ interface Outbound {
759
+ /**
760
+ * Set a phone number as the ani_override value to override caller id number on
761
+ * outbound calls.
762
+ */
763
+ ani_override?: string;
764
+ /**
765
+ * Specifies when we apply your ani_override setting. Only applies when
766
+ * ani_override is not blank.
767
+ */
768
+ ani_override_type?: 'always' | 'normal' | 'emergency';
769
+ /**
770
+ * Forces all SIP calls originated on this connection to be "parked" instead of
771
+ * "bridged" to the destination specified on the URI. Parked calls will return
772
+ * ringback to the caller and will await for a Call Control command to define which
773
+ * action will be taken next.
774
+ */
775
+ call_parking_enabled?: boolean | null;
776
+ /**
777
+ * When set, this will limit the total number of outbound calls to phone numbers
778
+ * associated with this connection.
779
+ */
780
+ channel_limit?: number;
781
+ /**
782
+ * Generate ringback tone through 183 session progress message with early media.
783
+ */
784
+ generate_ringback_tone?: boolean;
785
+ /**
786
+ * When set, ringback will not wait for indication before sending ringback tone to
787
+ * calling party.
788
+ */
789
+ instant_ringback_enabled?: boolean;
790
+ /**
791
+ * A 2-character country code specifying the country whose national dialing rules
792
+ * should be used. For example, if set to `US` then any US number can be dialed
793
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
794
+ * dialing rules, in that order, by default.
795
+ */
796
+ localization?: string;
797
+ /**
798
+ * Identifies the associated outbound voice profile.
799
+ */
800
+ outbound_voice_profile_id?: string;
801
+ /**
802
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
803
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
804
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
805
+ * expected to send the t.38 reinvite.
806
+ */
807
+ t38_reinvite_source?: 'telnyx' | 'customer' | 'disabled' | 'passthru' | 'caller-passthru' | 'callee-passthru';
808
+ }
809
+ }
810
+ }
811
+ export interface UacConnectionUpdateResponse {
812
+ /**
813
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
814
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
815
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
816
+ * registration.
817
+ */
818
+ data?: UacConnectionUpdateResponse.Data;
819
+ }
820
+ export declare namespace UacConnectionUpdateResponse {
821
+ /**
822
+ * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
823
+ * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
824
+ * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
825
+ * registration.
826
+ */
827
+ interface Data {
828
+ /**
829
+ * Identifies the type of resource.
830
+ */
831
+ id?: string;
832
+ /**
833
+ * Defaults to true
834
+ */
835
+ active?: boolean;
836
+ /**
837
+ * `Latency` directs Telnyx to route media through the site with the lowest
838
+ * round-trip time to the user's connection. Telnyx calculates this time using ICMP
839
+ * ping messages. This can be disabled by specifying a site to handle all media.
840
+ */
841
+ anchorsite_override?: CredentialConnectionsAPI.AnchorsiteOverride;
842
+ /**
843
+ * The uuid of the push credential for Android
844
+ */
845
+ android_push_credential_id?: string | null;
846
+ /**
847
+ * The authentication strategy used by this connection.
848
+ */
849
+ authentication?: 'uac-authentication';
850
+ /**
851
+ * Specifies if call cost webhooks should be sent for this connection.
852
+ */
853
+ call_cost_in_webhooks?: boolean;
854
+ connection_name?: string;
855
+ /**
856
+ * ISO-8601 formatted date indicating when the resource was created.
857
+ */
858
+ created_at?: string;
859
+ /**
860
+ * When enabled, Telnyx will generate comfort noise when you place the call on
861
+ * hold. If disabled, you will need to generate comfort noise or on hold music to
862
+ * avoid RTP timeout.
863
+ */
864
+ default_on_hold_comfort_noise_enabled?: boolean;
865
+ /**
866
+ * Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
867
+ * digits sent to Telnyx will be accepted in all formats.
868
+ */
869
+ dtmf_type?: CredentialConnectionsAPI.DtmfType;
870
+ /**
871
+ * Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
872
+ * scenarios.
873
+ */
874
+ encode_contact_header_enabled?: boolean;
875
+ /**
876
+ * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
877
+ * TLS.
878
+ */
879
+ encrypted_media?: CredentialConnectionsAPI.EncryptedMedia | null;
880
+ /**
881
+ * External SIP peer settings used by Telnyx when registering to your PBX and
882
+ * routing outbound calls.
883
+ */
884
+ external_uac_settings?: Data.ExternalUacSettings;
885
+ /**
886
+ * The Telnyx-managed FQDN generated for the UAC connection.
887
+ */
888
+ fqdn?: string;
889
+ /**
890
+ * The fixed outbound authentication mode used by UAC FQDN records.
891
+ */
892
+ fqdn_outbound_authentication?: 'credential-authentication';
893
+ /**
894
+ * FQDN records managed automatically by the UAC connection lifecycle.
895
+ */
896
+ fqdns?: Array<FqdnsAPI.Fqdn>;
897
+ inbound?: Data.Inbound;
898
+ /**
899
+ * Internal Telnyx-side settings for a UAC connection.
900
+ */
901
+ internal_uac_settings?: Data.InternalUacSettings;
902
+ /**
903
+ * The uuid of the push credential for Ios
904
+ */
905
+ ios_push_credential_id?: string | null;
906
+ /**
907
+ * Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams
908
+ * of SIP Trunking calls. The feature is off unless enabled. You may define min and
909
+ * max values in msec for customized buffering behaviors. Larger values add latency
910
+ * but tolerate more jitter, while smaller values reduce latency but are more
911
+ * sensitive to jitter and reordering.
912
+ */
913
+ jitter_buffer?: Shared.ConnectionJitterBuffer;
914
+ /**
915
+ * Controls when noise suppression is applied to calls. When set to 'inbound',
916
+ * noise suppression is applied to incoming audio. When set to 'outbound', it's
917
+ * applied to outgoing audio. When set to 'both', it's applied in both directions.
918
+ * When set to 'disabled', noise suppression is turned off.
919
+ */
920
+ noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
921
+ /**
922
+ * Configuration options for noise suppression. These settings are stored
923
+ * regardless of the noise_suppression value, but only take effect when
924
+ * noise_suppression is not 'disabled'. If you disable noise suppression and later
925
+ * re-enable it, the previously configured settings will be used.
926
+ */
927
+ noise_suppression_details?: Shared.ConnectionNoiseSuppressionDetails;
928
+ /**
929
+ * Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
930
+ * if both are on the Telnyx network. If this is disabled, Telnyx will be able to
931
+ * use T38 on just one leg of the call depending on each leg's settings.
932
+ */
933
+ onnet_t38_passthrough_enabled?: boolean;
934
+ outbound?: Data.Outbound;
935
+ /**
936
+ * The password to be used as part of the credentials. Must be 8 to 128 characters
937
+ * long.
938
+ */
939
+ password?: string;
940
+ /**
941
+ * Identifies the type of the resource.
942
+ */
943
+ record_type?: string;
944
+ /**
945
+ * The most recently known SIP registration status for this UAC connection.
946
+ */
947
+ registration_status?: string | null;
948
+ /**
949
+ * ISO 8601 formatted date indicating when the registration status was last
950
+ * updated.
951
+ */
952
+ registration_status_updated_at?: string | null;
953
+ rtcp_settings?: CredentialConnectionsAPI.ConnectionRtcpSettings;
954
+ /**
955
+ * This feature enables inbound SIP URI calls to your Credential Auth Connection.
956
+ * If enabled for all (unrestricted) then anyone who calls the SIP URI
957
+ * <your-username>@telnyx.com will be connected to your Connection. You can also
958
+ * choose to allow only calls that are originated on any Connections under your
959
+ * account (internal).
960
+ */
961
+ sip_uri_calling_preference?: 'disabled' | 'unrestricted' | 'internal';
962
+ /**
963
+ * Tags associated with the connection.
964
+ */
965
+ tags?: Array<string>;
966
+ /**
967
+ * ISO-8601 formatted date indicating when the resource was updated.
968
+ */
969
+ updated_at?: string;
970
+ /**
971
+ * The user name to be used as part of the credentials. Must be 4-32 characters
972
+ * long and alphanumeric values only (no spaces or special characters). At least
973
+ * one of the first 5 characters must be a letter.
974
+ */
975
+ user_name?: string;
976
+ /**
977
+ * Determines which webhook format will be used, Telnyx API v1 or v2.
978
+ */
979
+ webhook_api_version?: '1' | '2';
980
+ /**
981
+ * The failover URL where webhooks related to this connection will be sent if
982
+ * sending to the primary URL fails. Must include a scheme, such as 'https'.
983
+ */
984
+ webhook_event_failover_url?: string | null;
985
+ /**
986
+ * The URL where webhooks related to this connection will be sent. Must include a
987
+ * scheme, such as 'https'.
988
+ */
989
+ webhook_event_url?: string;
990
+ /**
991
+ * Specifies how many seconds to wait before timing out a webhook.
992
+ */
993
+ webhook_timeout_secs?: number | null;
994
+ }
995
+ namespace Data {
996
+ /**
997
+ * External SIP peer settings used by Telnyx when registering to your PBX and
998
+ * routing outbound calls.
999
+ */
1000
+ interface ExternalUacSettings {
1001
+ /**
1002
+ * The authentication username used in SIP digest authentication. If not set, the
1003
+ * Username value will be used.
1004
+ */
1005
+ auth_username?: string | null;
1006
+ /**
1007
+ * The registration interval, in seconds, indicating how often the system refreshes
1008
+ * the SIP registration with the external SIP peer.
1009
+ */
1010
+ expiration_sec?: number | null;
1011
+ /**
1012
+ * The user portion of the SIP From header used in outbound requests. This controls
1013
+ * the caller identity presented to the external SIP peer.
1014
+ */
1015
+ from_user?: string | null;
1016
+ /**
1017
+ * An optional SIP proxy used to route outbound requests before reaching the
1018
+ * external SIP peer.
1019
+ */
1020
+ outbound_proxy?: string | null;
1021
+ /**
1022
+ * The SIP password used for digest authentication with the external SIP peer.
1023
+ */
1024
+ password?: string;
1025
+ /**
1026
+ * The SIP proxy address of the external SIP peer used for registrations and
1027
+ * outbound call routing.
1028
+ */
1029
+ proxy?: string;
1030
+ /**
1031
+ * The transport protocol used for SIP signaling when communicating with the
1032
+ * external SIP peer. One of UDP, TLS, or TCP.
1033
+ */
1034
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
1035
+ /**
1036
+ * The SIP username used to authenticate with the external SIP peer for
1037
+ * registrations and outbound calls. Must start with a letter or number and contain
1038
+ * only letters, numbers, hyphens, and underscores.
1039
+ */
1040
+ username?: string;
1041
+ }
1042
+ interface Inbound {
1043
+ /**
1044
+ * This setting allows you to set the format with which the caller's number (ANI)
1045
+ * is sent for inbound phone calls.
1046
+ */
1047
+ ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
1048
+ /**
1049
+ * When set, this will limit the total number of inbound calls to phone numbers
1050
+ * associated with this connection.
1051
+ */
1052
+ channel_limit?: number;
1053
+ /**
1054
+ * Defines the list of codecs that Telnyx will send for inbound calls to a specific
1055
+ * number on your portal account, in priority order. This only works when the
1056
+ * Connection the number is assigned to uses Media Handling mode: default. OPUS and
1057
+ * H.264 codecs are available only when using TCP or TLS transport for SIP.
1058
+ */
1059
+ codecs?: Array<string>;
1060
+ /**
1061
+ * Default routing method to be used when a number is associated with the
1062
+ * connection. Must be one of the routing method types or left blank, other values
1063
+ * are not allowed.
1064
+ */
1065
+ default_routing_method?: 'sequential' | 'round-robin';
1066
+ dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
1067
+ /**
1068
+ * Generate ringback tone through 183 session progress message with early media.
1069
+ */
1070
+ generate_ringback_tone?: boolean;
1071
+ /**
1072
+ * When set, inbound phone calls will receive ISUP parameters via SIP headers.
1073
+ * (Only when available and only when using TCP or TLS transport.)
1074
+ */
1075
+ isup_headers_enabled?: boolean;
1076
+ /**
1077
+ * Enable PRACK messages as defined in RFC3262.
1078
+ */
1079
+ prack_enabled?: boolean;
1080
+ /**
1081
+ * When enabled the SIP Connection will receive the Identity header with
1082
+ * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
1083
+ * transport.
1084
+ */
1085
+ shaken_stir_enabled?: boolean;
1086
+ /**
1087
+ * When enabled, allows multiple devices to ring simultaneously on incoming calls.
1088
+ */
1089
+ simultaneous_ringing?: 'disabled' | 'enabled';
1090
+ /**
1091
+ * Defaults to true.
1092
+ */
1093
+ sip_compact_headers_enabled?: boolean;
1094
+ /**
1095
+ * The Telnyx-generated SIP subdomain for this UAC connection.
1096
+ */
1097
+ sip_subdomain?: string;
1098
+ /**
1099
+ * Controls which SIP URI callers may reach this connection.
1100
+ */
1101
+ sip_subdomain_receive_settings?: 'only_my_connections' | 'from_anyone';
1102
+ /**
1103
+ * Time(sec) before aborting if connection is not made.
1104
+ */
1105
+ timeout_1xx_secs?: number;
1106
+ /**
1107
+ * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
1108
+ */
1109
+ timeout_2xx_secs?: number;
1110
+ }
1111
+ /**
1112
+ * Internal Telnyx-side settings for a UAC connection.
1113
+ */
1114
+ interface InternalUacSettings {
1115
+ /**
1116
+ * The SIP URI that Telnyx will call when handling an inbound request from the
1117
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
1118
+ * `userinfo@<subdomain.>sip.telnyx.com` or
1119
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
1120
+ * letters, digits, hyphens, and underscores.
1121
+ */
1122
+ destination_uri?: string;
1123
+ }
1124
+ interface Outbound {
1125
+ /**
1126
+ * Set a phone number as the ani_override value to override caller id number on
1127
+ * outbound calls.
1128
+ */
1129
+ ani_override?: string;
1130
+ /**
1131
+ * Specifies when we apply your ani_override setting. Only applies when
1132
+ * ani_override is not blank.
1133
+ */
1134
+ ani_override_type?: 'always' | 'normal' | 'emergency';
1135
+ /**
1136
+ * Forces all SIP calls originated on this connection to be "parked" instead of
1137
+ * "bridged" to the destination specified on the URI. Parked calls will return
1138
+ * ringback to the caller and will await for a Call Control command to define which
1139
+ * action will be taken next.
1140
+ */
1141
+ call_parking_enabled?: boolean | null;
1142
+ /**
1143
+ * When set, this will limit the total number of outbound calls to phone numbers
1144
+ * associated with this connection.
1145
+ */
1146
+ channel_limit?: number;
1147
+ /**
1148
+ * Generate ringback tone through 183 session progress message with early media.
1149
+ */
1150
+ generate_ringback_tone?: boolean;
1151
+ /**
1152
+ * When set, ringback will not wait for indication before sending ringback tone to
1153
+ * calling party.
1154
+ */
1155
+ instant_ringback_enabled?: boolean;
1156
+ /**
1157
+ * A 2-character country code specifying the country whose national dialing rules
1158
+ * should be used. For example, if set to `US` then any US number can be dialed
1159
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
1160
+ * dialing rules, in that order, by default.
1161
+ */
1162
+ localization?: string;
1163
+ /**
1164
+ * Identifies the associated outbound voice profile.
1165
+ */
1166
+ outbound_voice_profile_id?: string;
1167
+ /**
1168
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
1169
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
1170
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
1171
+ * expected to send the t.38 reinvite.
1172
+ */
1173
+ t38_reinvite_source?: 'telnyx' | 'customer' | 'disabled' | 'passthru' | 'caller-passthru' | 'callee-passthru';
1174
+ }
1175
+ }
1176
+ }
79
1177
  /**
80
1178
  * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
81
1179
  * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
82
1180
  * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
83
1181
  * registration.
84
1182
  */
85
- export interface UacConnection {
1183
+ export interface UacConnectionListResponse {
86
1184
  /**
87
1185
  * Identifies the type of resource.
88
1186
  */
@@ -139,7 +1237,7 @@ export interface UacConnection {
139
1237
  * External SIP peer settings used by Telnyx when registering to your PBX and
140
1238
  * routing outbound calls.
141
1239
  */
142
- external_uac_settings?: UacExternalSettings;
1240
+ external_uac_settings?: UacConnectionListResponse.ExternalUacSettings;
143
1241
  /**
144
1242
  * The Telnyx-managed FQDN generated for the UAC connection.
145
1243
  */
@@ -152,11 +1250,11 @@ export interface UacConnection {
152
1250
  * FQDN records managed automatically by the UAC connection lifecycle.
153
1251
  */
154
1252
  fqdns?: Array<FqdnsAPI.Fqdn>;
155
- inbound?: UacInbound;
1253
+ inbound?: UacConnectionListResponse.Inbound;
156
1254
  /**
157
1255
  * Internal Telnyx-side settings for a UAC connection.
158
1256
  */
159
- internal_uac_settings?: UacInternalSettings;
1257
+ internal_uac_settings?: UacConnectionListResponse.InternalUacSettings;
160
1258
  /**
161
1259
  * The uuid of the push credential for Ios
162
1260
  */
@@ -189,7 +1287,7 @@ export interface UacConnection {
189
1287
  * use T38 on just one leg of the call depending on each leg's settings.
190
1288
  */
191
1289
  onnet_t38_passthrough_enabled?: boolean;
192
- outbound?: UacOutbound;
1290
+ outbound?: UacConnectionListResponse.Outbound;
193
1291
  /**
194
1292
  * The password to be used as part of the credentials. Must be 8 to 128 characters
195
1293
  * long.
@@ -250,220 +1348,552 @@ export interface UacConnection {
250
1348
  */
251
1349
  webhook_timeout_secs?: number | null;
252
1350
  }
253
- /**
254
- * External SIP peer settings used by Telnyx when registering to your PBX and
255
- * routing outbound calls.
256
- */
257
- export interface UacExternalSettings {
258
- /**
259
- * The authentication username used in SIP digest authentication. If not set, the
260
- * Username value will be used.
261
- */
262
- auth_username?: string | null;
263
- /**
264
- * The registration interval, in seconds, indicating how often the system refreshes
265
- * the SIP registration with the external SIP peer.
266
- */
267
- expiration_sec?: number | null;
268
- /**
269
- * The user portion of the SIP From header used in outbound requests. This controls
270
- * the caller identity presented to the external SIP peer.
271
- */
272
- from_user?: string | null;
273
- /**
274
- * An optional SIP proxy used to route outbound requests before reaching the
275
- * external SIP peer.
276
- */
277
- outbound_proxy?: string | null;
278
- /**
279
- * The SIP password used for digest authentication with the external SIP peer.
280
- */
281
- password?: string;
282
- /**
283
- * The SIP proxy address of the external SIP peer used for registrations and
284
- * outbound call routing.
285
- */
286
- proxy?: string;
287
- /**
288
- * The transport protocol used for SIP signaling when communicating with the
289
- * external SIP peer. One of UDP, TLS, or TCP.
290
- */
291
- transport?: 'UDP' | 'TLS' | 'TCP' | null;
292
- /**
293
- * The SIP username used to authenticate with the external SIP peer for
294
- * registrations and outbound calls. Must start with a letter or number and contain
295
- * only letters, numbers, hyphens, and underscores.
296
- */
297
- username?: string;
298
- }
299
- export interface UacInbound {
300
- /**
301
- * This setting allows you to set the format with which the caller's number (ANI)
302
- * is sent for inbound phone calls.
303
- */
304
- ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
305
- /**
306
- * When set, this will limit the total number of inbound calls to phone numbers
307
- * associated with this connection.
308
- */
309
- channel_limit?: number;
310
- /**
311
- * Defines the list of codecs that Telnyx will send for inbound calls to a specific
312
- * number on your portal account, in priority order. This only works when the
313
- * Connection the number is assigned to uses Media Handling mode: default. OPUS and
314
- * H.264 codecs are available only when using TCP or TLS transport for SIP.
315
- */
316
- codecs?: Array<string>;
317
- /**
318
- * Default routing method to be used when a number is associated with the
319
- * connection. Must be one of the routing method types or left blank, other values
320
- * are not allowed.
321
- */
322
- default_routing_method?: 'sequential' | 'round-robin';
323
- dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
324
- /**
325
- * Generate ringback tone through 183 session progress message with early media.
326
- */
327
- generate_ringback_tone?: boolean;
328
- /**
329
- * When set, inbound phone calls will receive ISUP parameters via SIP headers.
330
- * (Only when available and only when using TCP or TLS transport.)
331
- */
332
- isup_headers_enabled?: boolean;
333
- /**
334
- * Enable PRACK messages as defined in RFC3262.
335
- */
336
- prack_enabled?: boolean;
337
- /**
338
- * When enabled the SIP Connection will receive the Identity header with
339
- * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
340
- * transport.
341
- */
342
- shaken_stir_enabled?: boolean;
343
- /**
344
- * When enabled, allows multiple devices to ring simultaneously on incoming calls.
345
- */
346
- simultaneous_ringing?: 'disabled' | 'enabled';
347
- /**
348
- * Defaults to true.
349
- */
350
- sip_compact_headers_enabled?: boolean;
351
- /**
352
- * The Telnyx-generated SIP subdomain for this UAC connection.
353
- */
354
- sip_subdomain?: string;
355
- /**
356
- * Controls which SIP URI callers may reach this connection.
357
- */
358
- sip_subdomain_receive_settings?: 'only_my_connections' | 'from_anyone';
359
- /**
360
- * Time(sec) before aborting if connection is not made.
361
- */
362
- timeout_1xx_secs?: number;
363
- /**
364
- * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
365
- */
366
- timeout_2xx_secs?: number;
367
- }
368
- /**
369
- * Internal Telnyx-side settings for a UAC connection.
370
- */
371
- export interface UacInternalSettings {
372
- /**
373
- * The SIP URI that Telnyx will call when handling an inbound request from the
374
- * external peer. Do not include a `sip:` prefix. The value must be in the format
375
- * `userinfo@<subdomain.>sip.telnyx.com` or
376
- * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
377
- * letters, digits, hyphens, and underscores.
378
- */
379
- destination_uri?: string;
380
- }
381
- export interface UacOutbound {
382
- /**
383
- * Set a phone number as the ani_override value to override caller id number on
384
- * outbound calls.
385
- */
386
- ani_override?: string;
387
- /**
388
- * Specifies when we apply your ani_override setting. Only applies when
389
- * ani_override is not blank.
390
- */
391
- ani_override_type?: 'always' | 'normal' | 'emergency';
392
- /**
393
- * Forces all SIP calls originated on this connection to be "parked" instead of
394
- * "bridged" to the destination specified on the URI. Parked calls will return
395
- * ringback to the caller and will await for a Call Control command to define which
396
- * action will be taken next.
397
- */
398
- call_parking_enabled?: boolean | null;
399
- /**
400
- * When set, this will limit the total number of outbound calls to phone numbers
401
- * associated with this connection.
402
- */
403
- channel_limit?: number;
404
- /**
405
- * Generate ringback tone through 183 session progress message with early media.
406
- */
407
- generate_ringback_tone?: boolean;
408
- /**
409
- * When set, ringback will not wait for indication before sending ringback tone to
410
- * calling party.
411
- */
412
- instant_ringback_enabled?: boolean;
413
- /**
414
- * A 2-character country code specifying the country whose national dialing rules
415
- * should be used. For example, if set to `US` then any US number can be dialed
416
- * without preprending +1 to the number. When left blank, Telnyx will try US and GB
417
- * dialing rules, in that order, by default.
418
- */
419
- localization?: string;
420
- /**
421
- * Identifies the associated outbound voice profile.
422
- */
423
- outbound_voice_profile_id?: string;
424
- /**
425
- * This setting only affects connections with Fax-type Outbound Voice Profiles. The
426
- * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
427
- * default, Telnyx will send the re-invite. If set to `customer`, the caller is
428
- * expected to send the t.38 reinvite.
429
- */
430
- t38_reinvite_source?: 'telnyx' | 'customer' | 'disabled' | 'passthru' | 'caller-passthru' | 'callee-passthru';
431
- }
432
- export interface UacConnectionCreateResponse {
1351
+ export declare namespace UacConnectionListResponse {
433
1352
  /**
434
- * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
435
- * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
436
- * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
437
- * registration.
1353
+ * External SIP peer settings used by Telnyx when registering to your PBX and
1354
+ * routing outbound calls.
438
1355
  */
439
- data?: UacConnection;
440
- }
441
- export interface UacConnectionRetrieveResponse {
1356
+ interface ExternalUacSettings {
1357
+ /**
1358
+ * The authentication username used in SIP digest authentication. If not set, the
1359
+ * Username value will be used.
1360
+ */
1361
+ auth_username?: string | null;
1362
+ /**
1363
+ * The registration interval, in seconds, indicating how often the system refreshes
1364
+ * the SIP registration with the external SIP peer.
1365
+ */
1366
+ expiration_sec?: number | null;
1367
+ /**
1368
+ * The user portion of the SIP From header used in outbound requests. This controls
1369
+ * the caller identity presented to the external SIP peer.
1370
+ */
1371
+ from_user?: string | null;
1372
+ /**
1373
+ * An optional SIP proxy used to route outbound requests before reaching the
1374
+ * external SIP peer.
1375
+ */
1376
+ outbound_proxy?: string | null;
1377
+ /**
1378
+ * The SIP password used for digest authentication with the external SIP peer.
1379
+ */
1380
+ password?: string;
1381
+ /**
1382
+ * The SIP proxy address of the external SIP peer used for registrations and
1383
+ * outbound call routing.
1384
+ */
1385
+ proxy?: string;
1386
+ /**
1387
+ * The transport protocol used for SIP signaling when communicating with the
1388
+ * external SIP peer. One of UDP, TLS, or TCP.
1389
+ */
1390
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
1391
+ /**
1392
+ * The SIP username used to authenticate with the external SIP peer for
1393
+ * registrations and outbound calls. Must start with a letter or number and contain
1394
+ * only letters, numbers, hyphens, and underscores.
1395
+ */
1396
+ username?: string;
1397
+ }
1398
+ interface Inbound {
1399
+ /**
1400
+ * This setting allows you to set the format with which the caller's number (ANI)
1401
+ * is sent for inbound phone calls.
1402
+ */
1403
+ ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
1404
+ /**
1405
+ * When set, this will limit the total number of inbound calls to phone numbers
1406
+ * associated with this connection.
1407
+ */
1408
+ channel_limit?: number;
1409
+ /**
1410
+ * Defines the list of codecs that Telnyx will send for inbound calls to a specific
1411
+ * number on your portal account, in priority order. This only works when the
1412
+ * Connection the number is assigned to uses Media Handling mode: default. OPUS and
1413
+ * H.264 codecs are available only when using TCP or TLS transport for SIP.
1414
+ */
1415
+ codecs?: Array<string>;
1416
+ /**
1417
+ * Default routing method to be used when a number is associated with the
1418
+ * connection. Must be one of the routing method types or left blank, other values
1419
+ * are not allowed.
1420
+ */
1421
+ default_routing_method?: 'sequential' | 'round-robin';
1422
+ dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
1423
+ /**
1424
+ * Generate ringback tone through 183 session progress message with early media.
1425
+ */
1426
+ generate_ringback_tone?: boolean;
1427
+ /**
1428
+ * When set, inbound phone calls will receive ISUP parameters via SIP headers.
1429
+ * (Only when available and only when using TCP or TLS transport.)
1430
+ */
1431
+ isup_headers_enabled?: boolean;
1432
+ /**
1433
+ * Enable PRACK messages as defined in RFC3262.
1434
+ */
1435
+ prack_enabled?: boolean;
1436
+ /**
1437
+ * When enabled the SIP Connection will receive the Identity header with
1438
+ * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
1439
+ * transport.
1440
+ */
1441
+ shaken_stir_enabled?: boolean;
1442
+ /**
1443
+ * When enabled, allows multiple devices to ring simultaneously on incoming calls.
1444
+ */
1445
+ simultaneous_ringing?: 'disabled' | 'enabled';
1446
+ /**
1447
+ * Defaults to true.
1448
+ */
1449
+ sip_compact_headers_enabled?: boolean;
1450
+ /**
1451
+ * The Telnyx-generated SIP subdomain for this UAC connection.
1452
+ */
1453
+ sip_subdomain?: string;
1454
+ /**
1455
+ * Controls which SIP URI callers may reach this connection.
1456
+ */
1457
+ sip_subdomain_receive_settings?: 'only_my_connections' | 'from_anyone';
1458
+ /**
1459
+ * Time(sec) before aborting if connection is not made.
1460
+ */
1461
+ timeout_1xx_secs?: number;
1462
+ /**
1463
+ * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
1464
+ */
1465
+ timeout_2xx_secs?: number;
1466
+ }
442
1467
  /**
443
- * A UAC (User Agent Client) Connection registers Telnyx to your PBX the opposite
444
- * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
445
- * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
446
- * registration.
1468
+ * Internal Telnyx-side settings for a UAC connection.
447
1469
  */
448
- data?: UacConnection;
1470
+ interface InternalUacSettings {
1471
+ /**
1472
+ * The SIP URI that Telnyx will call when handling an inbound request from the
1473
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
1474
+ * `userinfo@<subdomain.>sip.telnyx.com` or
1475
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
1476
+ * letters, digits, hyphens, and underscores.
1477
+ */
1478
+ destination_uri?: string;
1479
+ }
1480
+ interface Outbound {
1481
+ /**
1482
+ * Set a phone number as the ani_override value to override caller id number on
1483
+ * outbound calls.
1484
+ */
1485
+ ani_override?: string;
1486
+ /**
1487
+ * Specifies when we apply your ani_override setting. Only applies when
1488
+ * ani_override is not blank.
1489
+ */
1490
+ ani_override_type?: 'always' | 'normal' | 'emergency';
1491
+ /**
1492
+ * Forces all SIP calls originated on this connection to be "parked" instead of
1493
+ * "bridged" to the destination specified on the URI. Parked calls will return
1494
+ * ringback to the caller and will await for a Call Control command to define which
1495
+ * action will be taken next.
1496
+ */
1497
+ call_parking_enabled?: boolean | null;
1498
+ /**
1499
+ * When set, this will limit the total number of outbound calls to phone numbers
1500
+ * associated with this connection.
1501
+ */
1502
+ channel_limit?: number;
1503
+ /**
1504
+ * Generate ringback tone through 183 session progress message with early media.
1505
+ */
1506
+ generate_ringback_tone?: boolean;
1507
+ /**
1508
+ * When set, ringback will not wait for indication before sending ringback tone to
1509
+ * calling party.
1510
+ */
1511
+ instant_ringback_enabled?: boolean;
1512
+ /**
1513
+ * A 2-character country code specifying the country whose national dialing rules
1514
+ * should be used. For example, if set to `US` then any US number can be dialed
1515
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
1516
+ * dialing rules, in that order, by default.
1517
+ */
1518
+ localization?: string;
1519
+ /**
1520
+ * Identifies the associated outbound voice profile.
1521
+ */
1522
+ outbound_voice_profile_id?: string;
1523
+ /**
1524
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
1525
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
1526
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
1527
+ * expected to send the t.38 reinvite.
1528
+ */
1529
+ t38_reinvite_source?: 'telnyx' | 'customer' | 'disabled' | 'passthru' | 'caller-passthru' | 'callee-passthru';
1530
+ }
449
1531
  }
450
- export interface UacConnectionUpdateResponse {
1532
+ export interface UacConnectionDeleteResponse {
451
1533
  /**
452
1534
  * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
453
1535
  * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
454
1536
  * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
455
1537
  * registration.
456
1538
  */
457
- data?: UacConnection;
1539
+ data?: UacConnectionDeleteResponse.Data;
458
1540
  }
459
- export interface UacConnectionDeleteResponse {
1541
+ export declare namespace UacConnectionDeleteResponse {
460
1542
  /**
461
1543
  * A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
462
1544
  * of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
463
1545
  * PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
464
1546
  * registration.
465
1547
  */
466
- data?: UacConnection;
1548
+ interface Data {
1549
+ /**
1550
+ * Identifies the type of resource.
1551
+ */
1552
+ id?: string;
1553
+ /**
1554
+ * Defaults to true
1555
+ */
1556
+ active?: boolean;
1557
+ /**
1558
+ * `Latency` directs Telnyx to route media through the site with the lowest
1559
+ * round-trip time to the user's connection. Telnyx calculates this time using ICMP
1560
+ * ping messages. This can be disabled by specifying a site to handle all media.
1561
+ */
1562
+ anchorsite_override?: CredentialConnectionsAPI.AnchorsiteOverride;
1563
+ /**
1564
+ * The uuid of the push credential for Android
1565
+ */
1566
+ android_push_credential_id?: string | null;
1567
+ /**
1568
+ * The authentication strategy used by this connection.
1569
+ */
1570
+ authentication?: 'uac-authentication';
1571
+ /**
1572
+ * Specifies if call cost webhooks should be sent for this connection.
1573
+ */
1574
+ call_cost_in_webhooks?: boolean;
1575
+ connection_name?: string;
1576
+ /**
1577
+ * ISO-8601 formatted date indicating when the resource was created.
1578
+ */
1579
+ created_at?: string;
1580
+ /**
1581
+ * When enabled, Telnyx will generate comfort noise when you place the call on
1582
+ * hold. If disabled, you will need to generate comfort noise or on hold music to
1583
+ * avoid RTP timeout.
1584
+ */
1585
+ default_on_hold_comfort_noise_enabled?: boolean;
1586
+ /**
1587
+ * Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
1588
+ * digits sent to Telnyx will be accepted in all formats.
1589
+ */
1590
+ dtmf_type?: CredentialConnectionsAPI.DtmfType;
1591
+ /**
1592
+ * Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
1593
+ * scenarios.
1594
+ */
1595
+ encode_contact_header_enabled?: boolean;
1596
+ /**
1597
+ * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
1598
+ * TLS.
1599
+ */
1600
+ encrypted_media?: CredentialConnectionsAPI.EncryptedMedia | null;
1601
+ /**
1602
+ * External SIP peer settings used by Telnyx when registering to your PBX and
1603
+ * routing outbound calls.
1604
+ */
1605
+ external_uac_settings?: Data.ExternalUacSettings;
1606
+ /**
1607
+ * The Telnyx-managed FQDN generated for the UAC connection.
1608
+ */
1609
+ fqdn?: string;
1610
+ /**
1611
+ * The fixed outbound authentication mode used by UAC FQDN records.
1612
+ */
1613
+ fqdn_outbound_authentication?: 'credential-authentication';
1614
+ /**
1615
+ * FQDN records managed automatically by the UAC connection lifecycle.
1616
+ */
1617
+ fqdns?: Array<FqdnsAPI.Fqdn>;
1618
+ inbound?: Data.Inbound;
1619
+ /**
1620
+ * Internal Telnyx-side settings for a UAC connection.
1621
+ */
1622
+ internal_uac_settings?: Data.InternalUacSettings;
1623
+ /**
1624
+ * The uuid of the push credential for Ios
1625
+ */
1626
+ ios_push_credential_id?: string | null;
1627
+ /**
1628
+ * Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams
1629
+ * of SIP Trunking calls. The feature is off unless enabled. You may define min and
1630
+ * max values in msec for customized buffering behaviors. Larger values add latency
1631
+ * but tolerate more jitter, while smaller values reduce latency but are more
1632
+ * sensitive to jitter and reordering.
1633
+ */
1634
+ jitter_buffer?: Shared.ConnectionJitterBuffer;
1635
+ /**
1636
+ * Controls when noise suppression is applied to calls. When set to 'inbound',
1637
+ * noise suppression is applied to incoming audio. When set to 'outbound', it's
1638
+ * applied to outgoing audio. When set to 'both', it's applied in both directions.
1639
+ * When set to 'disabled', noise suppression is turned off.
1640
+ */
1641
+ noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
1642
+ /**
1643
+ * Configuration options for noise suppression. These settings are stored
1644
+ * regardless of the noise_suppression value, but only take effect when
1645
+ * noise_suppression is not 'disabled'. If you disable noise suppression and later
1646
+ * re-enable it, the previously configured settings will be used.
1647
+ */
1648
+ noise_suppression_details?: Shared.ConnectionNoiseSuppressionDetails;
1649
+ /**
1650
+ * Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
1651
+ * if both are on the Telnyx network. If this is disabled, Telnyx will be able to
1652
+ * use T38 on just one leg of the call depending on each leg's settings.
1653
+ */
1654
+ onnet_t38_passthrough_enabled?: boolean;
1655
+ outbound?: Data.Outbound;
1656
+ /**
1657
+ * The password to be used as part of the credentials. Must be 8 to 128 characters
1658
+ * long.
1659
+ */
1660
+ password?: string;
1661
+ /**
1662
+ * Identifies the type of the resource.
1663
+ */
1664
+ record_type?: string;
1665
+ /**
1666
+ * The most recently known SIP registration status for this UAC connection.
1667
+ */
1668
+ registration_status?: string | null;
1669
+ /**
1670
+ * ISO 8601 formatted date indicating when the registration status was last
1671
+ * updated.
1672
+ */
1673
+ registration_status_updated_at?: string | null;
1674
+ rtcp_settings?: CredentialConnectionsAPI.ConnectionRtcpSettings;
1675
+ /**
1676
+ * This feature enables inbound SIP URI calls to your Credential Auth Connection.
1677
+ * If enabled for all (unrestricted) then anyone who calls the SIP URI
1678
+ * <your-username>@telnyx.com will be connected to your Connection. You can also
1679
+ * choose to allow only calls that are originated on any Connections under your
1680
+ * account (internal).
1681
+ */
1682
+ sip_uri_calling_preference?: 'disabled' | 'unrestricted' | 'internal';
1683
+ /**
1684
+ * Tags associated with the connection.
1685
+ */
1686
+ tags?: Array<string>;
1687
+ /**
1688
+ * ISO-8601 formatted date indicating when the resource was updated.
1689
+ */
1690
+ updated_at?: string;
1691
+ /**
1692
+ * The user name to be used as part of the credentials. Must be 4-32 characters
1693
+ * long and alphanumeric values only (no spaces or special characters). At least
1694
+ * one of the first 5 characters must be a letter.
1695
+ */
1696
+ user_name?: string;
1697
+ /**
1698
+ * Determines which webhook format will be used, Telnyx API v1 or v2.
1699
+ */
1700
+ webhook_api_version?: '1' | '2';
1701
+ /**
1702
+ * The failover URL where webhooks related to this connection will be sent if
1703
+ * sending to the primary URL fails. Must include a scheme, such as 'https'.
1704
+ */
1705
+ webhook_event_failover_url?: string | null;
1706
+ /**
1707
+ * The URL where webhooks related to this connection will be sent. Must include a
1708
+ * scheme, such as 'https'.
1709
+ */
1710
+ webhook_event_url?: string;
1711
+ /**
1712
+ * Specifies how many seconds to wait before timing out a webhook.
1713
+ */
1714
+ webhook_timeout_secs?: number | null;
1715
+ }
1716
+ namespace Data {
1717
+ /**
1718
+ * External SIP peer settings used by Telnyx when registering to your PBX and
1719
+ * routing outbound calls.
1720
+ */
1721
+ interface ExternalUacSettings {
1722
+ /**
1723
+ * The authentication username used in SIP digest authentication. If not set, the
1724
+ * Username value will be used.
1725
+ */
1726
+ auth_username?: string | null;
1727
+ /**
1728
+ * The registration interval, in seconds, indicating how often the system refreshes
1729
+ * the SIP registration with the external SIP peer.
1730
+ */
1731
+ expiration_sec?: number | null;
1732
+ /**
1733
+ * The user portion of the SIP From header used in outbound requests. This controls
1734
+ * the caller identity presented to the external SIP peer.
1735
+ */
1736
+ from_user?: string | null;
1737
+ /**
1738
+ * An optional SIP proxy used to route outbound requests before reaching the
1739
+ * external SIP peer.
1740
+ */
1741
+ outbound_proxy?: string | null;
1742
+ /**
1743
+ * The SIP password used for digest authentication with the external SIP peer.
1744
+ */
1745
+ password?: string;
1746
+ /**
1747
+ * The SIP proxy address of the external SIP peer used for registrations and
1748
+ * outbound call routing.
1749
+ */
1750
+ proxy?: string;
1751
+ /**
1752
+ * The transport protocol used for SIP signaling when communicating with the
1753
+ * external SIP peer. One of UDP, TLS, or TCP.
1754
+ */
1755
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
1756
+ /**
1757
+ * The SIP username used to authenticate with the external SIP peer for
1758
+ * registrations and outbound calls. Must start with a letter or number and contain
1759
+ * only letters, numbers, hyphens, and underscores.
1760
+ */
1761
+ username?: string;
1762
+ }
1763
+ interface Inbound {
1764
+ /**
1765
+ * This setting allows you to set the format with which the caller's number (ANI)
1766
+ * is sent for inbound phone calls.
1767
+ */
1768
+ ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
1769
+ /**
1770
+ * When set, this will limit the total number of inbound calls to phone numbers
1771
+ * associated with this connection.
1772
+ */
1773
+ channel_limit?: number;
1774
+ /**
1775
+ * Defines the list of codecs that Telnyx will send for inbound calls to a specific
1776
+ * number on your portal account, in priority order. This only works when the
1777
+ * Connection the number is assigned to uses Media Handling mode: default. OPUS and
1778
+ * H.264 codecs are available only when using TCP or TLS transport for SIP.
1779
+ */
1780
+ codecs?: Array<string>;
1781
+ /**
1782
+ * Default routing method to be used when a number is associated with the
1783
+ * connection. Must be one of the routing method types or left blank, other values
1784
+ * are not allowed.
1785
+ */
1786
+ default_routing_method?: 'sequential' | 'round-robin';
1787
+ dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
1788
+ /**
1789
+ * Generate ringback tone through 183 session progress message with early media.
1790
+ */
1791
+ generate_ringback_tone?: boolean;
1792
+ /**
1793
+ * When set, inbound phone calls will receive ISUP parameters via SIP headers.
1794
+ * (Only when available and only when using TCP or TLS transport.)
1795
+ */
1796
+ isup_headers_enabled?: boolean;
1797
+ /**
1798
+ * Enable PRACK messages as defined in RFC3262.
1799
+ */
1800
+ prack_enabled?: boolean;
1801
+ /**
1802
+ * When enabled the SIP Connection will receive the Identity header with
1803
+ * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
1804
+ * transport.
1805
+ */
1806
+ shaken_stir_enabled?: boolean;
1807
+ /**
1808
+ * When enabled, allows multiple devices to ring simultaneously on incoming calls.
1809
+ */
1810
+ simultaneous_ringing?: 'disabled' | 'enabled';
1811
+ /**
1812
+ * Defaults to true.
1813
+ */
1814
+ sip_compact_headers_enabled?: boolean;
1815
+ /**
1816
+ * The Telnyx-generated SIP subdomain for this UAC connection.
1817
+ */
1818
+ sip_subdomain?: string;
1819
+ /**
1820
+ * Controls which SIP URI callers may reach this connection.
1821
+ */
1822
+ sip_subdomain_receive_settings?: 'only_my_connections' | 'from_anyone';
1823
+ /**
1824
+ * Time(sec) before aborting if connection is not made.
1825
+ */
1826
+ timeout_1xx_secs?: number;
1827
+ /**
1828
+ * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
1829
+ */
1830
+ timeout_2xx_secs?: number;
1831
+ }
1832
+ /**
1833
+ * Internal Telnyx-side settings for a UAC connection.
1834
+ */
1835
+ interface InternalUacSettings {
1836
+ /**
1837
+ * The SIP URI that Telnyx will call when handling an inbound request from the
1838
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
1839
+ * `userinfo@<subdomain.>sip.telnyx.com` or
1840
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
1841
+ * letters, digits, hyphens, and underscores.
1842
+ */
1843
+ destination_uri?: string;
1844
+ }
1845
+ interface Outbound {
1846
+ /**
1847
+ * Set a phone number as the ani_override value to override caller id number on
1848
+ * outbound calls.
1849
+ */
1850
+ ani_override?: string;
1851
+ /**
1852
+ * Specifies when we apply your ani_override setting. Only applies when
1853
+ * ani_override is not blank.
1854
+ */
1855
+ ani_override_type?: 'always' | 'normal' | 'emergency';
1856
+ /**
1857
+ * Forces all SIP calls originated on this connection to be "parked" instead of
1858
+ * "bridged" to the destination specified on the URI. Parked calls will return
1859
+ * ringback to the caller and will await for a Call Control command to define which
1860
+ * action will be taken next.
1861
+ */
1862
+ call_parking_enabled?: boolean | null;
1863
+ /**
1864
+ * When set, this will limit the total number of outbound calls to phone numbers
1865
+ * associated with this connection.
1866
+ */
1867
+ channel_limit?: number;
1868
+ /**
1869
+ * Generate ringback tone through 183 session progress message with early media.
1870
+ */
1871
+ generate_ringback_tone?: boolean;
1872
+ /**
1873
+ * When set, ringback will not wait for indication before sending ringback tone to
1874
+ * calling party.
1875
+ */
1876
+ instant_ringback_enabled?: boolean;
1877
+ /**
1878
+ * A 2-character country code specifying the country whose national dialing rules
1879
+ * should be used. For example, if set to `US` then any US number can be dialed
1880
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
1881
+ * dialing rules, in that order, by default.
1882
+ */
1883
+ localization?: string;
1884
+ /**
1885
+ * Identifies the associated outbound voice profile.
1886
+ */
1887
+ outbound_voice_profile_id?: string;
1888
+ /**
1889
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
1890
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
1891
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
1892
+ * expected to send the t.38 reinvite.
1893
+ */
1894
+ t38_reinvite_source?: 'telnyx' | 'customer' | 'disabled' | 'passthru' | 'caller-passthru' | 'callee-passthru';
1895
+ }
1896
+ }
467
1897
  }
468
1898
  export interface UacConnectionCreateParams {
469
1899
  /**
@@ -513,7 +1943,7 @@ export interface UacConnectionCreateParams {
513
1943
  * External SIP peer settings used by Telnyx when registering to your PBX and
514
1944
  * routing outbound calls.
515
1945
  */
516
- external_uac_settings?: UacExternalSettings;
1946
+ external_uac_settings?: UacConnectionCreateParams.ExternalUacSettings;
517
1947
  /**
518
1948
  * Inbound settings that can be supplied when creating or updating a UAC
519
1949
  * connection. The SIP subdomain fields returned in UAC connection responses are
@@ -523,7 +1953,7 @@ export interface UacConnectionCreateParams {
523
1953
  /**
524
1954
  * Internal Telnyx-side settings for a UAC connection.
525
1955
  */
526
- internal_uac_settings?: UacInternalSettings;
1956
+ internal_uac_settings?: UacConnectionCreateParams.InternalUacSettings;
527
1957
  /**
528
1958
  * The uuid of the push credential for Ios
529
1959
  */
@@ -556,7 +1986,7 @@ export interface UacConnectionCreateParams {
556
1986
  * use T38 on just one leg of the call depending on each leg's settings.
557
1987
  */
558
1988
  onnet_t38_passthrough_enabled?: boolean;
559
- outbound?: UacOutbound;
1989
+ outbound?: UacConnectionCreateParams.Outbound;
560
1990
  /**
561
1991
  * The password to be used as part of the credentials. Must be 8 to 128 characters
562
1992
  * long.
@@ -602,6 +2032,52 @@ export interface UacConnectionCreateParams {
602
2032
  webhook_timeout_secs?: number | null;
603
2033
  }
604
2034
  export declare namespace UacConnectionCreateParams {
2035
+ /**
2036
+ * External SIP peer settings used by Telnyx when registering to your PBX and
2037
+ * routing outbound calls.
2038
+ */
2039
+ interface ExternalUacSettings {
2040
+ /**
2041
+ * The authentication username used in SIP digest authentication. If not set, the
2042
+ * Username value will be used.
2043
+ */
2044
+ auth_username?: string | null;
2045
+ /**
2046
+ * The registration interval, in seconds, indicating how often the system refreshes
2047
+ * the SIP registration with the external SIP peer.
2048
+ */
2049
+ expiration_sec?: number | null;
2050
+ /**
2051
+ * The user portion of the SIP From header used in outbound requests. This controls
2052
+ * the caller identity presented to the external SIP peer.
2053
+ */
2054
+ from_user?: string | null;
2055
+ /**
2056
+ * An optional SIP proxy used to route outbound requests before reaching the
2057
+ * external SIP peer.
2058
+ */
2059
+ outbound_proxy?: string | null;
2060
+ /**
2061
+ * The SIP password used for digest authentication with the external SIP peer.
2062
+ */
2063
+ password?: string;
2064
+ /**
2065
+ * The SIP proxy address of the external SIP peer used for registrations and
2066
+ * outbound call routing.
2067
+ */
2068
+ proxy?: string;
2069
+ /**
2070
+ * The transport protocol used for SIP signaling when communicating with the
2071
+ * external SIP peer. One of UDP, TLS, or TCP.
2072
+ */
2073
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
2074
+ /**
2075
+ * The SIP username used to authenticate with the external SIP peer for
2076
+ * registrations and outbound calls. Must start with a letter or number and contain
2077
+ * only letters, numbers, hyphens, and underscores.
2078
+ */
2079
+ username?: string;
2080
+ }
605
2081
  /**
606
2082
  * Inbound settings that can be supplied when creating or updating a UAC
607
2083
  * connection. The SIP subdomain fields returned in UAC connection responses are
@@ -668,6 +2144,70 @@ export declare namespace UacConnectionCreateParams {
668
2144
  */
669
2145
  timeout_2xx_secs?: number;
670
2146
  }
2147
+ /**
2148
+ * Internal Telnyx-side settings for a UAC connection.
2149
+ */
2150
+ interface InternalUacSettings {
2151
+ /**
2152
+ * The SIP URI that Telnyx will call when handling an inbound request from the
2153
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
2154
+ * `userinfo@<subdomain.>sip.telnyx.com` or
2155
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
2156
+ * letters, digits, hyphens, and underscores.
2157
+ */
2158
+ destination_uri?: string;
2159
+ }
2160
+ interface Outbound {
2161
+ /**
2162
+ * Set a phone number as the ani_override value to override caller id number on
2163
+ * outbound calls.
2164
+ */
2165
+ ani_override?: string;
2166
+ /**
2167
+ * Specifies when we apply your ani_override setting. Only applies when
2168
+ * ani_override is not blank.
2169
+ */
2170
+ ani_override_type?: 'always' | 'normal' | 'emergency';
2171
+ /**
2172
+ * Forces all SIP calls originated on this connection to be "parked" instead of
2173
+ * "bridged" to the destination specified on the URI. Parked calls will return
2174
+ * ringback to the caller and will await for a Call Control command to define which
2175
+ * action will be taken next.
2176
+ */
2177
+ call_parking_enabled?: boolean | null;
2178
+ /**
2179
+ * When set, this will limit the total number of outbound calls to phone numbers
2180
+ * associated with this connection.
2181
+ */
2182
+ channel_limit?: number;
2183
+ /**
2184
+ * Generate ringback tone through 183 session progress message with early media.
2185
+ */
2186
+ generate_ringback_tone?: boolean;
2187
+ /**
2188
+ * When set, ringback will not wait for indication before sending ringback tone to
2189
+ * calling party.
2190
+ */
2191
+ instant_ringback_enabled?: boolean;
2192
+ /**
2193
+ * A 2-character country code specifying the country whose national dialing rules
2194
+ * should be used. For example, if set to `US` then any US number can be dialed
2195
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
2196
+ * dialing rules, in that order, by default.
2197
+ */
2198
+ localization?: string;
2199
+ /**
2200
+ * Identifies the associated outbound voice profile.
2201
+ */
2202
+ outbound_voice_profile_id?: string;
2203
+ /**
2204
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
2205
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
2206
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
2207
+ * expected to send the t.38 reinvite.
2208
+ */
2209
+ t38_reinvite_source?: 'telnyx' | 'customer' | 'disabled' | 'passthru' | 'caller-passthru' | 'callee-passthru';
2210
+ }
671
2211
  }
672
2212
  export interface UacConnectionUpdateParams {
673
2213
  /**
@@ -717,7 +2257,7 @@ export interface UacConnectionUpdateParams {
717
2257
  * External SIP peer settings used by Telnyx when registering to your PBX and
718
2258
  * routing outbound calls.
719
2259
  */
720
- external_uac_settings?: UacExternalSettings;
2260
+ external_uac_settings?: UacConnectionUpdateParams.ExternalUacSettings;
721
2261
  /**
722
2262
  * Inbound settings that can be supplied when creating or updating a UAC
723
2263
  * connection. The SIP subdomain fields returned in UAC connection responses are
@@ -727,7 +2267,7 @@ export interface UacConnectionUpdateParams {
727
2267
  /**
728
2268
  * Internal Telnyx-side settings for a UAC connection.
729
2269
  */
730
- internal_uac_settings?: UacInternalSettings;
2270
+ internal_uac_settings?: UacConnectionUpdateParams.InternalUacSettings;
731
2271
  /**
732
2272
  * The uuid of the push credential for Ios
733
2273
  */
@@ -760,7 +2300,7 @@ export interface UacConnectionUpdateParams {
760
2300
  * use T38 on just one leg of the call depending on each leg's settings.
761
2301
  */
762
2302
  onnet_t38_passthrough_enabled?: boolean;
763
- outbound?: UacOutbound;
2303
+ outbound?: UacConnectionUpdateParams.Outbound;
764
2304
  /**
765
2305
  * The password to be used as part of the credentials. Must be 8 to 128 characters
766
2306
  * long.
@@ -804,6 +2344,52 @@ export interface UacConnectionUpdateParams {
804
2344
  webhook_timeout_secs?: number | null;
805
2345
  }
806
2346
  export declare namespace UacConnectionUpdateParams {
2347
+ /**
2348
+ * External SIP peer settings used by Telnyx when registering to your PBX and
2349
+ * routing outbound calls.
2350
+ */
2351
+ interface ExternalUacSettings {
2352
+ /**
2353
+ * The authentication username used in SIP digest authentication. If not set, the
2354
+ * Username value will be used.
2355
+ */
2356
+ auth_username?: string | null;
2357
+ /**
2358
+ * The registration interval, in seconds, indicating how often the system refreshes
2359
+ * the SIP registration with the external SIP peer.
2360
+ */
2361
+ expiration_sec?: number | null;
2362
+ /**
2363
+ * The user portion of the SIP From header used in outbound requests. This controls
2364
+ * the caller identity presented to the external SIP peer.
2365
+ */
2366
+ from_user?: string | null;
2367
+ /**
2368
+ * An optional SIP proxy used to route outbound requests before reaching the
2369
+ * external SIP peer.
2370
+ */
2371
+ outbound_proxy?: string | null;
2372
+ /**
2373
+ * The SIP password used for digest authentication with the external SIP peer.
2374
+ */
2375
+ password?: string;
2376
+ /**
2377
+ * The SIP proxy address of the external SIP peer used for registrations and
2378
+ * outbound call routing.
2379
+ */
2380
+ proxy?: string;
2381
+ /**
2382
+ * The transport protocol used for SIP signaling when communicating with the
2383
+ * external SIP peer. One of UDP, TLS, or TCP.
2384
+ */
2385
+ transport?: 'UDP' | 'TLS' | 'TCP' | null;
2386
+ /**
2387
+ * The SIP username used to authenticate with the external SIP peer for
2388
+ * registrations and outbound calls. Must start with a letter or number and contain
2389
+ * only letters, numbers, hyphens, and underscores.
2390
+ */
2391
+ username?: string;
2392
+ }
807
2393
  /**
808
2394
  * Inbound settings that can be supplied when creating or updating a UAC
809
2395
  * connection. The SIP subdomain fields returned in UAC connection responses are
@@ -870,6 +2456,70 @@ export declare namespace UacConnectionUpdateParams {
870
2456
  */
871
2457
  timeout_2xx_secs?: number;
872
2458
  }
2459
+ /**
2460
+ * Internal Telnyx-side settings for a UAC connection.
2461
+ */
2462
+ interface InternalUacSettings {
2463
+ /**
2464
+ * The SIP URI that Telnyx will call when handling an inbound request from the
2465
+ * external peer. Do not include a `sip:` prefix. The value must be in the format
2466
+ * `userinfo@<subdomain.>sip.telnyx.com` or
2467
+ * `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
2468
+ * letters, digits, hyphens, and underscores.
2469
+ */
2470
+ destination_uri?: string;
2471
+ }
2472
+ interface Outbound {
2473
+ /**
2474
+ * Set a phone number as the ani_override value to override caller id number on
2475
+ * outbound calls.
2476
+ */
2477
+ ani_override?: string;
2478
+ /**
2479
+ * Specifies when we apply your ani_override setting. Only applies when
2480
+ * ani_override is not blank.
2481
+ */
2482
+ ani_override_type?: 'always' | 'normal' | 'emergency';
2483
+ /**
2484
+ * Forces all SIP calls originated on this connection to be "parked" instead of
2485
+ * "bridged" to the destination specified on the URI. Parked calls will return
2486
+ * ringback to the caller and will await for a Call Control command to define which
2487
+ * action will be taken next.
2488
+ */
2489
+ call_parking_enabled?: boolean | null;
2490
+ /**
2491
+ * When set, this will limit the total number of outbound calls to phone numbers
2492
+ * associated with this connection.
2493
+ */
2494
+ channel_limit?: number;
2495
+ /**
2496
+ * Generate ringback tone through 183 session progress message with early media.
2497
+ */
2498
+ generate_ringback_tone?: boolean;
2499
+ /**
2500
+ * When set, ringback will not wait for indication before sending ringback tone to
2501
+ * calling party.
2502
+ */
2503
+ instant_ringback_enabled?: boolean;
2504
+ /**
2505
+ * A 2-character country code specifying the country whose national dialing rules
2506
+ * should be used. For example, if set to `US` then any US number can be dialed
2507
+ * without preprending +1 to the number. When left blank, Telnyx will try US and GB
2508
+ * dialing rules, in that order, by default.
2509
+ */
2510
+ localization?: string;
2511
+ /**
2512
+ * Identifies the associated outbound voice profile.
2513
+ */
2514
+ outbound_voice_profile_id?: string;
2515
+ /**
2516
+ * This setting only affects connections with Fax-type Outbound Voice Profiles. The
2517
+ * setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
2518
+ * default, Telnyx will send the re-invite. If set to `customer`, the caller is
2519
+ * expected to send the t.38 reinvite.
2520
+ */
2521
+ t38_reinvite_source?: 'telnyx' | 'customer' | 'disabled' | 'passthru' | 'caller-passthru' | 'callee-passthru';
2522
+ }
873
2523
  }
874
2524
  export interface UacConnectionListParams extends DefaultFlatPaginationParams {
875
2525
  /**
@@ -932,7 +2582,7 @@ export declare namespace UacConnectionListParams {
932
2582
  }
933
2583
  }
934
2584
  export declare namespace UacConnections {
935
- export { type UacConnection as UacConnection, type UacExternalSettings as UacExternalSettings, type UacInbound as UacInbound, type UacInternalSettings as UacInternalSettings, type UacOutbound as UacOutbound, type UacConnectionCreateResponse as UacConnectionCreateResponse, type UacConnectionRetrieveResponse as UacConnectionRetrieveResponse, type UacConnectionUpdateResponse as UacConnectionUpdateResponse, type UacConnectionDeleteResponse as UacConnectionDeleteResponse, type UacConnectionsDefaultFlatPagination as UacConnectionsDefaultFlatPagination, type UacConnectionCreateParams as UacConnectionCreateParams, type UacConnectionUpdateParams as UacConnectionUpdateParams, type UacConnectionListParams as UacConnectionListParams, };
2585
+ export { type UacConnectionCreateResponse as UacConnectionCreateResponse, type UacConnectionRetrieveResponse as UacConnectionRetrieveResponse, type UacConnectionUpdateResponse as UacConnectionUpdateResponse, type UacConnectionListResponse as UacConnectionListResponse, type UacConnectionDeleteResponse as UacConnectionDeleteResponse, type UacConnectionListResponsesDefaultFlatPagination as UacConnectionListResponsesDefaultFlatPagination, type UacConnectionCreateParams as UacConnectionCreateParams, type UacConnectionUpdateParams as UacConnectionUpdateParams, type UacConnectionListParams as UacConnectionListParams, };
936
2586
  export { Actions as Actions, type ActionCheckRegistrationStatusResponse as ActionCheckRegistrationStatusResponse, };
937
2587
  }
938
2588
  //# sourceMappingURL=uac-connections.d.mts.map