retell-sdk 5.12.0 → 5.14.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 +31 -0
- package/client.d.mts +3 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts +3 -0
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- 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/index.d.mts +1 -0
- package/resources/index.d.mts.map +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.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/playground.d.mts +395 -0
- package/resources/playground.d.mts.map +1 -0
- package/resources/playground.d.ts +395 -0
- package/resources/playground.d.ts.map +1 -0
- package/resources/playground.js +24 -0
- package/resources/playground.js.map +1 -0
- package/resources/playground.mjs +20 -0
- package/resources/playground.mjs.map +1 -0
- 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/client.ts +9 -0
- 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/index.ts +1 -0
- package/src/resources/llm.ts +201 -6
- package/src/resources/phone-number.ts +22 -141
- package/src/resources/playground.ts +500 -0
- 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/client.ts
CHANGED
|
@@ -110,6 +110,7 @@ import {
|
|
|
110
110
|
PhoneNumberResponse,
|
|
111
111
|
PhoneNumberUpdateParams,
|
|
112
112
|
} from './resources/phone-number';
|
|
113
|
+
import { Playground, PlaygroundCompletionParams, PlaygroundCompletionResponse } from './resources/playground';
|
|
113
114
|
import {
|
|
114
115
|
BatchTestResponse,
|
|
115
116
|
TestCaseDefinitionResponse,
|
|
@@ -849,6 +850,7 @@ export class Retell {
|
|
|
849
850
|
concurrency: API.Concurrency = new API.Concurrency(this);
|
|
850
851
|
batchCall: API.BatchCall = new API.BatchCall(this);
|
|
851
852
|
tests: API.Tests = new API.Tests(this);
|
|
853
|
+
playground: API.Playground = new API.Playground(this);
|
|
852
854
|
mcpTool: API.McpTool = new API.McpTool(this);
|
|
853
855
|
}
|
|
854
856
|
|
|
@@ -865,6 +867,7 @@ Retell.Voice = Voice;
|
|
|
865
867
|
Retell.Concurrency = Concurrency;
|
|
866
868
|
Retell.BatchCall = BatchCall;
|
|
867
869
|
Retell.Tests = Tests;
|
|
870
|
+
Retell.Playground = Playground;
|
|
868
871
|
Retell.McpTool = McpTool;
|
|
869
872
|
|
|
870
873
|
export declare namespace Retell {
|
|
@@ -996,6 +999,12 @@ export declare namespace Retell {
|
|
|
996
999
|
type TestUpdateTestCaseDefinitionParams as TestUpdateTestCaseDefinitionParams,
|
|
997
1000
|
};
|
|
998
1001
|
|
|
1002
|
+
export {
|
|
1003
|
+
Playground as Playground,
|
|
1004
|
+
type PlaygroundCompletionResponse as PlaygroundCompletionResponse,
|
|
1005
|
+
type PlaygroundCompletionParams as PlaygroundCompletionParams,
|
|
1006
|
+
};
|
|
1007
|
+
|
|
999
1008
|
export {
|
|
1000
1009
|
McpTool as McpTool,
|
|
1001
1010
|
type McpToolDefinition as McpToolDefinition,
|
|
@@ -9,10 +9,10 @@
|
|
|
9
9
|
*/
|
|
10
10
|
export const readEnv = (env: string): string | undefined => {
|
|
11
11
|
if (typeof (globalThis as any).process !== 'undefined') {
|
|
12
|
-
return (globalThis as any).process.env?.[env]?.trim()
|
|
12
|
+
return (globalThis as any).process.env?.[env]?.trim() || undefined;
|
|
13
13
|
}
|
|
14
14
|
if (typeof (globalThis as any).Deno !== 'undefined') {
|
|
15
|
-
return (globalThis as any).Deno.env?.get?.(env)?.trim();
|
|
15
|
+
return (globalThis as any).Deno.env?.get?.(env)?.trim() || undefined;
|
|
16
16
|
}
|
|
17
17
|
return undefined;
|
|
18
18
|
};
|
package/src/resources/agent.ts
CHANGED
|
@@ -440,17 +440,6 @@ export interface AgentResponse {
|
|
|
440
440
|
*/
|
|
441
441
|
max_call_duration_ms?: number;
|
|
442
442
|
|
|
443
|
-
/**
|
|
444
|
-
* If set to true, will normalize the some part of text (number, currency, date,
|
|
445
|
-
* etc) to spoken to its spoken form for more consistent speech synthesis
|
|
446
|
-
* (sometimes the voice synthesize system itself might read these wrong with the
|
|
447
|
-
* raw text). For example, it will convert "Call my number 2137112342 on Jul 5th,
|
|
448
|
-
* 2024 for the $24.12 payment" to "Call my number two one three seven one one two
|
|
449
|
-
* three four two on july fifth, twenty twenty four for the twenty four dollars
|
|
450
|
-
* twelve cents payment" before starting audio generation.
|
|
451
|
-
*/
|
|
452
|
-
normalize_for_speech?: boolean;
|
|
453
|
-
|
|
454
443
|
/**
|
|
455
444
|
* Whether this agent opts in for signed URLs for public logs and recordings. When
|
|
456
445
|
* enabled, the generated URLs will include security signatures that restrict
|
|
@@ -477,7 +466,7 @@ export interface AgentResponse {
|
|
|
477
466
|
> | null;
|
|
478
467
|
|
|
479
468
|
/**
|
|
480
|
-
* The model to use for post call analysis. Default to gpt-4.1
|
|
469
|
+
* The model to use for post call analysis. Default to gpt-4.1.
|
|
481
470
|
*/
|
|
482
471
|
post_call_analysis_model?:
|
|
483
472
|
| 'gpt-4.1'
|
|
@@ -497,6 +486,7 @@ export interface AgentResponse {
|
|
|
497
486
|
| 'gemini-2.5-flash'
|
|
498
487
|
| 'gemini-2.5-flash-lite'
|
|
499
488
|
| 'gemini-3.0-flash'
|
|
489
|
+
| 'gemini-3.1-flash-lite'
|
|
500
490
|
| null;
|
|
501
491
|
|
|
502
492
|
/**
|
|
@@ -595,6 +585,7 @@ export interface AgentResponse {
|
|
|
595
585
|
| 'speech-02-turbo'
|
|
596
586
|
| 'speech-2.8-turbo'
|
|
597
587
|
| 's1'
|
|
588
|
+
| 's2-pro'
|
|
598
589
|
| null;
|
|
599
590
|
|
|
600
591
|
/**
|
|
@@ -724,14 +715,15 @@ export namespace AgentResponse {
|
|
|
724
715
|
*/
|
|
725
716
|
export interface CustomSttConfig {
|
|
726
717
|
/**
|
|
727
|
-
* Endpointing timeout in milliseconds. Minimum is 100 for
|
|
718
|
+
* Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
|
|
719
|
+
* 500 for Soniox
|
|
728
720
|
*/
|
|
729
721
|
endpointing_ms: number;
|
|
730
722
|
|
|
731
723
|
/**
|
|
732
724
|
* The STT provider to use.
|
|
733
725
|
*/
|
|
734
|
-
provider: 'azure' | 'deepgram';
|
|
726
|
+
provider: 'azure' | 'deepgram' | 'soniox';
|
|
735
727
|
}
|
|
736
728
|
|
|
737
729
|
/**
|
|
@@ -1404,17 +1396,6 @@ export interface AgentCreateParams {
|
|
|
1404
1396
|
*/
|
|
1405
1397
|
max_call_duration_ms?: number;
|
|
1406
1398
|
|
|
1407
|
-
/**
|
|
1408
|
-
* If set to true, will normalize the some part of text (number, currency, date,
|
|
1409
|
-
* etc) to spoken to its spoken form for more consistent speech synthesis
|
|
1410
|
-
* (sometimes the voice synthesize system itself might read these wrong with the
|
|
1411
|
-
* raw text). For example, it will convert "Call my number 2137112342 on Jul 5th,
|
|
1412
|
-
* 2024 for the $24.12 payment" to "Call my number two one three seven one one two
|
|
1413
|
-
* three four two on july fifth, twenty twenty four for the twenty four dollars
|
|
1414
|
-
* twelve cents payment" before starting audio generation.
|
|
1415
|
-
*/
|
|
1416
|
-
normalize_for_speech?: boolean;
|
|
1417
|
-
|
|
1418
1399
|
/**
|
|
1419
1400
|
* Whether this agent opts in for signed URLs for public logs and recordings. When
|
|
1420
1401
|
* enabled, the generated URLs will include security signatures that restrict
|
|
@@ -1441,7 +1422,7 @@ export interface AgentCreateParams {
|
|
|
1441
1422
|
> | null;
|
|
1442
1423
|
|
|
1443
1424
|
/**
|
|
1444
|
-
* The model to use for post call analysis. Default to gpt-4.1
|
|
1425
|
+
* The model to use for post call analysis. Default to gpt-4.1.
|
|
1445
1426
|
*/
|
|
1446
1427
|
post_call_analysis_model?:
|
|
1447
1428
|
| 'gpt-4.1'
|
|
@@ -1461,6 +1442,7 @@ export interface AgentCreateParams {
|
|
|
1461
1442
|
| 'gemini-2.5-flash'
|
|
1462
1443
|
| 'gemini-2.5-flash-lite'
|
|
1463
1444
|
| 'gemini-3.0-flash'
|
|
1445
|
+
| 'gemini-3.1-flash-lite'
|
|
1464
1446
|
| null;
|
|
1465
1447
|
|
|
1466
1448
|
/**
|
|
@@ -1559,6 +1541,7 @@ export interface AgentCreateParams {
|
|
|
1559
1541
|
| 'speech-02-turbo'
|
|
1560
1542
|
| 'speech-2.8-turbo'
|
|
1561
1543
|
| 's1'
|
|
1544
|
+
| 's2-pro'
|
|
1562
1545
|
| null;
|
|
1563
1546
|
|
|
1564
1547
|
/**
|
|
@@ -1688,14 +1671,15 @@ export namespace AgentCreateParams {
|
|
|
1688
1671
|
*/
|
|
1689
1672
|
export interface CustomSttConfig {
|
|
1690
1673
|
/**
|
|
1691
|
-
* Endpointing timeout in milliseconds. Minimum is 100 for
|
|
1674
|
+
* Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
|
|
1675
|
+
* 500 for Soniox
|
|
1692
1676
|
*/
|
|
1693
1677
|
endpointing_ms: number;
|
|
1694
1678
|
|
|
1695
1679
|
/**
|
|
1696
1680
|
* The STT provider to use.
|
|
1697
1681
|
*/
|
|
1698
|
-
provider: 'azure' | 'deepgram';
|
|
1682
|
+
provider: 'azure' | 'deepgram' | 'soniox';
|
|
1699
1683
|
}
|
|
1700
1684
|
|
|
1701
1685
|
/**
|
|
@@ -2365,17 +2349,6 @@ export interface AgentUpdateParams {
|
|
|
2365
2349
|
*/
|
|
2366
2350
|
max_call_duration_ms?: number;
|
|
2367
2351
|
|
|
2368
|
-
/**
|
|
2369
|
-
* Body param: If set to true, will normalize the some part of text (number,
|
|
2370
|
-
* currency, date, etc) to spoken to its spoken form for more consistent speech
|
|
2371
|
-
* synthesis (sometimes the voice synthesize system itself might read these wrong
|
|
2372
|
-
* with the raw text). For example, it will convert "Call my number 2137112342 on
|
|
2373
|
-
* Jul 5th, 2024 for the $24.12 payment" to "Call my number two one three seven one
|
|
2374
|
-
* one two three four two on july fifth, twenty twenty four for the twenty four
|
|
2375
|
-
* dollars twelve cents payment" before starting audio generation.
|
|
2376
|
-
*/
|
|
2377
|
-
normalize_for_speech?: boolean;
|
|
2378
|
-
|
|
2379
2352
|
/**
|
|
2380
2353
|
* Body param: Whether this agent opts in for signed URLs for public logs and
|
|
2381
2354
|
* recordings. When enabled, the generated URLs will include security signatures
|
|
@@ -2402,7 +2375,7 @@ export interface AgentUpdateParams {
|
|
|
2402
2375
|
> | null;
|
|
2403
2376
|
|
|
2404
2377
|
/**
|
|
2405
|
-
* Body param: The model to use for post call analysis. Default to gpt-4.1
|
|
2378
|
+
* Body param: The model to use for post call analysis. Default to gpt-4.1.
|
|
2406
2379
|
*/
|
|
2407
2380
|
post_call_analysis_model?:
|
|
2408
2381
|
| 'gpt-4.1'
|
|
@@ -2422,6 +2395,7 @@ export interface AgentUpdateParams {
|
|
|
2422
2395
|
| 'gemini-2.5-flash'
|
|
2423
2396
|
| 'gemini-2.5-flash-lite'
|
|
2424
2397
|
| 'gemini-3.0-flash'
|
|
2398
|
+
| 'gemini-3.1-flash-lite'
|
|
2425
2399
|
| null;
|
|
2426
2400
|
|
|
2427
2401
|
/**
|
|
@@ -2543,6 +2517,7 @@ export interface AgentUpdateParams {
|
|
|
2543
2517
|
| 'speech-02-turbo'
|
|
2544
2518
|
| 'speech-2.8-turbo'
|
|
2545
2519
|
| 's1'
|
|
2520
|
+
| 's2-pro'
|
|
2546
2521
|
| null;
|
|
2547
2522
|
|
|
2548
2523
|
/**
|
|
@@ -2626,14 +2601,15 @@ export namespace AgentUpdateParams {
|
|
|
2626
2601
|
*/
|
|
2627
2602
|
export interface CustomSttConfig {
|
|
2628
2603
|
/**
|
|
2629
|
-
* Endpointing timeout in milliseconds. Minimum is 100 for
|
|
2604
|
+
* Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
|
|
2605
|
+
* 500 for Soniox
|
|
2630
2606
|
*/
|
|
2631
2607
|
endpointing_ms: number;
|
|
2632
2608
|
|
|
2633
2609
|
/**
|
|
2634
2610
|
* The STT provider to use.
|
|
2635
2611
|
*/
|
|
2636
|
-
provider: 'azure' | 'deepgram';
|
|
2612
|
+
provider: 'azure' | 'deepgram' | 'soniox';
|
|
2637
2613
|
}
|
|
2638
2614
|
|
|
2639
2615
|
/**
|
|
@@ -3054,6 +3030,11 @@ export namespace AgentUpdateParams {
|
|
|
3054
3030
|
}
|
|
3055
3031
|
|
|
3056
3032
|
export interface AgentListParams {
|
|
3033
|
+
/**
|
|
3034
|
+
* If true, only return the latest version of each agent.
|
|
3035
|
+
*/
|
|
3036
|
+
is_latest?: boolean;
|
|
3037
|
+
|
|
3057
3038
|
/**
|
|
3058
3039
|
* A limit on the number of objects to be returned. Limit can range between 1 and
|
|
3059
3040
|
* 1000, and the default is 1000.
|
|
@@ -505,17 +505,6 @@ export namespace BatchCallCreateBatchCallParams {
|
|
|
505
505
|
*/
|
|
506
506
|
max_call_duration_ms?: number;
|
|
507
507
|
|
|
508
|
-
/**
|
|
509
|
-
* If set to true, will normalize the some part of text (number, currency, date,
|
|
510
|
-
* etc) to spoken to its spoken form for more consistent speech synthesis
|
|
511
|
-
* (sometimes the voice synthesize system itself might read these wrong with the
|
|
512
|
-
* raw text). For example, it will convert "Call my number 2137112342 on Jul 5th,
|
|
513
|
-
* 2024 for the $24.12 payment" to "Call my number two one three seven one one two
|
|
514
|
-
* three four two on july fifth, twenty twenty four for the twenty four dollars
|
|
515
|
-
* twelve cents payment" before starting audio generation.
|
|
516
|
-
*/
|
|
517
|
-
normalize_for_speech?: boolean;
|
|
518
|
-
|
|
519
508
|
/**
|
|
520
509
|
* Whether this agent opts in for signed URLs for public logs and recordings. When
|
|
521
510
|
* enabled, the generated URLs will include security signatures that restrict
|
|
@@ -542,7 +531,7 @@ export namespace BatchCallCreateBatchCallParams {
|
|
|
542
531
|
> | null;
|
|
543
532
|
|
|
544
533
|
/**
|
|
545
|
-
* The model to use for post call analysis. Default to gpt-4.1
|
|
534
|
+
* The model to use for post call analysis. Default to gpt-4.1.
|
|
546
535
|
*/
|
|
547
536
|
post_call_analysis_model?:
|
|
548
537
|
| 'gpt-4.1'
|
|
@@ -562,6 +551,7 @@ export namespace BatchCallCreateBatchCallParams {
|
|
|
562
551
|
| 'gemini-2.5-flash'
|
|
563
552
|
| 'gemini-2.5-flash-lite'
|
|
564
553
|
| 'gemini-3.0-flash'
|
|
554
|
+
| 'gemini-3.1-flash-lite'
|
|
565
555
|
| null;
|
|
566
556
|
|
|
567
557
|
/**
|
|
@@ -676,6 +666,7 @@ export namespace BatchCallCreateBatchCallParams {
|
|
|
676
666
|
| 'speech-02-turbo'
|
|
677
667
|
| 'speech-2.8-turbo'
|
|
678
668
|
| 's1'
|
|
669
|
+
| 's2-pro'
|
|
679
670
|
| null;
|
|
680
671
|
|
|
681
672
|
/**
|
|
@@ -759,14 +750,15 @@ export namespace BatchCallCreateBatchCallParams {
|
|
|
759
750
|
*/
|
|
760
751
|
export interface CustomSttConfig {
|
|
761
752
|
/**
|
|
762
|
-
* Endpointing timeout in milliseconds. Minimum is 100 for
|
|
753
|
+
* Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
|
|
754
|
+
* 500 for Soniox
|
|
763
755
|
*/
|
|
764
756
|
endpointing_ms: number;
|
|
765
757
|
|
|
766
758
|
/**
|
|
767
759
|
* The STT provider to use.
|
|
768
760
|
*/
|
|
769
|
-
provider: 'azure' | 'deepgram';
|
|
761
|
+
provider: 'azure' | 'deepgram' | 'soniox';
|
|
770
762
|
}
|
|
771
763
|
|
|
772
764
|
/**
|
|
@@ -1274,7 +1266,8 @@ export namespace BatchCallCreateBatchCallParams {
|
|
|
1274
1266
|
| 'claude-4.5-haiku'
|
|
1275
1267
|
| 'gemini-2.5-flash'
|
|
1276
1268
|
| 'gemini-2.5-flash-lite'
|
|
1277
|
-
| 'gemini-3.0-flash'
|
|
1269
|
+
| 'gemini-3.0-flash'
|
|
1270
|
+
| 'gemini-3.1-flash-lite';
|
|
1278
1271
|
|
|
1279
1272
|
/**
|
|
1280
1273
|
* Type of model choice
|
|
@@ -1341,6 +1334,7 @@ export namespace BatchCallCreateBatchCallParams {
|
|
|
1341
1334
|
| 'gemini-2.5-flash'
|
|
1342
1335
|
| 'gemini-2.5-flash-lite'
|
|
1343
1336
|
| 'gemini-3.0-flash'
|
|
1337
|
+
| 'gemini-3.1-flash-lite'
|
|
1344
1338
|
| null;
|
|
1345
1339
|
|
|
1346
1340
|
/**
|
package/src/resources/call.ts
CHANGED
|
@@ -249,7 +249,8 @@ export interface PhoneCallResponse {
|
|
|
249
249
|
| 'error_user_not_joined'
|
|
250
250
|
| 'registered_call_timeout'
|
|
251
251
|
| 'transfer_bridged'
|
|
252
|
-
| 'transfer_cancelled'
|
|
252
|
+
| 'transfer_cancelled'
|
|
253
|
+
| 'manual_stopped';
|
|
253
254
|
|
|
254
255
|
/**
|
|
255
256
|
* Duration of the call in milliseconds. Available after call ends.
|
|
@@ -999,6 +1000,14 @@ export namespace PhoneCallResponse {
|
|
|
999
1000
|
* This is result of a node transition
|
|
1000
1001
|
*/
|
|
1001
1002
|
role: 'node_transition';
|
|
1003
|
+
|
|
1004
|
+
/**
|
|
1005
|
+
* How this node was reached. "global" means a global node transition,
|
|
1006
|
+
* "global_go_back" means returning from a global node, "interrupt_go_back" means
|
|
1007
|
+
* going back due to user interruption, and "normal" means a regular edge
|
|
1008
|
+
* transition.
|
|
1009
|
+
*/
|
|
1010
|
+
transition_type?: 'global' | 'global_go_back' | 'interrupt_go_back' | 'normal';
|
|
1002
1011
|
}
|
|
1003
1012
|
|
|
1004
1013
|
export interface DtmfUtterance {
|
|
@@ -1180,6 +1189,14 @@ export namespace PhoneCallResponse {
|
|
|
1180
1189
|
* This is result of a node transition
|
|
1181
1190
|
*/
|
|
1182
1191
|
role: 'node_transition';
|
|
1192
|
+
|
|
1193
|
+
/**
|
|
1194
|
+
* How this node was reached. "global" means a global node transition,
|
|
1195
|
+
* "global_go_back" means returning from a global node, "interrupt_go_back" means
|
|
1196
|
+
* going back due to user interruption, and "normal" means a regular edge
|
|
1197
|
+
* transition.
|
|
1198
|
+
*/
|
|
1199
|
+
transition_type?: 'global' | 'global_go_back' | 'interrupt_go_back' | 'normal';
|
|
1183
1200
|
}
|
|
1184
1201
|
|
|
1185
1202
|
export interface DtmfUtterance {
|
|
@@ -1305,7 +1322,8 @@ export interface WebCallResponse {
|
|
|
1305
1322
|
| 'error_user_not_joined'
|
|
1306
1323
|
| 'registered_call_timeout'
|
|
1307
1324
|
| 'transfer_bridged'
|
|
1308
|
-
| 'transfer_cancelled'
|
|
1325
|
+
| 'transfer_cancelled'
|
|
1326
|
+
| 'manual_stopped';
|
|
1309
1327
|
|
|
1310
1328
|
/**
|
|
1311
1329
|
* Duration of the call in milliseconds. Available after call ends.
|
|
@@ -2049,6 +2067,14 @@ export namespace WebCallResponse {
|
|
|
2049
2067
|
* This is result of a node transition
|
|
2050
2068
|
*/
|
|
2051
2069
|
role: 'node_transition';
|
|
2070
|
+
|
|
2071
|
+
/**
|
|
2072
|
+
* How this node was reached. "global" means a global node transition,
|
|
2073
|
+
* "global_go_back" means returning from a global node, "interrupt_go_back" means
|
|
2074
|
+
* going back due to user interruption, and "normal" means a regular edge
|
|
2075
|
+
* transition.
|
|
2076
|
+
*/
|
|
2077
|
+
transition_type?: 'global' | 'global_go_back' | 'interrupt_go_back' | 'normal';
|
|
2052
2078
|
}
|
|
2053
2079
|
|
|
2054
2080
|
export interface DtmfUtterance {
|
|
@@ -2219,6 +2245,14 @@ export namespace WebCallResponse {
|
|
|
2219
2245
|
* This is result of a node transition
|
|
2220
2246
|
*/
|
|
2221
2247
|
role: 'node_transition';
|
|
2248
|
+
|
|
2249
|
+
/**
|
|
2250
|
+
* How this node was reached. "global" means a global node transition,
|
|
2251
|
+
* "global_go_back" means returning from a global node, "interrupt_go_back" means
|
|
2252
|
+
* going back due to user interruption, and "normal" means a regular edge
|
|
2253
|
+
* transition.
|
|
2254
|
+
*/
|
|
2255
|
+
transition_type?: 'global' | 'global_go_back' | 'interrupt_go_back' | 'normal';
|
|
2222
2256
|
}
|
|
2223
2257
|
|
|
2224
2258
|
export interface DtmfUtterance {
|
|
@@ -2370,6 +2404,7 @@ export namespace CallListParams {
|
|
|
2370
2404
|
| 'registered_call_timeout'
|
|
2371
2405
|
| 'transfer_bridged'
|
|
2372
2406
|
| 'transfer_cancelled'
|
|
2407
|
+
| 'manual_stopped'
|
|
2373
2408
|
>;
|
|
2374
2409
|
|
|
2375
2410
|
/**
|
|
@@ -2839,17 +2874,6 @@ export namespace CallCreatePhoneCallParams {
|
|
|
2839
2874
|
*/
|
|
2840
2875
|
max_call_duration_ms?: number;
|
|
2841
2876
|
|
|
2842
|
-
/**
|
|
2843
|
-
* If set to true, will normalize the some part of text (number, currency, date,
|
|
2844
|
-
* etc) to spoken to its spoken form for more consistent speech synthesis
|
|
2845
|
-
* (sometimes the voice synthesize system itself might read these wrong with the
|
|
2846
|
-
* raw text). For example, it will convert "Call my number 2137112342 on Jul 5th,
|
|
2847
|
-
* 2024 for the $24.12 payment" to "Call my number two one three seven one one two
|
|
2848
|
-
* three four two on july fifth, twenty twenty four for the twenty four dollars
|
|
2849
|
-
* twelve cents payment" before starting audio generation.
|
|
2850
|
-
*/
|
|
2851
|
-
normalize_for_speech?: boolean;
|
|
2852
|
-
|
|
2853
2877
|
/**
|
|
2854
2878
|
* Whether this agent opts in for signed URLs for public logs and recordings. When
|
|
2855
2879
|
* enabled, the generated URLs will include security signatures that restrict
|
|
@@ -2876,7 +2900,7 @@ export namespace CallCreatePhoneCallParams {
|
|
|
2876
2900
|
> | null;
|
|
2877
2901
|
|
|
2878
2902
|
/**
|
|
2879
|
-
* The model to use for post call analysis. Default to gpt-4.1
|
|
2903
|
+
* The model to use for post call analysis. Default to gpt-4.1.
|
|
2880
2904
|
*/
|
|
2881
2905
|
post_call_analysis_model?:
|
|
2882
2906
|
| 'gpt-4.1'
|
|
@@ -2896,6 +2920,7 @@ export namespace CallCreatePhoneCallParams {
|
|
|
2896
2920
|
| 'gemini-2.5-flash'
|
|
2897
2921
|
| 'gemini-2.5-flash-lite'
|
|
2898
2922
|
| 'gemini-3.0-flash'
|
|
2923
|
+
| 'gemini-3.1-flash-lite'
|
|
2899
2924
|
| null;
|
|
2900
2925
|
|
|
2901
2926
|
/**
|
|
@@ -3010,6 +3035,7 @@ export namespace CallCreatePhoneCallParams {
|
|
|
3010
3035
|
| 'speech-02-turbo'
|
|
3011
3036
|
| 'speech-2.8-turbo'
|
|
3012
3037
|
| 's1'
|
|
3038
|
+
| 's2-pro'
|
|
3013
3039
|
| null;
|
|
3014
3040
|
|
|
3015
3041
|
/**
|
|
@@ -3093,14 +3119,15 @@ export namespace CallCreatePhoneCallParams {
|
|
|
3093
3119
|
*/
|
|
3094
3120
|
export interface CustomSttConfig {
|
|
3095
3121
|
/**
|
|
3096
|
-
* Endpointing timeout in milliseconds. Minimum is 100 for
|
|
3122
|
+
* Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
|
|
3123
|
+
* 500 for Soniox
|
|
3097
3124
|
*/
|
|
3098
3125
|
endpointing_ms: number;
|
|
3099
3126
|
|
|
3100
3127
|
/**
|
|
3101
3128
|
* The STT provider to use.
|
|
3102
3129
|
*/
|
|
3103
|
-
provider: 'azure' | 'deepgram';
|
|
3130
|
+
provider: 'azure' | 'deepgram' | 'soniox';
|
|
3104
3131
|
}
|
|
3105
3132
|
|
|
3106
3133
|
/**
|
|
@@ -3608,7 +3635,8 @@ export namespace CallCreatePhoneCallParams {
|
|
|
3608
3635
|
| 'claude-4.5-haiku'
|
|
3609
3636
|
| 'gemini-2.5-flash'
|
|
3610
3637
|
| 'gemini-2.5-flash-lite'
|
|
3611
|
-
| 'gemini-3.0-flash'
|
|
3638
|
+
| 'gemini-3.0-flash'
|
|
3639
|
+
| 'gemini-3.1-flash-lite';
|
|
3612
3640
|
|
|
3613
3641
|
/**
|
|
3614
3642
|
* Type of model choice
|
|
@@ -3675,6 +3703,7 @@ export namespace CallCreatePhoneCallParams {
|
|
|
3675
3703
|
| 'gemini-2.5-flash'
|
|
3676
3704
|
| 'gemini-2.5-flash-lite'
|
|
3677
3705
|
| 'gemini-3.0-flash'
|
|
3706
|
+
| 'gemini-3.1-flash-lite'
|
|
3678
3707
|
| null;
|
|
3679
3708
|
|
|
3680
3709
|
/**
|
|
@@ -4093,17 +4122,6 @@ export namespace CallCreateWebCallParams {
|
|
|
4093
4122
|
*/
|
|
4094
4123
|
max_call_duration_ms?: number;
|
|
4095
4124
|
|
|
4096
|
-
/**
|
|
4097
|
-
* If set to true, will normalize the some part of text (number, currency, date,
|
|
4098
|
-
* etc) to spoken to its spoken form for more consistent speech synthesis
|
|
4099
|
-
* (sometimes the voice synthesize system itself might read these wrong with the
|
|
4100
|
-
* raw text). For example, it will convert "Call my number 2137112342 on Jul 5th,
|
|
4101
|
-
* 2024 for the $24.12 payment" to "Call my number two one three seven one one two
|
|
4102
|
-
* three four two on july fifth, twenty twenty four for the twenty four dollars
|
|
4103
|
-
* twelve cents payment" before starting audio generation.
|
|
4104
|
-
*/
|
|
4105
|
-
normalize_for_speech?: boolean;
|
|
4106
|
-
|
|
4107
4125
|
/**
|
|
4108
4126
|
* Whether this agent opts in for signed URLs for public logs and recordings. When
|
|
4109
4127
|
* enabled, the generated URLs will include security signatures that restrict
|
|
@@ -4130,7 +4148,7 @@ export namespace CallCreateWebCallParams {
|
|
|
4130
4148
|
> | null;
|
|
4131
4149
|
|
|
4132
4150
|
/**
|
|
4133
|
-
* The model to use for post call analysis. Default to gpt-4.1
|
|
4151
|
+
* The model to use for post call analysis. Default to gpt-4.1.
|
|
4134
4152
|
*/
|
|
4135
4153
|
post_call_analysis_model?:
|
|
4136
4154
|
| 'gpt-4.1'
|
|
@@ -4150,6 +4168,7 @@ export namespace CallCreateWebCallParams {
|
|
|
4150
4168
|
| 'gemini-2.5-flash'
|
|
4151
4169
|
| 'gemini-2.5-flash-lite'
|
|
4152
4170
|
| 'gemini-3.0-flash'
|
|
4171
|
+
| 'gemini-3.1-flash-lite'
|
|
4153
4172
|
| null;
|
|
4154
4173
|
|
|
4155
4174
|
/**
|
|
@@ -4264,6 +4283,7 @@ export namespace CallCreateWebCallParams {
|
|
|
4264
4283
|
| 'speech-02-turbo'
|
|
4265
4284
|
| 'speech-2.8-turbo'
|
|
4266
4285
|
| 's1'
|
|
4286
|
+
| 's2-pro'
|
|
4267
4287
|
| null;
|
|
4268
4288
|
|
|
4269
4289
|
/**
|
|
@@ -4347,14 +4367,15 @@ export namespace CallCreateWebCallParams {
|
|
|
4347
4367
|
*/
|
|
4348
4368
|
export interface CustomSttConfig {
|
|
4349
4369
|
/**
|
|
4350
|
-
* Endpointing timeout in milliseconds. Minimum is 100 for
|
|
4370
|
+
* Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
|
|
4371
|
+
* 500 for Soniox
|
|
4351
4372
|
*/
|
|
4352
4373
|
endpointing_ms: number;
|
|
4353
4374
|
|
|
4354
4375
|
/**
|
|
4355
4376
|
* The STT provider to use.
|
|
4356
4377
|
*/
|
|
4357
|
-
provider: 'azure' | 'deepgram';
|
|
4378
|
+
provider: 'azure' | 'deepgram' | 'soniox';
|
|
4358
4379
|
}
|
|
4359
4380
|
|
|
4360
4381
|
/**
|
|
@@ -4862,7 +4883,8 @@ export namespace CallCreateWebCallParams {
|
|
|
4862
4883
|
| 'claude-4.5-haiku'
|
|
4863
4884
|
| 'gemini-2.5-flash'
|
|
4864
4885
|
| 'gemini-2.5-flash-lite'
|
|
4865
|
-
| 'gemini-3.0-flash'
|
|
4886
|
+
| 'gemini-3.0-flash'
|
|
4887
|
+
| 'gemini-3.1-flash-lite';
|
|
4866
4888
|
|
|
4867
4889
|
/**
|
|
4868
4890
|
* Type of model choice
|
|
@@ -4929,6 +4951,7 @@ export namespace CallCreateWebCallParams {
|
|
|
4929
4951
|
| 'gemini-2.5-flash'
|
|
4930
4952
|
| 'gemini-2.5-flash-lite'
|
|
4931
4953
|
| 'gemini-3.0-flash'
|
|
4954
|
+
| 'gemini-3.1-flash-lite'
|
|
4932
4955
|
| null;
|
|
4933
4956
|
|
|
4934
4957
|
/**
|
|
@@ -5347,17 +5370,6 @@ export namespace CallRegisterPhoneCallParams {
|
|
|
5347
5370
|
*/
|
|
5348
5371
|
max_call_duration_ms?: number;
|
|
5349
5372
|
|
|
5350
|
-
/**
|
|
5351
|
-
* If set to true, will normalize the some part of text (number, currency, date,
|
|
5352
|
-
* etc) to spoken to its spoken form for more consistent speech synthesis
|
|
5353
|
-
* (sometimes the voice synthesize system itself might read these wrong with the
|
|
5354
|
-
* raw text). For example, it will convert "Call my number 2137112342 on Jul 5th,
|
|
5355
|
-
* 2024 for the $24.12 payment" to "Call my number two one three seven one one two
|
|
5356
|
-
* three four two on july fifth, twenty twenty four for the twenty four dollars
|
|
5357
|
-
* twelve cents payment" before starting audio generation.
|
|
5358
|
-
*/
|
|
5359
|
-
normalize_for_speech?: boolean;
|
|
5360
|
-
|
|
5361
5373
|
/**
|
|
5362
5374
|
* Whether this agent opts in for signed URLs for public logs and recordings. When
|
|
5363
5375
|
* enabled, the generated URLs will include security signatures that restrict
|
|
@@ -5384,7 +5396,7 @@ export namespace CallRegisterPhoneCallParams {
|
|
|
5384
5396
|
> | null;
|
|
5385
5397
|
|
|
5386
5398
|
/**
|
|
5387
|
-
* The model to use for post call analysis. Default to gpt-4.1
|
|
5399
|
+
* The model to use for post call analysis. Default to gpt-4.1.
|
|
5388
5400
|
*/
|
|
5389
5401
|
post_call_analysis_model?:
|
|
5390
5402
|
| 'gpt-4.1'
|
|
@@ -5404,6 +5416,7 @@ export namespace CallRegisterPhoneCallParams {
|
|
|
5404
5416
|
| 'gemini-2.5-flash'
|
|
5405
5417
|
| 'gemini-2.5-flash-lite'
|
|
5406
5418
|
| 'gemini-3.0-flash'
|
|
5419
|
+
| 'gemini-3.1-flash-lite'
|
|
5407
5420
|
| null;
|
|
5408
5421
|
|
|
5409
5422
|
/**
|
|
@@ -5518,6 +5531,7 @@ export namespace CallRegisterPhoneCallParams {
|
|
|
5518
5531
|
| 'speech-02-turbo'
|
|
5519
5532
|
| 'speech-2.8-turbo'
|
|
5520
5533
|
| 's1'
|
|
5534
|
+
| 's2-pro'
|
|
5521
5535
|
| null;
|
|
5522
5536
|
|
|
5523
5537
|
/**
|
|
@@ -5601,14 +5615,15 @@ export namespace CallRegisterPhoneCallParams {
|
|
|
5601
5615
|
*/
|
|
5602
5616
|
export interface CustomSttConfig {
|
|
5603
5617
|
/**
|
|
5604
|
-
* Endpointing timeout in milliseconds. Minimum is 100 for
|
|
5618
|
+
* Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
|
|
5619
|
+
* 500 for Soniox
|
|
5605
5620
|
*/
|
|
5606
5621
|
endpointing_ms: number;
|
|
5607
5622
|
|
|
5608
5623
|
/**
|
|
5609
5624
|
* The STT provider to use.
|
|
5610
5625
|
*/
|
|
5611
|
-
provider: 'azure' | 'deepgram';
|
|
5626
|
+
provider: 'azure' | 'deepgram' | 'soniox';
|
|
5612
5627
|
}
|
|
5613
5628
|
|
|
5614
5629
|
/**
|
|
@@ -6116,7 +6131,8 @@ export namespace CallRegisterPhoneCallParams {
|
|
|
6116
6131
|
| 'claude-4.5-haiku'
|
|
6117
6132
|
| 'gemini-2.5-flash'
|
|
6118
6133
|
| 'gemini-2.5-flash-lite'
|
|
6119
|
-
| 'gemini-3.0-flash'
|
|
6134
|
+
| 'gemini-3.0-flash'
|
|
6135
|
+
| 'gemini-3.1-flash-lite';
|
|
6120
6136
|
|
|
6121
6137
|
/**
|
|
6122
6138
|
* Type of model choice
|
|
@@ -6183,6 +6199,7 @@ export namespace CallRegisterPhoneCallParams {
|
|
|
6183
6199
|
| 'gemini-2.5-flash'
|
|
6184
6200
|
| 'gemini-2.5-flash-lite'
|
|
6185
6201
|
| 'gemini-3.0-flash'
|
|
6202
|
+
| 'gemini-3.1-flash-lite'
|
|
6186
6203
|
| null;
|
|
6187
6204
|
|
|
6188
6205
|
/**
|
|
@@ -294,7 +294,7 @@ export interface ChatAgentResponse {
|
|
|
294
294
|
> | null;
|
|
295
295
|
|
|
296
296
|
/**
|
|
297
|
-
* The model to use for post chat analysis. Default to gpt-4.1
|
|
297
|
+
* The model to use for post chat analysis. Default to gpt-4.1.
|
|
298
298
|
*/
|
|
299
299
|
post_chat_analysis_model?:
|
|
300
300
|
| 'gpt-4.1'
|
|
@@ -314,6 +314,7 @@ export interface ChatAgentResponse {
|
|
|
314
314
|
| 'gemini-2.5-flash'
|
|
315
315
|
| 'gemini-2.5-flash-lite'
|
|
316
316
|
| 'gemini-3.0-flash'
|
|
317
|
+
| 'gemini-3.1-flash-lite'
|
|
317
318
|
| null;
|
|
318
319
|
|
|
319
320
|
/**
|
|
@@ -806,7 +807,7 @@ export interface ChatAgentCreateParams {
|
|
|
806
807
|
> | null;
|
|
807
808
|
|
|
808
809
|
/**
|
|
809
|
-
* The model to use for post chat analysis. Default to gpt-4.1
|
|
810
|
+
* The model to use for post chat analysis. Default to gpt-4.1.
|
|
810
811
|
*/
|
|
811
812
|
post_chat_analysis_model?:
|
|
812
813
|
| 'gpt-4.1'
|
|
@@ -826,6 +827,7 @@ export interface ChatAgentCreateParams {
|
|
|
826
827
|
| 'gemini-2.5-flash'
|
|
827
828
|
| 'gemini-2.5-flash-lite'
|
|
828
829
|
| 'gemini-3.0-flash'
|
|
830
|
+
| 'gemini-3.1-flash-lite'
|
|
829
831
|
| null;
|
|
830
832
|
|
|
831
833
|
/**
|
|
@@ -1315,7 +1317,7 @@ export interface ChatAgentUpdateParams {
|
|
|
1315
1317
|
> | null;
|
|
1316
1318
|
|
|
1317
1319
|
/**
|
|
1318
|
-
* Body param: The model to use for post chat analysis. Default to gpt-4.1
|
|
1320
|
+
* Body param: The model to use for post chat analysis. Default to gpt-4.1.
|
|
1319
1321
|
*/
|
|
1320
1322
|
post_chat_analysis_model?:
|
|
1321
1323
|
| 'gpt-4.1'
|
|
@@ -1335,6 +1337,7 @@ export interface ChatAgentUpdateParams {
|
|
|
1335
1337
|
| 'gemini-2.5-flash'
|
|
1336
1338
|
| 'gemini-2.5-flash-lite'
|
|
1337
1339
|
| 'gemini-3.0-flash'
|
|
1340
|
+
| 'gemini-3.1-flash-lite'
|
|
1338
1341
|
| null;
|
|
1339
1342
|
|
|
1340
1343
|
/**
|
|
@@ -1678,6 +1681,11 @@ export namespace ChatAgentUpdateParams {
|
|
|
1678
1681
|
}
|
|
1679
1682
|
|
|
1680
1683
|
export interface ChatAgentListParams {
|
|
1684
|
+
/**
|
|
1685
|
+
* If true, only return the latest version of each chat agent.
|
|
1686
|
+
*/
|
|
1687
|
+
is_latest?: boolean;
|
|
1688
|
+
|
|
1681
1689
|
/**
|
|
1682
1690
|
* A limit on the number of objects to be returned. Limit can range between 1 and
|
|
1683
1691
|
* 1000, and the default is 1000.
|