retell-sdk 4.61.0 → 4.63.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 +18 -0
- package/index.d.mts +3 -0
- package/index.d.ts +3 -0
- package/index.d.ts.map +1 -1
- package/index.js +3 -0
- package/index.js.map +1 -1
- package/index.mjs +3 -0
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/agent.d.ts +57 -6
- package/resources/agent.d.ts.map +1 -1
- package/resources/batch-call.d.ts +21 -4
- package/resources/batch-call.d.ts.map +1 -1
- package/resources/call.d.ts +153 -16
- package/resources/call.d.ts.map +1 -1
- package/resources/chat-agent.d.ts +51 -3
- package/resources/chat-agent.d.ts.map +1 -1
- package/resources/conversation-flow-component.d.ts +7835 -0
- package/resources/conversation-flow-component.d.ts.map +1 -0
- package/resources/conversation-flow-component.js +93 -0
- package/resources/conversation-flow-component.js.map +1 -0
- package/resources/conversation-flow-component.mjs +89 -0
- package/resources/conversation-flow-component.mjs.map +1 -0
- package/resources/conversation-flow.d.ts +540 -43
- package/resources/conversation-flow.d.ts.map +1 -1
- package/resources/conversation-flow.js +1 -1
- package/resources/conversation-flow.mjs +1 -1
- package/resources/index.d.ts +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/llm.d.ts +501 -9
- package/resources/llm.d.ts.map +1 -1
- package/resources/mcp-tool.d.ts +2 -1
- package/resources/mcp-tool.d.ts.map +1 -1
- package/src/index.ts +17 -0
- package/src/resources/agent.ts +72 -27
- package/src/resources/batch-call.ts +34 -27
- package/src/resources/call.ts +210 -85
- package/src/resources/chat-agent.ts +66 -27
- package/src/resources/conversation-flow-component.ts +11183 -0
- package/src/resources/conversation-flow.ts +799 -326
- package/src/resources/index.ts +7 -0
- package/src/resources/llm.ts +621 -33
- package/src/resources/mcp-tool.ts +2 -1
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/llm.d.ts
CHANGED
|
@@ -125,7 +125,7 @@ export interface LlmResponse {
|
|
|
125
125
|
/**
|
|
126
126
|
* Select the underlying text LLM. If not set, would default to gpt-4.1.
|
|
127
127
|
*/
|
|
128
|
-
model?: 'gpt-
|
|
128
|
+
model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | null;
|
|
129
129
|
/**
|
|
130
130
|
* If set to true, will use high priority pool with more dedicated resource to
|
|
131
131
|
* ensure lower and more consistent latency, default to false. This feature usually
|
|
@@ -194,7 +194,7 @@ export declare namespace LlmResponse {
|
|
|
194
194
|
*/
|
|
195
195
|
name: string;
|
|
196
196
|
transfer_destination: TransferCallTool.TransferDestinationPredefined | TransferCallTool.TransferDestinationInferred;
|
|
197
|
-
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer;
|
|
197
|
+
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer | TransferCallTool.TransferOptionAgenticWarmTransfer;
|
|
198
198
|
type: 'transfer_call';
|
|
199
199
|
/**
|
|
200
200
|
* Custom SIP headers to be added to the call.
|
|
@@ -344,6 +344,88 @@ export declare namespace LlmResponse {
|
|
|
344
344
|
type?: 'static_message';
|
|
345
345
|
}
|
|
346
346
|
}
|
|
347
|
+
interface TransferOptionAgenticWarmTransfer {
|
|
348
|
+
/**
|
|
349
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
350
|
+
*/
|
|
351
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
352
|
+
/**
|
|
353
|
+
* The type of the transfer.
|
|
354
|
+
*/
|
|
355
|
+
type: 'agentic_warm_transfer';
|
|
356
|
+
/**
|
|
357
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
358
|
+
*/
|
|
359
|
+
enable_bridge_audio_cue?: boolean;
|
|
360
|
+
/**
|
|
361
|
+
* The music to play while the caller is being transferred.
|
|
362
|
+
*/
|
|
363
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
364
|
+
/**
|
|
365
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
366
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
367
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
368
|
+
*/
|
|
369
|
+
public_handoff_option?: TransferOptionAgenticWarmTransfer.WarmTransferPrompt | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
370
|
+
/**
|
|
371
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
372
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
373
|
+
* Twilio numbers support this option.
|
|
374
|
+
*/
|
|
375
|
+
show_transferee_as_caller?: boolean;
|
|
376
|
+
}
|
|
377
|
+
namespace TransferOptionAgenticWarmTransfer {
|
|
378
|
+
/**
|
|
379
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
380
|
+
*/
|
|
381
|
+
interface AgenticTransferConfig {
|
|
382
|
+
/**
|
|
383
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
384
|
+
* Defaults to cancel_transfer.
|
|
385
|
+
*/
|
|
386
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
387
|
+
/**
|
|
388
|
+
* The agent that will mediate the transfer decision.
|
|
389
|
+
*/
|
|
390
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
391
|
+
/**
|
|
392
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
393
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
394
|
+
*/
|
|
395
|
+
transfer_timeout_ms?: number;
|
|
396
|
+
}
|
|
397
|
+
namespace AgenticTransferConfig {
|
|
398
|
+
/**
|
|
399
|
+
* The agent that will mediate the transfer decision.
|
|
400
|
+
*/
|
|
401
|
+
interface TransferAgent {
|
|
402
|
+
/**
|
|
403
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
404
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
405
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
406
|
+
*/
|
|
407
|
+
agent_id: string;
|
|
408
|
+
/**
|
|
409
|
+
* The version of the transfer agent to use.
|
|
410
|
+
*/
|
|
411
|
+
agent_version: number;
|
|
412
|
+
}
|
|
413
|
+
}
|
|
414
|
+
interface WarmTransferPrompt {
|
|
415
|
+
/**
|
|
416
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
417
|
+
*/
|
|
418
|
+
prompt?: string;
|
|
419
|
+
type?: 'prompt';
|
|
420
|
+
}
|
|
421
|
+
interface WarmTransferStaticMessage {
|
|
422
|
+
/**
|
|
423
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
424
|
+
*/
|
|
425
|
+
message?: string;
|
|
426
|
+
type?: 'static_message';
|
|
427
|
+
}
|
|
428
|
+
}
|
|
347
429
|
}
|
|
348
430
|
interface CheckAvailabilityCalTool {
|
|
349
431
|
/**
|
|
@@ -866,7 +948,7 @@ export declare namespace LlmResponse {
|
|
|
866
948
|
*/
|
|
867
949
|
name: string;
|
|
868
950
|
transfer_destination: TransferCallTool.TransferDestinationPredefined | TransferCallTool.TransferDestinationInferred;
|
|
869
|
-
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer;
|
|
951
|
+
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer | TransferCallTool.TransferOptionAgenticWarmTransfer;
|
|
870
952
|
type: 'transfer_call';
|
|
871
953
|
/**
|
|
872
954
|
* Custom SIP headers to be added to the call.
|
|
@@ -1016,6 +1098,88 @@ export declare namespace LlmResponse {
|
|
|
1016
1098
|
type?: 'static_message';
|
|
1017
1099
|
}
|
|
1018
1100
|
}
|
|
1101
|
+
interface TransferOptionAgenticWarmTransfer {
|
|
1102
|
+
/**
|
|
1103
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
1104
|
+
*/
|
|
1105
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
1106
|
+
/**
|
|
1107
|
+
* The type of the transfer.
|
|
1108
|
+
*/
|
|
1109
|
+
type: 'agentic_warm_transfer';
|
|
1110
|
+
/**
|
|
1111
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
1112
|
+
*/
|
|
1113
|
+
enable_bridge_audio_cue?: boolean;
|
|
1114
|
+
/**
|
|
1115
|
+
* The music to play while the caller is being transferred.
|
|
1116
|
+
*/
|
|
1117
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
1118
|
+
/**
|
|
1119
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
1120
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
1121
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
1122
|
+
*/
|
|
1123
|
+
public_handoff_option?: TransferOptionAgenticWarmTransfer.WarmTransferPrompt | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
1124
|
+
/**
|
|
1125
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
1126
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
1127
|
+
* Twilio numbers support this option.
|
|
1128
|
+
*/
|
|
1129
|
+
show_transferee_as_caller?: boolean;
|
|
1130
|
+
}
|
|
1131
|
+
namespace TransferOptionAgenticWarmTransfer {
|
|
1132
|
+
/**
|
|
1133
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
1134
|
+
*/
|
|
1135
|
+
interface AgenticTransferConfig {
|
|
1136
|
+
/**
|
|
1137
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
1138
|
+
* Defaults to cancel_transfer.
|
|
1139
|
+
*/
|
|
1140
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
1141
|
+
/**
|
|
1142
|
+
* The agent that will mediate the transfer decision.
|
|
1143
|
+
*/
|
|
1144
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
1145
|
+
/**
|
|
1146
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
1147
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
1148
|
+
*/
|
|
1149
|
+
transfer_timeout_ms?: number;
|
|
1150
|
+
}
|
|
1151
|
+
namespace AgenticTransferConfig {
|
|
1152
|
+
/**
|
|
1153
|
+
* The agent that will mediate the transfer decision.
|
|
1154
|
+
*/
|
|
1155
|
+
interface TransferAgent {
|
|
1156
|
+
/**
|
|
1157
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
1158
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
1159
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
1160
|
+
*/
|
|
1161
|
+
agent_id: string;
|
|
1162
|
+
/**
|
|
1163
|
+
* The version of the transfer agent to use.
|
|
1164
|
+
*/
|
|
1165
|
+
agent_version: number;
|
|
1166
|
+
}
|
|
1167
|
+
}
|
|
1168
|
+
interface WarmTransferPrompt {
|
|
1169
|
+
/**
|
|
1170
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
1171
|
+
*/
|
|
1172
|
+
prompt?: string;
|
|
1173
|
+
type?: 'prompt';
|
|
1174
|
+
}
|
|
1175
|
+
interface WarmTransferStaticMessage {
|
|
1176
|
+
/**
|
|
1177
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
1178
|
+
*/
|
|
1179
|
+
message?: string;
|
|
1180
|
+
type?: 'static_message';
|
|
1181
|
+
}
|
|
1182
|
+
}
|
|
1019
1183
|
}
|
|
1020
1184
|
interface CheckAvailabilityCalTool {
|
|
1021
1185
|
/**
|
|
@@ -1456,7 +1620,7 @@ export interface LlmCreateParams {
|
|
|
1456
1620
|
/**
|
|
1457
1621
|
* Select the underlying text LLM. If not set, would default to gpt-4.1.
|
|
1458
1622
|
*/
|
|
1459
|
-
model?: 'gpt-
|
|
1623
|
+
model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | null;
|
|
1460
1624
|
/**
|
|
1461
1625
|
* If set to true, will use high priority pool with more dedicated resource to
|
|
1462
1626
|
* ensure lower and more consistent latency, default to false. This feature usually
|
|
@@ -1525,7 +1689,7 @@ export declare namespace LlmCreateParams {
|
|
|
1525
1689
|
*/
|
|
1526
1690
|
name: string;
|
|
1527
1691
|
transfer_destination: TransferCallTool.TransferDestinationPredefined | TransferCallTool.TransferDestinationInferred;
|
|
1528
|
-
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer;
|
|
1692
|
+
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer | TransferCallTool.TransferOptionAgenticWarmTransfer;
|
|
1529
1693
|
type: 'transfer_call';
|
|
1530
1694
|
/**
|
|
1531
1695
|
* Custom SIP headers to be added to the call.
|
|
@@ -1675,6 +1839,88 @@ export declare namespace LlmCreateParams {
|
|
|
1675
1839
|
type?: 'static_message';
|
|
1676
1840
|
}
|
|
1677
1841
|
}
|
|
1842
|
+
interface TransferOptionAgenticWarmTransfer {
|
|
1843
|
+
/**
|
|
1844
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
1845
|
+
*/
|
|
1846
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
1847
|
+
/**
|
|
1848
|
+
* The type of the transfer.
|
|
1849
|
+
*/
|
|
1850
|
+
type: 'agentic_warm_transfer';
|
|
1851
|
+
/**
|
|
1852
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
1853
|
+
*/
|
|
1854
|
+
enable_bridge_audio_cue?: boolean;
|
|
1855
|
+
/**
|
|
1856
|
+
* The music to play while the caller is being transferred.
|
|
1857
|
+
*/
|
|
1858
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
1859
|
+
/**
|
|
1860
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
1861
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
1862
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
1863
|
+
*/
|
|
1864
|
+
public_handoff_option?: TransferOptionAgenticWarmTransfer.WarmTransferPrompt | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
1865
|
+
/**
|
|
1866
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
1867
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
1868
|
+
* Twilio numbers support this option.
|
|
1869
|
+
*/
|
|
1870
|
+
show_transferee_as_caller?: boolean;
|
|
1871
|
+
}
|
|
1872
|
+
namespace TransferOptionAgenticWarmTransfer {
|
|
1873
|
+
/**
|
|
1874
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
1875
|
+
*/
|
|
1876
|
+
interface AgenticTransferConfig {
|
|
1877
|
+
/**
|
|
1878
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
1879
|
+
* Defaults to cancel_transfer.
|
|
1880
|
+
*/
|
|
1881
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
1882
|
+
/**
|
|
1883
|
+
* The agent that will mediate the transfer decision.
|
|
1884
|
+
*/
|
|
1885
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
1886
|
+
/**
|
|
1887
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
1888
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
1889
|
+
*/
|
|
1890
|
+
transfer_timeout_ms?: number;
|
|
1891
|
+
}
|
|
1892
|
+
namespace AgenticTransferConfig {
|
|
1893
|
+
/**
|
|
1894
|
+
* The agent that will mediate the transfer decision.
|
|
1895
|
+
*/
|
|
1896
|
+
interface TransferAgent {
|
|
1897
|
+
/**
|
|
1898
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
1899
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
1900
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
1901
|
+
*/
|
|
1902
|
+
agent_id: string;
|
|
1903
|
+
/**
|
|
1904
|
+
* The version of the transfer agent to use.
|
|
1905
|
+
*/
|
|
1906
|
+
agent_version: number;
|
|
1907
|
+
}
|
|
1908
|
+
}
|
|
1909
|
+
interface WarmTransferPrompt {
|
|
1910
|
+
/**
|
|
1911
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
1912
|
+
*/
|
|
1913
|
+
prompt?: string;
|
|
1914
|
+
type?: 'prompt';
|
|
1915
|
+
}
|
|
1916
|
+
interface WarmTransferStaticMessage {
|
|
1917
|
+
/**
|
|
1918
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
1919
|
+
*/
|
|
1920
|
+
message?: string;
|
|
1921
|
+
type?: 'static_message';
|
|
1922
|
+
}
|
|
1923
|
+
}
|
|
1678
1924
|
}
|
|
1679
1925
|
interface CheckAvailabilityCalTool {
|
|
1680
1926
|
/**
|
|
@@ -2197,7 +2443,7 @@ export declare namespace LlmCreateParams {
|
|
|
2197
2443
|
*/
|
|
2198
2444
|
name: string;
|
|
2199
2445
|
transfer_destination: TransferCallTool.TransferDestinationPredefined | TransferCallTool.TransferDestinationInferred;
|
|
2200
|
-
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer;
|
|
2446
|
+
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer | TransferCallTool.TransferOptionAgenticWarmTransfer;
|
|
2201
2447
|
type: 'transfer_call';
|
|
2202
2448
|
/**
|
|
2203
2449
|
* Custom SIP headers to be added to the call.
|
|
@@ -2347,6 +2593,88 @@ export declare namespace LlmCreateParams {
|
|
|
2347
2593
|
type?: 'static_message';
|
|
2348
2594
|
}
|
|
2349
2595
|
}
|
|
2596
|
+
interface TransferOptionAgenticWarmTransfer {
|
|
2597
|
+
/**
|
|
2598
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
2599
|
+
*/
|
|
2600
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
2601
|
+
/**
|
|
2602
|
+
* The type of the transfer.
|
|
2603
|
+
*/
|
|
2604
|
+
type: 'agentic_warm_transfer';
|
|
2605
|
+
/**
|
|
2606
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
2607
|
+
*/
|
|
2608
|
+
enable_bridge_audio_cue?: boolean;
|
|
2609
|
+
/**
|
|
2610
|
+
* The music to play while the caller is being transferred.
|
|
2611
|
+
*/
|
|
2612
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
2613
|
+
/**
|
|
2614
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
2615
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
2616
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
2617
|
+
*/
|
|
2618
|
+
public_handoff_option?: TransferOptionAgenticWarmTransfer.WarmTransferPrompt | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
2619
|
+
/**
|
|
2620
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
2621
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
2622
|
+
* Twilio numbers support this option.
|
|
2623
|
+
*/
|
|
2624
|
+
show_transferee_as_caller?: boolean;
|
|
2625
|
+
}
|
|
2626
|
+
namespace TransferOptionAgenticWarmTransfer {
|
|
2627
|
+
/**
|
|
2628
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
2629
|
+
*/
|
|
2630
|
+
interface AgenticTransferConfig {
|
|
2631
|
+
/**
|
|
2632
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
2633
|
+
* Defaults to cancel_transfer.
|
|
2634
|
+
*/
|
|
2635
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
2636
|
+
/**
|
|
2637
|
+
* The agent that will mediate the transfer decision.
|
|
2638
|
+
*/
|
|
2639
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
2640
|
+
/**
|
|
2641
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
2642
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
2643
|
+
*/
|
|
2644
|
+
transfer_timeout_ms?: number;
|
|
2645
|
+
}
|
|
2646
|
+
namespace AgenticTransferConfig {
|
|
2647
|
+
/**
|
|
2648
|
+
* The agent that will mediate the transfer decision.
|
|
2649
|
+
*/
|
|
2650
|
+
interface TransferAgent {
|
|
2651
|
+
/**
|
|
2652
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
2653
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
2654
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
2655
|
+
*/
|
|
2656
|
+
agent_id: string;
|
|
2657
|
+
/**
|
|
2658
|
+
* The version of the transfer agent to use.
|
|
2659
|
+
*/
|
|
2660
|
+
agent_version: number;
|
|
2661
|
+
}
|
|
2662
|
+
}
|
|
2663
|
+
interface WarmTransferPrompt {
|
|
2664
|
+
/**
|
|
2665
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
2666
|
+
*/
|
|
2667
|
+
prompt?: string;
|
|
2668
|
+
type?: 'prompt';
|
|
2669
|
+
}
|
|
2670
|
+
interface WarmTransferStaticMessage {
|
|
2671
|
+
/**
|
|
2672
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
2673
|
+
*/
|
|
2674
|
+
message?: string;
|
|
2675
|
+
type?: 'static_message';
|
|
2676
|
+
}
|
|
2677
|
+
}
|
|
2350
2678
|
}
|
|
2351
2679
|
interface CheckAvailabilityCalTool {
|
|
2352
2680
|
/**
|
|
@@ -2801,7 +3129,7 @@ export interface LlmUpdateParams {
|
|
|
2801
3129
|
* Body param: Select the underlying text LLM. If not set, would default to
|
|
2802
3130
|
* gpt-4.1.
|
|
2803
3131
|
*/
|
|
2804
|
-
model?: 'gpt-
|
|
3132
|
+
model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | null;
|
|
2805
3133
|
/**
|
|
2806
3134
|
* Body param: If set to true, will use high priority pool with more dedicated
|
|
2807
3135
|
* resource to ensure lower and more consistent latency, default to false. This
|
|
@@ -2870,7 +3198,7 @@ export declare namespace LlmUpdateParams {
|
|
|
2870
3198
|
*/
|
|
2871
3199
|
name: string;
|
|
2872
3200
|
transfer_destination: TransferCallTool.TransferDestinationPredefined | TransferCallTool.TransferDestinationInferred;
|
|
2873
|
-
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer;
|
|
3201
|
+
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer | TransferCallTool.TransferOptionAgenticWarmTransfer;
|
|
2874
3202
|
type: 'transfer_call';
|
|
2875
3203
|
/**
|
|
2876
3204
|
* Custom SIP headers to be added to the call.
|
|
@@ -3020,6 +3348,88 @@ export declare namespace LlmUpdateParams {
|
|
|
3020
3348
|
type?: 'static_message';
|
|
3021
3349
|
}
|
|
3022
3350
|
}
|
|
3351
|
+
interface TransferOptionAgenticWarmTransfer {
|
|
3352
|
+
/**
|
|
3353
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
3354
|
+
*/
|
|
3355
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
3356
|
+
/**
|
|
3357
|
+
* The type of the transfer.
|
|
3358
|
+
*/
|
|
3359
|
+
type: 'agentic_warm_transfer';
|
|
3360
|
+
/**
|
|
3361
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
3362
|
+
*/
|
|
3363
|
+
enable_bridge_audio_cue?: boolean;
|
|
3364
|
+
/**
|
|
3365
|
+
* The music to play while the caller is being transferred.
|
|
3366
|
+
*/
|
|
3367
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
3368
|
+
/**
|
|
3369
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
3370
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
3371
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
3372
|
+
*/
|
|
3373
|
+
public_handoff_option?: TransferOptionAgenticWarmTransfer.WarmTransferPrompt | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
3374
|
+
/**
|
|
3375
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
3376
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
3377
|
+
* Twilio numbers support this option.
|
|
3378
|
+
*/
|
|
3379
|
+
show_transferee_as_caller?: boolean;
|
|
3380
|
+
}
|
|
3381
|
+
namespace TransferOptionAgenticWarmTransfer {
|
|
3382
|
+
/**
|
|
3383
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
3384
|
+
*/
|
|
3385
|
+
interface AgenticTransferConfig {
|
|
3386
|
+
/**
|
|
3387
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
3388
|
+
* Defaults to cancel_transfer.
|
|
3389
|
+
*/
|
|
3390
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
3391
|
+
/**
|
|
3392
|
+
* The agent that will mediate the transfer decision.
|
|
3393
|
+
*/
|
|
3394
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
3395
|
+
/**
|
|
3396
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
3397
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
3398
|
+
*/
|
|
3399
|
+
transfer_timeout_ms?: number;
|
|
3400
|
+
}
|
|
3401
|
+
namespace AgenticTransferConfig {
|
|
3402
|
+
/**
|
|
3403
|
+
* The agent that will mediate the transfer decision.
|
|
3404
|
+
*/
|
|
3405
|
+
interface TransferAgent {
|
|
3406
|
+
/**
|
|
3407
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
3408
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
3409
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
3410
|
+
*/
|
|
3411
|
+
agent_id: string;
|
|
3412
|
+
/**
|
|
3413
|
+
* The version of the transfer agent to use.
|
|
3414
|
+
*/
|
|
3415
|
+
agent_version: number;
|
|
3416
|
+
}
|
|
3417
|
+
}
|
|
3418
|
+
interface WarmTransferPrompt {
|
|
3419
|
+
/**
|
|
3420
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
3421
|
+
*/
|
|
3422
|
+
prompt?: string;
|
|
3423
|
+
type?: 'prompt';
|
|
3424
|
+
}
|
|
3425
|
+
interface WarmTransferStaticMessage {
|
|
3426
|
+
/**
|
|
3427
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
3428
|
+
*/
|
|
3429
|
+
message?: string;
|
|
3430
|
+
type?: 'static_message';
|
|
3431
|
+
}
|
|
3432
|
+
}
|
|
3023
3433
|
}
|
|
3024
3434
|
interface CheckAvailabilityCalTool {
|
|
3025
3435
|
/**
|
|
@@ -3542,7 +3952,7 @@ export declare namespace LlmUpdateParams {
|
|
|
3542
3952
|
*/
|
|
3543
3953
|
name: string;
|
|
3544
3954
|
transfer_destination: TransferCallTool.TransferDestinationPredefined | TransferCallTool.TransferDestinationInferred;
|
|
3545
|
-
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer;
|
|
3955
|
+
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer | TransferCallTool.TransferOptionAgenticWarmTransfer;
|
|
3546
3956
|
type: 'transfer_call';
|
|
3547
3957
|
/**
|
|
3548
3958
|
* Custom SIP headers to be added to the call.
|
|
@@ -3692,6 +4102,88 @@ export declare namespace LlmUpdateParams {
|
|
|
3692
4102
|
type?: 'static_message';
|
|
3693
4103
|
}
|
|
3694
4104
|
}
|
|
4105
|
+
interface TransferOptionAgenticWarmTransfer {
|
|
4106
|
+
/**
|
|
4107
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
4108
|
+
*/
|
|
4109
|
+
agentic_transfer_config: TransferOptionAgenticWarmTransfer.AgenticTransferConfig;
|
|
4110
|
+
/**
|
|
4111
|
+
* The type of the transfer.
|
|
4112
|
+
*/
|
|
4113
|
+
type: 'agentic_warm_transfer';
|
|
4114
|
+
/**
|
|
4115
|
+
* Whether to play an audio cue when bridging the call. Defaults to true.
|
|
4116
|
+
*/
|
|
4117
|
+
enable_bridge_audio_cue?: boolean;
|
|
4118
|
+
/**
|
|
4119
|
+
* The music to play while the caller is being transferred.
|
|
4120
|
+
*/
|
|
4121
|
+
on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
|
|
4122
|
+
/**
|
|
4123
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
4124
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
4125
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
4126
|
+
*/
|
|
4127
|
+
public_handoff_option?: TransferOptionAgenticWarmTransfer.WarmTransferPrompt | TransferOptionAgenticWarmTransfer.WarmTransferStaticMessage;
|
|
4128
|
+
/**
|
|
4129
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
4130
|
+
* transferring, requires the telephony side to support caller id override. Retell
|
|
4131
|
+
* Twilio numbers support this option.
|
|
4132
|
+
*/
|
|
4133
|
+
show_transferee_as_caller?: boolean;
|
|
4134
|
+
}
|
|
4135
|
+
namespace TransferOptionAgenticWarmTransfer {
|
|
4136
|
+
/**
|
|
4137
|
+
* Configuration for agentic warm transfer. Required for agentic warm transfer.
|
|
4138
|
+
*/
|
|
4139
|
+
interface AgenticTransferConfig {
|
|
4140
|
+
/**
|
|
4141
|
+
* The action to take when the transfer agent times out without making a decision.
|
|
4142
|
+
* Defaults to cancel_transfer.
|
|
4143
|
+
*/
|
|
4144
|
+
action_on_timeout?: 'bridge_transfer' | 'cancel_transfer';
|
|
4145
|
+
/**
|
|
4146
|
+
* The agent that will mediate the transfer decision.
|
|
4147
|
+
*/
|
|
4148
|
+
transfer_agent?: AgenticTransferConfig.TransferAgent;
|
|
4149
|
+
/**
|
|
4150
|
+
* The maximum time to wait for the transfer agent to make a decision, in
|
|
4151
|
+
* milliseconds. Defaults to 30000 (30 seconds).
|
|
4152
|
+
*/
|
|
4153
|
+
transfer_timeout_ms?: number;
|
|
4154
|
+
}
|
|
4155
|
+
namespace AgenticTransferConfig {
|
|
4156
|
+
/**
|
|
4157
|
+
* The agent that will mediate the transfer decision.
|
|
4158
|
+
*/
|
|
4159
|
+
interface TransferAgent {
|
|
4160
|
+
/**
|
|
4161
|
+
* The agent ID of the transfer agent. This agent must have isTransferAgent set to
|
|
4162
|
+
* true and should use bridge_transfer and cancel_transfer tools (for Retell LLM)
|
|
4163
|
+
* or BridgeTransferNode and CancelTransferNode (for Conversation Flow).
|
|
4164
|
+
*/
|
|
4165
|
+
agent_id: string;
|
|
4166
|
+
/**
|
|
4167
|
+
* The version of the transfer agent to use.
|
|
4168
|
+
*/
|
|
4169
|
+
agent_version: number;
|
|
4170
|
+
}
|
|
4171
|
+
}
|
|
4172
|
+
interface WarmTransferPrompt {
|
|
4173
|
+
/**
|
|
4174
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
4175
|
+
*/
|
|
4176
|
+
prompt?: string;
|
|
4177
|
+
type?: 'prompt';
|
|
4178
|
+
}
|
|
4179
|
+
interface WarmTransferStaticMessage {
|
|
4180
|
+
/**
|
|
4181
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
4182
|
+
*/
|
|
4183
|
+
message?: string;
|
|
4184
|
+
type?: 'static_message';
|
|
4185
|
+
}
|
|
4186
|
+
}
|
|
3695
4187
|
}
|
|
3696
4188
|
interface CheckAvailabilityCalTool {
|
|
3697
4189
|
/**
|