retell-sdk 4.65.0 → 5.0.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 +4 -1326
- package/LICENSE +1 -1
- package/README.md +120 -44
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +217 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +217 -0
- package/client.d.ts.map +1 -0
- package/client.js +513 -0
- package/client.js.map +1 -0
- package/client.mjs +509 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +1 -46
- package/error.d.ts.map +1 -1
- package/error.js +3 -110
- package/error.js.map +1 -1
- package/error.mjs +1 -96
- package/error.mjs.map +1 -1
- package/index.d.mts +6 -151
- package/index.d.mts.map +1 -0
- package/index.d.ts +5 -150
- package/index.d.ts.map +1 -1
- package/index.js +12 -150
- package/index.js.map +1 -1
- package/index.mjs +5 -123
- package/index.mjs.map +1 -1
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +40 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +37 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +101 -65
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +1 -5
- package/resource.d.ts.map +1 -1
- package/resource.js +3 -8
- package/resource.js.map +1 -1
- package/resource.mjs +1 -6
- package/resource.mjs.map +1 -1
- package/resources/agent.d.mts +1803 -0
- package/resources/agent.d.mts.map +1 -0
- package/resources/agent.d.ts +377 -81
- package/resources/agent.d.ts.map +1 -1
- package/resources/agent.js +33 -20
- package/resources/agent.js.map +1 -1
- package/resources/agent.mjs +33 -20
- package/resources/agent.mjs.map +1 -1
- package/resources/batch-call.d.mts +926 -0
- package/resources/batch-call.d.mts.map +1 -0
- package/resources/batch-call.d.ts +220 -28
- package/resources/batch-call.d.ts.map +1 -1
- package/resources/batch-call.js +6 -2
- package/resources/batch-call.js.map +1 -1
- package/resources/batch-call.mjs +6 -2
- package/resources/batch-call.mjs.map +1 -1
- package/resources/call.d.mts +4280 -0
- package/resources/call.d.mts.map +1 -0
- package/resources/call.d.ts +556 -110
- package/resources/call.d.ts.map +1 -1
- package/resources/call.js +20 -10
- package/resources/call.js.map +1 -1
- package/resources/call.mjs +20 -10
- package/resources/call.mjs.map +1 -1
- package/resources/chat-agent.d.mts +836 -0
- package/resources/chat-agent.d.mts.map +1 -0
- package/resources/chat-agent.d.ts +118 -23
- package/resources/chat-agent.d.ts.map +1 -1
- package/resources/chat-agent.js +33 -20
- package/resources/chat-agent.js.map +1 -1
- package/resources/chat-agent.mjs +33 -20
- package/resources/chat-agent.mjs.map +1 -1
- package/resources/chat.d.mts +607 -0
- package/resources/chat.d.mts.map +1 -0
- package/resources/chat.d.ts +82 -30
- package/resources/chat.d.ts.map +1 -1
- package/resources/chat.js +21 -11
- package/resources/chat.js.map +1 -1
- package/resources/chat.mjs +21 -11
- package/resources/chat.mjs.map +1 -1
- package/resources/concurrency.d.mts +51 -0
- package/resources/concurrency.d.mts.map +1 -0
- package/resources/concurrency.d.ts +14 -3
- package/resources/concurrency.d.ts.map +1 -1
- package/resources/concurrency.js +1 -1
- package/resources/concurrency.js.map +1 -1
- package/resources/concurrency.mjs +1 -1
- package/resources/concurrency.mjs.map +1 -1
- package/resources/conversation-flow-component.d.mts +11838 -0
- package/resources/conversation-flow-component.d.mts.map +1 -0
- package/resources/conversation-flow-component.d.ts +6600 -2597
- package/resources/conversation-flow-component.d.ts.map +1 -1
- package/resources/conversation-flow-component.js +10 -8
- package/resources/conversation-flow-component.js.map +1 -1
- package/resources/conversation-flow-component.mjs +10 -8
- package/resources/conversation-flow-component.mjs.map +1 -1
- package/resources/conversation-flow.d.mts +23851 -0
- package/resources/conversation-flow.d.mts.map +1 -0
- package/resources/conversation-flow.d.ts +15877 -7958
- package/resources/conversation-flow.d.ts.map +1 -1
- package/resources/conversation-flow.js +30 -15
- package/resources/conversation-flow.js.map +1 -1
- package/resources/conversation-flow.mjs +30 -15
- package/resources/conversation-flow.mjs.map +1 -1
- package/resources/index.d.mts +15 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +4 -4
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -2
- package/resources/index.mjs.map +1 -1
- package/resources/knowledge-base.d.mts +228 -0
- package/resources/knowledge-base.d.mts.map +1 -0
- package/resources/knowledge-base.d.ts +23 -14
- package/resources/knowledge-base.d.ts.map +1 -1
- package/resources/knowledge-base.js +16 -36
- package/resources/knowledge-base.js.map +1 -1
- package/resources/knowledge-base.mjs +16 -13
- package/resources/knowledge-base.mjs.map +1 -1
- package/resources/llm.d.mts +5306 -0
- package/resources/llm.d.mts.map +1 -0
- package/resources/llm.d.ts +1189 -477
- package/resources/llm.d.ts.map +1 -1
- package/resources/llm.js +28 -15
- package/resources/llm.js.map +1 -1
- package/resources/llm.mjs +28 -15
- package/resources/llm.mjs.map +1 -1
- package/resources/mcp-tool.d.mts +45 -0
- package/resources/mcp-tool.d.mts.map +1 -0
- package/resources/mcp-tool.d.ts +8 -3
- package/resources/mcp-tool.d.ts.map +1 -1
- package/resources/mcp-tool.js +4 -3
- package/resources/mcp-tool.js.map +1 -1
- package/resources/mcp-tool.mjs +4 -3
- package/resources/mcp-tool.mjs.map +1 -1
- package/resources/phone-number.d.mts +595 -0
- package/resources/phone-number.d.mts.map +1 -0
- package/resources/phone-number.d.ts +332 -13
- package/resources/phone-number.d.ts.map +1 -1
- package/resources/phone-number.js +7 -5
- package/resources/phone-number.js.map +1 -1
- package/resources/phone-number.mjs +7 -5
- package/resources/phone-number.mjs.map +1 -1
- package/resources/tests.d.mts +561 -0
- package/resources/tests.d.mts.map +1 -0
- package/resources/tests.d.ts +437 -7
- package/resources/tests.d.ts.map +1 -1
- package/resources/tests.js +60 -1
- package/resources/tests.js.map +1 -1
- package/resources/tests.mjs +60 -1
- package/resources/tests.mjs.map +1 -1
- package/resources/voice.d.mts +130 -0
- package/resources/voice.d.mts.map +1 -0
- package/resources/voice.d.ts +89 -6
- package/resources/voice.d.ts.map +1 -1
- package/resources/voice.js +23 -3
- package/resources/voice.js.map +1 -1
- package/resources/voice.mjs +23 -3
- package/resources/voice.mjs.map +1 -1
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts.map +1 -1
- package/resources.js +2 -15
- package/resources.js.map +1 -1
- package/src/api-promise.ts +2 -0
- package/src/client.ts +1005 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -130
- package/src/index.ts +5 -405
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +56 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +126 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/resource.ts +2 -11
- package/src/resources/agent.ts +610 -101
- package/src/resources/batch-call.ts +318 -26
- package/src/resources/call.ts +835 -111
- package/src/resources/chat-agent.ts +191 -41
- package/src/resources/chat.ts +108 -40
- package/src/resources/concurrency.ts +16 -3
- package/src/resources/conversation-flow-component.ts +9469 -4285
- package/src/resources/conversation-flow.ts +21572 -11318
- package/src/resources/index.ts +25 -2
- package/src/resources/knowledge-base.ts +40 -28
- package/src/resources/llm.ts +1422 -599
- package/src/resources/mcp-tool.ts +13 -6
- package/src/resources/phone-number.ts +410 -18
- package/src/resources/tests.ts +608 -9
- package/src/resources/voice.ts +122 -7
- package/src/tsconfig.json +2 -2
- package/src/uploads.ts +2 -259
- package/src/version.ts +1 -1
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +1 -74
- package/uploads.d.ts.map +1 -1
- package/uploads.js +3 -175
- package/uploads.js.map +1 -1
- package/uploads.mjs +1 -164
- package/uploads.mjs.map +1 -1
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
- package/_shims/MultipartBody.d.ts +0 -9
- package/_shims/MultipartBody.d.ts.map +0 -1
- package/_shims/MultipartBody.js +0 -16
- package/_shims/MultipartBody.js.map +0 -1
- package/_shims/MultipartBody.mjs +0 -12
- package/_shims/MultipartBody.mjs.map +0 -1
- package/_shims/README.md +0 -46
- package/_shims/auto/runtime-bun.d.ts +0 -5
- package/_shims/auto/runtime-bun.d.ts.map +0 -1
- package/_shims/auto/runtime-bun.js +0 -21
- package/_shims/auto/runtime-bun.js.map +0 -1
- package/_shims/auto/runtime-bun.mjs +0 -2
- package/_shims/auto/runtime-bun.mjs.map +0 -1
- package/_shims/auto/runtime-node.d.ts +0 -5
- package/_shims/auto/runtime-node.d.ts.map +0 -1
- package/_shims/auto/runtime-node.js +0 -21
- package/_shims/auto/runtime-node.js.map +0 -1
- package/_shims/auto/runtime-node.mjs +0 -2
- package/_shims/auto/runtime-node.mjs.map +0 -1
- package/_shims/auto/runtime.d.ts +0 -5
- package/_shims/auto/runtime.d.ts.map +0 -1
- package/_shims/auto/runtime.js +0 -21
- package/_shims/auto/runtime.js.map +0 -1
- package/_shims/auto/runtime.mjs +0 -2
- package/_shims/auto/runtime.mjs.map +0 -1
- package/_shims/auto/types-node.d.ts +0 -5
- package/_shims/auto/types-node.d.ts.map +0 -1
- package/_shims/auto/types-node.js +0 -21
- package/_shims/auto/types-node.js.map +0 -1
- package/_shims/auto/types-node.mjs +0 -2
- package/_shims/auto/types-node.mjs.map +0 -1
- package/_shims/auto/types.d.ts +0 -101
- package/_shims/auto/types.js +0 -3
- package/_shims/auto/types.mjs +0 -3
- package/_shims/bun-runtime.d.ts +0 -6
- package/_shims/bun-runtime.d.ts.map +0 -1
- package/_shims/bun-runtime.js +0 -14
- package/_shims/bun-runtime.js.map +0 -1
- package/_shims/bun-runtime.mjs +0 -10
- package/_shims/bun-runtime.mjs.map +0 -1
- package/_shims/index.d.ts +0 -83
- package/_shims/index.js +0 -17
- package/_shims/index.mjs +0 -11
- package/_shims/manual-types.d.ts +0 -12
- package/_shims/manual-types.js +0 -3
- package/_shims/manual-types.mjs +0 -3
- package/_shims/node-runtime.d.ts +0 -3
- package/_shims/node-runtime.d.ts.map +0 -1
- package/_shims/node-runtime.js +0 -89
- package/_shims/node-runtime.js.map +0 -1
- package/_shims/node-runtime.mjs +0 -56
- package/_shims/node-runtime.mjs.map +0 -1
- package/_shims/node-types.d.ts +0 -42
- package/_shims/node-types.js +0 -3
- package/_shims/node-types.mjs +0 -3
- package/_shims/registry.d.ts +0 -37
- package/_shims/registry.d.ts.map +0 -1
- package/_shims/registry.js +0 -41
- package/_shims/registry.js.map +0 -1
- package/_shims/registry.mjs +0 -37
- package/_shims/registry.mjs.map +0 -1
- package/_shims/web-runtime.d.ts +0 -5
- package/_shims/web-runtime.d.ts.map +0 -1
- package/_shims/web-runtime.js +0 -78
- package/_shims/web-runtime.js.map +0 -1
- package/_shims/web-runtime.mjs +0 -71
- package/_shims/web-runtime.mjs.map +0 -1
- package/_shims/web-types.d.ts +0 -83
- package/_shims/web-types.js +0 -3
- package/_shims/web-types.mjs +0 -3
- package/core.d.ts +0 -255
- package/core.d.ts.map +0 -1
- package/core.js +0 -924
- package/core.js.map +0 -1
- package/core.mjs +0 -892
- package/core.mjs.map +0 -1
- package/lib/webhook_auth.d.ts +0 -27
- package/lib/webhook_auth.d.ts.map +0 -1
- package/lib/webhook_auth.js +0 -50
- package/lib/webhook_auth.js.map +0 -1
- package/lib/webhook_auth.mjs +0 -45
- package/lib/webhook_auth.mjs.map +0 -1
- package/shims/node.d.ts +0 -30
- package/shims/node.d.ts.map +0 -1
- package/shims/node.js +0 -31
- package/shims/node.js.map +0 -1
- package/shims/node.mjs +0 -5
- package/shims/node.mjs.map +0 -1
- package/shims/web.d.ts +0 -26
- package/shims/web.d.ts.map +0 -1
- package/shims/web.js +0 -31
- package/shims/web.js.map +0 -1
- package/shims/web.mjs +0 -5
- package/shims/web.mjs.map +0 -1
- package/src/_shims/MultipartBody.ts +0 -9
- package/src/_shims/README.md +0 -46
- package/src/_shims/auto/runtime-bun.ts +0 -4
- package/src/_shims/auto/runtime-node.ts +0 -4
- package/src/_shims/auto/runtime.ts +0 -4
- package/src/_shims/auto/types-node.ts +0 -4
- package/src/_shims/auto/types.d.ts +0 -101
- package/src/_shims/auto/types.js +0 -3
- package/src/_shims/auto/types.mjs +0 -3
- package/src/_shims/bun-runtime.ts +0 -14
- package/src/_shims/index.d.ts +0 -83
- package/src/_shims/index.js +0 -17
- package/src/_shims/index.mjs +0 -11
- package/src/_shims/manual-types.d.ts +0 -12
- package/src/_shims/manual-types.js +0 -3
- package/src/_shims/manual-types.mjs +0 -3
- package/src/_shims/node-runtime.ts +0 -81
- package/src/_shims/node-types.d.ts +0 -42
- package/src/_shims/node-types.js +0 -3
- package/src/_shims/node-types.mjs +0 -3
- package/src/_shims/registry.ts +0 -67
- package/src/_shims/web-runtime.ts +0 -103
- package/src/_shims/web-types.d.ts +0 -83
- package/src/_shims/web-types.js +0 -3
- package/src/_shims/web-types.mjs +0 -3
- package/src/core.ts +0 -1236
- package/src/lib/webhook_auth.ts +0 -69
- package/src/shims/node.ts +0 -50
- package/src/shims/web.ts +0 -50
package/resources/call.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { APIResource } from "../resource.js";
|
|
2
|
-
import
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
3
4
|
export declare class Call extends APIResource {
|
|
4
5
|
/**
|
|
5
6
|
* Retrieve details of a specific call
|
|
@@ -11,7 +12,7 @@ export declare class Call extends APIResource {
|
|
|
11
12
|
* );
|
|
12
13
|
* ```
|
|
13
14
|
*/
|
|
14
|
-
retrieve(
|
|
15
|
+
retrieve(callID: string, options?: RequestOptions): APIPromise<CallResponse>;
|
|
15
16
|
/**
|
|
16
17
|
* Update metadata and sensitive data storage settings for an existing call.
|
|
17
18
|
*
|
|
@@ -29,7 +30,7 @@ export declare class Call extends APIResource {
|
|
|
29
30
|
* );
|
|
30
31
|
* ```
|
|
31
32
|
*/
|
|
32
|
-
update(
|
|
33
|
+
update(callID: string, body: CallUpdateParams, options?: RequestOptions): APIPromise<CallResponse>;
|
|
33
34
|
/**
|
|
34
35
|
* Retrieve call details
|
|
35
36
|
*
|
|
@@ -38,7 +39,7 @@ export declare class Call extends APIResource {
|
|
|
38
39
|
* const callResponses = await client.call.list();
|
|
39
40
|
* ```
|
|
40
41
|
*/
|
|
41
|
-
list(body: CallListParams, options?:
|
|
42
|
+
list(body: CallListParams, options?: RequestOptions): APIPromise<CallListResponse>;
|
|
42
43
|
/**
|
|
43
44
|
* Delete a specific call and its associated data
|
|
44
45
|
*
|
|
@@ -49,7 +50,7 @@ export declare class Call extends APIResource {
|
|
|
49
50
|
* );
|
|
50
51
|
* ```
|
|
51
52
|
*/
|
|
52
|
-
delete(
|
|
53
|
+
delete(callID: string, options?: RequestOptions): APIPromise<void>;
|
|
53
54
|
/**
|
|
54
55
|
* Create a new outbound phone call
|
|
55
56
|
*
|
|
@@ -63,7 +64,7 @@ export declare class Call extends APIResource {
|
|
|
63
64
|
* );
|
|
64
65
|
* ```
|
|
65
66
|
*/
|
|
66
|
-
createPhoneCall(body: CallCreatePhoneCallParams, options?:
|
|
67
|
+
createPhoneCall(body: CallCreatePhoneCallParams, options?: RequestOptions): APIPromise<PhoneCallResponse>;
|
|
67
68
|
/**
|
|
68
69
|
* Create a new web call
|
|
69
70
|
*
|
|
@@ -74,7 +75,7 @@ export declare class Call extends APIResource {
|
|
|
74
75
|
* });
|
|
75
76
|
* ```
|
|
76
77
|
*/
|
|
77
|
-
createWebCall(body: CallCreateWebCallParams, options?:
|
|
78
|
+
createWebCall(body: CallCreateWebCallParams, options?: RequestOptions): APIPromise<WebCallResponse>;
|
|
78
79
|
/**
|
|
79
80
|
* Register a new phone call for custom telephony
|
|
80
81
|
*
|
|
@@ -86,7 +87,7 @@ export declare class Call extends APIResource {
|
|
|
86
87
|
* });
|
|
87
88
|
* ```
|
|
88
89
|
*/
|
|
89
|
-
registerPhoneCall(body: CallRegisterPhoneCallParams, options?:
|
|
90
|
+
registerPhoneCall(body: CallRegisterPhoneCallParams, options?: RequestOptions): APIPromise<PhoneCallResponse>;
|
|
90
91
|
}
|
|
91
92
|
export type CallResponse = WebCallResponse | PhoneCallResponse;
|
|
92
93
|
export interface PhoneCallResponse {
|
|
@@ -99,20 +100,17 @@ export interface PhoneCallResponse {
|
|
|
99
100
|
*/
|
|
100
101
|
agent_version: number;
|
|
101
102
|
/**
|
|
102
|
-
* Unique id of the call. Used to identify in LLM websocket and used
|
|
103
|
-
* authenticate in audio websocket.
|
|
103
|
+
* Unique id of the call. Used to identify the call in the LLM websocket and used
|
|
104
|
+
* to authenticate in the audio websocket.
|
|
104
105
|
*/
|
|
105
106
|
call_id: string;
|
|
106
107
|
/**
|
|
107
108
|
* Status of call.
|
|
108
109
|
*
|
|
109
110
|
* - `registered`: Call id issued, starting to make a call using this id.
|
|
110
|
-
*
|
|
111
111
|
* - `ongoing`: Call connected and ongoing.
|
|
112
|
-
*
|
|
113
112
|
* - `ended`: The underlying websocket has ended for the call. Either user or agent
|
|
114
|
-
*
|
|
115
|
-
*
|
|
113
|
+
* hung up, or call transferred.
|
|
116
114
|
* - `error`: Call encountered error.
|
|
117
115
|
*/
|
|
118
116
|
call_status: 'registered' | 'not_connected' | 'ongoing' | 'ended' | 'error';
|
|
@@ -245,7 +243,7 @@ export interface PhoneCallResponse {
|
|
|
245
243
|
* PII. It precisely captures when (at what utterance, which word) the tool was
|
|
246
244
|
* invoked and what was the result. Available after call ends.
|
|
247
245
|
*/
|
|
248
|
-
scrubbed_transcript_with_tool_calls?: Array<PhoneCallResponse.Utterance | PhoneCallResponse.ToolCallInvocationUtterance | PhoneCallResponse.ToolCallResultUtterance | PhoneCallResponse.DtmfUtterance>;
|
|
246
|
+
scrubbed_transcript_with_tool_calls?: Array<PhoneCallResponse.Utterance | PhoneCallResponse.ToolCallInvocationUtterance | PhoneCallResponse.ToolCallResultUtterance | PhoneCallResponse.NodeTransitionUtterance | PhoneCallResponse.DtmfUtterance>;
|
|
249
247
|
/**
|
|
250
248
|
* Begin timestamp (milliseconds since epoch) of the call. Available after call
|
|
251
249
|
* starts.
|
|
@@ -270,15 +268,20 @@ export interface PhoneCallResponse {
|
|
|
270
268
|
* precisely captures when (at what utterance, which word) the tool was invoked and
|
|
271
269
|
* what was the result. Available after call ends.
|
|
272
270
|
*/
|
|
273
|
-
transcript_with_tool_calls?: Array<PhoneCallResponse.Utterance | PhoneCallResponse.ToolCallInvocationUtterance | PhoneCallResponse.ToolCallResultUtterance | PhoneCallResponse.DtmfUtterance>;
|
|
271
|
+
transcript_with_tool_calls?: Array<PhoneCallResponse.Utterance | PhoneCallResponse.ToolCallInvocationUtterance | PhoneCallResponse.ToolCallResultUtterance | PhoneCallResponse.NodeTransitionUtterance | PhoneCallResponse.DtmfUtterance>;
|
|
274
272
|
/**
|
|
275
273
|
* The destination number or identifier where the call was transferred to. Only
|
|
276
274
|
* populated when the disconnection reason was `call_transfer`. Can be a phone
|
|
277
275
|
* number or a SIP URI. SIP URIs are prefixed with "sip:" and may include a
|
|
278
276
|
* ";transport=..." portion (if transport is known) where the transport type can be
|
|
279
|
-
* "tls", "tcp"
|
|
277
|
+
* "tls", "tcp" or "udp".
|
|
280
278
|
*/
|
|
281
279
|
transfer_destination?: string | null;
|
|
280
|
+
/**
|
|
281
|
+
* Transfer end timestamp (milliseconds since epoch) of the call. Available after
|
|
282
|
+
* transfer call ends.
|
|
283
|
+
*/
|
|
284
|
+
transfer_end_timestamp?: number;
|
|
282
285
|
}
|
|
283
286
|
export declare namespace PhoneCallResponse {
|
|
284
287
|
/**
|
|
@@ -341,6 +344,10 @@ export declare namespace PhoneCallResponse {
|
|
|
341
344
|
* Product name that has a cost associated with it.
|
|
342
345
|
*/
|
|
343
346
|
product: string;
|
|
347
|
+
/**
|
|
348
|
+
* True if this cost item is for a transfer segment.
|
|
349
|
+
*/
|
|
350
|
+
is_transfer_leg_cost?: boolean;
|
|
344
351
|
/**
|
|
345
352
|
* Unit price of the product in cents per second.
|
|
346
353
|
*/
|
|
@@ -735,6 +742,11 @@ export declare namespace PhoneCallResponse {
|
|
|
735
742
|
* Tool call id, globally unique.
|
|
736
743
|
*/
|
|
737
744
|
tool_call_id: string;
|
|
745
|
+
/**
|
|
746
|
+
* Optional thought signature from Google Gemini thinking models. This is used
|
|
747
|
+
* internally to maintain reasoning chain in multi-turn function calling.
|
|
748
|
+
*/
|
|
749
|
+
thought_signature?: string;
|
|
738
750
|
}
|
|
739
751
|
interface ToolCallResultUtterance {
|
|
740
752
|
/**
|
|
@@ -742,7 +754,7 @@ export declare namespace PhoneCallResponse {
|
|
|
742
754
|
*/
|
|
743
755
|
content: string;
|
|
744
756
|
/**
|
|
745
|
-
* This is result of a tool call.
|
|
757
|
+
* This is the result of a tool call.
|
|
746
758
|
*/
|
|
747
759
|
role: 'tool_call_result';
|
|
748
760
|
/**
|
|
@@ -750,6 +762,28 @@ export declare namespace PhoneCallResponse {
|
|
|
750
762
|
*/
|
|
751
763
|
tool_call_id: string;
|
|
752
764
|
}
|
|
765
|
+
interface NodeTransitionUtterance {
|
|
766
|
+
/**
|
|
767
|
+
* Former node id
|
|
768
|
+
*/
|
|
769
|
+
former_node_id: string;
|
|
770
|
+
/**
|
|
771
|
+
* Former node name
|
|
772
|
+
*/
|
|
773
|
+
former_node_name: string;
|
|
774
|
+
/**
|
|
775
|
+
* New node id
|
|
776
|
+
*/
|
|
777
|
+
new_node_id: string;
|
|
778
|
+
/**
|
|
779
|
+
* New node name
|
|
780
|
+
*/
|
|
781
|
+
new_node_name: string;
|
|
782
|
+
/**
|
|
783
|
+
* This is result of a node transition
|
|
784
|
+
*/
|
|
785
|
+
role: 'node_transition';
|
|
786
|
+
}
|
|
753
787
|
interface DtmfUtterance {
|
|
754
788
|
/**
|
|
755
789
|
* The digit pressed by the user. Will be a single digit string like "1", "2", "3",
|
|
@@ -757,7 +791,7 @@ export declare namespace PhoneCallResponse {
|
|
|
757
791
|
*/
|
|
758
792
|
digit: string;
|
|
759
793
|
/**
|
|
760
|
-
*
|
|
794
|
+
* Digit pressed by the user from their phone keypad.
|
|
761
795
|
*/
|
|
762
796
|
role: 'dtmf';
|
|
763
797
|
}
|
|
@@ -856,6 +890,11 @@ export declare namespace PhoneCallResponse {
|
|
|
856
890
|
* Tool call id, globally unique.
|
|
857
891
|
*/
|
|
858
892
|
tool_call_id: string;
|
|
893
|
+
/**
|
|
894
|
+
* Optional thought signature from Google Gemini thinking models. This is used
|
|
895
|
+
* internally to maintain reasoning chain in multi-turn function calling.
|
|
896
|
+
*/
|
|
897
|
+
thought_signature?: string;
|
|
859
898
|
}
|
|
860
899
|
interface ToolCallResultUtterance {
|
|
861
900
|
/**
|
|
@@ -863,7 +902,7 @@ export declare namespace PhoneCallResponse {
|
|
|
863
902
|
*/
|
|
864
903
|
content: string;
|
|
865
904
|
/**
|
|
866
|
-
* This is result of a tool call.
|
|
905
|
+
* This is the result of a tool call.
|
|
867
906
|
*/
|
|
868
907
|
role: 'tool_call_result';
|
|
869
908
|
/**
|
|
@@ -871,6 +910,28 @@ export declare namespace PhoneCallResponse {
|
|
|
871
910
|
*/
|
|
872
911
|
tool_call_id: string;
|
|
873
912
|
}
|
|
913
|
+
interface NodeTransitionUtterance {
|
|
914
|
+
/**
|
|
915
|
+
* Former node id
|
|
916
|
+
*/
|
|
917
|
+
former_node_id: string;
|
|
918
|
+
/**
|
|
919
|
+
* Former node name
|
|
920
|
+
*/
|
|
921
|
+
former_node_name: string;
|
|
922
|
+
/**
|
|
923
|
+
* New node id
|
|
924
|
+
*/
|
|
925
|
+
new_node_id: string;
|
|
926
|
+
/**
|
|
927
|
+
* New node name
|
|
928
|
+
*/
|
|
929
|
+
new_node_name: string;
|
|
930
|
+
/**
|
|
931
|
+
* This is result of a node transition
|
|
932
|
+
*/
|
|
933
|
+
role: 'node_transition';
|
|
934
|
+
}
|
|
874
935
|
interface DtmfUtterance {
|
|
875
936
|
/**
|
|
876
937
|
* The digit pressed by the user. Will be a single digit string like "1", "2", "3",
|
|
@@ -878,7 +939,7 @@ export declare namespace PhoneCallResponse {
|
|
|
878
939
|
*/
|
|
879
940
|
digit: string;
|
|
880
941
|
/**
|
|
881
|
-
*
|
|
942
|
+
* Digit pressed by the user from their phone keypad.
|
|
882
943
|
*/
|
|
883
944
|
role: 'dtmf';
|
|
884
945
|
}
|
|
@@ -898,20 +959,17 @@ export interface WebCallResponse {
|
|
|
898
959
|
*/
|
|
899
960
|
agent_version: number;
|
|
900
961
|
/**
|
|
901
|
-
* Unique id of the call. Used to identify in LLM websocket and used
|
|
902
|
-
* authenticate in audio websocket.
|
|
962
|
+
* Unique id of the call. Used to identify the call in the LLM websocket and used
|
|
963
|
+
* to authenticate in the audio websocket.
|
|
903
964
|
*/
|
|
904
965
|
call_id: string;
|
|
905
966
|
/**
|
|
906
967
|
* Status of call.
|
|
907
968
|
*
|
|
908
969
|
* - `registered`: Call id issued, starting to make a call using this id.
|
|
909
|
-
*
|
|
910
970
|
* - `ongoing`: Call connected and ongoing.
|
|
911
|
-
*
|
|
912
971
|
* - `ended`: The underlying websocket has ended for the call. Either user or agent
|
|
913
|
-
*
|
|
914
|
-
*
|
|
972
|
+
* hung up, or call transferred.
|
|
915
973
|
* - `error`: Call encountered error.
|
|
916
974
|
*/
|
|
917
975
|
call_status: 'registered' | 'not_connected' | 'ongoing' | 'ended' | 'error';
|
|
@@ -1032,7 +1090,7 @@ export interface WebCallResponse {
|
|
|
1032
1090
|
* PII. It precisely captures when (at what utterance, which word) the tool was
|
|
1033
1091
|
* invoked and what was the result. Available after call ends.
|
|
1034
1092
|
*/
|
|
1035
|
-
scrubbed_transcript_with_tool_calls?: Array<WebCallResponse.Utterance | WebCallResponse.ToolCallInvocationUtterance | WebCallResponse.ToolCallResultUtterance | WebCallResponse.DtmfUtterance>;
|
|
1093
|
+
scrubbed_transcript_with_tool_calls?: Array<WebCallResponse.Utterance | WebCallResponse.ToolCallInvocationUtterance | WebCallResponse.ToolCallResultUtterance | WebCallResponse.NodeTransitionUtterance | WebCallResponse.DtmfUtterance>;
|
|
1036
1094
|
/**
|
|
1037
1095
|
* Begin timestamp (milliseconds since epoch) of the call. Available after call
|
|
1038
1096
|
* starts.
|
|
@@ -1052,15 +1110,20 @@ export interface WebCallResponse {
|
|
|
1052
1110
|
* precisely captures when (at what utterance, which word) the tool was invoked and
|
|
1053
1111
|
* what was the result. Available after call ends.
|
|
1054
1112
|
*/
|
|
1055
|
-
transcript_with_tool_calls?: Array<WebCallResponse.Utterance | WebCallResponse.ToolCallInvocationUtterance | WebCallResponse.ToolCallResultUtterance | WebCallResponse.DtmfUtterance>;
|
|
1113
|
+
transcript_with_tool_calls?: Array<WebCallResponse.Utterance | WebCallResponse.ToolCallInvocationUtterance | WebCallResponse.ToolCallResultUtterance | WebCallResponse.NodeTransitionUtterance | WebCallResponse.DtmfUtterance>;
|
|
1056
1114
|
/**
|
|
1057
1115
|
* The destination number or identifier where the call was transferred to. Only
|
|
1058
1116
|
* populated when the disconnection reason was `call_transfer`. Can be a phone
|
|
1059
1117
|
* number or a SIP URI. SIP URIs are prefixed with "sip:" and may include a
|
|
1060
1118
|
* ";transport=..." portion (if transport is known) where the transport type can be
|
|
1061
|
-
* "tls", "tcp"
|
|
1119
|
+
* "tls", "tcp" or "udp".
|
|
1062
1120
|
*/
|
|
1063
1121
|
transfer_destination?: string | null;
|
|
1122
|
+
/**
|
|
1123
|
+
* Transfer end timestamp (milliseconds since epoch) of the call. Available after
|
|
1124
|
+
* transfer call ends.
|
|
1125
|
+
*/
|
|
1126
|
+
transfer_end_timestamp?: number;
|
|
1064
1127
|
}
|
|
1065
1128
|
export declare namespace WebCallResponse {
|
|
1066
1129
|
/**
|
|
@@ -1123,6 +1186,10 @@ export declare namespace WebCallResponse {
|
|
|
1123
1186
|
* Product name that has a cost associated with it.
|
|
1124
1187
|
*/
|
|
1125
1188
|
product: string;
|
|
1189
|
+
/**
|
|
1190
|
+
* True if this cost item is for a transfer segment.
|
|
1191
|
+
*/
|
|
1192
|
+
is_transfer_leg_cost?: boolean;
|
|
1126
1193
|
/**
|
|
1127
1194
|
* Unit price of the product in cents per second.
|
|
1128
1195
|
*/
|
|
@@ -1517,6 +1584,11 @@ export declare namespace WebCallResponse {
|
|
|
1517
1584
|
* Tool call id, globally unique.
|
|
1518
1585
|
*/
|
|
1519
1586
|
tool_call_id: string;
|
|
1587
|
+
/**
|
|
1588
|
+
* Optional thought signature from Google Gemini thinking models. This is used
|
|
1589
|
+
* internally to maintain reasoning chain in multi-turn function calling.
|
|
1590
|
+
*/
|
|
1591
|
+
thought_signature?: string;
|
|
1520
1592
|
}
|
|
1521
1593
|
interface ToolCallResultUtterance {
|
|
1522
1594
|
/**
|
|
@@ -1524,7 +1596,7 @@ export declare namespace WebCallResponse {
|
|
|
1524
1596
|
*/
|
|
1525
1597
|
content: string;
|
|
1526
1598
|
/**
|
|
1527
|
-
* This is result of a tool call.
|
|
1599
|
+
* This is the result of a tool call.
|
|
1528
1600
|
*/
|
|
1529
1601
|
role: 'tool_call_result';
|
|
1530
1602
|
/**
|
|
@@ -1532,6 +1604,28 @@ export declare namespace WebCallResponse {
|
|
|
1532
1604
|
*/
|
|
1533
1605
|
tool_call_id: string;
|
|
1534
1606
|
}
|
|
1607
|
+
interface NodeTransitionUtterance {
|
|
1608
|
+
/**
|
|
1609
|
+
* Former node id
|
|
1610
|
+
*/
|
|
1611
|
+
former_node_id: string;
|
|
1612
|
+
/**
|
|
1613
|
+
* Former node name
|
|
1614
|
+
*/
|
|
1615
|
+
former_node_name: string;
|
|
1616
|
+
/**
|
|
1617
|
+
* New node id
|
|
1618
|
+
*/
|
|
1619
|
+
new_node_id: string;
|
|
1620
|
+
/**
|
|
1621
|
+
* New node name
|
|
1622
|
+
*/
|
|
1623
|
+
new_node_name: string;
|
|
1624
|
+
/**
|
|
1625
|
+
* This is result of a node transition
|
|
1626
|
+
*/
|
|
1627
|
+
role: 'node_transition';
|
|
1628
|
+
}
|
|
1535
1629
|
interface DtmfUtterance {
|
|
1536
1630
|
/**
|
|
1537
1631
|
* The digit pressed by the user. Will be a single digit string like "1", "2", "3",
|
|
@@ -1539,7 +1633,7 @@ export declare namespace WebCallResponse {
|
|
|
1539
1633
|
*/
|
|
1540
1634
|
digit: string;
|
|
1541
1635
|
/**
|
|
1542
|
-
*
|
|
1636
|
+
* Digit pressed by the user from their phone keypad.
|
|
1543
1637
|
*/
|
|
1544
1638
|
role: 'dtmf';
|
|
1545
1639
|
}
|
|
@@ -1628,6 +1722,11 @@ export declare namespace WebCallResponse {
|
|
|
1628
1722
|
* Tool call id, globally unique.
|
|
1629
1723
|
*/
|
|
1630
1724
|
tool_call_id: string;
|
|
1725
|
+
/**
|
|
1726
|
+
* Optional thought signature from Google Gemini thinking models. This is used
|
|
1727
|
+
* internally to maintain reasoning chain in multi-turn function calling.
|
|
1728
|
+
*/
|
|
1729
|
+
thought_signature?: string;
|
|
1631
1730
|
}
|
|
1632
1731
|
interface ToolCallResultUtterance {
|
|
1633
1732
|
/**
|
|
@@ -1635,7 +1734,7 @@ export declare namespace WebCallResponse {
|
|
|
1635
1734
|
*/
|
|
1636
1735
|
content: string;
|
|
1637
1736
|
/**
|
|
1638
|
-
* This is result of a tool call.
|
|
1737
|
+
* This is the result of a tool call.
|
|
1639
1738
|
*/
|
|
1640
1739
|
role: 'tool_call_result';
|
|
1641
1740
|
/**
|
|
@@ -1643,6 +1742,28 @@ export declare namespace WebCallResponse {
|
|
|
1643
1742
|
*/
|
|
1644
1743
|
tool_call_id: string;
|
|
1645
1744
|
}
|
|
1745
|
+
interface NodeTransitionUtterance {
|
|
1746
|
+
/**
|
|
1747
|
+
* Former node id
|
|
1748
|
+
*/
|
|
1749
|
+
former_node_id: string;
|
|
1750
|
+
/**
|
|
1751
|
+
* Former node name
|
|
1752
|
+
*/
|
|
1753
|
+
former_node_name: string;
|
|
1754
|
+
/**
|
|
1755
|
+
* New node id
|
|
1756
|
+
*/
|
|
1757
|
+
new_node_id: string;
|
|
1758
|
+
/**
|
|
1759
|
+
* New node name
|
|
1760
|
+
*/
|
|
1761
|
+
new_node_name: string;
|
|
1762
|
+
/**
|
|
1763
|
+
* This is result of a node transition
|
|
1764
|
+
*/
|
|
1765
|
+
role: 'node_transition';
|
|
1766
|
+
}
|
|
1646
1767
|
interface DtmfUtterance {
|
|
1647
1768
|
/**
|
|
1648
1769
|
* The digit pressed by the user. Will be a single digit string like "1", "2", "3",
|
|
@@ -1650,13 +1771,19 @@ export declare namespace WebCallResponse {
|
|
|
1650
1771
|
*/
|
|
1651
1772
|
digit: string;
|
|
1652
1773
|
/**
|
|
1653
|
-
*
|
|
1774
|
+
* Digit pressed by the user from their phone keypad.
|
|
1654
1775
|
*/
|
|
1655
1776
|
role: 'dtmf';
|
|
1656
1777
|
}
|
|
1657
1778
|
}
|
|
1658
1779
|
export type CallListResponse = Array<CallResponse>;
|
|
1659
1780
|
export interface CallUpdateParams {
|
|
1781
|
+
/**
|
|
1782
|
+
* Custom attributes for the call
|
|
1783
|
+
*/
|
|
1784
|
+
custom_attributes?: {
|
|
1785
|
+
[key: string]: string | number | boolean;
|
|
1786
|
+
};
|
|
1660
1787
|
/**
|
|
1661
1788
|
* Data storage setting for this call. Overrides the agent's default setting.
|
|
1662
1789
|
* "everything" stores all data, "everything_except_pii" excludes PII when
|
|
@@ -1741,7 +1868,18 @@ export declare namespace CallListParams {
|
|
|
1741
1868
|
* Only retrieve calls with specific range of duration(s).
|
|
1742
1869
|
*/
|
|
1743
1870
|
duration_ms?: FilterCriteria.DurationMs;
|
|
1871
|
+
/**
|
|
1872
|
+
* Filter by dynamic variables using dot notation (e.g., `dynamic_variables.name`).
|
|
1873
|
+
* Values are matched exactly as strings.
|
|
1874
|
+
*/
|
|
1875
|
+
dynamic_variables?: {
|
|
1876
|
+
[key: string]: Array<string>;
|
|
1877
|
+
};
|
|
1744
1878
|
e2e_latency_p50?: FilterCriteria.E2ELatencyP50;
|
|
1879
|
+
/**
|
|
1880
|
+
* Only retrieve calls with specific range of end timestamp(s).
|
|
1881
|
+
*/
|
|
1882
|
+
end_timestamp?: FilterCriteria.EndTimestamp;
|
|
1745
1883
|
/**
|
|
1746
1884
|
* Only retrieve calls with specific from number(s).
|
|
1747
1885
|
*/
|
|
@@ -1750,6 +1888,13 @@ export declare namespace CallListParams {
|
|
|
1750
1888
|
* Only retrieve calls that are in voicemail or not in voicemail.
|
|
1751
1889
|
*/
|
|
1752
1890
|
in_voicemail?: Array<boolean>;
|
|
1891
|
+
/**
|
|
1892
|
+
* Filter by metadata fields using dot notation (e.g., `metadata.customer_id`).
|
|
1893
|
+
* Values are matched exactly as strings.
|
|
1894
|
+
*/
|
|
1895
|
+
metadata?: {
|
|
1896
|
+
[key: string]: Array<string>;
|
|
1897
|
+
};
|
|
1753
1898
|
/**
|
|
1754
1899
|
* Only retrieve calls with specific range of start timestamp(s).
|
|
1755
1900
|
*/
|
|
@@ -1779,6 +1924,13 @@ export declare namespace CallListParams {
|
|
|
1779
1924
|
lower_threshold?: number;
|
|
1780
1925
|
upper_threshold?: number;
|
|
1781
1926
|
}
|
|
1927
|
+
/**
|
|
1928
|
+
* Only retrieve calls with specific range of end timestamp(s).
|
|
1929
|
+
*/
|
|
1930
|
+
interface EndTimestamp {
|
|
1931
|
+
lower_threshold?: number;
|
|
1932
|
+
upper_threshold?: number;
|
|
1933
|
+
}
|
|
1782
1934
|
/**
|
|
1783
1935
|
* Only retrieve calls with specific range of start timestamp(s).
|
|
1784
1936
|
*/
|
|
@@ -1893,24 +2045,18 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
1893
2045
|
*
|
|
1894
2046
|
* - `coffee-shop`: Coffee shop ambience with people chatting in background.
|
|
1895
2047
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/coffee-shop.wav)
|
|
1896
|
-
*
|
|
1897
2048
|
* - `convention-hall`: Convention hall ambience, with some echo and people
|
|
1898
2049
|
* chatting in background.
|
|
1899
2050
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/convention-hall.wav)
|
|
1900
|
-
*
|
|
1901
2051
|
* - `summer-outdoor`: Summer outdoor ambience with cicada chirping.
|
|
1902
2052
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/summer-outdoor.wav)
|
|
1903
|
-
*
|
|
1904
2053
|
* - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
|
|
1905
2054
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
|
|
1906
|
-
*
|
|
1907
2055
|
* - `static-noise`: Constant static noise.
|
|
1908
2056
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/static-noise.wav)
|
|
1909
|
-
*
|
|
1910
2057
|
* - `call-center`: Call center work noise.
|
|
1911
2058
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/call-center.wav)
|
|
1912
|
-
*
|
|
1913
|
-
* Set to `null` to remove ambient sound from this agent.
|
|
2059
|
+
* Set to `null` to remove ambient sound from this agent.
|
|
1914
2060
|
*/
|
|
1915
2061
|
ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'static-noise' | 'call-center' | null;
|
|
1916
2062
|
/**
|
|
@@ -1959,6 +2105,10 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
1959
2105
|
* street, etc.
|
|
1960
2106
|
*/
|
|
1961
2107
|
boosted_keywords?: Array<string> | null;
|
|
2108
|
+
/**
|
|
2109
|
+
* Custom STT configuration. Only used when stt_mode is set to custom.
|
|
2110
|
+
*/
|
|
2111
|
+
custom_stt_config?: Agent.CustomSttConfig;
|
|
1962
2112
|
/**
|
|
1963
2113
|
* Granular setting to manage how Retell stores sensitive data (transcripts,
|
|
1964
2114
|
* recordings, logs, etc.). This replaces the deprecated
|
|
@@ -1972,9 +2122,10 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
1972
2122
|
*/
|
|
1973
2123
|
data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
|
|
1974
2124
|
/**
|
|
1975
|
-
* If set, determines what denoising mode to use.
|
|
2125
|
+
* If set, determines what denoising mode to use. Use "no-denoise" to bypass all
|
|
2126
|
+
* audio denoising. Default to noise-cancellation.
|
|
1976
2127
|
*/
|
|
1977
|
-
denoising_mode?: 'noise-cancellation' | 'noise-and-background-speech-cancellation';
|
|
2128
|
+
denoising_mode?: 'no-denoise' | 'noise-cancellation' | 'noise-and-background-speech-cancellation';
|
|
1978
2129
|
/**
|
|
1979
2130
|
* Controls whether the agent would backchannel (agent interjects the speaker with
|
|
1980
2131
|
* phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
|
|
@@ -1982,6 +2133,16 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
1982
2133
|
* will not backchannel.
|
|
1983
2134
|
*/
|
|
1984
2135
|
enable_backchannel?: boolean;
|
|
2136
|
+
/**
|
|
2137
|
+
* If set to true, will enable dynamic voice speed adjustment based on the user's
|
|
2138
|
+
* speech rate and conversation context. If unset, default value false will apply.
|
|
2139
|
+
*/
|
|
2140
|
+
enable_dynamic_voice_speed?: boolean;
|
|
2141
|
+
/**
|
|
2142
|
+
* If set to true, will detect whether the call enters a voicemail. Note that this
|
|
2143
|
+
* feature is only available for phone calls.
|
|
2144
|
+
*/
|
|
2145
|
+
enable_voicemail_detection?: boolean;
|
|
1985
2146
|
/**
|
|
1986
2147
|
* If users stay silent for a period after agent speech, end the call. The minimum
|
|
1987
2148
|
* value allowed is 10,000 ms (10 s). By default, this is set to 600000 (10 min).
|
|
@@ -1995,6 +2156,11 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
1995
2156
|
* one. Set to null to remove voice fallback for the agent.
|
|
1996
2157
|
*/
|
|
1997
2158
|
fallback_voice_ids?: Array<string> | null;
|
|
2159
|
+
/**
|
|
2160
|
+
* Configuration for guardrail checks to detect and prevent prohibited topics in
|
|
2161
|
+
* agent output and user input.
|
|
2162
|
+
*/
|
|
2163
|
+
guardrail_config?: Agent.GuardrailConfig;
|
|
1998
2164
|
/**
|
|
1999
2165
|
* Controls how sensitive the agent is to user interruptions. Value ranging from
|
|
2000
2166
|
* [0,1]. Lower value means it will take longer / more words for user to interrupt
|
|
@@ -2003,13 +2169,24 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
2003
2169
|
* interrupted.
|
|
2004
2170
|
*/
|
|
2005
2171
|
interruption_sensitivity?: number;
|
|
2172
|
+
/**
|
|
2173
|
+
* Whether the agent is public. When set to true, the agent is available for public
|
|
2174
|
+
* agent preview link.
|
|
2175
|
+
*/
|
|
2176
|
+
is_public?: boolean | null;
|
|
2177
|
+
/**
|
|
2178
|
+
* If this option is set, the call will try to detect IVR in the first 3 minutes of
|
|
2179
|
+
* the call. Actions defined will be applied when the IVR is detected. Set this to
|
|
2180
|
+
* null to disable IVR detection.
|
|
2181
|
+
*/
|
|
2182
|
+
ivr_option?: Agent.IvrOption | null;
|
|
2006
2183
|
/**
|
|
2007
2184
|
* Specifies what language (and dialect) the speech recognition will operate in.
|
|
2008
2185
|
* For instance, selecting `en-GB` optimizes speech recognition for British
|
|
2009
2186
|
* English. If unset, will use default value `en-US`. Select `multi` for
|
|
2010
|
-
* multilingual support
|
|
2187
|
+
* multilingual support.
|
|
2011
2188
|
*/
|
|
2012
|
-
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | '
|
|
2189
|
+
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | 'multi';
|
|
2013
2190
|
/**
|
|
2014
2191
|
* Maximum allowed length for the call, will force end the call if reached. The
|
|
2015
2192
|
* minimum value allowed is 60,000 ms (1 min), and maximum value allowed is
|
|
@@ -2045,7 +2222,7 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
2045
2222
|
/**
|
|
2046
2223
|
* The model to use for post call analysis. Default to gpt-4.1-mini.
|
|
2047
2224
|
*/
|
|
2048
|
-
post_call_analysis_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;
|
|
2225
|
+
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
|
|
2049
2226
|
/**
|
|
2050
2227
|
* A list of words / phrases and their pronunciation to be used to guide the audio
|
|
2051
2228
|
* synthesize for consistent pronunciation. Currently only supported for English &
|
|
@@ -2091,28 +2268,37 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
2091
2268
|
signed_url_expiration_ms?: number | null;
|
|
2092
2269
|
/**
|
|
2093
2270
|
* If set, determines whether speech to text should focus on latency or accuracy.
|
|
2094
|
-
* Default to fast mode.
|
|
2271
|
+
* Default to fast mode. When set to custom, custom_stt_config must be provided.
|
|
2095
2272
|
*/
|
|
2096
|
-
stt_mode?: 'fast' | 'accurate';
|
|
2273
|
+
stt_mode?: 'fast' | 'accurate' | 'custom';
|
|
2097
2274
|
user_dtmf_options?: Agent.UserDtmfOptions | null;
|
|
2275
|
+
/**
|
|
2276
|
+
* Optional description of the agent version. Used for your own reference and
|
|
2277
|
+
* documentation.
|
|
2278
|
+
*/
|
|
2279
|
+
version_description?: string | null;
|
|
2098
2280
|
/**
|
|
2099
2281
|
* If set, determines the vocabulary set to use for transcription. This setting
|
|
2100
2282
|
* only applies for English agents, for non English agent, this setting is a no-op.
|
|
2101
2283
|
* Default to general.
|
|
2102
2284
|
*/
|
|
2103
2285
|
vocab_specialization?: 'general' | 'medical';
|
|
2286
|
+
/**
|
|
2287
|
+
* Controls the emotional tone of the agent's voice. Currently supported for
|
|
2288
|
+
* Cartesia and Minimax TTS providers. If unset, no emotion will be used.
|
|
2289
|
+
*/
|
|
2290
|
+
voice_emotion?: 'calm' | 'sympathetic' | 'happy' | 'sad' | 'angry' | 'fearful' | 'surprised' | null;
|
|
2104
2291
|
/**
|
|
2105
2292
|
* Unique voice id used for the agent. Find list of available voices and their
|
|
2106
2293
|
* preview in Dashboard.
|
|
2107
2294
|
*/
|
|
2108
2295
|
voice_id?: string;
|
|
2109
2296
|
/**
|
|
2110
|
-
*
|
|
2111
|
-
*
|
|
2112
|
-
*
|
|
2113
|
-
* each voice model.
|
|
2297
|
+
* Select the voice model used for the selected voice. Each provider has a set of
|
|
2298
|
+
* available voice models. Set to null to remove voice model selection, and default
|
|
2299
|
+
* ones will apply. Check out dashboard for more details of each voice model.
|
|
2114
2300
|
*/
|
|
2115
|
-
voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'tts-1' | 'gpt-4o-mini-tts' | null;
|
|
2301
|
+
voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'sonic-2' | 'sonic-3' | 'sonic-3-latest' | 'sonic-turbo' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | null;
|
|
2116
2302
|
/**
|
|
2117
2303
|
* Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
|
|
2118
2304
|
* speech, while higher value means faster speech rate. If unset, default value 1
|
|
@@ -2126,6 +2312,19 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
2126
2312
|
* apply.
|
|
2127
2313
|
*/
|
|
2128
2314
|
voice_temperature?: number;
|
|
2315
|
+
/**
|
|
2316
|
+
* Configures when to stop running voicemail detection, as it becomes unlikely to
|
|
2317
|
+
* hit voicemail after a couple minutes, and keep running it will only have
|
|
2318
|
+
* negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum value
|
|
2319
|
+
* allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
|
|
2320
|
+
*/
|
|
2321
|
+
voicemail_detection_timeout_ms?: number;
|
|
2322
|
+
/**
|
|
2323
|
+
* The message to be played when the call enters a voicemail. Note that this
|
|
2324
|
+
* feature is only available for phone calls. If you want to hangup after hitting
|
|
2325
|
+
* voicemail, set this to empty string.
|
|
2326
|
+
*/
|
|
2327
|
+
voicemail_message?: string;
|
|
2129
2328
|
/**
|
|
2130
2329
|
* If this option is set, the call will try to detect voicemail in the first 3
|
|
2131
2330
|
* minutes of the call. Actions defined (hangup, or leave a message) will be
|
|
@@ -2139,6 +2338,11 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
2139
2338
|
* If unset, default value 1 will apply.
|
|
2140
2339
|
*/
|
|
2141
2340
|
volume?: number;
|
|
2341
|
+
/**
|
|
2342
|
+
* Which webhook events this agent should receive. If not set, defaults to
|
|
2343
|
+
* call_started, call_ended, call_analyzed.
|
|
2344
|
+
*/
|
|
2345
|
+
webhook_events?: Array<'call_started' | 'call_ended' | 'call_analyzed' | 'transcript_updated' | 'transfer_started' | 'transfer_bridged' | 'transfer_cancelled' | 'transfer_ended'> | null;
|
|
2142
2346
|
/**
|
|
2143
2347
|
* The timeout for the webhook in milliseconds. If not set, default value of 10000
|
|
2144
2348
|
* will apply.
|
|
@@ -2153,6 +2357,49 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
2153
2357
|
webhook_url?: string | null;
|
|
2154
2358
|
}
|
|
2155
2359
|
namespace Agent {
|
|
2360
|
+
/**
|
|
2361
|
+
* Custom STT configuration. Only used when stt_mode is set to custom.
|
|
2362
|
+
*/
|
|
2363
|
+
interface CustomSttConfig {
|
|
2364
|
+
/**
|
|
2365
|
+
* Endpointing timeout in milliseconds. Minimum is 100 for azure, 10 for deepgram.
|
|
2366
|
+
*/
|
|
2367
|
+
endpointing_ms: number;
|
|
2368
|
+
/**
|
|
2369
|
+
* The STT provider to use.
|
|
2370
|
+
*/
|
|
2371
|
+
provider: 'azure' | 'deepgram';
|
|
2372
|
+
}
|
|
2373
|
+
/**
|
|
2374
|
+
* Configuration for guardrail checks to detect and prevent prohibited topics in
|
|
2375
|
+
* agent output and user input.
|
|
2376
|
+
*/
|
|
2377
|
+
interface GuardrailConfig {
|
|
2378
|
+
/**
|
|
2379
|
+
* Selected prohibited user topic categories to check. When user messages contain
|
|
2380
|
+
* these topics, the agent will respond with a placeholder message instead of
|
|
2381
|
+
* processing the request.
|
|
2382
|
+
*/
|
|
2383
|
+
input_topics?: Array<'platform_integrity_jailbreaking'> | null;
|
|
2384
|
+
/**
|
|
2385
|
+
* Selected prohibited agent topic categories to check. When agent messages contain
|
|
2386
|
+
* these topics, they will be replaced with a placeholder message.
|
|
2387
|
+
*/
|
|
2388
|
+
output_topics?: Array<'harassment' | 'self_harm' | 'sexual_exploitation' | 'violence' | 'defense_and_national_security' | 'illicit_and_harmful_activity' | 'gambling' | 'regulated_professional_advice' | 'child_safety_and_exploitation'> | null;
|
|
2389
|
+
}
|
|
2390
|
+
/**
|
|
2391
|
+
* If this option is set, the call will try to detect IVR in the first 3 minutes of
|
|
2392
|
+
* the call. Actions defined will be applied when the IVR is detected. Set this to
|
|
2393
|
+
* null to disable IVR detection.
|
|
2394
|
+
*/
|
|
2395
|
+
interface IvrOption {
|
|
2396
|
+
action: IvrOption.Action;
|
|
2397
|
+
}
|
|
2398
|
+
namespace IvrOption {
|
|
2399
|
+
interface Action {
|
|
2400
|
+
type: 'hangup';
|
|
2401
|
+
}
|
|
2402
|
+
}
|
|
2156
2403
|
/**
|
|
2157
2404
|
* Configuration for PII scrubbing from transcripts and recordings.
|
|
2158
2405
|
*/
|
|
@@ -2160,7 +2407,7 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
2160
2407
|
/**
|
|
2161
2408
|
* List of PII categories to scrub from transcripts and recordings.
|
|
2162
2409
|
*/
|
|
2163
|
-
categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth'>;
|
|
2410
|
+
categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth' | 'customer_account_number'>;
|
|
2164
2411
|
/**
|
|
2165
2412
|
* The processing mode for PII scrubbing. Currently only post-call is supported.
|
|
2166
2413
|
*/
|
|
@@ -2291,7 +2538,7 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
2291
2538
|
digit_limit?: number | null;
|
|
2292
2539
|
/**
|
|
2293
2540
|
* A single key that signals the end of DTMF input. Acceptable values include any
|
|
2294
|
-
* digit (0
|
|
2541
|
+
* digit (0-9), the pound/hash symbol (#), or the asterisk (\*).
|
|
2295
2542
|
*/
|
|
2296
2543
|
termination_key?: string | null;
|
|
2297
2544
|
/**
|
|
@@ -2307,7 +2554,7 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
2307
2554
|
* detection.
|
|
2308
2555
|
*/
|
|
2309
2556
|
interface VoicemailOption {
|
|
2310
|
-
action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup;
|
|
2557
|
+
action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup | VoicemailOption.VoicemailActionBridgeTransfer;
|
|
2311
2558
|
}
|
|
2312
2559
|
namespace VoicemailOption {
|
|
2313
2560
|
interface VoicemailActionPrompt {
|
|
@@ -2328,6 +2575,9 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
2328
2575
|
interface VoicemailActionHangup {
|
|
2329
2576
|
type: 'hangup';
|
|
2330
2577
|
}
|
|
2578
|
+
interface VoicemailActionBridgeTransfer {
|
|
2579
|
+
type: 'bridge_transfer';
|
|
2580
|
+
}
|
|
2331
2581
|
}
|
|
2332
2582
|
}
|
|
2333
2583
|
/**
|
|
@@ -2392,7 +2642,7 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
2392
2642
|
/**
|
|
2393
2643
|
* The LLM model to use
|
|
2394
2644
|
*/
|
|
2395
|
-
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';
|
|
2645
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
|
|
2396
2646
|
/**
|
|
2397
2647
|
* Type of model choice
|
|
2398
2648
|
*/
|
|
@@ -2434,7 +2684,7 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
2434
2684
|
/**
|
|
2435
2685
|
* Select the underlying text LLM. If not set, would default to gpt-4.1.
|
|
2436
2686
|
*/
|
|
2437
|
-
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;
|
|
2687
|
+
model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
|
|
2438
2688
|
/**
|
|
2439
2689
|
* If set to true, will use high priority pool with more dedicated resource to
|
|
2440
2690
|
* ensure lower and more consistent latency, default to false. This feature usually
|
|
@@ -2452,7 +2702,7 @@ export declare namespace CallCreatePhoneCallParams {
|
|
|
2452
2702
|
* Select the underlying speech to speech model. Can only set this or model, not
|
|
2453
2703
|
* both.
|
|
2454
2704
|
*/
|
|
2455
|
-
s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
|
|
2705
|
+
s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | 'gpt-realtime-mini' | null;
|
|
2456
2706
|
/**
|
|
2457
2707
|
* The speaker who starts the conversation. Required. Must be either 'user' or
|
|
2458
2708
|
* 'agent'.
|
|
@@ -2561,24 +2811,18 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2561
2811
|
*
|
|
2562
2812
|
* - `coffee-shop`: Coffee shop ambience with people chatting in background.
|
|
2563
2813
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/coffee-shop.wav)
|
|
2564
|
-
*
|
|
2565
2814
|
* - `convention-hall`: Convention hall ambience, with some echo and people
|
|
2566
2815
|
* chatting in background.
|
|
2567
2816
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/convention-hall.wav)
|
|
2568
|
-
*
|
|
2569
2817
|
* - `summer-outdoor`: Summer outdoor ambience with cicada chirping.
|
|
2570
2818
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/summer-outdoor.wav)
|
|
2571
|
-
*
|
|
2572
2819
|
* - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
|
|
2573
2820
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
|
|
2574
|
-
*
|
|
2575
2821
|
* - `static-noise`: Constant static noise.
|
|
2576
2822
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/static-noise.wav)
|
|
2577
|
-
*
|
|
2578
2823
|
* - `call-center`: Call center work noise.
|
|
2579
2824
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/call-center.wav)
|
|
2580
|
-
*
|
|
2581
|
-
* Set to `null` to remove ambient sound from this agent.
|
|
2825
|
+
* Set to `null` to remove ambient sound from this agent.
|
|
2582
2826
|
*/
|
|
2583
2827
|
ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'static-noise' | 'call-center' | null;
|
|
2584
2828
|
/**
|
|
@@ -2627,6 +2871,10 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2627
2871
|
* street, etc.
|
|
2628
2872
|
*/
|
|
2629
2873
|
boosted_keywords?: Array<string> | null;
|
|
2874
|
+
/**
|
|
2875
|
+
* Custom STT configuration. Only used when stt_mode is set to custom.
|
|
2876
|
+
*/
|
|
2877
|
+
custom_stt_config?: Agent.CustomSttConfig;
|
|
2630
2878
|
/**
|
|
2631
2879
|
* Granular setting to manage how Retell stores sensitive data (transcripts,
|
|
2632
2880
|
* recordings, logs, etc.). This replaces the deprecated
|
|
@@ -2640,9 +2888,10 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2640
2888
|
*/
|
|
2641
2889
|
data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
|
|
2642
2890
|
/**
|
|
2643
|
-
* If set, determines what denoising mode to use.
|
|
2891
|
+
* If set, determines what denoising mode to use. Use "no-denoise" to bypass all
|
|
2892
|
+
* audio denoising. Default to noise-cancellation.
|
|
2644
2893
|
*/
|
|
2645
|
-
denoising_mode?: 'noise-cancellation' | 'noise-and-background-speech-cancellation';
|
|
2894
|
+
denoising_mode?: 'no-denoise' | 'noise-cancellation' | 'noise-and-background-speech-cancellation';
|
|
2646
2895
|
/**
|
|
2647
2896
|
* Controls whether the agent would backchannel (agent interjects the speaker with
|
|
2648
2897
|
* phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
|
|
@@ -2650,6 +2899,16 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2650
2899
|
* will not backchannel.
|
|
2651
2900
|
*/
|
|
2652
2901
|
enable_backchannel?: boolean;
|
|
2902
|
+
/**
|
|
2903
|
+
* If set to true, will enable dynamic voice speed adjustment based on the user's
|
|
2904
|
+
* speech rate and conversation context. If unset, default value false will apply.
|
|
2905
|
+
*/
|
|
2906
|
+
enable_dynamic_voice_speed?: boolean;
|
|
2907
|
+
/**
|
|
2908
|
+
* If set to true, will detect whether the call enters a voicemail. Note that this
|
|
2909
|
+
* feature is only available for phone calls.
|
|
2910
|
+
*/
|
|
2911
|
+
enable_voicemail_detection?: boolean;
|
|
2653
2912
|
/**
|
|
2654
2913
|
* If users stay silent for a period after agent speech, end the call. The minimum
|
|
2655
2914
|
* value allowed is 10,000 ms (10 s). By default, this is set to 600000 (10 min).
|
|
@@ -2663,6 +2922,11 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2663
2922
|
* one. Set to null to remove voice fallback for the agent.
|
|
2664
2923
|
*/
|
|
2665
2924
|
fallback_voice_ids?: Array<string> | null;
|
|
2925
|
+
/**
|
|
2926
|
+
* Configuration for guardrail checks to detect and prevent prohibited topics in
|
|
2927
|
+
* agent output and user input.
|
|
2928
|
+
*/
|
|
2929
|
+
guardrail_config?: Agent.GuardrailConfig;
|
|
2666
2930
|
/**
|
|
2667
2931
|
* Controls how sensitive the agent is to user interruptions. Value ranging from
|
|
2668
2932
|
* [0,1]. Lower value means it will take longer / more words for user to interrupt
|
|
@@ -2671,13 +2935,24 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2671
2935
|
* interrupted.
|
|
2672
2936
|
*/
|
|
2673
2937
|
interruption_sensitivity?: number;
|
|
2938
|
+
/**
|
|
2939
|
+
* Whether the agent is public. When set to true, the agent is available for public
|
|
2940
|
+
* agent preview link.
|
|
2941
|
+
*/
|
|
2942
|
+
is_public?: boolean | null;
|
|
2943
|
+
/**
|
|
2944
|
+
* If this option is set, the call will try to detect IVR in the first 3 minutes of
|
|
2945
|
+
* the call. Actions defined will be applied when the IVR is detected. Set this to
|
|
2946
|
+
* null to disable IVR detection.
|
|
2947
|
+
*/
|
|
2948
|
+
ivr_option?: Agent.IvrOption | null;
|
|
2674
2949
|
/**
|
|
2675
2950
|
* Specifies what language (and dialect) the speech recognition will operate in.
|
|
2676
2951
|
* For instance, selecting `en-GB` optimizes speech recognition for British
|
|
2677
2952
|
* English. If unset, will use default value `en-US`. Select `multi` for
|
|
2678
|
-
* multilingual support
|
|
2953
|
+
* multilingual support.
|
|
2679
2954
|
*/
|
|
2680
|
-
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | '
|
|
2955
|
+
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | 'multi';
|
|
2681
2956
|
/**
|
|
2682
2957
|
* Maximum allowed length for the call, will force end the call if reached. The
|
|
2683
2958
|
* minimum value allowed is 60,000 ms (1 min), and maximum value allowed is
|
|
@@ -2713,7 +2988,7 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2713
2988
|
/**
|
|
2714
2989
|
* The model to use for post call analysis. Default to gpt-4.1-mini.
|
|
2715
2990
|
*/
|
|
2716
|
-
post_call_analysis_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;
|
|
2991
|
+
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
|
|
2717
2992
|
/**
|
|
2718
2993
|
* A list of words / phrases and their pronunciation to be used to guide the audio
|
|
2719
2994
|
* synthesize for consistent pronunciation. Currently only supported for English &
|
|
@@ -2759,28 +3034,37 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2759
3034
|
signed_url_expiration_ms?: number | null;
|
|
2760
3035
|
/**
|
|
2761
3036
|
* If set, determines whether speech to text should focus on latency or accuracy.
|
|
2762
|
-
* Default to fast mode.
|
|
3037
|
+
* Default to fast mode. When set to custom, custom_stt_config must be provided.
|
|
2763
3038
|
*/
|
|
2764
|
-
stt_mode?: 'fast' | 'accurate';
|
|
3039
|
+
stt_mode?: 'fast' | 'accurate' | 'custom';
|
|
2765
3040
|
user_dtmf_options?: Agent.UserDtmfOptions | null;
|
|
3041
|
+
/**
|
|
3042
|
+
* Optional description of the agent version. Used for your own reference and
|
|
3043
|
+
* documentation.
|
|
3044
|
+
*/
|
|
3045
|
+
version_description?: string | null;
|
|
2766
3046
|
/**
|
|
2767
3047
|
* If set, determines the vocabulary set to use for transcription. This setting
|
|
2768
3048
|
* only applies for English agents, for non English agent, this setting is a no-op.
|
|
2769
3049
|
* Default to general.
|
|
2770
3050
|
*/
|
|
2771
3051
|
vocab_specialization?: 'general' | 'medical';
|
|
3052
|
+
/**
|
|
3053
|
+
* Controls the emotional tone of the agent's voice. Currently supported for
|
|
3054
|
+
* Cartesia and Minimax TTS providers. If unset, no emotion will be used.
|
|
3055
|
+
*/
|
|
3056
|
+
voice_emotion?: 'calm' | 'sympathetic' | 'happy' | 'sad' | 'angry' | 'fearful' | 'surprised' | null;
|
|
2772
3057
|
/**
|
|
2773
3058
|
* Unique voice id used for the agent. Find list of available voices and their
|
|
2774
3059
|
* preview in Dashboard.
|
|
2775
3060
|
*/
|
|
2776
3061
|
voice_id?: string;
|
|
2777
3062
|
/**
|
|
2778
|
-
*
|
|
2779
|
-
*
|
|
2780
|
-
*
|
|
2781
|
-
* each voice model.
|
|
3063
|
+
* Select the voice model used for the selected voice. Each provider has a set of
|
|
3064
|
+
* available voice models. Set to null to remove voice model selection, and default
|
|
3065
|
+
* ones will apply. Check out dashboard for more details of each voice model.
|
|
2782
3066
|
*/
|
|
2783
|
-
voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'tts-1' | 'gpt-4o-mini-tts' | null;
|
|
3067
|
+
voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'sonic-2' | 'sonic-3' | 'sonic-3-latest' | 'sonic-turbo' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | null;
|
|
2784
3068
|
/**
|
|
2785
3069
|
* Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
|
|
2786
3070
|
* speech, while higher value means faster speech rate. If unset, default value 1
|
|
@@ -2794,6 +3078,19 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2794
3078
|
* apply.
|
|
2795
3079
|
*/
|
|
2796
3080
|
voice_temperature?: number;
|
|
3081
|
+
/**
|
|
3082
|
+
* Configures when to stop running voicemail detection, as it becomes unlikely to
|
|
3083
|
+
* hit voicemail after a couple minutes, and keep running it will only have
|
|
3084
|
+
* negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum value
|
|
3085
|
+
* allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
|
|
3086
|
+
*/
|
|
3087
|
+
voicemail_detection_timeout_ms?: number;
|
|
3088
|
+
/**
|
|
3089
|
+
* The message to be played when the call enters a voicemail. Note that this
|
|
3090
|
+
* feature is only available for phone calls. If you want to hangup after hitting
|
|
3091
|
+
* voicemail, set this to empty string.
|
|
3092
|
+
*/
|
|
3093
|
+
voicemail_message?: string;
|
|
2797
3094
|
/**
|
|
2798
3095
|
* If this option is set, the call will try to detect voicemail in the first 3
|
|
2799
3096
|
* minutes of the call. Actions defined (hangup, or leave a message) will be
|
|
@@ -2807,6 +3104,11 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2807
3104
|
* If unset, default value 1 will apply.
|
|
2808
3105
|
*/
|
|
2809
3106
|
volume?: number;
|
|
3107
|
+
/**
|
|
3108
|
+
* Which webhook events this agent should receive. If not set, defaults to
|
|
3109
|
+
* call_started, call_ended, call_analyzed.
|
|
3110
|
+
*/
|
|
3111
|
+
webhook_events?: Array<'call_started' | 'call_ended' | 'call_analyzed' | 'transcript_updated' | 'transfer_started' | 'transfer_bridged' | 'transfer_cancelled' | 'transfer_ended'> | null;
|
|
2810
3112
|
/**
|
|
2811
3113
|
* The timeout for the webhook in milliseconds. If not set, default value of 10000
|
|
2812
3114
|
* will apply.
|
|
@@ -2821,6 +3123,49 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2821
3123
|
webhook_url?: string | null;
|
|
2822
3124
|
}
|
|
2823
3125
|
namespace Agent {
|
|
3126
|
+
/**
|
|
3127
|
+
* Custom STT configuration. Only used when stt_mode is set to custom.
|
|
3128
|
+
*/
|
|
3129
|
+
interface CustomSttConfig {
|
|
3130
|
+
/**
|
|
3131
|
+
* Endpointing timeout in milliseconds. Minimum is 100 for azure, 10 for deepgram.
|
|
3132
|
+
*/
|
|
3133
|
+
endpointing_ms: number;
|
|
3134
|
+
/**
|
|
3135
|
+
* The STT provider to use.
|
|
3136
|
+
*/
|
|
3137
|
+
provider: 'azure' | 'deepgram';
|
|
3138
|
+
}
|
|
3139
|
+
/**
|
|
3140
|
+
* Configuration for guardrail checks to detect and prevent prohibited topics in
|
|
3141
|
+
* agent output and user input.
|
|
3142
|
+
*/
|
|
3143
|
+
interface GuardrailConfig {
|
|
3144
|
+
/**
|
|
3145
|
+
* Selected prohibited user topic categories to check. When user messages contain
|
|
3146
|
+
* these topics, the agent will respond with a placeholder message instead of
|
|
3147
|
+
* processing the request.
|
|
3148
|
+
*/
|
|
3149
|
+
input_topics?: Array<'platform_integrity_jailbreaking'> | null;
|
|
3150
|
+
/**
|
|
3151
|
+
* Selected prohibited agent topic categories to check. When agent messages contain
|
|
3152
|
+
* these topics, they will be replaced with a placeholder message.
|
|
3153
|
+
*/
|
|
3154
|
+
output_topics?: Array<'harassment' | 'self_harm' | 'sexual_exploitation' | 'violence' | 'defense_and_national_security' | 'illicit_and_harmful_activity' | 'gambling' | 'regulated_professional_advice' | 'child_safety_and_exploitation'> | null;
|
|
3155
|
+
}
|
|
3156
|
+
/**
|
|
3157
|
+
* If this option is set, the call will try to detect IVR in the first 3 minutes of
|
|
3158
|
+
* the call. Actions defined will be applied when the IVR is detected. Set this to
|
|
3159
|
+
* null to disable IVR detection.
|
|
3160
|
+
*/
|
|
3161
|
+
interface IvrOption {
|
|
3162
|
+
action: IvrOption.Action;
|
|
3163
|
+
}
|
|
3164
|
+
namespace IvrOption {
|
|
3165
|
+
interface Action {
|
|
3166
|
+
type: 'hangup';
|
|
3167
|
+
}
|
|
3168
|
+
}
|
|
2824
3169
|
/**
|
|
2825
3170
|
* Configuration for PII scrubbing from transcripts and recordings.
|
|
2826
3171
|
*/
|
|
@@ -2828,7 +3173,7 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2828
3173
|
/**
|
|
2829
3174
|
* List of PII categories to scrub from transcripts and recordings.
|
|
2830
3175
|
*/
|
|
2831
|
-
categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth'>;
|
|
3176
|
+
categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth' | 'customer_account_number'>;
|
|
2832
3177
|
/**
|
|
2833
3178
|
* The processing mode for PII scrubbing. Currently only post-call is supported.
|
|
2834
3179
|
*/
|
|
@@ -2959,7 +3304,7 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2959
3304
|
digit_limit?: number | null;
|
|
2960
3305
|
/**
|
|
2961
3306
|
* A single key that signals the end of DTMF input. Acceptable values include any
|
|
2962
|
-
* digit (0
|
|
3307
|
+
* digit (0-9), the pound/hash symbol (#), or the asterisk (\*).
|
|
2963
3308
|
*/
|
|
2964
3309
|
termination_key?: string | null;
|
|
2965
3310
|
/**
|
|
@@ -2975,7 +3320,7 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2975
3320
|
* detection.
|
|
2976
3321
|
*/
|
|
2977
3322
|
interface VoicemailOption {
|
|
2978
|
-
action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup;
|
|
3323
|
+
action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup | VoicemailOption.VoicemailActionBridgeTransfer;
|
|
2979
3324
|
}
|
|
2980
3325
|
namespace VoicemailOption {
|
|
2981
3326
|
interface VoicemailActionPrompt {
|
|
@@ -2996,6 +3341,9 @@ export declare namespace CallCreateWebCallParams {
|
|
|
2996
3341
|
interface VoicemailActionHangup {
|
|
2997
3342
|
type: 'hangup';
|
|
2998
3343
|
}
|
|
3344
|
+
interface VoicemailActionBridgeTransfer {
|
|
3345
|
+
type: 'bridge_transfer';
|
|
3346
|
+
}
|
|
2999
3347
|
}
|
|
3000
3348
|
}
|
|
3001
3349
|
/**
|
|
@@ -3060,7 +3408,7 @@ export declare namespace CallCreateWebCallParams {
|
|
|
3060
3408
|
/**
|
|
3061
3409
|
* The LLM model to use
|
|
3062
3410
|
*/
|
|
3063
|
-
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';
|
|
3411
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
|
|
3064
3412
|
/**
|
|
3065
3413
|
* Type of model choice
|
|
3066
3414
|
*/
|
|
@@ -3102,7 +3450,7 @@ export declare namespace CallCreateWebCallParams {
|
|
|
3102
3450
|
/**
|
|
3103
3451
|
* Select the underlying text LLM. If not set, would default to gpt-4.1.
|
|
3104
3452
|
*/
|
|
3105
|
-
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;
|
|
3453
|
+
model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
|
|
3106
3454
|
/**
|
|
3107
3455
|
* If set to true, will use high priority pool with more dedicated resource to
|
|
3108
3456
|
* ensure lower and more consistent latency, default to false. This feature usually
|
|
@@ -3120,7 +3468,7 @@ export declare namespace CallCreateWebCallParams {
|
|
|
3120
3468
|
* Select the underlying speech to speech model. Can only set this or model, not
|
|
3121
3469
|
* both.
|
|
3122
3470
|
*/
|
|
3123
|
-
s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
|
|
3471
|
+
s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | 'gpt-realtime-mini' | null;
|
|
3124
3472
|
/**
|
|
3125
3473
|
* The speaker who starts the conversation. Required. Must be either 'user' or
|
|
3126
3474
|
* 'agent'.
|
|
@@ -3240,24 +3588,18 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3240
3588
|
*
|
|
3241
3589
|
* - `coffee-shop`: Coffee shop ambience with people chatting in background.
|
|
3242
3590
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/coffee-shop.wav)
|
|
3243
|
-
*
|
|
3244
3591
|
* - `convention-hall`: Convention hall ambience, with some echo and people
|
|
3245
3592
|
* chatting in background.
|
|
3246
3593
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/convention-hall.wav)
|
|
3247
|
-
*
|
|
3248
3594
|
* - `summer-outdoor`: Summer outdoor ambience with cicada chirping.
|
|
3249
3595
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/summer-outdoor.wav)
|
|
3250
|
-
*
|
|
3251
3596
|
* - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
|
|
3252
3597
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
|
|
3253
|
-
*
|
|
3254
3598
|
* - `static-noise`: Constant static noise.
|
|
3255
3599
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/static-noise.wav)
|
|
3256
|
-
*
|
|
3257
3600
|
* - `call-center`: Call center work noise.
|
|
3258
3601
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/call-center.wav)
|
|
3259
|
-
*
|
|
3260
|
-
* Set to `null` to remove ambient sound from this agent.
|
|
3602
|
+
* Set to `null` to remove ambient sound from this agent.
|
|
3261
3603
|
*/
|
|
3262
3604
|
ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'static-noise' | 'call-center' | null;
|
|
3263
3605
|
/**
|
|
@@ -3306,6 +3648,10 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3306
3648
|
* street, etc.
|
|
3307
3649
|
*/
|
|
3308
3650
|
boosted_keywords?: Array<string> | null;
|
|
3651
|
+
/**
|
|
3652
|
+
* Custom STT configuration. Only used when stt_mode is set to custom.
|
|
3653
|
+
*/
|
|
3654
|
+
custom_stt_config?: Agent.CustomSttConfig;
|
|
3309
3655
|
/**
|
|
3310
3656
|
* Granular setting to manage how Retell stores sensitive data (transcripts,
|
|
3311
3657
|
* recordings, logs, etc.). This replaces the deprecated
|
|
@@ -3319,9 +3665,10 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3319
3665
|
*/
|
|
3320
3666
|
data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
|
|
3321
3667
|
/**
|
|
3322
|
-
* If set, determines what denoising mode to use.
|
|
3668
|
+
* If set, determines what denoising mode to use. Use "no-denoise" to bypass all
|
|
3669
|
+
* audio denoising. Default to noise-cancellation.
|
|
3323
3670
|
*/
|
|
3324
|
-
denoising_mode?: 'noise-cancellation' | 'noise-and-background-speech-cancellation';
|
|
3671
|
+
denoising_mode?: 'no-denoise' | 'noise-cancellation' | 'noise-and-background-speech-cancellation';
|
|
3325
3672
|
/**
|
|
3326
3673
|
* Controls whether the agent would backchannel (agent interjects the speaker with
|
|
3327
3674
|
* phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
|
|
@@ -3329,6 +3676,16 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3329
3676
|
* will not backchannel.
|
|
3330
3677
|
*/
|
|
3331
3678
|
enable_backchannel?: boolean;
|
|
3679
|
+
/**
|
|
3680
|
+
* If set to true, will enable dynamic voice speed adjustment based on the user's
|
|
3681
|
+
* speech rate and conversation context. If unset, default value false will apply.
|
|
3682
|
+
*/
|
|
3683
|
+
enable_dynamic_voice_speed?: boolean;
|
|
3684
|
+
/**
|
|
3685
|
+
* If set to true, will detect whether the call enters a voicemail. Note that this
|
|
3686
|
+
* feature is only available for phone calls.
|
|
3687
|
+
*/
|
|
3688
|
+
enable_voicemail_detection?: boolean;
|
|
3332
3689
|
/**
|
|
3333
3690
|
* If users stay silent for a period after agent speech, end the call. The minimum
|
|
3334
3691
|
* value allowed is 10,000 ms (10 s). By default, this is set to 600000 (10 min).
|
|
@@ -3342,6 +3699,11 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3342
3699
|
* one. Set to null to remove voice fallback for the agent.
|
|
3343
3700
|
*/
|
|
3344
3701
|
fallback_voice_ids?: Array<string> | null;
|
|
3702
|
+
/**
|
|
3703
|
+
* Configuration for guardrail checks to detect and prevent prohibited topics in
|
|
3704
|
+
* agent output and user input.
|
|
3705
|
+
*/
|
|
3706
|
+
guardrail_config?: Agent.GuardrailConfig;
|
|
3345
3707
|
/**
|
|
3346
3708
|
* Controls how sensitive the agent is to user interruptions. Value ranging from
|
|
3347
3709
|
* [0,1]. Lower value means it will take longer / more words for user to interrupt
|
|
@@ -3350,13 +3712,24 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3350
3712
|
* interrupted.
|
|
3351
3713
|
*/
|
|
3352
3714
|
interruption_sensitivity?: number;
|
|
3715
|
+
/**
|
|
3716
|
+
* Whether the agent is public. When set to true, the agent is available for public
|
|
3717
|
+
* agent preview link.
|
|
3718
|
+
*/
|
|
3719
|
+
is_public?: boolean | null;
|
|
3720
|
+
/**
|
|
3721
|
+
* If this option is set, the call will try to detect IVR in the first 3 minutes of
|
|
3722
|
+
* the call. Actions defined will be applied when the IVR is detected. Set this to
|
|
3723
|
+
* null to disable IVR detection.
|
|
3724
|
+
*/
|
|
3725
|
+
ivr_option?: Agent.IvrOption | null;
|
|
3353
3726
|
/**
|
|
3354
3727
|
* Specifies what language (and dialect) the speech recognition will operate in.
|
|
3355
3728
|
* For instance, selecting `en-GB` optimizes speech recognition for British
|
|
3356
3729
|
* English. If unset, will use default value `en-US`. Select `multi` for
|
|
3357
|
-
* multilingual support
|
|
3730
|
+
* multilingual support.
|
|
3358
3731
|
*/
|
|
3359
|
-
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | '
|
|
3732
|
+
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | 'multi';
|
|
3360
3733
|
/**
|
|
3361
3734
|
* Maximum allowed length for the call, will force end the call if reached. The
|
|
3362
3735
|
* minimum value allowed is 60,000 ms (1 min), and maximum value allowed is
|
|
@@ -3392,7 +3765,7 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3392
3765
|
/**
|
|
3393
3766
|
* The model to use for post call analysis. Default to gpt-4.1-mini.
|
|
3394
3767
|
*/
|
|
3395
|
-
post_call_analysis_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;
|
|
3768
|
+
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
|
|
3396
3769
|
/**
|
|
3397
3770
|
* A list of words / phrases and their pronunciation to be used to guide the audio
|
|
3398
3771
|
* synthesize for consistent pronunciation. Currently only supported for English &
|
|
@@ -3438,28 +3811,37 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3438
3811
|
signed_url_expiration_ms?: number | null;
|
|
3439
3812
|
/**
|
|
3440
3813
|
* If set, determines whether speech to text should focus on latency or accuracy.
|
|
3441
|
-
* Default to fast mode.
|
|
3814
|
+
* Default to fast mode. When set to custom, custom_stt_config must be provided.
|
|
3442
3815
|
*/
|
|
3443
|
-
stt_mode?: 'fast' | 'accurate';
|
|
3816
|
+
stt_mode?: 'fast' | 'accurate' | 'custom';
|
|
3444
3817
|
user_dtmf_options?: Agent.UserDtmfOptions | null;
|
|
3818
|
+
/**
|
|
3819
|
+
* Optional description of the agent version. Used for your own reference and
|
|
3820
|
+
* documentation.
|
|
3821
|
+
*/
|
|
3822
|
+
version_description?: string | null;
|
|
3445
3823
|
/**
|
|
3446
3824
|
* If set, determines the vocabulary set to use for transcription. This setting
|
|
3447
3825
|
* only applies for English agents, for non English agent, this setting is a no-op.
|
|
3448
3826
|
* Default to general.
|
|
3449
3827
|
*/
|
|
3450
3828
|
vocab_specialization?: 'general' | 'medical';
|
|
3829
|
+
/**
|
|
3830
|
+
* Controls the emotional tone of the agent's voice. Currently supported for
|
|
3831
|
+
* Cartesia and Minimax TTS providers. If unset, no emotion will be used.
|
|
3832
|
+
*/
|
|
3833
|
+
voice_emotion?: 'calm' | 'sympathetic' | 'happy' | 'sad' | 'angry' | 'fearful' | 'surprised' | null;
|
|
3451
3834
|
/**
|
|
3452
3835
|
* Unique voice id used for the agent. Find list of available voices and their
|
|
3453
3836
|
* preview in Dashboard.
|
|
3454
3837
|
*/
|
|
3455
3838
|
voice_id?: string;
|
|
3456
3839
|
/**
|
|
3457
|
-
*
|
|
3458
|
-
*
|
|
3459
|
-
*
|
|
3460
|
-
* each voice model.
|
|
3840
|
+
* Select the voice model used for the selected voice. Each provider has a set of
|
|
3841
|
+
* available voice models. Set to null to remove voice model selection, and default
|
|
3842
|
+
* ones will apply. Check out dashboard for more details of each voice model.
|
|
3461
3843
|
*/
|
|
3462
|
-
voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'tts-1' | 'gpt-4o-mini-tts' | null;
|
|
3844
|
+
voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'sonic-2' | 'sonic-3' | 'sonic-3-latest' | 'sonic-turbo' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | null;
|
|
3463
3845
|
/**
|
|
3464
3846
|
* Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
|
|
3465
3847
|
* speech, while higher value means faster speech rate. If unset, default value 1
|
|
@@ -3473,6 +3855,19 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3473
3855
|
* apply.
|
|
3474
3856
|
*/
|
|
3475
3857
|
voice_temperature?: number;
|
|
3858
|
+
/**
|
|
3859
|
+
* Configures when to stop running voicemail detection, as it becomes unlikely to
|
|
3860
|
+
* hit voicemail after a couple minutes, and keep running it will only have
|
|
3861
|
+
* negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum value
|
|
3862
|
+
* allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
|
|
3863
|
+
*/
|
|
3864
|
+
voicemail_detection_timeout_ms?: number;
|
|
3865
|
+
/**
|
|
3866
|
+
* The message to be played when the call enters a voicemail. Note that this
|
|
3867
|
+
* feature is only available for phone calls. If you want to hangup after hitting
|
|
3868
|
+
* voicemail, set this to empty string.
|
|
3869
|
+
*/
|
|
3870
|
+
voicemail_message?: string;
|
|
3476
3871
|
/**
|
|
3477
3872
|
* If this option is set, the call will try to detect voicemail in the first 3
|
|
3478
3873
|
* minutes of the call. Actions defined (hangup, or leave a message) will be
|
|
@@ -3486,6 +3881,11 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3486
3881
|
* If unset, default value 1 will apply.
|
|
3487
3882
|
*/
|
|
3488
3883
|
volume?: number;
|
|
3884
|
+
/**
|
|
3885
|
+
* Which webhook events this agent should receive. If not set, defaults to
|
|
3886
|
+
* call_started, call_ended, call_analyzed.
|
|
3887
|
+
*/
|
|
3888
|
+
webhook_events?: Array<'call_started' | 'call_ended' | 'call_analyzed' | 'transcript_updated' | 'transfer_started' | 'transfer_bridged' | 'transfer_cancelled' | 'transfer_ended'> | null;
|
|
3489
3889
|
/**
|
|
3490
3890
|
* The timeout for the webhook in milliseconds. If not set, default value of 10000
|
|
3491
3891
|
* will apply.
|
|
@@ -3500,6 +3900,49 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3500
3900
|
webhook_url?: string | null;
|
|
3501
3901
|
}
|
|
3502
3902
|
namespace Agent {
|
|
3903
|
+
/**
|
|
3904
|
+
* Custom STT configuration. Only used when stt_mode is set to custom.
|
|
3905
|
+
*/
|
|
3906
|
+
interface CustomSttConfig {
|
|
3907
|
+
/**
|
|
3908
|
+
* Endpointing timeout in milliseconds. Minimum is 100 for azure, 10 for deepgram.
|
|
3909
|
+
*/
|
|
3910
|
+
endpointing_ms: number;
|
|
3911
|
+
/**
|
|
3912
|
+
* The STT provider to use.
|
|
3913
|
+
*/
|
|
3914
|
+
provider: 'azure' | 'deepgram';
|
|
3915
|
+
}
|
|
3916
|
+
/**
|
|
3917
|
+
* Configuration for guardrail checks to detect and prevent prohibited topics in
|
|
3918
|
+
* agent output and user input.
|
|
3919
|
+
*/
|
|
3920
|
+
interface GuardrailConfig {
|
|
3921
|
+
/**
|
|
3922
|
+
* Selected prohibited user topic categories to check. When user messages contain
|
|
3923
|
+
* these topics, the agent will respond with a placeholder message instead of
|
|
3924
|
+
* processing the request.
|
|
3925
|
+
*/
|
|
3926
|
+
input_topics?: Array<'platform_integrity_jailbreaking'> | null;
|
|
3927
|
+
/**
|
|
3928
|
+
* Selected prohibited agent topic categories to check. When agent messages contain
|
|
3929
|
+
* these topics, they will be replaced with a placeholder message.
|
|
3930
|
+
*/
|
|
3931
|
+
output_topics?: Array<'harassment' | 'self_harm' | 'sexual_exploitation' | 'violence' | 'defense_and_national_security' | 'illicit_and_harmful_activity' | 'gambling' | 'regulated_professional_advice' | 'child_safety_and_exploitation'> | null;
|
|
3932
|
+
}
|
|
3933
|
+
/**
|
|
3934
|
+
* If this option is set, the call will try to detect IVR in the first 3 minutes of
|
|
3935
|
+
* the call. Actions defined will be applied when the IVR is detected. Set this to
|
|
3936
|
+
* null to disable IVR detection.
|
|
3937
|
+
*/
|
|
3938
|
+
interface IvrOption {
|
|
3939
|
+
action: IvrOption.Action;
|
|
3940
|
+
}
|
|
3941
|
+
namespace IvrOption {
|
|
3942
|
+
interface Action {
|
|
3943
|
+
type: 'hangup';
|
|
3944
|
+
}
|
|
3945
|
+
}
|
|
3503
3946
|
/**
|
|
3504
3947
|
* Configuration for PII scrubbing from transcripts and recordings.
|
|
3505
3948
|
*/
|
|
@@ -3507,7 +3950,7 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3507
3950
|
/**
|
|
3508
3951
|
* List of PII categories to scrub from transcripts and recordings.
|
|
3509
3952
|
*/
|
|
3510
|
-
categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth'>;
|
|
3953
|
+
categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth' | 'customer_account_number'>;
|
|
3511
3954
|
/**
|
|
3512
3955
|
* The processing mode for PII scrubbing. Currently only post-call is supported.
|
|
3513
3956
|
*/
|
|
@@ -3638,7 +4081,7 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3638
4081
|
digit_limit?: number | null;
|
|
3639
4082
|
/**
|
|
3640
4083
|
* A single key that signals the end of DTMF input. Acceptable values include any
|
|
3641
|
-
* digit (0
|
|
4084
|
+
* digit (0-9), the pound/hash symbol (#), or the asterisk (\*).
|
|
3642
4085
|
*/
|
|
3643
4086
|
termination_key?: string | null;
|
|
3644
4087
|
/**
|
|
@@ -3654,7 +4097,7 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3654
4097
|
* detection.
|
|
3655
4098
|
*/
|
|
3656
4099
|
interface VoicemailOption {
|
|
3657
|
-
action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup;
|
|
4100
|
+
action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup | VoicemailOption.VoicemailActionBridgeTransfer;
|
|
3658
4101
|
}
|
|
3659
4102
|
namespace VoicemailOption {
|
|
3660
4103
|
interface VoicemailActionPrompt {
|
|
@@ -3675,6 +4118,9 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3675
4118
|
interface VoicemailActionHangup {
|
|
3676
4119
|
type: 'hangup';
|
|
3677
4120
|
}
|
|
4121
|
+
interface VoicemailActionBridgeTransfer {
|
|
4122
|
+
type: 'bridge_transfer';
|
|
4123
|
+
}
|
|
3678
4124
|
}
|
|
3679
4125
|
}
|
|
3680
4126
|
/**
|
|
@@ -3739,7 +4185,7 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3739
4185
|
/**
|
|
3740
4186
|
* The LLM model to use
|
|
3741
4187
|
*/
|
|
3742
|
-
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';
|
|
4188
|
+
model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
|
|
3743
4189
|
/**
|
|
3744
4190
|
* Type of model choice
|
|
3745
4191
|
*/
|
|
@@ -3781,7 +4227,7 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3781
4227
|
/**
|
|
3782
4228
|
* Select the underlying text LLM. If not set, would default to gpt-4.1.
|
|
3783
4229
|
*/
|
|
3784
|
-
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;
|
|
4230
|
+
model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
|
|
3785
4231
|
/**
|
|
3786
4232
|
* If set to true, will use high priority pool with more dedicated resource to
|
|
3787
4233
|
* ensure lower and more consistent latency, default to false. This feature usually
|
|
@@ -3799,7 +4245,7 @@ export declare namespace CallRegisterPhoneCallParams {
|
|
|
3799
4245
|
* Select the underlying speech to speech model. Can only set this or model, not
|
|
3800
4246
|
* both.
|
|
3801
4247
|
*/
|
|
3802
|
-
s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
|
|
4248
|
+
s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | 'gpt-realtime-mini' | null;
|
|
3803
4249
|
/**
|
|
3804
4250
|
* The speaker who starts the conversation. Required. Must be either 'user' or
|
|
3805
4251
|
* 'agent'.
|