@signalwire/sdk 2.0.4 → 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 +550 -163
- package/dist/AgentBase.js +1640 -514
- 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 +163 -0
- package/dist/POM/PromptObjectModel.js +481 -0
- package/dist/POM/PromptObjectModel.js.map +1 -0
- 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 +28 -0
- package/dist/PomBuilder.js +81 -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 +29 -1
- package/dist/PromptManager.js +37 -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 +265 -66
- package/dist/SWMLService.js +652 -112
- 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 +55 -8
- package/dist/SecurityUtils.js +162 -49
- 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 +95 -34
- 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 -367
- 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 +102 -39
- package/dist/index.js +107 -30
- 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 +79 -14
- package/dist/relay/RelayClient.js +268 -61
- 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 +81 -39
- 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 +63 -0
- package/dist/rest/callHandler.js +62 -0
- package/dist/rest/callHandler.js.map +1 -0
- package/dist/rest/index.d.ts +19 -76
- package/dist/rest/index.js +49 -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 -273
- package/dist/rest/namespaces/fabric.js +14 -363
- 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 +9 -57
- package/dist/rest/namespaces/phone-numbers.js +9 -63
- 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 +47 -7
- package/dist/skills/SkillRegistry.js +85 -13
- 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 +24 -8
- 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 +34 -25
- 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 +46 -1
- package/dist/skills/builtin/spider.js +317 -101
- 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 +57 -31
- 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 +301 -84
- 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 +32 -14
- 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 +65 -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 +88 -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,622 @@
|
|
|
1
|
+
# Call Methods Reference
|
|
2
|
+
|
|
3
|
+
A `Call` object represents a live phone call. You get one from `client.onCall(...)` for an inbound call, or from `client.dial()` for an outbound call. Don't construct it yourself.
|
|
4
|
+
|
|
5
|
+
<!-- snippet-setup -->
|
|
6
|
+
```ts
|
|
7
|
+
export {}; // treat each example as a module so top-level `await` is allowed
|
|
8
|
+
// Shared context: `call` is a live Call (from `client.onCall` / `client.dial`).
|
|
9
|
+
declare const call: import('@signalwire/sdk').Call;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
A `Call` has these properties:
|
|
15
|
+
|
|
16
|
+
| Property | Type | Description |
|
|
17
|
+
|----------|------|-------------|
|
|
18
|
+
| `callId` | `string` | Call identifier assigned by the platform |
|
|
19
|
+
| `nodeId` | `string` | RELAY node that handles the call |
|
|
20
|
+
| `projectId` | `string` | SignalWire project ID |
|
|
21
|
+
| `context` | `string` | Context or protocol the call belongs to |
|
|
22
|
+
| `state` | `CallState` | `created`, `ringing`, `answered`, `ending` or `ended`, updated from `calling.call.state` events |
|
|
23
|
+
| `direction` | `string` | `inbound` or `outbound` |
|
|
24
|
+
| `tag` | `string` | Correlation tag (the dial tag for an outbound call) |
|
|
25
|
+
| `device` | `Device` | Device descriptor from the event that created the call |
|
|
26
|
+
| `segmentId` | `string` | Segment identifier (inbound calls) |
|
|
27
|
+
| `isTerminal` | `boolean` | `true` once `state` is `ended` |
|
|
28
|
+
|
|
29
|
+
`toString()` returns `<Call id=... state=... direction=...>` for logging.
|
|
30
|
+
|
|
31
|
+
## Return Values
|
|
32
|
+
|
|
33
|
+
Methods that start a long-running operation, such as `play()` or `record()`, resolve with an `Action` object; [Actions](#actions) describes them. The other methods resolve with the result object of the platform's JSON-RPC response.
|
|
34
|
+
|
|
35
|
+
A method rejects with a `RelayError` when the platform returns a non-2xx code. The exceptions are 404 and 410, which mean the call no longer exists. For those codes, the method logs a warning and resolves with `{}`, and an action method returns an action that has already completed.
|
|
36
|
+
|
|
37
|
+
## Play Items and Devices
|
|
38
|
+
|
|
39
|
+
The wire format nests an item's fields under `params`: `{ type: 'tts', params: { text: 'Hello' } }`. The SDK also accepts a flat form, `{ type: 'tts', text: 'Hello' }`, and moves the fields under `params` before it sends the request. This applies to play items (`tts`, `audio`, `silence`, `ringtone`) and to the devices you pass to `connect()`, `refer()`, `tap()` and `client.dial()`.
|
|
40
|
+
|
|
41
|
+
For a `phone` device in the flat form, the SDK also renames `to` and `from` to the wire fields `to_number` and `from_number`. An item that already has `params` is sent unchanged.
|
|
42
|
+
|
|
43
|
+
## Actions
|
|
44
|
+
|
|
45
|
+
Methods such as `play()`, `record()` and `detect()` return an **Action**. Awaiting `call.play(...)` waits only until the platform accepts the command, and the operation then runs on the platform. You choose how to handle its completion.
|
|
46
|
+
|
|
47
|
+
### Wait inline
|
|
48
|
+
|
|
49
|
+
Await the action's `wait()` method to pause until the operation finishes:
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
const action = await call.play([{ type: 'tts', params: { text: 'Hello' } }]);
|
|
53
|
+
await action.wait(); // resolves when playback finishes
|
|
54
|
+
// execution continues only after play is done
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Continue without waiting
|
|
58
|
+
|
|
59
|
+
Skip `wait()` to continue immediately, and check the action later:
|
|
60
|
+
|
|
61
|
+
```typescript
|
|
62
|
+
const action = await call.play([{ type: 'tts', params: { text: 'Hello' } }]);
|
|
63
|
+
// don't await action.wait(); continue while audio plays
|
|
64
|
+
await call.sendDigits('1234');
|
|
65
|
+
|
|
66
|
+
// check later if needed
|
|
67
|
+
if (action.completed) {
|
|
68
|
+
console.log(`Play result: ${JSON.stringify(action.result?.params)}`);
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Run a callback on completion
|
|
73
|
+
|
|
74
|
+
Pass `onCompleted` to run a function when the action finishes, without waiting for it:
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
// Sync callback
|
|
78
|
+
const action = await call.play(
|
|
79
|
+
[{ type: 'tts', params: { text: 'Hello' } }],
|
|
80
|
+
{ onCompleted: (event) => console.log(`Done: ${JSON.stringify(event.params)}`) },
|
|
81
|
+
);
|
|
82
|
+
// continues immediately; the callback runs when playback finishes
|
|
83
|
+
|
|
84
|
+
// Async callback
|
|
85
|
+
const rec = await call.record(
|
|
86
|
+
{ format: 'wav' },
|
|
87
|
+
{
|
|
88
|
+
onCompleted: async (event) => {
|
|
89
|
+
console.log(`Recording finished: ${JSON.stringify(event.params)}`);
|
|
90
|
+
await call.hangup();
|
|
91
|
+
},
|
|
92
|
+
},
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Every method that returns an action accepts `onCompleted`, including the typed helpers such as `playTTS()` and `detectAnsweringMachine()`. The callback may be sync or async. The SDK catches and logs a callback's errors, and they don't reach the client.
|
|
97
|
+
|
|
98
|
+
The callback also runs when the platform answers 404 or 410, with an empty event (`eventType` of `''`). It doesn't run when `call.state` is already `ended` before the request: the SDK then skips the request and returns an action that has already completed.
|
|
99
|
+
|
|
100
|
+
### Action members
|
|
101
|
+
|
|
102
|
+
Every action has these members:
|
|
103
|
+
|
|
104
|
+
| Member | Description |
|
|
105
|
+
|--------|-------------|
|
|
106
|
+
| `controlId` | The control ID the platform uses to route the operation's events to this action |
|
|
107
|
+
| `call` | The call the action belongs to |
|
|
108
|
+
| `await action.wait(timeout?)` | Resolves with the terminal `RelayEvent`. `timeout` is in **seconds**; when it passes, `wait()` rejects with an `Error` and the operation keeps running. |
|
|
109
|
+
| `action.completed` | `true` once the action has received its terminal event |
|
|
110
|
+
| `action.result` | The terminal `RelayEvent`, or `null` before completion |
|
|
111
|
+
| `action.isDone` | `true` once the action has settled, including when its request failed |
|
|
112
|
+
| `await action.stop()` | Stops the operation on the platform |
|
|
113
|
+
|
|
114
|
+
The action classes add these methods and complete on these event states:
|
|
115
|
+
|
|
116
|
+
| Action | Returned by | Extra methods | Completes on |
|
|
117
|
+
|--------|-------------|---------------|--------------|
|
|
118
|
+
| `PlayAction` | `play()`, `playTTS()`, `playAudio()`, `playSilence()`, `playRingtone()` | `pause(behavior?)`, `resume()`, `volume(db)` | `finished`, `error` |
|
|
119
|
+
| `RecordAction` | `record()` | `pause(behavior?)`, `resume()` | `finished`, `no_input` |
|
|
120
|
+
| `CollectAction` | `playAndCollect()`, `promptTTS()`, `promptAudio()` | `pause(behavior?)`, `resume()`, `volume(db)`, `startInputTimers()` | a `calling.call.collect` event with a `result`, or state `finished`, `error`, `no_input`, `no_match` |
|
|
121
|
+
| `StandaloneCollectAction` | `collect()` | `startInputTimers()` | a `calling.call.collect` event with a `result`, or state `finished`, `error`, `no_input`, `no_match` |
|
|
122
|
+
| `DetectAction` | `detect()`, `detectAnsweringMachine()`, `detectDigit()`, `detectFax()` | none | the first event with a `detect` result, or state `finished`, `error` |
|
|
123
|
+
| `FaxAction` | `sendFax()`, `receiveFax()` | none | `finished`, `error` |
|
|
124
|
+
| `TapAction` | `tap()` | none | `finished` |
|
|
125
|
+
| `StreamAction` | `stream()` | none | `finished` |
|
|
126
|
+
| `PayAction` | `pay()` | none | `finished`, `error` |
|
|
127
|
+
| `TranscribeAction` | `transcribe()` | none | `finished` |
|
|
128
|
+
| `AIAction` | `ai()` | none | `finished`, `error` |
|
|
129
|
+
|
|
130
|
+
`CollectAction` ignores the `calling.call.play` events that share its control ID, so the prompt finishing doesn't complete it. Both collect actions complete on the first `calling.call.collect` event that carries a `result`, whether or not `CollectEvent.final` is `true`.
|
|
131
|
+
|
|
132
|
+
## Lifecycle
|
|
133
|
+
|
|
134
|
+
### `answer(extra?)`
|
|
135
|
+
|
|
136
|
+
Answer an inbound call. The optional `extra` object is merged into the request's params.
|
|
137
|
+
|
|
138
|
+
```typescript
|
|
139
|
+
await call.answer();
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### `hangup(reason = 'hangup')`
|
|
143
|
+
|
|
144
|
+
End the call. The SDK sends `reason` to the platform in a `calling.end` request.
|
|
145
|
+
|
|
146
|
+
```typescript
|
|
147
|
+
await call.hangup();
|
|
148
|
+
await call.hangup('busy');
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### `pass()`
|
|
152
|
+
|
|
153
|
+
Decline control of the inbound call and return it to routing, in place of answering it.
|
|
154
|
+
|
|
155
|
+
```typescript
|
|
156
|
+
await call.pass();
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## Audio Playback
|
|
160
|
+
|
|
161
|
+
### `play(media, options?): Promise<PlayAction>`
|
|
162
|
+
|
|
163
|
+
Play a list of media items. The options are `volume` (dB), `direction`, `loop`, `controlId` and `onCompleted`.
|
|
164
|
+
|
|
165
|
+
```typescript
|
|
166
|
+
// TTS
|
|
167
|
+
const action = await call.play([{ type: 'tts', params: { text: 'Hello!' } }]);
|
|
168
|
+
await action.wait();
|
|
169
|
+
|
|
170
|
+
// Audio file
|
|
171
|
+
await call.play([{ type: 'audio', params: { url: 'https://example.com/sound.mp3' } }]);
|
|
172
|
+
|
|
173
|
+
// Silence
|
|
174
|
+
await call.play([{ type: 'silence', params: { duration: 2 } }]);
|
|
175
|
+
|
|
176
|
+
// Ringtone
|
|
177
|
+
await call.play([{ type: 'ringtone', params: { name: 'us' } }]);
|
|
178
|
+
|
|
179
|
+
// Control playback
|
|
180
|
+
await action.pause();
|
|
181
|
+
await action.resume();
|
|
182
|
+
await action.volume(-3.0);
|
|
183
|
+
await action.stop();
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### Typed playback helpers
|
|
187
|
+
|
|
188
|
+
These helpers build the media item for you and return a `PlayAction`:
|
|
189
|
+
|
|
190
|
+
- `playTTS(text, options?)`: options `language`, `gender` (`'male'` or `'female'`), `voice`, `volume`, `onCompleted`
|
|
191
|
+
- `playAudio(url, options?)`: options `volume`, `onCompleted`
|
|
192
|
+
- `playSilence(duration, options?)`: `duration` in seconds; option `onCompleted`
|
|
193
|
+
- `playRingtone(name, options?)`: options `duration` (seconds), `volume`, `onCompleted`
|
|
194
|
+
|
|
195
|
+
This call speaks a sentence in US English and waits for it to finish:
|
|
196
|
+
|
|
197
|
+
```typescript
|
|
198
|
+
const action = await call.playTTS('Hello!', { language: 'en-US' });
|
|
199
|
+
await action.wait();
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
## Recording
|
|
203
|
+
|
|
204
|
+
### `record(audio?, options?): Promise<RecordAction>`
|
|
205
|
+
|
|
206
|
+
Record the call. `audio` holds the recording settings, such as `format` (`'mp3'` or `'wav'`), `stereo`, `direction` (`'listen'`, `'speak'` or `'both'`), `beep`, `terminators`, `initial_timeout` and `end_silence_timeout`. The options are `controlId` and `onCompleted`.
|
|
207
|
+
|
|
208
|
+
```typescript
|
|
209
|
+
import { RecordEvent } from '@signalwire/sdk';
|
|
210
|
+
|
|
211
|
+
const action = await call.record({ format: 'wav', stereo: true, direction: 'both' });
|
|
212
|
+
// ... later ...
|
|
213
|
+
await action.stop();
|
|
214
|
+
const event = await action.wait();
|
|
215
|
+
if (event instanceof RecordEvent) {
|
|
216
|
+
console.log(`Recording URL: ${event.url}`);
|
|
217
|
+
}
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
`RecordEvent.url` reads `params.record.url`, falling back to `params.url`. The check with `instanceof` handles the empty event an action gets when the call is gone.
|
|
221
|
+
|
|
222
|
+
## Input Collection
|
|
223
|
+
|
|
224
|
+
### `playAndCollect(media, collect, options?): Promise<CollectAction>`
|
|
225
|
+
|
|
226
|
+
Play media and collect DTMF or speech input in one operation. `collect` takes the `calling.collect` fields, such as `digits`, `speech`, `initial_timeout` and `partial_results`. The options are `volume`, `controlId` and `onCompleted`.
|
|
227
|
+
|
|
228
|
+
```typescript
|
|
229
|
+
import { CollectEvent } from '@signalwire/sdk';
|
|
230
|
+
|
|
231
|
+
const action = await call.playAndCollect(
|
|
232
|
+
[{ type: 'tts', params: { text: 'Press 1 for sales, 2 for support.' } }],
|
|
233
|
+
{ digits: { max: 1, digit_timeout: 5.0 } },
|
|
234
|
+
);
|
|
235
|
+
const event = await action.wait();
|
|
236
|
+
if (event instanceof CollectEvent) {
|
|
237
|
+
console.log(`Collected: ${JSON.stringify(event.result)}`);
|
|
238
|
+
}
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
The typed helpers `promptTTS(text, collect, options?)` and `promptAudio(url, collect, options?)` build the prompt for you. Each returns a `CollectAction`:
|
|
242
|
+
|
|
243
|
+
```typescript
|
|
244
|
+
const action = await call.promptTTS('Enter your PIN, then press pound.', {
|
|
245
|
+
digits: { max: 4, terminators: '#' },
|
|
246
|
+
});
|
|
247
|
+
const event = await action.wait();
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
### `collect(options?): Promise<StandaloneCollectAction>`
|
|
251
|
+
|
|
252
|
+
Collect input without playing media. The options are `digits`, `speech`, `initialTimeout`, `partialResults`, `continuous`, `sendStartOfInput`, `startInputTimers`, `controlId` and `onCompleted`.
|
|
253
|
+
|
|
254
|
+
```typescript
|
|
255
|
+
const action = await call.collect({
|
|
256
|
+
digits: { max: 4, terminators: '#' },
|
|
257
|
+
speech: { language: 'en-US' },
|
|
258
|
+
});
|
|
259
|
+
const event = await action.wait();
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
## Bridging
|
|
263
|
+
|
|
264
|
+
### `connect(devices, options?)`
|
|
265
|
+
|
|
266
|
+
Bridge the call to another destination. `devices` is a nested array: serial attempts outside, parallel devices inside. The options are `ringback` (play items), `tag`, `maxDuration`, `maxPricePerMinute` and `statusUrl`.
|
|
267
|
+
|
|
268
|
+
```typescript
|
|
269
|
+
await call.connect(
|
|
270
|
+
[[{ type: 'phone', to: '+15551234567', from: '+15559876543' }]],
|
|
271
|
+
{ ringback: [{ type: 'ringtone', params: { name: 'us' } }] },
|
|
272
|
+
);
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
A device can also be `{ type: 'sip', to, from }` or `{ type: 'fabric', to }`, where `to` names a Fabric address.
|
|
276
|
+
|
|
277
|
+
### `disconnect()`
|
|
278
|
+
|
|
279
|
+
Unbridge a connected call.
|
|
280
|
+
|
|
281
|
+
```typescript
|
|
282
|
+
await call.disconnect();
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
## DTMF
|
|
286
|
+
|
|
287
|
+
### `sendDigits(digits, controlId?)`
|
|
288
|
+
|
|
289
|
+
Send DTMF tones.
|
|
290
|
+
|
|
291
|
+
```typescript
|
|
292
|
+
await call.sendDigits('1234#');
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
## Detection
|
|
296
|
+
|
|
297
|
+
### `detect(detect, options?): Promise<DetectAction>`
|
|
298
|
+
|
|
299
|
+
Detect an answering machine, a fax tone or DTMF digits. `detect` is `{ type: 'machine' | 'fax' | 'digit', params? }`. The options are `timeout` (seconds), `controlId` and `onCompleted`.
|
|
300
|
+
|
|
301
|
+
```typescript
|
|
302
|
+
const action = await call.detect({ type: 'machine' }, { timeout: 30 });
|
|
303
|
+
const event = await action.wait();
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
These typed helpers call `detect()` and return a `DetectAction`:
|
|
307
|
+
|
|
308
|
+
- `detectAnsweringMachine(options?)`: options `initialTimeout`, `endSilenceTimeout`, `machineVoiceThreshold`, `machineWordsThreshold`, `detectInterruptions`, `detectMessageEnd`, `timeout`, `onCompleted`
|
|
309
|
+
- `detectDigit(options?)`: options `digits`, `timeout`, `onCompleted`
|
|
310
|
+
- `detectFax(options?)`: options `tone` (`'CED'` or `'CNG'`), `timeout`, `onCompleted`
|
|
311
|
+
|
|
312
|
+
This call runs answering-machine detection for up to 30 seconds and reads the result:
|
|
313
|
+
|
|
314
|
+
```typescript
|
|
315
|
+
import { DetectEvent } from '@signalwire/sdk';
|
|
316
|
+
|
|
317
|
+
const action = await call.detectAnsweringMachine({ initialTimeout: 5, timeout: 30 });
|
|
318
|
+
const event = await action.wait();
|
|
319
|
+
if (event instanceof DetectEvent) {
|
|
320
|
+
console.log(`Detect result: ${JSON.stringify(event.detect)}`);
|
|
321
|
+
}
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
A `DetectAction` completes on the first event that carries a `detect` result, not only on `finished`.
|
|
325
|
+
|
|
326
|
+
## SIP Refer
|
|
327
|
+
|
|
328
|
+
### `refer(device, options?)`
|
|
329
|
+
|
|
330
|
+
Transfer a SIP call with a SIP REFER. The option is `statusUrl`.
|
|
331
|
+
|
|
332
|
+
```typescript
|
|
333
|
+
await call.refer({ type: 'sip', to: 'sip:user@example.com' });
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
## Transfer
|
|
337
|
+
|
|
338
|
+
### `transfer(dest, extra?)`
|
|
339
|
+
|
|
340
|
+
Transfer control of the call to another RELAY application or a SWML script. The optional `extra` object is merged into the request's params.
|
|
341
|
+
|
|
342
|
+
```typescript
|
|
343
|
+
await call.transfer('https://example.com/swml-endpoint');
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
## Fax
|
|
347
|
+
|
|
348
|
+
### `sendFax(document, options?): Promise<FaxAction>`
|
|
349
|
+
|
|
350
|
+
Send a fax. `document` is the URL of the document. The options are `identity`, `headerInfo`, `controlId` and `onCompleted`.
|
|
351
|
+
|
|
352
|
+
```typescript
|
|
353
|
+
const action = await call.sendFax('https://example.com/document.pdf', { identity: '+15551234567' });
|
|
354
|
+
const event = await action.wait();
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
### `receiveFax(options?): Promise<FaxAction>`
|
|
358
|
+
|
|
359
|
+
Receive a fax on the call. The options are `controlId` and `onCompleted`.
|
|
360
|
+
|
|
361
|
+
```typescript
|
|
362
|
+
const action = await call.receiveFax();
|
|
363
|
+
const event = await action.wait();
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
## Tap (Media Interception)
|
|
367
|
+
|
|
368
|
+
### `tap(tap, device, options?): Promise<TapAction>`
|
|
369
|
+
|
|
370
|
+
Copy the call's audio to an RTP or WebSocket endpoint. `tap` is `{ type: 'audio', params?: { direction } }`, and `device` has type `rtp` or `ws`. The options are `controlId` and `onCompleted`.
|
|
371
|
+
|
|
372
|
+
```typescript
|
|
373
|
+
const action = await call.tap(
|
|
374
|
+
{ type: 'audio', params: { direction: 'both' } },
|
|
375
|
+
{ type: 'rtp', params: { addr: '192.168.1.100', port: 5000 } },
|
|
376
|
+
);
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
## Streaming
|
|
380
|
+
|
|
381
|
+
### `stream(url, options?): Promise<StreamAction>`
|
|
382
|
+
|
|
383
|
+
Stream the call's audio to a WebSocket endpoint. The options are `name`, `codec`, `track`, `statusUrl`, `statusUrlMethod`, `authorizationBearerToken`, `customParameters`, `controlId` and `onCompleted`. `track` picks the audio to stream: `'inbound_track'`, `'outbound_track'` or `'both_tracks'`.
|
|
384
|
+
|
|
385
|
+
```typescript
|
|
386
|
+
const action = await call.stream('wss://example.com/audio', {
|
|
387
|
+
name: 'my_stream',
|
|
388
|
+
codec: 'PCMU',
|
|
389
|
+
track: 'inbound_track',
|
|
390
|
+
});
|
|
391
|
+
// Stop streaming
|
|
392
|
+
await action.stop();
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
## Payment
|
|
396
|
+
|
|
397
|
+
### `pay(paymentConnectorUrl, options?): Promise<PayAction>`
|
|
398
|
+
|
|
399
|
+
Collect a card payment through a payment connector. The options include `inputMethod` (sent as `input`), `chargeAmount`, `currency`, `paymentMethod`, `tokenType`, `validCardTypes`, `prompts`, `parameters`, `statusUrl`, `timeout`, `maxAttempts`, `language`, `voice` and `description`. Most take strings, as the wire format does.
|
|
400
|
+
|
|
401
|
+
```typescript
|
|
402
|
+
const action = await call.pay('https://pay.example.com', {
|
|
403
|
+
chargeAmount: '25.99',
|
|
404
|
+
currency: 'usd',
|
|
405
|
+
inputMethod: 'dtmf',
|
|
406
|
+
});
|
|
407
|
+
const event = await action.wait();
|
|
408
|
+
```
|
|
409
|
+
|
|
410
|
+
## Conference
|
|
411
|
+
|
|
412
|
+
### `joinConference(name, options?)`
|
|
413
|
+
|
|
414
|
+
Join the call to a named conference. Calls that join the same name hear each other. The options include `muted`, `beep`, `startOnEnter`, `endOnExit`, `waitUrl`, `maxParticipants`, `record`, `region`, `trim`, `coach`, `stream` and the `statusCallback*` and `recordingStatusCallback*` fields.
|
|
415
|
+
|
|
416
|
+
```typescript
|
|
417
|
+
await call.joinConference('my_conference', { muted: false, beep: 'onEnter' });
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
### `leaveConference(conferenceId, extra?)`
|
|
421
|
+
|
|
422
|
+
Remove the call from a conference.
|
|
423
|
+
|
|
424
|
+
```typescript
|
|
425
|
+
await call.leaveConference('conf-123');
|
|
426
|
+
```
|
|
427
|
+
|
|
428
|
+
## Hold
|
|
429
|
+
|
|
430
|
+
### `hold()` / `unhold()`
|
|
431
|
+
|
|
432
|
+
Put the call on hold, or take it off hold.
|
|
433
|
+
|
|
434
|
+
```typescript
|
|
435
|
+
await call.hold();
|
|
436
|
+
// ... later ...
|
|
437
|
+
await call.unhold();
|
|
438
|
+
```
|
|
439
|
+
|
|
440
|
+
## Denoise
|
|
441
|
+
|
|
442
|
+
### `denoise()` / `denoiseStop()`
|
|
443
|
+
|
|
444
|
+
Start or stop noise reduction on the call.
|
|
445
|
+
|
|
446
|
+
```typescript
|
|
447
|
+
await call.denoise();
|
|
448
|
+
// ... later ...
|
|
449
|
+
await call.denoiseStop();
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
## Transcription
|
|
453
|
+
|
|
454
|
+
### `transcribe(options?): Promise<TranscribeAction>`
|
|
455
|
+
|
|
456
|
+
Start transcribing the call. The options are `statusUrl`, `controlId` and `onCompleted`.
|
|
457
|
+
|
|
458
|
+
```typescript
|
|
459
|
+
const action = await call.transcribe({ statusUrl: 'https://example.com/transcription' });
|
|
460
|
+
// ... later ...
|
|
461
|
+
await action.stop();
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
## Live Transcribe / Translate
|
|
465
|
+
|
|
466
|
+
### `liveTranscribe(action, extra?)`
|
|
467
|
+
|
|
468
|
+
Start or stop live transcription. `action` is the platform's action object, such as `{ start: { ... } }` or `{ stop: ... }`.
|
|
469
|
+
|
|
470
|
+
```typescript
|
|
471
|
+
await call.liveTranscribe({ start: { language: 'en-US' } });
|
|
472
|
+
```
|
|
473
|
+
|
|
474
|
+
### `liveTranslate(action, options?)`
|
|
475
|
+
|
|
476
|
+
Start or stop live translation. The option is `statusUrl`.
|
|
477
|
+
|
|
478
|
+
```typescript
|
|
479
|
+
await call.liveTranslate({ start: { source: 'en-US', target: 'es' } });
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
## Echo
|
|
483
|
+
|
|
484
|
+
### `echo(options?)`
|
|
485
|
+
|
|
486
|
+
Echo the caller's audio back to them, which helps when you test audio paths. The options are `timeout` (seconds) and `statusUrl`.
|
|
487
|
+
|
|
488
|
+
```typescript
|
|
489
|
+
await call.echo({ timeout: 30 });
|
|
490
|
+
```
|
|
491
|
+
|
|
492
|
+
## AI Agent
|
|
493
|
+
|
|
494
|
+
### `ai(options?): Promise<AIAction>`
|
|
495
|
+
|
|
496
|
+
Start an AI agent session on the call. The options are `agent`, `prompt`, `postPrompt`, `postPromptUrl`, `postPromptAuthUser`, `postPromptAuthPassword`, `globalData`, `pronounce`, `hints`, `languages`, `SWAIG`, `aiParams` (sent as `params`), `controlId` and `onCompleted`.
|
|
497
|
+
|
|
498
|
+
```typescript
|
|
499
|
+
const action = await call.ai({
|
|
500
|
+
prompt: { text: 'You are a helpful support agent.' },
|
|
501
|
+
SWAIG: { functions: [] },
|
|
502
|
+
aiParams: { end_of_speech_timeout: 3000 },
|
|
503
|
+
});
|
|
504
|
+
const event = await action.wait();
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
### `amazonBedrock(options?)`
|
|
508
|
+
|
|
509
|
+
Connect the call to an Amazon Bedrock agent. The options are `prompt`, `SWAIG`, `aiParams`, `globalData`, `postPrompt` and `postPromptUrl`.
|
|
510
|
+
|
|
511
|
+
### `aiMessage(options?)`
|
|
512
|
+
|
|
513
|
+
Send a message into an active AI session. The options are `messageText`, `role`, `reset` and `globalData`.
|
|
514
|
+
|
|
515
|
+
### `aiHold(options?)` / `aiUnhold(options?)`
|
|
516
|
+
|
|
517
|
+
Put an AI session on hold, or resume it. `aiHold()` takes `timeout` and `prompt`; `aiUnhold()` takes `prompt`.
|
|
518
|
+
|
|
519
|
+
## Rooms
|
|
520
|
+
|
|
521
|
+
### `joinRoom(name, options?)`
|
|
522
|
+
|
|
523
|
+
Join the call to a named room. The option is `statusUrl`.
|
|
524
|
+
|
|
525
|
+
```typescript
|
|
526
|
+
await call.joinRoom('my_room');
|
|
527
|
+
```
|
|
528
|
+
|
|
529
|
+
### `leaveRoom(extra?)`
|
|
530
|
+
|
|
531
|
+
Remove the call from its room.
|
|
532
|
+
|
|
533
|
+
```typescript
|
|
534
|
+
await call.leaveRoom();
|
|
535
|
+
```
|
|
536
|
+
|
|
537
|
+
## Queue
|
|
538
|
+
|
|
539
|
+
### `queueEnter(queueName, options?)`
|
|
540
|
+
|
|
541
|
+
Place the call in a named queue. The options are `controlId` and `statusUrl`.
|
|
542
|
+
|
|
543
|
+
```typescript
|
|
544
|
+
await call.queueEnter('support');
|
|
545
|
+
```
|
|
546
|
+
|
|
547
|
+
### `queueLeave(queueName, options?)`
|
|
548
|
+
|
|
549
|
+
Remove the call from a queue. The options are `controlId`, `queueId` and `statusUrl`.
|
|
550
|
+
|
|
551
|
+
```typescript
|
|
552
|
+
await call.queueLeave('support', { queueId: 'q-123' });
|
|
553
|
+
```
|
|
554
|
+
|
|
555
|
+
## Digit Bindings
|
|
556
|
+
|
|
557
|
+
### `bindDigit(digits, bindMethod, options?)`
|
|
558
|
+
|
|
559
|
+
Bind a DTMF sequence to a RELAY method, which the platform runs when the caller presses the sequence. The options are `bindParams` (sent as `params`), `realm` and `maxTriggers`.
|
|
560
|
+
|
|
561
|
+
```typescript
|
|
562
|
+
await call.bindDigit('*1', 'calling.play', {
|
|
563
|
+
bindParams: { play: [{ type: 'tts', params: { text: 'You pressed star-1' } }] },
|
|
564
|
+
});
|
|
565
|
+
```
|
|
566
|
+
|
|
567
|
+
### `clearDigitBindings(realm?)`
|
|
568
|
+
|
|
569
|
+
Remove the call's digit bindings, or only those in `realm`.
|
|
570
|
+
|
|
571
|
+
```typescript
|
|
572
|
+
await call.clearDigitBindings();
|
|
573
|
+
```
|
|
574
|
+
|
|
575
|
+
## User Events
|
|
576
|
+
|
|
577
|
+
### `userEvent(options?)`
|
|
578
|
+
|
|
579
|
+
Send a custom event named by `options.event`. The SDK sends every other field in `options` with it:
|
|
580
|
+
|
|
581
|
+
```typescript
|
|
582
|
+
await call.userEvent({ event: 'order_placed', order_id: '12345' });
|
|
583
|
+
```
|
|
584
|
+
|
|
585
|
+
## Event Handling
|
|
586
|
+
|
|
587
|
+
### `on(eventType, handler)`
|
|
588
|
+
|
|
589
|
+
Register a listener for one event type on this call. The handler receives the typed event object, such as a `PlayEvent` for `calling.call.play`. Listener errors are logged and don't stop other listeners.
|
|
590
|
+
|
|
591
|
+
```typescript
|
|
592
|
+
call.on('calling.call.play', (event) => {
|
|
593
|
+
console.log(`Play state: ${event.params.state}`);
|
|
594
|
+
});
|
|
595
|
+
```
|
|
596
|
+
|
|
597
|
+
### `waitFor(eventType, predicate?, timeout?)`
|
|
598
|
+
|
|
599
|
+
Wait for the next event of a type that matches the optional predicate. `timeout` is in **milliseconds**; when it passes, `waitFor()` rejects with an `Error`.
|
|
600
|
+
|
|
601
|
+
```typescript
|
|
602
|
+
const event = await call.waitFor('calling.call.play', undefined, 30_000);
|
|
603
|
+
```
|
|
604
|
+
|
|
605
|
+
### `waitForEnded(timeout?)`
|
|
606
|
+
|
|
607
|
+
Wait for the call to reach `ended`, and resolve with that `calling.call.state` event. `timeout` is in **milliseconds**.
|
|
608
|
+
|
|
609
|
+
```typescript
|
|
610
|
+
const event = await call.waitForEnded();
|
|
611
|
+
console.log(`End reason: ${event.params.end_reason}`);
|
|
612
|
+
```
|
|
613
|
+
|
|
614
|
+
`waitForAnswered(timeout?)`, `waitForRinging(timeout?)` and `waitForEnding(timeout?)` wait for those states, with `timeout` in milliseconds. They resolve at once, with a generated `calling.call.state` event, when the call is already at or past the state.
|
|
615
|
+
|
|
616
|
+
## Next Steps
|
|
617
|
+
|
|
618
|
+
Continue with these pages:
|
|
619
|
+
|
|
620
|
+
- [Events](events.md): typed event classes and event-type constants
|
|
621
|
+
- [Client Reference](client-reference.md): `RelayClient` options and methods
|
|
622
|
+
- [Getting Started](getting-started.md): connecting and placing a first call
|