@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,313 @@
|
|
|
1
|
+
# Calling Commands
|
|
2
|
+
|
|
3
|
+
The Calling API controls calls over REST. Every command is a `POST` to `/api/calling/calls` with a `command` field, and needs no WebSocket connection. This page lists each method on `client.calling` with an example.
|
|
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 on the Getting Started page).
|
|
9
|
+
declare const client: import('@signalwire/sdk').RestClient;
|
|
10
|
+
declare const callId: string; // the UUID of an active call
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## How It Works
|
|
14
|
+
|
|
15
|
+
Each method on `client.calling` sends one POST request. This is the body that `client.calling.play(callId, [...])` sends:
|
|
16
|
+
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"command": "calling.play",
|
|
20
|
+
"params": {
|
|
21
|
+
"play": [{ "type": "audio", "params": { "url": "https://example.com/a.mp3" } }]
|
|
22
|
+
},
|
|
23
|
+
"id": "<call-uuid>"
|
|
24
|
+
}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
For `dial` and `update`, the call details go inside `params`, with no top-level `id`. Every other method takes the UUID of the call to control as its first argument. Each method is async and returns the parsed JSON response.
|
|
28
|
+
|
|
29
|
+
Every method also accepts an `extras` object in its options, merged into `params` for fields the SDK doesn't type, and a final `requestOptions` argument. [Request Options](guide.md#request-options-timeout-retries-abort) describes the second.
|
|
30
|
+
|
|
31
|
+
## Call Lifecycle
|
|
32
|
+
|
|
33
|
+
These methods start, change and end calls.
|
|
34
|
+
|
|
35
|
+
### `dial(from, to, options?)`
|
|
36
|
+
|
|
37
|
+
`dial` starts an outbound call. `from` and `to` are positional, and the other fields are options:
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
const result = await client.calling.dial('+15559876543', '+15551234567', {
|
|
41
|
+
url: 'https://example.com/call-handler',
|
|
42
|
+
});
|
|
43
|
+
const newCallId = result.id;
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### `update(id, options?)`
|
|
47
|
+
|
|
48
|
+
`update` gives an active call a new dialplan, from a `url` or inline `swml`. The call `id` is positional:
|
|
49
|
+
|
|
50
|
+
```typescript
|
|
51
|
+
await client.calling.update(callId, { url: 'https://example.com/new-handler' });
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### `end(callId, options?)`
|
|
55
|
+
|
|
56
|
+
`end` hangs up a call. The optional `reason` is one of `hangup`, `cancel`, `busy`, `noAnswer`, `decline` or `error`:
|
|
57
|
+
|
|
58
|
+
```typescript
|
|
59
|
+
await client.calling.end(callId, { reason: 'hangup' });
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### `transfer(callId, dest, options?)`
|
|
63
|
+
|
|
64
|
+
`transfer` moves a call to a new destination: a SIP URI, a phone number or an inline SWML object. `dest` is positional:
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
await client.calling.transfer(callId, 'sip:agent@example.com');
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### `disconnect(callId, options?)`
|
|
71
|
+
|
|
72
|
+
`disconnect` separates bridged calls without hanging up either leg:
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
await client.calling.disconnect(callId);
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Audio Playback
|
|
79
|
+
|
|
80
|
+
These methods play media into a call and control the playback.
|
|
81
|
+
|
|
82
|
+
### `play(callId, play, options?)`
|
|
83
|
+
|
|
84
|
+
`play` plays audio, TTS, silence or a ringtone. The `play` array is positional. Each item has a `type` (`audio`, `tts`, `silence` or `ring`) and its `params`:
|
|
85
|
+
|
|
86
|
+
```typescript
|
|
87
|
+
await client.calling.play(callId, [{ type: 'tts', params: { text: 'Hello!' } }], {
|
|
88
|
+
control_id: 'ctrl-1',
|
|
89
|
+
volume: 5.0,
|
|
90
|
+
});
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The `volume` option adjusts the level in dB.
|
|
94
|
+
|
|
95
|
+
### `playPause(callId, control_id, options?)` / `playResume(callId, control_id, options?)`
|
|
96
|
+
|
|
97
|
+
These pause and resume active playback. `control_id` is positional:
|
|
98
|
+
|
|
99
|
+
```typescript
|
|
100
|
+
await client.calling.playPause(callId, 'ctrl-1');
|
|
101
|
+
await client.calling.playResume(callId, 'ctrl-1');
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### `playStop(callId, control_id, options?)`
|
|
105
|
+
|
|
106
|
+
`playStop` stops active playback:
|
|
107
|
+
|
|
108
|
+
```typescript
|
|
109
|
+
await client.calling.playStop(callId, 'ctrl-1');
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### `playVolume(callId, control_id, volume, options?)`
|
|
113
|
+
|
|
114
|
+
`playVolume` adjusts the playback volume. `control_id` and `volume` are positional:
|
|
115
|
+
|
|
116
|
+
```typescript
|
|
117
|
+
await client.calling.playVolume(callId, 'ctrl-1', -3.0);
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## Recording
|
|
121
|
+
|
|
122
|
+
`record` takes an options object. The pause, resume and stop methods take `control_id` positionally:
|
|
123
|
+
|
|
124
|
+
```typescript
|
|
125
|
+
await client.calling.record(callId, {
|
|
126
|
+
control_id: 'rec-1',
|
|
127
|
+
audio: { beep: true, format: 'wav', stereo: true },
|
|
128
|
+
});
|
|
129
|
+
await client.calling.recordPause(callId, 'rec-1');
|
|
130
|
+
await client.calling.recordResume(callId, 'rec-1');
|
|
131
|
+
await client.calling.recordStop(callId, 'rec-1');
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## Input Collection
|
|
135
|
+
|
|
136
|
+
`collect` gathers DTMF or speech input and takes an options object. `collectStop` and `collectStartInputTimers` take `control_id` positionally:
|
|
137
|
+
|
|
138
|
+
```typescript
|
|
139
|
+
await client.calling.collect(callId, {
|
|
140
|
+
control_id: 'coll-1',
|
|
141
|
+
digits: { max: 4, terminators: '#' },
|
|
142
|
+
speech: { end_silence_timeout: 2.0 },
|
|
143
|
+
});
|
|
144
|
+
await client.calling.collectStop(callId, 'coll-1');
|
|
145
|
+
await client.calling.collectStartInputTimers(callId, 'coll-1');
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Detection
|
|
149
|
+
|
|
150
|
+
`detect` starts an answering-machine, fax or digit detector. The `detect` config object is positional, and `detectStop` takes `control_id` positionally:
|
|
151
|
+
|
|
152
|
+
```typescript
|
|
153
|
+
await client.calling.detect(callId, { type: 'machine', params: { initial_timeout: 4.5 } }, {
|
|
154
|
+
control_id: 'det-1',
|
|
155
|
+
});
|
|
156
|
+
await client.calling.detectStop(callId, 'det-1');
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## Tap and Stream
|
|
160
|
+
|
|
161
|
+
`tap` sends call audio to an RTP or WebSocket endpoint, and `stream` sends it to a WebSocket URL.
|
|
162
|
+
|
|
163
|
+
### `tap(callId, tap, device, options?)` / `tapStop(callId, control_id, options?)`
|
|
164
|
+
|
|
165
|
+
The `tap` and `device` config objects are positional, and `tapStop` takes `control_id` positionally:
|
|
166
|
+
|
|
167
|
+
```typescript
|
|
168
|
+
await client.calling.tap(
|
|
169
|
+
callId,
|
|
170
|
+
{ type: 'audio', params: { direction: 'both' } },
|
|
171
|
+
{ type: 'rtp', params: { addr: '192.168.1.1', port: 1234 } },
|
|
172
|
+
{ control_id: 'tap-1' },
|
|
173
|
+
);
|
|
174
|
+
await client.calling.tapStop(callId, 'tap-1');
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### `stream(callId, url, options?)` / `streamStop(callId, control_id, options?)`
|
|
178
|
+
|
|
179
|
+
The stream `url` is positional, and `streamStop` takes `control_id` positionally:
|
|
180
|
+
|
|
181
|
+
```typescript
|
|
182
|
+
await client.calling.stream(callId, 'wss://example.com/audio-stream', {
|
|
183
|
+
control_id: 'str-1',
|
|
184
|
+
codec: 'PCMU',
|
|
185
|
+
});
|
|
186
|
+
await client.calling.streamStop(callId, 'str-1');
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
## Denoise
|
|
190
|
+
|
|
191
|
+
`denoise` starts noise reduction on a call and `denoiseStop` stops it. Both take only the call ID and an optional `extras` object:
|
|
192
|
+
|
|
193
|
+
```typescript
|
|
194
|
+
await client.calling.denoise(callId);
|
|
195
|
+
await client.calling.denoiseStop(callId);
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
## Transcription
|
|
199
|
+
|
|
200
|
+
`transcribe` starts transcription of the call, and `transcribeStop` takes `control_id` positionally:
|
|
201
|
+
|
|
202
|
+
```typescript
|
|
203
|
+
await client.calling.transcribe(callId, { control_id: 'tx-1', status_url: 'https://example.com/hook' });
|
|
204
|
+
await client.calling.transcribeStop(callId, 'tx-1');
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
## AI
|
|
208
|
+
|
|
209
|
+
These methods act on an AI session running on a call.
|
|
210
|
+
|
|
211
|
+
### `aiMessage(callId, options?)`
|
|
212
|
+
|
|
213
|
+
`aiMessage` adds a message to the AI conversation. The `role` is `system`, `user` or `assistant`. The options also accept `reset` and `global_data`:
|
|
214
|
+
|
|
215
|
+
```typescript
|
|
216
|
+
await client.calling.aiMessage(callId, { role: 'user', message_text: 'Transfer me to billing' });
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### `aiHold(callId, options?)` / `aiUnhold(callId, options?)`
|
|
220
|
+
|
|
221
|
+
`aiHold` puts the caller on hold for up to `timeout` seconds. Its `prompt` is a system message added to the conversation before the hold, not text read to the caller:
|
|
222
|
+
|
|
223
|
+
```typescript
|
|
224
|
+
await client.calling.aiHold(callId, { timeout: 60, prompt: 'Tell the caller you are checking their account.' });
|
|
225
|
+
await client.calling.aiUnhold(callId, { prompt: 'The account check is done. Continue helping the caller.' });
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
### `aiStop(callId, control_id, options?)`
|
|
229
|
+
|
|
230
|
+
`aiStop` stops an active AI session on a call:
|
|
231
|
+
|
|
232
|
+
```typescript
|
|
233
|
+
await client.calling.aiStop(callId, 'ai-1');
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
## Live Transcribe and Translate
|
|
237
|
+
|
|
238
|
+
`liveTranscribe` and `liveTranslate` take a positional `action`. Use `{ start: {...} }` to begin, `{ summarize: {...} }` to request a summary, or the string `'stop'` to end. `liveTranslate` also accepts `{ inject: {...} }`:
|
|
239
|
+
|
|
240
|
+
```typescript
|
|
241
|
+
await client.calling.liveTranscribe(callId, {
|
|
242
|
+
start: { lang: 'en-US', direction: ['remote-caller'] },
|
|
243
|
+
});
|
|
244
|
+
await client.calling.liveTranslate(callId, {
|
|
245
|
+
start: { from_lang: 'en-US', to_lang: 'es-ES', direction: ['remote-caller'] },
|
|
246
|
+
});
|
|
247
|
+
await client.calling.liveTranscribe(callId, 'stop');
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
## Fax
|
|
251
|
+
|
|
252
|
+
These methods stop an active fax send or receive:
|
|
253
|
+
|
|
254
|
+
```typescript
|
|
255
|
+
await client.calling.sendFaxStop(callId, 'fax-1');
|
|
256
|
+
await client.calling.receiveFaxStop(callId, 'fax-1');
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
## SIP and Custom Events
|
|
260
|
+
|
|
261
|
+
`refer` transfers a SIP call with SIP REFER, and `userEvent` fires a custom event on the call:
|
|
262
|
+
|
|
263
|
+
```typescript
|
|
264
|
+
// SIP REFER transfer; the `device` object is positional
|
|
265
|
+
await client.calling.refer(callId, { type: 'sip', params: { to: 'sip:agent@example.com' } });
|
|
266
|
+
|
|
267
|
+
// Custom event; the `event` object is positional, and each value is an object
|
|
268
|
+
await client.calling.userEvent(callId, { custom: { key: 'value' } });
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
## Complete Method List
|
|
272
|
+
|
|
273
|
+
The table lists all 37 methods, with the wire `command` value each one sends:
|
|
274
|
+
|
|
275
|
+
| Method | Command | Requires callId |
|
|
276
|
+
|--------|---------|:-:|
|
|
277
|
+
| `dial(from, to, options?)` | `dial` | No |
|
|
278
|
+
| `update(id, options?)` | `update` | No (`id` goes in `params`) |
|
|
279
|
+
| `end(callId, options?)` | `calling.end` | Yes |
|
|
280
|
+
| `transfer(callId, dest, options?)` | `calling.transfer` | Yes |
|
|
281
|
+
| `disconnect(callId, options?)` | `calling.disconnect` | Yes |
|
|
282
|
+
| `play(callId, play, options?)` | `calling.play` | Yes |
|
|
283
|
+
| `playPause(callId, control_id, options?)` | `calling.play.pause` | Yes |
|
|
284
|
+
| `playResume(callId, control_id, options?)` | `calling.play.resume` | Yes |
|
|
285
|
+
| `playStop(callId, control_id, options?)` | `calling.play.stop` | Yes |
|
|
286
|
+
| `playVolume(callId, control_id, volume, options?)` | `calling.play.volume` | Yes |
|
|
287
|
+
| `record(callId, options?)` | `calling.record` | Yes |
|
|
288
|
+
| `recordPause(callId, control_id, options?)` | `calling.record.pause` | Yes |
|
|
289
|
+
| `recordResume(callId, control_id, options?)` | `calling.record.resume` | Yes |
|
|
290
|
+
| `recordStop(callId, control_id, options?)` | `calling.record.stop` | Yes |
|
|
291
|
+
| `collect(callId, options?)` | `calling.collect` | Yes |
|
|
292
|
+
| `collectStop(callId, control_id, options?)` | `calling.collect.stop` | Yes |
|
|
293
|
+
| `collectStartInputTimers(callId, control_id, options?)` | `calling.collect.start_input_timers` | Yes |
|
|
294
|
+
| `detect(callId, detect, options?)` | `calling.detect` | Yes |
|
|
295
|
+
| `detectStop(callId, control_id, options?)` | `calling.detect.stop` | Yes |
|
|
296
|
+
| `tap(callId, tap, device, options?)` | `calling.tap` | Yes |
|
|
297
|
+
| `tapStop(callId, control_id, options?)` | `calling.tap.stop` | Yes |
|
|
298
|
+
| `stream(callId, url, options?)` | `calling.stream` | Yes |
|
|
299
|
+
| `streamStop(callId, control_id, options?)` | `calling.stream.stop` | Yes |
|
|
300
|
+
| `denoise(callId, options?)` | `calling.denoise` | Yes |
|
|
301
|
+
| `denoiseStop(callId, options?)` | `calling.denoise.stop` | Yes |
|
|
302
|
+
| `transcribe(callId, options?)` | `calling.transcribe` | Yes |
|
|
303
|
+
| `transcribeStop(callId, control_id, options?)` | `calling.transcribe.stop` | Yes |
|
|
304
|
+
| `aiMessage(callId, options?)` | `calling.ai_message` | Yes |
|
|
305
|
+
| `aiHold(callId, options?)` | `calling.ai_hold` | Yes |
|
|
306
|
+
| `aiUnhold(callId, options?)` | `calling.ai_unhold` | Yes |
|
|
307
|
+
| `aiStop(callId, control_id, options?)` | `calling.ai.stop` | Yes |
|
|
308
|
+
| `liveTranscribe(callId, action, options?)` | `calling.live_transcribe` | Yes |
|
|
309
|
+
| `liveTranslate(callId, action, options?)` | `calling.live_translate` | Yes |
|
|
310
|
+
| `sendFaxStop(callId, control_id, options?)` | `calling.send_fax.stop` | Yes |
|
|
311
|
+
| `receiveFaxStop(callId, control_id, options?)` | `calling.receive_fax.stop` | Yes |
|
|
312
|
+
| `refer(callId, device, options?)` | `calling.refer` | Yes |
|
|
313
|
+
| `userEvent(callId, event, options?)` | `calling.user_event` | Yes |
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
# RestClient Reference
|
|
2
|
+
|
|
3
|
+
This page lists the `RestClient` constructor options, the namespace properties on the client and the error classes it throws.
|
|
4
|
+
|
|
5
|
+
## Constructor
|
|
6
|
+
|
|
7
|
+
This example passes every connection option explicitly. The comment on each line names the environment variable it falls back to:
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { RestClient } from '@signalwire/sdk';
|
|
11
|
+
|
|
12
|
+
const client = new RestClient({
|
|
13
|
+
project: 'your-project-id', // SIGNALWIRE_PROJECT_ID
|
|
14
|
+
token: 'your-api-token', // SIGNALWIRE_API_TOKEN
|
|
15
|
+
host: 'example.signalwire.com', // SIGNALWIRE_REST_BASE_URL, then SIGNALWIRE_SPACE
|
|
16
|
+
});
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
The constructor accepts these options:
|
|
20
|
+
|
|
21
|
+
| Option | Type | Description |
|
|
22
|
+
|--------|------|-------------|
|
|
23
|
+
| `project` | `string` | Project ID. Falls back to `SIGNALWIRE_PROJECT_ID`. |
|
|
24
|
+
| `token` | `string` | API token. Falls back to `SIGNALWIRE_API_TOKEN`. |
|
|
25
|
+
| `host` | `string` | A bare host (`example.signalwire.com`) or a full `http(s)://` URL. Falls back to `SIGNALWIRE_REST_BASE_URL`, then `SIGNALWIRE_SPACE`. |
|
|
26
|
+
| `requestOptions` | `RequestOptionsInit` | Default timeout, retry and abort settings for every request. See [Request Options](guide.md#request-options-timeout-retries-abort). |
|
|
27
|
+
| `fetchImpl` | `typeof fetch` | A replacement `fetch`, for tests. |
|
|
28
|
+
|
|
29
|
+
If `project`, `token` or `host` is missing from both the options and the environment, the constructor throws an `Error`. Authentication uses HTTP Basic Auth with `project:token`.
|
|
30
|
+
|
|
31
|
+
The `restClient(options?)` function, also exported from `@signalwire/sdk`, constructs the same client.
|
|
32
|
+
|
|
33
|
+
## Namespaces
|
|
34
|
+
|
|
35
|
+
Each API area is a property on the client. Namespaces are properties, not methods: write `client.fabric`, not `client.fabric()`.
|
|
36
|
+
|
|
37
|
+
### Fabric API
|
|
38
|
+
|
|
39
|
+
`client.fabric` has these sub-resources:
|
|
40
|
+
|
|
41
|
+
| Property | Description |
|
|
42
|
+
|-----------|-------------|
|
|
43
|
+
| `client.fabric.swmlScripts` | SWML script resources (CRUD + addresses) |
|
|
44
|
+
| `client.fabric.swmlWebhooks` | SWML webhook resources |
|
|
45
|
+
| `client.fabric.aiAgents` | AI agent resources |
|
|
46
|
+
| `client.fabric.relayApplications` | RELAY application resources |
|
|
47
|
+
| `client.fabric.callFlows` | Call flow resources (+ versions) |
|
|
48
|
+
| `client.fabric.conferenceRooms` | Conference room resources |
|
|
49
|
+
| `client.fabric.freeswitchConnectors` | FreeSWITCH connector resources |
|
|
50
|
+
| `client.fabric.subscribers` | Subscriber resources (+ SIP endpoints) |
|
|
51
|
+
| `client.fabric.sipEndpoints` | SIP endpoint resources |
|
|
52
|
+
| `client.fabric.sipGateways` | SIP gateway resources |
|
|
53
|
+
| `client.fabric.cxmlScripts` | cXML script resources |
|
|
54
|
+
| `client.fabric.cxmlWebhooks` | cXML webhook resources |
|
|
55
|
+
| `client.fabric.cxmlApplications` | cXML application resources (no create) |
|
|
56
|
+
| `client.fabric.resources` | Generic resource operations |
|
|
57
|
+
| `client.fabric.addresses` | Fabric addresses (list and get only) |
|
|
58
|
+
| `client.fabric.tokens` | Subscriber, guest, invite and embed tokens |
|
|
59
|
+
|
|
60
|
+
### Calling API
|
|
61
|
+
|
|
62
|
+
The Calling API has one property:
|
|
63
|
+
|
|
64
|
+
| Property | Description |
|
|
65
|
+
|-----------|-------------|
|
|
66
|
+
| `client.calling` | REST call control; every command is a POST to `/api/calling/calls` |
|
|
67
|
+
|
|
68
|
+
### Relay REST Resources
|
|
69
|
+
|
|
70
|
+
These properties wrap the `/api/relay/rest` endpoints:
|
|
71
|
+
|
|
72
|
+
| Property | Description |
|
|
73
|
+
|-----------|-------------|
|
|
74
|
+
| `client.phoneNumbers` | Phone number management (+ search and call-handler helpers) |
|
|
75
|
+
| `client.addresses` | Address management |
|
|
76
|
+
| `client.queues` | Queue management (+ members) |
|
|
77
|
+
| `client.recordings` | Recording management |
|
|
78
|
+
| `client.numberGroups` | Number group management (+ memberships) |
|
|
79
|
+
| `client.verifiedCallers` | Verified caller ID management (+ verification flow) |
|
|
80
|
+
| `client.sipProfile` | Project SIP profile (get and update) |
|
|
81
|
+
| `client.lookup` | Phone number lookup |
|
|
82
|
+
| `client.shortCodes` | Short code management |
|
|
83
|
+
| `client.importedNumbers` | Import external phone numbers |
|
|
84
|
+
| `client.mfa` | Multi-factor authentication (SMS, call, verify) |
|
|
85
|
+
| `client.registry` | 10DLC brand and campaign registry |
|
|
86
|
+
|
|
87
|
+
### Other APIs
|
|
88
|
+
|
|
89
|
+
These properties cover the remaining APIs:
|
|
90
|
+
|
|
91
|
+
| Property | Description |
|
|
92
|
+
|-----------|-------------|
|
|
93
|
+
| `client.messages` | Send an SMS or MMS message, and redact a sent message |
|
|
94
|
+
| `client.datasphere` | Datasphere document management and semantic search |
|
|
95
|
+
| `client.video` | Video rooms, sessions, recordings, conferences, tokens and streams |
|
|
96
|
+
| `client.logs` | Message, voice, fax and conference logs |
|
|
97
|
+
| `client.project` | API token management |
|
|
98
|
+
| `client.projects` | Project and subproject management (+ signing-key rotation) |
|
|
99
|
+
| `client.pubsub` | PubSub token creation |
|
|
100
|
+
| `client.chat` | Chat token creation |
|
|
101
|
+
|
|
102
|
+
## Error Handling
|
|
103
|
+
|
|
104
|
+
This example catches the error thrown by a failed request and reads its properties:
|
|
105
|
+
|
|
106
|
+
```typescript
|
|
107
|
+
import { RestClient, SignalWireRestError } from '@signalwire/sdk';
|
|
108
|
+
|
|
109
|
+
const client = new RestClient();
|
|
110
|
+
|
|
111
|
+
try {
|
|
112
|
+
await client.fabric.aiAgents.get('bad-id');
|
|
113
|
+
} catch (err) {
|
|
114
|
+
if (err instanceof SignalWireRestError) {
|
|
115
|
+
console.log(err.statusCode); // for example 404
|
|
116
|
+
console.log(err.body); // parsed JSON, or the raw text
|
|
117
|
+
console.log(err.url); // the full request URL
|
|
118
|
+
console.log(err.method); // "GET"
|
|
119
|
+
console.log(err.requestId); // the platform request ID, or null
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
`SignalWireRestError` is thrown on any non-2xx HTTP response. It's also exported as `RestError`; the two names refer to the same class. Its message has the form `GET <url> returned 404: <body>`, followed by ` (request-id: <id>)` when the response carries a request ID.
|
|
125
|
+
|
|
126
|
+
A request that gets no response throws `RestTransportError` (also exported as `SignalWireRestTransportError`). Examples are a refused connection, a DNS or TLS failure, a timeout, and cancellation through `abortSignal`. It extends `RestError`, so one `instanceof RestError` check catches both.
|
|
127
|
+
|
|
128
|
+
### Error Properties
|
|
129
|
+
|
|
130
|
+
The error has these properties:
|
|
131
|
+
|
|
132
|
+
| Property | Type | Description |
|
|
133
|
+
|-----------|------|-------------|
|
|
134
|
+
| `statusCode` | `number \| null` | HTTP status code; `null` for a transport failure |
|
|
135
|
+
| `body` | `object` or `string` | Response body (parsed JSON or raw text); the error message for a transport failure |
|
|
136
|
+
| `url` | `string` | Full request URL |
|
|
137
|
+
| `method` | `string` | HTTP method |
|
|
138
|
+
| `headers` | `Record<string, string> \| null` | Response headers; `null` for a transport failure |
|
|
139
|
+
| `requestId` | `string \| null` | The first of `x-request-id`, `x-signalwire-request-id`, `request-id` or `x-amzn-requestid` in the response headers |
|
|
140
|
+
|
|
141
|
+
## Client Behavior
|
|
142
|
+
|
|
143
|
+
The client works this way:
|
|
144
|
+
|
|
145
|
+
- One `HttpClient`, using the global `fetch`, is shared by all namespaces.
|
|
146
|
+
- Requests send `Accept: application/json`, and a JSON body with `Content-Type: application/json`.
|
|
147
|
+
- A `204 No Content` response, or an empty body, returns `{}`.
|
|
148
|
+
- A bare `host` gets an `https://` base URL, or `http://` for a loopback host such as `127.0.0.1:8933`.
|
|
149
|
+
- The `fetchImpl` option replaces `fetch`, for tests.
|
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
# Fabric Resources
|
|
2
|
+
|
|
3
|
+
The Fabric API (`/api/fabric`) manages the resources in your SignalWire project: AI agents, SWML scripts, subscribers, call flows and others. Most resource types support CRUD operations and address listing. Every method is async, so `await` it.
|
|
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 on the Getting Started page).
|
|
9
|
+
declare const client: import('@signalwire/sdk').RestClient;
|
|
10
|
+
declare const pnId: string; // a phone-number SID
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Standard CRUD Pattern
|
|
14
|
+
|
|
15
|
+
The CRUD resource types share the same methods. This example runs each of them on AI agents:
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
// List all resources of this type
|
|
19
|
+
let items = await client.fabric.aiAgents.list();
|
|
20
|
+
items = await client.fabric.aiAgents.list({ page_number: 2, page_size: 10 });
|
|
21
|
+
|
|
22
|
+
// Create a new resource
|
|
23
|
+
const agent = await client.fabric.aiAgents.create({
|
|
24
|
+
name: 'Support Bot',
|
|
25
|
+
prompt: { text: 'You are a helpful support agent.' },
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
// Get a resource by ID
|
|
29
|
+
const found = await client.fabric.aiAgents.get('agent-uuid');
|
|
30
|
+
|
|
31
|
+
// Update a resource
|
|
32
|
+
await client.fabric.aiAgents.update('agent-uuid', { name: 'Updated Name' });
|
|
33
|
+
|
|
34
|
+
// Delete a resource
|
|
35
|
+
await client.fabric.aiAgents.delete('agent-uuid');
|
|
36
|
+
|
|
37
|
+
// List addresses assigned to this resource
|
|
38
|
+
const addresses = await client.fabric.aiAgents.listAddresses('agent-uuid');
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
`list()` returns one page. To walk every page, iterate `paginate()`, for example `for await (const agent of client.fabric.aiAgents.paginate())`. `cxmlApplications` and `resources` have no `paginate()`.
|
|
42
|
+
|
|
43
|
+
`client.fabric` has 16 sub-resources. Thirteen are CRUD resource types, which use one of two update methods. The other three are `resources` (generic), `addresses` and `tokens`, covered later on this page.
|
|
44
|
+
|
|
45
|
+
### PUT-Update Resources
|
|
46
|
+
|
|
47
|
+
These resources send `update()` as a `PUT` (full replacement):
|
|
48
|
+
|
|
49
|
+
| Accessor | API Path |
|
|
50
|
+
|-----------|----------|
|
|
51
|
+
| `fabric.swmlScripts` | `/api/fabric/resources/swml_scripts` |
|
|
52
|
+
| `fabric.relayApplications` | `/api/fabric/resources/relay_applications` |
|
|
53
|
+
| `fabric.callFlows` | `/api/fabric/resources/call_flows` |
|
|
54
|
+
| `fabric.conferenceRooms` | `/api/fabric/resources/conference_rooms` |
|
|
55
|
+
| `fabric.freeswitchConnectors` | `/api/fabric/resources/freeswitch_connectors` |
|
|
56
|
+
| `fabric.subscribers` | `/api/fabric/resources/subscribers` |
|
|
57
|
+
| `fabric.sipEndpoints` | `/api/fabric/resources/sip_endpoints` |
|
|
58
|
+
| `fabric.cxmlScripts` | `/api/fabric/resources/cxml_scripts` |
|
|
59
|
+
| `fabric.cxmlApplications` | `/api/fabric/resources/cxml_applications` |
|
|
60
|
+
|
|
61
|
+
### PATCH-Update Resources
|
|
62
|
+
|
|
63
|
+
These resources send `update()` as a `PATCH` (partial update):
|
|
64
|
+
|
|
65
|
+
| Accessor | API Path | Notes |
|
|
66
|
+
|-----------|----------|-------|
|
|
67
|
+
| `fabric.swmlWebhooks` | `/api/fabric/resources/swml_webhooks` | Also created by the platform when you call `phoneNumbers.setSwmlWebhook(sid, url)`. See [phone-binding.md](phone-binding.md). |
|
|
68
|
+
| `fabric.aiAgents` | `/api/fabric/resources/ai_agents` | Create one directly, then bind a number to it with `phoneNumbers.setAiAgent(sid, agentId)`. |
|
|
69
|
+
| `fabric.sipGateways` | `/api/fabric/resources/sip_gateways` | |
|
|
70
|
+
| `fabric.cxmlWebhooks` | `/api/fabric/resources/cxml_webhooks` | Also created by the platform when you call `phoneNumbers.setCxmlWebhook(sid, url)`. This is the cXML (Twilio-compatible) handler, although its `call_handler` wire value is `laml_webhooks`. |
|
|
71
|
+
|
|
72
|
+
## Call Flows: Extra Methods
|
|
73
|
+
|
|
74
|
+
Call flows support version management. `deployVersion` takes either a `document_version` or a `call_flow_version_id`:
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
// List all versions of a call flow
|
|
78
|
+
const versions = await client.fabric.callFlows.listVersions('call-flow-uuid');
|
|
79
|
+
|
|
80
|
+
// Deploy a version
|
|
81
|
+
await client.fabric.callFlows.deployVersion('call-flow-uuid', { document_version: 3 });
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Subscribers: SIP Endpoints
|
|
85
|
+
|
|
86
|
+
Subscribers have nested SIP endpoint management. `createSipEndpoint` takes the username and password positionally:
|
|
87
|
+
|
|
88
|
+
```typescript
|
|
89
|
+
// List a subscriber's SIP endpoints
|
|
90
|
+
const endpoints = await client.fabric.subscribers.listSipEndpoints('subscriber-uuid');
|
|
91
|
+
|
|
92
|
+
// Create a SIP endpoint for a subscriber (username and password are positional)
|
|
93
|
+
const endpoint = await client.fabric.subscribers.createSipEndpoint('subscriber-uuid', 'user1', 'secret', {
|
|
94
|
+
caller_id: '+15551234567',
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
// Get a specific SIP endpoint
|
|
98
|
+
const found = await client.fabric.subscribers.getSipEndpoint('subscriber-uuid', 'endpoint-uuid');
|
|
99
|
+
|
|
100
|
+
// Update a SIP endpoint (uses PATCH)
|
|
101
|
+
await client.fabric.subscribers.updateSipEndpoint('subscriber-uuid', 'endpoint-uuid', {
|
|
102
|
+
caller_id: '+15559876543',
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
// Delete a SIP endpoint
|
|
106
|
+
await client.fabric.subscribers.deleteSipEndpoint('subscriber-uuid', 'endpoint-uuid');
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
## cXML Applications
|
|
110
|
+
|
|
111
|
+
cXML applications support list, get, update and delete. The class has no `create()` method, so a call to it fails to compile:
|
|
112
|
+
|
|
113
|
+
```typescript
|
|
114
|
+
const apps = await client.fabric.cxmlApplications.list();
|
|
115
|
+
const app = await client.fabric.cxmlApplications.get('app-uuid');
|
|
116
|
+
await client.fabric.cxmlApplications.update('app-uuid', { voice_url: 'https://example.com/voice' });
|
|
117
|
+
await client.fabric.cxmlApplications.delete('app-uuid');
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## Generic Resources
|
|
121
|
+
|
|
122
|
+
`client.fabric.resources` operates on a resource of any type by its ID:
|
|
123
|
+
|
|
124
|
+
```typescript
|
|
125
|
+
// List all resources across all types
|
|
126
|
+
const allResources = await client.fabric.resources.list();
|
|
127
|
+
|
|
128
|
+
// Get any resource by ID
|
|
129
|
+
const resource = await client.fabric.resources.get('resource-uuid');
|
|
130
|
+
|
|
131
|
+
// Delete any resource
|
|
132
|
+
await client.fabric.resources.delete('resource-uuid');
|
|
133
|
+
|
|
134
|
+
// List addresses for any resource
|
|
135
|
+
const addresses = await client.fabric.resources.listAddresses('resource-uuid');
|
|
136
|
+
|
|
137
|
+
// Assign a resource as a domain application handler
|
|
138
|
+
await client.fabric.resources.assignDomainApplication('resource-uuid', 'da-uuid');
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### `assignPhoneRoute` is not how you bind a phone number
|
|
142
|
+
|
|
143
|
+
`client.fabric.resources.assignPhoneRoute(id, phone_route_id, handler)` posts to `/api/fabric/resources/{id}/phone_routes`. The `handler` is `'calling'` or `'messaging'`. This method doesn't bind a phone number to an SWML webhook, a cXML webhook or an AI agent. You configure those bindings on the phone number, as [phone-binding.md](phone-binding.md) describes.
|
|
144
|
+
|
|
145
|
+
## Binding a phone number to a handler
|
|
146
|
+
|
|
147
|
+
[phone-binding.md](phone-binding.md) covers the `PhoneCallHandler` values, the Fabric resource each one produces and the typed `phoneNumbers.set*` helpers. The common case routes a number to an SWML webhook:
|
|
148
|
+
|
|
149
|
+
```typescript
|
|
150
|
+
// SWML webhook (your backend returns SWML per call)
|
|
151
|
+
await client.phoneNumbers.setSwmlWebhook(pnId, 'https://example.com/swml');
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
## Fabric Addresses
|
|
155
|
+
|
|
156
|
+
`client.fabric.addresses` gives read-only access to all Fabric addresses. `list()` accepts filters such as `type`, `display_name` and `name`:
|
|
157
|
+
|
|
158
|
+
```typescript
|
|
159
|
+
// List all addresses, filtered by type
|
|
160
|
+
const addresses = await client.fabric.addresses.list({ type: 'room' });
|
|
161
|
+
|
|
162
|
+
// Get a specific address
|
|
163
|
+
const address = await client.fabric.addresses.get('address-uuid');
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
## Tokens
|
|
167
|
+
|
|
168
|
+
`client.fabric.tokens` creates tokens for subscribers, guests, invites and embeds. The `expire_at` and `expires_at` options are Unix times in seconds:
|
|
169
|
+
|
|
170
|
+
```typescript
|
|
171
|
+
// Subscriber token; `reference` is positional, and the rest are options
|
|
172
|
+
const subscriberToken = await client.fabric.tokens.createSubscriberToken('user@example.com', {
|
|
173
|
+
password: 'a-long-random-password',
|
|
174
|
+
});
|
|
175
|
+
|
|
176
|
+
// Refresh a subscriber token; the refresh token is positional
|
|
177
|
+
const refreshed = await client.fabric.tokens.refreshSubscriberToken('existing-refresh-token');
|
|
178
|
+
|
|
179
|
+
// Guest token; `allowed_addresses` is positional
|
|
180
|
+
const guestToken = await client.fabric.tokens.createGuestToken(
|
|
181
|
+
['address-uuid-1', 'address-uuid-2'],
|
|
182
|
+
{ expire_at: 1767225599 },
|
|
183
|
+
);
|
|
184
|
+
|
|
185
|
+
// Subscriber invite token; `address_id` is positional
|
|
186
|
+
const inviteToken = await client.fabric.tokens.createInviteToken('address-uuid', {
|
|
187
|
+
expires_at: 1767225599,
|
|
188
|
+
});
|
|
189
|
+
|
|
190
|
+
// Click-to-call embed token; the source token is positional
|
|
191
|
+
const embedToken = await client.fabric.tokens.createEmbedToken('embed-source-token');
|
|
192
|
+
```
|