@signalwire/sdk 2.0.5 → 3.6.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 +821 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +510 -126
- package/dist/AgentBase.js +1581 -455
- 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 +186 -45
- package/dist/DataMap.js +210 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +309 -83
- package/dist/FunctionResult.js +483 -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 +169 -59
- package/dist/SWMLService.js +456 -129
- 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/SemanticGate.d.ts +183 -0
- package/dist/SemanticGate.js +533 -0
- package/dist/SemanticGate.js.map +1 -0
- 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 +139 -7
- package/dist/SwaigFunction.js +170 -22
- 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 +920 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +49 -68
- package/dist/index.js +45 -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 +111 -21
- 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 +3641 -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 +1207 -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 +1986 -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,281 @@
|
|
|
1
|
+
# RelayClient Reference
|
|
2
|
+
|
|
3
|
+
`RelayClient` owns one WebSocket connection to SignalWire RELAY. It authenticates, routes events to `Call` and `Message` objects, and sends the JSON-RPC requests that `Call` methods build.
|
|
4
|
+
|
|
5
|
+
<!-- snippet-setup -->
|
|
6
|
+
```ts
|
|
7
|
+
export {}; // treat each example as a module so top-level `await` is allowed
|
|
8
|
+
// Shared context for the fragments on this page: `client` is a constructed
|
|
9
|
+
// RelayClient (see the Constructor section).
|
|
10
|
+
declare const client: import('@signalwire/sdk').RelayClient;
|
|
11
|
+
// `await using` needs the disposable global types + Symbol members absent from
|
|
12
|
+
// the harness's ES2020 lib set.
|
|
13
|
+
declare global {
|
|
14
|
+
interface SymbolConstructor {
|
|
15
|
+
readonly dispose: unique symbol;
|
|
16
|
+
readonly asyncDispose: unique symbol;
|
|
17
|
+
}
|
|
18
|
+
interface Disposable {
|
|
19
|
+
[Symbol.dispose](): void;
|
|
20
|
+
}
|
|
21
|
+
interface AsyncDisposable {
|
|
22
|
+
[Symbol.asyncDispose](): PromiseLike<void>;
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Constructor
|
|
28
|
+
|
|
29
|
+
`new RelayClient(options?: RelayClientOptions)` takes one options object. Every option is optional:
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
import { RelayClient } from '@signalwire/sdk';
|
|
33
|
+
|
|
34
|
+
function makeClient() {
|
|
35
|
+
return new RelayClient({
|
|
36
|
+
project: 'your-project-id', // SIGNALWIRE_PROJECT_ID
|
|
37
|
+
token: 'your-api-token', // SIGNALWIRE_API_TOKEN
|
|
38
|
+
jwtToken: 'your-jwt', // SIGNALWIRE_JWT_TOKEN (alternative auth)
|
|
39
|
+
host: 'example.signalwire.com', // SIGNALWIRE_SPACE (default: relay.signalwire.com)
|
|
40
|
+
contexts: ['default'], // topics to subscribe to
|
|
41
|
+
maxActiveCalls: 1000, // RELAY_MAX_ACTIVE_CALLS (default: 1000)
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Each omitted option falls back to the environment variable in its comment. Authentication needs either `jwtToken`, or both `project` and `token`. When `jwtToken` is set, the client authenticates with it and doesn't send the project and token.
|
|
47
|
+
|
|
48
|
+
The constructor throws an `Error` in these cases:
|
|
49
|
+
|
|
50
|
+
- It has no JWT, and the project or the token is missing.
|
|
51
|
+
- `host` contains `@`, `/`, `?`, `#`, a space or a line break, which means it isn't a bare hostname.
|
|
52
|
+
|
|
53
|
+
The options have these types:
|
|
54
|
+
|
|
55
|
+
| Option | Type | Default |
|
|
56
|
+
|--------|------|---------|
|
|
57
|
+
| `project` | `string` | `SIGNALWIRE_PROJECT_ID` |
|
|
58
|
+
| `token` | `string` | `SIGNALWIRE_API_TOKEN` |
|
|
59
|
+
| `jwtToken` | `string` | `SIGNALWIRE_JWT_TOKEN` |
|
|
60
|
+
| `host` | `string` | `SIGNALWIRE_RELAY_HOST`, then `SIGNALWIRE_SPACE`, then `relay.signalwire.com` |
|
|
61
|
+
| `scheme` | `'ws' \| 'wss'` | `SIGNALWIRE_RELAY_SCHEME`, then `'wss'` |
|
|
62
|
+
| `contexts` | `string[]` | `[]` |
|
|
63
|
+
| `maxActiveCalls` | `number` | `RELAY_MAX_ACTIVE_CALLS`, then `1000`; values under 1 become 1 |
|
|
64
|
+
|
|
65
|
+
`scheme: 'ws'` sends traffic without TLS. It exists for tests against a local fixture, not for production.
|
|
66
|
+
|
|
67
|
+
## Methods
|
|
68
|
+
|
|
69
|
+
### `run(): Promise<void>`
|
|
70
|
+
|
|
71
|
+
`run()` connects, authenticates and reconnects after every dropped connection, with exponential backoff. It installs `SIGINT` and `SIGTERM` handlers, and its promise resolves after one of those signals shuts the client down.
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
await client.run();
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
A connection error doesn't reject the promise: `run()` logs it and tries again. Because `run()` installs process-wide signal handlers, call it on one client per process.
|
|
78
|
+
|
|
79
|
+
### `connect(): Promise<void>` / `disconnect(): Promise<void>`
|
|
80
|
+
|
|
81
|
+
`connect()` opens the WebSocket, runs the `signalwire.connect` handshake, starts the client ping loop and sends any queued requests. `disconnect()` closes the socket and rejects every pending request and dial with a `RelayError`. Calling `disconnect()` more than once is safe.
|
|
82
|
+
|
|
83
|
+
```typescript
|
|
84
|
+
await client.connect();
|
|
85
|
+
// ... use client ...
|
|
86
|
+
await client.disconnect();
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
A client started with `connect()` doesn't reconnect when the connection drops; only `run()` reconnects. `connect()` throws when the process already has `RELAY_MAX_CONNECTIONS` other connected clients.
|
|
90
|
+
|
|
91
|
+
`RelayClient` also implements `Symbol.asyncDispose`, so `await using` calls `disconnect()` at the end of the scope:
|
|
92
|
+
|
|
93
|
+
```typescript
|
|
94
|
+
import { RelayClient } from '@signalwire/sdk';
|
|
95
|
+
|
|
96
|
+
async function withClient() {
|
|
97
|
+
await using client = new RelayClient({ contexts: ['default'] });
|
|
98
|
+
await client.connect();
|
|
99
|
+
// ...
|
|
100
|
+
}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### `onCall(handler: CallHandler): CallHandler`
|
|
104
|
+
|
|
105
|
+
`onCall()` registers the inbound call handler and returns it. The client calls the handler once for each `calling.call.receive` event, with a `Call` built from that event (normally in state `created`). The handler may be async.
|
|
106
|
+
|
|
107
|
+
```typescript
|
|
108
|
+
client.onCall(async (call) => {
|
|
109
|
+
await call.answer();
|
|
110
|
+
});
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
The client doesn't await the handler, so handlers for different calls run concurrently. A handler's error is logged and doesn't stop the client. Registering a second handler replaces the first.
|
|
114
|
+
|
|
115
|
+
### `onMessage(handler: MessageHandler): MessageHandler`
|
|
116
|
+
|
|
117
|
+
`onMessage()` registers the inbound message handler and returns it. The client calls the handler for each `messaging.receive` event, with a `Message` built from that event (normally in state `received`). The handler may be async.
|
|
118
|
+
|
|
119
|
+
```typescript
|
|
120
|
+
client.onMessage(async (message) => {
|
|
121
|
+
console.log(`SMS from ${message.fromNumber}: ${message.body}`);
|
|
122
|
+
});
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### `onEvent(handler): typeof handler`
|
|
126
|
+
|
|
127
|
+
`onEvent()` registers a low-level observer for every inbound `signalwire.event`, whatever its type. The handler receives `(eventType: string, params: Record<string, unknown>)`, with `params` in the platform's raw `snake_case` form, and may be async.
|
|
128
|
+
|
|
129
|
+
```typescript
|
|
130
|
+
client.onEvent((eventType, params) => {
|
|
131
|
+
console.log(`event: ${eventType}`);
|
|
132
|
+
});
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
The observer runs before the client routes the event to a `Call` or `Message`, so an event reaches both. It also sees events that match no tracked call, such as state changes for calls this client didn't create. For inbound calls and messages, `onCall` and `onMessage` hand you objects that are ready to use.
|
|
136
|
+
|
|
137
|
+
### `dial(devices, options?): Promise<Call>`
|
|
138
|
+
|
|
139
|
+
`dial()` places an outbound call and resolves with a `Call` once a device answers. It takes these arguments:
|
|
140
|
+
|
|
141
|
+
- `devices`: a nested array of device objects. The outer array holds serial attempts, and each inner array holds devices dialed in parallel.
|
|
142
|
+
- `options.tag`: a correlation tag. The client generates a UUID when you omit it.
|
|
143
|
+
- `options.maxDuration`: the maximum call duration in minutes, sent as `max_duration`
|
|
144
|
+
- `options.dialTimeout`: seconds to wait for an answer after the platform accepts the dial (default 120)
|
|
145
|
+
|
|
146
|
+
This call rings one number and waits up to 30 seconds:
|
|
147
|
+
|
|
148
|
+
```typescript
|
|
149
|
+
const call = await client.dial(
|
|
150
|
+
[[{ type: 'phone', to: '+15551234567', from: '+15559876543' }]],
|
|
151
|
+
{ dialTimeout: 30 },
|
|
152
|
+
);
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
`dial()` doesn't read a call ID from the `calling.dial` response. It waits for a `calling.call.dial` event that carries its tag. It resolves when that event's `dial_state` is `answered` and rejects with a `RelayError` when it's `failed`. It also rejects when `dialTimeout` passes or the connection closes.
|
|
156
|
+
|
|
157
|
+
### `sendMessage(options): Promise<Message>`
|
|
158
|
+
|
|
159
|
+
`sendMessage()` sends an outbound SMS or MMS. It takes `toNumber` and `fromNumber`, with `body`, `media` or both, and resolves with a `Message` once the platform accepts the send.
|
|
160
|
+
|
|
161
|
+
```typescript
|
|
162
|
+
const message = await client.sendMessage({
|
|
163
|
+
toNumber: '+15552222222',
|
|
164
|
+
fromNumber: '+15551111111',
|
|
165
|
+
body: 'Hello!',
|
|
166
|
+
});
|
|
167
|
+
await message.wait(); // resolves at delivered, undelivered or failed
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
It throws an `Error` when both `body` and `media` are missing. [Messaging](messaging.md) lists every option.
|
|
171
|
+
|
|
172
|
+
### `execute(method, params): Promise<Record<string, unknown>>`
|
|
173
|
+
|
|
174
|
+
`execute()` sends a JSON-RPC request and resolves with the response's `result` object. `Call` methods use it, and you can use it for RELAY methods the SDK has no helper for.
|
|
175
|
+
|
|
176
|
+
```typescript
|
|
177
|
+
await client.execute('calling.play', { /* ... */ });
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
It rejects with a `RelayError` when the result `code` isn't 2xx. Unlike `Call` methods, it doesn't turn a 404 or 410 into `{}`. A request that gets no response within 30 seconds rejects with a `RelayError` (code `-1`), and the client then closes the connection. Under `run()`, the client reconnects.
|
|
181
|
+
|
|
182
|
+
### `notify(method, params): void`
|
|
183
|
+
|
|
184
|
+
`notify()` sends a JSON-RPC frame without waiting for a response, and does nothing when the socket is closed. The SDK's audit harness uses it. Use `execute()` in application code, because `notify()` never checks the result.
|
|
185
|
+
|
|
186
|
+
### `receive(contexts): Promise<void>` / `unreceive(contexts): Promise<void>`
|
|
187
|
+
|
|
188
|
+
`receive()` subscribes a connected client to more contexts, and `unreceive()` removes contexts. Each does nothing when the array is empty.
|
|
189
|
+
|
|
190
|
+
```typescript
|
|
191
|
+
await client.receive(['new-context']);
|
|
192
|
+
await client.unreceive(['old-context']);
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
## Properties
|
|
196
|
+
|
|
197
|
+
`RelayClient` exposes these read-only properties:
|
|
198
|
+
|
|
199
|
+
| Property | Type | Description |
|
|
200
|
+
|----------|------|-------------|
|
|
201
|
+
| `relayProtocol` | `string` | Protocol string the server assigned in the `signalwire.connect` result (`''` before the first connection) |
|
|
202
|
+
| `project` | `string` | Project ID |
|
|
203
|
+
| `token` | `string` | API token |
|
|
204
|
+
| `jwtToken` | `string` | JWT (`''` when not used) |
|
|
205
|
+
| `host` | `string` | RELAY host |
|
|
206
|
+
| `scheme` | `'ws' \| 'wss'` | WebSocket scheme |
|
|
207
|
+
| `contexts` | `string[]` | Contexts passed to the constructor. `receive()` and `unreceive()` don't change this array. |
|
|
208
|
+
|
|
209
|
+
## Connection Behavior
|
|
210
|
+
|
|
211
|
+
The client manages its WebSocket connection in these ways:
|
|
212
|
+
|
|
213
|
+
- **Reconnection**: `run()` reconnects after a dropped connection. The delay starts at 1 second, doubles after each attempt and stops growing at 30 seconds. A successful connection resets it to 1 second.
|
|
214
|
+
- **Ping**: The client sends `signalwire.ping` every 30 seconds. A ping that gets no response closes the connection like any other request, and so do 3 failed pings in a row. The client answers the server's pings.
|
|
215
|
+
- **Request timeout**: A request with no response in 30 seconds rejects with a `RelayError`, and the client closes the connection.
|
|
216
|
+
- **Request queueing**: A request made while the client is disconnected waits in a queue of up to 500 requests. The client sends the queue after the next successful authentication. Each queued request still times out after 30 seconds, and a full queue rejects new requests with a `RelayError`.
|
|
217
|
+
- **In-flight requests**: When the connection drops under `run()`, requests already sent are rejected with a `RelayError`. The client doesn't resend them.
|
|
218
|
+
- **Session resumption**: The client stores the protocol string and the latest `authorization_state` the server sends, and sends both back when it reconnects.
|
|
219
|
+
- **Server disconnect**: The client acknowledges a `signalwire.disconnect` request. When the request carries `restart: true`, the client clears the stored protocol and authorization state, so the next connection starts a new session.
|
|
220
|
+
|
|
221
|
+
## Concurrency
|
|
222
|
+
|
|
223
|
+
The client calls each inbound call handler without awaiting it, so handlers for different calls run concurrently on Node's event loop. Synchronous or CPU-bound work in a handler blocks every other call until it finishes.
|
|
224
|
+
|
|
225
|
+
The `maxActiveCalls` option (default 1000) caps the calls one client tracks, inbound and dialed. When the cap is reached, the client logs an error and ignores new inbound calls; your handler doesn't run for them. The client stops tracking a call when it reaches `ended`.
|
|
226
|
+
|
|
227
|
+
`RELAY_MAX_CONNECTIONS` (default 1) limits how many connected `RelayClient` instances one process may have. The SDK reads it once, when its module loads, so set it in the environment before your program starts.
|
|
228
|
+
|
|
229
|
+
## Error Handling
|
|
230
|
+
|
|
231
|
+
`RelayError` has a numeric `code`, a `serverMessage` with the server's text, and a `message` of the form `RELAY error <code>: <serverMessage>`. Catch it around calls that can fail:
|
|
232
|
+
|
|
233
|
+
```typescript
|
|
234
|
+
import { RelayError } from '@signalwire/sdk';
|
|
235
|
+
|
|
236
|
+
declare const call: import('@signalwire/sdk').Call; // a live relay Call
|
|
237
|
+
try {
|
|
238
|
+
await call.play([{ type: 'tts', params: { text: 'Hello' } }]);
|
|
239
|
+
} catch (err) {
|
|
240
|
+
if (err instanceof RelayError) {
|
|
241
|
+
console.error(`Error ${err.code}: ${err.serverMessage}`);
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
The client throws `RelayError` when the server returns a non-2xx result code or a JSON-RPC error, and uses code `-1` for timeouts and closed connections. `Call` methods treat 404 and 410 as "the call no longer exists": they log a warning and resolve with `{}` in place of throwing. Every other error code is thrown.
|
|
247
|
+
|
|
248
|
+
## Environment Variables
|
|
249
|
+
|
|
250
|
+
The client reads these variables in production:
|
|
251
|
+
|
|
252
|
+
| Variable | Purpose |
|
|
253
|
+
|----------|---------|
|
|
254
|
+
| `SIGNALWIRE_PROJECT_ID` | Default for `project` |
|
|
255
|
+
| `SIGNALWIRE_API_TOKEN` | Default for `token` |
|
|
256
|
+
| `SIGNALWIRE_JWT_TOKEN` | Default for `jwtToken` |
|
|
257
|
+
| `SIGNALWIRE_SPACE` | Default for `host` |
|
|
258
|
+
| `RELAY_MAX_ACTIVE_CALLS` | Default for `maxActiveCalls` |
|
|
259
|
+
| `RELAY_MAX_CONNECTIONS` | Connected clients allowed per process (default 1, minimum 1). Read once, when the SDK module loads. |
|
|
260
|
+
| `SIGNALWIRE_RELAY_CA_FILE` | Path to a CA bundle the WebSocket connection trusts in place of Node's default store. Read at each `connect()`; an unreadable file logs a warning and falls back to the default store. |
|
|
261
|
+
|
|
262
|
+
These variables exist for tests. Leave them unset in production:
|
|
263
|
+
|
|
264
|
+
| Variable | Purpose |
|
|
265
|
+
|----------|---------|
|
|
266
|
+
| `SIGNALWIRE_RELAY_HOST` | Overrides `SIGNALWIRE_SPACE` as the default host, for a local fixture |
|
|
267
|
+
| `SIGNALWIRE_RELAY_SCHEME` | Default for `scheme` (`ws` or `wss`) |
|
|
268
|
+
| `SIGNALWIRE_RELAY_PING_INTERVAL_MS` | Client ping interval (default 30000) |
|
|
269
|
+
| `SIGNALWIRE_RELAY_PING_MAX_FAILURES` | Ping failures before the client closes the connection (default 3) |
|
|
270
|
+
| `SIGNALWIRE_RELAY_REQUEST_TIMEOUT_MS` | Request timeout (default 30000) |
|
|
271
|
+
| `SIGNALWIRE_RELAY_RECONNECT_MIN_DELAY_S` | First reconnect delay in seconds (default 1) |
|
|
272
|
+
| `SIGNALWIRE_RELAY_RECONNECT_MAX_DELAY_S` | Longest reconnect delay in seconds (default 30) |
|
|
273
|
+
|
|
274
|
+
## Next Steps
|
|
275
|
+
|
|
276
|
+
Continue with these pages:
|
|
277
|
+
|
|
278
|
+
- [Getting Started](getting-started.md): connecting and placing a first call
|
|
279
|
+
- [Call Methods Reference](call-methods.md): the methods on a `Call` object
|
|
280
|
+
- [Events](events.md): handling real-time call events
|
|
281
|
+
- [Messaging](messaging.md): sending and receiving SMS/MMS
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
# Events
|
|
2
|
+
|
|
3
|
+
RELAY events are notifications the platform pushes about call state and operation results. They arrive over the WebSocket as `signalwire.event` JSON-RPC messages. The client acknowledges each one, then routes it to the matching `Call`, `Message` or dial in progress.
|
|
4
|
+
|
|
5
|
+
<!-- snippet-setup -->
|
|
6
|
+
```ts
|
|
7
|
+
export {}; // treat each example as a module so top-level `await` is allowed
|
|
8
|
+
// Shared context the fragments on this page assume (constructed in the Getting Started example).
|
|
9
|
+
declare const client: import('@signalwire/sdk').RelayClient;
|
|
10
|
+
declare const call: import('@signalwire/sdk').Call; // a live relay Call
|
|
11
|
+
declare const rawPayload: Record<string, unknown>; // the params of a signalwire.event message: { event_type, params }
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Listening for Events
|
|
15
|
+
|
|
16
|
+
You can receive events on a call, through an action, or for the whole client.
|
|
17
|
+
|
|
18
|
+
### On a Call
|
|
19
|
+
|
|
20
|
+
Register a listener with `call.on()`, or wait for one event with `call.waitFor()`:
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
client.onCall(async (call) => {
|
|
24
|
+
// Register a listener
|
|
25
|
+
call.on('calling.call.play', (event) => console.log(`Play: ${JSON.stringify(event.params)}`));
|
|
26
|
+
|
|
27
|
+
// Or wait for a specific event (timeout in milliseconds)
|
|
28
|
+
const event = await call.waitFor(
|
|
29
|
+
'calling.call.state',
|
|
30
|
+
(e) => e.params.call_state === 'ended',
|
|
31
|
+
60_000,
|
|
32
|
+
);
|
|
33
|
+
});
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
The client routes an event to a call's listeners when the event's `params.call_id` matches a call it tracks. It handles `calling.call.receive`, `calling.call.dial` and the messaging events separately, so `call.on()` doesn't receive them. A `calling.call.dial` event that arrives after `dial()` has resolved is the exception, and goes to the answered call.
|
|
37
|
+
|
|
38
|
+
### Via Actions
|
|
39
|
+
|
|
40
|
+
Actions returned by `play()`, `record()` and the other action methods have a `wait()` method that resolves with the terminal event:
|
|
41
|
+
|
|
42
|
+
```typescript
|
|
43
|
+
const action = await call.play([{ type: 'tts', params: { text: 'Hello' } }]);
|
|
44
|
+
const event = await action.wait(30); // timeout in seconds
|
|
45
|
+
// event is the terminal event for this action
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### For Every Event
|
|
49
|
+
|
|
50
|
+
`client.onEvent()` registers one observer that receives every `signalwire.event`, as `(eventType, params)` with the raw params. It runs before the client's own routing, and sees events that match no tracked call:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
client.onEvent((eventType, params) => {
|
|
54
|
+
if (eventType === 'calling.conference') {
|
|
55
|
+
console.log(`Conference event: ${JSON.stringify(params)}`);
|
|
56
|
+
}
|
|
57
|
+
});
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Event Types
|
|
61
|
+
|
|
62
|
+
These event-type constants are exported from `@signalwire/sdk`:
|
|
63
|
+
|
|
64
|
+
| Constant | Value | Description |
|
|
65
|
+
|----------|-------|-------------|
|
|
66
|
+
| `EVENT_CALL_STATE` | `calling.call.state` | Call state changes (created, ringing, answered, ending, ended) |
|
|
67
|
+
| `EVENT_CALL_RECEIVE` | `calling.call.receive` | Inbound call notification |
|
|
68
|
+
| `EVENT_CALL_PLAY` | `calling.call.play` | Play operation state changes |
|
|
69
|
+
| `EVENT_CALL_RECORD` | `calling.call.record` | Record operation state changes |
|
|
70
|
+
| `EVENT_CALL_COLLECT` | `calling.call.collect` | Input collection results |
|
|
71
|
+
| `EVENT_CALL_CONNECT` | `calling.call.connect` | Bridge/connect state changes |
|
|
72
|
+
| `EVENT_CALL_DETECT` | `calling.call.detect` | Detection results |
|
|
73
|
+
| `EVENT_CALL_FAX` | `calling.call.fax` | Fax operation state changes |
|
|
74
|
+
| `EVENT_CALL_TAP` | `calling.call.tap` | Tap operation state changes |
|
|
75
|
+
| `EVENT_CALL_STREAM` | `calling.call.stream` | Stream operation state changes |
|
|
76
|
+
| `EVENT_CALL_SEND_DIGITS` | `calling.call.send_digits` | DTMF send completion |
|
|
77
|
+
| `EVENT_CALL_DIAL` | `calling.call.dial` | Outbound dial progress |
|
|
78
|
+
| `EVENT_CALL_REFER` | `calling.call.refer` | SIP REFER results |
|
|
79
|
+
| `EVENT_CALL_DENOISE` | `calling.call.denoise` | Denoise state changes |
|
|
80
|
+
| `EVENT_CALL_PAY` | `calling.call.pay` | Payment state changes |
|
|
81
|
+
| `EVENT_CALL_QUEUE` | `calling.call.queue` | Queue state changes |
|
|
82
|
+
| `EVENT_CALL_ECHO` | `calling.call.echo` | Echo state changes |
|
|
83
|
+
| `EVENT_CALL_TRANSCRIBE` | `calling.call.transcribe` | Transcription state changes |
|
|
84
|
+
| `EVENT_CALL_HOLD` | `calling.call.hold` | Hold/unhold state changes |
|
|
85
|
+
| `EVENT_CONFERENCE` | `calling.conference` | Conference state changes |
|
|
86
|
+
| `EVENT_CALLING_ERROR` | `calling.error` | Error events |
|
|
87
|
+
| `EVENT_MESSAGING_RECEIVE` | `messaging.receive` | Inbound message received |
|
|
88
|
+
| `EVENT_MESSAGING_STATE` | `messaging.state` | Outbound message state change |
|
|
89
|
+
|
|
90
|
+
The client also handles `signalwire.authorization.state` internally, to store the state it sends back on reconnect. The SDK has no constant or typed class for `calling.call.ai`, the event type `AIAction` is declared with; such events arrive as a plain `RelayEvent`.
|
|
91
|
+
|
|
92
|
+
## Typed Event Classes
|
|
93
|
+
|
|
94
|
+
`parseEvent()` takes the `params` object of a `signalwire.event` message, which holds `event_type` and the event's own `params`. It returns an instance of the class for that `event_type`, or a plain `RelayEvent` for a type with no class. The typed classes add camelCase properties for the event's fields:
|
|
95
|
+
|
|
96
|
+
<!-- snippet: no-run illustrative fragment: references the assumed `rawPayload` object established by the surrounding handler example -->
|
|
97
|
+
```typescript
|
|
98
|
+
import { CallStateEvent, parseEvent } from '@signalwire/sdk';
|
|
99
|
+
|
|
100
|
+
// Parse by event type
|
|
101
|
+
const event = parseEvent(rawPayload);
|
|
102
|
+
if (event instanceof CallStateEvent) {
|
|
103
|
+
console.log(event.callState); // for example, "answered"
|
|
104
|
+
console.log(event.endReason); // set when callState is "ended"
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
// Or build one class directly
|
|
108
|
+
const stateEvent = CallStateEvent.fromPayload(rawPayload);
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
The events that `call.on()` listeners, `call.waitFor()` and `action.wait()` deliver come from `parseEvent()`, so you can check them with `instanceof`. `Message` listeners and `message.wait()` receive a plain `RelayEvent`.
|
|
112
|
+
|
|
113
|
+
### Available Typed Events
|
|
114
|
+
|
|
115
|
+
Each class reads these properties from the event's `params`:
|
|
116
|
+
|
|
117
|
+
| Class | Properties |
|
|
118
|
+
|-------|------------|
|
|
119
|
+
| `CallStateEvent` | `callState`, `endReason`, `direction`, `device` |
|
|
120
|
+
| `CallReceiveEvent` | `callState`, `direction`, `device`, `nodeId`, `projectId`, `context`, `segmentId`, `tag` |
|
|
121
|
+
| `PlayEvent` | `controlId`, `state` |
|
|
122
|
+
| `RecordEvent` | `controlId`, `state`, `url`, `duration`, `size`, `record` |
|
|
123
|
+
| `CollectEvent` | `controlId`, `state`, `result`, `final` |
|
|
124
|
+
| `ConnectEvent` | `connectState`, `peer` |
|
|
125
|
+
| `DetectEvent` | `controlId`, `detect` |
|
|
126
|
+
| `FaxEvent` | `controlId`, `fax` |
|
|
127
|
+
| `TapEvent` | `controlId`, `state`, `tap`, `device` |
|
|
128
|
+
| `StreamEvent` | `controlId`, `state`, `url`, `name` |
|
|
129
|
+
| `SendDigitsEvent` | `controlId`, `state` |
|
|
130
|
+
| `DialEvent` | `tag`, `dialState`, `call` |
|
|
131
|
+
| `ReferEvent` | `state`, `sipReferTo`, `sipReferResponseCode`, `sipNotifyResponseCode` |
|
|
132
|
+
| `DenoiseEvent` | `denoised` |
|
|
133
|
+
| `PayEvent` | `controlId`, `state` |
|
|
134
|
+
| `QueueEvent` | `controlId`, `status`, `queueId`, `queueName`, `position`, `size` |
|
|
135
|
+
| `EchoEvent` | `state` |
|
|
136
|
+
| `TranscribeEvent` | `controlId`, `state`, `url`, `recordingId`, `duration`, `size` |
|
|
137
|
+
| `HoldEvent` | `state` |
|
|
138
|
+
| `ConferenceEvent` | `conferenceId`, `name`, `status` |
|
|
139
|
+
| `CallingErrorEvent` | `code`, `message` |
|
|
140
|
+
| `MessageReceiveEvent` | `messageId`, `context`, `direction`, `fromNumber`, `toNumber`, `body`, `media`, `segments`, `messageState`, `tags` |
|
|
141
|
+
| `MessageStateEvent` | `messageId`, `context`, `direction`, `fromNumber`, `toNumber`, `body`, `media`, `segments`, `messageState`, `reason`, `tags` |
|
|
142
|
+
|
|
143
|
+
Most properties map to the `snake_case` field of the same name. These don't:
|
|
144
|
+
|
|
145
|
+
- `RecordEvent.url`, `duration` and `size` read `params.record.*` first, then `params.*`.
|
|
146
|
+
- `QueueEvent.queueId` and `queueName` read `params.id` and `params.name`.
|
|
147
|
+
- `CallReceiveEvent.context` reads `params.context`, then `params.protocol`.
|
|
148
|
+
|
|
149
|
+
A missing field becomes `''`, `0`, `{}` or `[]`, depending on its type. `CollectEvent.final` is `undefined` when the event doesn't carry it.
|
|
150
|
+
|
|
151
|
+
`EVENT_CLASS_MAP` maps each event-type string to its class. Every typed event also has the base `RelayEvent` fields: `eventType`, `params`, `callId` and `timestamp`. `params` is the raw object, with the platform's `snake_case` names, and `timestamp` comes from `params.timestamp` (`0` when absent).
|
|
152
|
+
|
|
153
|
+
## Call States
|
|
154
|
+
|
|
155
|
+
A call moves through these states in order:
|
|
156
|
+
|
|
157
|
+
```text
|
|
158
|
+
created -> ringing -> answered -> ending -> ended
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
The constants are `CALL_STATE_CREATED`, `CALL_STATE_RINGING`, `CALL_STATE_ANSWERED`, `CALL_STATE_ENDING` and `CALL_STATE_ENDED`. The `CallState` type is the union of these values. `isCallStateTerminal(state)` and `call.isTerminal` test for `ended`, the only terminal state.
|
|
162
|
+
|
|
163
|
+
An outbound dial has its own states, in `DialEvent.dialState`: `dialing`, then `answered` or `failed`. The `DialState` type and `isDialStateTerminal()` cover them.
|
|
164
|
+
|
|
165
|
+
## End Reasons
|
|
166
|
+
|
|
167
|
+
When a call reaches `ended`, `CallStateEvent.endReason` holds the `end_reason` the platform sent. The SDK's constants list these values; the package doesn't export constants for them:
|
|
168
|
+
|
|
169
|
+
| Reason | Description |
|
|
170
|
+
|--------|-------------|
|
|
171
|
+
| `hangup` | Normal hangup |
|
|
172
|
+
| `cancel` | Caller cancelled |
|
|
173
|
+
| `busy` | Destination busy |
|
|
174
|
+
| `noAnswer` | No answer |
|
|
175
|
+
| `decline` | Call declined |
|
|
176
|
+
| `error` | Error occurred |
|
|
177
|
+
| `abandoned` | Call abandoned |
|
|
178
|
+
| `max_duration` | Max duration reached |
|
|
179
|
+
| `not_found` | Destination not found |
|
|
180
|
+
|
|
181
|
+
## Message States
|
|
182
|
+
|
|
183
|
+
Outbound messages move through `queued`, `initiated` and `sent`, and end at `delivered`, `undelivered` or `failed`. Inbound messages arrive with state `received`.
|
|
184
|
+
|
|
185
|
+
The constants are `MESSAGE_STATE_QUEUED`, `MESSAGE_STATE_INITIATED`, `MESSAGE_STATE_SENT`, `MESSAGE_STATE_DELIVERED`, `MESSAGE_STATE_UNDELIVERED`, `MESSAGE_STATE_FAILED` and `MESSAGE_STATE_RECEIVED`. The `MessageState` type is their union, and `isMessageStateTerminal()` tests for the three terminal states.
|
|
186
|
+
|
|
187
|
+
## Next Steps
|
|
188
|
+
|
|
189
|
+
Continue with these pages:
|
|
190
|
+
|
|
191
|
+
- [Call Methods Reference](call-methods.md): the methods on a `Call` object
|
|
192
|
+
- [Client Reference](client-reference.md): `RelayClient` options and methods
|
|
193
|
+
- [Messaging](messaging.md): sending and receiving SMS/MMS
|