@signalwire/sdk 2.0.5 → 3.5.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 +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +481 -126
- package/dist/AgentBase.js +1502 -438
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +12 -1
- package/dist/POM/PromptObjectModel.js +25 -9
- package/dist/POM/PromptObjectModel.js.map +1 -1
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +18 -0
- package/dist/PomBuilder.js +53 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +22 -1
- package/dist/PromptManager.js +28 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +158 -58
- package/dist/SWMLService.js +435 -127
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +49 -9
- package/dist/SecurityUtils.js +153 -51
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +92 -33
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -371
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +47 -68
- package/dist/index.js +44 -73
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +44 -17
- package/dist/relay/RelayClient.js +175 -65
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +73 -42
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +5 -2
- package/dist/rest/callHandler.js +4 -1
- package/dist/rest/callHandler.js.map +1 -1
- package/dist/rest/index.d.ts +18 -77
- package/dist/rest/index.js +47 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -327
- package/dist/rest/namespaces/fabric.js +14 -439
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +8 -196
- package/dist/rest/namespaces/phone-numbers.js +8 -230
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +22 -11
- package/dist/skills/SkillRegistry.js +47 -17
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +18 -6
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +21 -22
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +42 -4
- package/dist/skills/builtin/spider.js +277 -104
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +38 -30
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +294 -100
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +14 -13
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +59 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +85 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
|
@@ -0,0 +1,4557 @@
|
|
|
1
|
+
export interface AI {
|
|
2
|
+
/** Creates an AI agent that conducts voice conversations using automatic speech recognition (ASR), */
|
|
3
|
+
ai: AIObject;
|
|
4
|
+
}
|
|
5
|
+
export interface AIAddressPaginationResponse {
|
|
6
|
+
/** Link of the current page */
|
|
7
|
+
self: string;
|
|
8
|
+
/** Link to the first page */
|
|
9
|
+
first: string;
|
|
10
|
+
/** Link to the next page */
|
|
11
|
+
next?: string;
|
|
12
|
+
/** Link to the previous page */
|
|
13
|
+
prev?: string;
|
|
14
|
+
}
|
|
15
|
+
/** An AI Agent configuration that extends the SWML AI object with additional API-specific properties. */
|
|
16
|
+
export interface AIAgent {
|
|
17
|
+
/** A key-value object for storing data that persists throughout the AI session. */
|
|
18
|
+
global_data?: Record<string, Record<string, unknown>>;
|
|
19
|
+
/** Hints help the AI agent understand certain words or phrases better. Words that can commonly be misinterpreted can be added to the hints to help the AI speak more accurately. */
|
|
20
|
+
hints?: (string | Hint)[];
|
|
21
|
+
/** An array of JSON objects defining supported languages in the conversation. */
|
|
22
|
+
languages?: Languages[];
|
|
23
|
+
/** A JSON object containing parameters as key-value pairs. */
|
|
24
|
+
params?: AIParams;
|
|
25
|
+
/** The final set of instructions and configuration settings to send to the agent. */
|
|
26
|
+
post_prompt?: AIPostPrompt;
|
|
27
|
+
/** The URL to which to send status callbacks and reports. Authentication can also be set in the url in the format of `username:password@url`. */
|
|
28
|
+
post_prompt_url?: string;
|
|
29
|
+
/** An array of JSON objects to clarify the AI's pronunciation of words or expressions. */
|
|
30
|
+
pronounce?: Pronounce[];
|
|
31
|
+
/** Defines the AI agent's personality, goals, behaviors, and instructions for handling conversations. */
|
|
32
|
+
prompt: AIPrompt;
|
|
33
|
+
/** An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue. */
|
|
34
|
+
SWAIG?: SWAIG;
|
|
35
|
+
/** Unique ID of an AI Agent. */
|
|
36
|
+
agent_id: uuid;
|
|
37
|
+
/** Name of the AI Agent. */
|
|
38
|
+
name: string;
|
|
39
|
+
}
|
|
40
|
+
export interface AIAgentAddressListResponse {
|
|
41
|
+
/** An array of objects containing the address data */
|
|
42
|
+
data: FabricAddressApp[];
|
|
43
|
+
/** Object containing pagination links */
|
|
44
|
+
links: AIAddressPaginationResponse;
|
|
45
|
+
}
|
|
46
|
+
export interface AIAgentCreateRequest {
|
|
47
|
+
/** A key-value object for storing data that persists throughout the AI session. */
|
|
48
|
+
global_data?: Record<string, Record<string, unknown>>;
|
|
49
|
+
/** Hints help the AI agent understand certain words or phrases better. Words that can commonly be misinterpreted can be added to the hints to help the AI speak more accurately. */
|
|
50
|
+
hints?: (string | Hint)[];
|
|
51
|
+
/** An array of JSON objects defining supported languages in the conversation. */
|
|
52
|
+
languages?: Languages[];
|
|
53
|
+
/** A JSON object containing parameters as key-value pairs. */
|
|
54
|
+
params?: AIParams;
|
|
55
|
+
/** The final set of instructions and configuration settings to send to the agent. */
|
|
56
|
+
post_prompt?: AIPostPrompt;
|
|
57
|
+
/** The URL to which to send status callbacks and reports. Authentication can also be set in the url in the format of `username:password@url`. */
|
|
58
|
+
post_prompt_url?: string;
|
|
59
|
+
/** An array of JSON objects to clarify the AI's pronunciation of words or expressions. */
|
|
60
|
+
pronounce?: Pronounce[];
|
|
61
|
+
/** Defines the AI agent's personality, goals, behaviors, and instructions for handling conversations. */
|
|
62
|
+
prompt: AIPrompt;
|
|
63
|
+
/** An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue. */
|
|
64
|
+
SWAIG?: SWAIG;
|
|
65
|
+
/** Unique ID of an AI Agent. */
|
|
66
|
+
agent_id?: uuid;
|
|
67
|
+
/** Name of the AI Agent. */
|
|
68
|
+
name: string;
|
|
69
|
+
}
|
|
70
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
71
|
+
export interface AIAgentCreateStatusCode422 {
|
|
72
|
+
/** List of validation errors. */
|
|
73
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
74
|
+
}
|
|
75
|
+
export interface AIAgentListResponse {
|
|
76
|
+
/** An array of objects containing the list of AI Agent data. */
|
|
77
|
+
data: AIAgentResponse[];
|
|
78
|
+
/** Object containing pagination links */
|
|
79
|
+
links: AIAgentPaginationResponse;
|
|
80
|
+
}
|
|
81
|
+
export interface AIAgentPaginationResponse {
|
|
82
|
+
/** Link of the current page */
|
|
83
|
+
self: string;
|
|
84
|
+
/** Link to the first page */
|
|
85
|
+
first: string;
|
|
86
|
+
/** Link to the next page */
|
|
87
|
+
next?: string;
|
|
88
|
+
/** Link to the previous page */
|
|
89
|
+
prev?: string;
|
|
90
|
+
}
|
|
91
|
+
export interface AIAgentResponse {
|
|
92
|
+
/** Unique ID of the AIAgent. */
|
|
93
|
+
id: uuid;
|
|
94
|
+
/** Unique ID of the Project. */
|
|
95
|
+
project_id: uuid;
|
|
96
|
+
/** Display name of the AIAgent Fabric Resource */
|
|
97
|
+
display_name: string;
|
|
98
|
+
/** Type of the Fabric Resource */
|
|
99
|
+
type: 'ai_agent';
|
|
100
|
+
/** Date and time when the resource was created. */
|
|
101
|
+
created_at: string;
|
|
102
|
+
/** Date and time when the resource was updated. */
|
|
103
|
+
updated_at: string;
|
|
104
|
+
/** AIAgent data. */
|
|
105
|
+
ai_agent: AIAgent;
|
|
106
|
+
}
|
|
107
|
+
export interface AIAgentUpdateRequest {
|
|
108
|
+
/** A key-value object for storing data that persists throughout the AI session. */
|
|
109
|
+
global_data?: Record<string, Record<string, unknown>>;
|
|
110
|
+
/** Hints help the AI agent understand certain words or phrases better. Words that can commonly be misinterpreted can be added to the hints to help the AI speak more accurately. */
|
|
111
|
+
hints?: (string | Hint)[];
|
|
112
|
+
/** An array of JSON objects defining supported languages in the conversation. */
|
|
113
|
+
languages?: Languages[];
|
|
114
|
+
/** A JSON object containing parameters as key-value pairs. */
|
|
115
|
+
params?: AIParams;
|
|
116
|
+
/** The final set of instructions and configuration settings to send to the agent. */
|
|
117
|
+
post_prompt?: AIPostPromptUpdate;
|
|
118
|
+
/** The URL to which to send status callbacks and reports. Authentication can also be set in the url in the format of `username:password@url`. */
|
|
119
|
+
post_prompt_url?: string;
|
|
120
|
+
/** An array of JSON objects to clarify the AI's pronunciation of words or expressions. */
|
|
121
|
+
pronounce?: Pronounce[];
|
|
122
|
+
/** Defines the AI agent's personality, goals, behaviors, and instructions for handling conversations. */
|
|
123
|
+
prompt?: AIPromptUpdate;
|
|
124
|
+
/** An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue. */
|
|
125
|
+
SWAIG?: SWAIGUpdate;
|
|
126
|
+
/** Unique ID of an AI Agent. */
|
|
127
|
+
agent_id?: uuid;
|
|
128
|
+
/** Name of the AI Agent. */
|
|
129
|
+
name?: string;
|
|
130
|
+
}
|
|
131
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
132
|
+
export interface AIAgentUpdateStatusCode422 {
|
|
133
|
+
/** List of validation errors. */
|
|
134
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
135
|
+
}
|
|
136
|
+
export interface AIObject {
|
|
137
|
+
/** A key-value object for storing data that persists throughout the AI session. */
|
|
138
|
+
global_data?: Record<string, Record<string, unknown>>;
|
|
139
|
+
/** Hints help the AI agent understand certain words or phrases better. Words that can commonly be misinterpreted can be added to the hints to help the AI speak more accurately. */
|
|
140
|
+
hints?: (string | Hint)[];
|
|
141
|
+
/** An array of JSON objects defining supported languages in the conversation. */
|
|
142
|
+
languages?: Languages[];
|
|
143
|
+
/** A JSON object containing parameters as key-value pairs. */
|
|
144
|
+
params?: AIParams;
|
|
145
|
+
/** The final set of instructions and configuration settings to send to the agent. */
|
|
146
|
+
post_prompt?: AIPostPrompt;
|
|
147
|
+
/** The URL to which to send status callbacks and reports. Authentication can also be set in the url in the format of `username:password@url`. */
|
|
148
|
+
post_prompt_url?: string;
|
|
149
|
+
/** An array of JSON objects to clarify the AI's pronunciation of words or expressions. */
|
|
150
|
+
pronounce?: Pronounce[];
|
|
151
|
+
/** Defines the AI agent's personality, goals, behaviors, and instructions for handling conversations. */
|
|
152
|
+
prompt: AIPrompt;
|
|
153
|
+
/** An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue. */
|
|
154
|
+
SWAIG?: SWAIG;
|
|
155
|
+
}
|
|
156
|
+
export interface AIParams {
|
|
157
|
+
/** Instructs the agent to acknowledge crosstalk and confirm user input when the user speaks over the agent. */
|
|
158
|
+
acknowledge_interruptions?: boolean | SWMLVar;
|
|
159
|
+
/** The model to use for the AI. Allowed values are `gpt-4o-mini`, `gpt-4.1-mini`, and `gpt-4.1-nano`. */
|
|
160
|
+
ai_model?: 'gpt-4o-mini' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | string;
|
|
161
|
+
/** Sets the name the AI agent responds to for wake/activation purposes. When using `enable_pause`, `start_paused`, or `speak_when_spoken_to`, the user must say this name to get the agent's attention. The name matching is case-insensitive. */
|
|
162
|
+
ai_name?: string;
|
|
163
|
+
/** Adjust the volume of the AI. Allowed values from `-50` - `50`. **Default:** `0`. */
|
|
164
|
+
ai_volume?: number | SWMLVar;
|
|
165
|
+
/** A custom identifier for the AI application instance. This name is included in webhook payloads, allowing backend systems to identify which AI configuration made the request. */
|
|
166
|
+
app_name?: string;
|
|
167
|
+
/** If true, enables smart formatting in ASR (Automatic Speech Recognition). */
|
|
168
|
+
asr_smart_format?: boolean | SWMLVar;
|
|
169
|
+
/** Amount of time, in ms, to wait before prompting the user to respond. Allowed values from `10,000` - `600,000`. Set to `0` to disable. **Default:** `5000` ms (note: user-configurable values must be `0` or within the `10,000` - `600,000` range). */
|
|
170
|
+
attention_timeout?: AttentionTimeout | 0 | SWMLVar;
|
|
171
|
+
/** A custom prompt that is fed into the AI when the attention_timeout is reached. */
|
|
172
|
+
attention_timeout_prompt?: string;
|
|
173
|
+
/** If true, enables speaker diarization in ASR (Automatic Speech Recognition). */
|
|
174
|
+
asr_diarize?: boolean | SWMLVar;
|
|
175
|
+
/** If true, will force the AI Agent to only respond to the speaker who reesponds to the AI Agent first. */
|
|
176
|
+
asr_speaker_affinity?: boolean | SWMLVar;
|
|
177
|
+
/** URL of audio file to play in the background while AI plays in foreground. */
|
|
178
|
+
background_file?: string;
|
|
179
|
+
/** Maximum number of times to loop playing the background file. `undefined` means loop indefinitely. */
|
|
180
|
+
background_file_loops?: number | null | SWMLVar;
|
|
181
|
+
/** Defines background_file volume within a range of `-50` to `50`. **Default:** `0`. */
|
|
182
|
+
background_file_volume?: number | SWMLVar;
|
|
183
|
+
/** Controls the barge behavior. Allowed values are `"complete"`, `"partial"`, `"all"`, or boolean. */
|
|
184
|
+
enable_barge?: string | boolean | SWMLVar;
|
|
185
|
+
/** Enables the inner dialog feature, which runs a separate AI process in the background */
|
|
186
|
+
enable_inner_dialog?: boolean | SWMLVar;
|
|
187
|
+
/** Enables the pause/resume functionality for the AI agent. When enabled, a `pause_conversation` */
|
|
188
|
+
enable_pause?: boolean | SWMLVar;
|
|
189
|
+
/** Enables intelligent turn detection that monitors partial speech transcripts for sentence-ending */
|
|
190
|
+
enable_turn_detection?: boolean | SWMLVar;
|
|
191
|
+
/** Takes a string, including a regular expression, defining barge behavior. */
|
|
192
|
+
barge_match_string?: string;
|
|
193
|
+
/** Defines the number of words that must be input before triggering barge behavior, in a range of `1-99`. */
|
|
194
|
+
barge_min_words?: number | SWMLVar;
|
|
195
|
+
/** If `true`, allows functions to be executed while the AI is being interrupted. **Default:** `true`. */
|
|
196
|
+
barge_functions?: boolean | SWMLVar;
|
|
197
|
+
/** Sets the prompt which binds the agent to its purpose. */
|
|
198
|
+
conscience?: string;
|
|
199
|
+
/** Injects pre-existing conversation history into the AI session at startup. This allows you to seed the AI agent with context from a previous conversation or provide example interactions. */
|
|
200
|
+
convo?: ConversationMessage[];
|
|
201
|
+
/** Used by `check_for_input` and `save_conversation` to identify an individual conversation. */
|
|
202
|
+
conversation_id?: string;
|
|
203
|
+
/** Sets the size of the sliding window for conversation history. This limits how much conversation history is sent to the AI model. */
|
|
204
|
+
conversation_sliding_window?: number | SWMLVar;
|
|
205
|
+
/** Enables debugging to the set URL. Allowed values from `0` - `2`. Default is `1` if url is set. */
|
|
206
|
+
debug_webhook_level?: number | SWMLVar;
|
|
207
|
+
/** Each interaction between the AI and end user is posted in real time to the established URL. */
|
|
208
|
+
debug_webhook_url?: string;
|
|
209
|
+
/** Enables debug mode for the AI session. When enabled, additional diagnostic information is logged including turn detection events, speech processing details, and internal state changes. */
|
|
210
|
+
debug?: boolean | number | SWMLVar;
|
|
211
|
+
/** Forces the direction of the call to the assistant. Valid values are `inbound` and `outbound`. */
|
|
212
|
+
direction?: Direction | SWMLVar;
|
|
213
|
+
/** DTMF digit, as a string, to signal the end of input (ex: '#') */
|
|
214
|
+
digit_terminators?: string;
|
|
215
|
+
/** Time, in ms, at the end of digit input to detect end of input. Allowed values from `0` - `30,000`. **Default:** `3000` ms. */
|
|
216
|
+
digit_timeout?: number | SWMLVar;
|
|
217
|
+
/** Amount of silence, in ms, at the end of an utterance to detect end of speech. Allowed values from `250` - `10,000`. **Default:** `700` ms. */
|
|
218
|
+
end_of_speech_timeout?: number | SWMLVar;
|
|
219
|
+
/** Enables thinking output for the AI Agent. */
|
|
220
|
+
enable_thinking?: boolean | SWMLVar;
|
|
221
|
+
/** Enables visual input processing for the AI Agent. */
|
|
222
|
+
enable_vision?: boolean | SWMLVar;
|
|
223
|
+
/** Amount of energy necessary for bot to hear you (in dB). Allowed values from `0.0` - `100.0`. **Default:** `52.0` dB. */
|
|
224
|
+
energy_level?: number | SWMLVar;
|
|
225
|
+
/** Amount of time, in ms, to wait for the first word after speech is detected. Allowed values from `0` - `10,000`. **Default:** `1000` ms. */
|
|
226
|
+
first_word_timeout?: number | SWMLVar;
|
|
227
|
+
/** If `true`, the AI will wait for any `filler` to finish playing before executing a function. */
|
|
228
|
+
function_wait_for_talking?: boolean | SWMLVar;
|
|
229
|
+
/** If `true`, functions can be executed when there is no user response after a timeout. **Default:** `false`. */
|
|
230
|
+
functions_on_no_response?: boolean | SWMLVar;
|
|
231
|
+
/** A final prompt that is fed into the AI when the `hard_stop_time` is reached. */
|
|
232
|
+
hard_stop_prompt?: string;
|
|
233
|
+
/** Specifies the maximum duration fopr the AI Agent to remain active before it exists the session. */
|
|
234
|
+
hard_stop_time?: string | SWMLVar;
|
|
235
|
+
/** A URL for the hold music to play, accepting WAV, mp3, and FreeSWITCH tone_stream. */
|
|
236
|
+
hold_music?: string;
|
|
237
|
+
/** Enables hold music during SWAIG processing. */
|
|
238
|
+
hold_on_process?: boolean | SWMLVar;
|
|
239
|
+
/** Amount of time, in ms, to wait before exiting the app due to inactivity. Allowed values from `10,000` - `3,600,000`. **Default:** `600000` ms (10 minutes). */
|
|
240
|
+
inactivity_timeout?: number | SWMLVar;
|
|
241
|
+
/** Specifies the AI model to use for the inner dialog feature. Can be set to a different (often smaller/faster) model than the main conversation model. Only used when `enable_inner_dialog` is `true`. */
|
|
242
|
+
inner_dialog_model?: 'gpt-4o-mini' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | string;
|
|
243
|
+
/** The system prompt that guides the inner dialog AI's behavior. This prompt shapes how the background AI */
|
|
244
|
+
inner_dialog_prompt?: string;
|
|
245
|
+
/** When enabled, synchronizes the inner dialog with the main conversation flow. */
|
|
246
|
+
inner_dialog_synced?: boolean | SWMLVar;
|
|
247
|
+
/** Amount of time, in ms, to wait before starting the conversation. Allowed values from `0` - `300,000`. */
|
|
248
|
+
initial_sleep_ms?: number | SWMLVar;
|
|
249
|
+
/** Check for input function with check_for_input. */
|
|
250
|
+
input_poll_freq?: number | SWMLVar;
|
|
251
|
+
/** When enabled, barges agent upon any sound interruption longer than 1 second. */
|
|
252
|
+
interrupt_on_noise?: boolean | SWMLVar;
|
|
253
|
+
/** Provide a prompt for the agent to handle crosstalk. */
|
|
254
|
+
interrupt_prompt?: string;
|
|
255
|
+
/** @deprecated Allows multilingualism when `true`. */
|
|
256
|
+
languages_enabled?: boolean | SWMLVar;
|
|
257
|
+
/** The local timezone setting for the AI. Value should use `IANA TZ ID` */
|
|
258
|
+
local_tz?: string;
|
|
259
|
+
/** If true, the AI Agent will be involved with the diarization process. */
|
|
260
|
+
llm_diarize_aware?: boolean | SWMLVar;
|
|
261
|
+
/** Sets the maximum emotion intensity for the AI voice. Allowed values from `1` - `30`. **Default:** `30`. */
|
|
262
|
+
max_emotion?: number | SWMLVar;
|
|
263
|
+
/** Sets the maximum number of tokens the AI model can generate in a single response. Lower values produce shorter responses and reduce latency. */
|
|
264
|
+
max_response_tokens?: number | SWMLVar;
|
|
265
|
+
/** The ASR (Automatic Speech Recognition) engine to use. Common values include `nova-2` and `nova-3`. */
|
|
266
|
+
openai_asr_engine?: string;
|
|
267
|
+
/** Sets a time duration for the outbound call recipient to respond to the AI agent before timeout, in a range from `10000` to `600000`. **Default:** `120000` ms (2 minutes). */
|
|
268
|
+
outbound_attention_timeout?: number | SWMLVar;
|
|
269
|
+
/** When enabled, the `global_data` object is automatically saved to a channel variable */
|
|
270
|
+
persist_global_data?: boolean | SWMLVar;
|
|
271
|
+
/** Specifies the output format for structured prompts when using the `pom` array in prompt definitions. Valid values are `markdown` or `xml`. */
|
|
272
|
+
pom_format?: 'markdown' | 'xml';
|
|
273
|
+
/** Send a summary of the conversation after the call ends. */
|
|
274
|
+
save_conversation?: boolean | SWMLVar;
|
|
275
|
+
/** Amount of time, in ms, to wait for a speech event. Allowed values from `0` - `10,000`. **Default:** `1400` ms. */
|
|
276
|
+
speech_event_timeout?: number | SWMLVar;
|
|
277
|
+
/** Number of quick stops to generate for speech. Allowed values from `0` - `10`. **Default:** `3`. */
|
|
278
|
+
speech_gen_quick_stops?: number | SWMLVar;
|
|
279
|
+
/** Overall speech timeout, in ms. Allowed values from `0` - `600,000`. **Default:** `60000` ms. */
|
|
280
|
+
speech_timeout?: number | SWMLVar;
|
|
281
|
+
/** When enabled, the AI agent remains silent until directly addressed by name (using `ai_name`). */
|
|
282
|
+
speak_when_spoken_to?: boolean | SWMLVar;
|
|
283
|
+
/** When enabled, the AI agent starts in a paused state and will not respond until the user */
|
|
284
|
+
start_paused?: boolean | SWMLVar;
|
|
285
|
+
/** The static greeting to play when the call is answered. This will always play at the beginning of the call. */
|
|
286
|
+
static_greeting?: string;
|
|
287
|
+
/** If `true`, the static greeting will not be interrupted by the user if they speak over the greeting. If `false`, the static greeting can be interrupted by the user if they speak over the greeting. */
|
|
288
|
+
static_greeting_no_barge?: boolean | SWMLVar;
|
|
289
|
+
/** Defines the mode for summary generation. Allowed values are `"string"` and `"original"`. */
|
|
290
|
+
summary_mode?: 'string' | 'original' | SWMLVar;
|
|
291
|
+
/** Allows tweaking any of the indicated settings, such as `barge_match_string`, using the returned SWML from the SWAIG function. **Default:** `true`. */
|
|
292
|
+
swaig_allow_settings?: boolean | SWMLVar;
|
|
293
|
+
/** Allows your SWAIG to return SWML to be executed. **Default:** `true`. */
|
|
294
|
+
swaig_allow_swml?: boolean | SWMLVar;
|
|
295
|
+
/** Post entire conversation to any SWAIG call. */
|
|
296
|
+
swaig_post_conversation?: boolean | SWMLVar;
|
|
297
|
+
/** Allows SWAIG to set global data that persists across calls. **Default:** `true`. */
|
|
298
|
+
swaig_set_global_data?: boolean | SWMLVar;
|
|
299
|
+
/** Controls whether SWML variables are included in SWAIG function webhook payloads. */
|
|
300
|
+
swaig_post_swml_vars?: boolean | string[] | SWMLVar;
|
|
301
|
+
/** The model to use for the AI's thinking capabilities. Allowed values are `gpt-4o-mini`, `gpt-4.1-mini`, and `gpt-4.1-nano`. */
|
|
302
|
+
thinking_model?: 'gpt-4o-mini' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | string;
|
|
303
|
+
/** When enabled, the AI will not respond to the user's input when the user is speaking over the agent. */
|
|
304
|
+
transparent_barge?: boolean | SWMLVar;
|
|
305
|
+
/** Maximum time, in ms, for transparent barge mode. Allowed values from `0` - `60,000`. **Default:** `3000` ms. */
|
|
306
|
+
transparent_barge_max_time?: number | SWMLVar;
|
|
307
|
+
/** Pass a summary of a conversation from one AI agent to another. For example, transfer a call summary between support agents in two departments. */
|
|
308
|
+
transfer_summary?: boolean | SWMLVar;
|
|
309
|
+
/** Time in milliseconds to wait after detecting a potential end-of-turn before finalizing speech recognition. */
|
|
310
|
+
turn_detection_timeout?: number | SWMLVar;
|
|
311
|
+
/** The format for the AI agent to reference phone numbers. */
|
|
312
|
+
tts_number_format?: 'international' | 'national';
|
|
313
|
+
/** URL of a video file to play when AI is listening to the user speak. Only works for calls that support video. */
|
|
314
|
+
video_listening_file?: string;
|
|
315
|
+
/** URL of a video file to play when AI is idle. Only works for calls that support video. */
|
|
316
|
+
video_idle_file?: string;
|
|
317
|
+
/** URL of a video file to play when AI is talking. Only works for calls that support video. */
|
|
318
|
+
video_talking_file?: string;
|
|
319
|
+
/** The model to use for the AI's vision capabilities. Allowed values are `gpt-4o-mini`, `gpt-4.1-mini`, and `gpt-4.1-nano`. */
|
|
320
|
+
vision_model?: 'gpt-4o-mini' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | string;
|
|
321
|
+
/** Configures Silero Voice Activity Detection (VAD) settings. Format: `"threshold"` or `"threshold:frame_ms"`. */
|
|
322
|
+
vad_config?: string;
|
|
323
|
+
/** When false, AI agent will initialize dialogue after call is setup. When true, agent will wait for the user to speak first. */
|
|
324
|
+
wait_for_user?: boolean | SWMLVar;
|
|
325
|
+
/** Specifies an additional prefix that must be spoken along with the agent's name (`ai_name`) */
|
|
326
|
+
wake_prefix?: string;
|
|
327
|
+
/** The stability slider determines how stable the voice is and the randomness between each generation. Lowering this slider introduces a broader emotional range for the voice. */
|
|
328
|
+
eleven_labs_stability?: number | SWMLVar;
|
|
329
|
+
/** The similarity slider dictates how closely the AI should adhere to the original voice when attempting to replicate it. The higher the similarity, the closer the AI will sound to the original voice. */
|
|
330
|
+
eleven_labs_similarity?: number | SWMLVar;
|
|
331
|
+
[key: string]: Record<string, unknown> | boolean | SWMLVar | 'gpt-4o-mini' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | string | string | number | SWMLVar | AttentionTimeout | 0 | SWMLVar | number | null | SWMLVar | string | boolean | SWMLVar | ConversationMessage[] | boolean | number | SWMLVar | Direction | SWMLVar | string | SWMLVar | 'markdown' | 'xml' | 'string' | 'original' | SWMLVar | boolean | string[] | SWMLVar | 'international' | 'national' | undefined;
|
|
332
|
+
}
|
|
333
|
+
export type AIPostPrompt = AIPostPromptText | AIPostPromptPom;
|
|
334
|
+
export interface AIPostPromptPom {
|
|
335
|
+
/** Limits the amount of tokens that the AI agent may generate when creating its response */
|
|
336
|
+
max_tokens?: number;
|
|
337
|
+
/** Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
338
|
+
temperature?: number | SWMLVar;
|
|
339
|
+
/** Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
340
|
+
top_p?: number | SWMLVar;
|
|
341
|
+
/** Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. */
|
|
342
|
+
confidence?: number | SWMLVar;
|
|
343
|
+
/** Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. */
|
|
344
|
+
presence_penalty?: number | SWMLVar;
|
|
345
|
+
/** Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. */
|
|
346
|
+
frequency_penalty?: number | SWMLVar;
|
|
347
|
+
/** The instructions to send to the agent. */
|
|
348
|
+
pom: POM[];
|
|
349
|
+
}
|
|
350
|
+
export interface AIPostPromptPomUpdate {
|
|
351
|
+
/** Limits the amount of tokens that the AI agent may generate when creating its response */
|
|
352
|
+
max_tokens?: number;
|
|
353
|
+
/** Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
354
|
+
temperature?: number | SWMLVar;
|
|
355
|
+
/** Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
356
|
+
top_p?: number | SWMLVar;
|
|
357
|
+
/** Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. */
|
|
358
|
+
confidence?: number | SWMLVar;
|
|
359
|
+
/** Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. */
|
|
360
|
+
presence_penalty?: number | SWMLVar;
|
|
361
|
+
/** Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. */
|
|
362
|
+
frequency_penalty?: number | SWMLVar;
|
|
363
|
+
/** The instructions to send to the agent. */
|
|
364
|
+
pom?: POM[];
|
|
365
|
+
}
|
|
366
|
+
export interface AIPostPromptText {
|
|
367
|
+
/** Limits the amount of tokens that the AI agent may generate when creating its response */
|
|
368
|
+
max_tokens?: number;
|
|
369
|
+
/** Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
370
|
+
temperature?: number | SWMLVar;
|
|
371
|
+
/** Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
372
|
+
top_p?: number | SWMLVar;
|
|
373
|
+
/** Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. */
|
|
374
|
+
confidence?: number | SWMLVar;
|
|
375
|
+
/** Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. */
|
|
376
|
+
presence_penalty?: number | SWMLVar;
|
|
377
|
+
/** Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. */
|
|
378
|
+
frequency_penalty?: number | SWMLVar;
|
|
379
|
+
/** The instructions to send to the agent. */
|
|
380
|
+
text: string;
|
|
381
|
+
}
|
|
382
|
+
export interface AIPostPromptTextUpdate {
|
|
383
|
+
/** Limits the amount of tokens that the AI agent may generate when creating its response */
|
|
384
|
+
max_tokens?: number;
|
|
385
|
+
/** Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
386
|
+
temperature?: number | SWMLVar;
|
|
387
|
+
/** Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
388
|
+
top_p?: number | SWMLVar;
|
|
389
|
+
/** Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. */
|
|
390
|
+
confidence?: number | SWMLVar;
|
|
391
|
+
/** Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. */
|
|
392
|
+
presence_penalty?: number | SWMLVar;
|
|
393
|
+
/** Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. */
|
|
394
|
+
frequency_penalty?: number | SWMLVar;
|
|
395
|
+
/** The instructions to send to the agent. */
|
|
396
|
+
text?: string;
|
|
397
|
+
}
|
|
398
|
+
export type AIPostPromptUpdate = AIPostPromptTextUpdate | AIPostPromptPomUpdate;
|
|
399
|
+
export type AIPrompt = AIPromptText | AIPromptPom;
|
|
400
|
+
export interface AIPromptPom {
|
|
401
|
+
/** Limits the amount of tokens that the AI agent may generate when creating its response */
|
|
402
|
+
max_tokens?: number;
|
|
403
|
+
/** Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
404
|
+
temperature?: number | SWMLVar;
|
|
405
|
+
/** Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
406
|
+
top_p?: number | SWMLVar;
|
|
407
|
+
/** Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. */
|
|
408
|
+
confidence?: number | SWMLVar;
|
|
409
|
+
/** Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. */
|
|
410
|
+
presence_penalty?: number | SWMLVar;
|
|
411
|
+
/** Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. */
|
|
412
|
+
frequency_penalty?: number | SWMLVar;
|
|
413
|
+
/** Prompt Object Model (POM) is a structured data format for composing, organizing, and rendering prompt instructions for AI agents. */
|
|
414
|
+
pom: POM[];
|
|
415
|
+
/** An object that defines the context steps for the AI. The context steps are used to define the flow of the conversation. */
|
|
416
|
+
contexts?: Contexts;
|
|
417
|
+
}
|
|
418
|
+
export interface AIPromptPomUpdate {
|
|
419
|
+
/** Limits the amount of tokens that the AI agent may generate when creating its response */
|
|
420
|
+
max_tokens?: number;
|
|
421
|
+
/** Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
422
|
+
temperature?: number | SWMLVar;
|
|
423
|
+
/** Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
424
|
+
top_p?: number | SWMLVar;
|
|
425
|
+
/** Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. */
|
|
426
|
+
confidence?: number | SWMLVar;
|
|
427
|
+
/** Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. */
|
|
428
|
+
presence_penalty?: number | SWMLVar;
|
|
429
|
+
/** Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. */
|
|
430
|
+
frequency_penalty?: number | SWMLVar;
|
|
431
|
+
/** Prompt Object Model (POM) is a structured data format for composing, organizing, and rendering prompt instructions for AI agents. */
|
|
432
|
+
pom?: POM[];
|
|
433
|
+
/** An object that defines the context steps for the AI. The context steps are used to define the flow of the conversation. */
|
|
434
|
+
contexts?: ContextsUpdate;
|
|
435
|
+
}
|
|
436
|
+
export interface AIPromptText {
|
|
437
|
+
/** Limits the amount of tokens that the AI agent may generate when creating its response */
|
|
438
|
+
max_tokens?: number;
|
|
439
|
+
/** Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
440
|
+
temperature?: number | SWMLVar;
|
|
441
|
+
/** Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
442
|
+
top_p?: number | SWMLVar;
|
|
443
|
+
/** Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. */
|
|
444
|
+
confidence?: number | SWMLVar;
|
|
445
|
+
/** Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. */
|
|
446
|
+
presence_penalty?: number | SWMLVar;
|
|
447
|
+
/** Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. */
|
|
448
|
+
frequency_penalty?: number | SWMLVar;
|
|
449
|
+
/** The instructions to send to the agent. */
|
|
450
|
+
text: string;
|
|
451
|
+
/** An object that defines the context steps for the AI. The context steps are used to define the flow of the conversation. */
|
|
452
|
+
contexts?: Contexts;
|
|
453
|
+
}
|
|
454
|
+
export interface AIPromptTextUpdate {
|
|
455
|
+
/** Limits the amount of tokens that the AI agent may generate when creating its response */
|
|
456
|
+
max_tokens?: number;
|
|
457
|
+
/** Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
458
|
+
temperature?: number | SWMLVar;
|
|
459
|
+
/** Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
460
|
+
top_p?: number | SWMLVar;
|
|
461
|
+
/** Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. */
|
|
462
|
+
confidence?: number | SWMLVar;
|
|
463
|
+
/** Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. */
|
|
464
|
+
presence_penalty?: number | SWMLVar;
|
|
465
|
+
/** Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. */
|
|
466
|
+
frequency_penalty?: number | SWMLVar;
|
|
467
|
+
/** The instructions to send to the agent. */
|
|
468
|
+
text?: string;
|
|
469
|
+
/** An object that defines the context steps for the AI. The context steps are used to define the flow of the conversation. */
|
|
470
|
+
contexts?: ContextsUpdate;
|
|
471
|
+
}
|
|
472
|
+
export type AIPromptUpdate = AIPromptTextUpdate | AIPromptPomUpdate;
|
|
473
|
+
export type Action = SWMLAction | ChangeContextAction | ChangeStepAction | ContextSwitchAction | HangupAction | HoldAction | PlaybackBGAction | SayAction | SetGlobalDataAction | SetMetaDataAction | StopAction | StopPlaybackBGAction | ToggleFunctionsAction | UnsetGlobalDataAction | UnsetMetaDataAction | UserInputAction;
|
|
474
|
+
export type AddressChannel = AudioChannel | MessagingChannel | VideoChannel;
|
|
475
|
+
export interface AllOfProperty {
|
|
476
|
+
/** An array of schemas where all of the schemas must be valid. */
|
|
477
|
+
allOf: SchemaType[];
|
|
478
|
+
}
|
|
479
|
+
export interface AmazonBedrock {
|
|
480
|
+
/** Creates a new Bedrock AI Agent */
|
|
481
|
+
amazon_bedrock: AmazonBedrockObject;
|
|
482
|
+
}
|
|
483
|
+
export interface AmazonBedrockObject {
|
|
484
|
+
/** A powerful and flexible environmental variable which can accept arbitrary data that is set initially in the SWML script */
|
|
485
|
+
global_data?: Record<string, Record<string, unknown>>;
|
|
486
|
+
/** A JSON object containing parameters as key-value pairs. */
|
|
487
|
+
params?: BedrockParams;
|
|
488
|
+
/** The final set of instructions and configuration settings to send to the agent. */
|
|
489
|
+
post_prompt?: BedrockPostPrompt;
|
|
490
|
+
/** The URL to which to send status callbacks and reports. Authentication can also be set in the url in the format of `username:password@url`. */
|
|
491
|
+
post_prompt_url?: string;
|
|
492
|
+
/** Establishes the initial set of instructions and settings to configure the agent. */
|
|
493
|
+
prompt: BedrockPrompt;
|
|
494
|
+
/** An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue. */
|
|
495
|
+
SWAIG?: BedrockSWAIG;
|
|
496
|
+
}
|
|
497
|
+
export interface Answer {
|
|
498
|
+
/** Answer incoming call and set an optional maximum duration. */
|
|
499
|
+
answer: {
|
|
500
|
+
/** Maximum duration in seconds for the call. Defaults to `14400` seconds (4 hours). */
|
|
501
|
+
max_duration?: number | SWMLVar;
|
|
502
|
+
/** Comma-separated string of codecs to offer. Valid codecs are: PCMU, PCMA, G722, G729, AMR-WB, OPUS, VP8, H264. */
|
|
503
|
+
codecs?: string;
|
|
504
|
+
/** Username to use for SIP authentication. */
|
|
505
|
+
username?: string;
|
|
506
|
+
/** Password to use for SIP authentication. */
|
|
507
|
+
password?: string;
|
|
508
|
+
};
|
|
509
|
+
}
|
|
510
|
+
export interface AnyOfProperty {
|
|
511
|
+
/** An array of schemas where at least one of the schemas must be valid. */
|
|
512
|
+
anyOf: SchemaType[];
|
|
513
|
+
}
|
|
514
|
+
/** Base interface for all property types */
|
|
515
|
+
export interface ArrayProperty {
|
|
516
|
+
/** A description of the property. */
|
|
517
|
+
description?: string;
|
|
518
|
+
/** Whether the property can be null. */
|
|
519
|
+
nullable?: boolean | SWMLVar;
|
|
520
|
+
/** The type of parameter(s) the AI is passing to the function. */
|
|
521
|
+
type: 'array';
|
|
522
|
+
/** The default array value */
|
|
523
|
+
default?: Record<string, unknown>[];
|
|
524
|
+
/** Schema for array items */
|
|
525
|
+
items: SchemaType;
|
|
526
|
+
}
|
|
527
|
+
export type AttentionTimeout = number;
|
|
528
|
+
export interface AudioChannel {
|
|
529
|
+
/** Audio Channel of Fabric Address */
|
|
530
|
+
audio: string;
|
|
531
|
+
}
|
|
532
|
+
export interface BedrockParams {
|
|
533
|
+
/** Amount of time, in ms, to wait before prompting the user to respond. Allowed values from `10,000` - `600,000`. Set to `0` to disable. **Default:** `5000` ms (note: user-configurable values must be `0` or within the `10,000` - `600,000` range). */
|
|
534
|
+
attention_timeout?: AttentionTimeout | 0 | SWMLVar;
|
|
535
|
+
/** Specifies the maximum duration fopr the AI Agent to remain active before it exists the session. */
|
|
536
|
+
hard_stop_time?: string | SWMLVar;
|
|
537
|
+
/** Amount of time, in ms, to wait before exiting the app due to inactivity. Allowed values from `10,000` - `3,600,000`. **Default:** `600000` ms (10 minutes). */
|
|
538
|
+
inactivity_timeout?: number | SWMLVar;
|
|
539
|
+
/** URL of a video file to play when AI is listening to the user speak. Only works for calls that support video. */
|
|
540
|
+
video_listening_file?: string;
|
|
541
|
+
/** URL of a video file to play when AI is idle. Only works for calls that support video. */
|
|
542
|
+
video_idle_file?: string;
|
|
543
|
+
/** URL of a video file to play when AI is talking. Only works for calls that support video. */
|
|
544
|
+
video_talking_file?: string;
|
|
545
|
+
/** A final prompt that is fed into the AI when the `hard_stop_time` is reached. */
|
|
546
|
+
hard_stop_prompt?: string;
|
|
547
|
+
[key: string]: Record<string, unknown> | AttentionTimeout | 0 | SWMLVar | string | SWMLVar | number | SWMLVar | string | undefined;
|
|
548
|
+
}
|
|
549
|
+
export type BedrockPostPrompt = {
|
|
550
|
+
/** Limits the amount of tokens that the AI agent may generate when creating its response */
|
|
551
|
+
max_tokens?: number;
|
|
552
|
+
/** Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
553
|
+
temperature?: number | SWMLVar;
|
|
554
|
+
/** Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
555
|
+
top_p?: number | SWMLVar;
|
|
556
|
+
/** Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. */
|
|
557
|
+
confidence?: number | SWMLVar;
|
|
558
|
+
/** Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. */
|
|
559
|
+
presence_penalty?: number | SWMLVar;
|
|
560
|
+
/** Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. */
|
|
561
|
+
frequency_penalty?: number | SWMLVar;
|
|
562
|
+
/** The instructions to send to the agent. */
|
|
563
|
+
text: string;
|
|
564
|
+
} | {
|
|
565
|
+
/** Limits the amount of tokens that the AI agent may generate when creating its response */
|
|
566
|
+
max_tokens?: number;
|
|
567
|
+
/** Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
568
|
+
temperature?: number | SWMLVar;
|
|
569
|
+
/** Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
570
|
+
top_p?: number | SWMLVar;
|
|
571
|
+
/** Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. */
|
|
572
|
+
confidence?: number | SWMLVar;
|
|
573
|
+
/** Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. */
|
|
574
|
+
presence_penalty?: number | SWMLVar;
|
|
575
|
+
/** Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. */
|
|
576
|
+
frequency_penalty?: number | SWMLVar;
|
|
577
|
+
/** The instructions to send to the agent. */
|
|
578
|
+
pom: POM[];
|
|
579
|
+
};
|
|
580
|
+
export type BedrockPrompt = {
|
|
581
|
+
voice_id?: 'tiffany' | 'matthew' | 'amy' | 'lupe' | 'carlos';
|
|
582
|
+
/** Limits the amount of tokens that the AI agent may generate when creating its response */
|
|
583
|
+
max_tokens?: number;
|
|
584
|
+
/** Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
585
|
+
temperature?: number | SWMLVar;
|
|
586
|
+
/** Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
587
|
+
top_p?: number | SWMLVar;
|
|
588
|
+
/** Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. */
|
|
589
|
+
confidence?: number | SWMLVar;
|
|
590
|
+
/** Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. */
|
|
591
|
+
presence_penalty?: number | SWMLVar;
|
|
592
|
+
/** Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. */
|
|
593
|
+
frequency_penalty?: number | SWMLVar;
|
|
594
|
+
/** The instructions to send to the agent. */
|
|
595
|
+
text: string;
|
|
596
|
+
} | {
|
|
597
|
+
voice_id?: 'tiffany' | 'matthew' | 'amy' | 'lupe' | 'carlos';
|
|
598
|
+
/** Limits the amount of tokens that the AI agent may generate when creating its response */
|
|
599
|
+
max_tokens?: number;
|
|
600
|
+
/** Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
601
|
+
temperature?: number | SWMLVar;
|
|
602
|
+
/** Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. */
|
|
603
|
+
top_p?: number | SWMLVar;
|
|
604
|
+
/** Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. */
|
|
605
|
+
confidence?: number | SWMLVar;
|
|
606
|
+
/** Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. */
|
|
607
|
+
presence_penalty?: number | SWMLVar;
|
|
608
|
+
/** Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. */
|
|
609
|
+
frequency_penalty?: number | SWMLVar;
|
|
610
|
+
/** The instructions to send to the agent. */
|
|
611
|
+
pom: POM[];
|
|
612
|
+
};
|
|
613
|
+
export interface BedrockSWAIG {
|
|
614
|
+
/** An array of JSON objects to define functions that can be executed during the interaction with the Bedrock AI. Default is not set. */
|
|
615
|
+
functions?: BedrockSWAIGFunction[];
|
|
616
|
+
/** Default settings for all SWAIG functions. If `defaults` is not set, settings may be set in each function object. Default is not set. */
|
|
617
|
+
defaults?: SWAIGDefaults;
|
|
618
|
+
/** Prebuilt functions the AI agent is able to call from this list of available native functions */
|
|
619
|
+
native_functions?: SWAIGNativeFunction[];
|
|
620
|
+
/** An array of objects to include remote function signatures. */
|
|
621
|
+
includes?: SWAIGIncludes[];
|
|
622
|
+
}
|
|
623
|
+
export type BedrockSWAIGFunction = {
|
|
624
|
+
/** A description of the context and purpose of the function, to explain to the agent when to use it. */
|
|
625
|
+
description: string;
|
|
626
|
+
/** A JSON object that defines the expected user input parameters and their validation rules for the function. */
|
|
627
|
+
parameters?: FunctionParameters;
|
|
628
|
+
/** Whether the function is active. **Default:** `true`. */
|
|
629
|
+
active?: boolean | SWMLVar;
|
|
630
|
+
/** A powerful and flexible environmental variable which can accept arbitrary data that is set initially in the SWML script or from the SWML set_meta_data action. */
|
|
631
|
+
meta_data?: Record<string, Record<string, unknown>>;
|
|
632
|
+
/** Scoping token for meta_data. If not supplied, metadata will be scoped to function's `web_hook_url`. Default is set by SignalWire. */
|
|
633
|
+
meta_data_token?: string;
|
|
634
|
+
/** An object that processes function inputs and executes operations through expressions, webhooks, or direct output. */
|
|
635
|
+
data_map?: DataMap;
|
|
636
|
+
/** Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` */
|
|
637
|
+
web_hook_url?: string;
|
|
638
|
+
/** A unique name for the function. This can be any user-defined string or can reference a reserved function. Reserved functions are SignalWire functions that will be executed at certain points in the conversation. */
|
|
639
|
+
function: string;
|
|
640
|
+
} | {
|
|
641
|
+
/** A description of the context and purpose of the function, to explain to the agent when to use it. */
|
|
642
|
+
description: string;
|
|
643
|
+
/** A JSON object that defines the expected user input parameters and their validation rules for the function. */
|
|
644
|
+
parameters?: FunctionParameters;
|
|
645
|
+
/** Whether the function is active. **Default:** `true`. */
|
|
646
|
+
active?: boolean | SWMLVar;
|
|
647
|
+
/** A powerful and flexible environmental variable which can accept arbitrary data that is set initially in the SWML script or from the SWML set_meta_data action. */
|
|
648
|
+
meta_data?: Record<string, Record<string, unknown>>;
|
|
649
|
+
/** Scoping token for meta_data. If not supplied, metadata will be scoped to function's `web_hook_url`. Default is set by SignalWire. */
|
|
650
|
+
meta_data_token?: string;
|
|
651
|
+
/** An object that processes function inputs and executes operations through expressions, webhooks, or direct output. */
|
|
652
|
+
data_map?: DataMap;
|
|
653
|
+
/** Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` */
|
|
654
|
+
web_hook_url?: string;
|
|
655
|
+
/** A unique name for the function. This can be any user-defined string or can reference a reserved function. Reserved functions are SignalWire functions that will be executed at certain points in the conversation. For the start_hook function, the function name is 'start_hook'. */
|
|
656
|
+
function: 'startup_hook';
|
|
657
|
+
} | {
|
|
658
|
+
/** A description of the context and purpose of the function, to explain to the agent when to use it. */
|
|
659
|
+
description: string;
|
|
660
|
+
/** A JSON object that defines the expected user input parameters and their validation rules for the function. */
|
|
661
|
+
parameters?: FunctionParameters;
|
|
662
|
+
/** Whether the function is active. **Default:** `true`. */
|
|
663
|
+
active?: boolean | SWMLVar;
|
|
664
|
+
/** A powerful and flexible environmental variable which can accept arbitrary data that is set initially in the SWML script or from the SWML set_meta_data action. */
|
|
665
|
+
meta_data?: Record<string, Record<string, unknown>>;
|
|
666
|
+
/** Scoping token for meta_data. If not supplied, metadata will be scoped to function's `web_hook_url`. Default is set by SignalWire. */
|
|
667
|
+
meta_data_token?: string;
|
|
668
|
+
/** An object that processes function inputs and executes operations through expressions, webhooks, or direct output. */
|
|
669
|
+
data_map?: DataMap;
|
|
670
|
+
/** Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` */
|
|
671
|
+
web_hook_url?: string;
|
|
672
|
+
/** A unique name for the function. This can be any user-defined string or can reference a reserved function. Reserved functions are SignalWire functions that will be executed at certain points in the conversation. For the stop_hook function, the function name is 'stop_hook'. */
|
|
673
|
+
function: 'hangup_hook';
|
|
674
|
+
} | {
|
|
675
|
+
/** A description of the context and purpose of the function, to explain to the agent when to use it. */
|
|
676
|
+
description: string;
|
|
677
|
+
/** A JSON object that defines the expected user input parameters and their validation rules for the function. */
|
|
678
|
+
parameters?: FunctionParameters;
|
|
679
|
+
/** Whether the function is active. **Default:** `true`. */
|
|
680
|
+
active?: boolean | SWMLVar;
|
|
681
|
+
/** A powerful and flexible environmental variable which can accept arbitrary data that is set initially in the SWML script or from the SWML set_meta_data action. */
|
|
682
|
+
meta_data?: Record<string, Record<string, unknown>>;
|
|
683
|
+
/** Scoping token for meta_data. If not supplied, metadata will be scoped to function's `web_hook_url`. Default is set by SignalWire. */
|
|
684
|
+
meta_data_token?: string;
|
|
685
|
+
/** An object that processes function inputs and executes operations through expressions, webhooks, or direct output. */
|
|
686
|
+
data_map?: DataMap;
|
|
687
|
+
/** Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` */
|
|
688
|
+
web_hook_url?: string;
|
|
689
|
+
/** A unique name for the function. This can be any user-defined string or can reference a reserved function. Reserved functions are SignalWire functions that will be executed at certain points in the conversation.. For the summarize_conversation function, the function name is 'summarize_conversation'. */
|
|
690
|
+
function: 'summarize_conversation';
|
|
691
|
+
};
|
|
692
|
+
/** Base interface for all property types */
|
|
693
|
+
export interface BooleanProperty {
|
|
694
|
+
/** A description of the property. */
|
|
695
|
+
description?: string;
|
|
696
|
+
/** Whether the property can be null. */
|
|
697
|
+
nullable?: boolean | SWMLVar;
|
|
698
|
+
/** The type of parameter(s) the AI is passing to the function. */
|
|
699
|
+
type: 'boolean';
|
|
700
|
+
/** The default boolean value */
|
|
701
|
+
default?: boolean | SWMLVar;
|
|
702
|
+
}
|
|
703
|
+
export interface CXMLScript {
|
|
704
|
+
/** Unique ID of a cXML Script. */
|
|
705
|
+
id: uuid;
|
|
706
|
+
/** The cXML script contents */
|
|
707
|
+
contents: string;
|
|
708
|
+
/** The amout of times the cXML script has been requested */
|
|
709
|
+
request_count: number;
|
|
710
|
+
/** The date and time when the cXML script was last accessed */
|
|
711
|
+
last_accessed_at: string | null;
|
|
712
|
+
/** The URL where the cXML script can be accessed */
|
|
713
|
+
request_url: string;
|
|
714
|
+
/** The script type the cXML Script is used for */
|
|
715
|
+
script_type: 'calling' | 'messaging';
|
|
716
|
+
/** Display name of the cXML Script Fabric Resource */
|
|
717
|
+
display_name: string;
|
|
718
|
+
/** The url that will send status updates for the cXML Script */
|
|
719
|
+
status_callback_url?: string | null;
|
|
720
|
+
/** HTTP method for status callback URL */
|
|
721
|
+
status_callback_method?: 'GET' | 'POST';
|
|
722
|
+
}
|
|
723
|
+
export interface CXMLScriptAddressListResponse {
|
|
724
|
+
/** An array of objects that contain a list of cXML Script Addresses */
|
|
725
|
+
data: FabricAddressApp[];
|
|
726
|
+
/** Object containing pagination links */
|
|
727
|
+
links: CXMLScriptAddressPaginationResponse;
|
|
728
|
+
}
|
|
729
|
+
export interface CXMLScriptAddressPaginationResponse {
|
|
730
|
+
/** Link of the current page */
|
|
731
|
+
self: string;
|
|
732
|
+
/** Link to the first page */
|
|
733
|
+
first: string;
|
|
734
|
+
/** Link to the next page */
|
|
735
|
+
next?: string;
|
|
736
|
+
/** Link to the previous page */
|
|
737
|
+
prev?: string;
|
|
738
|
+
}
|
|
739
|
+
export interface CXMLScriptCreateRequest {
|
|
740
|
+
/** Display name of the cXML Script */
|
|
741
|
+
display_name: string;
|
|
742
|
+
/** The cXML script contents */
|
|
743
|
+
contents: string;
|
|
744
|
+
/** URL to send status callbacks to */
|
|
745
|
+
status_callback_url?: string;
|
|
746
|
+
/** HTTP method to use for status callbacks */
|
|
747
|
+
status_callback_method?: 'GET' | 'POST';
|
|
748
|
+
}
|
|
749
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
750
|
+
export interface CXMLScriptCreateStatusCode422 {
|
|
751
|
+
/** List of validation errors. */
|
|
752
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
753
|
+
}
|
|
754
|
+
export interface CXMLScriptListResponse {
|
|
755
|
+
/** An array of objects containing a list of cXML Script data */
|
|
756
|
+
data: CXMLScriptResponse[];
|
|
757
|
+
/** Object containing pagination links */
|
|
758
|
+
links: CXMLScriptAddressPaginationResponse;
|
|
759
|
+
}
|
|
760
|
+
export interface CXMLScriptResponse {
|
|
761
|
+
/** Unique ID of the cXML Script. */
|
|
762
|
+
id: uuid;
|
|
763
|
+
/** Unique ID of the Project. */
|
|
764
|
+
project_id: uuid;
|
|
765
|
+
/** Display name of the cXML Script Fabric Resource */
|
|
766
|
+
name: string;
|
|
767
|
+
/** Type of the Fabric Resource */
|
|
768
|
+
type: 'cxml_script';
|
|
769
|
+
/** Date and time when the resource was created. */
|
|
770
|
+
created_at: string;
|
|
771
|
+
/** Date and time when the resource was updated. */
|
|
772
|
+
updated_at: string;
|
|
773
|
+
/** cXML Script data. */
|
|
774
|
+
cxml_script: CXMLScript;
|
|
775
|
+
}
|
|
776
|
+
export interface CXMLScriptUpdateRequest {
|
|
777
|
+
/** Display name of the cXML Script */
|
|
778
|
+
display_name?: string;
|
|
779
|
+
/** The cXML script contents */
|
|
780
|
+
contents?: string;
|
|
781
|
+
/** URL to send status callbacks to */
|
|
782
|
+
status_callback_url?: string;
|
|
783
|
+
/** HTTP method to use for status callbacks */
|
|
784
|
+
status_callback_method?: 'GET' | 'POST';
|
|
785
|
+
}
|
|
786
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
787
|
+
export interface CXMLScriptUpdateStatusCode422 {
|
|
788
|
+
/** List of validation errors. */
|
|
789
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
790
|
+
}
|
|
791
|
+
export interface CXMLWebhook {
|
|
792
|
+
/** Unique ID of the CXML Webhook. */
|
|
793
|
+
id: uuid;
|
|
794
|
+
/** Name of the CXML Webhook. */
|
|
795
|
+
name: string;
|
|
796
|
+
/** Used for of the CXML Webhook. */
|
|
797
|
+
used_for: UsedForType;
|
|
798
|
+
/** Primary request url of the CXML Webhook. */
|
|
799
|
+
primary_request_url: string;
|
|
800
|
+
/** Primary request method of the CXML Webhook. */
|
|
801
|
+
primary_request_method: 'GET' | 'POST';
|
|
802
|
+
/** Fallback request url of the CXML Webhook. */
|
|
803
|
+
fallback_request_url: string | null;
|
|
804
|
+
/** Fallback request method of the CXML Webhook. */
|
|
805
|
+
fallback_request_method: 'GET' | 'POST';
|
|
806
|
+
/** Status callback url of the CXML Webhook. */
|
|
807
|
+
status_callback_url: string | null;
|
|
808
|
+
/** Status callback method of the CXML Webhook. */
|
|
809
|
+
status_callback_method: 'GET' | 'POST';
|
|
810
|
+
}
|
|
811
|
+
export interface CXMLWebhookAddressListResponse {
|
|
812
|
+
data: FabricAddressApp[];
|
|
813
|
+
links: CXMLWebhookAddressPaginationResponse;
|
|
814
|
+
}
|
|
815
|
+
export interface CXMLWebhookAddressPaginationResponse {
|
|
816
|
+
/** Link of the current page */
|
|
817
|
+
self: string;
|
|
818
|
+
/** Link to the first page */
|
|
819
|
+
first: string;
|
|
820
|
+
/** Link to the next page */
|
|
821
|
+
next: string;
|
|
822
|
+
/** Link to the previous page */
|
|
823
|
+
prev?: string;
|
|
824
|
+
}
|
|
825
|
+
export interface CXMLWebhookCreateRequest {
|
|
826
|
+
/** Name of the CXML Webhook. */
|
|
827
|
+
name?: string;
|
|
828
|
+
/** Used for of the CXML Webhook. */
|
|
829
|
+
used_for?: UsedForType;
|
|
830
|
+
/** Primary request url of the CXML Webhook. */
|
|
831
|
+
primary_request_url: string;
|
|
832
|
+
/** Primary request method of the CXML Webhook. */
|
|
833
|
+
primary_request_method?: 'GET' | 'POST';
|
|
834
|
+
/** Fallback request url of the CXML Webhook. */
|
|
835
|
+
fallback_request_url?: string;
|
|
836
|
+
/** Fallback request method of the CXML Webhook. */
|
|
837
|
+
fallback_request_method?: 'GET' | 'POST';
|
|
838
|
+
/** Status callback url of the CXML Webhook. */
|
|
839
|
+
status_callback_url?: string;
|
|
840
|
+
/** Status callback method of the CXML Webhook. */
|
|
841
|
+
status_callback_method?: 'GET' | 'POST';
|
|
842
|
+
}
|
|
843
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
844
|
+
export interface CXMLWebhookCreateStatusCode422 {
|
|
845
|
+
/** List of validation errors. */
|
|
846
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
847
|
+
}
|
|
848
|
+
export interface CXMLWebhookListResponse {
|
|
849
|
+
/** An array of objects containing a list of cXML Webhook data */
|
|
850
|
+
data: CXMLWebhookResponse[];
|
|
851
|
+
/** Object containing pagination links */
|
|
852
|
+
links: CXMLWebhookPaginationResponse;
|
|
853
|
+
}
|
|
854
|
+
export interface CXMLWebhookPaginationResponse {
|
|
855
|
+
/** Link of the current page */
|
|
856
|
+
self: string;
|
|
857
|
+
/** Link to the first page */
|
|
858
|
+
first: string;
|
|
859
|
+
/** Link to the next page */
|
|
860
|
+
next: string;
|
|
861
|
+
/** Link to the previous page */
|
|
862
|
+
prev?: string;
|
|
863
|
+
}
|
|
864
|
+
export interface CXMLWebhookResponse {
|
|
865
|
+
/** Unique ID of the CXMLWebhook. */
|
|
866
|
+
id: uuid;
|
|
867
|
+
/** Unique ID of the Project. */
|
|
868
|
+
project_id: uuid;
|
|
869
|
+
/** Display name of the CXMLWebhook Fabric Resource */
|
|
870
|
+
display_name: string;
|
|
871
|
+
/** Type of the Fabric Resource */
|
|
872
|
+
type: 'cxml_webhook';
|
|
873
|
+
/** Date and time when the resource was created. */
|
|
874
|
+
created_at: string;
|
|
875
|
+
/** Date and time when the resource was updated. */
|
|
876
|
+
updated_at: string;
|
|
877
|
+
/** CXMLWebhook data. */
|
|
878
|
+
cxml_webhook: CXMLWebhook;
|
|
879
|
+
}
|
|
880
|
+
export interface CXMLWebhookUpdateRequest {
|
|
881
|
+
/** Name of the CXML Webhook. */
|
|
882
|
+
name?: string;
|
|
883
|
+
/** Used for of the CXML Webhook. */
|
|
884
|
+
used_for?: UsedForType;
|
|
885
|
+
/** Primary request url of the CXML Webhook. */
|
|
886
|
+
primary_request_url?: string;
|
|
887
|
+
/** Primary request method of the CXML Webhook. */
|
|
888
|
+
primary_request_method?: 'GET' | 'POST';
|
|
889
|
+
/** Fallback request url of the CXML Webhook. */
|
|
890
|
+
fallback_request_url?: string;
|
|
891
|
+
/** Fallback request method of the CXML Webhook. */
|
|
892
|
+
fallback_request_method?: 'GET' | 'POST';
|
|
893
|
+
/** Status callback url of the CXML Webhook. */
|
|
894
|
+
status_callback_url?: string;
|
|
895
|
+
/** Status callback method of the CXML Webhook. */
|
|
896
|
+
status_callback_method?: 'GET' | 'POST';
|
|
897
|
+
}
|
|
898
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
899
|
+
export interface CXMLWebhookUpdateStatusCode422 {
|
|
900
|
+
/** List of validation errors. */
|
|
901
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
902
|
+
}
|
|
903
|
+
export interface CallFlow {
|
|
904
|
+
/** Unique ID of a Call Flow. */
|
|
905
|
+
id: uuid;
|
|
906
|
+
/** The name of the Call Flow */
|
|
907
|
+
title: string;
|
|
908
|
+
/** Call flow data as JSON string */
|
|
909
|
+
flow_data?: string;
|
|
910
|
+
/** A SWML document. For more information on SWML, please go to the [SWML docs](/swml) */
|
|
911
|
+
relayml?: string;
|
|
912
|
+
/** The current revision of the call flow. Every update must increase this number. */
|
|
913
|
+
document_version?: number;
|
|
914
|
+
}
|
|
915
|
+
export interface CallFlowAddressListResponse {
|
|
916
|
+
/** An array of objects containing a list of Call Flow Addresses */
|
|
917
|
+
data: FabricAddressApp[];
|
|
918
|
+
/** Object containing pagination links */
|
|
919
|
+
links: CallFlowAddressPaginationResponse;
|
|
920
|
+
}
|
|
921
|
+
export interface CallFlowAddressPaginationResponse {
|
|
922
|
+
/** Link of the current page */
|
|
923
|
+
self: string;
|
|
924
|
+
/** Link to the first page */
|
|
925
|
+
first: string;
|
|
926
|
+
/** Link to the next page */
|
|
927
|
+
next?: string;
|
|
928
|
+
/** Link to the previous page */
|
|
929
|
+
prev?: string;
|
|
930
|
+
}
|
|
931
|
+
export interface CallFlowCreateRequest {
|
|
932
|
+
/** The name of the Call Flow */
|
|
933
|
+
title: string;
|
|
934
|
+
}
|
|
935
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
936
|
+
export interface CallFlowCreateStatusCode422 {
|
|
937
|
+
/** List of validation errors. */
|
|
938
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
939
|
+
}
|
|
940
|
+
export interface CallFlowListResponse {
|
|
941
|
+
/** Object containing pagination links */
|
|
942
|
+
links: CallFlowAddressPaginationResponse;
|
|
943
|
+
/** An array of objects containing the CallFlow listing response */
|
|
944
|
+
data: CallFlowResponse[];
|
|
945
|
+
}
|
|
946
|
+
export interface CallFlowResponse {
|
|
947
|
+
/** Unique ID of the Call Flow. */
|
|
948
|
+
id: uuid;
|
|
949
|
+
/** Unique ID of the Project. */
|
|
950
|
+
project_id: uuid;
|
|
951
|
+
/** Display name of the Call Flow Fabric Resource */
|
|
952
|
+
display_name: string;
|
|
953
|
+
/** Type of the Fabric Resource */
|
|
954
|
+
type: 'call_flow';
|
|
955
|
+
/** Date and time when the resource was created. */
|
|
956
|
+
created_at: string;
|
|
957
|
+
/** Date and time when the resource was updated. */
|
|
958
|
+
updated_at: string;
|
|
959
|
+
/** Call Flow data. */
|
|
960
|
+
call_flow: CallFlow;
|
|
961
|
+
}
|
|
962
|
+
export interface CallFlowUpdateRequest {
|
|
963
|
+
/** The name of the Call Flow */
|
|
964
|
+
title?: string;
|
|
965
|
+
/** The current revision of the call flow. Every update must increase this number. */
|
|
966
|
+
document_version?: number;
|
|
967
|
+
}
|
|
968
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
969
|
+
export interface CallFlowUpdateStatusCode422 {
|
|
970
|
+
/** List of validation errors. */
|
|
971
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
972
|
+
}
|
|
973
|
+
export interface CallFlowVersion {
|
|
974
|
+
/** The unique identifier of the version. */
|
|
975
|
+
id: uuid;
|
|
976
|
+
/** The version number. */
|
|
977
|
+
version: string;
|
|
978
|
+
/** The creation timestamp. */
|
|
979
|
+
created_at: string;
|
|
980
|
+
/** The last update timestamp. */
|
|
981
|
+
updated_at: string;
|
|
982
|
+
/** Call Flow data structure */
|
|
983
|
+
flow_data?: string;
|
|
984
|
+
/** SWML document for this version */
|
|
985
|
+
relayml?: string;
|
|
986
|
+
}
|
|
987
|
+
export interface CallFlowVersionDeployByDocumentVersion {
|
|
988
|
+
/** The current revision of the call flow. */
|
|
989
|
+
document_version: number;
|
|
990
|
+
}
|
|
991
|
+
export interface CallFlowVersionDeployByVersionId {
|
|
992
|
+
/** Any call flow version ID for this call flow. */
|
|
993
|
+
call_flow_version_id: uuid;
|
|
994
|
+
}
|
|
995
|
+
export type CallFlowVersionDeployRequest = CallFlowVersionDeployByDocumentVersion | CallFlowVersionDeployByVersionId;
|
|
996
|
+
export interface CallFlowVersionDeployResponse {
|
|
997
|
+
/** The unique identifier of the deployed Call Flow Version. */
|
|
998
|
+
id: uuid;
|
|
999
|
+
/** The creation timestamp. */
|
|
1000
|
+
created_at: string;
|
|
1001
|
+
/** The last update timestamp. */
|
|
1002
|
+
updated_at: string;
|
|
1003
|
+
/** The document version. */
|
|
1004
|
+
document_version: number;
|
|
1005
|
+
/** Call Flow data structure */
|
|
1006
|
+
flow_data?: string;
|
|
1007
|
+
/** SWML document for this version */
|
|
1008
|
+
relayml?: string;
|
|
1009
|
+
}
|
|
1010
|
+
export interface CallFlowVersionListResponse {
|
|
1011
|
+
/** List of Call Flow Versions */
|
|
1012
|
+
data: CallFlowVersion[];
|
|
1013
|
+
links: CallFlowVersionsPaginationResponse;
|
|
1014
|
+
}
|
|
1015
|
+
export interface CallFlowVersionsPaginationResponse {
|
|
1016
|
+
/** Link of the current page */
|
|
1017
|
+
self: string;
|
|
1018
|
+
/** Link to the first page */
|
|
1019
|
+
first: string;
|
|
1020
|
+
/** Link to the next page */
|
|
1021
|
+
next: string;
|
|
1022
|
+
/** Link to the previous page */
|
|
1023
|
+
prev?: string;
|
|
1024
|
+
}
|
|
1025
|
+
export type CallHandlerType = 'default' | 'passthrough' | 'block-pstn' | 'resource';
|
|
1026
|
+
export type CallStatus = 'created' | 'ringing' | 'answered' | 'ended';
|
|
1027
|
+
export interface ChangeContextAction {
|
|
1028
|
+
/** The name of the context to switch to. The context must be defined in the AI's prompt.contexts configuration. */
|
|
1029
|
+
change_context: string;
|
|
1030
|
+
}
|
|
1031
|
+
export interface ChangeStepAction {
|
|
1032
|
+
/** The name of the step to switch to. The step must be defined in the current context's steps array. */
|
|
1033
|
+
change_step: string;
|
|
1034
|
+
}
|
|
1035
|
+
export type Ciphers = 'AEAD_AES_256_GCM_8' | 'AES_256_CM_HMAC_SHA1_80' | 'AES_CM_128_HMAC_SHA1_80' | 'AES_256_CM_HMAC_SHA1_32' | 'AES_CM_128_HMAC_SHA1_32';
|
|
1036
|
+
export type Codecs = 'PCMU' | 'PCMA' | 'G722' | 'G729' | 'OPUS' | 'VP8' | 'H264';
|
|
1037
|
+
export interface Cond {
|
|
1038
|
+
/** Execute a sequence of instructions depending on the value of a JavaScript condition. */
|
|
1039
|
+
cond: CondParams[];
|
|
1040
|
+
}
|
|
1041
|
+
export interface CondElse {
|
|
1042
|
+
/** Sequence of SWML methods to execute when none of the other conditions evaluate to true. */
|
|
1043
|
+
else: SWMLMethod[];
|
|
1044
|
+
}
|
|
1045
|
+
export type CondParams = CondReg | CondElse;
|
|
1046
|
+
export interface CondReg {
|
|
1047
|
+
/** The JavaScript condition to act on. */
|
|
1048
|
+
when: string;
|
|
1049
|
+
/** Sequence of SWML methods to execute when the condition evaluates to true. */
|
|
1050
|
+
then: SWMLMethod[];
|
|
1051
|
+
/** Sequence of SWML methods to execute when none of the other conditions evaluate to true. */
|
|
1052
|
+
else?: SWMLMethod[];
|
|
1053
|
+
}
|
|
1054
|
+
export interface ConferenceRoom {
|
|
1055
|
+
/** The unique id of the Conference Room */
|
|
1056
|
+
id: uuid;
|
|
1057
|
+
/** The name of the Conference Room */
|
|
1058
|
+
name: string;
|
|
1059
|
+
/** The descrption of the Conference Room */
|
|
1060
|
+
description: string;
|
|
1061
|
+
/** Display name of the Conference Room */
|
|
1062
|
+
display_name: string;
|
|
1063
|
+
/** Maximum number of members allowed in the conference room */
|
|
1064
|
+
max_members: number;
|
|
1065
|
+
/** The viudeo quality of the Conference Room. */
|
|
1066
|
+
quality: '1080p' | '720p';
|
|
1067
|
+
/** The frames-per-second (fps) of the participants videos in the conference. */
|
|
1068
|
+
fps: 30 | 20;
|
|
1069
|
+
/** The time users are allowed to start joining the conference. Joining before this time will result in failure to join the conference. */
|
|
1070
|
+
join_from: string | null;
|
|
1071
|
+
/** The time users are allowed to until the conference is locked. Attempting to join the conference after the set time will result in failure to join the conference. */
|
|
1072
|
+
join_until: string | null;
|
|
1073
|
+
/** The time to remove all participants from the conference. */
|
|
1074
|
+
remove_at: string | null;
|
|
1075
|
+
/** The amount of time in seconds to remove a particpant from a conference after they join. */
|
|
1076
|
+
remove_after_seconds_elapsed: number | null;
|
|
1077
|
+
/** The video layout of the conference. */
|
|
1078
|
+
layout: Layout;
|
|
1079
|
+
/** Starts recording when the conference starts. */
|
|
1080
|
+
record_on_start: boolean;
|
|
1081
|
+
/** Plays a tone when a participant joins or leaves the conference. */
|
|
1082
|
+
tone_on_entry_and_exit: boolean;
|
|
1083
|
+
/** Turns the conference video off when the participant joins the room if `true`. */
|
|
1084
|
+
room_join_video_off: boolean;
|
|
1085
|
+
/** Turns the participants video off when the participant joins the room if `true`. */
|
|
1086
|
+
user_join_video_off: boolean;
|
|
1087
|
+
/** Enables live video room previews for the conference. */
|
|
1088
|
+
enable_room_previews: boolean;
|
|
1089
|
+
/** Syncs the participants audio and video. */
|
|
1090
|
+
sync_audio_video: boolean | null;
|
|
1091
|
+
/** Metadata of the conference. */
|
|
1092
|
+
meta: Record<string, Record<string, unknown>>;
|
|
1093
|
+
/** Indicator if the Conference Room will prioritize showing participants utilizing the hand raised feature. */
|
|
1094
|
+
prioritize_handraise: boolean;
|
|
1095
|
+
}
|
|
1096
|
+
export interface ConferenceRoomAddressListResponse {
|
|
1097
|
+
/** An array of objects containing list of Conference Room Addresses */
|
|
1098
|
+
data: FabricAddressRoom[];
|
|
1099
|
+
/** Object containing pagination links */
|
|
1100
|
+
links: ConferenceRoomAddressPaginationResponse;
|
|
1101
|
+
}
|
|
1102
|
+
export interface ConferenceRoomAddressPaginationResponse {
|
|
1103
|
+
/** Link of the current page */
|
|
1104
|
+
self: string;
|
|
1105
|
+
/** Link to the first page */
|
|
1106
|
+
first: string;
|
|
1107
|
+
/** Link to the next page */
|
|
1108
|
+
next?: string;
|
|
1109
|
+
/** Link to the previous page */
|
|
1110
|
+
prev?: string;
|
|
1111
|
+
}
|
|
1112
|
+
export interface ConferenceRoomCreateRequest {
|
|
1113
|
+
/** The name of the Conference Room */
|
|
1114
|
+
name: string;
|
|
1115
|
+
/** Display name of the Conference Room */
|
|
1116
|
+
display_name?: string;
|
|
1117
|
+
/** The descrption of the Conference Room */
|
|
1118
|
+
description?: string;
|
|
1119
|
+
/** The time users are allowed to start joining the conference. Joining before this time will result in failure to join the conference. */
|
|
1120
|
+
join_from?: string;
|
|
1121
|
+
/** The time users are allowed to until the conference is locked. Attempting to join the conference after the set time will result in failure to join the conference. */
|
|
1122
|
+
join_until?: string;
|
|
1123
|
+
/** Maximum number of members allowed in the conference room */
|
|
1124
|
+
max_members?: number;
|
|
1125
|
+
/** The viudeo quality of the Conference Room. */
|
|
1126
|
+
quality?: '1080p' | '720p';
|
|
1127
|
+
/** The time to remove all participants from the conference. */
|
|
1128
|
+
remove_at?: string;
|
|
1129
|
+
/** The amount of time in seconds to remove a particpant from a conference after they join. */
|
|
1130
|
+
remove_after_seconds_elapsed?: number;
|
|
1131
|
+
/** The video layout of the conference. */
|
|
1132
|
+
layout?: Layout;
|
|
1133
|
+
/** Starts recording when the conference starts. */
|
|
1134
|
+
record_on_start?: boolean;
|
|
1135
|
+
/** Enables live video room previews for the conference. */
|
|
1136
|
+
enable_room_previews: boolean;
|
|
1137
|
+
/** Metadata of the conference. */
|
|
1138
|
+
meta?: Record<string, Record<string, unknown>>;
|
|
1139
|
+
/** Syncs the participants audio and video. */
|
|
1140
|
+
sync_audio_video?: boolean;
|
|
1141
|
+
/** Plays a tone when a participant joins or leaves the conference. */
|
|
1142
|
+
tone_on_entry_and_exit?: boolean;
|
|
1143
|
+
/** Turns the conference video off when the participant joins the room if `true`. */
|
|
1144
|
+
room_join_video_off?: boolean;
|
|
1145
|
+
/** Turns the participants video off when the participant joins the room if `true`. */
|
|
1146
|
+
user_join_video_off?: boolean;
|
|
1147
|
+
}
|
|
1148
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
1149
|
+
export interface ConferenceRoomCreateStatusCode422 {
|
|
1150
|
+
/** List of validation errors. */
|
|
1151
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
1152
|
+
}
|
|
1153
|
+
export interface ConferenceRoomListResponse {
|
|
1154
|
+
/** Object containing pagination links */
|
|
1155
|
+
links: ConferenceRoomAddressPaginationResponse;
|
|
1156
|
+
/** An array of objects containing the Conference Room data */
|
|
1157
|
+
data: ConferenceRoomResponse[];
|
|
1158
|
+
}
|
|
1159
|
+
export interface ConferenceRoomResponse {
|
|
1160
|
+
/** Unique ID of the Conference Room. */
|
|
1161
|
+
id: uuid;
|
|
1162
|
+
/** Unique ID of the Project. */
|
|
1163
|
+
project_id: uuid;
|
|
1164
|
+
/** Display name of the Conference Room Fabric Resource */
|
|
1165
|
+
display_name: string;
|
|
1166
|
+
/** Type of the Fabric Resource */
|
|
1167
|
+
type: 'video_room';
|
|
1168
|
+
/** Date and time when the resource was created. */
|
|
1169
|
+
created_at: string;
|
|
1170
|
+
/** Date and time when the resource was updated. */
|
|
1171
|
+
updated_at: string;
|
|
1172
|
+
/** Conference Room data. */
|
|
1173
|
+
conference_room: ConferenceRoom;
|
|
1174
|
+
}
|
|
1175
|
+
export interface ConferenceRoomUpdateRequest {
|
|
1176
|
+
/** The name of the Conference Room */
|
|
1177
|
+
name?: string;
|
|
1178
|
+
/** Display name of the Conference Room */
|
|
1179
|
+
display_name?: string;
|
|
1180
|
+
/** The descrption of the Conference Room */
|
|
1181
|
+
description?: string;
|
|
1182
|
+
/** The time users are allowed to start joining the conference. Joining before this time will result in failure to join the conference. */
|
|
1183
|
+
join_from?: string;
|
|
1184
|
+
/** The time users are allowed to until the conference is locked. Attempting to join the conference after the set time will result in failure to join the conference. */
|
|
1185
|
+
join_until?: string;
|
|
1186
|
+
/** Maximum number of members allowed in the conference room */
|
|
1187
|
+
max_members?: number;
|
|
1188
|
+
/** The viudeo quality of the Conference Room. */
|
|
1189
|
+
quality?: '1080p' | '720p';
|
|
1190
|
+
/** The time to remove all participants from the conference. */
|
|
1191
|
+
remove_at?: string;
|
|
1192
|
+
/** The amount of time in seconds to remove a particpant from a conference after they join. */
|
|
1193
|
+
remove_after_seconds_elapsed?: number;
|
|
1194
|
+
/** The video layout of the conference. */
|
|
1195
|
+
layout?: Layout;
|
|
1196
|
+
/** Starts recording when the conference starts. */
|
|
1197
|
+
record_on_start?: boolean;
|
|
1198
|
+
/** Enables live video room previews for the conference. */
|
|
1199
|
+
enable_room_previews: boolean;
|
|
1200
|
+
/** Metadata of the conference. */
|
|
1201
|
+
meta?: Record<string, Record<string, unknown>>;
|
|
1202
|
+
/** Syncs the participants audio and video. */
|
|
1203
|
+
sync_audio_video: boolean;
|
|
1204
|
+
/** Plays a tone when a participant joins or leaves the conference. */
|
|
1205
|
+
tone_on_entry_and_exit?: boolean;
|
|
1206
|
+
/** Turns the conference video off when the participant joins the room if `true`. */
|
|
1207
|
+
room_join_video_off?: boolean;
|
|
1208
|
+
/** Turns the participants video off when the participant joins the room if `true`. */
|
|
1209
|
+
user_join_video_off?: boolean;
|
|
1210
|
+
}
|
|
1211
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
1212
|
+
export interface ConferenceRoomUpdateStatusCode422 {
|
|
1213
|
+
/** List of validation errors. */
|
|
1214
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
1215
|
+
}
|
|
1216
|
+
export interface Connect {
|
|
1217
|
+
/** Connect to a phone number, SIP URI, Call Fabric resource, queue, or WebSocket stream. */
|
|
1218
|
+
connect: ConnectDeviceSingle | ConnectDeviceSerial | ConnectDeviceParallel | ConnectDeviceSerialParallel;
|
|
1219
|
+
}
|
|
1220
|
+
export interface ConnectDeviceParallel {
|
|
1221
|
+
/** The caller ID to use when dialing the number. */
|
|
1222
|
+
from?: string;
|
|
1223
|
+
/** Custom SIP headers to add to INVITE. It Has no effect on calls to phone numbers. */
|
|
1224
|
+
headers?: ConnectHeaders[];
|
|
1225
|
+
/** Comma-separated string of codecs to offer. */
|
|
1226
|
+
codecs?: string;
|
|
1227
|
+
/** If true, WebRTC media is offered to the SIP endpoint. */
|
|
1228
|
+
webrtc_media?: boolean | SWMLVar;
|
|
1229
|
+
/** Time, in seconds, to set the SIP `Session-Expires` header in INVITE. */
|
|
1230
|
+
session_timeout?: number | SWMLVar;
|
|
1231
|
+
/** Array of URIs to play as ringback tone. If not specified, plays audio from the provider. */
|
|
1232
|
+
ringback?: string[];
|
|
1233
|
+
/** Action to take based on the result of the call. This will run once the peer leg of the call has ended. */
|
|
1234
|
+
result?: ConnectSwitch | CondParams[];
|
|
1235
|
+
/** Time, in seconds, to wait for the call to be answered. */
|
|
1236
|
+
timeout?: number | SWMLVar;
|
|
1237
|
+
/** Maximum duration, in seconds, allowed for the call. */
|
|
1238
|
+
max_duration?: number | SWMLVar;
|
|
1239
|
+
/** Delay answer until the B-leg answers. */
|
|
1240
|
+
answer_on_bridge?: boolean | SWMLVar;
|
|
1241
|
+
/** Confirmation to execute when the call is connected. Can be either: */
|
|
1242
|
+
confirm?: string | ValidConfirmMethods[];
|
|
1243
|
+
/** The amount of time, in seconds, to wait for the `confirm` URL to return a response */
|
|
1244
|
+
confirm_timeout?: number | SWMLVar;
|
|
1245
|
+
/** SIP username to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers. */
|
|
1246
|
+
username?: string;
|
|
1247
|
+
/** SIP password to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers. */
|
|
1248
|
+
password?: string;
|
|
1249
|
+
/** Encryption setting to use. **Possible values:** `mandatory`, `optional`, `forbidden` */
|
|
1250
|
+
encryption?: 'mandatory' | 'optional' | 'forbidden';
|
|
1251
|
+
/** Webhook URL to send call status change notifications to. Authentication can also be set in the URL in the format of `username:password@url`. */
|
|
1252
|
+
call_state_url?: string;
|
|
1253
|
+
/** SWML to execute after the bridge completes. This defines what should happen after the call is connected and the bridge ends. */
|
|
1254
|
+
transfer_after_bridge?: string | SWMLVar;
|
|
1255
|
+
/** An array of call state event names to be notified about. */
|
|
1256
|
+
call_state_events?: CallStatus[];
|
|
1257
|
+
/** HTTP or HTTPS URL to deliver connect status events. */
|
|
1258
|
+
status_url?: string;
|
|
1259
|
+
/** Array of destinations to dial simultaneously. */
|
|
1260
|
+
parallel: ConnectDeviceSingle[];
|
|
1261
|
+
}
|
|
1262
|
+
export interface ConnectDeviceSerial {
|
|
1263
|
+
/** The caller ID to use when dialing the number. */
|
|
1264
|
+
from?: string;
|
|
1265
|
+
/** Custom SIP headers to add to INVITE. It Has no effect on calls to phone numbers. */
|
|
1266
|
+
headers?: ConnectHeaders[];
|
|
1267
|
+
/** Comma-separated string of codecs to offer. */
|
|
1268
|
+
codecs?: string;
|
|
1269
|
+
/** If true, WebRTC media is offered to the SIP endpoint. */
|
|
1270
|
+
webrtc_media?: boolean | SWMLVar;
|
|
1271
|
+
/** Time, in seconds, to set the SIP `Session-Expires` header in INVITE. */
|
|
1272
|
+
session_timeout?: number | SWMLVar;
|
|
1273
|
+
/** Array of URIs to play as ringback tone. If not specified, plays audio from the provider. */
|
|
1274
|
+
ringback?: string[];
|
|
1275
|
+
/** Action to take based on the result of the call. This will run once the peer leg of the call has ended. */
|
|
1276
|
+
result?: ConnectSwitch | CondParams[];
|
|
1277
|
+
/** Time, in seconds, to wait for the call to be answered. */
|
|
1278
|
+
timeout?: number | SWMLVar;
|
|
1279
|
+
/** Maximum duration, in seconds, allowed for the call. */
|
|
1280
|
+
max_duration?: number | SWMLVar;
|
|
1281
|
+
/** Delay answer until the B-leg answers. */
|
|
1282
|
+
answer_on_bridge?: boolean | SWMLVar;
|
|
1283
|
+
/** Confirmation to execute when the call is connected. Can be either: */
|
|
1284
|
+
confirm?: string | ValidConfirmMethods[];
|
|
1285
|
+
/** The amount of time, in seconds, to wait for the `confirm` URL to return a response */
|
|
1286
|
+
confirm_timeout?: number | SWMLVar;
|
|
1287
|
+
/** SIP username to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers. */
|
|
1288
|
+
username?: string;
|
|
1289
|
+
/** SIP password to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers. */
|
|
1290
|
+
password?: string;
|
|
1291
|
+
/** Encryption setting to use. **Possible values:** `mandatory`, `optional`, `forbidden` */
|
|
1292
|
+
encryption?: 'mandatory' | 'optional' | 'forbidden';
|
|
1293
|
+
/** Webhook URL to send call status change notifications to. Authentication can also be set in the URL in the format of `username:password@url`. */
|
|
1294
|
+
call_state_url?: string;
|
|
1295
|
+
/** SWML to execute after the bridge completes. This defines what should happen after the call is connected and the bridge ends. */
|
|
1296
|
+
transfer_after_bridge?: string | SWMLVar;
|
|
1297
|
+
/** An array of call state event names to be notified about. */
|
|
1298
|
+
call_state_events?: CallStatus[];
|
|
1299
|
+
/** HTTP or HTTPS URL to deliver connect status events. */
|
|
1300
|
+
status_url?: string;
|
|
1301
|
+
serial: ConnectDeviceSingle[];
|
|
1302
|
+
}
|
|
1303
|
+
export interface ConnectDeviceSerialParallel {
|
|
1304
|
+
/** The caller ID to use when dialing the number. */
|
|
1305
|
+
from?: string;
|
|
1306
|
+
/** Custom SIP headers to add to INVITE. It Has no effect on calls to phone numbers. */
|
|
1307
|
+
headers?: ConnectHeaders[];
|
|
1308
|
+
/** Comma-separated string of codecs to offer. */
|
|
1309
|
+
codecs?: string;
|
|
1310
|
+
/** If true, WebRTC media is offered to the SIP endpoint. */
|
|
1311
|
+
webrtc_media?: boolean | SWMLVar;
|
|
1312
|
+
/** Time, in seconds, to set the SIP `Session-Expires` header in INVITE. */
|
|
1313
|
+
session_timeout?: number | SWMLVar;
|
|
1314
|
+
/** Array of URIs to play as ringback tone. If not specified, plays audio from the provider. */
|
|
1315
|
+
ringback?: string[];
|
|
1316
|
+
/** Action to take based on the result of the call. This will run once the peer leg of the call has ended. */
|
|
1317
|
+
result?: ConnectSwitch | CondParams[];
|
|
1318
|
+
/** Time, in seconds, to wait for the call to be answered. */
|
|
1319
|
+
timeout?: number | SWMLVar;
|
|
1320
|
+
/** Maximum duration, in seconds, allowed for the call. */
|
|
1321
|
+
max_duration?: number | SWMLVar;
|
|
1322
|
+
/** Delay answer until the B-leg answers. */
|
|
1323
|
+
answer_on_bridge?: boolean | SWMLVar;
|
|
1324
|
+
/** Confirmation to execute when the call is connected. Can be either: */
|
|
1325
|
+
confirm?: string | ValidConfirmMethods[];
|
|
1326
|
+
/** The amount of time, in seconds, to wait for the `confirm` URL to return a response */
|
|
1327
|
+
confirm_timeout?: number | SWMLVar;
|
|
1328
|
+
/** SIP username to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers. */
|
|
1329
|
+
username?: string;
|
|
1330
|
+
/** SIP password to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers. */
|
|
1331
|
+
password?: string;
|
|
1332
|
+
/** Encryption setting to use. **Possible values:** `mandatory`, `optional`, `forbidden` */
|
|
1333
|
+
encryption?: 'mandatory' | 'optional' | 'forbidden';
|
|
1334
|
+
/** Webhook URL to send call status change notifications to. Authentication can also be set in the URL in the format of `username:password@url`. */
|
|
1335
|
+
call_state_url?: string;
|
|
1336
|
+
/** SWML to execute after the bridge completes. This defines what should happen after the call is connected and the bridge ends. */
|
|
1337
|
+
transfer_after_bridge?: string | SWMLVar;
|
|
1338
|
+
/** An array of call state event names to be notified about. */
|
|
1339
|
+
call_state_events?: CallStatus[];
|
|
1340
|
+
/** HTTP or HTTPS URL to deliver connect status events. */
|
|
1341
|
+
status_url?: string;
|
|
1342
|
+
/** Array of arrays. */
|
|
1343
|
+
serial_parallel: ConnectDeviceSingle[][];
|
|
1344
|
+
}
|
|
1345
|
+
export interface ConnectDeviceSingle {
|
|
1346
|
+
/** The caller ID to use when dialing the number. */
|
|
1347
|
+
from?: string;
|
|
1348
|
+
/** Custom SIP headers to add to INVITE. It Has no effect on calls to phone numbers. */
|
|
1349
|
+
headers?: ConnectHeaders[];
|
|
1350
|
+
/** Comma-separated string of codecs to offer. */
|
|
1351
|
+
codecs?: string;
|
|
1352
|
+
/** If true, WebRTC media is offered to the SIP endpoint. */
|
|
1353
|
+
webrtc_media?: boolean | SWMLVar;
|
|
1354
|
+
/** Time, in seconds, to set the SIP `Session-Expires` header in INVITE. */
|
|
1355
|
+
session_timeout?: number | SWMLVar;
|
|
1356
|
+
/** Array of URIs to play as ringback tone. If not specified, plays audio from the provider. */
|
|
1357
|
+
ringback?: string[];
|
|
1358
|
+
/** Action to take based on the result of the call. This will run once the peer leg of the call has ended. */
|
|
1359
|
+
result?: ConnectSwitch | CondParams[];
|
|
1360
|
+
/** Time, in seconds, to wait for the call to be answered. */
|
|
1361
|
+
timeout?: number | SWMLVar;
|
|
1362
|
+
/** Maximum duration, in seconds, allowed for the call. */
|
|
1363
|
+
max_duration?: number | SWMLVar;
|
|
1364
|
+
/** Delay answer until the B-leg answers. */
|
|
1365
|
+
answer_on_bridge?: boolean | SWMLVar;
|
|
1366
|
+
/** Confirmation to execute when the call is connected. Can be either: */
|
|
1367
|
+
confirm?: string | ValidConfirmMethods[];
|
|
1368
|
+
/** The amount of time, in seconds, to wait for the `confirm` URL to return a response */
|
|
1369
|
+
confirm_timeout?: number | SWMLVar;
|
|
1370
|
+
/** SIP username to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers. */
|
|
1371
|
+
username?: string;
|
|
1372
|
+
/** SIP password to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers. */
|
|
1373
|
+
password?: string;
|
|
1374
|
+
/** Encryption setting to use. **Possible values:** `mandatory`, `optional`, `forbidden` */
|
|
1375
|
+
encryption?: 'mandatory' | 'optional' | 'forbidden';
|
|
1376
|
+
/** Webhook URL to send call status change notifications to. Authentication can also be set in the URL in the format of `username:password@url`. */
|
|
1377
|
+
call_state_url?: string;
|
|
1378
|
+
/** SWML to execute after the bridge completes. This defines what should happen after the call is connected and the bridge ends. */
|
|
1379
|
+
transfer_after_bridge?: string | SWMLVar;
|
|
1380
|
+
/** An array of call state event names to be notified about. */
|
|
1381
|
+
call_state_events?: CallStatus[];
|
|
1382
|
+
/** HTTP or HTTPS URL to deliver connect status events. */
|
|
1383
|
+
status_url?: string;
|
|
1384
|
+
/** Destination to dial. Can be: */
|
|
1385
|
+
to: string;
|
|
1386
|
+
/** Stream name identifier. Only applies to stream destinations. */
|
|
1387
|
+
name?: string;
|
|
1388
|
+
/** Audio codec for the stream. Supported values: `PCMU`, `PCMA`, `G722`, `L16`. */
|
|
1389
|
+
codec?: string;
|
|
1390
|
+
/** Enable realtime mode for bidirectional audio. */
|
|
1391
|
+
realtime?: boolean | SWMLVar;
|
|
1392
|
+
/** HTTP method for the stream status webhook. */
|
|
1393
|
+
status_url_method?: 'GET' | 'POST';
|
|
1394
|
+
/** Bearer token sent as an `Authorization` header during the WebSocket handshake. Only applies to stream destinations. */
|
|
1395
|
+
authorization_bearer_token?: string;
|
|
1396
|
+
/** Custom key-value pairs sent in the WebSocket start message. Only applies to stream destinations. */
|
|
1397
|
+
custom_parameters?: Record<string, string>;
|
|
1398
|
+
}
|
|
1399
|
+
export interface ConnectHeaders {
|
|
1400
|
+
/** The name of the header. */
|
|
1401
|
+
name: string;
|
|
1402
|
+
/** The value of the header. */
|
|
1403
|
+
value: string;
|
|
1404
|
+
}
|
|
1405
|
+
export interface ConnectSwitch {
|
|
1406
|
+
/** Name of the variable whose value needs to be compared. If not provided, it will check the `connect_result` variable. */
|
|
1407
|
+
variable?: string;
|
|
1408
|
+
/** Object of values mapped to array of instructions to execute */
|
|
1409
|
+
case: Record<string, SWMLMethod[]>;
|
|
1410
|
+
/** Array of instructions to execute if no cases match */
|
|
1411
|
+
default?: SWMLMethod[];
|
|
1412
|
+
}
|
|
1413
|
+
export interface ConstProperty {
|
|
1414
|
+
/** A constant value that can be passed to the function. */
|
|
1415
|
+
const: Record<string, unknown>;
|
|
1416
|
+
}
|
|
1417
|
+
export interface ContextPOMSteps {
|
|
1418
|
+
/** The name of the step. The name must be unique within the context. The name is used for referencing the step in the context. */
|
|
1419
|
+
name: string;
|
|
1420
|
+
/** The criteria that must be met for the AI to proceed to the next step. */
|
|
1421
|
+
step_criteria?: string;
|
|
1422
|
+
/** An array of strings, where each string is the name of a SWAIG.function that can be executed from this step. */
|
|
1423
|
+
functions?: string[];
|
|
1424
|
+
/** An array of context names that the AI can transition to from this step. This must be a valid `contexts.name` that is present in your `contexts` object. */
|
|
1425
|
+
valid_contexts?: string[];
|
|
1426
|
+
/** A boolean value, if set to `true`, will skip the user's turn to respond in the conversation and proceed to the next step. **Default:** `false`. */
|
|
1427
|
+
skip_user_turn?: boolean | SWMLVar;
|
|
1428
|
+
/** A boolean value that determines if the step is the last in the context. If `true`, the context ends after this step. Cannot be used along with the `valid_steps` parameter. **Default:** `false`. */
|
|
1429
|
+
end?: boolean;
|
|
1430
|
+
/** An array of valid steps that the conversation can proceed to from this step. */
|
|
1431
|
+
valid_steps?: string[];
|
|
1432
|
+
/** An array of objects that define the POM for the step. POM is the Post-Prompt Object Model, which is used to define the flow of the conversation. */
|
|
1433
|
+
pom: POM[];
|
|
1434
|
+
}
|
|
1435
|
+
export type ContextSteps = ContextPOMSteps | ContextTextSteps;
|
|
1436
|
+
export interface ContextSwitchAction {
|
|
1437
|
+
/** A JSON object containing the context to switch to. Default is not set. */
|
|
1438
|
+
context_switch: {
|
|
1439
|
+
/** The instructions to send to the agent. Default is not set. */
|
|
1440
|
+
system_prompt: string;
|
|
1441
|
+
/** Whether to consolidate the context. Default is `false`. */
|
|
1442
|
+
consolidate?: boolean | SWMLVar;
|
|
1443
|
+
/** A string serving as simulated user input for the AI Agent. */
|
|
1444
|
+
user_prompt?: string;
|
|
1445
|
+
};
|
|
1446
|
+
}
|
|
1447
|
+
export interface ContextTextSteps {
|
|
1448
|
+
/** The name of the step. The name must be unique within the context. The name is used for referencing the step in the context. */
|
|
1449
|
+
name: string;
|
|
1450
|
+
/** The criteria that must be met for the AI to proceed to the next step. */
|
|
1451
|
+
step_criteria?: string;
|
|
1452
|
+
/** An array of strings, where each string is the name of a SWAIG.function that can be executed from this step. */
|
|
1453
|
+
functions?: string[];
|
|
1454
|
+
/** An array of context names that the AI can transition to from this step. This must be a valid `contexts.name` that is present in your `contexts` object. */
|
|
1455
|
+
valid_contexts?: string[];
|
|
1456
|
+
/** A boolean value, if set to `true`, will skip the user's turn to respond in the conversation and proceed to the next step. **Default:** `false`. */
|
|
1457
|
+
skip_user_turn?: boolean | SWMLVar;
|
|
1458
|
+
/** A boolean value that determines if the step is the last in the context. If `true`, the context ends after this step. Cannot be used along with the `valid_steps` parameter. **Default:** `false`. */
|
|
1459
|
+
end?: boolean;
|
|
1460
|
+
/** An array of valid steps that the conversation can proceed to from this step. */
|
|
1461
|
+
valid_steps?: string[];
|
|
1462
|
+
/** The prompt or instructions given to the AI at this step. */
|
|
1463
|
+
text: string;
|
|
1464
|
+
}
|
|
1465
|
+
export interface Contexts {
|
|
1466
|
+
/** The default context to use at the beginning of the conversation. Additional context steps can be defined as any other key in the object. */
|
|
1467
|
+
default: ContextsObject;
|
|
1468
|
+
[key: string]: ContextsObject;
|
|
1469
|
+
}
|
|
1470
|
+
export type ContextsObject = ContextsPOMObject | ContextsTextObject;
|
|
1471
|
+
export type ContextsObjectUpdate = ContextsPOMObjectUpdate | ContextsTextObjectUpdate;
|
|
1472
|
+
export interface ContextsPOMObject {
|
|
1473
|
+
/** An array of step objects that define the conversation flow for this context. Steps execute sequentially unless otherwise specified. */
|
|
1474
|
+
steps: ContextSteps[];
|
|
1475
|
+
/** When `true`, resets conversation history to only the system prompt when entering this context. Useful for focused tasks that shouldn't be influenced by previous conversation. **Default:** `false`. */
|
|
1476
|
+
isolated?: boolean;
|
|
1477
|
+
/** Language-specific filler phrases played when transitioning into this context. Helps provide smooth context switches. */
|
|
1478
|
+
enter_fillers?: FunctionFillers[];
|
|
1479
|
+
/** Language-specific filler phrases played when leaving this context. Ensures natural transitions out of specialized modes. */
|
|
1480
|
+
exit_fillers?: FunctionFillers[];
|
|
1481
|
+
/** An array of objects that define the POM for the context. POM is the Post-Prompt Object Model, which is used to define the flow of the conversation. */
|
|
1482
|
+
pom?: POM[];
|
|
1483
|
+
}
|
|
1484
|
+
export interface ContextsPOMObjectUpdate {
|
|
1485
|
+
/** An array of step objects that define the conversation flow for this context. Steps execute sequentially unless otherwise specified. */
|
|
1486
|
+
steps?: ContextSteps[];
|
|
1487
|
+
/** When `true`, resets conversation history to only the system prompt when entering this context. Useful for focused tasks that shouldn't be influenced by previous conversation. **Default:** `false`. */
|
|
1488
|
+
isolated?: boolean;
|
|
1489
|
+
/** Language-specific filler phrases played when transitioning into this context. Helps provide smooth context switches. */
|
|
1490
|
+
enter_fillers?: FunctionFillers[];
|
|
1491
|
+
/** Language-specific filler phrases played when leaving this context. Ensures natural transitions out of specialized modes. */
|
|
1492
|
+
exit_fillers?: FunctionFillers[];
|
|
1493
|
+
/** An array of objects that define the POM for the context. POM is the Post-Prompt Object Model, which is used to define the flow of the conversation. */
|
|
1494
|
+
pom?: POM[];
|
|
1495
|
+
}
|
|
1496
|
+
export interface ContextsTextObject {
|
|
1497
|
+
/** An array of step objects that define the conversation flow for this context. Steps execute sequentially unless otherwise specified. */
|
|
1498
|
+
steps: ContextSteps[];
|
|
1499
|
+
/** When `true`, resets conversation history to only the system prompt when entering this context. Useful for focused tasks that shouldn't be influenced by previous conversation. **Default:** `false`. */
|
|
1500
|
+
isolated?: boolean;
|
|
1501
|
+
/** Language-specific filler phrases played when transitioning into this context. Helps provide smooth context switches. */
|
|
1502
|
+
enter_fillers?: FunctionFillers[];
|
|
1503
|
+
/** Language-specific filler phrases played when leaving this context. Ensures natural transitions out of specialized modes. */
|
|
1504
|
+
exit_fillers?: FunctionFillers[];
|
|
1505
|
+
/** The text to send to the agent. */
|
|
1506
|
+
text?: string;
|
|
1507
|
+
}
|
|
1508
|
+
export interface ContextsTextObjectUpdate {
|
|
1509
|
+
/** An array of step objects that define the conversation flow for this context. Steps execute sequentially unless otherwise specified. */
|
|
1510
|
+
steps?: ContextSteps[];
|
|
1511
|
+
/** When `true`, resets conversation history to only the system prompt when entering this context. Useful for focused tasks that shouldn't be influenced by previous conversation. **Default:** `false`. */
|
|
1512
|
+
isolated?: boolean;
|
|
1513
|
+
/** Language-specific filler phrases played when transitioning into this context. Helps provide smooth context switches. */
|
|
1514
|
+
enter_fillers?: FunctionFillers[];
|
|
1515
|
+
/** Language-specific filler phrases played when leaving this context. Ensures natural transitions out of specialized modes. */
|
|
1516
|
+
exit_fillers?: FunctionFillers[];
|
|
1517
|
+
/** The text to send to the agent. */
|
|
1518
|
+
text?: string;
|
|
1519
|
+
}
|
|
1520
|
+
export interface ContextsUpdate {
|
|
1521
|
+
/** The default context to use at the beginning of the conversation. Additional context steps can be defined as any other key in the object. */
|
|
1522
|
+
default?: ContextsObjectUpdate;
|
|
1523
|
+
[key: string]: ContextsObjectUpdate | undefined;
|
|
1524
|
+
}
|
|
1525
|
+
/** A message object representing a single turn in the conversation history. */
|
|
1526
|
+
export interface ConversationMessage {
|
|
1527
|
+
/** The role of the message sender. */
|
|
1528
|
+
role: ConversationRole;
|
|
1529
|
+
/** The text content of the message. */
|
|
1530
|
+
content: string;
|
|
1531
|
+
/** Optional language code for the message (e.g., 'en', 'es', 'fr'). */
|
|
1532
|
+
lang?: string;
|
|
1533
|
+
}
|
|
1534
|
+
export type ConversationRole = 'user' | 'assistant' | 'system';
|
|
1535
|
+
/** Custom translation filter with a prompt prefix. Use `prompt:` followed by your custom instructions (e.g., `prompt:Use formal business language`). */
|
|
1536
|
+
export type CustomTranslationFilter = string;
|
|
1537
|
+
export interface CxmlApplication {
|
|
1538
|
+
/** Unique ID of the cXML Application. */
|
|
1539
|
+
id: uuid;
|
|
1540
|
+
/** Project ID for the cXML Application */
|
|
1541
|
+
project_id: uuid;
|
|
1542
|
+
/** Display name of the cXML Application */
|
|
1543
|
+
friendly_name: string;
|
|
1544
|
+
/** URL to handle incoming calls */
|
|
1545
|
+
voice_url: string | null;
|
|
1546
|
+
/** HTTP method for voice URL */
|
|
1547
|
+
voice_method: 'GET' | 'POST';
|
|
1548
|
+
/** Fallback URL for voice errors */
|
|
1549
|
+
voice_fallback_url: string | null;
|
|
1550
|
+
/** HTTP method for voice fallback URL */
|
|
1551
|
+
voice_fallback_method: 'GET' | 'POST';
|
|
1552
|
+
/** URL to receive status callbacks */
|
|
1553
|
+
status_callback: string | null;
|
|
1554
|
+
/** HTTP method for status callbacks */
|
|
1555
|
+
status_callback_method: 'GET' | 'POST';
|
|
1556
|
+
/** URL to handle incoming messages */
|
|
1557
|
+
sms_url: string | null;
|
|
1558
|
+
/** HTTP method for SMS URL */
|
|
1559
|
+
sms_method: 'GET' | 'POST';
|
|
1560
|
+
/** Fallback URL for SMS errors */
|
|
1561
|
+
sms_fallback_url: string | null;
|
|
1562
|
+
/** HTTP method for SMS fallback URL */
|
|
1563
|
+
sms_fallback_method: 'GET' | 'POST';
|
|
1564
|
+
/** URL to receive SMS status callbacks */
|
|
1565
|
+
sms_status_callback: string | null;
|
|
1566
|
+
/** HTTP method for SMS status callbacks */
|
|
1567
|
+
sms_status_callback_method: 'GET' | 'POST';
|
|
1568
|
+
}
|
|
1569
|
+
export interface CxmlApplicationAddressListResponse {
|
|
1570
|
+
/** An array of objects that contain a list of Cxml Application Addresses */
|
|
1571
|
+
data: FabricAddress[];
|
|
1572
|
+
/** Object containing pagination links */
|
|
1573
|
+
links: CxmlApplicationAddressPaginationResponse;
|
|
1574
|
+
}
|
|
1575
|
+
export interface CxmlApplicationAddressPaginationResponse {
|
|
1576
|
+
/** Self link for the current page */
|
|
1577
|
+
self: string;
|
|
1578
|
+
/** Link to the first page of results */
|
|
1579
|
+
first: string;
|
|
1580
|
+
/** Link to the next page of results */
|
|
1581
|
+
next?: string;
|
|
1582
|
+
/** Link to the previous page of results */
|
|
1583
|
+
prev?: string;
|
|
1584
|
+
}
|
|
1585
|
+
export interface CxmlApplicationListResponse {
|
|
1586
|
+
/** An array of objects containing the list of cXML Application(s) data. */
|
|
1587
|
+
data: CxmlApplicationResponse[];
|
|
1588
|
+
/** Object containing pagination links */
|
|
1589
|
+
links: CxmlApplicationPaginationResponse;
|
|
1590
|
+
}
|
|
1591
|
+
export interface CxmlApplicationPaginationResponse {
|
|
1592
|
+
/** Linmk to the current page */
|
|
1593
|
+
self: string;
|
|
1594
|
+
/** Link to the first page */
|
|
1595
|
+
first: string;
|
|
1596
|
+
/** Link to the next page */
|
|
1597
|
+
next?: string;
|
|
1598
|
+
/** Link to the previous page */
|
|
1599
|
+
prev?: string;
|
|
1600
|
+
}
|
|
1601
|
+
export interface CxmlApplicationResponse {
|
|
1602
|
+
/** Unique ID of the cXML Application. */
|
|
1603
|
+
id: uuid;
|
|
1604
|
+
/** Unique ID of the Project. */
|
|
1605
|
+
project_id: uuid;
|
|
1606
|
+
/** Display name of the cXML Application Fabric Resource */
|
|
1607
|
+
display_name: string;
|
|
1608
|
+
/** Type of the Fabric Resource */
|
|
1609
|
+
type: 'cxml_application';
|
|
1610
|
+
/** Date and time when the resource was created. */
|
|
1611
|
+
created_at: string;
|
|
1612
|
+
/** Date and time when the resource was updated. */
|
|
1613
|
+
updated_at: string;
|
|
1614
|
+
/** cXML Application data. */
|
|
1615
|
+
cxml_application: CxmlApplication;
|
|
1616
|
+
}
|
|
1617
|
+
export interface CxmlApplicationUpdateRequest {
|
|
1618
|
+
/** Display name of the cXML Application */
|
|
1619
|
+
display_name?: string;
|
|
1620
|
+
/** Project ID for the cXML Application */
|
|
1621
|
+
account_sid?: uuid;
|
|
1622
|
+
/** URL to handle incoming calls */
|
|
1623
|
+
voice_url?: string;
|
|
1624
|
+
/** HTTP method for voice URL */
|
|
1625
|
+
voice_method?: 'GET' | 'POST';
|
|
1626
|
+
/** Fallback URL for voice errors */
|
|
1627
|
+
voice_fallback_url?: string;
|
|
1628
|
+
/** HTTP method for voice fallback URL */
|
|
1629
|
+
voice_fallback_method?: 'GET' | 'POST';
|
|
1630
|
+
/** URL to receive status callbacks */
|
|
1631
|
+
status_callback?: string;
|
|
1632
|
+
/** HTTP method for status callbacks */
|
|
1633
|
+
status_callback_method?: 'GET' | 'POST';
|
|
1634
|
+
/** URL to handle incoming messages */
|
|
1635
|
+
sms_url?: string;
|
|
1636
|
+
/** HTTP method for SMS URL */
|
|
1637
|
+
sms_method?: 'GET' | 'POST';
|
|
1638
|
+
/** Fallback URL for SMS errors */
|
|
1639
|
+
sms_fallback_url?: string;
|
|
1640
|
+
/** HTTP method for SMS fallback URL */
|
|
1641
|
+
sms_fallback_method?: 'GET' | 'POST';
|
|
1642
|
+
/** URL to receive SMS status callbacks */
|
|
1643
|
+
sms_status_callback?: string;
|
|
1644
|
+
/** HTTP method for SMS status callbacks */
|
|
1645
|
+
sms_status_callback_method?: 'GET' | 'POST';
|
|
1646
|
+
}
|
|
1647
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
1648
|
+
export interface CxmlApplicationUpdateStatusCode422 {
|
|
1649
|
+
/** List of validation errors. */
|
|
1650
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
1651
|
+
}
|
|
1652
|
+
export interface DataMap {
|
|
1653
|
+
/** An object that contains a response and a list of actions to be performed upon a SWAIG function call. */
|
|
1654
|
+
output?: Output;
|
|
1655
|
+
/** An array of objects that have pattern matching logic to process the user's input data. A user can define multiple expressions to match against the user's input data. */
|
|
1656
|
+
expressions?: Expression[];
|
|
1657
|
+
/** An array of objects that define external API calls. */
|
|
1658
|
+
webhooks?: Webhook[];
|
|
1659
|
+
}
|
|
1660
|
+
export interface Denoise {
|
|
1661
|
+
/** Start noise reduction. You can stop it at any time using `stop_denoise`. */
|
|
1662
|
+
denoise: Record<string, unknown>;
|
|
1663
|
+
}
|
|
1664
|
+
export interface DetectMachine {
|
|
1665
|
+
/** A detection method that combines AMD (Answering Machine Detection) and fax detection. */
|
|
1666
|
+
detect_machine: {
|
|
1667
|
+
/** If `true`, stops detection on beep / end of voicemail greeting. Default `false`. */
|
|
1668
|
+
detect_message_end?: boolean | SWMLVar;
|
|
1669
|
+
/** Comma-separated string of detectors to enable. Valid values: `amd`, `fax`. */
|
|
1670
|
+
detectors?: string;
|
|
1671
|
+
/** How long to wait for voice to finish. Default `1.0`. */
|
|
1672
|
+
end_silence_timeout?: number | SWMLVar;
|
|
1673
|
+
/** How long to wait for initial voice before giving up. Default `4.5`. */
|
|
1674
|
+
initial_timeout?: number | SWMLVar;
|
|
1675
|
+
/** How long to wait for voice to finish before firing READY event. Default is `end_silence_timeout`. */
|
|
1676
|
+
machine_ready_timeout?: number | SWMLVar;
|
|
1677
|
+
/** The number of seconds of ongoing voice activity required to classify as MACHINE. Default `1.25`. */
|
|
1678
|
+
machine_voice_threshold?: number | SWMLVar;
|
|
1679
|
+
/** The minimum number of words that must be detected in a single utterance before classifying the call as MACHINE. Default `6`. */
|
|
1680
|
+
machine_words_threshold?: number | SWMLVar;
|
|
1681
|
+
/** The http(s) URL to deliver detector events to. */
|
|
1682
|
+
status_url?: string;
|
|
1683
|
+
/** The max time to run detector. Default `30.0` seconds. */
|
|
1684
|
+
timeout?: number | SWMLVar;
|
|
1685
|
+
/** The tone to detect, will only receive remote side tone. Default `CED`. */
|
|
1686
|
+
tone?: 'CED' | 'CNG';
|
|
1687
|
+
/** If false, the detector will run asynchronously and status_url must be set. */
|
|
1688
|
+
wait?: boolean | SWMLVar;
|
|
1689
|
+
};
|
|
1690
|
+
}
|
|
1691
|
+
export interface DialogFlowPaginationResponse {
|
|
1692
|
+
/** Link to the current page */
|
|
1693
|
+
self: string;
|
|
1694
|
+
/** Link to the first page */
|
|
1695
|
+
first: string;
|
|
1696
|
+
/** Link to the next page */
|
|
1697
|
+
next?: string;
|
|
1698
|
+
/** Link to the previous page */
|
|
1699
|
+
prev?: string;
|
|
1700
|
+
}
|
|
1701
|
+
export interface DialogflowAgent {
|
|
1702
|
+
/** Unique ID of a Dialogflow Agent. */
|
|
1703
|
+
id: uuid;
|
|
1704
|
+
/** Whether to enable the 'say' feature */
|
|
1705
|
+
say_enabled?: boolean;
|
|
1706
|
+
/** Default message to say */
|
|
1707
|
+
say?: string;
|
|
1708
|
+
/** Voice to use for speech */
|
|
1709
|
+
voice?: string;
|
|
1710
|
+
/** Display name of the Dialogflow Agent */
|
|
1711
|
+
display_name?: string;
|
|
1712
|
+
/** Dialogflow reference ID */
|
|
1713
|
+
dialogflow_reference_id?: uuid;
|
|
1714
|
+
/** Dialogflow reference name */
|
|
1715
|
+
dialogflow_reference_name?: string;
|
|
1716
|
+
}
|
|
1717
|
+
export interface DialogflowAgentAddressListResponse {
|
|
1718
|
+
/** An array of objects that contain a list of Dialogflow Agent Addresses */
|
|
1719
|
+
data: FabricAddressApp[];
|
|
1720
|
+
/** Object containing pagination links */
|
|
1721
|
+
links: DialogflowAgentAddressPaginationResponse;
|
|
1722
|
+
}
|
|
1723
|
+
export interface DialogflowAgentAddressPaginationResponse {
|
|
1724
|
+
/** Link of the current page */
|
|
1725
|
+
self: string;
|
|
1726
|
+
/** Link to the first page */
|
|
1727
|
+
first: string;
|
|
1728
|
+
/** Link to the next page */
|
|
1729
|
+
next?: string;
|
|
1730
|
+
/** Link to the previous page */
|
|
1731
|
+
prev?: string;
|
|
1732
|
+
}
|
|
1733
|
+
export interface DialogflowAgentListResponse {
|
|
1734
|
+
/** An array of objects that contain a list of Dialogflow Agent data */
|
|
1735
|
+
data: DialogflowAgentResponse[];
|
|
1736
|
+
/** Object containing pagination links */
|
|
1737
|
+
links: DialogFlowPaginationResponse;
|
|
1738
|
+
}
|
|
1739
|
+
export interface DialogflowAgentResponse {
|
|
1740
|
+
/** Unique ID of the Dialogflow Agent. */
|
|
1741
|
+
id: uuid;
|
|
1742
|
+
/** Unique ID of the Project. */
|
|
1743
|
+
project_id: uuid;
|
|
1744
|
+
/** Display name of the Dialogflow Agent Fabric Resource */
|
|
1745
|
+
display_name: string;
|
|
1746
|
+
/** Type of the Fabric Resource */
|
|
1747
|
+
type: 'dialogflow_agent';
|
|
1748
|
+
/** Date and time when the resource was created. */
|
|
1749
|
+
created_at: string;
|
|
1750
|
+
/** Date and time when the resource was updated. */
|
|
1751
|
+
updated_at: string;
|
|
1752
|
+
/** Dialogflow Agent data. */
|
|
1753
|
+
dialogflow_agent: DialogflowAgent;
|
|
1754
|
+
}
|
|
1755
|
+
export interface DialogflowAgentUpdateRequest {
|
|
1756
|
+
/** Name of the Dialogflow Agent */
|
|
1757
|
+
name?: string;
|
|
1758
|
+
/** Whether to enable the 'say' feature */
|
|
1759
|
+
say_enabled?: boolean;
|
|
1760
|
+
/** Default message to say */
|
|
1761
|
+
say?: string;
|
|
1762
|
+
/** Voice to use for speech */
|
|
1763
|
+
voice?: string;
|
|
1764
|
+
}
|
|
1765
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
1766
|
+
export interface DialogflowAgentUpdateStatusCode422 {
|
|
1767
|
+
/** List of validation errors. */
|
|
1768
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
1769
|
+
}
|
|
1770
|
+
export type Direction = 'inbound' | 'outbound';
|
|
1771
|
+
/** DisplayTypes */
|
|
1772
|
+
export type DisplayTypes = 'app' | 'room' | 'call' | 'subscriber';
|
|
1773
|
+
export interface DomainApplicationAssignRequest {
|
|
1774
|
+
/** The id of the domain application you wish to assign a resource to. */
|
|
1775
|
+
domain_application_id: uuid;
|
|
1776
|
+
}
|
|
1777
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
1778
|
+
export interface DomainApplicationCreateStatusCode422 {
|
|
1779
|
+
/** List of validation errors. */
|
|
1780
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
1781
|
+
}
|
|
1782
|
+
export interface DomainApplicationResponse {
|
|
1783
|
+
/** Unique ID of the Fabric Address. */
|
|
1784
|
+
id: uuid;
|
|
1785
|
+
/** Name of the Fabric Address. */
|
|
1786
|
+
name: string;
|
|
1787
|
+
/** Display name of the Fabric Address. */
|
|
1788
|
+
display_name: string;
|
|
1789
|
+
/** Cover url of the Fabric Address. */
|
|
1790
|
+
cover_url: string;
|
|
1791
|
+
/** Preview url of the Fabric Address. */
|
|
1792
|
+
preview_url: string;
|
|
1793
|
+
/** Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls. */
|
|
1794
|
+
locked: boolean;
|
|
1795
|
+
/** Channels of the Fabric Address. */
|
|
1796
|
+
channels: AddressChannel;
|
|
1797
|
+
/** Fabric Address Creation Date. */
|
|
1798
|
+
created_at: string;
|
|
1799
|
+
/** The display type of a fabric address pointing to an application. */
|
|
1800
|
+
type: 'app';
|
|
1801
|
+
}
|
|
1802
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
1803
|
+
export interface EmbedTokenCreateStatusCode422 {
|
|
1804
|
+
/** List of validation errors. */
|
|
1805
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
1806
|
+
}
|
|
1807
|
+
export interface EmbedsTokensRequest {
|
|
1808
|
+
/** Click to Call Token */
|
|
1809
|
+
token: string;
|
|
1810
|
+
}
|
|
1811
|
+
export interface EmbedsTokensResponse {
|
|
1812
|
+
/** Encrypted guest token. */
|
|
1813
|
+
token: string;
|
|
1814
|
+
}
|
|
1815
|
+
export type Encryption = 'required' | 'optional' | 'default';
|
|
1816
|
+
export interface EnterQueue {
|
|
1817
|
+
/** Place the current call in a named queue where it will wait to be connected to an available agent or resource. */
|
|
1818
|
+
enter_queue: EnterQueueObject;
|
|
1819
|
+
}
|
|
1820
|
+
export interface EnterQueueObject {
|
|
1821
|
+
/** Name of the queue to enter. If a queue with this name does not exist, it will be automatically created. */
|
|
1822
|
+
queue_name: string;
|
|
1823
|
+
/** SWML to execute after the bridge completes. This defines what should happen after the call is connected to an agent and the bridge ends. */
|
|
1824
|
+
transfer_after_bridge: string | SWMLVar;
|
|
1825
|
+
/** HTTP or HTTPS URL to deliver queue status events. Default not set */
|
|
1826
|
+
status_url?: string;
|
|
1827
|
+
/** URL for media to play while waiting in the queue. Default hold music will be played if not set */
|
|
1828
|
+
wait_url?: string | SWMLVar;
|
|
1829
|
+
/** Maximum time in seconds to wait in the queue before timeout. Default `3600` */
|
|
1830
|
+
wait_time?: number | SWMLVar;
|
|
1831
|
+
}
|
|
1832
|
+
export interface Execute {
|
|
1833
|
+
/** Execute a specified section or URL as a subroutine, and upon completion, return to the current document. */
|
|
1834
|
+
execute: {
|
|
1835
|
+
/** Specifies what to execute. The value can be one of: */
|
|
1836
|
+
dest: string;
|
|
1837
|
+
/** Named parameters to send to section or URL */
|
|
1838
|
+
params?: Record<string, Record<string, unknown>>;
|
|
1839
|
+
/** User-defined metadata, ignored by SignalWire */
|
|
1840
|
+
meta?: Record<string, Record<string, unknown>>;
|
|
1841
|
+
/** The list of SWML instructions to be executed when the executed section or URL returns */
|
|
1842
|
+
on_return?: SWMLMethod[];
|
|
1843
|
+
/** Action to take based on the result of the call. This will run once the peer leg of the call has ended. */
|
|
1844
|
+
result?: ExecuteSwitch | CondParams[];
|
|
1845
|
+
};
|
|
1846
|
+
}
|
|
1847
|
+
export interface ExecuteSwitch {
|
|
1848
|
+
/** Name of the variable whose value needs to be compared. If not provided, it will check the `return_value` variable. */
|
|
1849
|
+
variable?: string;
|
|
1850
|
+
/** Object of values mapped to array of instructions to execute */
|
|
1851
|
+
case: Record<string, SWMLMethod[]>;
|
|
1852
|
+
/** Array of instructions to execute if no cases match */
|
|
1853
|
+
default?: SWMLMethod[];
|
|
1854
|
+
}
|
|
1855
|
+
export interface Expression {
|
|
1856
|
+
/** The actual input or value from the user or system. */
|
|
1857
|
+
string: string;
|
|
1858
|
+
/** A regular expression pattern to validate or match the string. */
|
|
1859
|
+
pattern: string;
|
|
1860
|
+
/** An object that contains a response and a list of actions to be performed upon a expression match. */
|
|
1861
|
+
output: Output;
|
|
1862
|
+
}
|
|
1863
|
+
export interface FabricAddress {
|
|
1864
|
+
/** Unique ID of the Fabric Address. */
|
|
1865
|
+
id: uuid;
|
|
1866
|
+
/** Name of the Fabric Address. */
|
|
1867
|
+
name: string;
|
|
1868
|
+
/** Display name of the Fabric Address. */
|
|
1869
|
+
display_name: string;
|
|
1870
|
+
/** Cover url of the Fabric Address. */
|
|
1871
|
+
cover_url: string;
|
|
1872
|
+
/** Preview url of the Fabric Address. */
|
|
1873
|
+
preview_url: string;
|
|
1874
|
+
/** Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls. */
|
|
1875
|
+
locked: boolean;
|
|
1876
|
+
/** Channels of the Fabric Address. */
|
|
1877
|
+
channels: AddressChannel;
|
|
1878
|
+
/** Fabric Address Creation Date. */
|
|
1879
|
+
created_at: string;
|
|
1880
|
+
type: DisplayTypes;
|
|
1881
|
+
}
|
|
1882
|
+
export interface FabricAddressApp {
|
|
1883
|
+
/** Unique ID of the Fabric Address. */
|
|
1884
|
+
id: uuid;
|
|
1885
|
+
/** Name of the Fabric Address. */
|
|
1886
|
+
name: string;
|
|
1887
|
+
/** Display name of the Fabric Address. */
|
|
1888
|
+
display_name: string;
|
|
1889
|
+
/** Cover url of the Fabric Address. */
|
|
1890
|
+
cover_url: string;
|
|
1891
|
+
/** Preview url of the Fabric Address. */
|
|
1892
|
+
preview_url: string;
|
|
1893
|
+
/** Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls. */
|
|
1894
|
+
locked: boolean;
|
|
1895
|
+
/** Channels of the Fabric Address. */
|
|
1896
|
+
channels: AddressChannel;
|
|
1897
|
+
/** Fabric Address Creation Date. */
|
|
1898
|
+
created_at: string;
|
|
1899
|
+
/** The display type of a fabric address pointing to an application. */
|
|
1900
|
+
type: 'app';
|
|
1901
|
+
}
|
|
1902
|
+
export interface FabricAddressCall {
|
|
1903
|
+
/** Unique ID of the Fabric Address. */
|
|
1904
|
+
id: uuid;
|
|
1905
|
+
/** Name of the Fabric Address. */
|
|
1906
|
+
name: string;
|
|
1907
|
+
/** Display name of the Fabric Address. */
|
|
1908
|
+
display_name: string;
|
|
1909
|
+
/** Cover url of the Fabric Address. */
|
|
1910
|
+
cover_url: string;
|
|
1911
|
+
/** Preview url of the Fabric Address. */
|
|
1912
|
+
preview_url: string;
|
|
1913
|
+
/** Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls. */
|
|
1914
|
+
locked: boolean;
|
|
1915
|
+
/** Channels of the Fabric Address. */
|
|
1916
|
+
channels: AddressChannel;
|
|
1917
|
+
/** Fabric Address Creation Date. */
|
|
1918
|
+
created_at: string;
|
|
1919
|
+
/** The display type of a fabric address pointing to call. */
|
|
1920
|
+
type: 'call';
|
|
1921
|
+
}
|
|
1922
|
+
export interface FabricAddressPaginationResponse {
|
|
1923
|
+
/** Link of the current page */
|
|
1924
|
+
self: string;
|
|
1925
|
+
/** Link to the first page */
|
|
1926
|
+
first: string;
|
|
1927
|
+
/** Link to the next page */
|
|
1928
|
+
next?: string;
|
|
1929
|
+
/** Link to the previous page */
|
|
1930
|
+
prev?: string;
|
|
1931
|
+
}
|
|
1932
|
+
export interface FabricAddressRoom {
|
|
1933
|
+
/** Unique ID of the Fabric Address. */
|
|
1934
|
+
id: uuid;
|
|
1935
|
+
/** Name of the Fabric Address. */
|
|
1936
|
+
name: string;
|
|
1937
|
+
/** Display name of the Fabric Address. */
|
|
1938
|
+
display_name: string;
|
|
1939
|
+
/** Cover url of the Fabric Address. */
|
|
1940
|
+
cover_url: string;
|
|
1941
|
+
/** Preview url of the Fabric Address. */
|
|
1942
|
+
preview_url: string;
|
|
1943
|
+
/** Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls. */
|
|
1944
|
+
locked: boolean;
|
|
1945
|
+
/** Channels of the Fabric Address. */
|
|
1946
|
+
channels: AddressChannel;
|
|
1947
|
+
/** Fabric Address Creation Date. */
|
|
1948
|
+
created_at: string;
|
|
1949
|
+
/** The display type of a fabric address pointing to a Conference Room. */
|
|
1950
|
+
type: 'room';
|
|
1951
|
+
}
|
|
1952
|
+
export interface FabricAddressSubscriber {
|
|
1953
|
+
/** Unique ID of the Fabric Address. */
|
|
1954
|
+
id: uuid;
|
|
1955
|
+
/** Name of the Fabric Address. */
|
|
1956
|
+
name: string;
|
|
1957
|
+
/** Display name of the Fabric Address. */
|
|
1958
|
+
display_name: string;
|
|
1959
|
+
/** Cover url of the Fabric Address. */
|
|
1960
|
+
cover_url: string;
|
|
1961
|
+
/** Preview url of the Fabric Address. */
|
|
1962
|
+
preview_url: string;
|
|
1963
|
+
/** Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls. */
|
|
1964
|
+
locked: boolean;
|
|
1965
|
+
/** Channels of the Fabric Address. */
|
|
1966
|
+
channels: AddressChannel;
|
|
1967
|
+
/** Fabric Address Creation Date. */
|
|
1968
|
+
created_at: string;
|
|
1969
|
+
/** The display type of a fabric address pointing to a Subscriber. */
|
|
1970
|
+
type: 'subscriber';
|
|
1971
|
+
}
|
|
1972
|
+
export interface FabricAddressesResponse {
|
|
1973
|
+
/** An array of objects containing a list of Resource Addresses */
|
|
1974
|
+
data: FabricAddress[];
|
|
1975
|
+
/** Object containing pagination links */
|
|
1976
|
+
links: FabricAddressPaginationResponse;
|
|
1977
|
+
}
|
|
1978
|
+
export interface FreeswitchConectorPaginationResponse {
|
|
1979
|
+
/** The link of the current page */
|
|
1980
|
+
self: string;
|
|
1981
|
+
/** The link of the first page */
|
|
1982
|
+
first: string;
|
|
1983
|
+
/** The link of the next page */
|
|
1984
|
+
next?: string;
|
|
1985
|
+
/** The link of the previous page */
|
|
1986
|
+
prev?: string;
|
|
1987
|
+
}
|
|
1988
|
+
export interface FreeswitchConnector {
|
|
1989
|
+
/** Unique ID of a FreeSWITCH Connector. */
|
|
1990
|
+
id: uuid;
|
|
1991
|
+
/** Name of the FreeSWITCH Connector */
|
|
1992
|
+
name?: string;
|
|
1993
|
+
/** Caller ID for the connector */
|
|
1994
|
+
caller_id?: string | null;
|
|
1995
|
+
/** Send as identifier */
|
|
1996
|
+
send_as?: string | null;
|
|
1997
|
+
}
|
|
1998
|
+
export interface FreeswitchConnectorAddressListResponse {
|
|
1999
|
+
/** An array of objects containing a list of FreeSWITCH Connector Addresses */
|
|
2000
|
+
data: FabricAddressCall[];
|
|
2001
|
+
/** Object containing pagination links */
|
|
2002
|
+
links: FreeswitchConnectorAddressPaginationResponse;
|
|
2003
|
+
}
|
|
2004
|
+
export interface FreeswitchConnectorAddressPaginationResponse {
|
|
2005
|
+
/** Link to the current page */
|
|
2006
|
+
self: string;
|
|
2007
|
+
/** Link to the first page */
|
|
2008
|
+
first: string;
|
|
2009
|
+
/** Link to the next page */
|
|
2010
|
+
next?: string;
|
|
2011
|
+
/** Link to the previous page */
|
|
2012
|
+
prev?: string;
|
|
2013
|
+
}
|
|
2014
|
+
export interface FreeswitchConnectorCreateRequest {
|
|
2015
|
+
/** Name of the FreeSWITCH Connector */
|
|
2016
|
+
name: string;
|
|
2017
|
+
/** FreeSWITCH token */
|
|
2018
|
+
token: uuid;
|
|
2019
|
+
}
|
|
2020
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
2021
|
+
export interface FreeswitchConnectorCreateStatusCode422 {
|
|
2022
|
+
/** List of validation errors. */
|
|
2023
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
2024
|
+
}
|
|
2025
|
+
export interface FreeswitchConnectorListResponse {
|
|
2026
|
+
/** Object containing pagination links */
|
|
2027
|
+
links: FreeswitchConectorPaginationResponse;
|
|
2028
|
+
/** An array of objects containing a list of FreeSWITCH connector data */
|
|
2029
|
+
data: FreeswitchConnectorResponse[];
|
|
2030
|
+
}
|
|
2031
|
+
export interface FreeswitchConnectorResponse {
|
|
2032
|
+
/** Unique ID of the FreeSWITCH Connector. */
|
|
2033
|
+
id: uuid;
|
|
2034
|
+
/** Unique ID of the Project. */
|
|
2035
|
+
project_id: uuid;
|
|
2036
|
+
/** Display name of the FreeSWITCH Connector Fabric Resource */
|
|
2037
|
+
display_name: string;
|
|
2038
|
+
/** Type of the Fabric Resource */
|
|
2039
|
+
type: 'freeswitch_connector';
|
|
2040
|
+
/** Date and time when the resource was created. */
|
|
2041
|
+
created_at: string;
|
|
2042
|
+
/** Date and time when the resource was updated. */
|
|
2043
|
+
updated_at: string;
|
|
2044
|
+
/** FreeSWITCH Connector data. */
|
|
2045
|
+
freeswitch_connector: FreeswitchConnector;
|
|
2046
|
+
}
|
|
2047
|
+
export interface FreeswitchConnectorUpdateRequest {
|
|
2048
|
+
/** Name of the FreeSWITCH Connector */
|
|
2049
|
+
name?: string;
|
|
2050
|
+
/** Caller ID for the connector */
|
|
2051
|
+
caller_id?: string;
|
|
2052
|
+
/** Send as identifier */
|
|
2053
|
+
send_as?: string;
|
|
2054
|
+
}
|
|
2055
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
2056
|
+
export interface FreeswitchConnectorUpdateStatusCode422 {
|
|
2057
|
+
/** List of validation errors. */
|
|
2058
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
2059
|
+
}
|
|
2060
|
+
/** Supported language codes */
|
|
2061
|
+
export type FunctionFillers = {
|
|
2062
|
+
/** Default language set by the user */
|
|
2063
|
+
default: string[];
|
|
2064
|
+
} | {
|
|
2065
|
+
/** Bulgarian */
|
|
2066
|
+
bg: string[];
|
|
2067
|
+
} | {
|
|
2068
|
+
/** Catalan */
|
|
2069
|
+
ca: string[];
|
|
2070
|
+
} | {
|
|
2071
|
+
/** Chinese (Simplified) */
|
|
2072
|
+
zh: string[];
|
|
2073
|
+
} | {
|
|
2074
|
+
/** Chinese (Simplified, China) */
|
|
2075
|
+
'zh-CN': string[];
|
|
2076
|
+
} | {
|
|
2077
|
+
/** Chinese (Simplified Han) */
|
|
2078
|
+
'zh-Hans': string[];
|
|
2079
|
+
} | {
|
|
2080
|
+
/** Chinese (Traditional, Taiwan) */
|
|
2081
|
+
'zh-TW': string[];
|
|
2082
|
+
} | {
|
|
2083
|
+
/** Chinese (Traditional Han) */
|
|
2084
|
+
'zh-Hant': string[];
|
|
2085
|
+
} | {
|
|
2086
|
+
/** Chinese (Traditional, Hong Kong) */
|
|
2087
|
+
'zh-HK': string[];
|
|
2088
|
+
} | {
|
|
2089
|
+
/** Czech */
|
|
2090
|
+
cs: string[];
|
|
2091
|
+
} | {
|
|
2092
|
+
/** Danish */
|
|
2093
|
+
da: string[];
|
|
2094
|
+
} | {
|
|
2095
|
+
/** Danish (Denmark) */
|
|
2096
|
+
'da-DK': string[];
|
|
2097
|
+
} | {
|
|
2098
|
+
/** Dutch */
|
|
2099
|
+
nl: string[];
|
|
2100
|
+
} | {
|
|
2101
|
+
/** English */
|
|
2102
|
+
en: string[];
|
|
2103
|
+
} | {
|
|
2104
|
+
/** English (United States) */
|
|
2105
|
+
'en-US': string[];
|
|
2106
|
+
} | {
|
|
2107
|
+
/** English (United Kingdom) */
|
|
2108
|
+
'en-GB': string[];
|
|
2109
|
+
} | {
|
|
2110
|
+
/** English (New Zealand) */
|
|
2111
|
+
'en-NZ': string[];
|
|
2112
|
+
} | {
|
|
2113
|
+
/** English (India) */
|
|
2114
|
+
'en-IN': string[];
|
|
2115
|
+
} | {
|
|
2116
|
+
/** English (Australia) */
|
|
2117
|
+
'en-AU': string[];
|
|
2118
|
+
} | {
|
|
2119
|
+
/** Estonian */
|
|
2120
|
+
et: string[];
|
|
2121
|
+
} | {
|
|
2122
|
+
/** Finnish */
|
|
2123
|
+
fi: string[];
|
|
2124
|
+
} | {
|
|
2125
|
+
/** Flemish (Belgian Dutch) */
|
|
2126
|
+
'nl-BE': string[];
|
|
2127
|
+
} | {
|
|
2128
|
+
/** French */
|
|
2129
|
+
fr: string[];
|
|
2130
|
+
} | {
|
|
2131
|
+
/** French (Canada) */
|
|
2132
|
+
'fr-CA': string[];
|
|
2133
|
+
} | {
|
|
2134
|
+
/** German */
|
|
2135
|
+
de: string[];
|
|
2136
|
+
} | {
|
|
2137
|
+
/** German (Switzerland) */
|
|
2138
|
+
'de-CH': string[];
|
|
2139
|
+
} | {
|
|
2140
|
+
/** Greek */
|
|
2141
|
+
el: string[];
|
|
2142
|
+
} | {
|
|
2143
|
+
/** Hindi */
|
|
2144
|
+
hi: string[];
|
|
2145
|
+
} | {
|
|
2146
|
+
/** Hungarian */
|
|
2147
|
+
hu: string[];
|
|
2148
|
+
} | {
|
|
2149
|
+
/** Indonesian */
|
|
2150
|
+
id: string[];
|
|
2151
|
+
} | {
|
|
2152
|
+
/** Italian */
|
|
2153
|
+
it: string[];
|
|
2154
|
+
} | {
|
|
2155
|
+
/** Japanese */
|
|
2156
|
+
ja: string[];
|
|
2157
|
+
} | {
|
|
2158
|
+
/** Korean */
|
|
2159
|
+
ko: string[];
|
|
2160
|
+
} | {
|
|
2161
|
+
/** Korean (South Korea) */
|
|
2162
|
+
'ko-KR': string[];
|
|
2163
|
+
} | {
|
|
2164
|
+
/** Latvian */
|
|
2165
|
+
lv: string[];
|
|
2166
|
+
} | {
|
|
2167
|
+
/** Lithuanian */
|
|
2168
|
+
lt: string[];
|
|
2169
|
+
} | {
|
|
2170
|
+
/** Malay */
|
|
2171
|
+
ms: string[];
|
|
2172
|
+
} | {
|
|
2173
|
+
/** Multilingual (Spanish + English) */
|
|
2174
|
+
multi: string[];
|
|
2175
|
+
} | {
|
|
2176
|
+
/** Norwegian */
|
|
2177
|
+
no: string[];
|
|
2178
|
+
} | {
|
|
2179
|
+
/** Polish */
|
|
2180
|
+
pl: string[];
|
|
2181
|
+
} | {
|
|
2182
|
+
/** Portuguese */
|
|
2183
|
+
pt: string[];
|
|
2184
|
+
} | {
|
|
2185
|
+
/** Portuguese (Brazil) */
|
|
2186
|
+
'pt-BR': string[];
|
|
2187
|
+
} | {
|
|
2188
|
+
/** Portuguese (Portugal) */
|
|
2189
|
+
'pt-PT': string[];
|
|
2190
|
+
} | {
|
|
2191
|
+
/** Romanian */
|
|
2192
|
+
ro: string[];
|
|
2193
|
+
} | {
|
|
2194
|
+
/** Russian */
|
|
2195
|
+
ru: string[];
|
|
2196
|
+
} | {
|
|
2197
|
+
/** Slovak */
|
|
2198
|
+
sk: string[];
|
|
2199
|
+
} | {
|
|
2200
|
+
/** Spanish */
|
|
2201
|
+
es: string[];
|
|
2202
|
+
} | {
|
|
2203
|
+
/** Spanish (Latin America) */
|
|
2204
|
+
'es-419': string[];
|
|
2205
|
+
} | {
|
|
2206
|
+
/** Swedish */
|
|
2207
|
+
sv: string[];
|
|
2208
|
+
} | {
|
|
2209
|
+
/** Swedish (Sweden) */
|
|
2210
|
+
'sv-SE': string[];
|
|
2211
|
+
} | {
|
|
2212
|
+
/** Thai */
|
|
2213
|
+
th: string[];
|
|
2214
|
+
} | {
|
|
2215
|
+
/** Thai (Thailand) */
|
|
2216
|
+
'th-TH': string[];
|
|
2217
|
+
} | {
|
|
2218
|
+
/** Turkish */
|
|
2219
|
+
tr: string[];
|
|
2220
|
+
} | {
|
|
2221
|
+
/** Ukrainian */
|
|
2222
|
+
uk: string[];
|
|
2223
|
+
} | {
|
|
2224
|
+
/** Vietnamese */
|
|
2225
|
+
vi: string[];
|
|
2226
|
+
};
|
|
2227
|
+
/** Supported language codes */
|
|
2228
|
+
export type FunctionFillersUpdate = {
|
|
2229
|
+
/** Default language set by the user */
|
|
2230
|
+
default?: string[];
|
|
2231
|
+
} | {
|
|
2232
|
+
/** Bulgarian */
|
|
2233
|
+
bg?: string[];
|
|
2234
|
+
} | {
|
|
2235
|
+
/** Catalan */
|
|
2236
|
+
ca?: string[];
|
|
2237
|
+
} | {
|
|
2238
|
+
/** Chinese (Simplified) */
|
|
2239
|
+
zh?: string[];
|
|
2240
|
+
} | {
|
|
2241
|
+
/** Chinese (Simplified, China) */
|
|
2242
|
+
'zh-CN'?: string[];
|
|
2243
|
+
} | {
|
|
2244
|
+
/** Chinese (Simplified Han) */
|
|
2245
|
+
'zh-Hans'?: string[];
|
|
2246
|
+
} | {
|
|
2247
|
+
/** Chinese (Traditional, Taiwan) */
|
|
2248
|
+
'zh-TW'?: string[];
|
|
2249
|
+
} | {
|
|
2250
|
+
/** Chinese (Traditional Han) */
|
|
2251
|
+
'zh-Hant'?: string[];
|
|
2252
|
+
} | {
|
|
2253
|
+
/** Chinese (Traditional, Hong Kong) */
|
|
2254
|
+
'zh-HK'?: string[];
|
|
2255
|
+
} | {
|
|
2256
|
+
/** Czech */
|
|
2257
|
+
cs?: string[];
|
|
2258
|
+
} | {
|
|
2259
|
+
/** Danish */
|
|
2260
|
+
da?: string[];
|
|
2261
|
+
} | {
|
|
2262
|
+
/** Danish (Denmark) */
|
|
2263
|
+
'da-DK'?: string[];
|
|
2264
|
+
} | {
|
|
2265
|
+
/** Dutch */
|
|
2266
|
+
nl?: string[];
|
|
2267
|
+
} | {
|
|
2268
|
+
/** English */
|
|
2269
|
+
en?: string[];
|
|
2270
|
+
} | {
|
|
2271
|
+
/** English (United States) */
|
|
2272
|
+
'en-US'?: string[];
|
|
2273
|
+
} | {
|
|
2274
|
+
/** English (United Kingdom) */
|
|
2275
|
+
'en-GB'?: string[];
|
|
2276
|
+
} | {
|
|
2277
|
+
/** English (New Zealand) */
|
|
2278
|
+
'en-NZ'?: string[];
|
|
2279
|
+
} | {
|
|
2280
|
+
/** English (India) */
|
|
2281
|
+
'en-IN'?: string[];
|
|
2282
|
+
} | {
|
|
2283
|
+
/** English (Australia) */
|
|
2284
|
+
'en-AU'?: string[];
|
|
2285
|
+
} | {
|
|
2286
|
+
/** Estonian */
|
|
2287
|
+
et?: string[];
|
|
2288
|
+
} | {
|
|
2289
|
+
/** Finnish */
|
|
2290
|
+
fi?: string[];
|
|
2291
|
+
} | {
|
|
2292
|
+
/** Flemish (Belgian Dutch) */
|
|
2293
|
+
'nl-BE'?: string[];
|
|
2294
|
+
} | {
|
|
2295
|
+
/** French */
|
|
2296
|
+
fr?: string[];
|
|
2297
|
+
} | {
|
|
2298
|
+
/** French (Canada) */
|
|
2299
|
+
'fr-CA'?: string[];
|
|
2300
|
+
} | {
|
|
2301
|
+
/** German */
|
|
2302
|
+
de?: string[];
|
|
2303
|
+
} | {
|
|
2304
|
+
/** German (Switzerland) */
|
|
2305
|
+
'de-CH'?: string[];
|
|
2306
|
+
} | {
|
|
2307
|
+
/** Greek */
|
|
2308
|
+
el?: string[];
|
|
2309
|
+
} | {
|
|
2310
|
+
/** Hindi */
|
|
2311
|
+
hi?: string[];
|
|
2312
|
+
} | {
|
|
2313
|
+
/** Hungarian */
|
|
2314
|
+
hu?: string[];
|
|
2315
|
+
} | {
|
|
2316
|
+
/** Indonesian */
|
|
2317
|
+
id?: string[];
|
|
2318
|
+
} | {
|
|
2319
|
+
/** Italian */
|
|
2320
|
+
it?: string[];
|
|
2321
|
+
} | {
|
|
2322
|
+
/** Japanese */
|
|
2323
|
+
ja?: string[];
|
|
2324
|
+
} | {
|
|
2325
|
+
/** Korean */
|
|
2326
|
+
ko?: string[];
|
|
2327
|
+
} | {
|
|
2328
|
+
/** Korean (South Korea) */
|
|
2329
|
+
'ko-KR'?: string[];
|
|
2330
|
+
} | {
|
|
2331
|
+
/** Latvian */
|
|
2332
|
+
lv?: string[];
|
|
2333
|
+
} | {
|
|
2334
|
+
/** Lithuanian */
|
|
2335
|
+
lt?: string[];
|
|
2336
|
+
} | {
|
|
2337
|
+
/** Malay */
|
|
2338
|
+
ms?: string[];
|
|
2339
|
+
} | {
|
|
2340
|
+
/** Multilingual (Spanish + English) */
|
|
2341
|
+
multi?: string[];
|
|
2342
|
+
} | {
|
|
2343
|
+
/** Norwegian */
|
|
2344
|
+
no?: string[];
|
|
2345
|
+
} | {
|
|
2346
|
+
/** Polish */
|
|
2347
|
+
pl?: string[];
|
|
2348
|
+
} | {
|
|
2349
|
+
/** Portuguese */
|
|
2350
|
+
pt?: string[];
|
|
2351
|
+
} | {
|
|
2352
|
+
/** Portuguese (Brazil) */
|
|
2353
|
+
'pt-BR'?: string[];
|
|
2354
|
+
} | {
|
|
2355
|
+
/** Portuguese (Portugal) */
|
|
2356
|
+
'pt-PT'?: string[];
|
|
2357
|
+
} | {
|
|
2358
|
+
/** Romanian */
|
|
2359
|
+
ro?: string[];
|
|
2360
|
+
} | {
|
|
2361
|
+
/** Russian */
|
|
2362
|
+
ru?: string[];
|
|
2363
|
+
} | {
|
|
2364
|
+
/** Slovak */
|
|
2365
|
+
sk?: string[];
|
|
2366
|
+
} | {
|
|
2367
|
+
/** Spanish */
|
|
2368
|
+
es?: string[];
|
|
2369
|
+
} | {
|
|
2370
|
+
/** Spanish (Latin America) */
|
|
2371
|
+
'es-419'?: string[];
|
|
2372
|
+
} | {
|
|
2373
|
+
/** Swedish */
|
|
2374
|
+
sv?: string[];
|
|
2375
|
+
} | {
|
|
2376
|
+
/** Swedish (Sweden) */
|
|
2377
|
+
'sv-SE'?: string[];
|
|
2378
|
+
} | {
|
|
2379
|
+
/** Thai */
|
|
2380
|
+
th?: string[];
|
|
2381
|
+
} | {
|
|
2382
|
+
/** Thai (Thailand) */
|
|
2383
|
+
'th-TH'?: string[];
|
|
2384
|
+
} | {
|
|
2385
|
+
/** Turkish */
|
|
2386
|
+
tr?: string[];
|
|
2387
|
+
} | {
|
|
2388
|
+
/** Ukrainian */
|
|
2389
|
+
uk?: string[];
|
|
2390
|
+
} | {
|
|
2391
|
+
/** Vietnamese */
|
|
2392
|
+
vi?: string[];
|
|
2393
|
+
};
|
|
2394
|
+
export interface FunctionParameters {
|
|
2395
|
+
/** The type of argument the AI is passing to the function. Possible values are 'string' and 'object'. */
|
|
2396
|
+
type: 'object';
|
|
2397
|
+
/** An object containing the property definitions that are passed to the function. */
|
|
2398
|
+
properties: Record<string, SchemaType>;
|
|
2399
|
+
/** An array of required property names from the `properties` object. */
|
|
2400
|
+
required?: string[];
|
|
2401
|
+
}
|
|
2402
|
+
export interface Goto {
|
|
2403
|
+
/** Jump to a label within the current section, optionally based on a condition. */
|
|
2404
|
+
goto: {
|
|
2405
|
+
/** Mark any point of the SWML section with a label so that goto can jump to it. */
|
|
2406
|
+
label: string;
|
|
2407
|
+
/** A JavaScript condition that determines whether to perform the jump. If the condition evaluates to true, the jump is executed. If omitted, the jump is unconditional. */
|
|
2408
|
+
when?: string;
|
|
2409
|
+
/** The maximum number of times to perform the jump. Must be a number between 1 and 100. Default `100`. */
|
|
2410
|
+
max?: number | SWMLVar;
|
|
2411
|
+
};
|
|
2412
|
+
}
|
|
2413
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
2414
|
+
export interface GuestTokenCreateStatusCode422 {
|
|
2415
|
+
/** List of validation errors. */
|
|
2416
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
2417
|
+
}
|
|
2418
|
+
export interface HangUpHookSWAIGFunction {
|
|
2419
|
+
/** A description of the context and purpose of the function, to explain to the agent when to use it. */
|
|
2420
|
+
description: string;
|
|
2421
|
+
/** The purpose field has been deprecated and is replaced by the `description` field. */
|
|
2422
|
+
purpose?: string;
|
|
2423
|
+
/** A JSON object that defines the expected user input parameters and their validation rules for the function. */
|
|
2424
|
+
parameters?: FunctionParameters;
|
|
2425
|
+
/** A JSON object defining the fillers that should be played when calling a `swaig function`. This helps the AI break silence between responses. The filler is played asynchronously during the function call. */
|
|
2426
|
+
fillers?: FunctionFillers;
|
|
2427
|
+
/** The argument field has been deprecated and is replaced by the `parameters` field. */
|
|
2428
|
+
argument?: FunctionParameters;
|
|
2429
|
+
/** Whether the function is active. **Default:** `true`. */
|
|
2430
|
+
active?: boolean | SWMLVar;
|
|
2431
|
+
/** A powerful and flexible environmental variable which can accept arbitrary data that is set initially in the SWML script or from the SWML set_meta_data action. */
|
|
2432
|
+
meta_data?: Record<string, Record<string, unknown>>;
|
|
2433
|
+
/** Scoping token for meta_data. If not supplied, metadata will be scoped to function's `web_hook_url`. Default is set by SignalWire. */
|
|
2434
|
+
meta_data_token?: string;
|
|
2435
|
+
/** An object that processes function inputs and executes operations through expressions, webhooks, or direct output. */
|
|
2436
|
+
data_map?: DataMap;
|
|
2437
|
+
/** Skips the top-level fillers specified in `ai.languages` (which includes `speech_fillers` and `function_fillers`). */
|
|
2438
|
+
skip_fillers?: boolean | SWMLVar;
|
|
2439
|
+
/** Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` */
|
|
2440
|
+
web_hook_url?: string;
|
|
2441
|
+
/** A file to play while the function is running. `wait_file_loops` can specify the amount of times that files should continously play. Default is not set. */
|
|
2442
|
+
wait_file?: string;
|
|
2443
|
+
/** The number of times to loop playing the file. Default is not set. */
|
|
2444
|
+
wait_file_loops?: number | string;
|
|
2445
|
+
/** Whether to wait for fillers to finish playing before continuing with the function. **Default:** `false`. */
|
|
2446
|
+
wait_for_fillers?: boolean | SWMLVar;
|
|
2447
|
+
/** A unique name for the function. This can be any user-defined string or can reference a reserved function. Reserved functions are SignalWire functions that will be executed at certain points in the conversation. For the stop_hook function, the function name is 'stop_hook'. */
|
|
2448
|
+
function: 'hangup_hook';
|
|
2449
|
+
}
|
|
2450
|
+
export interface Hangup {
|
|
2451
|
+
/** End the call with an optional reason. */
|
|
2452
|
+
hangup: {
|
|
2453
|
+
/** The reason for hanging up the call. */
|
|
2454
|
+
reason?: 'hangup' | 'busy' | 'decline';
|
|
2455
|
+
};
|
|
2456
|
+
}
|
|
2457
|
+
export interface HangupAction {
|
|
2458
|
+
/** Whether to hang up the call. When set to `true`, the call will be terminated after the AI agent finishes speaking. */
|
|
2459
|
+
hangup: boolean | SWMLVar;
|
|
2460
|
+
}
|
|
2461
|
+
export interface Hint {
|
|
2462
|
+
/** The hint to match. This will match the string exactly as provided */
|
|
2463
|
+
hint: string;
|
|
2464
|
+
/** A regular expression to match the hint against. This will ensure that the hint has a valid matching pattern before being replaced. */
|
|
2465
|
+
pattern: string;
|
|
2466
|
+
/** The text to replace the hint with. This will replace the portion of the hint that matches the pattern. */
|
|
2467
|
+
replace: string;
|
|
2468
|
+
/** If true, the hint will be matched in a case-insensitive manner. **Default:** `false`. */
|
|
2469
|
+
ignore_case?: boolean | SWMLVar;
|
|
2470
|
+
}
|
|
2471
|
+
export interface HoldAction {
|
|
2472
|
+
/** Places the caller on hold while playing hold music (configured via params.hold_music). */
|
|
2473
|
+
hold: number | SWMLVar | {
|
|
2474
|
+
/** The duration to hold the caller in seconds. Can be a number or an object with timeout property. */
|
|
2475
|
+
timeout?: number | SWMLVar;
|
|
2476
|
+
};
|
|
2477
|
+
}
|
|
2478
|
+
export interface InjectAction {
|
|
2479
|
+
/** Injects a message into the conversation to be translated and spoken to the specified party. */
|
|
2480
|
+
inject: {
|
|
2481
|
+
/** The message to be injected */
|
|
2482
|
+
message: string;
|
|
2483
|
+
/** The direction of the message. */
|
|
2484
|
+
direction: TranslateDirection;
|
|
2485
|
+
};
|
|
2486
|
+
}
|
|
2487
|
+
/** Base interface for all property types */
|
|
2488
|
+
export interface IntegerProperty {
|
|
2489
|
+
/** A description of the property. */
|
|
2490
|
+
description?: string;
|
|
2491
|
+
/** Whether the property can be null. */
|
|
2492
|
+
nullable?: boolean | SWMLVar;
|
|
2493
|
+
/** The type of parameter(s) the AI is passing to the function. */
|
|
2494
|
+
type: 'integer';
|
|
2495
|
+
/** An array of integers that are the possible values */
|
|
2496
|
+
enum?: number[];
|
|
2497
|
+
/** The default integer value */
|
|
2498
|
+
default?: number | SWMLVar;
|
|
2499
|
+
}
|
|
2500
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
2501
|
+
export interface InviteTokenCreateStatusCode422 {
|
|
2502
|
+
/** List of validation errors. */
|
|
2503
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
2504
|
+
}
|
|
2505
|
+
export interface JoinConference {
|
|
2506
|
+
/** Join an ad-hoc audio conference started on either the SignalWire or Compatibility API. */
|
|
2507
|
+
join_conference: JoinConferenceObject;
|
|
2508
|
+
}
|
|
2509
|
+
export interface JoinConferenceObject {
|
|
2510
|
+
/** Name of conference */
|
|
2511
|
+
name: string;
|
|
2512
|
+
/** Whether to join the conference in a muted state. If set to `true`, the participant will be muted upon joining. Default `false`. */
|
|
2513
|
+
muted?: boolean | SWMLVar;
|
|
2514
|
+
/** Sets the behavior of the beep sound when joining or leaving the conference. Default `"true"`. */
|
|
2515
|
+
beep?: 'true' | 'false' | 'onEnter' | 'onExit';
|
|
2516
|
+
/** Starts the conference when the main participant joins. This means the start action will not wait on more participants to join before starting. Default `true`. */
|
|
2517
|
+
start_on_enter?: boolean | SWMLVar;
|
|
2518
|
+
/** Ends the conference when the main participant leaves. This means the end action will not wait on more participants to leave before ending. Default `false`. */
|
|
2519
|
+
end_on_exit?: boolean | SWMLVar;
|
|
2520
|
+
/** A URL that will play media when the conference is put on hold. Default hold music will be played if not set */
|
|
2521
|
+
wait_url?: string | SWMLVar;
|
|
2522
|
+
/** The maximum number of participants allowed in the conference. If the limit is reached, new participants will not be able to join. Default `100000`. */
|
|
2523
|
+
max_participants?: number | SWMLVar;
|
|
2524
|
+
/** Enables or disables recording of the conference. Default `"do-not-record"`. */
|
|
2525
|
+
record?: 'do-not-record' | 'record-from-start';
|
|
2526
|
+
/** Specifies the geographical region where the conference will be hosted. Default not set */
|
|
2527
|
+
region?: string;
|
|
2528
|
+
/** If set to `trim-silence`, it will remove silence from the start of the recording. If set to `do-not-trim`, it will keep the silence. Default `"trim-silence"`. */
|
|
2529
|
+
trim?: 'trim-silence' | 'do-not-trim';
|
|
2530
|
+
/** Coach accepts a call SID of a call that is currently connected to an in-progress conference. */
|
|
2531
|
+
coach?: string;
|
|
2532
|
+
/** The events to listen for and send to the status callback URL. Default not set */
|
|
2533
|
+
status_callback_event?: 'start' | 'end' | 'join' | 'leave' | 'mute' | 'hold' | 'modify' | 'speaker' | 'announcement';
|
|
2534
|
+
/** The URL to which status events will be sent. This URL must be publicly accessible and able to handle HTTP requests. Default not set */
|
|
2535
|
+
status_callback?: string;
|
|
2536
|
+
/** The HTTP method to use when sending status events to the status callback URL. Default `"POST"`. */
|
|
2537
|
+
status_callback_method?: 'GET' | 'POST';
|
|
2538
|
+
/** The URL to which recording status events will be sent. This URL must be publicly accessible and able to handle HTTP requests. Default not set */
|
|
2539
|
+
recording_status_callback?: string;
|
|
2540
|
+
/** The HTTP method to use when sending recording status events to the recording status callback URL. Default `"POST"`. */
|
|
2541
|
+
recording_status_callback_method?: 'GET' | 'POST';
|
|
2542
|
+
/** The events to listen for and send to the recording status callback URL. Default not set */
|
|
2543
|
+
recording_status_callback_event?: 'in-progress' | 'completed' | 'absent';
|
|
2544
|
+
/** Allows the user to specify a custom action to be executed when the conference result is returned (typically when it has ended). */
|
|
2545
|
+
result?: {
|
|
2546
|
+
/** Name of the variable whose value needs to be compared. */
|
|
2547
|
+
variable: string;
|
|
2548
|
+
/** Object of key-mapped values to array of SWML methods to execute. */
|
|
2549
|
+
case: Record<string, SWMLMethod[]>;
|
|
2550
|
+
/** Array of SWML methods to execute if no cases match. */
|
|
2551
|
+
default?: SWMLMethod[];
|
|
2552
|
+
} | CondParams[];
|
|
2553
|
+
}
|
|
2554
|
+
export interface JoinRoom {
|
|
2555
|
+
/** Join a RELAY room. If the room doesn't exist, it creates a new room. */
|
|
2556
|
+
join_room: {
|
|
2557
|
+
/** Name of the room to join. Allowed characters: A-Z, a-z, 0-9, underscore, and hyphen. */
|
|
2558
|
+
name: string;
|
|
2559
|
+
};
|
|
2560
|
+
}
|
|
2561
|
+
export interface Label {
|
|
2562
|
+
/** Mark any point of the SWML section with a label so that goto can jump to it. */
|
|
2563
|
+
label: string;
|
|
2564
|
+
}
|
|
2565
|
+
export interface LanguageParams {
|
|
2566
|
+
/** The stability slider determines how stable the voice is and the randomness between each generation. Lowering this slider introduces a broader emotional range for the voice. IMPORTANT: Only works with ElevenLabs TTS engine. */
|
|
2567
|
+
stability?: number | SWMLVar;
|
|
2568
|
+
/** The similarity slider dictates how closely the AI should adhere to the original voice when attempting to replicate it. The higher the similarity, the closer the AI will sound to the original voice. IMPORTANT: Only works with ElevenLabs TTS engine. */
|
|
2569
|
+
similarity?: number | SWMLVar;
|
|
2570
|
+
}
|
|
2571
|
+
export type Languages = LanguagesWithSoloFillers | LanguagesWithFillers;
|
|
2572
|
+
export interface LanguagesWithFillers {
|
|
2573
|
+
/** Name of the language (e.g., 'French', 'English'). This value is used in the system prompt to instruct the LLM what language is being spoken. */
|
|
2574
|
+
name: string;
|
|
2575
|
+
/** The language code for ASR (Automatic Speech Recognition) purposes. By default, SignalWire uses Deepgram's */
|
|
2576
|
+
code: string;
|
|
2577
|
+
/** Voice to use for the language. String format: `<engine id>.<voice id>`. */
|
|
2578
|
+
voice: string;
|
|
2579
|
+
/** The model to use for the specified TTS engine. For example, 'arcana'. */
|
|
2580
|
+
model?: string;
|
|
2581
|
+
/** Enables emotion detection for the set TTS engine. This allows the AI to express emotions when speaking. */
|
|
2582
|
+
emotion?: 'auto';
|
|
2583
|
+
/** The speed to use for the specified TTS engine. This allows the AI to speak at a different speed at different points in the conversation. */
|
|
2584
|
+
speed?: 'auto';
|
|
2585
|
+
/** The engine to use for the language. For example, 'elevenlabs'. */
|
|
2586
|
+
engine?: string;
|
|
2587
|
+
/** TTS engine-specific parameters for this language. */
|
|
2588
|
+
params?: LanguageParams;
|
|
2589
|
+
/** An array of strings to be used as fillers in the conversation when calling a `swaig function`. This helps the AI break silence between responses. The filler is played asynchronously during the function call. */
|
|
2590
|
+
function_fillers?: string[];
|
|
2591
|
+
/** An array of strings to be used as fillers in the conversation. This helps the AI break silence between responses. */
|
|
2592
|
+
speech_fillers?: string[];
|
|
2593
|
+
}
|
|
2594
|
+
export interface LanguagesWithSoloFillers {
|
|
2595
|
+
/** Name of the language (e.g., 'French', 'English'). This value is used in the system prompt to instruct the LLM what language is being spoken. */
|
|
2596
|
+
name: string;
|
|
2597
|
+
/** The language code for ASR (Automatic Speech Recognition) purposes. By default, SignalWire uses Deepgram's */
|
|
2598
|
+
code: string;
|
|
2599
|
+
/** Voice to use for the language. String format: `<engine id>.<voice id>`. */
|
|
2600
|
+
voice: string;
|
|
2601
|
+
/** The model to use for the specified TTS engine. For example, 'arcana'. */
|
|
2602
|
+
model?: string;
|
|
2603
|
+
/** Enables emotion detection for the set TTS engine. This allows the AI to express emotions when speaking. */
|
|
2604
|
+
emotion?: 'auto';
|
|
2605
|
+
/** The speed to use for the specified TTS engine. This allows the AI to speak at a different speed at different points in the conversation. */
|
|
2606
|
+
speed?: 'auto';
|
|
2607
|
+
/** The engine to use for the language. For example, 'elevenlabs'. */
|
|
2608
|
+
engine?: string;
|
|
2609
|
+
/** TTS engine-specific parameters for this language. */
|
|
2610
|
+
params?: LanguageParams;
|
|
2611
|
+
/** An array of strings to be used as fillers in the conversation. This will be used for both speech and function fillers if provided. */
|
|
2612
|
+
fillers?: string[];
|
|
2613
|
+
}
|
|
2614
|
+
export type Layout = 'grid-responsive' | 'grid-responsive-mobile' | 'highlight-1-responsive' | '1x1' | '2x1' | '2x2' | '5up' | '3x3' | '4x4' | '5x5' | '6x6' | '8x8' | '10x10';
|
|
2615
|
+
export interface LiveTranscribe {
|
|
2616
|
+
/** Start live transcription of the call. The transcription will be sent to the specified webhook URL. */
|
|
2617
|
+
live_transcribe: {
|
|
2618
|
+
/** The action to perform during live transcription. */
|
|
2619
|
+
action: TranscribeAction;
|
|
2620
|
+
};
|
|
2621
|
+
}
|
|
2622
|
+
export interface LiveTranslate {
|
|
2623
|
+
/** Start live translation of the call. The translation will be sent to the specified webhook URL. */
|
|
2624
|
+
live_translate: {
|
|
2625
|
+
/** The action to perform during live translation. */
|
|
2626
|
+
action: TranslateAction;
|
|
2627
|
+
};
|
|
2628
|
+
}
|
|
2629
|
+
export interface MessagingChannel {
|
|
2630
|
+
/** Messaging Channel of Fabric Address */
|
|
2631
|
+
messaging: string;
|
|
2632
|
+
}
|
|
2633
|
+
export interface NullProperty {
|
|
2634
|
+
/** The type of parameter(s) the AI is passing to the function. */
|
|
2635
|
+
type: 'null';
|
|
2636
|
+
/** A description of the property. */
|
|
2637
|
+
description: string;
|
|
2638
|
+
}
|
|
2639
|
+
/** Base interface for all property types */
|
|
2640
|
+
export interface NumberProperty {
|
|
2641
|
+
/** A description of the property. */
|
|
2642
|
+
description?: string;
|
|
2643
|
+
/** Whether the property can be null. */
|
|
2644
|
+
nullable?: boolean | SWMLVar;
|
|
2645
|
+
/** The type of parameter(s) the AI is passing to the function. */
|
|
2646
|
+
type: 'number';
|
|
2647
|
+
/** An array of integers that are the possible values */
|
|
2648
|
+
enum?: number[] | SWMLVar[];
|
|
2649
|
+
/** The default integer value */
|
|
2650
|
+
default?: number | SWMLVar;
|
|
2651
|
+
}
|
|
2652
|
+
/** Base interface for all property types */
|
|
2653
|
+
export interface ObjectProperty {
|
|
2654
|
+
/** A description of the property. */
|
|
2655
|
+
description?: string;
|
|
2656
|
+
/** Whether the property can be null. */
|
|
2657
|
+
nullable?: boolean | SWMLVar;
|
|
2658
|
+
/** The type of parameter(s) the AI is passing to the function. */
|
|
2659
|
+
type: 'object';
|
|
2660
|
+
/** The default object value */
|
|
2661
|
+
default?: Record<string, Record<string, unknown>>;
|
|
2662
|
+
/** Nested properties */
|
|
2663
|
+
properties?: Record<string, SchemaType>;
|
|
2664
|
+
/** Required property names */
|
|
2665
|
+
required?: string[];
|
|
2666
|
+
}
|
|
2667
|
+
export interface OneOfProperty {
|
|
2668
|
+
/** An array of schemas where exactly one of the schemas must be valid. */
|
|
2669
|
+
oneOf: SchemaType[];
|
|
2670
|
+
}
|
|
2671
|
+
export interface Output {
|
|
2672
|
+
/** A static response text or message returned to the AI agent's context. */
|
|
2673
|
+
response: string;
|
|
2674
|
+
/** A list of actions to be performed upon matching. */
|
|
2675
|
+
action?: Action[];
|
|
2676
|
+
}
|
|
2677
|
+
/** Regular section that requires either body or bullets. */
|
|
2678
|
+
export type POM = PomSectionBodyContent | PomSectionBulletsContent;
|
|
2679
|
+
export interface Pay {
|
|
2680
|
+
/** Enables secure payment processing during voice calls. When implemented, it manages the entire payment flow */
|
|
2681
|
+
pay: {
|
|
2682
|
+
/** The URL to make POST requests with all the gathered payment details. */
|
|
2683
|
+
payment_connector_url: string;
|
|
2684
|
+
/** The amount to charge against payment method passed in the request. `Float` value with no currency prefix passed as string. */
|
|
2685
|
+
charge_amount?: string;
|
|
2686
|
+
/** Uses the ISO 4217 currency code of the charge amount. */
|
|
2687
|
+
currency?: string;
|
|
2688
|
+
/** Custom description of the payment provided in the request. */
|
|
2689
|
+
description?: string;
|
|
2690
|
+
/** The method of how to collect the payment details. Currently only `dtmf` mode is supported. */
|
|
2691
|
+
input?: 'dtmf';
|
|
2692
|
+
/** Language to use for prompts being played to the caller by the `pay` method. */
|
|
2693
|
+
language?: string;
|
|
2694
|
+
/** Number of times the `pay` method will retry to collect payment details. */
|
|
2695
|
+
max_attempts?: number | SWMLVar;
|
|
2696
|
+
/** The minimum length of the postal code the user must enter. */
|
|
2697
|
+
min_postal_code_length?: number | SWMLVar;
|
|
2698
|
+
/** Array of parameter objects to pass to your payment processor. The parameters are user-defined key-value pairs. */
|
|
2699
|
+
parameters?: PayParameters[];
|
|
2700
|
+
/** Indicates the payment method which is going to be used in this payment request. Currently only `credit-card` is supported. */
|
|
2701
|
+
payment_method?: 'credit-card';
|
|
2702
|
+
/** Takes `true`, `false` or real postalcode (if it's known beforehand) to let pay method know whether to prompt for postal code. Default is `true`. */
|
|
2703
|
+
postal_code?: boolean | string;
|
|
2704
|
+
/** Array of prompt objects for customizing the audio prompts during different stages of the payment process. */
|
|
2705
|
+
prompts?: PayPrompts[];
|
|
2706
|
+
/** Takes true or false to let pay method know whether to prompt for security code. */
|
|
2707
|
+
security_code?: boolean | SWMLVar;
|
|
2708
|
+
/** The URL to send requests for each status change during the payment process. */
|
|
2709
|
+
status_url?: string;
|
|
2710
|
+
/** Limit in seconds that pay method waits for the caller to press another digit before moving on to validate the digits captured. */
|
|
2711
|
+
timeout?: number | SWMLVar;
|
|
2712
|
+
/** Whether the payment is a one off payment or re-occurring. */
|
|
2713
|
+
token_type?: 'one-time' | 'reusable';
|
|
2714
|
+
/** List of payment cards allowed to use in the requested payment process separated by space. */
|
|
2715
|
+
valid_card_types?: string;
|
|
2716
|
+
/** Text-to-speech voice to use. Please refer to https://signalwire.com/docs/voice/getting-started/voice-and-languages for more information. */
|
|
2717
|
+
voice?: string;
|
|
2718
|
+
};
|
|
2719
|
+
}
|
|
2720
|
+
export interface PayParameters {
|
|
2721
|
+
/** The identifier for your custom parameter. This will be the key in the parameters object. */
|
|
2722
|
+
name: string;
|
|
2723
|
+
/** The value associated with the parameter. This will be the value in the parameters object. */
|
|
2724
|
+
value: string;
|
|
2725
|
+
}
|
|
2726
|
+
export type PayPromptAction = PayPromptSayAction | PayPromptPlayAction;
|
|
2727
|
+
export interface PayPromptPlayAction {
|
|
2728
|
+
/** When the action `type` is `Say`, this value is the text to be spoken; when the type is `Play`, it should be a URL to the audio file. */
|
|
2729
|
+
type: 'Play';
|
|
2730
|
+
/** The URL of the audio file to play */
|
|
2731
|
+
phrase: string;
|
|
2732
|
+
}
|
|
2733
|
+
export interface PayPromptSayAction {
|
|
2734
|
+
/** When the action `type` is `Say`, this value is the text to be spoken; when the type is `Play`, it should be a URL to the audio file. */
|
|
2735
|
+
type: 'Say';
|
|
2736
|
+
/** The phrase to speak */
|
|
2737
|
+
phrase: string;
|
|
2738
|
+
}
|
|
2739
|
+
export interface PayPrompts {
|
|
2740
|
+
/** Array of action objects to execute for this prompt. These actions can either play an audio file or speak a phrase. */
|
|
2741
|
+
actions: PayPromptAction[];
|
|
2742
|
+
/** The payment step this prompt is for. See Payment Steps for a list of available steps. */
|
|
2743
|
+
for: string;
|
|
2744
|
+
/** Specifies which payment attempt(s) this prompt applies to. The value increments when a payment fails. */
|
|
2745
|
+
attempts?: string;
|
|
2746
|
+
/** Space-seperated list of card types that are allowed to be used for this prompt. */
|
|
2747
|
+
card_type?: string;
|
|
2748
|
+
/** Space-separated list of error types this prompt applies to. */
|
|
2749
|
+
error_type?: string;
|
|
2750
|
+
}
|
|
2751
|
+
export interface PhoneRouteAssignRequest {
|
|
2752
|
+
/** The id of the phone route. */
|
|
2753
|
+
phone_route_id: uuid;
|
|
2754
|
+
/** Indicates if the resource should be assigned to a `calling` or `messaging` handler. */
|
|
2755
|
+
handler: UsedForType;
|
|
2756
|
+
}
|
|
2757
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
2758
|
+
export interface PhoneRouteCreateStatusCode422 {
|
|
2759
|
+
/** List of validation errors. */
|
|
2760
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
2761
|
+
}
|
|
2762
|
+
export interface PhoneRouteResponse {
|
|
2763
|
+
/** Unique ID of the Fabric Address. */
|
|
2764
|
+
id: uuid;
|
|
2765
|
+
/** Name of the Fabric Address. */
|
|
2766
|
+
name: string;
|
|
2767
|
+
/** Display name of the Fabric Address. */
|
|
2768
|
+
display_name: string;
|
|
2769
|
+
/** Cover url of the Fabric Address. */
|
|
2770
|
+
cover_url: string;
|
|
2771
|
+
/** Preview url of the Fabric Address. */
|
|
2772
|
+
preview_url: string;
|
|
2773
|
+
/** Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls. */
|
|
2774
|
+
locked: boolean;
|
|
2775
|
+
/** Channels of the Fabric Address. */
|
|
2776
|
+
channels: AddressChannel;
|
|
2777
|
+
/** Fabric Address Creation Date. */
|
|
2778
|
+
created_at: string;
|
|
2779
|
+
/** The display type of a fabric address pointing to an application. */
|
|
2780
|
+
type: 'app';
|
|
2781
|
+
}
|
|
2782
|
+
export interface Play {
|
|
2783
|
+
/** Play file(s), ringtones, speech or silence. */
|
|
2784
|
+
play: PlayWithURL | PlayWithURLS;
|
|
2785
|
+
}
|
|
2786
|
+
/** Play with a single URL */
|
|
2787
|
+
export interface PlayWithURL {
|
|
2788
|
+
/** If `true`, the call will automatically answer as the sound is playing. If `false`, you will start playing the audio during early media. Default `true`. */
|
|
2789
|
+
auto_answer?: boolean | SWMLVar;
|
|
2790
|
+
/** Volume level for the audio file. */
|
|
2791
|
+
volume?: number | SWMLVar;
|
|
2792
|
+
/** The voice to use for the text to speech. */
|
|
2793
|
+
say_voice?: string;
|
|
2794
|
+
/** The language to use for the text to speech. */
|
|
2795
|
+
say_language?: string;
|
|
2796
|
+
/** Gender to use for the text to speech. */
|
|
2797
|
+
say_gender?: string;
|
|
2798
|
+
/** http or https URL to deliver play status events */
|
|
2799
|
+
status_url?: string;
|
|
2800
|
+
/** URL to play. */
|
|
2801
|
+
url: play_url | SWMLVar;
|
|
2802
|
+
}
|
|
2803
|
+
export interface PlayWithURLS {
|
|
2804
|
+
/** If `true`, the call will automatically answer as the sound is playing. If `false`, you will start playing the audio during early media. Default `true`. */
|
|
2805
|
+
auto_answer?: boolean | SWMLVar;
|
|
2806
|
+
/** Volume level for the audio file. */
|
|
2807
|
+
volume?: number | SWMLVar;
|
|
2808
|
+
/** The voice to use for the text to speech. */
|
|
2809
|
+
say_voice?: string;
|
|
2810
|
+
/** The language to use for the text to speech. */
|
|
2811
|
+
say_language?: string;
|
|
2812
|
+
/** Gender to use for the text to speech. */
|
|
2813
|
+
say_gender?: string;
|
|
2814
|
+
/** http or https URL to deliver play status events */
|
|
2815
|
+
status_url?: string;
|
|
2816
|
+
/** Array of URLs to play. */
|
|
2817
|
+
urls: play_url[] | SWMLVar[];
|
|
2818
|
+
}
|
|
2819
|
+
export interface PlaybackBGAction {
|
|
2820
|
+
/** A JSON object containing the audio file to play. */
|
|
2821
|
+
playback_bg: {
|
|
2822
|
+
/** URL or filepath of the audio file to play. */
|
|
2823
|
+
file: string;
|
|
2824
|
+
/** Whether to wait for the audio file to finish playing before continuing. Default is `false`. */
|
|
2825
|
+
wait?: boolean | SWMLVar;
|
|
2826
|
+
};
|
|
2827
|
+
}
|
|
2828
|
+
/** Content model with body text and optional bullets */
|
|
2829
|
+
export interface PomSectionBodyContent {
|
|
2830
|
+
/** Title for the section */
|
|
2831
|
+
title?: string;
|
|
2832
|
+
/** Optional array of nested subsections */
|
|
2833
|
+
subsections?: POM[];
|
|
2834
|
+
/** Whether to number the section */
|
|
2835
|
+
numbered?: boolean | SWMLVar;
|
|
2836
|
+
/** Whether to number the bullets */
|
|
2837
|
+
numberedBullets?: boolean | SWMLVar;
|
|
2838
|
+
/** Body text for the section */
|
|
2839
|
+
body: string;
|
|
2840
|
+
/** Optional array of bullet points */
|
|
2841
|
+
bullets?: string[];
|
|
2842
|
+
}
|
|
2843
|
+
/** Content model with bullets and optional body */
|
|
2844
|
+
export interface PomSectionBulletsContent {
|
|
2845
|
+
/** Title for the section */
|
|
2846
|
+
title?: string;
|
|
2847
|
+
/** Optional array of nested subsections */
|
|
2848
|
+
subsections?: POM[];
|
|
2849
|
+
/** Whether to number the section */
|
|
2850
|
+
numbered?: boolean | SWMLVar;
|
|
2851
|
+
/** Whether to number the bullets */
|
|
2852
|
+
numberedBullets?: boolean | SWMLVar;
|
|
2853
|
+
/** Body text for the section (optional) */
|
|
2854
|
+
body?: string;
|
|
2855
|
+
/** Array of bullet points */
|
|
2856
|
+
bullets: string[];
|
|
2857
|
+
}
|
|
2858
|
+
export interface Prompt {
|
|
2859
|
+
/** Play a prompt and wait for input. The input can be received either as digits from the keypad, */
|
|
2860
|
+
prompt: {
|
|
2861
|
+
/** URL or array of URLs to play. */
|
|
2862
|
+
play: play_url | play_url[] | SWMLVar | SWMLVar[];
|
|
2863
|
+
/** Volume level for the audio file. */
|
|
2864
|
+
volume?: number;
|
|
2865
|
+
/** The voice to use for the text to speech. */
|
|
2866
|
+
say_voice?: string;
|
|
2867
|
+
/** The language to use for the text to speech. */
|
|
2868
|
+
say_language?: string;
|
|
2869
|
+
/** The gender to use for the text to speech. */
|
|
2870
|
+
say_gender?: string;
|
|
2871
|
+
/** Number of digits to collect. */
|
|
2872
|
+
max_digits?: number | SWMLVar;
|
|
2873
|
+
/** Digits that terminate digit collection. */
|
|
2874
|
+
terminators?: string;
|
|
2875
|
+
/** Time in seconds to wait for next digit. */
|
|
2876
|
+
digit_timeout?: number | SWMLVar;
|
|
2877
|
+
/** Time in seconds to wait for start of input. */
|
|
2878
|
+
initial_timeout?: number | SWMLVar;
|
|
2879
|
+
/** Max time in seconds to wait for speech result. */
|
|
2880
|
+
speech_timeout?: number | SWMLVar;
|
|
2881
|
+
/** Time in seconds to wait for end of speech utterance. */
|
|
2882
|
+
speech_end_timeout?: number | SWMLVar;
|
|
2883
|
+
/** Language to detect speech in. */
|
|
2884
|
+
speech_language?: string;
|
|
2885
|
+
/** Expected words or phrases to help the speech recognition. */
|
|
2886
|
+
speech_hints?: string[] | SWMLVar[];
|
|
2887
|
+
/** The engine that is selected for speech recognition. The engine must support the specified language. */
|
|
2888
|
+
speech_engine?: string;
|
|
2889
|
+
/** http or https URL to deliver prompt status events */
|
|
2890
|
+
status_url?: string;
|
|
2891
|
+
};
|
|
2892
|
+
}
|
|
2893
|
+
export interface Pronounce {
|
|
2894
|
+
/** The expression to replace. */
|
|
2895
|
+
replace: string;
|
|
2896
|
+
/** The phonetic spelling of the expression. */
|
|
2897
|
+
with: string;
|
|
2898
|
+
/** Whether the pronunciation replacement should ignore case. **Default:** `true`. */
|
|
2899
|
+
ignore_case?: boolean | SWMLVar;
|
|
2900
|
+
}
|
|
2901
|
+
export interface ReceiveFax {
|
|
2902
|
+
/** Receive a fax being delivered to this call. */
|
|
2903
|
+
receive_fax: {
|
|
2904
|
+
/** http or https URL to deliver receive_fax status events */
|
|
2905
|
+
status_url?: string;
|
|
2906
|
+
};
|
|
2907
|
+
}
|
|
2908
|
+
export interface Record_ {
|
|
2909
|
+
/** Record the call audio in the foreground, pausing further SWML execution until recording ends. */
|
|
2910
|
+
record: {
|
|
2911
|
+
/** If true, record in stereo. */
|
|
2912
|
+
stereo?: boolean | SWMLVar;
|
|
2913
|
+
/** The format to record in. Can be `wav`, `mp3`, or `mp4`. */
|
|
2914
|
+
format?: 'wav' | 'mp3' | 'mp4';
|
|
2915
|
+
/** Direction of the audio to record: "speak" for what party says, "listen" for what party hears. */
|
|
2916
|
+
direction?: 'speak' | 'listen';
|
|
2917
|
+
/** String of digits that will stop the recording when pressed. Default is `"#"`. */
|
|
2918
|
+
terminators?: string;
|
|
2919
|
+
/** Play a beep before recording. */
|
|
2920
|
+
beep?: boolean | SWMLVar;
|
|
2921
|
+
/** How sensitive the recording voice activity detector is to background noise. */
|
|
2922
|
+
input_sensitivity?: number | SWMLVar;
|
|
2923
|
+
/** Time in seconds to wait for the start of speech. */
|
|
2924
|
+
initial_timeout?: number | SWMLVar;
|
|
2925
|
+
/** Time in seconds to wait in silence before ending the recording. */
|
|
2926
|
+
end_silence_timeout?: number | SWMLVar;
|
|
2927
|
+
/** Maximum length of the recording in seconds. */
|
|
2928
|
+
max_length?: number | SWMLVar;
|
|
2929
|
+
/** URL to send recording status events to. */
|
|
2930
|
+
status_url?: string;
|
|
2931
|
+
};
|
|
2932
|
+
}
|
|
2933
|
+
export interface RecordCall {
|
|
2934
|
+
/** Record call in the background. */
|
|
2935
|
+
record_call: {
|
|
2936
|
+
/** Identifier for this recording, to use with `stop_call_record`. */
|
|
2937
|
+
control_id?: string;
|
|
2938
|
+
/** If `true`, record in stereo. */
|
|
2939
|
+
stereo?: boolean | SWMLVar;
|
|
2940
|
+
/** The format to record in. It can be `wav`, `mp3`, or `mp4`. */
|
|
2941
|
+
format?: 'wav' | 'mp3' | 'mp4';
|
|
2942
|
+
/** Direction of the audio to record: "speak" for what party says, "listen" for what party hears, "both" for what the party hears and says. */
|
|
2943
|
+
direction?: 'speak' | 'listen' | 'both';
|
|
2944
|
+
/** String of digits that will stop the recording when pressed. Default is `""` (empty). */
|
|
2945
|
+
terminators?: string;
|
|
2946
|
+
/** Play a beep before recording. */
|
|
2947
|
+
beep?: boolean | SWMLVar;
|
|
2948
|
+
/** How sensitive the recording voice activity detector is to background noise. */
|
|
2949
|
+
input_sensitivity?: number | SWMLVar;
|
|
2950
|
+
/** Time in seconds to wait for the start of speech. */
|
|
2951
|
+
initial_timeout?: number | SWMLVar;
|
|
2952
|
+
/** Time in seconds to wait in silence before ending the recording. */
|
|
2953
|
+
end_silence_timeout?: number | SWMLVar;
|
|
2954
|
+
/** Maximum length of the recording in seconds. */
|
|
2955
|
+
max_length?: number | SWMLVar;
|
|
2956
|
+
/** http or https URL to deliver record_call status events */
|
|
2957
|
+
status_url?: string;
|
|
2958
|
+
};
|
|
2959
|
+
}
|
|
2960
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
2961
|
+
export interface RefreshTokenStatusCode422 {
|
|
2962
|
+
/** List of validation errors. */
|
|
2963
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
2964
|
+
}
|
|
2965
|
+
export interface RelayApplication {
|
|
2966
|
+
/** Unique ID of a Relay Application. */
|
|
2967
|
+
id: uuid;
|
|
2968
|
+
/** Name of the Relay Application */
|
|
2969
|
+
name: string;
|
|
2970
|
+
/** Topic of the Relay Application */
|
|
2971
|
+
topic: string;
|
|
2972
|
+
/** Call status callback URL */
|
|
2973
|
+
call_status_callback_url: string | null;
|
|
2974
|
+
}
|
|
2975
|
+
export interface RelayApplicationAddressListResponse {
|
|
2976
|
+
/** An array of objects that contain a list of Relay Application Addresses */
|
|
2977
|
+
data: FabricAddressApp[];
|
|
2978
|
+
/** Object containing pagination links */
|
|
2979
|
+
links: RelayApplicationAddressPaginationResponse;
|
|
2980
|
+
}
|
|
2981
|
+
export interface RelayApplicationAddressPaginationResponse {
|
|
2982
|
+
/** Self link for the current page */
|
|
2983
|
+
self: string;
|
|
2984
|
+
/** Link to the first page */
|
|
2985
|
+
first: string;
|
|
2986
|
+
/** Link to the next page */
|
|
2987
|
+
next?: string;
|
|
2988
|
+
/** Link to the previous page */
|
|
2989
|
+
prev?: string;
|
|
2990
|
+
}
|
|
2991
|
+
export interface RelayApplicationCreateRequest {
|
|
2992
|
+
/** Name of the Relay Application */
|
|
2993
|
+
name: string;
|
|
2994
|
+
/** Topic of the Relay Application */
|
|
2995
|
+
topic: string;
|
|
2996
|
+
/** Call status callback URL */
|
|
2997
|
+
call_status_callback_url?: string;
|
|
2998
|
+
}
|
|
2999
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
3000
|
+
export interface RelayApplicationCreateStatusCode422 {
|
|
3001
|
+
/** List of validation errors. */
|
|
3002
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
3003
|
+
}
|
|
3004
|
+
export interface RelayApplicationListResponse {
|
|
3005
|
+
/** An array of objects that contain a list of Relay Application data */
|
|
3006
|
+
data: RelayApplicationResponse[];
|
|
3007
|
+
/** Object containing pagination links */
|
|
3008
|
+
links: RelayApplicationAddressPaginationResponse;
|
|
3009
|
+
}
|
|
3010
|
+
export interface RelayApplicationResponse {
|
|
3011
|
+
/** Unique ID of the Relay Application. */
|
|
3012
|
+
id: uuid;
|
|
3013
|
+
/** Unique ID of the Project. */
|
|
3014
|
+
project_id: uuid;
|
|
3015
|
+
/** Display name of the Relay Application Fabric Resource */
|
|
3016
|
+
display_name: string;
|
|
3017
|
+
/** Type of the Fabric Resource */
|
|
3018
|
+
type: 'relay_application';
|
|
3019
|
+
/** Date and time when the resource was created. */
|
|
3020
|
+
created_at: string;
|
|
3021
|
+
/** Date and time when the resource was updated. */
|
|
3022
|
+
updated_at: string;
|
|
3023
|
+
/** Relay Application data. */
|
|
3024
|
+
relay_application: RelayApplication;
|
|
3025
|
+
}
|
|
3026
|
+
export interface RelayApplicationUpdateRequest {
|
|
3027
|
+
/** Name of the Relay Application */
|
|
3028
|
+
name?: string;
|
|
3029
|
+
/** Topic of the Relay Application */
|
|
3030
|
+
topic?: string;
|
|
3031
|
+
/** Call status callback URL */
|
|
3032
|
+
call_status_callback_url?: string;
|
|
3033
|
+
}
|
|
3034
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
3035
|
+
export interface RelayApplicationUpdateStatusCode422 {
|
|
3036
|
+
/** List of validation errors. */
|
|
3037
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
3038
|
+
}
|
|
3039
|
+
export interface Request {
|
|
3040
|
+
/** Send a GET, POST, PUT, or DELETE request to a remote URL. */
|
|
3041
|
+
request: {
|
|
3042
|
+
/** URL to send the HTTPS request to. Authentication can also be set in the URL in the format of username:password@url. */
|
|
3043
|
+
url: string;
|
|
3044
|
+
/** The HTTP method to be used for the request. Can be `GET`, `POST`, `PUT`, or `DELETE`. */
|
|
3045
|
+
method: 'GET' | 'POST' | 'PUT' | 'DELETE';
|
|
3046
|
+
/** Object containing HTTP headers to set. Valid header values are Accept, Authorization, Content-Type, Range, and custom X- headers. */
|
|
3047
|
+
headers?: Record<string, Record<string, unknown>>;
|
|
3048
|
+
/** Request body. Content-Type header should be explicitly set, but if not set, the most likely type */
|
|
3049
|
+
body?: string | Record<string, Record<string, unknown>>;
|
|
3050
|
+
/** Maximum time in seconds to wait for a response. */
|
|
3051
|
+
timeout?: number | SWMLVar;
|
|
3052
|
+
/** Maximum time in seconds to wait for a connection. */
|
|
3053
|
+
connect_timeout?: number | SWMLVar;
|
|
3054
|
+
/** Store parsed JSON response as variables. */
|
|
3055
|
+
save_variables?: boolean | SWMLVar;
|
|
3056
|
+
};
|
|
3057
|
+
}
|
|
3058
|
+
export interface ResourceAddressListResponse {
|
|
3059
|
+
/** An array opf objects that contain a list of Resource Addresses */
|
|
3060
|
+
data: FabricAddress[];
|
|
3061
|
+
/** Object containing pagination links */
|
|
3062
|
+
links: ResourceAddressPaginationResponse;
|
|
3063
|
+
}
|
|
3064
|
+
export interface ResourceAddressPaginationResponse {
|
|
3065
|
+
/** Link to the current page of results */
|
|
3066
|
+
self: string;
|
|
3067
|
+
/** Link to the first page of results */
|
|
3068
|
+
first: string;
|
|
3069
|
+
/** Link to the next page of results */
|
|
3070
|
+
next?: string;
|
|
3071
|
+
/** Link to the previous page of results */
|
|
3072
|
+
prev?: string;
|
|
3073
|
+
}
|
|
3074
|
+
export interface ResourceListResponse {
|
|
3075
|
+
/** An array of objects that contain a list of Resource data */
|
|
3076
|
+
data: ResourceResponse[];
|
|
3077
|
+
/** Object containing pagination links */
|
|
3078
|
+
links: ResourcePaginationResponse;
|
|
3079
|
+
}
|
|
3080
|
+
export interface ResourcePaginationResponse {
|
|
3081
|
+
/** The link to the current page */
|
|
3082
|
+
self: string;
|
|
3083
|
+
/** The link to the first page */
|
|
3084
|
+
first: string;
|
|
3085
|
+
/** The link to the next page */
|
|
3086
|
+
next?: string;
|
|
3087
|
+
/** The link to the previous page */
|
|
3088
|
+
prev?: string;
|
|
3089
|
+
}
|
|
3090
|
+
export type ResourceResponse = ResourceResponseAI | ResourceResponseCallFlow | ResourceResponseCXMLWebhook | ResourceResponseCXMLScript | ResourceResponseCXMLApplication | ResourceResponseDialogFlowAgent | ResourceResponseFSConnector | ResourceResponseRelayApp | ResourceResponseSipEndpoint | ResourceResponseSipGateway | ResourceResponseSubscriber | ResourceResponseSWMLWebhook | ResourceResponseSWMLScript | ResourceResponseConferenceRoom;
|
|
3091
|
+
export interface ResourceResponseAI {
|
|
3092
|
+
/** Unique ID of the Resource. */
|
|
3093
|
+
id: uuid;
|
|
3094
|
+
/** Unique ID of the Project. */
|
|
3095
|
+
project_id: uuid;
|
|
3096
|
+
/** Display name of the Resource */
|
|
3097
|
+
display_name: string;
|
|
3098
|
+
/** Date and time when the resource was created. */
|
|
3099
|
+
created_at: string;
|
|
3100
|
+
/** Date and time when the resource was updated. */
|
|
3101
|
+
updated_at: string;
|
|
3102
|
+
/** The type of Resource */
|
|
3103
|
+
type: 'ai_agent';
|
|
3104
|
+
/** An object containing the response data of the AI Agent */
|
|
3105
|
+
ai_agent: AIAgent;
|
|
3106
|
+
}
|
|
3107
|
+
export interface ResourceResponseCXMLApplication {
|
|
3108
|
+
/** Unique ID of the Resource. */
|
|
3109
|
+
id: uuid;
|
|
3110
|
+
/** Unique ID of the Project. */
|
|
3111
|
+
project_id: uuid;
|
|
3112
|
+
/** Display name of the Resource */
|
|
3113
|
+
display_name: string;
|
|
3114
|
+
/** Date and time when the resource was created. */
|
|
3115
|
+
created_at: string;
|
|
3116
|
+
/** Date and time when the resource was updated. */
|
|
3117
|
+
updated_at: string;
|
|
3118
|
+
/** The type of Resource */
|
|
3119
|
+
type: 'cxml_application';
|
|
3120
|
+
/** An object containing the response data of the cXML Application */
|
|
3121
|
+
cxml_application: CxmlApplication;
|
|
3122
|
+
}
|
|
3123
|
+
export interface ResourceResponseCXMLScript {
|
|
3124
|
+
/** Unique ID of the Resource. */
|
|
3125
|
+
id: uuid;
|
|
3126
|
+
/** Unique ID of the Project. */
|
|
3127
|
+
project_id: uuid;
|
|
3128
|
+
/** Display name of the Resource */
|
|
3129
|
+
display_name: string;
|
|
3130
|
+
/** Date and time when the resource was created. */
|
|
3131
|
+
created_at: string;
|
|
3132
|
+
/** Date and time when the resource was updated. */
|
|
3133
|
+
updated_at: string;
|
|
3134
|
+
/** The type of Resource */
|
|
3135
|
+
type: 'cxml_script';
|
|
3136
|
+
/** An object containing the response data of the cXML Script */
|
|
3137
|
+
cxml_script: CXMLScript;
|
|
3138
|
+
}
|
|
3139
|
+
export interface ResourceResponseCXMLWebhook {
|
|
3140
|
+
/** Unique ID of the Resource. */
|
|
3141
|
+
id: uuid;
|
|
3142
|
+
/** Unique ID of the Project. */
|
|
3143
|
+
project_id: uuid;
|
|
3144
|
+
/** Display name of the Resource */
|
|
3145
|
+
display_name: string;
|
|
3146
|
+
/** Date and time when the resource was created. */
|
|
3147
|
+
created_at: string;
|
|
3148
|
+
/** Date and time when the resource was updated. */
|
|
3149
|
+
updated_at: string;
|
|
3150
|
+
/** The type of Resource */
|
|
3151
|
+
type: 'cxml_webhook';
|
|
3152
|
+
/** An object containing the response data of the cXML Webhook */
|
|
3153
|
+
cxml_webhook: CXMLWebhook;
|
|
3154
|
+
}
|
|
3155
|
+
export interface ResourceResponseCallFlow {
|
|
3156
|
+
/** Unique ID of the Resource. */
|
|
3157
|
+
id: uuid;
|
|
3158
|
+
/** Unique ID of the Project. */
|
|
3159
|
+
project_id: uuid;
|
|
3160
|
+
/** Display name of the Resource */
|
|
3161
|
+
display_name: string;
|
|
3162
|
+
/** Date and time when the resource was created. */
|
|
3163
|
+
created_at: string;
|
|
3164
|
+
/** Date and time when the resource was updated. */
|
|
3165
|
+
updated_at: string;
|
|
3166
|
+
/** The type of Resource */
|
|
3167
|
+
type: 'call_flow';
|
|
3168
|
+
/** An object containing the response data of the Call Flow */
|
|
3169
|
+
call_flow: CallFlow;
|
|
3170
|
+
}
|
|
3171
|
+
export interface ResourceResponseConferenceRoom {
|
|
3172
|
+
/** Unique ID of the Resource. */
|
|
3173
|
+
id: uuid;
|
|
3174
|
+
/** Unique ID of the Project. */
|
|
3175
|
+
project_id: uuid;
|
|
3176
|
+
/** Display name of the Resource */
|
|
3177
|
+
display_name: string;
|
|
3178
|
+
/** Date and time when the resource was created. */
|
|
3179
|
+
created_at: string;
|
|
3180
|
+
/** Date and time when the resource was updated. */
|
|
3181
|
+
updated_at: string;
|
|
3182
|
+
/** The type of Resource */
|
|
3183
|
+
type: 'swml_script';
|
|
3184
|
+
/** An object containing the response data of the Conference Room */
|
|
3185
|
+
conference_room: ConferenceRoom;
|
|
3186
|
+
}
|
|
3187
|
+
export interface ResourceResponseDialogFlowAgent {
|
|
3188
|
+
/** Unique ID of the Resource. */
|
|
3189
|
+
id: uuid;
|
|
3190
|
+
/** Unique ID of the Project. */
|
|
3191
|
+
project_id: uuid;
|
|
3192
|
+
/** Display name of the Resource */
|
|
3193
|
+
display_name: string;
|
|
3194
|
+
/** Date and time when the resource was created. */
|
|
3195
|
+
created_at: string;
|
|
3196
|
+
/** Date and time when the resource was updated. */
|
|
3197
|
+
updated_at: string;
|
|
3198
|
+
/** The type of Resource */
|
|
3199
|
+
type: 'dialogflow_agent';
|
|
3200
|
+
/** An object containing the response data of the Dialogflow Agent */
|
|
3201
|
+
dialogflow_agent: DialogflowAgent;
|
|
3202
|
+
}
|
|
3203
|
+
export interface ResourceResponseFSConnector {
|
|
3204
|
+
/** Unique ID of the Resource. */
|
|
3205
|
+
id: uuid;
|
|
3206
|
+
/** Unique ID of the Project. */
|
|
3207
|
+
project_id: uuid;
|
|
3208
|
+
/** Display name of the Resource */
|
|
3209
|
+
display_name: string;
|
|
3210
|
+
/** Date and time when the resource was created. */
|
|
3211
|
+
created_at: string;
|
|
3212
|
+
/** Date and time when the resource was updated. */
|
|
3213
|
+
updated_at: string;
|
|
3214
|
+
/** The type of Resource */
|
|
3215
|
+
type: 'freeswitch_connector';
|
|
3216
|
+
/** An object containing the response data of the FreeSWITCH Connector */
|
|
3217
|
+
freeswitch_connector: FreeswitchConnector;
|
|
3218
|
+
}
|
|
3219
|
+
export interface ResourceResponseRelayApp {
|
|
3220
|
+
/** Unique ID of the Resource. */
|
|
3221
|
+
id: uuid;
|
|
3222
|
+
/** Unique ID of the Project. */
|
|
3223
|
+
project_id: uuid;
|
|
3224
|
+
/** Display name of the Resource */
|
|
3225
|
+
display_name: string;
|
|
3226
|
+
/** Date and time when the resource was created. */
|
|
3227
|
+
created_at: string;
|
|
3228
|
+
/** Date and time when the resource was updated. */
|
|
3229
|
+
updated_at: string;
|
|
3230
|
+
/** The type of Resource */
|
|
3231
|
+
type: 'relay_application';
|
|
3232
|
+
/** An object containing the response data of the Relay Application */
|
|
3233
|
+
relay_application: RelayApplication;
|
|
3234
|
+
}
|
|
3235
|
+
export interface ResourceResponseSWMLScript {
|
|
3236
|
+
/** Unique ID of the Resource. */
|
|
3237
|
+
id: uuid;
|
|
3238
|
+
/** Unique ID of the Project. */
|
|
3239
|
+
project_id: uuid;
|
|
3240
|
+
/** Display name of the Resource */
|
|
3241
|
+
display_name: string;
|
|
3242
|
+
/** Date and time when the resource was created. */
|
|
3243
|
+
created_at: string;
|
|
3244
|
+
/** Date and time when the resource was updated. */
|
|
3245
|
+
updated_at: string;
|
|
3246
|
+
/** The type of Resource */
|
|
3247
|
+
type: 'swml_script';
|
|
3248
|
+
/** An object containing the response data of the SWML Script */
|
|
3249
|
+
swml_script: SwmlScript;
|
|
3250
|
+
}
|
|
3251
|
+
export interface ResourceResponseSWMLWebhook {
|
|
3252
|
+
/** Unique ID of the Resource. */
|
|
3253
|
+
id: uuid;
|
|
3254
|
+
/** Unique ID of the Project. */
|
|
3255
|
+
project_id: uuid;
|
|
3256
|
+
/** Display name of the Resource */
|
|
3257
|
+
display_name: string;
|
|
3258
|
+
/** Date and time when the resource was created. */
|
|
3259
|
+
created_at: string;
|
|
3260
|
+
/** Date and time when the resource was updated. */
|
|
3261
|
+
updated_at: string;
|
|
3262
|
+
/** The type of Resource */
|
|
3263
|
+
type: 'swml_webhook';
|
|
3264
|
+
/** An object containing the response data of the SWML Webhook */
|
|
3265
|
+
swml_webhook: SWMLWebhook;
|
|
3266
|
+
}
|
|
3267
|
+
export interface ResourceResponseSipEndpoint {
|
|
3268
|
+
/** Unique ID of the Resource. */
|
|
3269
|
+
id: uuid;
|
|
3270
|
+
/** Unique ID of the Project. */
|
|
3271
|
+
project_id: uuid;
|
|
3272
|
+
/** Display name of the Resource */
|
|
3273
|
+
display_name: string;
|
|
3274
|
+
/** Date and time when the resource was created. */
|
|
3275
|
+
created_at: string;
|
|
3276
|
+
/** Date and time when the resource was updated. */
|
|
3277
|
+
updated_at: string;
|
|
3278
|
+
/** The type of Resource */
|
|
3279
|
+
type: 'sip_endpoint';
|
|
3280
|
+
/** An object containing the response data of the SIP Endpoint */
|
|
3281
|
+
sip_endpoint: SipEndpoint;
|
|
3282
|
+
}
|
|
3283
|
+
export interface ResourceResponseSipGateway {
|
|
3284
|
+
/** Unique ID of the Resource. */
|
|
3285
|
+
id: uuid;
|
|
3286
|
+
/** Unique ID of the Project. */
|
|
3287
|
+
project_id: uuid;
|
|
3288
|
+
/** Display name of the Resource */
|
|
3289
|
+
display_name: string;
|
|
3290
|
+
/** Date and time when the resource was created. */
|
|
3291
|
+
created_at: string;
|
|
3292
|
+
/** Date and time when the resource was updated. */
|
|
3293
|
+
updated_at: string;
|
|
3294
|
+
/** The type of Resource */
|
|
3295
|
+
type: 'sip_gateway';
|
|
3296
|
+
/** An object containing the response data of the SIP Gateway */
|
|
3297
|
+
sip_gateway: SipGateway;
|
|
3298
|
+
}
|
|
3299
|
+
export interface ResourceResponseSubscriber {
|
|
3300
|
+
/** Unique ID of the Resource. */
|
|
3301
|
+
id: uuid;
|
|
3302
|
+
/** Unique ID of the Project. */
|
|
3303
|
+
project_id: uuid;
|
|
3304
|
+
/** Display name of the Resource */
|
|
3305
|
+
display_name: string;
|
|
3306
|
+
/** Date and time when the resource was created. */
|
|
3307
|
+
created_at: string;
|
|
3308
|
+
/** Date and time when the resource was updated. */
|
|
3309
|
+
updated_at: string;
|
|
3310
|
+
/** The type of Resource */
|
|
3311
|
+
type: 'subscriber';
|
|
3312
|
+
/** An object containing the response data of the Subscriber */
|
|
3313
|
+
subscriber: Subscriber;
|
|
3314
|
+
}
|
|
3315
|
+
export interface ResourceSipEndpointAssignRequest {
|
|
3316
|
+
/** The unique identifier of the SIP endpoint. */
|
|
3317
|
+
sip_endpoint_id: uuid;
|
|
3318
|
+
}
|
|
3319
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
3320
|
+
export interface ResourceSipEndpointCreateStatusCode422 {
|
|
3321
|
+
/** List of validation errors. */
|
|
3322
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
3323
|
+
}
|
|
3324
|
+
export interface ResourceSipEndpointResponse {
|
|
3325
|
+
/** The unique identifier of the SIP endpoint. */
|
|
3326
|
+
id: uuid;
|
|
3327
|
+
/** The name for the SIP endpoint. */
|
|
3328
|
+
name: string;
|
|
3329
|
+
/** The Resource type */
|
|
3330
|
+
type: 'call';
|
|
3331
|
+
/** The cover URL for the SIP endpoint. */
|
|
3332
|
+
cover_url: string | null;
|
|
3333
|
+
/** The preview URL for the SIP endpoint. */
|
|
3334
|
+
preview_url: string | null;
|
|
3335
|
+
/** An object containing the resource addresses with the specified comunication channels */
|
|
3336
|
+
channels: AddressChannel;
|
|
3337
|
+
}
|
|
3338
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
3339
|
+
export interface ResourceSipEndpointUpdateStatusCode422 {
|
|
3340
|
+
/** List of validation errors. */
|
|
3341
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
3342
|
+
}
|
|
3343
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
3344
|
+
export interface ResourceSubSipEndpointCreateStatusCode422 {
|
|
3345
|
+
/** List of validation errors. */
|
|
3346
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
3347
|
+
}
|
|
3348
|
+
export interface Return {
|
|
3349
|
+
/** Return a value from an execute call or exit the script. The value can be any type. */
|
|
3350
|
+
return: Record<string, unknown>;
|
|
3351
|
+
}
|
|
3352
|
+
export interface SIPRefer {
|
|
3353
|
+
/** Send SIP REFER to a SIP call. */
|
|
3354
|
+
sip_refer: {
|
|
3355
|
+
/** The SIP URI to send the REFER to. */
|
|
3356
|
+
to_uri: string;
|
|
3357
|
+
/** The HTTP or HTTPS URL to send status callback events to. */
|
|
3358
|
+
status_url?: string;
|
|
3359
|
+
/** Username to use for SIP authentication. */
|
|
3360
|
+
username?: string;
|
|
3361
|
+
/** Password to use for SIP authentication. */
|
|
3362
|
+
password?: string;
|
|
3363
|
+
};
|
|
3364
|
+
}
|
|
3365
|
+
export interface SMSWithBody {
|
|
3366
|
+
/** Phone number to send SMS message to in E.164 format. */
|
|
3367
|
+
to_number: string;
|
|
3368
|
+
/** Phone number the SMS message will be sent from in E.164 format. */
|
|
3369
|
+
from_number: string;
|
|
3370
|
+
/** Region of the world to originate the message from. Chosen based on account preferences or device location if not specified. */
|
|
3371
|
+
region?: string;
|
|
3372
|
+
/** Array of tags to associate with the message to facilitate log searches. */
|
|
3373
|
+
tags?: string[];
|
|
3374
|
+
/** Required if `media` is not present. The body of the SMS message. */
|
|
3375
|
+
body: string;
|
|
3376
|
+
}
|
|
3377
|
+
export interface SMSWithMedia {
|
|
3378
|
+
/** Phone number to send SMS message to in E.164 format. */
|
|
3379
|
+
to_number: string;
|
|
3380
|
+
/** Phone number the SMS message will be sent from in E.164 format. */
|
|
3381
|
+
from_number: string;
|
|
3382
|
+
/** Region of the world to originate the message from. Chosen based on account preferences or device location if not specified. */
|
|
3383
|
+
region?: string;
|
|
3384
|
+
/** Array of tags to associate with the message to facilitate log searches. */
|
|
3385
|
+
tags?: string[];
|
|
3386
|
+
/** Required if `body` is not present. Array of media URLs to include in the message. */
|
|
3387
|
+
media: string[];
|
|
3388
|
+
/** Optional if `media` is present. The body of the SMS message. */
|
|
3389
|
+
body?: string;
|
|
3390
|
+
}
|
|
3391
|
+
export interface SWAIG {
|
|
3392
|
+
/** Default settings for all SWAIG functions. If `defaults` is not set, settings may be set in each function object. Default is not set. */
|
|
3393
|
+
defaults?: SWAIGDefaults;
|
|
3394
|
+
/** Prebuilt functions the AI agent is able to call from this list of available native functions */
|
|
3395
|
+
native_functions?: SWAIGNativeFunction[];
|
|
3396
|
+
/** An array of objects to include remote function signatures. */
|
|
3397
|
+
includes?: SWAIGIncludes[];
|
|
3398
|
+
/** An array of JSON objects to define functions that can be executed during the interaction with the AI. Default is not set. */
|
|
3399
|
+
functions?: SWAIGFunction[];
|
|
3400
|
+
/** An object containing filler phrases for internal SWAIG functions. These fillers are played while utilizing internal functions. */
|
|
3401
|
+
internal_fillers?: SWAIGInternalFiller;
|
|
3402
|
+
}
|
|
3403
|
+
export interface SWAIGDefaults {
|
|
3404
|
+
/** Default URL to send status callbacks and reports to. Authentication can also be set in the url in the format of `username:password@url.` */
|
|
3405
|
+
web_hook_url?: string;
|
|
3406
|
+
}
|
|
3407
|
+
export type SWAIGFunction = UserSWAIGFunction | StartUpHookSWAIGFunction | HangUpHookSWAIGFunction | SummarizeConversationSWAIGFunction;
|
|
3408
|
+
export interface SWAIGIncludes {
|
|
3409
|
+
/** Remote functions to fetch and include in your AI application. */
|
|
3410
|
+
functions: string[];
|
|
3411
|
+
/** URL to fetch remote functions and include in your AI application. Authentication can also be set in the url in the format of `username:password@url`. */
|
|
3412
|
+
url: string;
|
|
3413
|
+
/** User-defined metadata to pass with the remote function request. */
|
|
3414
|
+
meta_data?: Record<string, Record<string, unknown>>;
|
|
3415
|
+
}
|
|
3416
|
+
export interface SWAIGInternalFiller {
|
|
3417
|
+
/** Filler phrases played when the AI Agent is hanging up the call. */
|
|
3418
|
+
hangup?: FunctionFillers;
|
|
3419
|
+
/** Filler phrases played when the AI Agent is checking the time. */
|
|
3420
|
+
check_time?: FunctionFillers;
|
|
3421
|
+
/** Filler phrases played when the AI Agent is waiting for user input. */
|
|
3422
|
+
wait_for_user?: FunctionFillers;
|
|
3423
|
+
/** Filler phrases played during deliberate pauses or wait periods. */
|
|
3424
|
+
wait_seconds?: FunctionFillers;
|
|
3425
|
+
/** Filler phrases played when the AI Agent is adjusting response timing. */
|
|
3426
|
+
adjust_response_latency?: FunctionFillers;
|
|
3427
|
+
/** Filler phrases played when transitioning between conversation steps when utilizing `prompt.contexts`. */
|
|
3428
|
+
next_step?: FunctionFillers;
|
|
3429
|
+
/** Filler phrases played when switching between conversation contexts when utilizing `prompt.contexts`. */
|
|
3430
|
+
change_context?: FunctionFillers;
|
|
3431
|
+
/** Filler phrases played when the AI Agent is processing visual input. This function is enabled when `enable_vision` is set to `true` in `ai.params`. */
|
|
3432
|
+
get_visual_input?: FunctionFillers;
|
|
3433
|
+
/** Filler phrases played when the AI Agent is thinking or considering options. This is utilized when `enable_thinking` is set to `true` in `ai.params`. */
|
|
3434
|
+
get_ideal_strategy?: FunctionFillers;
|
|
3435
|
+
}
|
|
3436
|
+
export interface SWAIGInternalFillerUpdate {
|
|
3437
|
+
/** Filler phrases played when the AI Agent is hanging up the call. */
|
|
3438
|
+
hangup?: FunctionFillersUpdate;
|
|
3439
|
+
/** Filler phrases played when the AI Agent is checking the time. */
|
|
3440
|
+
check_time?: FunctionFillersUpdate;
|
|
3441
|
+
/** Filler phrases played when the AI Agent is waiting for user input. */
|
|
3442
|
+
wait_for_user?: FunctionFillersUpdate;
|
|
3443
|
+
/** Filler phrases played during deliberate pauses or wait periods. */
|
|
3444
|
+
wait_seconds?: FunctionFillersUpdate;
|
|
3445
|
+
/** Filler phrases played when the AI Agent is adjusting response timing. */
|
|
3446
|
+
adjust_response_latency?: FunctionFillersUpdate;
|
|
3447
|
+
/** Filler phrases played when transitioning between conversation steps when utilizing `prompt.contexts`. */
|
|
3448
|
+
next_step?: FunctionFillersUpdate;
|
|
3449
|
+
/** Filler phrases played when switching between conversation contexts when utilizing `prompt.contexts`. */
|
|
3450
|
+
change_context?: FunctionFillersUpdate;
|
|
3451
|
+
/** Filler phrases played when the AI Agent is processing visual input. This function is enabled when `enable_vision` is set to `true` in `ai.params`. */
|
|
3452
|
+
get_visual_input?: FunctionFillersUpdate;
|
|
3453
|
+
/** Filler phrases played when the AI Agent is thinking or considering options. This is utilized when `enable_thinking` is set to `true` in `ai.params`. */
|
|
3454
|
+
get_ideal_strategy?: FunctionFillersUpdate;
|
|
3455
|
+
}
|
|
3456
|
+
export type SWAIGNativeFunction = 'check_time' | 'wait_seconds' | 'wait_for_user' | 'adjust_response_latency';
|
|
3457
|
+
export interface SWAIGUpdate {
|
|
3458
|
+
/** Default settings for all SWAIG functions. If `defaults` is not set, settings may be set in each function object. Default is not set. */
|
|
3459
|
+
defaults?: SWAIGDefaults;
|
|
3460
|
+
/** Prebuilt functions the AI agent is able to call from this list of available native functions */
|
|
3461
|
+
native_functions?: SWAIGNativeFunction[];
|
|
3462
|
+
/** An array of objects to include remote function signatures. */
|
|
3463
|
+
includes?: SWAIGIncludes[];
|
|
3464
|
+
/** An array of JSON objects to define functions that can be executed during the interaction with the AI. Default is not set. */
|
|
3465
|
+
functions?: SWAIGFunction[];
|
|
3466
|
+
/** An object containing filler phrases for internal SWAIG functions. These fillers are played while utilizing internal functions. */
|
|
3467
|
+
internal_fillers?: SWAIGInternalFillerUpdate;
|
|
3468
|
+
}
|
|
3469
|
+
export interface SWMLAction {
|
|
3470
|
+
/** A SWML object to be executed. */
|
|
3471
|
+
SWML: SWMLObject;
|
|
3472
|
+
}
|
|
3473
|
+
export type SWMLMethod = Answer | AI | AmazonBedrock | Cond | Connect | Denoise | EnterQueue | Execute | Goto | Label | LiveTranscribe | LiveTranslate | Hangup | JoinRoom | JoinConference | Play | Prompt | ReceiveFax | Record_ | RecordCall | Request | Return | SendDigits | SendFax | SendSMS | Set_ | Sleep | SIPRefer | StopDenoise | StopRecordCall | StopTap | Switch | Tap | Transfer | Unset | Pay | DetectMachine | UserEvent;
|
|
3474
|
+
export interface SWMLObject {
|
|
3475
|
+
version?: '1.0.0';
|
|
3476
|
+
sections: Section;
|
|
3477
|
+
}
|
|
3478
|
+
export interface SWMLScriptAddressListResponse {
|
|
3479
|
+
/** An array of objects that contain a list of SWML Script Addresses */
|
|
3480
|
+
data: FabricAddressApp[];
|
|
3481
|
+
/** Object containing pagination links */
|
|
3482
|
+
links: SWMLScriptAddressPaginationResponse;
|
|
3483
|
+
}
|
|
3484
|
+
export interface SWMLScriptAddressPaginationResponse {
|
|
3485
|
+
/** Link of the current page */
|
|
3486
|
+
self: string;
|
|
3487
|
+
/** Link of the first page */
|
|
3488
|
+
first: string;
|
|
3489
|
+
/** Link of the next page */
|
|
3490
|
+
next?: string;
|
|
3491
|
+
/** Link of the previous page */
|
|
3492
|
+
prev?: string;
|
|
3493
|
+
}
|
|
3494
|
+
/** A SWML variable reference for dynamic value substitution at runtime. */
|
|
3495
|
+
export type SWMLVar = string;
|
|
3496
|
+
export interface SWMLWebhook {
|
|
3497
|
+
/** Unique ID of the SWML Webhook. */
|
|
3498
|
+
id: uuid;
|
|
3499
|
+
/** Name of the SWML Webhook. */
|
|
3500
|
+
name: string;
|
|
3501
|
+
/** Used for of the SWML Webhook. */
|
|
3502
|
+
used_for: 'calling';
|
|
3503
|
+
/** Primary request url of the SWML Webhook. */
|
|
3504
|
+
primary_request_url: string;
|
|
3505
|
+
/** Primary request method of the SWML Webhook. */
|
|
3506
|
+
primary_request_method: 'GET' | 'POST';
|
|
3507
|
+
/** Fallback request url of the SWML Webhook. */
|
|
3508
|
+
fallback_request_url: string | null;
|
|
3509
|
+
/** Fallback request method of the SWML Webhook. */
|
|
3510
|
+
fallback_request_method: 'GET' | 'POST';
|
|
3511
|
+
/** Status callback url of the SWML Webhook. */
|
|
3512
|
+
status_callback_url: string | null;
|
|
3513
|
+
/** Status callback method of the SWML Webhook. */
|
|
3514
|
+
status_callback_method: 'GET' | 'POST';
|
|
3515
|
+
}
|
|
3516
|
+
export interface SWMLWebhookAddressListResponse {
|
|
3517
|
+
/** An array of objects that contain a list of SWML Webhook Addresses */
|
|
3518
|
+
data: FabricAddressApp[];
|
|
3519
|
+
/** Object containing pagination links */
|
|
3520
|
+
links: SWMLWebhookAddressPaginationResponse;
|
|
3521
|
+
}
|
|
3522
|
+
export interface SWMLWebhookAddressPaginationResponse {
|
|
3523
|
+
/** Link of the current paghe */
|
|
3524
|
+
self: string;
|
|
3525
|
+
/** Link to the first page */
|
|
3526
|
+
first: string;
|
|
3527
|
+
/** Link to the next page */
|
|
3528
|
+
next: string;
|
|
3529
|
+
/** Link to the previous page */
|
|
3530
|
+
prev?: string;
|
|
3531
|
+
}
|
|
3532
|
+
export interface SWMLWebhookCreateRequest {
|
|
3533
|
+
/** Name of the SWML Webhook. */
|
|
3534
|
+
name?: string;
|
|
3535
|
+
/** Used for of the SWML Webhook. */
|
|
3536
|
+
used_for?: 'calling';
|
|
3537
|
+
/** Primary request url of the SWML Webhook. */
|
|
3538
|
+
primary_request_url: string;
|
|
3539
|
+
/** Primary request method of the SWML Webhook. */
|
|
3540
|
+
primary_request_method?: 'GET' | 'POST';
|
|
3541
|
+
/** Fallback request url of the SWML Webhook. */
|
|
3542
|
+
fallback_request_url?: string;
|
|
3543
|
+
/** Fallback request method of the SWML Webhook. */
|
|
3544
|
+
fallback_request_method?: 'GET' | 'POST';
|
|
3545
|
+
/** Status callback url of the SWML Webhook. */
|
|
3546
|
+
status_callback_url?: string;
|
|
3547
|
+
/** Status callback method of the SWML Webhook. */
|
|
3548
|
+
status_callback_method?: 'GET' | 'POST';
|
|
3549
|
+
}
|
|
3550
|
+
export interface SWMLWebhookListResponse {
|
|
3551
|
+
/** An array of objects that contain a list of SWML Webhook data */
|
|
3552
|
+
data: SWMLWebhookResponse[];
|
|
3553
|
+
/** Object containing pagination links */
|
|
3554
|
+
links: SWMLWebhookPaginationResponse;
|
|
3555
|
+
}
|
|
3556
|
+
export interface SWMLWebhookPaginationResponse {
|
|
3557
|
+
/** Link of the current page */
|
|
3558
|
+
self: string;
|
|
3559
|
+
/** Link to the first page */
|
|
3560
|
+
first: string;
|
|
3561
|
+
/** Link to the next page */
|
|
3562
|
+
next?: string;
|
|
3563
|
+
/** Link to the previous page */
|
|
3564
|
+
prev?: string;
|
|
3565
|
+
}
|
|
3566
|
+
export interface SWMLWebhookResponse {
|
|
3567
|
+
/** Unique ID of the SWML Webhook. */
|
|
3568
|
+
id: uuid;
|
|
3569
|
+
/** Unique ID of the Project. */
|
|
3570
|
+
project_id: uuid;
|
|
3571
|
+
/** Display name of the SWML Webhook Fabric Resource */
|
|
3572
|
+
display_name: string;
|
|
3573
|
+
/** Type of the Fabric Resource */
|
|
3574
|
+
type: 'swml_webhook';
|
|
3575
|
+
/** Date and time when the resource was created. */
|
|
3576
|
+
created_at: string;
|
|
3577
|
+
/** Date and time when the resource was updated. */
|
|
3578
|
+
updated_at: string;
|
|
3579
|
+
/** SWML Webhook data. */
|
|
3580
|
+
swml_webhook: SWMLWebhook;
|
|
3581
|
+
}
|
|
3582
|
+
export interface SWMLWebhookUpdateRequest {
|
|
3583
|
+
/** Name of the SWML Webhook. */
|
|
3584
|
+
name?: string;
|
|
3585
|
+
/** Used for of the SWML Webhook. */
|
|
3586
|
+
used_for?: 'calling';
|
|
3587
|
+
/** Primary request url of the SWML Webhook. */
|
|
3588
|
+
primary_request_url?: string;
|
|
3589
|
+
/** Primary request method of the SWML Webhook. */
|
|
3590
|
+
primary_request_method?: 'GET' | 'POST';
|
|
3591
|
+
/** Fallback request url of the SWML Webhook. */
|
|
3592
|
+
fallback_request_url?: string;
|
|
3593
|
+
/** Fallback request method of the SWML Webhook. */
|
|
3594
|
+
fallback_request_method?: 'GET' | 'POST';
|
|
3595
|
+
/** Status callback url of the SWML Webhook. */
|
|
3596
|
+
status_callback_url?: string;
|
|
3597
|
+
/** Status callback method of the SWML Webhook. */
|
|
3598
|
+
status_callback_method?: 'GET' | 'POST';
|
|
3599
|
+
}
|
|
3600
|
+
export interface SayAction {
|
|
3601
|
+
/** A message to be spoken by the AI agent. */
|
|
3602
|
+
say: string;
|
|
3603
|
+
}
|
|
3604
|
+
export type SchemaType = StringProperty | IntegerProperty | NumberProperty | BooleanProperty | ArrayProperty | ObjectProperty | NullProperty | OneOfProperty | AllOfProperty | AnyOfProperty | ConstProperty;
|
|
3605
|
+
export interface Section {
|
|
3606
|
+
main: SWMLMethod[];
|
|
3607
|
+
[key: string]: SWMLMethod[];
|
|
3608
|
+
}
|
|
3609
|
+
export interface SendDigits {
|
|
3610
|
+
/** Send digit presses as DTMF tones. */
|
|
3611
|
+
send_digits: {
|
|
3612
|
+
/** The digits to send. Valid values are 0123456789*#ABCDWw. Character W is a 1 second delay, and w is a 500ms delay. */
|
|
3613
|
+
digits: string;
|
|
3614
|
+
};
|
|
3615
|
+
}
|
|
3616
|
+
export interface SendFax {
|
|
3617
|
+
/** Send a fax. */
|
|
3618
|
+
send_fax: {
|
|
3619
|
+
/** URL to the PDF document to fax. */
|
|
3620
|
+
document: string;
|
|
3621
|
+
/** Header text to include on the fax. */
|
|
3622
|
+
header_info?: string;
|
|
3623
|
+
/** Station identity to report. */
|
|
3624
|
+
identity?: string;
|
|
3625
|
+
/** http or https URL to deliver send_fax status events */
|
|
3626
|
+
status_url?: string;
|
|
3627
|
+
};
|
|
3628
|
+
}
|
|
3629
|
+
export interface SendSMS {
|
|
3630
|
+
/** Send an outbound SMS or MMS message to a PSTN phone number. */
|
|
3631
|
+
send_sms: SMSWithBody | SMSWithMedia;
|
|
3632
|
+
}
|
|
3633
|
+
export interface Set_ {
|
|
3634
|
+
/** Set script variables to the specified values. */
|
|
3635
|
+
set: Record<string, Record<string, unknown>>;
|
|
3636
|
+
}
|
|
3637
|
+
export interface SetGlobalDataAction {
|
|
3638
|
+
/** A JSON object containing any global data, as a key-value map. This action sets the data in the `global_data` to be globally referenced. */
|
|
3639
|
+
set_global_data: Record<string, Record<string, unknown>>;
|
|
3640
|
+
}
|
|
3641
|
+
export interface SetMetaDataAction {
|
|
3642
|
+
/** A JSON object containing any metadata, as a key-value map. This action sets the data in the `meta_data` to be referenced locally in the function. */
|
|
3643
|
+
set_meta_data: Record<string, Record<string, unknown>>;
|
|
3644
|
+
}
|
|
3645
|
+
export interface SipEndpoint {
|
|
3646
|
+
/** The id of the Sip Endpoint */
|
|
3647
|
+
id: uuid;
|
|
3648
|
+
/** The username of the Sip Endpoint */
|
|
3649
|
+
username: string;
|
|
3650
|
+
/** The caller ID that will showup when dialing from this Sip Endpoint */
|
|
3651
|
+
caller_id: string;
|
|
3652
|
+
/** The Sip username that will show up on the calle's side. Overrides the username. */
|
|
3653
|
+
send_as: string;
|
|
3654
|
+
/** Ciphers that can be enabled for calls on this Sip Endpoint. */
|
|
3655
|
+
ciphers: Ciphers[];
|
|
3656
|
+
/** Codecs that can be enabled for calls on this Sip Endpoint. */
|
|
3657
|
+
codecs: Codecs[];
|
|
3658
|
+
/** The set encryption type on the Sip Endpoint. */
|
|
3659
|
+
encryption: Encryption;
|
|
3660
|
+
/** Specify how the SIP endpoint will handle outbound calls. */
|
|
3661
|
+
call_handler: CallHandlerType;
|
|
3662
|
+
/** If `call_handler` is set to `resource`, this field expects the id of the set resouce. Will be `null` otherwise. */
|
|
3663
|
+
calling_handler_resource_id: uuid | null;
|
|
3664
|
+
}
|
|
3665
|
+
export interface SipEndpointAddressListResponse {
|
|
3666
|
+
/** An array of objects that contain a list of SIP Endpoint Addresses */
|
|
3667
|
+
data: FabricAddressCall[];
|
|
3668
|
+
/** Object containing pagination links */
|
|
3669
|
+
links: SipEndpointAddressPaginationResponse;
|
|
3670
|
+
}
|
|
3671
|
+
export interface SipEndpointAddressPaginationResponse {
|
|
3672
|
+
/** Link of the current page */
|
|
3673
|
+
self: string;
|
|
3674
|
+
/** Link to the first page */
|
|
3675
|
+
first: string;
|
|
3676
|
+
/** Link to the next page */
|
|
3677
|
+
next?: string;
|
|
3678
|
+
/** Link to the previous page */
|
|
3679
|
+
prev?: string;
|
|
3680
|
+
}
|
|
3681
|
+
export interface SipEndpointCreateRequest {
|
|
3682
|
+
/** The id of the Sip Endpoint */
|
|
3683
|
+
id?: uuid;
|
|
3684
|
+
/** The username of the Sip Endpoint */
|
|
3685
|
+
username: string;
|
|
3686
|
+
/** The caller ID that will showup when dialing from this Sip Endpoint */
|
|
3687
|
+
caller_id: string;
|
|
3688
|
+
/** The Sip username that will show up on the calle's side. Overrides the username. */
|
|
3689
|
+
send_as: string;
|
|
3690
|
+
/** Ciphers that can be enabled for calls on this Sip Endpoint. */
|
|
3691
|
+
ciphers: Ciphers[];
|
|
3692
|
+
/** Codecs that can be enabled for calls on this Sip Endpoint. */
|
|
3693
|
+
codecs: Codecs[];
|
|
3694
|
+
/** The set encryption type on the Sip Endpoint. */
|
|
3695
|
+
encryption: Encryption;
|
|
3696
|
+
/** Specify how the SIP endpoint will handle outbound calls. */
|
|
3697
|
+
call_handler: CallHandlerType;
|
|
3698
|
+
/** If `call_handler` is set to `resource`, this field expects the id of the set resouce. Will be `null` otherwise. */
|
|
3699
|
+
calling_handler_resource_id: uuid | null;
|
|
3700
|
+
}
|
|
3701
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
3702
|
+
export interface SipEndpointCreateStatusCode422 {
|
|
3703
|
+
/** List of validation errors. */
|
|
3704
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
3705
|
+
}
|
|
3706
|
+
export interface SipEndpointListResponse {
|
|
3707
|
+
/** An array of objects that contain a list of SIP Endpoint data */
|
|
3708
|
+
data: SipEndpointResponse[];
|
|
3709
|
+
/** Object containing pagination links */
|
|
3710
|
+
links: SipEndpointPaginationResponse;
|
|
3711
|
+
}
|
|
3712
|
+
export interface SipEndpointPaginationResponse {
|
|
3713
|
+
/** Link to the current page */
|
|
3714
|
+
self: string;
|
|
3715
|
+
/** Link to the first page */
|
|
3716
|
+
first: string;
|
|
3717
|
+
/** Link to the next page */
|
|
3718
|
+
next?: string;
|
|
3719
|
+
/** Link to the previous page */
|
|
3720
|
+
prev?: string;
|
|
3721
|
+
}
|
|
3722
|
+
export interface SipEndpointResponse {
|
|
3723
|
+
/** Unique ID of the SIP Endpoint. */
|
|
3724
|
+
id: uuid;
|
|
3725
|
+
/** Unique ID of the Project. */
|
|
3726
|
+
project_id: uuid;
|
|
3727
|
+
/** Display name of the SIP Endpoint Fabric Resource */
|
|
3728
|
+
display_name: string;
|
|
3729
|
+
/** Type of the Fabric Resource */
|
|
3730
|
+
type: 'sip_endpoint';
|
|
3731
|
+
/** Date and time when the resource was created. */
|
|
3732
|
+
created_at: string;
|
|
3733
|
+
/** Date and time when the resource was updated. */
|
|
3734
|
+
updated_at: string;
|
|
3735
|
+
/** SIP Endpoint data. */
|
|
3736
|
+
sip_endpoint: SipEndpoint;
|
|
3737
|
+
}
|
|
3738
|
+
export interface SipEndpointUpdateRequest {
|
|
3739
|
+
/** The username of the Sip Endpoint */
|
|
3740
|
+
username?: string;
|
|
3741
|
+
/** The caller ID that will showup when dialing from this Sip Endpoint */
|
|
3742
|
+
caller_id?: string;
|
|
3743
|
+
/** The Sip username that will show up on the calle's side. Overrides the username. */
|
|
3744
|
+
send_as?: string;
|
|
3745
|
+
/** Ciphers that can be enabled for calls on this Sip Endpoint. */
|
|
3746
|
+
ciphers?: Ciphers[];
|
|
3747
|
+
/** Codecs that can be enabled for calls on this Sip Endpoint. */
|
|
3748
|
+
codecs?: Codecs[];
|
|
3749
|
+
/** The set encryption type on the Sip Endpoint. */
|
|
3750
|
+
encryption?: Encryption;
|
|
3751
|
+
/** Specify how the SIP endpoint will handle outbound calls. */
|
|
3752
|
+
call_handler?: CallHandlerType;
|
|
3753
|
+
/** If `call_handler` is set to `resource`, this field will contain the id of the set resouce. Will be `null` otherwise. */
|
|
3754
|
+
calling_handler_resource_id: uuid | null;
|
|
3755
|
+
}
|
|
3756
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
3757
|
+
export interface SipEndpointUpdateStatusCode422 {
|
|
3758
|
+
/** List of validation errors. */
|
|
3759
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
3760
|
+
}
|
|
3761
|
+
export interface SipGateway {
|
|
3762
|
+
/** Unique ID of the SIP Gateway. */
|
|
3763
|
+
id: string;
|
|
3764
|
+
/** The URI for the SIP Gateway. */
|
|
3765
|
+
uri: string;
|
|
3766
|
+
/** Display name of the SIP Gateway. */
|
|
3767
|
+
name: string;
|
|
3768
|
+
/** List of supported SIP ciphers. */
|
|
3769
|
+
ciphers: Ciphers[];
|
|
3770
|
+
/** List of supported codecs. */
|
|
3771
|
+
codecs: Codecs[];
|
|
3772
|
+
/** Specifies the encryption requirement. */
|
|
3773
|
+
encryption: Encryption;
|
|
3774
|
+
}
|
|
3775
|
+
export interface SipGatewayAddressListResponse {
|
|
3776
|
+
/** An array of objects containing a list of SIP Gateway Addresses */
|
|
3777
|
+
data: FabricAddressCall[];
|
|
3778
|
+
/** Object containing pagination links */
|
|
3779
|
+
links: SipGatewayAddressPaginationResponse;
|
|
3780
|
+
}
|
|
3781
|
+
export interface SipGatewayAddressPaginationResponse {
|
|
3782
|
+
/** Link of the current page */
|
|
3783
|
+
self: string;
|
|
3784
|
+
/** Link to the first page */
|
|
3785
|
+
first: string;
|
|
3786
|
+
/** Link to the next page */
|
|
3787
|
+
next?: string;
|
|
3788
|
+
/** Link to the previous page */
|
|
3789
|
+
prev?: string;
|
|
3790
|
+
}
|
|
3791
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
3792
|
+
export interface SipGatewayCreateStatusCode422 {
|
|
3793
|
+
/** List of validation errors. */
|
|
3794
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
3795
|
+
}
|
|
3796
|
+
export interface SipGatewayListResponse {
|
|
3797
|
+
/** An array of objects that contain a list of SIP Gateway data */
|
|
3798
|
+
data: SipGatewayResponse[];
|
|
3799
|
+
/** Pagination links for the response. */
|
|
3800
|
+
links: SipGatewayPaginationResponse;
|
|
3801
|
+
}
|
|
3802
|
+
export interface SipGatewayPaginationResponse {
|
|
3803
|
+
/** Link to the current page of results */
|
|
3804
|
+
self: string;
|
|
3805
|
+
/** Link to the first page of results */
|
|
3806
|
+
first: string;
|
|
3807
|
+
/** Link to the next page of results */
|
|
3808
|
+
next?: string;
|
|
3809
|
+
/** Link to the previous page of results */
|
|
3810
|
+
prev?: string;
|
|
3811
|
+
}
|
|
3812
|
+
export interface SipGatewayRequest {
|
|
3813
|
+
/** Display name for the SIP Gateway. */
|
|
3814
|
+
name: string;
|
|
3815
|
+
/** External SIP URI. */
|
|
3816
|
+
uri: string;
|
|
3817
|
+
/** Specifies the encryption requirement for the SIP connection. */
|
|
3818
|
+
encryption: Encryption;
|
|
3819
|
+
/** List of supported SIP ciphers. */
|
|
3820
|
+
ciphers: Ciphers[];
|
|
3821
|
+
/** List of supported codecs for media transmission. */
|
|
3822
|
+
codecs: Codecs[];
|
|
3823
|
+
}
|
|
3824
|
+
export interface SipGatewayRequestUpdate {
|
|
3825
|
+
/** Display name for the SIP Gateway. */
|
|
3826
|
+
name?: string;
|
|
3827
|
+
/** External SIP URI. */
|
|
3828
|
+
uri?: string;
|
|
3829
|
+
/** Specifies the encryption requirement for the SIP connection. */
|
|
3830
|
+
encryption?: Encryption;
|
|
3831
|
+
/** List of supported SIP ciphers. */
|
|
3832
|
+
ciphers?: Ciphers[];
|
|
3833
|
+
/** List of supported codecs for media transmission. */
|
|
3834
|
+
codecs?: Codecs[];
|
|
3835
|
+
}
|
|
3836
|
+
export interface SipGatewayResponse {
|
|
3837
|
+
/** Unique ID of the resource. */
|
|
3838
|
+
id: string;
|
|
3839
|
+
/** Project ID associated with the resource. */
|
|
3840
|
+
project_id: string;
|
|
3841
|
+
/** Display name of the SIP Gateway. */
|
|
3842
|
+
display_name: string;
|
|
3843
|
+
/** Type of the resource. */
|
|
3844
|
+
type: 'sip_gateway';
|
|
3845
|
+
/** Timestamp when the resource was created. */
|
|
3846
|
+
created_at: string;
|
|
3847
|
+
/** Timestamp when the resource was last updated. */
|
|
3848
|
+
updated_at: string;
|
|
3849
|
+
/** SIP Gateway configuration details. */
|
|
3850
|
+
sip_gateway: SipGateway;
|
|
3851
|
+
}
|
|
3852
|
+
export interface Sleep {
|
|
3853
|
+
/** Pause execution for a specified duration. */
|
|
3854
|
+
sleep: {
|
|
3855
|
+
/** The amount of time to sleep in milliseconds. */
|
|
3856
|
+
duration: number | SWMLVar;
|
|
3857
|
+
} | number | SWMLVar;
|
|
3858
|
+
}
|
|
3859
|
+
/** Speech recognition engine options. */
|
|
3860
|
+
export type SpeechEngine = 'deepgram' | 'google';
|
|
3861
|
+
export interface StartAction {
|
|
3862
|
+
/** Starts live translation of the call. The translation will be sent to the specified URL. */
|
|
3863
|
+
start: {
|
|
3864
|
+
/** The webhook URL to be called. */
|
|
3865
|
+
webhook?: string;
|
|
3866
|
+
/** The language to translate from. */
|
|
3867
|
+
from_lang: string;
|
|
3868
|
+
/** The language to translate to. */
|
|
3869
|
+
to_lang: string;
|
|
3870
|
+
/** The TTS voice you want to use for the source language. */
|
|
3871
|
+
from_voice?: string;
|
|
3872
|
+
/** The TTS voice you want to use for the target language. */
|
|
3873
|
+
to_voice?: string;
|
|
3874
|
+
/** Translation filter for the source language direction. */
|
|
3875
|
+
filter_from?: TranslationFilterPreset | CustomTranslationFilter;
|
|
3876
|
+
/** Translation filter for the target language direction. */
|
|
3877
|
+
filter_to?: TranslationFilterPreset | CustomTranslationFilter;
|
|
3878
|
+
/** Whether to enable live events. */
|
|
3879
|
+
live_events?: boolean | SWMLVar;
|
|
3880
|
+
/** Whether to enable AI summarization. */
|
|
3881
|
+
ai_summary?: boolean | SWMLVar;
|
|
3882
|
+
/** The timeout for speech recognition in milliseconds. */
|
|
3883
|
+
speech_timeout?: number | SWMLVar;
|
|
3884
|
+
/** Voice activity detection silence time in milliseconds. Default depends on speech engine: `300` for Deepgram, `500` for Google. */
|
|
3885
|
+
vad_silence_ms?: number | SWMLVar;
|
|
3886
|
+
/** Voice activity detection threshold (0-1800). */
|
|
3887
|
+
vad_thresh?: number | SWMLVar;
|
|
3888
|
+
/** Debug level for logging (0-2). */
|
|
3889
|
+
debug_level?: number | SWMLVar;
|
|
3890
|
+
/** The direction of the call that should be translated. */
|
|
3891
|
+
direction: TranslateDirection[];
|
|
3892
|
+
/** The speech engine to use for speech recognition. */
|
|
3893
|
+
speech_engine?: SpeechEngine;
|
|
3894
|
+
/** The AI prompt that instructs how to summarize the conversation when `ai_summary` is enabled. */
|
|
3895
|
+
ai_summary_prompt?: string;
|
|
3896
|
+
};
|
|
3897
|
+
}
|
|
3898
|
+
export interface StartUpHookSWAIGFunction {
|
|
3899
|
+
/** A description of the context and purpose of the function, to explain to the agent when to use it. */
|
|
3900
|
+
description: string;
|
|
3901
|
+
/** The purpose field has been deprecated and is replaced by the `description` field. */
|
|
3902
|
+
purpose?: string;
|
|
3903
|
+
/** A JSON object that defines the expected user input parameters and their validation rules for the function. */
|
|
3904
|
+
parameters?: FunctionParameters;
|
|
3905
|
+
/** A JSON object defining the fillers that should be played when calling a `swaig function`. This helps the AI break silence between responses. The filler is played asynchronously during the function call. */
|
|
3906
|
+
fillers?: FunctionFillers;
|
|
3907
|
+
/** The argument field has been deprecated and is replaced by the `parameters` field. */
|
|
3908
|
+
argument?: FunctionParameters;
|
|
3909
|
+
/** Whether the function is active. **Default:** `true`. */
|
|
3910
|
+
active?: boolean | SWMLVar;
|
|
3911
|
+
/** A powerful and flexible environmental variable which can accept arbitrary data that is set initially in the SWML script or from the SWML set_meta_data action. */
|
|
3912
|
+
meta_data?: Record<string, Record<string, unknown>>;
|
|
3913
|
+
/** Scoping token for meta_data. If not supplied, metadata will be scoped to function's `web_hook_url`. Default is set by SignalWire. */
|
|
3914
|
+
meta_data_token?: string;
|
|
3915
|
+
/** An object that processes function inputs and executes operations through expressions, webhooks, or direct output. */
|
|
3916
|
+
data_map?: DataMap;
|
|
3917
|
+
/** Skips the top-level fillers specified in `ai.languages` (which includes `speech_fillers` and `function_fillers`). */
|
|
3918
|
+
skip_fillers?: boolean | SWMLVar;
|
|
3919
|
+
/** Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` */
|
|
3920
|
+
web_hook_url?: string;
|
|
3921
|
+
/** A file to play while the function is running. `wait_file_loops` can specify the amount of times that files should continously play. Default is not set. */
|
|
3922
|
+
wait_file?: string;
|
|
3923
|
+
/** The number of times to loop playing the file. Default is not set. */
|
|
3924
|
+
wait_file_loops?: number | string;
|
|
3925
|
+
/** Whether to wait for fillers to finish playing before continuing with the function. **Default:** `false`. */
|
|
3926
|
+
wait_for_fillers?: boolean | SWMLVar;
|
|
3927
|
+
/** A unique name for the function. This can be any user-defined string or can reference a reserved function. Reserved functions are SignalWire functions that will be executed at certain points in the conversation. For the start_hook function, the function name is 'start_hook'. */
|
|
3928
|
+
function: 'startup_hook';
|
|
3929
|
+
}
|
|
3930
|
+
export interface StopAction {
|
|
3931
|
+
/** Whether to stop the conversation. */
|
|
3932
|
+
stop: boolean | SWMLVar;
|
|
3933
|
+
}
|
|
3934
|
+
export interface StopDenoise {
|
|
3935
|
+
/** Stop noise reduction that was started with denoise. */
|
|
3936
|
+
stop_denoise: Record<string, unknown>;
|
|
3937
|
+
}
|
|
3938
|
+
export interface StopPlaybackBGAction {
|
|
3939
|
+
/** Whether to stop the background audio file. */
|
|
3940
|
+
stop_playback_bg: boolean | SWMLVar;
|
|
3941
|
+
}
|
|
3942
|
+
export interface StopRecordCall {
|
|
3943
|
+
/** Stop an active background recording. */
|
|
3944
|
+
stop_record_call: {
|
|
3945
|
+
/** Identifier for the recording to stop. */
|
|
3946
|
+
control_id?: string;
|
|
3947
|
+
};
|
|
3948
|
+
}
|
|
3949
|
+
export interface StopTap {
|
|
3950
|
+
/** Stop an active tap stream. */
|
|
3951
|
+
stop_tap: {
|
|
3952
|
+
/** ID of the tap to stop. */
|
|
3953
|
+
control_id?: string;
|
|
3954
|
+
};
|
|
3955
|
+
}
|
|
3956
|
+
export type StringFormat = 'date_time' | 'time' | 'date' | 'duration' | 'email' | 'hostname' | 'ipv4' | 'ipv6' | 'uri' | 'uuid';
|
|
3957
|
+
/** Base interface for all property types */
|
|
3958
|
+
export interface StringProperty {
|
|
3959
|
+
/** A description of the property. */
|
|
3960
|
+
description?: string;
|
|
3961
|
+
/** Whether the property can be null. */
|
|
3962
|
+
nullable?: boolean | SWMLVar;
|
|
3963
|
+
/** The type of parameter(s) the AI is passing to the function. */
|
|
3964
|
+
type: 'string';
|
|
3965
|
+
/** An array of strings that are the possible values */
|
|
3966
|
+
enum?: string[];
|
|
3967
|
+
/** The default string value */
|
|
3968
|
+
default?: string;
|
|
3969
|
+
/** Regular expression pattern */
|
|
3970
|
+
pattern?: string;
|
|
3971
|
+
/** String format (email, date-time, etc.) */
|
|
3972
|
+
format?: StringFormat;
|
|
3973
|
+
}
|
|
3974
|
+
export interface Subscriber {
|
|
3975
|
+
/** Unique ID of the Subscriber. */
|
|
3976
|
+
id: uuid;
|
|
3977
|
+
/** Email of the Subscriber. */
|
|
3978
|
+
email: string;
|
|
3979
|
+
/** First name of the Subscriber. */
|
|
3980
|
+
first_name: string;
|
|
3981
|
+
/** Last name of the Subscriber. */
|
|
3982
|
+
last_name: string;
|
|
3983
|
+
/** Display name of the Subscriber. */
|
|
3984
|
+
display_name: string;
|
|
3985
|
+
/** Job title of the Subscriber. */
|
|
3986
|
+
job_title: string;
|
|
3987
|
+
/** Timezone of the Subscriber. */
|
|
3988
|
+
timezone: string;
|
|
3989
|
+
/** Country of the Subscriber. */
|
|
3990
|
+
country: string;
|
|
3991
|
+
/** Region of the Subscriber. */
|
|
3992
|
+
region: string;
|
|
3993
|
+
/** Company name of the Subscriber. */
|
|
3994
|
+
company_name: string;
|
|
3995
|
+
}
|
|
3996
|
+
export interface SubscriberAddressPaginationResponse {
|
|
3997
|
+
/** Link of the current page */
|
|
3998
|
+
self: string;
|
|
3999
|
+
/** Link to the first page */
|
|
4000
|
+
first: string;
|
|
4001
|
+
/** Link to the next page */
|
|
4002
|
+
next?: string;
|
|
4003
|
+
/** Link of the previous page */
|
|
4004
|
+
prev?: string;
|
|
4005
|
+
}
|
|
4006
|
+
export interface SubscriberAddressesResponse {
|
|
4007
|
+
/** An array of objects that contain a list of Subscriber addresses */
|
|
4008
|
+
data: FabricAddressSubscriber[];
|
|
4009
|
+
/** Object containing pagination links */
|
|
4010
|
+
links: SubscriberAddressPaginationResponse;
|
|
4011
|
+
}
|
|
4012
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
4013
|
+
export interface SubscriberCreateStatusCode422 {
|
|
4014
|
+
/** List of validation errors. */
|
|
4015
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
4016
|
+
}
|
|
4017
|
+
export interface SubscriberGuestTokenCreateRequest {
|
|
4018
|
+
/** List of up to 10 UUIDs representing the allowed Fabric addresses. */
|
|
4019
|
+
allowed_addresses: uuid[];
|
|
4020
|
+
/** A unixtime (the number of seconds since 1970-01-01 00:00:00) at which the token should no longer be valid. Defaults to 'two hours from now' */
|
|
4021
|
+
expire_at?: number;
|
|
4022
|
+
}
|
|
4023
|
+
export interface SubscriberGuestTokenCreateResponse {
|
|
4024
|
+
/** Guest Token */
|
|
4025
|
+
token: jwt;
|
|
4026
|
+
/** Refresh Token */
|
|
4027
|
+
refresh_token: jwt;
|
|
4028
|
+
}
|
|
4029
|
+
export interface SubscriberInviteTokenCreateRequest {
|
|
4030
|
+
/** Unique ID of a Subscriber Address */
|
|
4031
|
+
address_id: uuid;
|
|
4032
|
+
/** A unixtime (the number of seconds since 1970-01-01 00:00:00) at which the token should no longer be valid. Defaults to 'two hours from now' */
|
|
4033
|
+
expires_at?: number;
|
|
4034
|
+
}
|
|
4035
|
+
export interface SubscriberInviteTokenCreateResponse {
|
|
4036
|
+
/** Invite Token */
|
|
4037
|
+
token: jwt;
|
|
4038
|
+
}
|
|
4039
|
+
export interface SubscriberListResponse {
|
|
4040
|
+
/** An array of objects that contain a list of Subscriber data */
|
|
4041
|
+
data: SubscriberResponse[];
|
|
4042
|
+
/** Object containing pagination links */
|
|
4043
|
+
links: SubscriberPaginationResponse;
|
|
4044
|
+
}
|
|
4045
|
+
export interface SubscriberPaginationResponse {
|
|
4046
|
+
/** Link of the current page */
|
|
4047
|
+
self: string;
|
|
4048
|
+
/** Link to the first page */
|
|
4049
|
+
first: string;
|
|
4050
|
+
/** Link to the next page */
|
|
4051
|
+
next?: string;
|
|
4052
|
+
/** Link to the previous page */
|
|
4053
|
+
prev?: string;
|
|
4054
|
+
}
|
|
4055
|
+
export interface SubscriberRefreshTokenRequest {
|
|
4056
|
+
/** The refresh token previously issued alongside a subscriber access token. This token is used to request a new access token. */
|
|
4057
|
+
refresh_token: jwt;
|
|
4058
|
+
}
|
|
4059
|
+
export interface SubscriberRefreshTokenResponse {
|
|
4060
|
+
/** A newly generated subscriber access token, valid for 2 hours. */
|
|
4061
|
+
token: jwt;
|
|
4062
|
+
/** A new refresh token, valid for 2 hours and 5 minutes. */
|
|
4063
|
+
refresh_token: jwt;
|
|
4064
|
+
}
|
|
4065
|
+
export interface SubscriberRequest {
|
|
4066
|
+
/** Password of the Subscriber. Defaults to a secure random password if not provided. */
|
|
4067
|
+
password?: string;
|
|
4068
|
+
/** Email of the Subscriber. */
|
|
4069
|
+
email: string;
|
|
4070
|
+
/** First name of the Subscriber. */
|
|
4071
|
+
first_name?: string;
|
|
4072
|
+
/** Last name of the Subscriber. */
|
|
4073
|
+
last_name?: string;
|
|
4074
|
+
/** Display name of the Subscriber. */
|
|
4075
|
+
display_name?: string;
|
|
4076
|
+
/** Job title of the Subscriber. */
|
|
4077
|
+
job_title?: string;
|
|
4078
|
+
/** Timezone of the Subscriber. */
|
|
4079
|
+
timezone?: string;
|
|
4080
|
+
/** Country of the Subscriber. */
|
|
4081
|
+
country?: string;
|
|
4082
|
+
/** Region of the Subscriber. */
|
|
4083
|
+
region?: string;
|
|
4084
|
+
/** Company name of the Subscriber. */
|
|
4085
|
+
company_name?: string;
|
|
4086
|
+
}
|
|
4087
|
+
export interface SubscriberResponse {
|
|
4088
|
+
/** Unique ID of the request. */
|
|
4089
|
+
id: string;
|
|
4090
|
+
/** Unique ID of the project. */
|
|
4091
|
+
project_id: string;
|
|
4092
|
+
/** Display name of the Subscriber. */
|
|
4093
|
+
display_name: string;
|
|
4094
|
+
/** Type of the resource. */
|
|
4095
|
+
type: 'subscriber';
|
|
4096
|
+
/** Date and time when the resource was created. */
|
|
4097
|
+
created_at: string;
|
|
4098
|
+
/** Date and time when the resource was updated. */
|
|
4099
|
+
updated_at: string;
|
|
4100
|
+
/** Subscriber data. */
|
|
4101
|
+
subscriber: Subscriber;
|
|
4102
|
+
}
|
|
4103
|
+
export interface SubscriberSIPEndpoint {
|
|
4104
|
+
/** Unique ID of the Sip Endpoint. */
|
|
4105
|
+
id: uuid;
|
|
4106
|
+
/** Username of the Sip Endpoint. */
|
|
4107
|
+
username: string;
|
|
4108
|
+
/** Caller ID of the Sip Endpoint. */
|
|
4109
|
+
caller_id: string;
|
|
4110
|
+
/** Purchased or verified number */
|
|
4111
|
+
send_as: string;
|
|
4112
|
+
/** Ciphers of the Sip Endpoint. */
|
|
4113
|
+
ciphers: Ciphers[];
|
|
4114
|
+
/** Codecs of the Sip Endpoint. */
|
|
4115
|
+
codecs: Codecs[];
|
|
4116
|
+
/** Encryption requirement of the Sip Endpoint. */
|
|
4117
|
+
encryption: Encryption;
|
|
4118
|
+
}
|
|
4119
|
+
export interface SubscriberSipEndpointListResponse {
|
|
4120
|
+
data: SubscriberSIPEndpoint[];
|
|
4121
|
+
links: SubscriberSipEndpointPaginationResponse;
|
|
4122
|
+
}
|
|
4123
|
+
export interface SubscriberSipEndpointPaginationResponse {
|
|
4124
|
+
/** Link of the current page */
|
|
4125
|
+
self: string;
|
|
4126
|
+
/** Link to the first page */
|
|
4127
|
+
first: string;
|
|
4128
|
+
/** Link to the next page */
|
|
4129
|
+
next?: string;
|
|
4130
|
+
/** The link to the previous page */
|
|
4131
|
+
prev?: string;
|
|
4132
|
+
}
|
|
4133
|
+
export interface SubscriberSipEndpointRequest {
|
|
4134
|
+
/** Username of the Sip Endpoint. */
|
|
4135
|
+
username: string;
|
|
4136
|
+
/** Password of the Sip Endpoint. */
|
|
4137
|
+
password: string;
|
|
4138
|
+
/** Caller ID of the Sip Endpoint. */
|
|
4139
|
+
caller_id?: string;
|
|
4140
|
+
/** The Number to send as. */
|
|
4141
|
+
send_as?: string;
|
|
4142
|
+
/** Ciphers of the Sip Endpoint. */
|
|
4143
|
+
ciphers?: Ciphers[];
|
|
4144
|
+
/** Codecs of the Sip Endpoint. */
|
|
4145
|
+
codecs?: Codecs[];
|
|
4146
|
+
/** Encryption requirement of the Sip Endpoint. */
|
|
4147
|
+
encryption?: Encryption;
|
|
4148
|
+
}
|
|
4149
|
+
export interface SubscriberSipEndpointRequestUpdate {
|
|
4150
|
+
/** Username of the Sip Endpoint. */
|
|
4151
|
+
username?: string;
|
|
4152
|
+
/** Password of the Sip Endpoint. */
|
|
4153
|
+
password?: string;
|
|
4154
|
+
/** Caller ID of the Sip Endpoint. */
|
|
4155
|
+
caller_id?: string;
|
|
4156
|
+
/** The Number to send as. */
|
|
4157
|
+
send_as?: string;
|
|
4158
|
+
/** Ciphers of the Sip Endpoint. */
|
|
4159
|
+
ciphers?: Ciphers[];
|
|
4160
|
+
/** Codecs of the Sip Endpoint. */
|
|
4161
|
+
codecs?: Codecs[];
|
|
4162
|
+
/** Encryption requirement of the Sip Endpoint. */
|
|
4163
|
+
encryption?: Encryption;
|
|
4164
|
+
}
|
|
4165
|
+
export interface SubscriberTokenRequest {
|
|
4166
|
+
/** A string that uniquely identifies the subscriber. Often it's an email, but can be any other string. */
|
|
4167
|
+
reference: string;
|
|
4168
|
+
/** A unixtime (the number of seconds since 1970-01-01 00:00:00) at which the token should no longer be valid. Defaults to 'two hours from now' */
|
|
4169
|
+
expire_at?: number;
|
|
4170
|
+
/** The ID of the application that the token is associated with. */
|
|
4171
|
+
application_id?: uuid;
|
|
4172
|
+
/** Set or update the subscriber's password. Omit this field or pass an empty string if you don't want to update the password. */
|
|
4173
|
+
password?: string;
|
|
4174
|
+
/** Set or update the first name of the subscriber. */
|
|
4175
|
+
first_name?: string;
|
|
4176
|
+
/** Set or update the last name of the subscriber. */
|
|
4177
|
+
last_name?: string;
|
|
4178
|
+
/** Set or update the display name of the subscriber. */
|
|
4179
|
+
display_name?: string;
|
|
4180
|
+
/** Set or update the job title of the subscriber. */
|
|
4181
|
+
job_title?: string;
|
|
4182
|
+
/** Set or update the time zone of the subscriber. */
|
|
4183
|
+
time_zone?: string;
|
|
4184
|
+
/** Set or update the country of the subscriber. */
|
|
4185
|
+
country?: string;
|
|
4186
|
+
/** Set or update the region of the subscriber. */
|
|
4187
|
+
region?: string;
|
|
4188
|
+
/** Set or update the company name of the subscriber. */
|
|
4189
|
+
company_name?: string;
|
|
4190
|
+
}
|
|
4191
|
+
export interface SubscriberTokenResponse {
|
|
4192
|
+
/** The ID of the subscriber that the token is associated with. */
|
|
4193
|
+
subscriber_id: uuid;
|
|
4194
|
+
/** The token that is associated with the subscriber. */
|
|
4195
|
+
token: jwt;
|
|
4196
|
+
/** Refresh token. */
|
|
4197
|
+
refresh_token: jwt;
|
|
4198
|
+
}
|
|
4199
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
4200
|
+
export interface SubscriberTokenStatusCode422 {
|
|
4201
|
+
/** List of validation errors. */
|
|
4202
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
4203
|
+
}
|
|
4204
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
4205
|
+
export interface SubscriberUpdateStatusCode422 {
|
|
4206
|
+
/** List of validation errors. */
|
|
4207
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
4208
|
+
}
|
|
4209
|
+
export interface SummarizeAction {
|
|
4210
|
+
/** Summarizes the conversation as an object, allowing you to specify the webhook url and prompt for the summary. */
|
|
4211
|
+
summarize: {
|
|
4212
|
+
/** The webhook URL to be called. */
|
|
4213
|
+
webhook?: string;
|
|
4214
|
+
/** The AI prompt that instructs how to summarize the conversation. */
|
|
4215
|
+
prompt?: string;
|
|
4216
|
+
};
|
|
4217
|
+
}
|
|
4218
|
+
export type SummarizeActionUnion = SummarizeAction | 'summarize';
|
|
4219
|
+
/** An internal reserved function that generates a summary of the conversation and sends any specified properties to the configured webhook after the conversation has ended. */
|
|
4220
|
+
export interface SummarizeConversationSWAIGFunction {
|
|
4221
|
+
/** A description of the context and purpose of the function, to explain to the agent when to use it. */
|
|
4222
|
+
description: string;
|
|
4223
|
+
/** The purpose field has been deprecated and is replaced by the `description` field. */
|
|
4224
|
+
purpose?: string;
|
|
4225
|
+
/** A JSON object that defines the expected user input parameters and their validation rules for the function. */
|
|
4226
|
+
parameters?: FunctionParameters;
|
|
4227
|
+
/** A JSON object defining the fillers that should be played when calling a `swaig function`. This helps the AI break silence between responses. The filler is played asynchronously during the function call. */
|
|
4228
|
+
fillers?: FunctionFillers;
|
|
4229
|
+
/** The argument field has been deprecated and is replaced by the `parameters` field. */
|
|
4230
|
+
argument?: FunctionParameters;
|
|
4231
|
+
/** Whether the function is active. **Default:** `true`. */
|
|
4232
|
+
active?: boolean | SWMLVar;
|
|
4233
|
+
/** A powerful and flexible environmental variable which can accept arbitrary data that is set initially in the SWML script or from the SWML set_meta_data action. */
|
|
4234
|
+
meta_data?: Record<string, Record<string, unknown>>;
|
|
4235
|
+
/** Scoping token for meta_data. If not supplied, metadata will be scoped to function's `web_hook_url`. Default is set by SignalWire. */
|
|
4236
|
+
meta_data_token?: string;
|
|
4237
|
+
/** An object that processes function inputs and executes operations through expressions, webhooks, or direct output. */
|
|
4238
|
+
data_map?: DataMap;
|
|
4239
|
+
/** Skips the top-level fillers specified in `ai.languages` (which includes `speech_fillers` and `function_fillers`). */
|
|
4240
|
+
skip_fillers?: boolean | SWMLVar;
|
|
4241
|
+
/** Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` */
|
|
4242
|
+
web_hook_url?: string;
|
|
4243
|
+
/** A file to play while the function is running. `wait_file_loops` can specify the amount of times that files should continously play. Default is not set. */
|
|
4244
|
+
wait_file?: string;
|
|
4245
|
+
/** The number of times to loop playing the file. Default is not set. */
|
|
4246
|
+
wait_file_loops?: number | string;
|
|
4247
|
+
/** Whether to wait for fillers to finish playing before continuing with the function. **Default:** `false`. */
|
|
4248
|
+
wait_for_fillers?: boolean | SWMLVar;
|
|
4249
|
+
/** A unique name for the function. This can be any user-defined string or can reference a reserved function. Reserved functions are SignalWire functions that will be executed at certain points in the conversation.. For the summarize_conversation function, the function name is 'summarize_conversation'. */
|
|
4250
|
+
function: 'summarize_conversation';
|
|
4251
|
+
}
|
|
4252
|
+
export interface Switch {
|
|
4253
|
+
/** Execute different instructions based on a variable's value. */
|
|
4254
|
+
switch: {
|
|
4255
|
+
/** Name of the variable whose value needs to be compared. */
|
|
4256
|
+
variable: string;
|
|
4257
|
+
/** Object of key-mapped values to array of SWML methods to execute. */
|
|
4258
|
+
case: Record<string, SWMLMethod[]>;
|
|
4259
|
+
/** Array of SWML methods to execute if no cases match. */
|
|
4260
|
+
default?: SWMLMethod[];
|
|
4261
|
+
};
|
|
4262
|
+
}
|
|
4263
|
+
export interface SwmlScript {
|
|
4264
|
+
/** Unique ID of a SWML Script. */
|
|
4265
|
+
id: uuid;
|
|
4266
|
+
/** The SWML script contents */
|
|
4267
|
+
contents: string;
|
|
4268
|
+
/** The url where the SWML script is hosted at. */
|
|
4269
|
+
request_url: string;
|
|
4270
|
+
/** The displayed name of the SWML scipt */
|
|
4271
|
+
display_name: string;
|
|
4272
|
+
/** URL to send status callbacks to */
|
|
4273
|
+
status_callback_url?: string;
|
|
4274
|
+
/** HTTP method to use for status callbacks */
|
|
4275
|
+
status_callback_method?: 'POST';
|
|
4276
|
+
}
|
|
4277
|
+
export interface SwmlScriptCreateRequest {
|
|
4278
|
+
/** Display name of the SWML Script */
|
|
4279
|
+
name: string;
|
|
4280
|
+
/** The contents of the SWML script. */
|
|
4281
|
+
contents: string;
|
|
4282
|
+
/** URL to send status callbacks to */
|
|
4283
|
+
status_callback_url?: string;
|
|
4284
|
+
}
|
|
4285
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
4286
|
+
export interface SwmlScriptCreateStatusCode422 {
|
|
4287
|
+
/** List of validation errors. */
|
|
4288
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
4289
|
+
}
|
|
4290
|
+
export interface SwmlScriptListResponse {
|
|
4291
|
+
/** An array of objects that contain a list of SWML Script data */
|
|
4292
|
+
data: SwmlScriptResponse[];
|
|
4293
|
+
/** Object containing pagination links */
|
|
4294
|
+
links: SwmlScriptPaginationresponse;
|
|
4295
|
+
}
|
|
4296
|
+
export interface SwmlScriptPaginationresponse {
|
|
4297
|
+
/** Link to the current page */
|
|
4298
|
+
self: string;
|
|
4299
|
+
/** Link to the first page */
|
|
4300
|
+
first: string;
|
|
4301
|
+
/** Link to the next page */
|
|
4302
|
+
next?: string;
|
|
4303
|
+
/** Link to the previous page */
|
|
4304
|
+
prev?: string;
|
|
4305
|
+
}
|
|
4306
|
+
export interface SwmlScriptResponse {
|
|
4307
|
+
/** Unique ID of the SWML Script. */
|
|
4308
|
+
id: uuid;
|
|
4309
|
+
/** Unique ID of the Project. */
|
|
4310
|
+
project_id: uuid;
|
|
4311
|
+
/** Display name of the SWML Script Fabric Resource */
|
|
4312
|
+
display_name: string;
|
|
4313
|
+
/** Type of the Fabric Resource */
|
|
4314
|
+
type: 'swml_script';
|
|
4315
|
+
/** Date and time when the resource was created. */
|
|
4316
|
+
created_at: string;
|
|
4317
|
+
/** Date and time when the resource was updated. */
|
|
4318
|
+
updated_at: string;
|
|
4319
|
+
/** SWML Script data. */
|
|
4320
|
+
swml_script: SwmlScript;
|
|
4321
|
+
}
|
|
4322
|
+
export interface SwmlScriptUpdateRequest {
|
|
4323
|
+
/** Display name of the SWML Script */
|
|
4324
|
+
display_name?: string;
|
|
4325
|
+
/** The contents of the SWML script. */
|
|
4326
|
+
contents?: string;
|
|
4327
|
+
/** URL to send status callbacks to */
|
|
4328
|
+
status_callback_url?: string;
|
|
4329
|
+
}
|
|
4330
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
4331
|
+
export interface SwmlScriptUpdateStatusCode422 {
|
|
4332
|
+
/** List of validation errors. */
|
|
4333
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
4334
|
+
}
|
|
4335
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
4336
|
+
export interface SwmlWebhookCreateStatusCode422 {
|
|
4337
|
+
/** List of validation errors. */
|
|
4338
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
4339
|
+
}
|
|
4340
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
4341
|
+
export interface SwmlWebhookUpdateStatusCode422 {
|
|
4342
|
+
/** List of validation errors. */
|
|
4343
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
4344
|
+
}
|
|
4345
|
+
export interface Tap {
|
|
4346
|
+
/** Start background call tap. Media is streamed over Websocket or RTP to customer controlled URI. */
|
|
4347
|
+
tap: {
|
|
4348
|
+
/** Destination of the tap media stream: rtp://IP:port, ws://example.com, or wss://example.com. */
|
|
4349
|
+
uri: string;
|
|
4350
|
+
/** Identifier for this tap to use with `stop_tap`. */
|
|
4351
|
+
control_id?: string;
|
|
4352
|
+
/** Direction of the audio to tap: */
|
|
4353
|
+
direction?: 'speak' | 'listen' | 'both';
|
|
4354
|
+
/** Codec to use for the tap media stream. */
|
|
4355
|
+
codec?: 'PCMU' | 'PCMA';
|
|
4356
|
+
/** If `uri` is a `rtp://` this will set the packetization time of the media in milliseconds. */
|
|
4357
|
+
rtp_ptime?: number | SWMLVar;
|
|
4358
|
+
/** http or https URL to deliver tap status events */
|
|
4359
|
+
status_url?: string;
|
|
4360
|
+
};
|
|
4361
|
+
}
|
|
4362
|
+
export interface ToggleFunctionsAction {
|
|
4363
|
+
/** Whether to toggle the functions on or off. */
|
|
4364
|
+
toggle_functions: {
|
|
4365
|
+
/** Whether to activate or deactivate the functions. Default is `true` */
|
|
4366
|
+
active: boolean | SWMLVar;
|
|
4367
|
+
/** The function names to toggle. */
|
|
4368
|
+
function: string | string[];
|
|
4369
|
+
}[];
|
|
4370
|
+
}
|
|
4371
|
+
export type TranscribeAction = TranscribeStartAction | 'stop' | TranscribeSummarizeActionUnion;
|
|
4372
|
+
export type TranscribeDirection = 'remote-caller' | 'local-caller';
|
|
4373
|
+
export interface TranscribeStartAction {
|
|
4374
|
+
/** Starts live transcription of the call. The transcription will be sent to the specified URL. */
|
|
4375
|
+
start: {
|
|
4376
|
+
/** Enables AI summarization of the transcription. The summary will be sent to the specified URL at the end of the conversation. */
|
|
4377
|
+
ai_summary?: boolean | SWMLVar;
|
|
4378
|
+
/** The webhook URL the transcription will be sent to. */
|
|
4379
|
+
webhook?: string;
|
|
4380
|
+
/** The language to transcribe. */
|
|
4381
|
+
lang: string;
|
|
4382
|
+
/** Whether to enable live events. */
|
|
4383
|
+
live_events?: boolean | SWMLVar;
|
|
4384
|
+
/** The timeout for speech recognition in milliseconds. */
|
|
4385
|
+
speech_timeout?: number | SWMLVar;
|
|
4386
|
+
/** Voice activity detection silence time in milliseconds. Default depends on speech engine: `300` for Deepgram, `500` for Google. */
|
|
4387
|
+
vad_silence_ms?: number | SWMLVar;
|
|
4388
|
+
/** Voice activity detection threshold (0-1800). */
|
|
4389
|
+
vad_thresh?: number | SWMLVar;
|
|
4390
|
+
/** Debug level for logging (0-2). */
|
|
4391
|
+
debug_level?: number | SWMLVar;
|
|
4392
|
+
/** The direction of the call that should be transcribed. */
|
|
4393
|
+
direction: TranscribeDirection[];
|
|
4394
|
+
/** The speech engine to use for speech recognition. */
|
|
4395
|
+
speech_engine?: SpeechEngine;
|
|
4396
|
+
/** The AI prompt that instructs how to summarize the conversation when `ai_summary` is enabled. */
|
|
4397
|
+
ai_summary_prompt?: string;
|
|
4398
|
+
};
|
|
4399
|
+
}
|
|
4400
|
+
export interface TranscribeSummarizeAction {
|
|
4401
|
+
/** Summarizes the conversation as an object, allowing you to specify the webhook url and prompt for the summary. */
|
|
4402
|
+
summarize: {
|
|
4403
|
+
/** The webhook URL to be called. */
|
|
4404
|
+
webhook?: string;
|
|
4405
|
+
/** The prompt for summarization. */
|
|
4406
|
+
prompt?: string;
|
|
4407
|
+
};
|
|
4408
|
+
}
|
|
4409
|
+
export type TranscribeSummarizeActionUnion = TranscribeSummarizeAction | 'summarize';
|
|
4410
|
+
export interface Transfer {
|
|
4411
|
+
/** Transfer the execution of the script to a different SWML section, URL, or Relay application. */
|
|
4412
|
+
transfer: {
|
|
4413
|
+
/** Specifies where to transfer to. The value can be one of: */
|
|
4414
|
+
dest: string;
|
|
4415
|
+
/** Named parameters to send to transfer destination. */
|
|
4416
|
+
params?: Record<string, Record<string, unknown>>;
|
|
4417
|
+
/** User data, ignored by SignalWire. */
|
|
4418
|
+
meta?: Record<string, Record<string, unknown>>;
|
|
4419
|
+
};
|
|
4420
|
+
}
|
|
4421
|
+
export type TranslateAction = StartAction | 'stop' | SummarizeActionUnion | InjectAction;
|
|
4422
|
+
export type TranslateDirection = 'remote-caller' | 'local-caller';
|
|
4423
|
+
/** Preset translation filter values that adjust the tone or style of translated speech. */
|
|
4424
|
+
export type TranslationFilterPreset = 'polite' | 'rude' | 'professional' | 'shakespeare' | 'gen-z';
|
|
4425
|
+
/** Details about a specific error. */
|
|
4426
|
+
export interface Types_StatusCodes_RestApiErrorItem {
|
|
4427
|
+
/** The category of error. */
|
|
4428
|
+
type: string;
|
|
4429
|
+
/** A specific error code. */
|
|
4430
|
+
code: string;
|
|
4431
|
+
/** A description of what caused the error. */
|
|
4432
|
+
message: string;
|
|
4433
|
+
/** The request parameter that caused the error, if applicable. */
|
|
4434
|
+
attribute?: string | null;
|
|
4435
|
+
/** A link to documentation about this error. */
|
|
4436
|
+
url: string;
|
|
4437
|
+
}
|
|
4438
|
+
/** Access is unauthorized. */
|
|
4439
|
+
export interface Types_StatusCodes_StatusCode401 {
|
|
4440
|
+
error: 'Unauthorized';
|
|
4441
|
+
}
|
|
4442
|
+
/** Access is forbidden. */
|
|
4443
|
+
export interface Types_StatusCodes_StatusCode403 {
|
|
4444
|
+
error: 'Forbidden';
|
|
4445
|
+
}
|
|
4446
|
+
/** The server cannot find the requested resource. */
|
|
4447
|
+
export interface Types_StatusCodes_StatusCode404 {
|
|
4448
|
+
error: 'Not Found';
|
|
4449
|
+
}
|
|
4450
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
4451
|
+
export interface Types_StatusCodes_StatusCode422 {
|
|
4452
|
+
/** List of validation errors. */
|
|
4453
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
4454
|
+
}
|
|
4455
|
+
/** An internal server error occurred. */
|
|
4456
|
+
export interface Types_StatusCodes_StatusCode500 {
|
|
4457
|
+
error: 'Internal Server Error';
|
|
4458
|
+
}
|
|
4459
|
+
export interface Unset {
|
|
4460
|
+
/** Unset specified variables. The variables may have been set using the set method */
|
|
4461
|
+
unset: string | string[];
|
|
4462
|
+
}
|
|
4463
|
+
export interface UnsetGlobalDataAction {
|
|
4464
|
+
/** The key of the global data to unset from the `global_data`. You can also reset the `global_data` by passing in a new object. */
|
|
4465
|
+
unset_global_data: string | Record<string, unknown>;
|
|
4466
|
+
}
|
|
4467
|
+
export interface UnsetMetaDataAction {
|
|
4468
|
+
/** The key of the local data to unset from the `meta_data`. You can also reset the `meta_data` by passing in a new object. */
|
|
4469
|
+
unset_meta_data: string | Record<string, unknown>;
|
|
4470
|
+
}
|
|
4471
|
+
/** Sets the handler to handle incoming `calls` or `messages`. */
|
|
4472
|
+
export type UsedForType = 'calling' | 'messaging';
|
|
4473
|
+
export interface UserEvent {
|
|
4474
|
+
/** Allows the user to set and send events to the connected client on the call. */
|
|
4475
|
+
user_event: {
|
|
4476
|
+
event: Record<string, Record<string, unknown>>;
|
|
4477
|
+
};
|
|
4478
|
+
}
|
|
4479
|
+
export interface UserInputAction {
|
|
4480
|
+
/** Used to inject text into the users queue as if they input the data themselves. */
|
|
4481
|
+
user_input: string;
|
|
4482
|
+
}
|
|
4483
|
+
export interface UserSWAIGFunction {
|
|
4484
|
+
/** A description of the context and purpose of the function, to explain to the agent when to use it. */
|
|
4485
|
+
description: string;
|
|
4486
|
+
/** The purpose field has been deprecated and is replaced by the `description` field. */
|
|
4487
|
+
purpose?: string;
|
|
4488
|
+
/** A JSON object that defines the expected user input parameters and their validation rules for the function. */
|
|
4489
|
+
parameters?: FunctionParameters;
|
|
4490
|
+
/** A JSON object defining the fillers that should be played when calling a `swaig function`. This helps the AI break silence between responses. The filler is played asynchronously during the function call. */
|
|
4491
|
+
fillers?: FunctionFillers;
|
|
4492
|
+
/** The argument field has been deprecated and is replaced by the `parameters` field. */
|
|
4493
|
+
argument?: FunctionParameters;
|
|
4494
|
+
/** Whether the function is active. **Default:** `true`. */
|
|
4495
|
+
active?: boolean | SWMLVar;
|
|
4496
|
+
/** A powerful and flexible environmental variable which can accept arbitrary data that is set initially in the SWML script or from the SWML set_meta_data action. */
|
|
4497
|
+
meta_data?: Record<string, Record<string, unknown>>;
|
|
4498
|
+
/** Scoping token for meta_data. If not supplied, metadata will be scoped to function's `web_hook_url`. Default is set by SignalWire. */
|
|
4499
|
+
meta_data_token?: string;
|
|
4500
|
+
/** An object that processes function inputs and executes operations through expressions, webhooks, or direct output. */
|
|
4501
|
+
data_map?: DataMap;
|
|
4502
|
+
/** Skips the top-level fillers specified in `ai.languages` (which includes `speech_fillers` and `function_fillers`). */
|
|
4503
|
+
skip_fillers?: boolean | SWMLVar;
|
|
4504
|
+
/** Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` */
|
|
4505
|
+
web_hook_url?: string;
|
|
4506
|
+
/** A file to play while the function is running. `wait_file_loops` can specify the amount of times that files should continously play. Default is not set. */
|
|
4507
|
+
wait_file?: string;
|
|
4508
|
+
/** The number of times to loop playing the file. Default is not set. */
|
|
4509
|
+
wait_file_loops?: number | string;
|
|
4510
|
+
/** Whether to wait for fillers to finish playing before continuing with the function. **Default:** `false`. */
|
|
4511
|
+
wait_for_fillers?: boolean | SWMLVar;
|
|
4512
|
+
/** A unique name for the function. This can be any user-defined string or can reference a reserved function. Reserved functions are SignalWire functions that will be executed at certain points in the conversation. */
|
|
4513
|
+
function: string;
|
|
4514
|
+
}
|
|
4515
|
+
export type ValidConfirmMethods = Cond | Set_ | Unset | Hangup | Play | Prompt | Record_ | RecordCall | StopRecordCall | Tap | StopTap | SendDigits | SendSMS | Denoise | StopDenoise;
|
|
4516
|
+
export interface VideoChannel {
|
|
4517
|
+
/** Video Channel of Fabric Address */
|
|
4518
|
+
video: string;
|
|
4519
|
+
}
|
|
4520
|
+
export interface Webhook {
|
|
4521
|
+
/** A list of expressions to be evaluated upon matching. */
|
|
4522
|
+
expressions?: Expression[];
|
|
4523
|
+
/** A string or array of strings that represent the keys to be used for error handling. This will match the key(s) in the response from the API call. */
|
|
4524
|
+
error_keys?: string | string[];
|
|
4525
|
+
/** The endpoint for the external service or API. */
|
|
4526
|
+
url: string;
|
|
4527
|
+
/** Iterates over an array of objects and processes a output based on each element in the array. Works similarly to JavaScript's forEach method. */
|
|
4528
|
+
foreach?: {
|
|
4529
|
+
/** The key to be used to access the current element in the array. */
|
|
4530
|
+
input_key: string;
|
|
4531
|
+
/** The key that can be referenced in the output of the `foreach` iteration. The values that are stored from `append` will be stored in this key. */
|
|
4532
|
+
output_key: string;
|
|
4533
|
+
/** The max amount of elements that are iterated over in the array. This will start at the beginning of the array. */
|
|
4534
|
+
max?: number | SWMLVar;
|
|
4535
|
+
/** The values to append to the output_key. */
|
|
4536
|
+
append: string;
|
|
4537
|
+
};
|
|
4538
|
+
/** Any necessary headers for the API call. */
|
|
4539
|
+
headers?: Record<string, Record<string, unknown>>;
|
|
4540
|
+
/** The HTTP method (GET, POST, etc.) for the API call. */
|
|
4541
|
+
method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
|
|
4542
|
+
/** A boolean to determine if the input arguments should be passed as parameters. */
|
|
4543
|
+
input_args_as_params?: boolean | SWMLVar;
|
|
4544
|
+
/** An object of any necessary parameters for the API call. The key is the parameter name and the value is the parameter value. */
|
|
4545
|
+
params?: Record<string, Record<string, unknown>>;
|
|
4546
|
+
/** A string or array of strings that represent the `arguments` that are required to make the webhook request. */
|
|
4547
|
+
require_args?: string | string[];
|
|
4548
|
+
/** An object that contains a response and a list of actions to be performed upon completion of the webhook request. */
|
|
4549
|
+
output?: Output;
|
|
4550
|
+
}
|
|
4551
|
+
export type jwt = string;
|
|
4552
|
+
export type play_url = string;
|
|
4553
|
+
/** Universal Unique Identifier. */
|
|
4554
|
+
export type uuid = string;
|
|
4555
|
+
export type ListSipEndpointsResponse = SipEndpointListResponse[];
|
|
4556
|
+
export type ListSubscriberAddressesResponse = SubscriberAddressesResponse[];
|
|
4557
|
+
export type ListSwmlScriptsResponse = SwmlScriptListResponse[];
|