retell-sdk 6.2.6 → 6.2.8
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 +20 -0
- package/package.json +1 -1
- package/resources/agent.d.mts +141 -18
- package/resources/agent.d.mts.map +1 -1
- package/resources/agent.d.ts +141 -18
- package/resources/agent.d.ts.map +1 -1
- package/resources/batch-call.d.mts +61 -12
- package/resources/batch-call.d.mts.map +1 -1
- package/resources/batch-call.d.ts +61 -12
- package/resources/batch-call.d.ts.map +1 -1
- package/resources/call.d.mts +185 -37
- package/resources/call.d.mts.map +1 -1
- package/resources/call.d.ts +185 -37
- package/resources/call.d.ts.map +1 -1
- package/resources/call.js +2 -1
- package/resources/call.js.map +1 -1
- package/resources/call.mjs +2 -1
- package/resources/call.mjs.map +1 -1
- package/resources/chat-agent.d.mts +130 -18
- package/resources/chat-agent.d.mts.map +1 -1
- package/resources/chat-agent.d.ts +130 -18
- package/resources/chat-agent.d.ts.map +1 -1
- package/resources/conversation-flow-component.d.mts +492 -42
- package/resources/conversation-flow-component.d.mts.map +1 -1
- package/resources/conversation-flow-component.d.ts +492 -42
- package/resources/conversation-flow-component.d.ts.map +1 -1
- package/resources/conversation-flow.d.mts +1005 -87
- package/resources/conversation-flow.d.mts.map +1 -1
- package/resources/conversation-flow.d.ts +1005 -87
- package/resources/conversation-flow.d.ts.map +1 -1
- package/resources/llm.d.mts +234 -3
- package/resources/llm.d.mts.map +1 -1
- package/resources/llm.d.ts +234 -3
- package/resources/llm.d.ts.map +1 -1
- package/resources/tests.d.mts +3 -3
- package/resources/tests.d.mts.map +1 -1
- package/resources/tests.d.ts +3 -3
- package/resources/tests.d.ts.map +1 -1
- package/src/resources/agent.ts +172 -15
- package/src/resources/batch-call.ts +75 -10
- package/src/resources/call.ts +227 -31
- package/src/resources/chat-agent.ts +159 -15
- package/src/resources/conversation-flow-component.ts +627 -42
- package/src/resources/conversation-flow.ts +1290 -87
- package/src/resources/llm.ts +291 -0
- package/src/resources/tests.ts +6 -3
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,25 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [6.2.8](https://github.com/RetellAI/retell-typescript-sdk/compare/v6.2.7...v6.2.8) (2026-10-17)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* **api:** Add SMS sender and destination options, plus `speak_after_execution`, to SMS tools and nodes. ([e67af52](https://github.com/RetellAI/retell-typescript-sdk/commit/e67af5215eeb72b172ff5547c7c9c82ecb98f960))
|
|
9
|
+
* **api:** Clarify chart type behavior and revise the live-call takeover description for PCI sessions. ([e67af52](https://github.com/RetellAI/retell-typescript-sdk/commit/e67af5215eeb72b172ff5547c7c9c82ecb98f960))
|
|
10
|
+
* **api:** Remove the deprecated `multi` scalar from agent language fields; use a locale or locale array instead. ([e67af52](https://github.com/RetellAI/retell-typescript-sdk/commit/e67af5215eeb72b172ff5547c7c9c82ecb98f960))
|
|
11
|
+
|
|
12
|
+
## [6.2.7](https://github.com/RetellAI/retell-typescript-sdk/compare/v6.2.6...v6.2.7) (2026-10-15)
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### Bug Fixes
|
|
16
|
+
|
|
17
|
+
* **api:** Add a 409 Conflict response for takeOverLiveCall when a PCI session is active. ([750c1a7](https://github.com/RetellAI/retell-typescript-sdk/commit/750c1a7b66483dee4bd2b611b9f9f8c2a6b5cdba))
|
|
18
|
+
* **api:** Add is_transfer_agent to agent create requests, agent responses, and agent list filters. ([e6c5420](https://github.com/RetellAI/retell-typescript-sdk/commit/e6c542012552bf595d83f46fdf1f53bd266685c2))
|
|
19
|
+
* **api:** Add model_ultrafast and ultrafast override fields to Retell LLM configurations. ([6b64fed](https://github.com/RetellAI/retell-typescript-sdk/commit/6b64fed698daab4008e6da49238c3cdf36cf52eb))
|
|
20
|
+
* **api:** api update ([ca490ed](https://github.com/RetellAI/retell-typescript-sdk/commit/ca490eda511bd172e82395189ae8349109fc5b10))
|
|
21
|
+
* **api:** Clarify that AgentOverrideRequest uses the latest version when no response-engine version is provided. ([d100462](https://github.com/RetellAI/retell-typescript-sdk/commit/d100462f0b50c6bf75ccc07fc6dd7ff22467b7d2))
|
|
22
|
+
|
|
3
23
|
## [6.2.6](https://github.com/RetellAI/retell-typescript-sdk/compare/v6.2.5...v6.2.6) (2026-10-13)
|
|
4
24
|
|
|
5
25
|
|
package/package.json
CHANGED
package/resources/agent.d.mts
CHANGED
|
@@ -361,6 +361,10 @@ export interface AgentResponse {
|
|
|
361
361
|
* Whether the agent is published.
|
|
362
362
|
*/
|
|
363
363
|
is_published?: boolean;
|
|
364
|
+
/**
|
|
365
|
+
* Whether the agent is a transfer agent used for agentic warm transfer.
|
|
366
|
+
*/
|
|
367
|
+
is_transfer_agent?: boolean;
|
|
364
368
|
/**
|
|
365
369
|
* If this option is set, the call will try to detect IVR in the first 3 minutes of
|
|
366
370
|
* the call. Actions defined will be applied when the IVR is detected. Set this to
|
|
@@ -370,12 +374,9 @@ export interface AgentResponse {
|
|
|
370
374
|
/**
|
|
371
375
|
* Specifies what language(s) the agent will operate in. Accepts either a single
|
|
372
376
|
* locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
|
|
373
|
-
* `["en-US","es-ES"]`).
|
|
374
|
-
* as a scalar, and is stored and returned as the ten locales it used to mean. It
|
|
375
|
-
* must not appear inside the array form. Send an explicit locale array instead. If
|
|
376
|
-
* unset, defaults to `en-US`.
|
|
377
|
+
* `["en-US","es-ES"]`). If unset, defaults to `en-US`.
|
|
377
378
|
*/
|
|
378
|
-
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' |
|
|
379
|
+
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | Array<'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA'>;
|
|
379
380
|
/**
|
|
380
381
|
* Maximum allowed length for the call, will force end the call if reached. The
|
|
381
382
|
* minimum value allowed is 60,000 ms (1 min), and maximum value allowed is
|
|
@@ -401,7 +402,7 @@ export interface AgentResponse {
|
|
|
401
402
|
/**
|
|
402
403
|
* The model to use for post call analysis. Default to gpt-5.6-terra.
|
|
403
404
|
*/
|
|
404
|
-
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | null;
|
|
405
|
+
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | 'gemini-4-argon' | null;
|
|
405
406
|
/**
|
|
406
407
|
* Integration (Agent Functions) tools run as a dependency graph during teardown,
|
|
407
408
|
* after post-call analysis. Each tool can be gated by a condition. On calls the
|
|
@@ -1322,6 +1323,20 @@ export declare namespace AgentResponse {
|
|
|
1322
1323
|
* to "prompt".
|
|
1323
1324
|
*/
|
|
1324
1325
|
execution_message_type?: 'prompt' | 'static_text';
|
|
1326
|
+
/**
|
|
1327
|
+
* SMS destination number configuration. If omitted, the message is sent to the
|
|
1328
|
+
* customer number on the call.
|
|
1329
|
+
*/
|
|
1330
|
+
sms_destination?: SendSMSTool.DestinationCustomerNumber | SendSMSTool.DestinationPhoneNumber | unknown;
|
|
1331
|
+
/**
|
|
1332
|
+
* SMS sender number configuration. If omitted, the message is sent from the
|
|
1333
|
+
* agent's phone number.
|
|
1334
|
+
*/
|
|
1335
|
+
sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
|
|
1336
|
+
/**
|
|
1337
|
+
* Whether the agent should speak after the SMS tool finishes execution.
|
|
1338
|
+
*/
|
|
1339
|
+
speak_after_execution?: boolean;
|
|
1325
1340
|
/**
|
|
1326
1341
|
* If true, the agent will speak a short line before sending the SMS. If omitted,
|
|
1327
1342
|
* defaults to true (same as end_call / transfer_call tools).
|
|
@@ -1376,6 +1391,27 @@ export declare namespace AgentResponse {
|
|
|
1376
1391
|
right?: string;
|
|
1377
1392
|
}
|
|
1378
1393
|
}
|
|
1394
|
+
interface DestinationCustomerNumber {
|
|
1395
|
+
type: 'customer_number';
|
|
1396
|
+
}
|
|
1397
|
+
interface DestinationPhoneNumber {
|
|
1398
|
+
/**
|
|
1399
|
+
* Destination phone number in E.164 format.
|
|
1400
|
+
*/
|
|
1401
|
+
phone_number: string;
|
|
1402
|
+
type: 'phone_number';
|
|
1403
|
+
/**
|
|
1404
|
+
* If true, skip E.164 validation for this phone number (same semantics as
|
|
1405
|
+
* transfer_call ignore_e164_validation).
|
|
1406
|
+
*/
|
|
1407
|
+
ignore_e164_validation?: boolean;
|
|
1408
|
+
}
|
|
1409
|
+
interface SenderCurrentNumber {
|
|
1410
|
+
type: 'current_number';
|
|
1411
|
+
}
|
|
1412
|
+
interface SenderRetellLongCode {
|
|
1413
|
+
type: 'retell_long_code';
|
|
1414
|
+
}
|
|
1379
1415
|
}
|
|
1380
1416
|
interface AppTool {
|
|
1381
1417
|
/**
|
|
@@ -1821,6 +1857,10 @@ export declare namespace AgentListResponse {
|
|
|
1821
1857
|
* update or creation if no updates available.
|
|
1822
1858
|
*/
|
|
1823
1859
|
user_modified_timestamp: number;
|
|
1860
|
+
/**
|
|
1861
|
+
* Whether the agent is a transfer agent used for agentic warm transfer.
|
|
1862
|
+
*/
|
|
1863
|
+
is_transfer_agent?: boolean;
|
|
1824
1864
|
}
|
|
1825
1865
|
namespace Item {
|
|
1826
1866
|
interface Tags {
|
|
@@ -2078,6 +2118,13 @@ export interface AgentCreateParams {
|
|
|
2078
2118
|
* interrupted.
|
|
2079
2119
|
*/
|
|
2080
2120
|
interruption_sensitivity?: number;
|
|
2121
|
+
/**
|
|
2122
|
+
* Whether to create the agent as a transfer agent for agentic warm transfer. You
|
|
2123
|
+
* can only set this field when creating the agent. The response engine must also
|
|
2124
|
+
* be configured for transfer use with is_transfer_llm or is_transfer_cf. Custom
|
|
2125
|
+
* LLM agents cannot be transfer agents.
|
|
2126
|
+
*/
|
|
2127
|
+
is_transfer_agent?: boolean;
|
|
2081
2128
|
/**
|
|
2082
2129
|
* If this option is set, the call will try to detect IVR in the first 3 minutes of
|
|
2083
2130
|
* the call. Actions defined will be applied when the IVR is detected. Set this to
|
|
@@ -2087,12 +2134,9 @@ export interface AgentCreateParams {
|
|
|
2087
2134
|
/**
|
|
2088
2135
|
* Specifies what language(s) the agent will operate in. Accepts either a single
|
|
2089
2136
|
* locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
|
|
2090
|
-
* `["en-US","es-ES"]`).
|
|
2091
|
-
* as a scalar, and is stored and returned as the ten locales it used to mean. It
|
|
2092
|
-
* must not appear inside the array form. Send an explicit locale array instead. If
|
|
2093
|
-
* unset, defaults to `en-US`.
|
|
2137
|
+
* `["en-US","es-ES"]`). If unset, defaults to `en-US`.
|
|
2094
2138
|
*/
|
|
2095
|
-
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' |
|
|
2139
|
+
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | Array<'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA'>;
|
|
2096
2140
|
/**
|
|
2097
2141
|
* Maximum allowed length for the call, will force end the call if reached. The
|
|
2098
2142
|
* minimum value allowed is 60,000 ms (1 min), and maximum value allowed is
|
|
@@ -2118,7 +2162,7 @@ export interface AgentCreateParams {
|
|
|
2118
2162
|
/**
|
|
2119
2163
|
* The model to use for post call analysis. Default to gpt-5.6-terra.
|
|
2120
2164
|
*/
|
|
2121
|
-
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | null;
|
|
2165
|
+
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | 'gemini-4-argon' | null;
|
|
2122
2166
|
/**
|
|
2123
2167
|
* Integration (Agent Functions) tools run as a dependency graph during teardown,
|
|
2124
2168
|
* after post-call analysis. Each tool can be gated by a condition. On calls the
|
|
@@ -3039,6 +3083,20 @@ export declare namespace AgentCreateParams {
|
|
|
3039
3083
|
* to "prompt".
|
|
3040
3084
|
*/
|
|
3041
3085
|
execution_message_type?: 'prompt' | 'static_text';
|
|
3086
|
+
/**
|
|
3087
|
+
* SMS destination number configuration. If omitted, the message is sent to the
|
|
3088
|
+
* customer number on the call.
|
|
3089
|
+
*/
|
|
3090
|
+
sms_destination?: SendSMSTool.DestinationCustomerNumber | SendSMSTool.DestinationPhoneNumber | unknown;
|
|
3091
|
+
/**
|
|
3092
|
+
* SMS sender number configuration. If omitted, the message is sent from the
|
|
3093
|
+
* agent's phone number.
|
|
3094
|
+
*/
|
|
3095
|
+
sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
|
|
3096
|
+
/**
|
|
3097
|
+
* Whether the agent should speak after the SMS tool finishes execution.
|
|
3098
|
+
*/
|
|
3099
|
+
speak_after_execution?: boolean;
|
|
3042
3100
|
/**
|
|
3043
3101
|
* If true, the agent will speak a short line before sending the SMS. If omitted,
|
|
3044
3102
|
* defaults to true (same as end_call / transfer_call tools).
|
|
@@ -3093,6 +3151,27 @@ export declare namespace AgentCreateParams {
|
|
|
3093
3151
|
right?: string;
|
|
3094
3152
|
}
|
|
3095
3153
|
}
|
|
3154
|
+
interface DestinationCustomerNumber {
|
|
3155
|
+
type: 'customer_number';
|
|
3156
|
+
}
|
|
3157
|
+
interface DestinationPhoneNumber {
|
|
3158
|
+
/**
|
|
3159
|
+
* Destination phone number in E.164 format.
|
|
3160
|
+
*/
|
|
3161
|
+
phone_number: string;
|
|
3162
|
+
type: 'phone_number';
|
|
3163
|
+
/**
|
|
3164
|
+
* If true, skip E.164 validation for this phone number (same semantics as
|
|
3165
|
+
* transfer_call ignore_e164_validation).
|
|
3166
|
+
*/
|
|
3167
|
+
ignore_e164_validation?: boolean;
|
|
3168
|
+
}
|
|
3169
|
+
interface SenderCurrentNumber {
|
|
3170
|
+
type: 'current_number';
|
|
3171
|
+
}
|
|
3172
|
+
interface SenderRetellLongCode {
|
|
3173
|
+
type: 'retell_long_code';
|
|
3174
|
+
}
|
|
3096
3175
|
}
|
|
3097
3176
|
interface AppTool {
|
|
3098
3177
|
/**
|
|
@@ -3725,12 +3804,9 @@ export interface AgentUpdateParams {
|
|
|
3725
3804
|
/**
|
|
3726
3805
|
* Body param: Specifies what language(s) the agent will operate in. Accepts either
|
|
3727
3806
|
* a single locale (e.g. `en-US`) or an array of locales for multilingual agents
|
|
3728
|
-
* (e.g. `["en-US","es-ES"]`).
|
|
3729
|
-
* accepted as a scalar, and is stored and returned as the ten locales it used to
|
|
3730
|
-
* mean. It must not appear inside the array form. Send an explicit locale array
|
|
3731
|
-
* instead. If unset, defaults to `en-US`.
|
|
3807
|
+
* (e.g. `["en-US","es-ES"]`). If unset, defaults to `en-US`.
|
|
3732
3808
|
*/
|
|
3733
|
-
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' |
|
|
3809
|
+
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | Array<'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA'>;
|
|
3734
3810
|
/**
|
|
3735
3811
|
* Body param: Maximum allowed length for the call, will force end the call if
|
|
3736
3812
|
* reached. The minimum value allowed is 60,000 ms (1 min), and maximum value
|
|
@@ -3756,7 +3832,7 @@ export interface AgentUpdateParams {
|
|
|
3756
3832
|
/**
|
|
3757
3833
|
* Body param: The model to use for post call analysis. Default to gpt-5.6-terra.
|
|
3758
3834
|
*/
|
|
3759
|
-
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | null;
|
|
3835
|
+
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | 'gemini-4-argon' | null;
|
|
3760
3836
|
/**
|
|
3761
3837
|
* Body param: Integration (Agent Functions) tools run as a dependency graph during
|
|
3762
3838
|
* teardown, after post-call analysis. Each tool can be gated by a condition. On
|
|
@@ -4656,6 +4732,20 @@ export declare namespace AgentUpdateParams {
|
|
|
4656
4732
|
* to "prompt".
|
|
4657
4733
|
*/
|
|
4658
4734
|
execution_message_type?: 'prompt' | 'static_text';
|
|
4735
|
+
/**
|
|
4736
|
+
* SMS destination number configuration. If omitted, the message is sent to the
|
|
4737
|
+
* customer number on the call.
|
|
4738
|
+
*/
|
|
4739
|
+
sms_destination?: SendSMSTool.DestinationCustomerNumber | SendSMSTool.DestinationPhoneNumber | unknown;
|
|
4740
|
+
/**
|
|
4741
|
+
* SMS sender number configuration. If omitted, the message is sent from the
|
|
4742
|
+
* agent's phone number.
|
|
4743
|
+
*/
|
|
4744
|
+
sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
|
|
4745
|
+
/**
|
|
4746
|
+
* Whether the agent should speak after the SMS tool finishes execution.
|
|
4747
|
+
*/
|
|
4748
|
+
speak_after_execution?: boolean;
|
|
4659
4749
|
/**
|
|
4660
4750
|
* If true, the agent will speak a short line before sending the SMS. If omitted,
|
|
4661
4751
|
* defaults to true (same as end_call / transfer_call tools).
|
|
@@ -4710,6 +4800,27 @@ export declare namespace AgentUpdateParams {
|
|
|
4710
4800
|
right?: string;
|
|
4711
4801
|
}
|
|
4712
4802
|
}
|
|
4803
|
+
interface DestinationCustomerNumber {
|
|
4804
|
+
type: 'customer_number';
|
|
4805
|
+
}
|
|
4806
|
+
interface DestinationPhoneNumber {
|
|
4807
|
+
/**
|
|
4808
|
+
* Destination phone number in E.164 format.
|
|
4809
|
+
*/
|
|
4810
|
+
phone_number: string;
|
|
4811
|
+
type: 'phone_number';
|
|
4812
|
+
/**
|
|
4813
|
+
* If true, skip E.164 validation for this phone number (same semantics as
|
|
4814
|
+
* transfer_call ignore_e164_validation).
|
|
4815
|
+
*/
|
|
4816
|
+
ignore_e164_validation?: boolean;
|
|
4817
|
+
}
|
|
4818
|
+
interface SenderCurrentNumber {
|
|
4819
|
+
type: 'current_number';
|
|
4820
|
+
}
|
|
4821
|
+
interface SenderRetellLongCode {
|
|
4822
|
+
type: 'retell_long_code';
|
|
4823
|
+
}
|
|
4713
4824
|
}
|
|
4714
4825
|
interface AppTool {
|
|
4715
4826
|
/**
|
|
@@ -5185,6 +5296,10 @@ export declare namespace AgentListParams {
|
|
|
5185
5296
|
*/
|
|
5186
5297
|
interface FilterCriteria {
|
|
5187
5298
|
channel?: FilterCriteria.Channel;
|
|
5299
|
+
/**
|
|
5300
|
+
* Filter by whether the agent is a transfer agent.
|
|
5301
|
+
*/
|
|
5302
|
+
is_transfer_agent?: FilterCriteria.IsTransferAgent;
|
|
5188
5303
|
/**
|
|
5189
5304
|
* Case-insensitive substring search over agent name, plus substring search over
|
|
5190
5305
|
* agent id.
|
|
@@ -5200,6 +5315,14 @@ export declare namespace AgentListParams {
|
|
|
5200
5315
|
type: 'string';
|
|
5201
5316
|
value: 'voice' | 'chat';
|
|
5202
5317
|
}
|
|
5318
|
+
/**
|
|
5319
|
+
* Filter by whether the agent is a transfer agent.
|
|
5320
|
+
*/
|
|
5321
|
+
interface IsTransferAgent {
|
|
5322
|
+
op: 'eq';
|
|
5323
|
+
type: 'boolean';
|
|
5324
|
+
value: boolean;
|
|
5325
|
+
}
|
|
5203
5326
|
}
|
|
5204
5327
|
}
|
|
5205
5328
|
export interface AgentCreateVersionParams {
|