retell-sdk 5.12.0 → 5.13.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 +23 -0
- package/internal/utils/env.js +2 -2
- package/internal/utils/env.js.map +1 -1
- package/internal/utils/env.mjs +2 -2
- package/internal/utils/env.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/agent.d.mts +22 -45
- package/resources/agent.d.mts.map +1 -1
- package/resources/agent.d.ts +22 -45
- package/resources/agent.d.ts.map +1 -1
- package/resources/batch-call.d.mts +8 -17
- package/resources/batch-call.d.mts.map +1 -1
- package/resources/batch-call.d.ts +8 -17
- package/resources/batch-call.d.ts.map +1 -1
- package/resources/call.d.mts +55 -54
- package/resources/call.d.mts.map +1 -1
- package/resources/call.d.ts +55 -54
- package/resources/call.d.ts.map +1 -1
- package/resources/chat-agent.d.mts +10 -6
- package/resources/chat-agent.d.mts.map +1 -1
- package/resources/chat-agent.d.ts +10 -6
- package/resources/chat-agent.d.ts.map +1 -1
- package/resources/chat.d.mts +90 -76
- package/resources/chat.d.mts.map +1 -1
- package/resources/chat.d.ts +90 -76
- package/resources/chat.d.ts.map +1 -1
- package/resources/conversation-flow-component.d.mts +207 -48
- package/resources/conversation-flow-component.d.mts.map +1 -1
- package/resources/conversation-flow-component.d.ts +207 -48
- package/resources/conversation-flow-component.d.ts.map +1 -1
- package/resources/conversation-flow.d.mts +417 -99
- package/resources/conversation-flow.d.mts.map +1 -1
- package/resources/conversation-flow.d.ts +417 -99
- package/resources/conversation-flow.d.ts.map +1 -1
- package/resources/llm.d.mts +153 -9
- package/resources/llm.d.mts.map +1 -1
- package/resources/llm.d.ts +153 -9
- package/resources/llm.d.ts.map +1 -1
- package/resources/phone-number.d.mts +22 -125
- package/resources/phone-number.d.mts.map +1 -1
- package/resources/phone-number.d.ts +22 -125
- package/resources/phone-number.d.ts.map +1 -1
- package/resources/phone-number.js +14 -2
- package/resources/phone-number.js.map +1 -1
- package/resources/phone-number.mjs +14 -2
- package/resources/phone-number.mjs.map +1 -1
- package/resources/tests.d.mts +4 -8
- package/resources/tests.d.mts.map +1 -1
- package/resources/tests.d.ts +4 -8
- package/resources/tests.d.ts.map +1 -1
- package/src/internal/utils/env.ts +2 -2
- package/src/resources/agent.ts +23 -42
- package/src/resources/batch-call.ts +9 -15
- package/src/resources/call.ts +64 -47
- package/src/resources/chat-agent.ts +11 -3
- package/src/resources/chat.ts +106 -90
- package/src/resources/conversation-flow-component.ts +300 -48
- package/src/resources/conversation-flow.ts +606 -99
- package/src/resources/llm.ts +201 -6
- package/src/resources/phone-number.ts +22 -141
- package/src/resources/tests.ts +7 -9
- 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/src/resources/llm.ts
CHANGED
|
@@ -195,6 +195,7 @@ export interface LlmResponse {
|
|
|
195
195
|
| 'gemini-2.5-flash'
|
|
196
196
|
| 'gemini-2.5-flash-lite'
|
|
197
197
|
| 'gemini-3.0-flash'
|
|
198
|
+
| 'gemini-3.1-flash-lite'
|
|
198
199
|
| null;
|
|
199
200
|
|
|
200
201
|
/**
|
|
@@ -805,7 +806,10 @@ export namespace LlmResponse {
|
|
|
805
806
|
*/
|
|
806
807
|
name: string;
|
|
807
808
|
|
|
808
|
-
sms_content:
|
|
809
|
+
sms_content:
|
|
810
|
+
| SendSMSTool.SMSContentPredefined
|
|
811
|
+
| SendSMSTool.SMSContentInferred
|
|
812
|
+
| SendSMSTool.SMSContentTemplate;
|
|
809
813
|
|
|
810
814
|
type: 'send_sms';
|
|
811
815
|
|
|
@@ -856,6 +860,16 @@ export namespace LlmResponse {
|
|
|
856
860
|
|
|
857
861
|
type?: 'inferred';
|
|
858
862
|
}
|
|
863
|
+
|
|
864
|
+
export interface SMSContentTemplate {
|
|
865
|
+
/**
|
|
866
|
+
* The template to use for the SMS content. "info_collection" sends a predefined
|
|
867
|
+
* message requesting information from the user.
|
|
868
|
+
*/
|
|
869
|
+
template: 'info_collection';
|
|
870
|
+
|
|
871
|
+
type: 'template';
|
|
872
|
+
}
|
|
859
873
|
}
|
|
860
874
|
|
|
861
875
|
export interface CustomTool {
|
|
@@ -886,6 +900,13 @@ export namespace LlmResponse {
|
|
|
886
900
|
*/
|
|
887
901
|
description?: string;
|
|
888
902
|
|
|
903
|
+
/**
|
|
904
|
+
* If true, play a typing sound on the agent audio track while this tool is
|
|
905
|
+
* executing. Useful when the tool takes a noticeable amount of time to prevent
|
|
906
|
+
* silence on the call.
|
|
907
|
+
*/
|
|
908
|
+
enable_typing_sound?: boolean;
|
|
909
|
+
|
|
889
910
|
/**
|
|
890
911
|
* The description for the sentence agent say during execution. Only applicable
|
|
891
912
|
* when speak_during_execution is true. Can write what to say or even provide
|
|
@@ -1005,6 +1026,12 @@ export namespace LlmResponse {
|
|
|
1005
1026
|
*/
|
|
1006
1027
|
description?: string;
|
|
1007
1028
|
|
|
1029
|
+
/**
|
|
1030
|
+
* If true, play a typing sound on the agent audio track while this tool is
|
|
1031
|
+
* executing.
|
|
1032
|
+
*/
|
|
1033
|
+
enable_typing_sound?: boolean;
|
|
1034
|
+
|
|
1008
1035
|
/**
|
|
1009
1036
|
* The description for the sentence agent say during execution. Only applicable
|
|
1010
1037
|
* when speak_during_execution is true.
|
|
@@ -1295,6 +1322,12 @@ export namespace LlmResponse {
|
|
|
1295
1322
|
|
|
1296
1323
|
type: 'mcp';
|
|
1297
1324
|
|
|
1325
|
+
/**
|
|
1326
|
+
* If true, play a typing sound on the agent audio track while this MCP tool is
|
|
1327
|
+
* executing.
|
|
1328
|
+
*/
|
|
1329
|
+
enable_typing_sound?: boolean;
|
|
1330
|
+
|
|
1298
1331
|
/**
|
|
1299
1332
|
* The description for the sentence agent say during execution. Only applicable
|
|
1300
1333
|
* when speak_during_execution is true. Can write what to say or even provide
|
|
@@ -2039,7 +2072,10 @@ export namespace LlmResponse {
|
|
|
2039
2072
|
*/
|
|
2040
2073
|
name: string;
|
|
2041
2074
|
|
|
2042
|
-
sms_content:
|
|
2075
|
+
sms_content:
|
|
2076
|
+
| SendSMSTool.SMSContentPredefined
|
|
2077
|
+
| SendSMSTool.SMSContentInferred
|
|
2078
|
+
| SendSMSTool.SMSContentTemplate;
|
|
2043
2079
|
|
|
2044
2080
|
type: 'send_sms';
|
|
2045
2081
|
|
|
@@ -2090,6 +2126,16 @@ export namespace LlmResponse {
|
|
|
2090
2126
|
|
|
2091
2127
|
type?: 'inferred';
|
|
2092
2128
|
}
|
|
2129
|
+
|
|
2130
|
+
export interface SMSContentTemplate {
|
|
2131
|
+
/**
|
|
2132
|
+
* The template to use for the SMS content. "info_collection" sends a predefined
|
|
2133
|
+
* message requesting information from the user.
|
|
2134
|
+
*/
|
|
2135
|
+
template: 'info_collection';
|
|
2136
|
+
|
|
2137
|
+
type: 'template';
|
|
2138
|
+
}
|
|
2093
2139
|
}
|
|
2094
2140
|
|
|
2095
2141
|
export interface CustomTool {
|
|
@@ -2120,6 +2166,13 @@ export namespace LlmResponse {
|
|
|
2120
2166
|
*/
|
|
2121
2167
|
description?: string;
|
|
2122
2168
|
|
|
2169
|
+
/**
|
|
2170
|
+
* If true, play a typing sound on the agent audio track while this tool is
|
|
2171
|
+
* executing. Useful when the tool takes a noticeable amount of time to prevent
|
|
2172
|
+
* silence on the call.
|
|
2173
|
+
*/
|
|
2174
|
+
enable_typing_sound?: boolean;
|
|
2175
|
+
|
|
2123
2176
|
/**
|
|
2124
2177
|
* The description for the sentence agent say during execution. Only applicable
|
|
2125
2178
|
* when speak_during_execution is true. Can write what to say or even provide
|
|
@@ -2239,6 +2292,12 @@ export namespace LlmResponse {
|
|
|
2239
2292
|
*/
|
|
2240
2293
|
description?: string;
|
|
2241
2294
|
|
|
2295
|
+
/**
|
|
2296
|
+
* If true, play a typing sound on the agent audio track while this tool is
|
|
2297
|
+
* executing.
|
|
2298
|
+
*/
|
|
2299
|
+
enable_typing_sound?: boolean;
|
|
2300
|
+
|
|
2242
2301
|
/**
|
|
2243
2302
|
* The description for the sentence agent say during execution. Only applicable
|
|
2244
2303
|
* when speak_during_execution is true.
|
|
@@ -2529,6 +2588,12 @@ export namespace LlmResponse {
|
|
|
2529
2588
|
|
|
2530
2589
|
type: 'mcp';
|
|
2531
2590
|
|
|
2591
|
+
/**
|
|
2592
|
+
* If true, play a typing sound on the agent audio track while this MCP tool is
|
|
2593
|
+
* executing.
|
|
2594
|
+
*/
|
|
2595
|
+
enable_typing_sound?: boolean;
|
|
2596
|
+
|
|
2532
2597
|
/**
|
|
2533
2598
|
* The description for the sentence agent say during execution. Only applicable
|
|
2534
2599
|
* when speak_during_execution is true. Can write what to say or even provide
|
|
@@ -2671,6 +2736,7 @@ export interface LlmCreateParams {
|
|
|
2671
2736
|
| 'gemini-2.5-flash'
|
|
2672
2737
|
| 'gemini-2.5-flash-lite'
|
|
2673
2738
|
| 'gemini-3.0-flash'
|
|
2739
|
+
| 'gemini-3.1-flash-lite'
|
|
2674
2740
|
| null;
|
|
2675
2741
|
|
|
2676
2742
|
/**
|
|
@@ -3281,7 +3347,10 @@ export namespace LlmCreateParams {
|
|
|
3281
3347
|
*/
|
|
3282
3348
|
name: string;
|
|
3283
3349
|
|
|
3284
|
-
sms_content:
|
|
3350
|
+
sms_content:
|
|
3351
|
+
| SendSMSTool.SMSContentPredefined
|
|
3352
|
+
| SendSMSTool.SMSContentInferred
|
|
3353
|
+
| SendSMSTool.SMSContentTemplate;
|
|
3285
3354
|
|
|
3286
3355
|
type: 'send_sms';
|
|
3287
3356
|
|
|
@@ -3332,6 +3401,16 @@ export namespace LlmCreateParams {
|
|
|
3332
3401
|
|
|
3333
3402
|
type?: 'inferred';
|
|
3334
3403
|
}
|
|
3404
|
+
|
|
3405
|
+
export interface SMSContentTemplate {
|
|
3406
|
+
/**
|
|
3407
|
+
* The template to use for the SMS content. "info_collection" sends a predefined
|
|
3408
|
+
* message requesting information from the user.
|
|
3409
|
+
*/
|
|
3410
|
+
template: 'info_collection';
|
|
3411
|
+
|
|
3412
|
+
type: 'template';
|
|
3413
|
+
}
|
|
3335
3414
|
}
|
|
3336
3415
|
|
|
3337
3416
|
export interface CustomTool {
|
|
@@ -3362,6 +3441,13 @@ export namespace LlmCreateParams {
|
|
|
3362
3441
|
*/
|
|
3363
3442
|
description?: string;
|
|
3364
3443
|
|
|
3444
|
+
/**
|
|
3445
|
+
* If true, play a typing sound on the agent audio track while this tool is
|
|
3446
|
+
* executing. Useful when the tool takes a noticeable amount of time to prevent
|
|
3447
|
+
* silence on the call.
|
|
3448
|
+
*/
|
|
3449
|
+
enable_typing_sound?: boolean;
|
|
3450
|
+
|
|
3365
3451
|
/**
|
|
3366
3452
|
* The description for the sentence agent say during execution. Only applicable
|
|
3367
3453
|
* when speak_during_execution is true. Can write what to say or even provide
|
|
@@ -3481,6 +3567,12 @@ export namespace LlmCreateParams {
|
|
|
3481
3567
|
*/
|
|
3482
3568
|
description?: string;
|
|
3483
3569
|
|
|
3570
|
+
/**
|
|
3571
|
+
* If true, play a typing sound on the agent audio track while this tool is
|
|
3572
|
+
* executing.
|
|
3573
|
+
*/
|
|
3574
|
+
enable_typing_sound?: boolean;
|
|
3575
|
+
|
|
3484
3576
|
/**
|
|
3485
3577
|
* The description for the sentence agent say during execution. Only applicable
|
|
3486
3578
|
* when speak_during_execution is true.
|
|
@@ -3771,6 +3863,12 @@ export namespace LlmCreateParams {
|
|
|
3771
3863
|
|
|
3772
3864
|
type: 'mcp';
|
|
3773
3865
|
|
|
3866
|
+
/**
|
|
3867
|
+
* If true, play a typing sound on the agent audio track while this MCP tool is
|
|
3868
|
+
* executing.
|
|
3869
|
+
*/
|
|
3870
|
+
enable_typing_sound?: boolean;
|
|
3871
|
+
|
|
3774
3872
|
/**
|
|
3775
3873
|
* The description for the sentence agent say during execution. Only applicable
|
|
3776
3874
|
* when speak_during_execution is true. Can write what to say or even provide
|
|
@@ -4515,7 +4613,10 @@ export namespace LlmCreateParams {
|
|
|
4515
4613
|
*/
|
|
4516
4614
|
name: string;
|
|
4517
4615
|
|
|
4518
|
-
sms_content:
|
|
4616
|
+
sms_content:
|
|
4617
|
+
| SendSMSTool.SMSContentPredefined
|
|
4618
|
+
| SendSMSTool.SMSContentInferred
|
|
4619
|
+
| SendSMSTool.SMSContentTemplate;
|
|
4519
4620
|
|
|
4520
4621
|
type: 'send_sms';
|
|
4521
4622
|
|
|
@@ -4566,6 +4667,16 @@ export namespace LlmCreateParams {
|
|
|
4566
4667
|
|
|
4567
4668
|
type?: 'inferred';
|
|
4568
4669
|
}
|
|
4670
|
+
|
|
4671
|
+
export interface SMSContentTemplate {
|
|
4672
|
+
/**
|
|
4673
|
+
* The template to use for the SMS content. "info_collection" sends a predefined
|
|
4674
|
+
* message requesting information from the user.
|
|
4675
|
+
*/
|
|
4676
|
+
template: 'info_collection';
|
|
4677
|
+
|
|
4678
|
+
type: 'template';
|
|
4679
|
+
}
|
|
4569
4680
|
}
|
|
4570
4681
|
|
|
4571
4682
|
export interface CustomTool {
|
|
@@ -4596,6 +4707,13 @@ export namespace LlmCreateParams {
|
|
|
4596
4707
|
*/
|
|
4597
4708
|
description?: string;
|
|
4598
4709
|
|
|
4710
|
+
/**
|
|
4711
|
+
* If true, play a typing sound on the agent audio track while this tool is
|
|
4712
|
+
* executing. Useful when the tool takes a noticeable amount of time to prevent
|
|
4713
|
+
* silence on the call.
|
|
4714
|
+
*/
|
|
4715
|
+
enable_typing_sound?: boolean;
|
|
4716
|
+
|
|
4599
4717
|
/**
|
|
4600
4718
|
* The description for the sentence agent say during execution. Only applicable
|
|
4601
4719
|
* when speak_during_execution is true. Can write what to say or even provide
|
|
@@ -4715,6 +4833,12 @@ export namespace LlmCreateParams {
|
|
|
4715
4833
|
*/
|
|
4716
4834
|
description?: string;
|
|
4717
4835
|
|
|
4836
|
+
/**
|
|
4837
|
+
* If true, play a typing sound on the agent audio track while this tool is
|
|
4838
|
+
* executing.
|
|
4839
|
+
*/
|
|
4840
|
+
enable_typing_sound?: boolean;
|
|
4841
|
+
|
|
4718
4842
|
/**
|
|
4719
4843
|
* The description for the sentence agent say during execution. Only applicable
|
|
4720
4844
|
* when speak_during_execution is true.
|
|
@@ -5005,6 +5129,12 @@ export namespace LlmCreateParams {
|
|
|
5005
5129
|
|
|
5006
5130
|
type: 'mcp';
|
|
5007
5131
|
|
|
5132
|
+
/**
|
|
5133
|
+
* If true, play a typing sound on the agent audio track while this MCP tool is
|
|
5134
|
+
* executing.
|
|
5135
|
+
*/
|
|
5136
|
+
enable_typing_sound?: boolean;
|
|
5137
|
+
|
|
5008
5138
|
/**
|
|
5009
5139
|
* The description for the sentence agent say during execution. Only applicable
|
|
5010
5140
|
* when speak_during_execution is true. Can write what to say or even provide
|
|
@@ -5161,6 +5291,7 @@ export interface LlmUpdateParams {
|
|
|
5161
5291
|
| 'gemini-2.5-flash'
|
|
5162
5292
|
| 'gemini-2.5-flash-lite'
|
|
5163
5293
|
| 'gemini-3.0-flash'
|
|
5294
|
+
| 'gemini-3.1-flash-lite'
|
|
5164
5295
|
| null;
|
|
5165
5296
|
|
|
5166
5297
|
/**
|
|
@@ -5771,7 +5902,10 @@ export namespace LlmUpdateParams {
|
|
|
5771
5902
|
*/
|
|
5772
5903
|
name: string;
|
|
5773
5904
|
|
|
5774
|
-
sms_content:
|
|
5905
|
+
sms_content:
|
|
5906
|
+
| SendSMSTool.SMSContentPredefined
|
|
5907
|
+
| SendSMSTool.SMSContentInferred
|
|
5908
|
+
| SendSMSTool.SMSContentTemplate;
|
|
5775
5909
|
|
|
5776
5910
|
type: 'send_sms';
|
|
5777
5911
|
|
|
@@ -5822,6 +5956,16 @@ export namespace LlmUpdateParams {
|
|
|
5822
5956
|
|
|
5823
5957
|
type?: 'inferred';
|
|
5824
5958
|
}
|
|
5959
|
+
|
|
5960
|
+
export interface SMSContentTemplate {
|
|
5961
|
+
/**
|
|
5962
|
+
* The template to use for the SMS content. "info_collection" sends a predefined
|
|
5963
|
+
* message requesting information from the user.
|
|
5964
|
+
*/
|
|
5965
|
+
template: 'info_collection';
|
|
5966
|
+
|
|
5967
|
+
type: 'template';
|
|
5968
|
+
}
|
|
5825
5969
|
}
|
|
5826
5970
|
|
|
5827
5971
|
export interface CustomTool {
|
|
@@ -5852,6 +5996,13 @@ export namespace LlmUpdateParams {
|
|
|
5852
5996
|
*/
|
|
5853
5997
|
description?: string;
|
|
5854
5998
|
|
|
5999
|
+
/**
|
|
6000
|
+
* If true, play a typing sound on the agent audio track while this tool is
|
|
6001
|
+
* executing. Useful when the tool takes a noticeable amount of time to prevent
|
|
6002
|
+
* silence on the call.
|
|
6003
|
+
*/
|
|
6004
|
+
enable_typing_sound?: boolean;
|
|
6005
|
+
|
|
5855
6006
|
/**
|
|
5856
6007
|
* The description for the sentence agent say during execution. Only applicable
|
|
5857
6008
|
* when speak_during_execution is true. Can write what to say or even provide
|
|
@@ -5971,6 +6122,12 @@ export namespace LlmUpdateParams {
|
|
|
5971
6122
|
*/
|
|
5972
6123
|
description?: string;
|
|
5973
6124
|
|
|
6125
|
+
/**
|
|
6126
|
+
* If true, play a typing sound on the agent audio track while this tool is
|
|
6127
|
+
* executing.
|
|
6128
|
+
*/
|
|
6129
|
+
enable_typing_sound?: boolean;
|
|
6130
|
+
|
|
5974
6131
|
/**
|
|
5975
6132
|
* The description for the sentence agent say during execution. Only applicable
|
|
5976
6133
|
* when speak_during_execution is true.
|
|
@@ -6261,6 +6418,12 @@ export namespace LlmUpdateParams {
|
|
|
6261
6418
|
|
|
6262
6419
|
type: 'mcp';
|
|
6263
6420
|
|
|
6421
|
+
/**
|
|
6422
|
+
* If true, play a typing sound on the agent audio track while this MCP tool is
|
|
6423
|
+
* executing.
|
|
6424
|
+
*/
|
|
6425
|
+
enable_typing_sound?: boolean;
|
|
6426
|
+
|
|
6264
6427
|
/**
|
|
6265
6428
|
* The description for the sentence agent say during execution. Only applicable
|
|
6266
6429
|
* when speak_during_execution is true. Can write what to say or even provide
|
|
@@ -7005,7 +7168,10 @@ export namespace LlmUpdateParams {
|
|
|
7005
7168
|
*/
|
|
7006
7169
|
name: string;
|
|
7007
7170
|
|
|
7008
|
-
sms_content:
|
|
7171
|
+
sms_content:
|
|
7172
|
+
| SendSMSTool.SMSContentPredefined
|
|
7173
|
+
| SendSMSTool.SMSContentInferred
|
|
7174
|
+
| SendSMSTool.SMSContentTemplate;
|
|
7009
7175
|
|
|
7010
7176
|
type: 'send_sms';
|
|
7011
7177
|
|
|
@@ -7056,6 +7222,16 @@ export namespace LlmUpdateParams {
|
|
|
7056
7222
|
|
|
7057
7223
|
type?: 'inferred';
|
|
7058
7224
|
}
|
|
7225
|
+
|
|
7226
|
+
export interface SMSContentTemplate {
|
|
7227
|
+
/**
|
|
7228
|
+
* The template to use for the SMS content. "info_collection" sends a predefined
|
|
7229
|
+
* message requesting information from the user.
|
|
7230
|
+
*/
|
|
7231
|
+
template: 'info_collection';
|
|
7232
|
+
|
|
7233
|
+
type: 'template';
|
|
7234
|
+
}
|
|
7059
7235
|
}
|
|
7060
7236
|
|
|
7061
7237
|
export interface CustomTool {
|
|
@@ -7086,6 +7262,13 @@ export namespace LlmUpdateParams {
|
|
|
7086
7262
|
*/
|
|
7087
7263
|
description?: string;
|
|
7088
7264
|
|
|
7265
|
+
/**
|
|
7266
|
+
* If true, play a typing sound on the agent audio track while this tool is
|
|
7267
|
+
* executing. Useful when the tool takes a noticeable amount of time to prevent
|
|
7268
|
+
* silence on the call.
|
|
7269
|
+
*/
|
|
7270
|
+
enable_typing_sound?: boolean;
|
|
7271
|
+
|
|
7089
7272
|
/**
|
|
7090
7273
|
* The description for the sentence agent say during execution. Only applicable
|
|
7091
7274
|
* when speak_during_execution is true. Can write what to say or even provide
|
|
@@ -7205,6 +7388,12 @@ export namespace LlmUpdateParams {
|
|
|
7205
7388
|
*/
|
|
7206
7389
|
description?: string;
|
|
7207
7390
|
|
|
7391
|
+
/**
|
|
7392
|
+
* If true, play a typing sound on the agent audio track while this tool is
|
|
7393
|
+
* executing.
|
|
7394
|
+
*/
|
|
7395
|
+
enable_typing_sound?: boolean;
|
|
7396
|
+
|
|
7208
7397
|
/**
|
|
7209
7398
|
* The description for the sentence agent say during execution. Only applicable
|
|
7210
7399
|
* when speak_during_execution is true.
|
|
@@ -7495,6 +7684,12 @@ export namespace LlmUpdateParams {
|
|
|
7495
7684
|
|
|
7496
7685
|
type: 'mcp';
|
|
7497
7686
|
|
|
7687
|
+
/**
|
|
7688
|
+
* If true, play a typing sound on the agent audio track while this MCP tool is
|
|
7689
|
+
* executing.
|
|
7690
|
+
*/
|
|
7691
|
+
enable_typing_sound?: boolean;
|
|
7692
|
+
|
|
7498
7693
|
/**
|
|
7499
7694
|
* The description for the sentence agent say during execution. Only applicable
|
|
7500
7695
|
* when speak_during_execution is true. Can write what to say or even provide
|
|
@@ -41,9 +41,21 @@ export class PhoneNumber extends APIResource {
|
|
|
41
41
|
* const phoneNumberResponse = await client.phoneNumber.update(
|
|
42
42
|
* '+14157774444',
|
|
43
43
|
* {
|
|
44
|
-
*
|
|
44
|
+
* inbound_agents: [
|
|
45
|
+
* {
|
|
46
|
+
* agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
|
|
47
|
+
* agent_version: 1,
|
|
48
|
+
* weight: 1,
|
|
49
|
+
* },
|
|
50
|
+
* ],
|
|
45
51
|
* nickname: 'Frontdesk Number',
|
|
46
|
-
*
|
|
52
|
+
* outbound_agents: [
|
|
53
|
+
* {
|
|
54
|
+
* agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
|
|
55
|
+
* agent_version: 1,
|
|
56
|
+
* weight: 1,
|
|
57
|
+
* },
|
|
58
|
+
* ],
|
|
47
59
|
* },
|
|
48
60
|
* );
|
|
49
61
|
* ```
|
|
@@ -146,26 +158,10 @@ export interface PhoneNumberResponse {
|
|
|
146
158
|
*/
|
|
147
159
|
fallback_number?: string | null;
|
|
148
160
|
|
|
149
|
-
/**
|
|
150
|
-
* @deprecated Unique id of agent to bind to the number. The number will
|
|
151
|
-
* automatically use the agent when receiving inbound calls. If null, this number
|
|
152
|
-
* would not accept inbound call. Deprecated. See
|
|
153
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
154
|
-
*/
|
|
155
|
-
inbound_agent_id?: string | null;
|
|
156
|
-
|
|
157
|
-
/**
|
|
158
|
-
* @deprecated Version of the inbound agent to bind to the number. If not provided,
|
|
159
|
-
* will default to latest version. Deprecated. See
|
|
160
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
161
|
-
*/
|
|
162
|
-
inbound_agent_version?: number | null;
|
|
163
|
-
|
|
164
161
|
/**
|
|
165
162
|
* Inbound agents to bind to the number with weights. If set and non-empty, one
|
|
166
163
|
* agent will be picked randomly for each inbound call, with probability
|
|
167
|
-
* proportional to the weight. Total weights must add up to 1.
|
|
168
|
-
* fallback to inbound_agent_id.
|
|
164
|
+
* proportional to the weight. Total weights must add up to 1.
|
|
169
165
|
*/
|
|
170
166
|
inbound_agents?: Array<PhoneNumberResponse.InboundAgent> | null;
|
|
171
167
|
|
|
@@ -194,27 +190,10 @@ export interface PhoneNumberResponse {
|
|
|
194
190
|
*/
|
|
195
191
|
nickname?: string | null;
|
|
196
192
|
|
|
197
|
-
/**
|
|
198
|
-
* @deprecated Unique id of agent to bind to the number. The number will
|
|
199
|
-
* automatically use the agent when conducting outbound calls. If null, this number
|
|
200
|
-
* would not be able to initiate outbound call without agent id override.
|
|
201
|
-
* Deprecated. See
|
|
202
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
203
|
-
*/
|
|
204
|
-
outbound_agent_id?: string | null;
|
|
205
|
-
|
|
206
|
-
/**
|
|
207
|
-
* @deprecated Version of the outbound agent to bind to the number. If not
|
|
208
|
-
* provided, will default to latest version. Deprecated. See
|
|
209
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
210
|
-
*/
|
|
211
|
-
outbound_agent_version?: number | null;
|
|
212
|
-
|
|
213
193
|
/**
|
|
214
194
|
* Outbound agents to bind to the number with weights. If set and non-empty, one
|
|
215
195
|
* agent will be picked randomly for each outbound call, with probability
|
|
216
|
-
* proportional to the weight. Total weights must add up to 1.
|
|
217
|
-
* fallback to outbound_agent_id.
|
|
196
|
+
* proportional to the weight. Total weights must add up to 1.
|
|
218
197
|
*/
|
|
219
198
|
outbound_agents?: Array<PhoneNumberResponse.OutboundAgent> | null;
|
|
220
199
|
|
|
@@ -337,26 +316,10 @@ export interface PhoneNumberCreateParams {
|
|
|
337
316
|
*/
|
|
338
317
|
fallback_number?: string | null;
|
|
339
318
|
|
|
340
|
-
/**
|
|
341
|
-
* @deprecated Unique id of agent to bind to the number. The number will
|
|
342
|
-
* automatically use the agent when receiving inbound calls. If null, this number
|
|
343
|
-
* would not accept inbound call. Deprecated. See
|
|
344
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
345
|
-
*/
|
|
346
|
-
inbound_agent_id?: string | null;
|
|
347
|
-
|
|
348
|
-
/**
|
|
349
|
-
* @deprecated Version of the inbound agent to bind to the number. If not provided,
|
|
350
|
-
* will default to latest version. Deprecated. See
|
|
351
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
352
|
-
*/
|
|
353
|
-
inbound_agent_version?: number | null;
|
|
354
|
-
|
|
355
319
|
/**
|
|
356
320
|
* Inbound agents to bind to the number with weights. If set and non-empty, one
|
|
357
321
|
* agent will be picked randomly for each inbound call, with probability
|
|
358
|
-
* proportional to the weight. Total weights must add up to 1.
|
|
359
|
-
* fallback to inbound_agent_id.
|
|
322
|
+
* proportional to the weight. Total weights must add up to 1.
|
|
360
323
|
*/
|
|
361
324
|
inbound_agents?: Array<PhoneNumberCreateParams.InboundAgent> | null;
|
|
362
325
|
|
|
@@ -376,27 +339,10 @@ export interface PhoneNumberCreateParams {
|
|
|
376
339
|
*/
|
|
377
340
|
number_provider?: 'twilio' | 'telnyx';
|
|
378
341
|
|
|
379
|
-
/**
|
|
380
|
-
* @deprecated Unique id of agent to bind to the number. The number will
|
|
381
|
-
* automatically use the agent when conducting outbound calls. If null, this number
|
|
382
|
-
* would not be able to initiate outbound call without agent id override.
|
|
383
|
-
* Deprecated. See
|
|
384
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
385
|
-
*/
|
|
386
|
-
outbound_agent_id?: string | null;
|
|
387
|
-
|
|
388
|
-
/**
|
|
389
|
-
* @deprecated Version of the outbound agent to bind to the number. If not
|
|
390
|
-
* provided, will default to latest version. Deprecated. See
|
|
391
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
392
|
-
*/
|
|
393
|
-
outbound_agent_version?: number | null;
|
|
394
|
-
|
|
395
342
|
/**
|
|
396
343
|
* Outbound agents to bind to the number with weights. If set and non-empty, one
|
|
397
344
|
* agent will be picked randomly for each outbound call, with probability
|
|
398
|
-
* proportional to the weight. Total weights must add up to 1.
|
|
399
|
-
* fallback to outbound_agent_id.
|
|
345
|
+
* proportional to the weight. Total weights must add up to 1.
|
|
400
346
|
*/
|
|
401
347
|
outbound_agents?: Array<PhoneNumberCreateParams.OutboundAgent> | null;
|
|
402
348
|
|
|
@@ -478,26 +424,10 @@ export interface PhoneNumberUpdateParams {
|
|
|
478
424
|
*/
|
|
479
425
|
fallback_number?: string | null;
|
|
480
426
|
|
|
481
|
-
/**
|
|
482
|
-
* @deprecated Unique id of agent to bind to the number. The number will
|
|
483
|
-
* automatically use the agent when receiving inbound calls. If set to null, this
|
|
484
|
-
* number would not accept inbound call. Deprecated. See
|
|
485
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
486
|
-
*/
|
|
487
|
-
inbound_agent_id?: string | null;
|
|
488
|
-
|
|
489
|
-
/**
|
|
490
|
-
* @deprecated Version of the inbound agent to bind to the number. If not provided,
|
|
491
|
-
* will default to latest version. Deprecated. See
|
|
492
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
493
|
-
*/
|
|
494
|
-
inbound_agent_version?: number | null;
|
|
495
|
-
|
|
496
427
|
/**
|
|
497
428
|
* Inbound agents to bind to the number with weights. If set and non-empty, one
|
|
498
429
|
* agent will be picked randomly for each inbound call, with probability
|
|
499
|
-
* proportional to the weight. Total weights must add up to 1.
|
|
500
|
-
* fallback to inbound_agent_id.
|
|
430
|
+
* proportional to the weight. Total weights must add up to 1.
|
|
501
431
|
*/
|
|
502
432
|
inbound_agents?: Array<PhoneNumberUpdateParams.InboundAgent> | null;
|
|
503
433
|
|
|
@@ -526,26 +456,10 @@ export interface PhoneNumberUpdateParams {
|
|
|
526
456
|
*/
|
|
527
457
|
nickname?: string | null;
|
|
528
458
|
|
|
529
|
-
/**
|
|
530
|
-
* @deprecated Unique id of agent to bind to the number. The number will
|
|
531
|
-
* automatically use the agent when conducting outbound calls. If set to null, this
|
|
532
|
-
* number would not be able to initiate outbound call without agent id override.
|
|
533
|
-
* Deprecated. See
|
|
534
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
535
|
-
*/
|
|
536
|
-
outbound_agent_id?: string | null;
|
|
537
|
-
|
|
538
|
-
/**
|
|
539
|
-
* Version of the outbound agent to bind to the number. If not provided, will
|
|
540
|
-
* default to latest version.
|
|
541
|
-
*/
|
|
542
|
-
outbound_agent_version?: number | null;
|
|
543
|
-
|
|
544
459
|
/**
|
|
545
460
|
* Outbound agents to bind to the number with weights. If set and non-empty, one
|
|
546
461
|
* agent will be picked randomly for each outbound call, with probability
|
|
547
|
-
* proportional to the weight. Total weights must add up to 1.
|
|
548
|
-
* fallback to outbound_agent_id.
|
|
462
|
+
* proportional to the weight. Total weights must add up to 1.
|
|
549
463
|
*/
|
|
550
464
|
outbound_agents?: Array<PhoneNumberUpdateParams.OutboundAgent> | null;
|
|
551
465
|
|
|
@@ -655,26 +569,10 @@ export interface PhoneNumberImportParams {
|
|
|
655
569
|
*/
|
|
656
570
|
ignore_e164_validation?: boolean;
|
|
657
571
|
|
|
658
|
-
/**
|
|
659
|
-
* @deprecated Unique id of agent to bind to the number. The number will
|
|
660
|
-
* automatically use the agent when receiving inbound calls. If null, this number
|
|
661
|
-
* would not accept inbound call. Deprecated. See
|
|
662
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
663
|
-
*/
|
|
664
|
-
inbound_agent_id?: string | null;
|
|
665
|
-
|
|
666
|
-
/**
|
|
667
|
-
* @deprecated Version of the inbound agent to bind to the number. If not provided,
|
|
668
|
-
* will default to latest version. Deprecated. See
|
|
669
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
670
|
-
*/
|
|
671
|
-
inbound_agent_version?: number | null;
|
|
672
|
-
|
|
673
572
|
/**
|
|
674
573
|
* Inbound agents to bind to the number with weights. If set and non-empty, one
|
|
675
574
|
* agent will be picked randomly for each inbound call, with probability
|
|
676
|
-
* proportional to the weight. Total weights must add up to 1.
|
|
677
|
-
* fallback to inbound_agent_id.
|
|
575
|
+
* proportional to the weight. Total weights must add up to 1.
|
|
678
576
|
*/
|
|
679
577
|
inbound_agents?: Array<PhoneNumberImportParams.InboundAgent> | null;
|
|
680
578
|
|
|
@@ -689,27 +587,10 @@ export interface PhoneNumberImportParams {
|
|
|
689
587
|
*/
|
|
690
588
|
nickname?: string;
|
|
691
589
|
|
|
692
|
-
/**
|
|
693
|
-
* @deprecated Unique id of agent to bind to the number. The number will
|
|
694
|
-
* automatically use the agent when conducting outbound calls. If null, this number
|
|
695
|
-
* would not be able to initiate outbound call without agent id override.
|
|
696
|
-
* Deprecated. See
|
|
697
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
698
|
-
*/
|
|
699
|
-
outbound_agent_id?: string | null;
|
|
700
|
-
|
|
701
|
-
/**
|
|
702
|
-
* @deprecated Version of the outbound agent to bind to the number. If not
|
|
703
|
-
* provided, will default to latest version. Deprecated. See
|
|
704
|
-
* https://docs.retellai.com/deprecation-notice/2026/03-31_phone_number_agent_fields
|
|
705
|
-
*/
|
|
706
|
-
outbound_agent_version?: number | null;
|
|
707
|
-
|
|
708
590
|
/**
|
|
709
591
|
* Outbound agents to bind to the number with weights. If set and non-empty, one
|
|
710
592
|
* agent will be picked randomly for each outbound call, with probability
|
|
711
|
-
* proportional to the weight. Total weights must add up to 1.
|
|
712
|
-
* fallback to outbound_agent_id.
|
|
593
|
+
* proportional to the weight. Total weights must add up to 1.
|
|
713
594
|
*/
|
|
714
595
|
outbound_agents?: Array<PhoneNumberImportParams.OutboundAgent> | null;
|
|
715
596
|
|