telnyx 6.63.0 → 6.64.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 6.64.0 (2026-05-13)
4
+
5
+ Full Changelog: [v6.63.0...v6.64.0](https://github.com/team-telnyx/telnyx-node/compare/v6.63.0...v6.64.0)
6
+
7
+ ### Features
8
+
9
+ * Document AI call status callback overrides ([ca76a36](https://github.com/team-telnyx/telnyx-node/commit/ca76a369e14b3a15608ef74ed4d094eb99e7d9c0))
10
+
3
11
  ## 6.63.0 (2026-05-11)
4
12
 
5
13
  Full Changelog: [v6.62.0...v6.63.0](https://github.com/team-telnyx/telnyx-node/compare/v6.62.0...v6.63.0)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "telnyx",
3
- "version": "6.63.0",
3
+ "version": "6.64.0",
4
4
  "description": "Telnyx API SDK for global Voice, SMS, MMS, WhatsApp, Fax, Wireless IoT, SIP Trunking, and Call Control.",
5
5
  "author": "Telnyx <support@telnyx.com>",
6
6
  "types": "./index.d.ts",
@@ -14,6 +14,17 @@ export declare class Texml extends APIResource {
14
14
  * client state, and calls the dial API. The Twiml, Texml, and Url parameters are
15
15
  * not allowed and will result in a 422 error.
16
16
  *
17
+ * **Expected callback events:**
18
+ *
19
+ * Status callbacks: `initiated`, `ringing`, `answered`, one terminal status
20
+ * (`completed`, `no-answer`, `busy`, `canceled`, or `failed`), then `analyzed`
21
+ * after post-call processing completes.
22
+ *
23
+ * Conversation callbacks: `conversation_created` and `conversation_ended`.
24
+ *
25
+ * Recording, AMD, transcription, and deepfake detection callbacks are only sent
26
+ * when those features are enabled.
27
+ *
17
28
  * @example
18
29
  * ```ts
19
30
  * const response = await client.texml.initiateAICall(
@@ -105,15 +116,17 @@ export interface TexmlInitiateAICallParams {
105
116
  */
106
117
  CallerId?: string;
107
118
  /**
108
- * URL destination for Telnyx to send conversation callback events to.
119
+ * URL destination for Telnyx to send AI conversation callback events for this
120
+ * call. Events include `conversation_created` and `conversation_ended`.
109
121
  */
110
122
  ConversationCallback?: string;
111
123
  /**
112
- * HTTP request type used for `ConversationCallback`.
124
+ * HTTP request type used for `ConversationCallback` and `ConversationCallbacks`.
113
125
  */
114
126
  ConversationCallbackMethod?: 'GET' | 'POST';
115
127
  /**
116
- * An array of URL destinations for conversation callback events.
128
+ * Array of URL destinations for AI conversation callback events for this call.
129
+ * Events include `conversation_created` and `conversation_ended`.
117
130
  */
118
131
  ConversationCallbacks?: Array<string>;
119
132
  /**
@@ -205,22 +218,29 @@ export interface TexmlInitiateAICallParams {
205
218
  */
206
219
  SipRegion?: 'US' | 'Europe' | 'Canada' | 'Australia' | 'Middle East';
207
220
  /**
208
- * URL destination for Telnyx to send status callback events to for the call.
221
+ * URL destination for Telnyx to send status callback events for this AI call. When
222
+ * provided, this per-call value overrides the status callback URL configured on
223
+ * the TeXML application/connection.
209
224
  */
210
225
  StatusCallback?: string;
211
226
  /**
212
- * The call events for which Telnyx should send a webhook. Multiple events can be
213
- * defined when separated by a space. Valid values: initiated, ringing, answered,
214
- * completed.
227
+ * The status callback events for which Telnyx should send a webhook for this AI
228
+ * call. Multiple events can be defined when separated by a space. Valid values:
229
+ * initiated, ringing, answered, completed, no-answer, busy, canceled, failed,
230
+ * analyzed. When provided, this per-call value overrides the status callback
231
+ * events configured on the TeXML application/connection.
215
232
  */
216
233
  StatusCallbackEvent?: string;
217
234
  /**
218
- * HTTP request type used for `StatusCallback`.
235
+ * HTTP request type used for `StatusCallback` and `StatusCallbacks` for this AI
236
+ * call. When provided, this per-call value overrides the status callback method
237
+ * configured on the TeXML application/connection.
219
238
  */
220
239
  StatusCallbackMethod?: 'GET' | 'POST';
221
240
  /**
222
- * An array of URL destinations for Telnyx to send status callback events to for
223
- * the call.
241
+ * Array of URL destinations for Telnyx to send status callback events for this AI
242
+ * call. When provided, these per-call values override the status callback URL
243
+ * configured on the TeXML application/connection.
224
244
  */
225
245
  StatusCallbacks?: Array<string>;
226
246
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"texml.d.mts","sourceRoot":"","sources":["../../src/resources/texml/texml.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,mCAAmC,EACnC,qCAAqC,EACrC,uCAAuC,EACvC,yCAAyC,EACzC,QAAQ,EACR,iCAAiC,EACjC,8BAA8B,EAC/B;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,CACZ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAQ1C;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG9F;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,oBAAoB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,KAAK,CAAC,EAAE,UAAU,CAAC;KACpB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,2BAA2B,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAExD;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,4BAA4B,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE9C;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,0BAA0B,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE5C;;OAEG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC;IAE9D;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAEtC;;OAEG;IACH,gBAAgB,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,kBAAkB,CAAC;IAE7D;;;OAGG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IAExC;;;OAGG;IACH,kCAAkC,CAAC,EAAE,MAAM,CAAC;IAE5C;;;OAGG;IACH,+BAA+B,CAAC,EAAE,MAAM,CAAC;IAEzC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEpC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,6BAA6B,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE/C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,cAAc,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;IAEjD;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,QAAQ,GAAG,QAAQ,GAAG,WAAW,GAAG,aAAa,CAAC;IAErE;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEtC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,aAAa,CAAC;CACvC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,YAAY;QAC3B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,uCAAuC,IAAI,uCAAuC,GACxF,CAAC;CACH"}
1
+ {"version":3,"file":"texml.d.mts","sourceRoot":"","sources":["../../src/resources/texml/texml.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,mCAAmC,EACnC,qCAAqC,EACrC,uCAAuC,EACvC,yCAAyC,EACzC,QAAQ,EACR,iCAAiC,EACjC,8BAA8B,EAC/B;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,cAAc,CACZ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAQ1C;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG9F;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,oBAAoB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,KAAK,CAAC,EAAE,UAAU,CAAC;KACpB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,2BAA2B,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAExD;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,4BAA4B,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE9C;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,0BAA0B,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE5C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC;IAE9D;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAEtC;;OAEG;IACH,gBAAgB,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,kBAAkB,CAAC;IAE7D;;;OAGG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IAExC;;;OAGG;IACH,kCAAkC,CAAC,EAAE,MAAM,CAAC;IAE5C;;;OAGG;IACH,+BAA+B,CAAC,EAAE,MAAM,CAAC;IAEzC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEpC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,6BAA6B,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE/C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,cAAc,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;IAEjD;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,QAAQ,GAAG,QAAQ,GAAG,WAAW,GAAG,aAAa,CAAC;IAErE;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEtC;;;;OAIG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,aAAa,CAAC;CACvC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,YAAY;QAC3B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,uCAAuC,IAAI,uCAAuC,GACxF,CAAC;CACH"}
@@ -14,6 +14,17 @@ export declare class Texml extends APIResource {
14
14
  * client state, and calls the dial API. The Twiml, Texml, and Url parameters are
15
15
  * not allowed and will result in a 422 error.
16
16
  *
17
+ * **Expected callback events:**
18
+ *
19
+ * Status callbacks: `initiated`, `ringing`, `answered`, one terminal status
20
+ * (`completed`, `no-answer`, `busy`, `canceled`, or `failed`), then `analyzed`
21
+ * after post-call processing completes.
22
+ *
23
+ * Conversation callbacks: `conversation_created` and `conversation_ended`.
24
+ *
25
+ * Recording, AMD, transcription, and deepfake detection callbacks are only sent
26
+ * when those features are enabled.
27
+ *
17
28
  * @example
18
29
  * ```ts
19
30
  * const response = await client.texml.initiateAICall(
@@ -105,15 +116,17 @@ export interface TexmlInitiateAICallParams {
105
116
  */
106
117
  CallerId?: string;
107
118
  /**
108
- * URL destination for Telnyx to send conversation callback events to.
119
+ * URL destination for Telnyx to send AI conversation callback events for this
120
+ * call. Events include `conversation_created` and `conversation_ended`.
109
121
  */
110
122
  ConversationCallback?: string;
111
123
  /**
112
- * HTTP request type used for `ConversationCallback`.
124
+ * HTTP request type used for `ConversationCallback` and `ConversationCallbacks`.
113
125
  */
114
126
  ConversationCallbackMethod?: 'GET' | 'POST';
115
127
  /**
116
- * An array of URL destinations for conversation callback events.
128
+ * Array of URL destinations for AI conversation callback events for this call.
129
+ * Events include `conversation_created` and `conversation_ended`.
117
130
  */
118
131
  ConversationCallbacks?: Array<string>;
119
132
  /**
@@ -205,22 +218,29 @@ export interface TexmlInitiateAICallParams {
205
218
  */
206
219
  SipRegion?: 'US' | 'Europe' | 'Canada' | 'Australia' | 'Middle East';
207
220
  /**
208
- * URL destination for Telnyx to send status callback events to for the call.
221
+ * URL destination for Telnyx to send status callback events for this AI call. When
222
+ * provided, this per-call value overrides the status callback URL configured on
223
+ * the TeXML application/connection.
209
224
  */
210
225
  StatusCallback?: string;
211
226
  /**
212
- * The call events for which Telnyx should send a webhook. Multiple events can be
213
- * defined when separated by a space. Valid values: initiated, ringing, answered,
214
- * completed.
227
+ * The status callback events for which Telnyx should send a webhook for this AI
228
+ * call. Multiple events can be defined when separated by a space. Valid values:
229
+ * initiated, ringing, answered, completed, no-answer, busy, canceled, failed,
230
+ * analyzed. When provided, this per-call value overrides the status callback
231
+ * events configured on the TeXML application/connection.
215
232
  */
216
233
  StatusCallbackEvent?: string;
217
234
  /**
218
- * HTTP request type used for `StatusCallback`.
235
+ * HTTP request type used for `StatusCallback` and `StatusCallbacks` for this AI
236
+ * call. When provided, this per-call value overrides the status callback method
237
+ * configured on the TeXML application/connection.
219
238
  */
220
239
  StatusCallbackMethod?: 'GET' | 'POST';
221
240
  /**
222
- * An array of URL destinations for Telnyx to send status callback events to for
223
- * the call.
241
+ * Array of URL destinations for Telnyx to send status callback events for this AI
242
+ * call. When provided, these per-call values override the status callback URL
243
+ * configured on the TeXML application/connection.
224
244
  */
225
245
  StatusCallbacks?: Array<string>;
226
246
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"texml.d.ts","sourceRoot":"","sources":["../../src/resources/texml/texml.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,mCAAmC,EACnC,qCAAqC,EACrC,uCAAuC,EACvC,yCAAyC,EACzC,QAAQ,EACR,iCAAiC,EACjC,8BAA8B,EAC/B;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,CACZ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAQ1C;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG9F;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,oBAAoB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,KAAK,CAAC,EAAE,UAAU,CAAC;KACpB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,2BAA2B,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAExD;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,4BAA4B,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE9C;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,0BAA0B,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE5C;;OAEG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC;IAE9D;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAEtC;;OAEG;IACH,gBAAgB,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,kBAAkB,CAAC;IAE7D;;;OAGG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IAExC;;;OAGG;IACH,kCAAkC,CAAC,EAAE,MAAM,CAAC;IAE5C;;;OAGG;IACH,+BAA+B,CAAC,EAAE,MAAM,CAAC;IAEzC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEpC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,6BAA6B,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE/C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,cAAc,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;IAEjD;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,QAAQ,GAAG,QAAQ,GAAG,WAAW,GAAG,aAAa,CAAC;IAErE;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEtC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,aAAa,CAAC;CACvC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,YAAY;QAC3B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,uCAAuC,IAAI,uCAAuC,GACxF,CAAC;CACH"}
1
+ {"version":3,"file":"texml.d.ts","sourceRoot":"","sources":["../../src/resources/texml/texml.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,mCAAmC,EACnC,qCAAqC,EACrC,uCAAuC,EACvC,yCAAyC,EACzC,QAAQ,EACR,iCAAiC,EACjC,8BAA8B,EAC/B;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,cAAc,CACZ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAQ1C;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG9F;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,oBAAoB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,KAAK,CAAC,EAAE,UAAU,CAAC;KACpB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,2BAA2B,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAExD;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,4BAA4B,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE9C;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,0BAA0B,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE5C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC;IAE9D;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAEtC;;OAEG;IACH,gBAAgB,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,kBAAkB,CAAC;IAE7D;;;OAGG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IAExC;;;OAGG;IACH,kCAAkC,CAAC,EAAE,MAAM,CAAC;IAE5C;;;OAGG;IACH,+BAA+B,CAAC,EAAE,MAAM,CAAC;IAEzC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEpC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,6BAA6B,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE/C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,cAAc,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;IAEjD;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,QAAQ,GAAG,QAAQ,GAAG,WAAW,GAAG,aAAa,CAAC;IAErE;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEtC;;;;OAIG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,aAAa,CAAC;CACvC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,YAAY;QAC3B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,uCAAuC,IAAI,uCAAuC,GACxF,CAAC;CACH"}
@@ -21,6 +21,17 @@ class Texml extends resource_1.APIResource {
21
21
  * client state, and calls the dial API. The Twiml, Texml, and Url parameters are
22
22
  * not allowed and will result in a 422 error.
23
23
  *
24
+ * **Expected callback events:**
25
+ *
26
+ * Status callbacks: `initiated`, `ringing`, `answered`, one terminal status
27
+ * (`completed`, `no-answer`, `busy`, `canceled`, or `failed`), then `analyzed`
28
+ * after post-call processing completes.
29
+ *
30
+ * Conversation callbacks: `conversation_created` and `conversation_ended`.
31
+ *
32
+ * Recording, AMD, transcription, and deepfake detection callbacks are only sent
33
+ * when those features are enabled.
34
+ *
24
35
  * @example
25
36
  * ```ts
26
37
  * const response = await client.texml.initiateAICall(
@@ -1 +1 @@
1
- {"version":3,"file":"texml.js","sourceRoot":"","sources":["../../src/resources/texml/texml.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,4EAAmD;AACnD,qDAQ6B;AAG7B,uDAAiD;AAEjD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkD1E,CAAC;IAhDC;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,CACZ,YAAoB,EACpB,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,mBAAmB,YAAY,EAAE,EAAE;YAC9D,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE;YAC3C,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,IAAwB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AAnDD,sBAmDC;AA6QD,KAAK,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}
1
+ {"version":3,"file":"texml.js","sourceRoot":"","sources":["../../src/resources/texml/texml.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,4EAAmD;AACnD,qDAQ6B;AAG7B,uDAAiD;AAEjD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA6D1E,CAAC;IA3DC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,cAAc,CACZ,YAAoB,EACpB,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,mBAAmB,YAAY,EAAE,EAAE;YAC9D,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE;YAC3C,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,IAAwB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AA9DD,sBA8DC;AAsRD,KAAK,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}
@@ -17,6 +17,17 @@ export class Texml extends APIResource {
17
17
  * client state, and calls the dial API. The Twiml, Texml, and Url parameters are
18
18
  * not allowed and will result in a 422 error.
19
19
  *
20
+ * **Expected callback events:**
21
+ *
22
+ * Status callbacks: `initiated`, `ringing`, `answered`, one terminal status
23
+ * (`completed`, `no-answer`, `busy`, `canceled`, or `failed`), then `analyzed`
24
+ * after post-call processing completes.
25
+ *
26
+ * Conversation callbacks: `conversation_created` and `conversation_ended`.
27
+ *
28
+ * Recording, AMD, transcription, and deepfake detection callbacks are only sent
29
+ * when those features are enabled.
30
+ *
20
31
  * @example
21
32
  * ```ts
22
33
  * const response = await client.texml.initiateAICall(
@@ -1 +1 @@
1
- {"version":3,"file":"texml.mjs","sourceRoot":"","sources":["../../src/resources/texml/texml.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAKL,QAAQ,GAGT;OAGM,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkD1E,CAAC;IAhDC;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,CACZ,YAAoB,EACpB,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,mBAAmB,YAAY,EAAE,EAAE;YAC9D,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE;YAC3C,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,IAAwB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AA6QD,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC"}
1
+ {"version":3,"file":"texml.mjs","sourceRoot":"","sources":["../../src/resources/texml/texml.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAKL,QAAQ,GAGT;OAGM,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA6D1E,CAAC;IA3DC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,cAAc,CACZ,YAAoB,EACpB,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,mBAAmB,YAAY,EAAE,EAAE;YAC9D,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE;YAC3C,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,IAAwB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AAsRD,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC"}
@@ -27,6 +27,17 @@ export class Texml extends APIResource {
27
27
  * client state, and calls the dial API. The Twiml, Texml, and Url parameters are
28
28
  * not allowed and will result in a 422 error.
29
29
  *
30
+ * **Expected callback events:**
31
+ *
32
+ * Status callbacks: `initiated`, `ringing`, `answered`, one terminal status
33
+ * (`completed`, `no-answer`, `busy`, `canceled`, or `failed`), then `analyzed`
34
+ * after post-call processing completes.
35
+ *
36
+ * Conversation callbacks: `conversation_created` and `conversation_ended`.
37
+ *
38
+ * Recording, AMD, transcription, and deepfake detection callbacks are only sent
39
+ * when those features are enabled.
40
+ *
30
41
  * @example
31
42
  * ```ts
32
43
  * const response = await client.texml.initiateAICall(
@@ -146,17 +157,19 @@ export interface TexmlInitiateAICallParams {
146
157
  CallerId?: string;
147
158
 
148
159
  /**
149
- * URL destination for Telnyx to send conversation callback events to.
160
+ * URL destination for Telnyx to send AI conversation callback events for this
161
+ * call. Events include `conversation_created` and `conversation_ended`.
150
162
  */
151
163
  ConversationCallback?: string;
152
164
 
153
165
  /**
154
- * HTTP request type used for `ConversationCallback`.
166
+ * HTTP request type used for `ConversationCallback` and `ConversationCallbacks`.
155
167
  */
156
168
  ConversationCallbackMethod?: 'GET' | 'POST';
157
169
 
158
170
  /**
159
- * An array of URL destinations for conversation callback events.
171
+ * Array of URL destinations for AI conversation callback events for this call.
172
+ * Events include `conversation_created` and `conversation_ended`.
160
173
  */
161
174
  ConversationCallbacks?: Array<string>;
162
175
 
@@ -269,25 +282,32 @@ export interface TexmlInitiateAICallParams {
269
282
  SipRegion?: 'US' | 'Europe' | 'Canada' | 'Australia' | 'Middle East';
270
283
 
271
284
  /**
272
- * URL destination for Telnyx to send status callback events to for the call.
285
+ * URL destination for Telnyx to send status callback events for this AI call. When
286
+ * provided, this per-call value overrides the status callback URL configured on
287
+ * the TeXML application/connection.
273
288
  */
274
289
  StatusCallback?: string;
275
290
 
276
291
  /**
277
- * The call events for which Telnyx should send a webhook. Multiple events can be
278
- * defined when separated by a space. Valid values: initiated, ringing, answered,
279
- * completed.
292
+ * The status callback events for which Telnyx should send a webhook for this AI
293
+ * call. Multiple events can be defined when separated by a space. Valid values:
294
+ * initiated, ringing, answered, completed, no-answer, busy, canceled, failed,
295
+ * analyzed. When provided, this per-call value overrides the status callback
296
+ * events configured on the TeXML application/connection.
280
297
  */
281
298
  StatusCallbackEvent?: string;
282
299
 
283
300
  /**
284
- * HTTP request type used for `StatusCallback`.
301
+ * HTTP request type used for `StatusCallback` and `StatusCallbacks` for this AI
302
+ * call. When provided, this per-call value overrides the status callback method
303
+ * configured on the TeXML application/connection.
285
304
  */
286
305
  StatusCallbackMethod?: 'GET' | 'POST';
287
306
 
288
307
  /**
289
- * An array of URL destinations for Telnyx to send status callback events to for
290
- * the call.
308
+ * Array of URL destinations for Telnyx to send status callback events for this AI
309
+ * call. When provided, these per-call values override the status callback URL
310
+ * configured on the TeXML application/connection.
291
311
  */
292
312
  StatusCallbacks?: Array<string>;
293
313
 
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '6.63.0'; // x-release-please-version
1
+ export const VERSION = '6.64.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "6.63.0";
1
+ export declare const VERSION = "6.64.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "6.63.0";
1
+ export declare const VERSION = "6.64.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '6.63.0'; // x-release-please-version
4
+ exports.VERSION = '6.64.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '6.63.0'; // x-release-please-version
1
+ export const VERSION = '6.64.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map