@signalwire/sdk 2.0.0 → 2.0.2
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/dist/AgentBase.d.ts +1045 -0
- package/dist/AgentBase.js +2375 -0
- package/dist/AgentBase.js.map +1 -0
- package/dist/AgentServer.d.ts +146 -0
- package/dist/AgentServer.js +388 -0
- package/dist/AgentServer.js.map +1 -0
- package/dist/AuthHandler.d.ts +127 -0
- package/dist/AuthHandler.js +212 -0
- package/dist/AuthHandler.js.map +1 -0
- package/dist/ConfigLoader.d.ts +170 -0
- package/dist/ConfigLoader.js +393 -0
- package/dist/ConfigLoader.js.map +1 -0
- package/dist/ContextBuilder.d.ts +652 -0
- package/dist/ContextBuilder.js +1115 -0
- package/dist/ContextBuilder.js.map +1 -0
- package/dist/DataMap.d.ts +271 -0
- package/dist/DataMap.js +430 -0
- package/dist/DataMap.js.map +1 -0
- package/dist/FunctionResult.d.ts +481 -0
- package/dist/FunctionResult.js +775 -0
- package/dist/FunctionResult.js.map +1 -0
- package/dist/Logger.d.ts +113 -0
- package/dist/Logger.js +320 -0
- package/dist/Logger.js.map +1 -0
- package/dist/PomBuilder.d.ts +208 -0
- package/dist/PomBuilder.js +409 -0
- package/dist/PomBuilder.js.map +1 -0
- package/dist/PromptManager.d.ts +85 -0
- package/dist/PromptManager.js +108 -0
- package/dist/PromptManager.js.map +1 -0
- package/dist/SWMLHandler.d.ts +159 -0
- package/dist/SWMLHandler.js +229 -0
- package/dist/SWMLHandler.js.map +1 -0
- package/dist/SWMLService.d.ts +326 -0
- package/dist/SWMLService.js +610 -0
- package/dist/SWMLService.js.map +1 -0
- package/dist/SchemaUtils.d.ts +108 -0
- package/dist/SchemaUtils.js +317 -0
- package/dist/SchemaUtils.js.map +1 -0
- package/dist/SecurityUtils.d.ts +60 -0
- package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
- package/dist/SecurityUtils.js.map +1 -0
- package/dist/ServerlessAdapter.d.ts +119 -0
- package/dist/ServerlessAdapter.js +188 -0
- package/dist/ServerlessAdapter.js.map +1 -0
- package/dist/SessionManager.d.ts +142 -0
- package/dist/SessionManager.js +260 -0
- package/dist/SessionManager.js.map +1 -0
- package/dist/SslConfig.d.ts +77 -0
- package/dist/SslConfig.js +100 -0
- package/dist/SslConfig.js.map +1 -0
- package/dist/SwaigFunction.d.ts +159 -0
- package/dist/SwaigFunction.js +209 -0
- package/dist/SwaigFunction.js.map +1 -0
- package/dist/SwmlBuilder.d.ts +165 -0
- package/dist/SwmlBuilder.js +247 -0
- package/dist/SwmlBuilder.js.map +1 -0
- package/dist/SwmlVerbMethods.generated.d.ts +254 -0
- package/dist/SwmlVerbMethods.generated.js +9 -0
- package/dist/SwmlVerbMethods.generated.js.map +1 -0
- package/dist/TypeInference.d.ts +71 -0
- package/dist/TypeInference.js +164 -0
- package/dist/TypeInference.js.map +1 -0
- package/dist/WebService.d.ts +148 -0
- package/dist/WebService.js +532 -0
- package/dist/WebService.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +22 -0
- package/dist/cli/agent-loader.js +144 -0
- package/dist/cli/agent-loader.js.map +1 -0
- package/dist/cli/mock-data.d.ts +37 -0
- package/dist/cli/mock-data.js +80 -0
- package/dist/cli/mock-data.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +32 -0
- package/dist/cli/swaig-test.js +418 -0
- package/dist/cli/swaig-test.js.map +1 -0
- package/dist/generateVerbTypes.d.ts +11 -0
- package/dist/generateVerbTypes.js +265 -0
- package/dist/generateVerbTypes.js.map +1 -0
- package/dist/index.d.ts +146 -0
- package/dist/index.js +152 -0
- package/dist/index.js.map +1 -0
- package/dist/livewire/index.d.ts +653 -0
- package/dist/livewire/index.js +992 -0
- package/dist/livewire/index.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +89 -0
- package/dist/prefabs/ConciergeAgent.js +245 -0
- package/dist/prefabs/ConciergeAgent.js.map +1 -0
- package/dist/prefabs/FAQBotAgent.d.ts +113 -0
- package/dist/prefabs/FAQBotAgent.js +329 -0
- package/dist/prefabs/FAQBotAgent.js.map +1 -0
- package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
- package/dist/prefabs/InfoGathererAgent.js +287 -0
- package/dist/prefabs/InfoGathererAgent.js.map +1 -0
- package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
- package/dist/prefabs/ReceptionistAgent.js +303 -0
- package/dist/prefabs/ReceptionistAgent.js.map +1 -0
- package/dist/prefabs/SurveyAgent.d.ts +148 -0
- package/dist/prefabs/SurveyAgent.js +540 -0
- package/dist/prefabs/SurveyAgent.js.map +1 -0
- package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
- package/dist/prefabs/index.js +14 -0
- package/dist/prefabs/index.js.map +1 -0
- package/dist/relay/Action.d.ts +258 -0
- package/dist/relay/Action.js +402 -0
- package/dist/relay/Action.js.map +1 -0
- package/dist/relay/Call.d.ts +697 -0
- package/dist/relay/Call.js +1062 -0
- package/dist/relay/Call.js.map +1 -0
- package/dist/relay/Deferred.d.ts +44 -0
- package/dist/relay/Deferred.js +69 -0
- package/dist/relay/Deferred.js.map +1 -0
- package/dist/relay/Message.d.ts +103 -0
- package/dist/relay/Message.js +169 -0
- package/dist/relay/Message.js.map +1 -0
- package/dist/relay/RelayClient.d.ts +302 -0
- package/dist/relay/RelayClient.js +1019 -0
- package/dist/relay/RelayClient.js.map +1 -0
- package/dist/relay/RelayError.d.ts +15 -0
- package/dist/relay/RelayError.js +20 -0
- package/dist/relay/RelayError.js.map +1 -0
- package/dist/relay/RelayEvent.d.ts +254 -0
- package/dist/relay/RelayEvent.js +509 -0
- package/dist/relay/RelayEvent.js.map +1 -0
- package/dist/relay/constants.d.ts +90 -0
- package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
- package/dist/relay/constants.js.map +1 -0
- package/dist/relay/index.d.ts +16 -0
- package/dist/relay/index.js +18 -0
- package/dist/relay/index.js.map +1 -0
- package/dist/relay/types.d.ts +142 -0
- package/dist/relay/types.js +5 -0
- package/dist/relay/types.js.map +1 -0
- package/dist/rest/HttpClient.d.ts +80 -0
- package/dist/rest/HttpClient.js +148 -0
- package/dist/rest/HttpClient.js.map +1 -0
- package/dist/rest/RestError.d.ts +30 -0
- package/dist/rest/RestError.js +39 -0
- package/dist/rest/RestError.js.map +1 -0
- package/dist/rest/base/BaseResource.d.ts +24 -0
- package/dist/rest/base/BaseResource.js +29 -0
- package/dist/rest/base/BaseResource.js.map +1 -0
- package/dist/rest/base/CrudResource.d.ts +68 -0
- package/dist/rest/base/CrudResource.js +82 -0
- package/dist/rest/base/CrudResource.js.map +1 -0
- package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
- package/dist/rest/base/CrudWithAddresses.js +25 -0
- package/dist/rest/base/CrudWithAddresses.js.map +1 -0
- package/{src/rest/index.ts → dist/rest/index.d.ts} +53 -122
- package/dist/rest/index.js +195 -0
- package/dist/rest/index.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +46 -0
- package/dist/rest/namespaces/addresses.js +55 -0
- package/dist/rest/namespaces/addresses.js.map +1 -0
- package/dist/rest/namespaces/calling.d.ts +382 -0
- package/dist/rest/namespaces/calling.js +478 -0
- package/dist/rest/namespaces/calling.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +22 -0
- package/dist/rest/namespaces/chat.js +26 -0
- package/dist/rest/namespaces/chat.js.map +1 -0
- package/dist/rest/namespaces/compat.d.ts +585 -0
- package/dist/rest/namespaces/compat.js +735 -0
- package/dist/rest/namespaces/compat.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +66 -0
- package/dist/rest/namespaces/datasphere.js +77 -0
- package/dist/rest/namespaces/datasphere.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +282 -0
- package/dist/rest/namespaces/fabric.js +373 -0
- package/dist/rest/namespaces/fabric.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
- package/dist/rest/namespaces/imported-numbers.js +26 -0
- package/dist/rest/namespaces/imported-numbers.js.map +1 -0
- package/dist/rest/namespaces/logs.d.ts +105 -0
- package/dist/rest/namespaces/logs.js +133 -0
- package/dist/rest/namespaces/logs.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +29 -0
- package/dist/rest/namespaces/lookup.js +32 -0
- package/dist/rest/namespaces/lookup.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +46 -0
- package/dist/rest/namespaces/mfa.js +54 -0
- package/dist/rest/namespaces/mfa.js.map +1 -0
- package/dist/rest/namespaces/number-groups.d.ts +49 -0
- package/dist/rest/namespaces/number-groups.js +58 -0
- package/dist/rest/namespaces/number-groups.js.map +1 -0
- package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
- package/dist/rest/namespaces/phone-numbers.js +67 -0
- package/dist/rest/namespaces/phone-numbers.js.map +1 -0
- package/dist/rest/namespaces/project.d.ts +46 -0
- package/dist/rest/namespaces/project.js +56 -0
- package/dist/rest/namespaces/project.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +22 -0
- package/dist/rest/namespaces/pubsub.js +26 -0
- package/dist/rest/namespaces/pubsub.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +42 -0
- package/dist/rest/namespaces/queues.js +49 -0
- package/dist/rest/namespaces/queues.js.map +1 -0
- package/dist/rest/namespaces/recordings.d.ts +38 -0
- package/dist/rest/namespaces/recordings.js +45 -0
- package/dist/rest/namespaces/recordings.js.map +1 -0
- package/dist/rest/namespaces/registry.d.ts +141 -0
- package/dist/rest/namespaces/registry.js +178 -0
- package/dist/rest/namespaces/registry.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +39 -0
- package/dist/rest/namespaces/short-codes.js +46 -0
- package/dist/rest/namespaces/short-codes.js.map +1 -0
- package/dist/rest/namespaces/sip-profile.d.ts +28 -0
- package/dist/rest/namespaces/sip-profile.js +34 -0
- package/dist/rest/namespaces/sip-profile.js.map +1 -0
- package/dist/rest/namespaces/verified-callers.d.ts +33 -0
- package/dist/rest/namespaces/verified-callers.js +39 -0
- package/dist/rest/namespaces/verified-callers.js.map +1 -0
- package/dist/rest/namespaces/video.d.ts +235 -0
- package/dist/rest/namespaces/video.js +297 -0
- package/dist/rest/namespaces/video.js.map +1 -0
- package/dist/rest/pagination.d.ts +39 -0
- package/dist/rest/pagination.js +78 -0
- package/dist/rest/pagination.js.map +1 -0
- package/dist/rest/types.d.ts +54 -0
- package/dist/rest/types.js +5 -0
- package/dist/rest/types.js.map +1 -0
- package/dist/skills/SkillBase.d.ts +404 -0
- package/dist/skills/SkillBase.js +471 -0
- package/dist/skills/SkillBase.js.map +1 -0
- package/dist/skills/SkillManager.d.ts +195 -0
- package/dist/skills/SkillManager.js +378 -0
- package/dist/skills/SkillManager.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +176 -0
- package/dist/skills/SkillRegistry.js +310 -0
- package/dist/skills/SkillRegistry.js.map +1 -0
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
- package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
- package/dist/skills/builtin/ask_claude.d.ts +37 -0
- package/dist/skills/builtin/ask_claude.js +162 -0
- package/dist/skills/builtin/ask_claude.js.map +1 -0
- package/dist/skills/builtin/claude_skills.d.ts +75 -0
- package/dist/skills/builtin/claude_skills.js +753 -0
- package/dist/skills/builtin/claude_skills.js.map +1 -0
- package/dist/skills/builtin/custom_skills.d.ts +79 -0
- package/dist/skills/builtin/custom_skills.js +227 -0
- package/dist/skills/builtin/custom_skills.js.map +1 -0
- package/dist/skills/builtin/datasphere.d.ts +73 -0
- package/dist/skills/builtin/datasphere.js +350 -0
- package/dist/skills/builtin/datasphere.js.map +1 -0
- package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
- package/dist/skills/builtin/datasphere_serverless.js +291 -0
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
- package/dist/skills/builtin/datetime.d.ts +40 -0
- package/dist/skills/builtin/datetime.js +118 -0
- package/dist/skills/builtin/datetime.js.map +1 -0
- package/dist/skills/builtin/google_maps.d.ts +48 -0
- package/dist/skills/builtin/google_maps.js +470 -0
- package/dist/skills/builtin/google_maps.js.map +1 -0
- package/dist/skills/builtin/index.d.ts +31 -0
- package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
- package/dist/skills/builtin/index.js.map +1 -0
- package/dist/skills/builtin/info_gatherer.d.ts +115 -0
- package/dist/skills/builtin/info_gatherer.js +328 -0
- package/dist/skills/builtin/info_gatherer.js.map +1 -0
- package/dist/skills/builtin/joke.d.ts +41 -0
- package/dist/skills/builtin/joke.js +156 -0
- package/dist/skills/builtin/joke.js.map +1 -0
- package/dist/skills/builtin/math.d.ts +39 -0
- package/dist/skills/builtin/math.js +119 -0
- package/dist/skills/builtin/math.js.map +1 -0
- package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
- package/dist/skills/builtin/mcp_gateway.js +574 -0
- package/dist/skills/builtin/mcp_gateway.js.map +1 -0
- package/dist/skills/builtin/native_vector_search.d.ts +128 -0
- package/dist/skills/builtin/native_vector_search.js +752 -0
- package/dist/skills/builtin/native_vector_search.js.map +1 -0
- package/dist/skills/builtin/play_background_file.d.ts +59 -0
- package/dist/skills/builtin/play_background_file.js +274 -0
- package/dist/skills/builtin/play_background_file.js.map +1 -0
- package/dist/skills/builtin/spider.d.ts +91 -0
- package/dist/skills/builtin/spider.js +758 -0
- package/dist/skills/builtin/spider.js.map +1 -0
- package/dist/skills/builtin/swml_transfer.d.ts +66 -0
- package/dist/skills/builtin/swml_transfer.js +475 -0
- package/dist/skills/builtin/swml_transfer.js.map +1 -0
- package/dist/skills/builtin/weather_api.d.ts +59 -0
- package/dist/skills/builtin/weather_api.js +196 -0
- package/dist/skills/builtin/weather_api.js.map +1 -0
- package/dist/skills/builtin/web_search.d.ts +160 -0
- package/dist/skills/builtin/web_search.js +894 -0
- package/dist/skills/builtin/web_search.js.map +1 -0
- package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
- package/dist/skills/builtin/wikipedia_search.js +241 -0
- package/dist/skills/builtin/wikipedia_search.js.map +1 -0
- package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
- package/dist/skills/index.js +10 -0
- package/dist/skills/index.js.map +1 -0
- package/dist/types.d.ts +118 -0
- package/dist/types.js +5 -0
- package/dist/types.js.map +1 -0
- package/package.json +7 -1
- package/.github/workflows/publish.yml +0 -27
- package/.github/workflows/test.yml +0 -17
- package/CLAUDE.md +0 -112
- package/docs/MIGRATION-2.0.md +0 -81
- package/docs/agent-guide.md +0 -869
- package/docs/agent_guide.md +0 -1026
- package/docs/api-reference.md +0 -2420
- package/docs/api_reference.md +0 -1301
- package/docs/architecture.md +0 -843
- package/docs/cli-guide.md +0 -579
- package/docs/cli_guide.md +0 -448
- package/docs/cloud_functions_guide.md +0 -474
- package/docs/configuration.md +0 -422
- package/docs/contexts-guide.md +0 -787
- package/docs/contexts_guide.md +0 -511
- package/docs/datamap-guide.md +0 -1141
- package/docs/datamap_guide.md +0 -595
- package/docs/llm_parameters.md +0 -239
- package/docs/mcp_gateway_reference.md +0 -648
- package/docs/mcp_integration.md +0 -108
- package/docs/prefabs-guide.md +0 -800
- package/docs/sdk_features.md +0 -477
- package/docs/security.md +0 -436
- package/docs/serverless-guide.md +0 -513
- package/docs/skills-guide.md +0 -857
- package/docs/skills-system.md +0 -301
- package/docs/skills_parameter_schema.md +0 -392
- package/docs/skills_system.md +0 -467
- package/docs/swaig-reference.md +0 -1627
- package/docs/swaig_reference.md +0 -910
- package/docs/swml_service_guide.md +0 -600
- package/docs/third_party_skills.md +0 -533
- package/docs/web_service.md +0 -677
- package/examples/README.md +0 -131
- package/examples/advanced-datamap.ts +0 -100
- package/examples/advanced-dynamic-config.ts +0 -70
- package/examples/auto-vivified.ts +0 -94
- package/examples/call-flow.ts +0 -63
- package/examples/comprehensive-dynamic.ts +0 -125
- package/examples/contexts-steps.ts +0 -65
- package/examples/custom-path.ts +0 -45
- package/examples/datamap-tools.ts +0 -55
- package/examples/datasphere-multi-instance.ts +0 -63
- package/examples/datasphere-serverless-env.ts +0 -68
- package/examples/datasphere-webhook-env.ts +0 -66
- package/examples/datasphere.ts +0 -37
- package/examples/declarative.ts +0 -100
- package/examples/dynamic-config.ts +0 -54
- package/examples/dynamic-info-gatherer.ts +0 -69
- package/examples/dynamic-swml-service.ts +0 -67
- package/examples/gather-info.ts +0 -71
- package/examples/gather-per-question-functions-demo.ts +0 -140
- package/examples/joke-agent.ts +0 -34
- package/examples/kubernetes-agent.ts +0 -45
- package/examples/llm-params.ts +0 -69
- package/examples/mcp-agent.ts +0 -84
- package/examples/mcp-gateway.ts +0 -35
- package/examples/multi-agent.ts +0 -73
- package/examples/multi-endpoint.ts +0 -79
- package/examples/pom-prompt.ts +0 -71
- package/examples/prefab-concierge.ts +0 -47
- package/examples/prefab-faq.ts +0 -54
- package/examples/prefab-info-gatherer.ts +0 -33
- package/examples/prefab-receptionist.ts +0 -36
- package/examples/prefab-survey.ts +0 -68
- package/examples/record-call.ts +0 -67
- package/examples/relay-demo.ts +0 -33
- package/examples/room-and-sip.ts +0 -94
- package/examples/serverless-lambda.ts +0 -35
- package/examples/session-state.ts +0 -83
- package/examples/simple-agent.ts +0 -36
- package/examples/simple-static.ts +0 -29
- package/examples/skills-demo.ts +0 -38
- package/examples/step-function-inheritance-demo.ts +0 -124
- package/examples/swaig-features.ts +0 -187
- package/examples/swml-service-routing.ts +0 -66
- package/examples/swml-service.ts +0 -38
- package/examples/tap.ts +0 -68
- package/examples/verb-methods.ts +0 -45
- package/examples/web-search-multi-instance.ts +0 -72
- package/examples/web-search.ts +0 -38
- package/examples/wikipedia.ts +0 -36
- package/livewire/README.md +0 -140
- package/livewire/docs/migration-guide.md +0 -228
- package/livewire/examples/livewire-basic-agent.ts +0 -74
- package/livewire/examples/livewire-handoff.ts +0 -197
- package/livewire/examples/livewire-multi-tool.ts +0 -117
- package/relay/README.md +0 -70
- package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
- package/relay/docs/call-methods.md +0 -474
- package/relay/docs/client-reference.md +0 -142
- package/relay/docs/events.md +0 -134
- package/relay/docs/getting-started.md +0 -134
- package/relay/docs/guide.md +0 -306
- package/relay/docs/messaging.md +0 -182
- package/relay/examples/relay-inbound.ts +0 -66
- package/relay/examples/relay-messaging.ts +0 -71
- package/relay/examples/relay-outbound.ts +0 -76
- package/rest/README.md +0 -95
- package/rest/docs/calling.md +0 -273
- package/rest/docs/client-reference.md +0 -107
- package/rest/docs/compat.md +0 -204
- package/rest/docs/fabric.md +0 -183
- package/rest/docs/getting-started.md +0 -110
- package/rest/docs/guide.md +0 -351
- package/rest/docs/namespaces.md +0 -285
- package/rest/examples/rest-10dlc-registration.ts +0 -161
- package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
- package/rest/examples/rest-calling-play-and-record.ts +0 -91
- package/rest/examples/rest-client.ts +0 -65
- package/rest/examples/rest-compat-laml.ts +0 -210
- package/rest/examples/rest-datasphere-search.ts +0 -82
- package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
- package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
- package/rest/examples/rest-manage-resources.ts +0 -65
- package/rest/examples/rest-phone-number-management.ts +0 -197
- package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
- package/rest/examples/rest-video-rooms.ts +0 -186
- package/src/AgentBase.ts +0 -2489
- package/src/AgentServer.ts +0 -415
- package/src/AuthHandler.ts +0 -256
- package/src/ConfigLoader.ts +0 -447
- package/src/ContextBuilder.ts +0 -1150
- package/src/DataMap.ts +0 -449
- package/src/FunctionResult.ts +0 -866
- package/src/Logger.ts +0 -337
- package/src/PomBuilder.ts +0 -439
- package/src/PromptManager.ts +0 -133
- package/src/SWMLHandler.ts +0 -298
- package/src/SWMLService.ts +0 -717
- package/src/SchemaUtils.ts +0 -361
- package/src/ServerlessAdapter.ts +0 -221
- package/src/SessionManager.ts +0 -311
- package/src/SslConfig.ts +0 -118
- package/src/SwaigFunction.ts +0 -276
- package/src/SwmlBuilder.ts +0 -258
- package/src/SwmlVerbMethods.generated.ts +0 -234
- package/src/TypeInference.ts +0 -181
- package/src/WebService.ts +0 -619
- package/src/cli/agent-loader.ts +0 -166
- package/src/cli/mock-data.ts +0 -111
- package/src/cli/swaig-test.ts +0 -452
- package/src/generateVerbTypes.ts +0 -322
- package/src/index.ts +0 -167
- package/src/livewire/index.ts +0 -950
- package/src/prefabs/ConciergeAgent.ts +0 -287
- package/src/prefabs/FAQBotAgent.ts +0 -384
- package/src/prefabs/InfoGathererAgent.ts +0 -339
- package/src/prefabs/ReceptionistAgent.ts +0 -366
- package/src/prefabs/SurveyAgent.ts +0 -646
- package/src/relay/Action.ts +0 -314
- package/src/relay/Call.ts +0 -854
- package/src/relay/Deferred.ts +0 -71
- package/src/relay/Message.ts +0 -148
- package/src/relay/RelayClient.ts +0 -1036
- package/src/relay/RelayError.ts +0 -14
- package/src/relay/RelayEvent.ts +0 -892
- package/src/relay/index.ts +0 -123
- package/src/relay/types.ts +0 -149
- package/src/rest/HttpClient.ts +0 -103
- package/src/rest/RestError.ts +0 -31
- package/src/rest/base/BaseResource.ts +0 -19
- package/src/rest/base/CrudResource.ts +0 -51
- package/src/rest/base/CrudWithAddresses.ts +0 -26
- package/src/rest/namespaces/addresses.ts +0 -32
- package/src/rest/namespaces/calling.ts +0 -187
- package/src/rest/namespaces/chat.ts +0 -20
- package/src/rest/namespaces/compat.ts +0 -352
- package/src/rest/namespaces/datasphere.ts +0 -45
- package/src/rest/namespaces/fabric.ts +0 -222
- package/src/rest/namespaces/imported-numbers.ts +0 -20
- package/src/rest/namespaces/logs.ts +0 -84
- package/src/rest/namespaces/lookup.ts +0 -21
- package/src/rest/namespaces/mfa.ts +0 -30
- package/src/rest/namespaces/number-groups.ts +0 -38
- package/src/rest/namespaces/phone-numbers.ts +0 -44
- package/src/rest/namespaces/project.ts +0 -36
- package/src/rest/namespaces/pubsub.ts +0 -20
- package/src/rest/namespaces/queues.ts +0 -33
- package/src/rest/namespaces/recordings.ts +0 -28
- package/src/rest/namespaces/registry.ts +0 -101
- package/src/rest/namespaces/short-codes.ts +0 -28
- package/src/rest/namespaces/sip-profile.ts +0 -25
- package/src/rest/namespaces/verified-callers.ts +0 -27
- package/src/rest/namespaces/video.ts +0 -165
- package/src/rest/pagination.ts +0 -84
- package/src/rest/types.ts +0 -61
- package/src/skills/SkillBase.ts +0 -547
- package/src/skills/SkillManager.ts +0 -415
- package/src/skills/SkillRegistry.ts +0 -367
- package/src/skills/builtin/api_ninjas_trivia.ts +0 -280
- package/src/skills/builtin/ask_claude.ts +0 -241
- package/src/skills/builtin/claude_skills.ts +0 -978
- package/src/skills/builtin/custom_skills.ts +0 -312
- package/src/skills/builtin/datasphere.ts +0 -438
- package/src/skills/builtin/datasphere_serverless.ts +0 -339
- package/src/skills/builtin/datetime.ts +0 -130
- package/src/skills/builtin/google_maps.ts +0 -651
- package/src/skills/builtin/info_gatherer.ts +0 -405
- package/src/skills/builtin/joke.ts +0 -191
- package/src/skills/builtin/math.ts +0 -142
- package/src/skills/builtin/mcp_gateway.ts +0 -677
- package/src/skills/builtin/native_vector_search.ts +0 -901
- package/src/skills/builtin/play_background_file.ts +0 -358
- package/src/skills/builtin/spider.ts +0 -869
- package/src/skills/builtin/swml_transfer.ts +0 -635
- package/src/skills/builtin/weather_api.ts +0 -248
- package/src/skills/builtin/web_search.ts +0 -1074
- package/src/skills/builtin/wikipedia_search.ts +0 -299
- package/src/types.ts +0 -132
- package/tests/AgentBase.test.ts +0 -1093
- package/tests/AgentServer.test.ts +0 -126
- package/tests/AuthHandler.test.ts +0 -133
- package/tests/ConfigLoader.test.ts +0 -151
- package/tests/ContextBuilder.test.ts +0 -108
- package/tests/DataMap.test.ts +0 -367
- package/tests/EphemeralSkillCopy.test.ts +0 -107
- package/tests/FunctionResult.test.ts +0 -298
- package/tests/GracefulShutdown.test.ts +0 -46
- package/tests/Logger.test.ts +0 -420
- package/tests/PomBuilder.test.ts +0 -228
- package/tests/ProxyDetection.test.ts +0 -228
- package/tests/SWMLService.test.ts +0 -320
- package/tests/SWMLVerbHandler.test.ts +0 -523
- package/tests/SchemaUtils.test.ts +0 -106
- package/tests/SchemaUtils.verb.test.ts +0 -206
- package/tests/SecurityUtils.test.ts +0 -192
- package/tests/ServerlessAdapter.test.ts +0 -222
- package/tests/SessionManager.test.ts +0 -257
- package/tests/SkillBaseFeatures.test.ts +0 -130
- package/tests/SkillMultiInstance.test.ts +0 -102
- package/tests/SkillParameterSchemas.test.ts +0 -134
- package/tests/SkillRegistrySchema.test.ts +0 -84
- package/tests/SslConfig.test.ts +0 -97
- package/tests/SwmlBuilder.test.ts +0 -400
- package/tests/TypeInference.test.ts +0 -165
- package/tests/VerbHandlerRegistry.test.ts +0 -128
- package/tests/cli/mock-data.test.ts +0 -113
- package/tests/cli/swaig-test.test.ts +0 -108
- package/tests/examples.test.ts +0 -194
- package/tests/fixtures/scrape-parity/README.md +0 -53
- package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
- package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
- package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
- package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
- package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
- package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
- package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
- package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
- package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
- package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
- package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
- package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
- package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
- package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
- package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
- package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
- package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
- package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
- package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
- package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
- package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
- package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
- package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
- package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
- package/tests/fixtures/scrape-parity/python_extract.py +0 -109
- package/tests/livewire/livewire.test.ts +0 -780
- package/tests/mcp.test.ts +0 -221
- package/tests/prefabs/prefabs.test.ts +0 -1093
- package/tests/relay/Action.test.ts +0 -392
- package/tests/relay/Call.test.ts +0 -535
- package/tests/relay/Deferred.test.ts +0 -71
- package/tests/relay/Message.test.ts +0 -164
- package/tests/relay/RelayClient.test.ts +0 -779
- package/tests/relay/RelayEvent.test.ts +0 -463
- package/tests/relay/helpers.ts +0 -79
- package/tests/rest/HttpClient.test.ts +0 -274
- package/tests/rest/RestError.test.ts +0 -53
- package/tests/rest/calling.test.ts +0 -156
- package/tests/rest/client.test.ts +0 -197
- package/tests/rest/compat.test.ts +0 -335
- package/tests/rest/datasphere.test.ts +0 -71
- package/tests/rest/fabric.test.ts +0 -186
- package/tests/rest/helpers.ts +0 -95
- package/tests/rest/logs.test.ts +0 -68
- package/tests/rest/pagination.test.ts +0 -133
- package/tests/rest/registry.test.ts +0 -94
- package/tests/rest/relay-rest.test.ts +0 -290
- package/tests/rest/video.test.ts +0 -173
- package/tests/setup.ts +0 -6
- package/tests/skills/SkillBase.test.ts +0 -108
- package/tests/skills/SkillManager.test.ts +0 -268
- package/tests/skills/SkillRegistry.test.ts +0 -176
- package/tests/skills/builtin.test.ts +0 -1472
- package/tests/skills/claude-skills.test.ts +0 -54
- package/tests/skills/custom-skills.test.ts +0 -53
- package/tests/skills/datasphere-serverless.test.ts +0 -70
- package/tests/skills/datasphere.test.ts +0 -107
- package/tests/skills/datetime.test.ts +0 -101
- package/tests/skills/google-maps.test.ts +0 -78
- package/tests/skills/info-gatherer.test.ts +0 -411
- package/tests/skills/joke.test.ts +0 -81
- package/tests/skills/math.test.ts +0 -68
- package/tests/skills/mcp-gateway.test.ts +0 -101
- package/tests/skills/play-background.test.ts +0 -54
- package/tests/skills/spider.test.ts +0 -108
- package/tests/skills/swml-transfer.test.ts +0 -178
- package/tests/skills/trivia.test.ts +0 -54
- package/tests/skills/vector-search.test.ts +0 -135
- package/tests/skills/weather-api.test.ts +0 -77
- package/tests/skills/web-search-parity.test.ts +0 -59
- package/tests/skills/web-search.test.ts +0 -103
- package/tests/skills/wikipedia.test.ts +0 -63
- package/tsconfig.json +0 -18
- package/vitest.config.ts +0 -9
- /package/{src → dist}/schema.json +0 -0
package/relay/docs/events.md
DELETED
|
@@ -1,134 +0,0 @@
|
|
|
1
|
-
# Events
|
|
2
|
-
|
|
3
|
-
RELAY events are server-pushed notifications about call state changes and operation results. Events arrive over the WebSocket as `signalwire.event` JSON-RPC messages and are automatically routed to the correct `Call` object.
|
|
4
|
-
|
|
5
|
-
## Listening for Events
|
|
6
|
-
|
|
7
|
-
### On a Call
|
|
8
|
-
|
|
9
|
-
```python
|
|
10
|
-
@client.on_call
|
|
11
|
-
async def handle(call):
|
|
12
|
-
# Register a listener
|
|
13
|
-
call.on("calling.call.play", lambda event: print(f"Play: {event.params}"))
|
|
14
|
-
|
|
15
|
-
# Or wait for a specific event
|
|
16
|
-
event = await call.wait_for("calling.call.state",
|
|
17
|
-
predicate=lambda e: e.params.get("call_state") == "ended",
|
|
18
|
-
timeout=60.0,
|
|
19
|
-
)
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
### Via Actions
|
|
23
|
-
|
|
24
|
-
Actions returned by `play()`, `record()`, etc. have a `wait()` method that resolves when the operation completes:
|
|
25
|
-
|
|
26
|
-
```python
|
|
27
|
-
action = await call.play([{"type": "tts", "params": {"text": "Hello"}}])
|
|
28
|
-
event = await action.wait(timeout=30.0)
|
|
29
|
-
# event is a RelayEvent with the terminal state
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
## Event Types
|
|
33
|
-
|
|
34
|
-
All event type constants are importable from `signalwire_agents.relay`:
|
|
35
|
-
|
|
36
|
-
| Constant | Value | Description |
|
|
37
|
-
|----------|-------|-------------|
|
|
38
|
-
| `EVENT_CALL_STATE` | `calling.call.state` | Call state changes (created, ringing, answered, ending, ended) |
|
|
39
|
-
| `EVENT_CALL_RECEIVE` | `calling.call.receive` | Inbound call notification |
|
|
40
|
-
| `EVENT_CALL_PLAY` | `calling.call.play` | Play operation state changes |
|
|
41
|
-
| `EVENT_CALL_RECORD` | `calling.call.record` | Record operation state changes |
|
|
42
|
-
| `EVENT_CALL_COLLECT` | `calling.call.collect` | Input collection results |
|
|
43
|
-
| `EVENT_CALL_CONNECT` | `calling.call.connect` | Bridge/connect state changes |
|
|
44
|
-
| `EVENT_CALL_DETECT` | `calling.call.detect` | Detection results |
|
|
45
|
-
| `EVENT_CALL_FAX` | `calling.call.fax` | Fax operation state changes |
|
|
46
|
-
| `EVENT_CALL_TAP` | `calling.call.tap` | Tap operation state changes |
|
|
47
|
-
| `EVENT_CALL_STREAM` | `calling.call.stream` | Stream operation state changes |
|
|
48
|
-
| `EVENT_CALL_SEND_DIGITS` | `calling.call.send_digits` | DTMF send completion |
|
|
49
|
-
| `EVENT_CALL_DIAL` | `calling.call.dial` | Outbound dial progress |
|
|
50
|
-
| `EVENT_CALL_REFER` | `calling.call.refer` | SIP REFER results |
|
|
51
|
-
| `EVENT_CALL_DENOISE` | `calling.call.denoise` | Denoise state changes |
|
|
52
|
-
| `EVENT_CALL_PAY` | `calling.call.pay` | Payment state changes |
|
|
53
|
-
| `EVENT_CALL_QUEUE` | `calling.call.queue` | Queue state changes |
|
|
54
|
-
| `EVENT_CALL_ECHO` | `calling.call.echo` | Echo state changes |
|
|
55
|
-
| `EVENT_CALL_TRANSCRIBE` | `calling.call.transcribe` | Transcription state changes |
|
|
56
|
-
| `EVENT_CONFERENCE` | `calling.conference` | Conference state changes |
|
|
57
|
-
| `EVENT_CALLING_ERROR` | `calling.error` | Error events |
|
|
58
|
-
| `EVENT_MESSAGING_RECEIVE` | `messaging.receive` | Inbound message received |
|
|
59
|
-
| `EVENT_MESSAGING_STATE` | `messaging.state` | Outbound message state change |
|
|
60
|
-
|
|
61
|
-
## Typed Event Classes
|
|
62
|
-
|
|
63
|
-
Raw events are always `RelayEvent` with a `params` dict. For convenience, typed event classes provide named properties:
|
|
64
|
-
|
|
65
|
-
```python
|
|
66
|
-
from signalwire_agents.relay import CallStateEvent, PlayEvent, RecordEvent, parse_event
|
|
67
|
-
|
|
68
|
-
# Automatic parsing
|
|
69
|
-
event = parse_event(raw_payload)
|
|
70
|
-
|
|
71
|
-
# Or construct directly
|
|
72
|
-
if event.event_type == "calling.call.state":
|
|
73
|
-
state_event = CallStateEvent.from_payload(raw_payload)
|
|
74
|
-
print(state_event.call_state) # "answered"
|
|
75
|
-
print(state_event.end_reason) # "hangup" (only on ended)
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
### Available Typed Events
|
|
79
|
-
|
|
80
|
-
| Class | Key Properties |
|
|
81
|
-
|-------|---------------|
|
|
82
|
-
| `CallStateEvent` | `call_state`, `end_reason`, `direction`, `device` |
|
|
83
|
-
| `CallReceiveEvent` | `call_state`, `direction`, `device`, `node_id`, `context`, `tag` |
|
|
84
|
-
| `PlayEvent` | `control_id`, `state` |
|
|
85
|
-
| `RecordEvent` | `control_id`, `state`, `url`, `duration`, `size` |
|
|
86
|
-
| `CollectEvent` | `control_id`, `state`, `result`, `final` |
|
|
87
|
-
| `ConnectEvent` | `connect_state`, `peer` |
|
|
88
|
-
| `DetectEvent` | `control_id`, `detect` |
|
|
89
|
-
| `FaxEvent` | `control_id`, `fax` |
|
|
90
|
-
| `TapEvent` | `control_id`, `state`, `tap`, `device` |
|
|
91
|
-
| `StreamEvent` | `control_id`, `state`, `url`, `name` |
|
|
92
|
-
| `SendDigitsEvent` | `control_id`, `state` |
|
|
93
|
-
| `DialEvent` | `tag`, `dial_state`, `call` |
|
|
94
|
-
| `ReferEvent` | `state`, `sip_refer_to`, `sip_refer_response_code` |
|
|
95
|
-
| `DenoiseEvent` | `denoised` |
|
|
96
|
-
| `PayEvent` | `control_id`, `state` |
|
|
97
|
-
| `QueueEvent` | `control_id`, `status`, `queue_id`, `queue_name`, `position`, `size` |
|
|
98
|
-
| `EchoEvent` | `state` |
|
|
99
|
-
| `TranscribeEvent` | `control_id`, `state`, `url`, `duration`, `size` |
|
|
100
|
-
| `HoldEvent` | `state` |
|
|
101
|
-
| `ConferenceEvent` | `conference_id`, `name`, `status` |
|
|
102
|
-
| `CallingErrorEvent` | `code`, `message` |
|
|
103
|
-
| `MessageReceiveEvent` | `message_id`, `context`, `direction`, `from_number`, `to_number`, `body`, `media`, `segments`, `message_state`, `tags` |
|
|
104
|
-
| `MessageStateEvent` | `message_id`, `context`, `direction`, `from_number`, `to_number`, `body`, `media`, `segments`, `message_state`, `reason`, `tags` |
|
|
105
|
-
|
|
106
|
-
## Call States
|
|
107
|
-
|
|
108
|
-
```
|
|
109
|
-
created -> ringing -> answered -> ending -> ended
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
Constants: `CALL_STATE_CREATED`, `CALL_STATE_RINGING`, `CALL_STATE_ANSWERED`, `CALL_STATE_ENDING`, `CALL_STATE_ENDED`
|
|
113
|
-
|
|
114
|
-
## End Reasons
|
|
115
|
-
|
|
116
|
-
When a call reaches the `ended` state, the `end_reason` field indicates why:
|
|
117
|
-
|
|
118
|
-
| Reason | Description |
|
|
119
|
-
|--------|-------------|
|
|
120
|
-
| `hangup` | Normal hangup |
|
|
121
|
-
| `cancel` | Caller cancelled |
|
|
122
|
-
| `busy` | Destination busy |
|
|
123
|
-
| `noAnswer` | No answer |
|
|
124
|
-
| `decline` | Call declined |
|
|
125
|
-
| `error` | Error occurred |
|
|
126
|
-
| `abandoned` | Call abandoned |
|
|
127
|
-
| `max_duration` | Max duration reached |
|
|
128
|
-
| `not_found` | Destination not found |
|
|
129
|
-
|
|
130
|
-
## Message States
|
|
131
|
-
|
|
132
|
-
Outbound messages progress through: `queued` → `initiated` → `sent` → `delivered` (or `undelivered`/`failed`).
|
|
133
|
-
|
|
134
|
-
Constants: `MESSAGE_STATE_QUEUED`, `MESSAGE_STATE_INITIATED`, `MESSAGE_STATE_SENT`, `MESSAGE_STATE_DELIVERED`, `MESSAGE_STATE_UNDELIVERED`, `MESSAGE_STATE_FAILED`, `MESSAGE_STATE_RECEIVED`
|
|
@@ -1,134 +0,0 @@
|
|
|
1
|
-
# Getting Started with RELAY
|
|
2
|
-
|
|
3
|
-
The RELAY client connects to SignalWire via WebSocket and gives you real-time, imperative control over phone calls using Python's asyncio.
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
The RELAY client is included in the `@signalwire/sdk` package:
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
pip install @signalwire/sdk
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
The only additional dependency is `websockets>=12.0`, which is installed automatically.
|
|
14
|
-
|
|
15
|
-
## Configuration
|
|
16
|
-
|
|
17
|
-
You need three things to connect:
|
|
18
|
-
|
|
19
|
-
| Parameter | Env Var | Description |
|
|
20
|
-
|-----------|---------|-------------|
|
|
21
|
-
| `project` | `SIGNALWIRE_PROJECT_ID` | Your SignalWire project ID |
|
|
22
|
-
| `token` | `SIGNALWIRE_API_TOKEN` | Your SignalWire API token |
|
|
23
|
-
| `host` | `SIGNALWIRE_SPACE` | Your space hostname (e.g. `example.signalwire.com`) |
|
|
24
|
-
|
|
25
|
-
Alternatively, you can authenticate with a JWT token:
|
|
26
|
-
|
|
27
|
-
| Parameter | Env Var | Description |
|
|
28
|
-
|-----------|---------|-------------|
|
|
29
|
-
| `jwt_token` | `SIGNALWIRE_JWT_TOKEN` | A SignalWire JWT auth token |
|
|
30
|
-
|
|
31
|
-
## Minimal Example
|
|
32
|
-
|
|
33
|
-
```python
|
|
34
|
-
from signalwire_agents.relay import RelayClient
|
|
35
|
-
|
|
36
|
-
client = RelayClient(
|
|
37
|
-
project="your-project-id",
|
|
38
|
-
token="your-api-token",
|
|
39
|
-
host="example.signalwire.com",
|
|
40
|
-
contexts=["default"],
|
|
41
|
-
)
|
|
42
|
-
|
|
43
|
-
@client.on_call
|
|
44
|
-
async def handle(call):
|
|
45
|
-
await call.answer()
|
|
46
|
-
action = await call.play([{"type": "tts", "params": {"text": "Hello!"}}])
|
|
47
|
-
await action.wait()
|
|
48
|
-
await call.hangup()
|
|
49
|
-
|
|
50
|
-
client.run()
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
Or use environment variables and skip the constructor args:
|
|
54
|
-
|
|
55
|
-
```bash
|
|
56
|
-
export SIGNALWIRE_PROJECT_ID=your-project-id
|
|
57
|
-
export SIGNALWIRE_API_TOKEN=your-api-token
|
|
58
|
-
export SIGNALWIRE_SPACE=example.signalwire.com
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
```python
|
|
62
|
-
from signalwire_agents.relay import RelayClient
|
|
63
|
-
|
|
64
|
-
client = RelayClient(contexts=["default"])
|
|
65
|
-
|
|
66
|
-
@client.on_call
|
|
67
|
-
async def handle(call):
|
|
68
|
-
await call.answer()
|
|
69
|
-
await call.hangup()
|
|
70
|
-
|
|
71
|
-
client.run()
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
## Contexts
|
|
75
|
-
|
|
76
|
-
Contexts are topics your client subscribes to for receiving inbound calls. When a call arrives on a context you're subscribed to, your `@client.on_call` handler is invoked.
|
|
77
|
-
|
|
78
|
-
```python
|
|
79
|
-
# Subscribe at connect time
|
|
80
|
-
client = RelayClient(contexts=["sales", "support"])
|
|
81
|
-
|
|
82
|
-
# Or dynamically after connecting
|
|
83
|
-
await client.receive(["billing"])
|
|
84
|
-
await client.unreceive(["sales"])
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
## Making Outbound Calls
|
|
88
|
-
|
|
89
|
-
Use `client.dial()` to place an outbound call:
|
|
90
|
-
|
|
91
|
-
```python
|
|
92
|
-
call = await client.dial([
|
|
93
|
-
[{"type": "phone", "params": {"to_number": "+15551234567", "from_number": "+15559876543"}}]
|
|
94
|
-
])
|
|
95
|
-
# call is now a live Call object
|
|
96
|
-
action = await call.play([{"type": "tts", "params": {"text": "This is an outbound call."}}])
|
|
97
|
-
await action.wait()
|
|
98
|
-
await call.hangup()
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
The outer list represents serial attempts; the inner list represents parallel attempts. For example, to try two numbers simultaneously:
|
|
102
|
-
|
|
103
|
-
```python
|
|
104
|
-
call = await client.dial([
|
|
105
|
-
[
|
|
106
|
-
{"type": "phone", "params": {"to_number": "+15551111111", "from_number": "+15559876543"}},
|
|
107
|
-
{"type": "phone", "params": {"to_number": "+15552222222", "from_number": "+15559876543"}},
|
|
108
|
-
]
|
|
109
|
-
])
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
## Debug Logging
|
|
113
|
-
|
|
114
|
-
Set the log level to see WebSocket traffic:
|
|
115
|
-
|
|
116
|
-
```bash
|
|
117
|
-
export SIGNALWIRE_LOG_LEVEL=debug
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
## Async Context Manager
|
|
121
|
-
|
|
122
|
-
For use within an existing async application:
|
|
123
|
-
|
|
124
|
-
```python
|
|
125
|
-
async with RelayClient(contexts=["default"]) as client:
|
|
126
|
-
call = await client.dial([...])
|
|
127
|
-
await call.answer()
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
## Next Steps
|
|
131
|
-
|
|
132
|
-
- [Call Methods Reference](call-methods.md) -- all methods available on a Call object
|
|
133
|
-
- [Events](events.md) -- handling real-time call events
|
|
134
|
-
- [Client Reference](client-reference.md) -- RelayClient configuration and methods
|
package/relay/docs/guide.md
DELETED
|
@@ -1,306 +0,0 @@
|
|
|
1
|
-
# RELAY Client Guide
|
|
2
|
-
|
|
3
|
-
The RELAY client provides real-time call and message control over a persistent WebSocket connection to SignalWire. Unlike the HTTP-based agent model (AgentBase), RELAY gives your application event-driven, bidirectional control of live calls and messages.
|
|
4
|
-
|
|
5
|
-
## Authentication
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
import { RelayClient } from '@signalwire/sdk';
|
|
9
|
-
|
|
10
|
-
const client = new RelayClient({
|
|
11
|
-
project: 'your-project-id', // or env: SIGNALWIRE_PROJECT_ID
|
|
12
|
-
token: 'your-api-token', // or env: SIGNALWIRE_TOKEN
|
|
13
|
-
host: 'your-space.signalwire.com', // or env: SIGNALWIRE_SPACE
|
|
14
|
-
contexts: ['office', 'support'],
|
|
15
|
-
});
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
All parameters can be provided via environment variables:
|
|
19
|
-
- `SIGNALWIRE_PROJECT_ID` - Your SignalWire project ID
|
|
20
|
-
- `SIGNALWIRE_TOKEN` - Your SignalWire API token (or `SIGNALWIRE_JWT_TOKEN` for JWT auth)
|
|
21
|
-
- `SIGNALWIRE_SPACE` - Your SignalWire space hostname
|
|
22
|
-
|
|
23
|
-
## Handling Inbound Calls
|
|
24
|
-
|
|
25
|
-
```typescript
|
|
26
|
-
client.onCall(async (call) => {
|
|
27
|
-
console.log(`Inbound call: ${call.callId}`);
|
|
28
|
-
|
|
29
|
-
await call.answer();
|
|
30
|
-
|
|
31
|
-
const action = await call.play([
|
|
32
|
-
{ type: 'tts', text: 'Hello! Thanks for calling.' },
|
|
33
|
-
]);
|
|
34
|
-
await action.wait();
|
|
35
|
-
|
|
36
|
-
await call.hangup();
|
|
37
|
-
});
|
|
38
|
-
|
|
39
|
-
// Start the client (auto-reconnects)
|
|
40
|
-
client.run();
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
## Making Outbound Calls
|
|
44
|
-
|
|
45
|
-
```typescript
|
|
46
|
-
await client.connect();
|
|
47
|
-
|
|
48
|
-
const call = await client.dial(
|
|
49
|
-
[[{ type: 'phone', to: '+15551234567', from: '+15559876543' }]],
|
|
50
|
-
{ dialTimeout: 30_000 },
|
|
51
|
-
);
|
|
52
|
-
|
|
53
|
-
console.log(`Call answered: ${call.callId}`);
|
|
54
|
-
await call.play([{ type: 'tts', text: 'Hello from RELAY!' }]);
|
|
55
|
-
await call.hangup();
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
### Dial Gotcha
|
|
59
|
-
|
|
60
|
-
The `calling.dial` RPC response does **not** contain a `call_id` — it only returns `{"code":"200","message":"Dialing"}`. The real `call_id` arrives via a `calling.call.dial` event matched by `tag`. The `dial()` method handles this automatically and returns a fully-initialized `Call` object.
|
|
61
|
-
|
|
62
|
-
## Call Methods
|
|
63
|
-
|
|
64
|
-
### Lifecycle
|
|
65
|
-
- `call.answer()` - Answer an inbound call
|
|
66
|
-
- `call.hangup(reason?)` - End the call
|
|
67
|
-
- `call.pass()` - Decline control, return to routing
|
|
68
|
-
|
|
69
|
-
### Audio Playback
|
|
70
|
-
```typescript
|
|
71
|
-
const action = await call.play([
|
|
72
|
-
{ type: 'tts', text: 'Hello world', language: 'en-US' },
|
|
73
|
-
{ type: 'audio', url: 'https://example.com/greeting.mp3' },
|
|
74
|
-
{ type: 'silence', duration: 2 },
|
|
75
|
-
]);
|
|
76
|
-
|
|
77
|
-
// Control playback
|
|
78
|
-
await action.pause();
|
|
79
|
-
await action.resume();
|
|
80
|
-
await action.volume(-3);
|
|
81
|
-
await action.stop();
|
|
82
|
-
|
|
83
|
-
// Or wait for completion
|
|
84
|
-
const event = await action.wait();
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
### Recording
|
|
88
|
-
```typescript
|
|
89
|
-
const action = await call.record({ format: 'mp3' });
|
|
90
|
-
// ... later
|
|
91
|
-
await action.stop();
|
|
92
|
-
const event = await action.wait();
|
|
93
|
-
console.log(`Recording URL: ${event.url}`);
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
### Input Collection
|
|
97
|
-
```typescript
|
|
98
|
-
// Play and collect (combined)
|
|
99
|
-
const action = await call.playAndCollect(
|
|
100
|
-
[{ type: 'tts', text: 'Enter your PIN:' }],
|
|
101
|
-
{ digits: { max: 4, terminators: '#' } },
|
|
102
|
-
);
|
|
103
|
-
const event = await action.wait();
|
|
104
|
-
|
|
105
|
-
// Standalone collect (no media)
|
|
106
|
-
const collectAction = await call.collect({
|
|
107
|
-
speech: { endSilenceTimeout: 2 },
|
|
108
|
-
});
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
### Detection
|
|
112
|
-
```typescript
|
|
113
|
-
const action = await call.detect(
|
|
114
|
-
{ type: 'machine', params: { initial_timeout: 5 } },
|
|
115
|
-
{ timeout: 10 },
|
|
116
|
-
);
|
|
117
|
-
const event = await action.wait();
|
|
118
|
-
// DetectAction resolves on first meaningful result (HUMAN, MACHINE, etc.)
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
### Connectivity
|
|
122
|
-
- `call.connect(devices, options?)` - Bridge to another endpoint
|
|
123
|
-
- `call.disconnect()` - Unbridge a connected call
|
|
124
|
-
- `call.transfer(dest)` - Transfer to another app/script
|
|
125
|
-
- `call.refer(device, options?)` - SIP REFER transfer
|
|
126
|
-
|
|
127
|
-
### Other Methods
|
|
128
|
-
- `call.sendDigits(digits)` - Send DTMF
|
|
129
|
-
- `call.hold()` / `call.unhold()`
|
|
130
|
-
- `call.denoise()` / `call.denoiseStop()`
|
|
131
|
-
- `call.joinConference(name, options?)` / `call.leaveConference(id)`
|
|
132
|
-
- `call.stream(url, options?)` - Stream audio to WebSocket
|
|
133
|
-
- `call.tap(tap, device, options?)` - Media interception
|
|
134
|
-
- `call.transcribe(options?)` - Start transcription
|
|
135
|
-
- `call.pay(connectorUrl, options?)` - Payment collection
|
|
136
|
-
- `call.sendFax(document, options?)` / `call.receiveFax(options?)`
|
|
137
|
-
- `call.ai(options?)` - Start AI agent session
|
|
138
|
-
- `call.queueEnter(name)` / `call.queueLeave(name)`
|
|
139
|
-
- `call.echo()` - Echo audio back (testing)
|
|
140
|
-
|
|
141
|
-
## Actions
|
|
142
|
-
|
|
143
|
-
Action methods return Action objects that track the operation's lifecycle:
|
|
144
|
-
|
|
145
|
-
```typescript
|
|
146
|
-
const action = await call.play([{ type: 'tts', text: 'Hello' }]);
|
|
147
|
-
|
|
148
|
-
// Check status
|
|
149
|
-
console.log(action.isDone); // false
|
|
150
|
-
console.log(action.completed); // false
|
|
151
|
-
|
|
152
|
-
// Wait for completion
|
|
153
|
-
const event = await action.wait(10_000); // with timeout
|
|
154
|
-
|
|
155
|
-
// Or fire-and-forget with callback
|
|
156
|
-
await call.play(
|
|
157
|
-
[{ type: 'tts', text: 'Background music' }],
|
|
158
|
-
{
|
|
159
|
-
onCompleted: (event) => console.log('Playback finished'),
|
|
160
|
-
},
|
|
161
|
-
);
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
### Action Types
|
|
165
|
-
| Action | Methods | Terminal States |
|
|
166
|
-
|--------|---------|----------------|
|
|
167
|
-
| `PlayAction` | stop, pause, resume, volume | finished, error |
|
|
168
|
-
| `RecordAction` | stop, pause, resume | finished, no_input |
|
|
169
|
-
| `DetectAction` | stop | finished, error (+ first result) |
|
|
170
|
-
| `CollectAction` | stop, volume, startInputTimers | finished, error, no_input, no_match |
|
|
171
|
-
| `FaxAction` | stop | finished, error |
|
|
172
|
-
| `TapAction` | stop | finished |
|
|
173
|
-
| `StreamAction` | stop | finished |
|
|
174
|
-
| `PayAction` | stop | finished, error |
|
|
175
|
-
| `TranscribeAction` | stop | finished |
|
|
176
|
-
| `AIAction` | stop | finished, error |
|
|
177
|
-
|
|
178
|
-
## Event Listening
|
|
179
|
-
|
|
180
|
-
```typescript
|
|
181
|
-
// Listen for specific events on a call
|
|
182
|
-
call.on('calling.call.play', (event) => {
|
|
183
|
-
console.log(`Play state: ${event.params.state}`);
|
|
184
|
-
});
|
|
185
|
-
|
|
186
|
-
// Wait for a specific event
|
|
187
|
-
const event = await call.waitFor('calling.call.state',
|
|
188
|
-
(e) => e.params.call_state === 'answered',
|
|
189
|
-
10_000, // timeout
|
|
190
|
-
);
|
|
191
|
-
|
|
192
|
-
// Wait for call to end
|
|
193
|
-
const endEvent = await call.waitForEnded(60_000);
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
## Messaging
|
|
197
|
-
|
|
198
|
-
```typescript
|
|
199
|
-
// Send SMS
|
|
200
|
-
const message = await client.sendMessage({
|
|
201
|
-
to: '+15551234567',
|
|
202
|
-
from: '+15559876543',
|
|
203
|
-
body: 'Hello from RELAY!',
|
|
204
|
-
});
|
|
205
|
-
|
|
206
|
-
// Track delivery
|
|
207
|
-
const event = await message.wait(30_000);
|
|
208
|
-
console.log(`State: ${message.state}`); // delivered, undelivered, failed
|
|
209
|
-
|
|
210
|
-
// Receive inbound messages
|
|
211
|
-
client.onMessage(async (message) => {
|
|
212
|
-
console.log(`From ${message.fromNumber}: ${message.body}`);
|
|
213
|
-
});
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
## Reconnection
|
|
217
|
-
|
|
218
|
-
The `run()` method handles auto-reconnection with exponential backoff:
|
|
219
|
-
|
|
220
|
-
```typescript
|
|
221
|
-
client.run(); // Blocks, auto-reconnects on disconnect
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
Reconnection behavior:
|
|
225
|
-
- Initial delay: 1 second
|
|
226
|
-
- Max delay: 30 seconds
|
|
227
|
-
- Backoff factor: 2x
|
|
228
|
-
- Protocol/authorization state preserved across reconnects
|
|
229
|
-
- Queued requests flushed after re-authentication
|
|
230
|
-
- SIGINT/SIGTERM triggers clean shutdown
|
|
231
|
-
|
|
232
|
-
For manual control:
|
|
233
|
-
```typescript
|
|
234
|
-
await client.connect();
|
|
235
|
-
// ... use client
|
|
236
|
-
await client.disconnect();
|
|
237
|
-
```
|
|
238
|
-
|
|
239
|
-
## Dynamic Context Subscription
|
|
240
|
-
|
|
241
|
-
```typescript
|
|
242
|
-
await client.connect();
|
|
243
|
-
|
|
244
|
-
// Subscribe to new contexts at runtime
|
|
245
|
-
await client.receive(['sales', 'support']);
|
|
246
|
-
|
|
247
|
-
// Unsubscribe
|
|
248
|
-
await client.unreceive(['sales']);
|
|
249
|
-
```
|
|
250
|
-
|
|
251
|
-
## Error Handling
|
|
252
|
-
|
|
253
|
-
```typescript
|
|
254
|
-
import { RelayError } from '@signalwire/sdk';
|
|
255
|
-
|
|
256
|
-
try {
|
|
257
|
-
await call.answer();
|
|
258
|
-
} catch (err) {
|
|
259
|
-
if (err instanceof RelayError) {
|
|
260
|
-
console.error(`RELAY error ${err.code}: ${err.message}`);
|
|
261
|
-
}
|
|
262
|
-
}
|
|
263
|
-
```
|
|
264
|
-
|
|
265
|
-
### Call-Gone Handling
|
|
266
|
-
|
|
267
|
-
When a call ends (404/410 from server), methods return `{}` instead of throwing. Actions are resolved immediately so `await action.wait()` doesn't hang:
|
|
268
|
-
|
|
269
|
-
```typescript
|
|
270
|
-
const action = await call.play([{ type: 'tts', text: 'hello' }]);
|
|
271
|
-
// If call ended between play request and response, action.isDone === true
|
|
272
|
-
```
|
|
273
|
-
|
|
274
|
-
## Typed Events
|
|
275
|
-
|
|
276
|
-
All events are parsed into typed classes:
|
|
277
|
-
|
|
278
|
-
```typescript
|
|
279
|
-
import { CallStateEvent, PlayEvent, parseEvent } from '@signalwire/sdk';
|
|
280
|
-
|
|
281
|
-
call.on('calling.call.state', (event) => {
|
|
282
|
-
const stateEvent = event as CallStateEvent;
|
|
283
|
-
console.log(stateEvent.callState); // 'answered', 'ended', etc.
|
|
284
|
-
console.log(stateEvent.endReason); // 'hangup', 'busy', etc.
|
|
285
|
-
});
|
|
286
|
-
```
|
|
287
|
-
|
|
288
|
-
22 typed event classes are available for all RELAY event types.
|
|
289
|
-
|
|
290
|
-
## Environment Variables
|
|
291
|
-
|
|
292
|
-
| Variable | Purpose |
|
|
293
|
-
|----------|---------|
|
|
294
|
-
| `SIGNALWIRE_PROJECT_ID` | Project ID for authentication |
|
|
295
|
-
| `SIGNALWIRE_TOKEN` | API token for authentication |
|
|
296
|
-
| `SIGNALWIRE_JWT_TOKEN` | JWT token (alternative to project/token) |
|
|
297
|
-
| `SIGNALWIRE_SPACE` | Space hostname (default: relay.signalwire.com) |
|
|
298
|
-
| `SIGNALWIRE_LOG_LEVEL` | Log level: debug, info, warn, error |
|
|
299
|
-
| `SIGNALWIRE_LOG_MODE` | Set to "off" to suppress logging |
|
|
300
|
-
|
|
301
|
-
## Examples
|
|
302
|
-
|
|
303
|
-
See the `examples/` directory:
|
|
304
|
-
- `relay-inbound.ts` - Answer calls, play TTS, collect digits
|
|
305
|
-
- `relay-outbound.ts` - Dial outbound, detect machine, play message
|
|
306
|
-
- `relay-messaging.ts` - Send/receive SMS
|