@signalwire/sdk 2.0.5 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +481 -126
- package/dist/AgentBase.js +1502 -438
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +12 -1
- package/dist/POM/PromptObjectModel.js +25 -9
- package/dist/POM/PromptObjectModel.js.map +1 -1
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +18 -0
- package/dist/PomBuilder.js +53 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +22 -1
- package/dist/PromptManager.js +28 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +158 -58
- package/dist/SWMLService.js +435 -127
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +49 -9
- package/dist/SecurityUtils.js +153 -51
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +92 -33
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -371
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +47 -68
- package/dist/index.js +44 -73
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +44 -17
- package/dist/relay/RelayClient.js +175 -65
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +73 -42
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +5 -2
- package/dist/rest/callHandler.js +4 -1
- package/dist/rest/callHandler.js.map +1 -1
- package/dist/rest/index.d.ts +18 -77
- package/dist/rest/index.js +47 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -327
- package/dist/rest/namespaces/fabric.js +14 -439
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +8 -196
- package/dist/rest/namespaces/phone-numbers.js +8 -230
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +22 -11
- package/dist/skills/SkillRegistry.js +47 -17
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +18 -6
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +21 -22
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +42 -4
- package/dist/skills/builtin/spider.js +277 -104
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +38 -30
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +294 -100
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +14 -13
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +59 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +85 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
|
@@ -0,0 +1,1906 @@
|
|
|
1
|
+
/** Request body for adding a phone number to a number group. */
|
|
2
|
+
export interface AddNumberGroupMembershipRequest {
|
|
3
|
+
/** The phone number ID to add to the group. */
|
|
4
|
+
phone_number_id: uuid;
|
|
5
|
+
}
|
|
6
|
+
/** Address model representing a physical address for regulatory compliance. */
|
|
7
|
+
export interface Address {
|
|
8
|
+
/** The unique identifier of the Address on SignalWire. */
|
|
9
|
+
id: uuid;
|
|
10
|
+
/** A friendly name given to the address to help distinguish and search for different addresses within your project. */
|
|
11
|
+
label: string;
|
|
12
|
+
/** The ISO 3166 Alpha 2 country code. */
|
|
13
|
+
country: string;
|
|
14
|
+
/** First name of the occupant associated with this address. */
|
|
15
|
+
first_name: string;
|
|
16
|
+
/** Last name of the occupant associated with this address. */
|
|
17
|
+
last_name: string;
|
|
18
|
+
/** The number portion of the street address. */
|
|
19
|
+
street_number: string;
|
|
20
|
+
/** The name portion of the street address. */
|
|
21
|
+
street_name: string;
|
|
22
|
+
/** If the address is divided into multiple sub-addresses, this identifies how the address is divided. */
|
|
23
|
+
address_type: AddressType | null;
|
|
24
|
+
/** If the address is divided into multiple sub-addresses, this identifies the particular sub-address. */
|
|
25
|
+
address_number: string | null;
|
|
26
|
+
/** The city portion of the street address. */
|
|
27
|
+
city: string;
|
|
28
|
+
/** The state/province/region of the street address. In the USA and Canada, use the two-letter abbreviated form. */
|
|
29
|
+
state: string;
|
|
30
|
+
/** The postal code of the street address. */
|
|
31
|
+
postal_code: string;
|
|
32
|
+
/** The postal code of the street address. Alias for postal_code for backwards compatibility. */
|
|
33
|
+
zip_code: string;
|
|
34
|
+
}
|
|
35
|
+
/** Response containing a list of addresses. */
|
|
36
|
+
export interface AddressListResponse {
|
|
37
|
+
/** Pagination links. */
|
|
38
|
+
links: PaginationLinks;
|
|
39
|
+
/** List of addresses. */
|
|
40
|
+
data: Address[];
|
|
41
|
+
}
|
|
42
|
+
/** Response containing a single address. */
|
|
43
|
+
export interface AddressResponse {
|
|
44
|
+
/** The unique identifier of the Address on SignalWire. */
|
|
45
|
+
id: uuid;
|
|
46
|
+
/** A friendly name given to the address to help distinguish and search for different addresses within your project. */
|
|
47
|
+
label: string;
|
|
48
|
+
/** The ISO 3166 Alpha 2 country code. */
|
|
49
|
+
country: string;
|
|
50
|
+
/** First name of the occupant associated with this address. */
|
|
51
|
+
first_name: string;
|
|
52
|
+
/** Last name of the occupant associated with this address. */
|
|
53
|
+
last_name: string;
|
|
54
|
+
/** The number portion of the street address. */
|
|
55
|
+
street_number: string;
|
|
56
|
+
/** The name portion of the street address. */
|
|
57
|
+
street_name: string;
|
|
58
|
+
/** If the address is divided into multiple sub-addresses, this identifies how the address is divided. */
|
|
59
|
+
address_type: AddressType | null;
|
|
60
|
+
/** If the address is divided into multiple sub-addresses, this identifies the particular sub-address. */
|
|
61
|
+
address_number: string | null;
|
|
62
|
+
/** The city portion of the street address. */
|
|
63
|
+
city: string;
|
|
64
|
+
/** The state/province/region of the street address. In the USA and Canada, use the two-letter abbreviated form. */
|
|
65
|
+
state: string;
|
|
66
|
+
/** The postal code of the street address. */
|
|
67
|
+
postal_code: string;
|
|
68
|
+
/** The postal code of the street address. Alias for postal_code for backwards compatibility. */
|
|
69
|
+
zip_code: string;
|
|
70
|
+
}
|
|
71
|
+
/** Address type for sub-addresses. */
|
|
72
|
+
export type AddressType = 'Apartment' | 'Basement' | 'Building' | 'Department' | 'Floor' | 'Office' | 'Penthouse' | 'Suite' | 'Trailer' | 'Unit';
|
|
73
|
+
/** Assigned number model for campaign registration. */
|
|
74
|
+
export interface AssignedNumber {
|
|
75
|
+
/** The unique identifier of the assignment. */
|
|
76
|
+
id: uuid;
|
|
77
|
+
/** The current state of the assignment. */
|
|
78
|
+
state?: string;
|
|
79
|
+
/** The campaign ID associated with the number. */
|
|
80
|
+
campaign_id?: uuid;
|
|
81
|
+
/** The phone number details. */
|
|
82
|
+
phone_number?: AssignedPhoneNumber;
|
|
83
|
+
/** Timestamp when the assignment was created. */
|
|
84
|
+
created_at?: string;
|
|
85
|
+
/** Timestamp when the assignment was last updated. */
|
|
86
|
+
updated_at?: string;
|
|
87
|
+
}
|
|
88
|
+
/** Response containing a list of assigned numbers. */
|
|
89
|
+
export interface AssignedNumberListResponse {
|
|
90
|
+
/** Pagination links. */
|
|
91
|
+
links?: PaginationLinks;
|
|
92
|
+
/** List of assigned numbers. */
|
|
93
|
+
data?: AssignedNumber[];
|
|
94
|
+
}
|
|
95
|
+
/** Phone number details in an assignment. */
|
|
96
|
+
export interface AssignedPhoneNumber {
|
|
97
|
+
/** The unique identifier of the phone number. */
|
|
98
|
+
id?: uuid;
|
|
99
|
+
/** The name of the phone number. */
|
|
100
|
+
name?: string;
|
|
101
|
+
/** The phone number in E.164 format. */
|
|
102
|
+
number?: string;
|
|
103
|
+
/** Optional: Specify a URL to receive webhook notifications. See the [10DLC status callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback) docs for the webhook payload. */
|
|
104
|
+
status_callback_url?: string;
|
|
105
|
+
}
|
|
106
|
+
/** Available phone number for purchase. */
|
|
107
|
+
export interface AvailablePhoneNumber {
|
|
108
|
+
/** The phone number in E.164 format. */
|
|
109
|
+
number: string;
|
|
110
|
+
/** The region of the phone number. */
|
|
111
|
+
region?: string;
|
|
112
|
+
/** The city of the phone number. */
|
|
113
|
+
city?: string;
|
|
114
|
+
/** The rate center of the phone number. */
|
|
115
|
+
rate_center?: string;
|
|
116
|
+
/** The LATA of the phone number. */
|
|
117
|
+
lata?: string;
|
|
118
|
+
/** The capabilities of the phone number. */
|
|
119
|
+
capabilities?: PhoneNumberCapabilities;
|
|
120
|
+
}
|
|
121
|
+
/** Response containing available phone numbers for purchase. */
|
|
122
|
+
export interface AvailablePhoneNumbersResponse {
|
|
123
|
+
/** Pagination links. */
|
|
124
|
+
links?: PaginationLinks;
|
|
125
|
+
/** List of available phone numbers. */
|
|
126
|
+
data?: AvailablePhoneNumber[];
|
|
127
|
+
}
|
|
128
|
+
/** Brand model for 10DLC registration. */
|
|
129
|
+
export interface Brand {
|
|
130
|
+
/** The unique identifier of the brand. */
|
|
131
|
+
id: uuid;
|
|
132
|
+
/** The current state of the brand. */
|
|
133
|
+
state?: string;
|
|
134
|
+
/** Brand/Marketing/DBA name of the business if applicable. */
|
|
135
|
+
name?: string;
|
|
136
|
+
/** The legal name of the business. */
|
|
137
|
+
company_name?: string;
|
|
138
|
+
/** A company contact email for this brand. */
|
|
139
|
+
contact_email?: string;
|
|
140
|
+
/** A contact phone number for this brand. */
|
|
141
|
+
contact_phone?: string;
|
|
142
|
+
/** Country of registration. */
|
|
143
|
+
ein_issuing_country?: string;
|
|
144
|
+
/** What type of legal entity is the organization? (PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT) */
|
|
145
|
+
legal_entity_type?: string;
|
|
146
|
+
/** Company EIN Number/Tax ID. */
|
|
147
|
+
ein?: string;
|
|
148
|
+
/** Full company address. */
|
|
149
|
+
company_address?: string;
|
|
150
|
+
/** An optional Vertical for the brand (REAL_ESTATE, HEALTHCARE, ENERGY, ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION, HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION). */
|
|
151
|
+
company_vertical?: string;
|
|
152
|
+
/** Link to the company website. */
|
|
153
|
+
company_website?: string;
|
|
154
|
+
/** If you are your own Campaign Service Provider, this is the approved Brand ID (Mandatory for CSPs, otherwise please omit). */
|
|
155
|
+
csp_brand_reference?: string;
|
|
156
|
+
/** This value must be true for all self-registered brands. */
|
|
157
|
+
csp_self_registered?: boolean;
|
|
158
|
+
/** Optional: Specify a URL to receive webhook notifications when your brand's state changes. See the [10DLC status callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback) docs for the webhook payload. */
|
|
159
|
+
status_callback_url?: string;
|
|
160
|
+
/** Timestamp when the brand was created. */
|
|
161
|
+
created_at?: string;
|
|
162
|
+
/** Timestamp when the brand was last updated. */
|
|
163
|
+
updated_at?: string;
|
|
164
|
+
}
|
|
165
|
+
/** Response containing a list of brands. */
|
|
166
|
+
export interface BrandListResponse {
|
|
167
|
+
/** Pagination links. */
|
|
168
|
+
links?: PaginationLinks;
|
|
169
|
+
/** List of brands. */
|
|
170
|
+
data?: Brand[];
|
|
171
|
+
}
|
|
172
|
+
/** Response containing a single brand. */
|
|
173
|
+
export interface BrandResponse {
|
|
174
|
+
/** The unique identifier of the brand. */
|
|
175
|
+
id: uuid;
|
|
176
|
+
/** The current state of the brand. */
|
|
177
|
+
state?: string;
|
|
178
|
+
/** Brand/Marketing/DBA name of the business if applicable. */
|
|
179
|
+
name?: string;
|
|
180
|
+
/** The legal name of the business. */
|
|
181
|
+
company_name?: string;
|
|
182
|
+
/** A company contact email for this brand. */
|
|
183
|
+
contact_email?: string;
|
|
184
|
+
/** A contact phone number for this brand. */
|
|
185
|
+
contact_phone?: string;
|
|
186
|
+
/** Country of registration. */
|
|
187
|
+
ein_issuing_country?: string;
|
|
188
|
+
/** What type of legal entity is the organization? (PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT) */
|
|
189
|
+
legal_entity_type?: string;
|
|
190
|
+
/** Company EIN Number/Tax ID. */
|
|
191
|
+
ein?: string;
|
|
192
|
+
/** Full company address. */
|
|
193
|
+
company_address?: string;
|
|
194
|
+
/** An optional Vertical for the brand (REAL_ESTATE, HEALTHCARE, ENERGY, ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION, HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION). */
|
|
195
|
+
company_vertical?: string;
|
|
196
|
+
/** Link to the company website. */
|
|
197
|
+
company_website?: string;
|
|
198
|
+
/** If you are your own Campaign Service Provider, this is the approved Brand ID (Mandatory for CSPs, otherwise please omit). */
|
|
199
|
+
csp_brand_reference?: string;
|
|
200
|
+
/** This value must be true for all self-registered brands. */
|
|
201
|
+
csp_self_registered?: boolean;
|
|
202
|
+
/** Optional: Specify a URL to receive webhook notifications when your brand's state changes. See the [10DLC status callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback) docs for the webhook payload. */
|
|
203
|
+
status_callback_url?: string;
|
|
204
|
+
/** Timestamp when the brand was created. */
|
|
205
|
+
created_at?: string;
|
|
206
|
+
/** Timestamp when the brand was last updated. */
|
|
207
|
+
updated_at?: string;
|
|
208
|
+
}
|
|
209
|
+
/** Call receive mode. */
|
|
210
|
+
export type CallReceiveMode = 'voice' | 'fax';
|
|
211
|
+
/** Campaign model for 10DLC registration. */
|
|
212
|
+
export interface Campaign {
|
|
213
|
+
/** The unique identifier of the campaign. */
|
|
214
|
+
id: uuid;
|
|
215
|
+
/** A name for the campaign. */
|
|
216
|
+
name?: string;
|
|
217
|
+
/** The current state of the campaign. */
|
|
218
|
+
state?: string;
|
|
219
|
+
/** An SMS Use Case category for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME_MIXED, MARKETING, MIXED, POLITICAL, POLITICAL_SECTION_527, POLLING_VOTING, PROXY, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SWEEPSTAKE, TRIAL, UCAAS_HIGH_VOLUME, UCAAS_LOW_VOLUME). */
|
|
220
|
+
sms_use_case?: string;
|
|
221
|
+
/** A sub use case category for MIXED or LOW_VOLUME_MIXED campaigns (CUSTOMER_CARE, HIGHER_EDUCATION, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, MARKETING, SECURITY_ALERT, 2FA, ACCOUNT_NOTIFICATION, DELIVERY_NOTIFICATION, FRAUD_ALERT). */
|
|
222
|
+
sub_use_cases?: string[];
|
|
223
|
+
/** Campaign Verify token. Required if sms use case is POLITICAL_SECTION_527. */
|
|
224
|
+
campaign_verify_token?: string;
|
|
225
|
+
/** A description for the campaign. Please use at least 40 characters. */
|
|
226
|
+
description?: string;
|
|
227
|
+
/** Sample message template/content. At least two samples are required and up to five can be provided. Please use at least 20 characters. */
|
|
228
|
+
sample1?: string;
|
|
229
|
+
/** Sample 2. */
|
|
230
|
+
sample2?: string;
|
|
231
|
+
/** Sample 3. */
|
|
232
|
+
sample3?: string;
|
|
233
|
+
/** Sample 4. */
|
|
234
|
+
sample4?: string;
|
|
235
|
+
/** Sample 5. */
|
|
236
|
+
sample5?: string;
|
|
237
|
+
/** If your messaging content will be modified in any way beyond what you shared in your templates, please describe the nature of how the content will change. */
|
|
238
|
+
dynamic_templates?: string;
|
|
239
|
+
/** Please describe the call to action/message flow your intended recipients will experience. */
|
|
240
|
+
message_flow?: string;
|
|
241
|
+
/** Please share the message subscribers receive when they opt in. */
|
|
242
|
+
opt_in_message?: string;
|
|
243
|
+
/** Please share the message subscribers receive when they opt out. */
|
|
244
|
+
opt_out_message?: string;
|
|
245
|
+
/** Please share the message subscribers receive when they request help. */
|
|
246
|
+
help_message?: string;
|
|
247
|
+
/** Opt in keywords that subscribers can use. */
|
|
248
|
+
opt_in_keywords?: string;
|
|
249
|
+
/** Opt out keywords that subscribers can use. */
|
|
250
|
+
opt_out_keywords?: string;
|
|
251
|
+
/** Help keywords that subscribers can use. */
|
|
252
|
+
help_keywords?: string;
|
|
253
|
+
/** Will 50 or more numbers be used with this single campaign? If so, please enter true. */
|
|
254
|
+
number_pooling_required?: boolean;
|
|
255
|
+
/** If you will be using number pooling, please provide an explanation as to why it is needed. */
|
|
256
|
+
number_pooling_per_campaign?: string;
|
|
257
|
+
/** Will this campaign include content related to direct lending or other loan agreements? */
|
|
258
|
+
direct_lending?: boolean;
|
|
259
|
+
/** Will you be using an embedded link of any kind? Note that public URL shorteners (bitly, tinyurl) will not be accepted. */
|
|
260
|
+
embedded_link?: boolean;
|
|
261
|
+
/** Are you using an embedded phone number (except the required HELP information contact phone number)? */
|
|
262
|
+
embedded_phone?: boolean;
|
|
263
|
+
/** Will this campaign include any age gated content as defined by carrier and CTA guidelines? */
|
|
264
|
+
age_gated_content?: boolean;
|
|
265
|
+
/** Is there any intent of this campaign to generate leads? */
|
|
266
|
+
lead_generation?: boolean;
|
|
267
|
+
/** If you are your own Campaign Service Provider, what is the approved Campaign ID? (Mandatory for CSPs, otherwise please omit) */
|
|
268
|
+
csp_campaign_reference?: string;
|
|
269
|
+
/** Optional: Specify a URL to receive webhook notifications when your campaign's state changes. See the [10DLC status callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback) docs for the webhook payload. */
|
|
270
|
+
status_callback_url?: string;
|
|
271
|
+
/** Timestamp when the campaign was created. */
|
|
272
|
+
created_at?: string;
|
|
273
|
+
/** Timestamp when the campaign was last updated. */
|
|
274
|
+
updated_at?: string;
|
|
275
|
+
}
|
|
276
|
+
/** Response containing a list of campaigns. */
|
|
277
|
+
export interface CampaignListResponse {
|
|
278
|
+
/** Pagination links. */
|
|
279
|
+
links?: PaginationLinks;
|
|
280
|
+
/** List of campaigns. */
|
|
281
|
+
data?: Campaign[];
|
|
282
|
+
}
|
|
283
|
+
/** Response containing a single campaign. */
|
|
284
|
+
export interface CampaignResponse {
|
|
285
|
+
/** The unique identifier of the campaign. */
|
|
286
|
+
id: uuid;
|
|
287
|
+
/** A name for the campaign. */
|
|
288
|
+
name?: string;
|
|
289
|
+
/** The current state of the campaign. */
|
|
290
|
+
state?: string;
|
|
291
|
+
/** An SMS Use Case category for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME_MIXED, MARKETING, MIXED, POLITICAL, POLITICAL_SECTION_527, POLLING_VOTING, PROXY, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SWEEPSTAKE, TRIAL, UCAAS_HIGH_VOLUME, UCAAS_LOW_VOLUME). */
|
|
292
|
+
sms_use_case?: string;
|
|
293
|
+
/** A sub use case category for MIXED or LOW_VOLUME_MIXED campaigns (CUSTOMER_CARE, HIGHER_EDUCATION, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, MARKETING, SECURITY_ALERT, 2FA, ACCOUNT_NOTIFICATION, DELIVERY_NOTIFICATION, FRAUD_ALERT). */
|
|
294
|
+
sub_use_cases?: string[];
|
|
295
|
+
/** Campaign Verify token. Required if sms use case is POLITICAL_SECTION_527. */
|
|
296
|
+
campaign_verify_token?: string;
|
|
297
|
+
/** A description for the campaign. Please use at least 40 characters. */
|
|
298
|
+
description?: string;
|
|
299
|
+
/** Sample message template/content. At least two samples are required and up to five can be provided. Please use at least 20 characters. */
|
|
300
|
+
sample1?: string;
|
|
301
|
+
/** Sample 2. */
|
|
302
|
+
sample2?: string;
|
|
303
|
+
/** Sample 3. */
|
|
304
|
+
sample3?: string;
|
|
305
|
+
/** Sample 4. */
|
|
306
|
+
sample4?: string;
|
|
307
|
+
/** Sample 5. */
|
|
308
|
+
sample5?: string;
|
|
309
|
+
/** If your messaging content will be modified in any way beyond what you shared in your templates, please describe the nature of how the content will change. */
|
|
310
|
+
dynamic_templates?: string;
|
|
311
|
+
/** Please describe the call to action/message flow your intended recipients will experience. */
|
|
312
|
+
message_flow?: string;
|
|
313
|
+
/** Please share the message subscribers receive when they opt in. */
|
|
314
|
+
opt_in_message?: string;
|
|
315
|
+
/** Please share the message subscribers receive when they opt out. */
|
|
316
|
+
opt_out_message?: string;
|
|
317
|
+
/** Please share the message subscribers receive when they request help. */
|
|
318
|
+
help_message?: string;
|
|
319
|
+
/** Opt in keywords that subscribers can use. */
|
|
320
|
+
opt_in_keywords?: string;
|
|
321
|
+
/** Opt out keywords that subscribers can use. */
|
|
322
|
+
opt_out_keywords?: string;
|
|
323
|
+
/** Help keywords that subscribers can use. */
|
|
324
|
+
help_keywords?: string;
|
|
325
|
+
/** Will 50 or more numbers be used with this single campaign? If so, please enter true. */
|
|
326
|
+
number_pooling_required?: boolean;
|
|
327
|
+
/** If you will be using number pooling, please provide an explanation as to why it is needed. */
|
|
328
|
+
number_pooling_per_campaign?: string;
|
|
329
|
+
/** Will this campaign include content related to direct lending or other loan agreements? */
|
|
330
|
+
direct_lending?: boolean;
|
|
331
|
+
/** Will you be using an embedded link of any kind? Note that public URL shorteners (bitly, tinyurl) will not be accepted. */
|
|
332
|
+
embedded_link?: boolean;
|
|
333
|
+
/** Are you using an embedded phone number (except the required HELP information contact phone number)? */
|
|
334
|
+
embedded_phone?: boolean;
|
|
335
|
+
/** Will this campaign include any age gated content as defined by carrier and CTA guidelines? */
|
|
336
|
+
age_gated_content?: boolean;
|
|
337
|
+
/** Is there any intent of this campaign to generate leads? */
|
|
338
|
+
lead_generation?: boolean;
|
|
339
|
+
/** If you are your own Campaign Service Provider, what is the approved Campaign ID? (Mandatory for CSPs, otherwise please omit) */
|
|
340
|
+
csp_campaign_reference?: string;
|
|
341
|
+
/** Optional: Specify a URL to receive webhook notifications when your campaign's state changes. See the [10DLC status callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback) docs for the webhook payload. */
|
|
342
|
+
status_callback_url?: string;
|
|
343
|
+
/** Timestamp when the campaign was created. */
|
|
344
|
+
created_at?: string;
|
|
345
|
+
/** Timestamp when the campaign was last updated. */
|
|
346
|
+
updated_at?: string;
|
|
347
|
+
}
|
|
348
|
+
/** Carrier lookup information. */
|
|
349
|
+
export interface CarrierLookupInfo {
|
|
350
|
+
/** The LRN associated with the number. */
|
|
351
|
+
lrn?: string;
|
|
352
|
+
/** The Service Profile Identifier associated with the number. */
|
|
353
|
+
spid?: string;
|
|
354
|
+
/** The Operating Company Number associated with the number. */
|
|
355
|
+
ocn?: string;
|
|
356
|
+
/** The Local Access and Transport Area number associated with the number. */
|
|
357
|
+
lata?: string;
|
|
358
|
+
/** The City associated with the number. */
|
|
359
|
+
city?: string;
|
|
360
|
+
/** The State/Province/Region associated with the number. */
|
|
361
|
+
state?: string;
|
|
362
|
+
/** The Jurisdiction associated with the number. */
|
|
363
|
+
jurisdiction?: string;
|
|
364
|
+
/** The LEC or Carrier of the number. */
|
|
365
|
+
lec?: string;
|
|
366
|
+
/** The type of line the number is. Generally either wireless or landline. */
|
|
367
|
+
linetype?: string;
|
|
368
|
+
}
|
|
369
|
+
/** Caller ID (CNAM) information. */
|
|
370
|
+
export interface CnamInfo {
|
|
371
|
+
/** The caller ID associated with the number. */
|
|
372
|
+
caller_id?: string;
|
|
373
|
+
}
|
|
374
|
+
/** Company vertical/industry classification. */
|
|
375
|
+
export type CompanyVertical = 'AGRICULTURE' | 'COMMUNICATION' | 'CONSTRUCTION' | 'EDUCATION' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HEALTHCARE' | 'HOSPITALITY' | 'HUMAN_RESOURCES' | 'INSURANCE' | 'LEGAL' | 'MANUFACTURING' | 'NGO' | 'POLITICAL' | 'POSTAL' | 'PROFESSIONAL' | 'REAL_ESTATE' | 'RETAIL' | 'TECHNOLOGY' | 'TRANSPORTATION';
|
|
376
|
+
/** Request body for creating an address. */
|
|
377
|
+
export interface CreateAddressRequest {
|
|
378
|
+
/** A friendly name given to the address to help distinguish and search for different addresses within your project. */
|
|
379
|
+
label: string;
|
|
380
|
+
/** The ISO 3166 Alpha 2 country code. */
|
|
381
|
+
country: string;
|
|
382
|
+
/** First name of the occupant associated with this address. */
|
|
383
|
+
first_name: string;
|
|
384
|
+
/** Last name of the occupant associated with this address. */
|
|
385
|
+
last_name: string;
|
|
386
|
+
/** The number portion of the street address. */
|
|
387
|
+
street_number: string;
|
|
388
|
+
/** The name portion of the street address. */
|
|
389
|
+
street_name: string;
|
|
390
|
+
/** If the address is divided into multiple sub-addresses, this identifies how the address is divided. Possible values are: Apartment, Basement, Building, Department, Floor, Office, Penthouse, Suite, Trailer, Unit. */
|
|
391
|
+
address_type?: AddressType;
|
|
392
|
+
/** If the address is divided into multiple sub-addresses, this identifies the particular sub-address. */
|
|
393
|
+
address_number?: string;
|
|
394
|
+
/** The city portion of the street address. */
|
|
395
|
+
city: string;
|
|
396
|
+
/** The state/province/region of the street address. In the USA and Canada, use the two-letter abbreviated form. */
|
|
397
|
+
state: string;
|
|
398
|
+
/** The postal code of the street address. */
|
|
399
|
+
postal_code: string;
|
|
400
|
+
}
|
|
401
|
+
/** Request body for importing a self-registered CSP brand. Use this when you have already registered your brand directly with TCR. */
|
|
402
|
+
export interface CreateCspBrandRequest {
|
|
403
|
+
/** Set to true to indicate this is a self-registered CSP brand. */
|
|
404
|
+
csp_self_registered: true;
|
|
405
|
+
/** Brand/Marketing/DBA name of the business. */
|
|
406
|
+
name: string;
|
|
407
|
+
/** The approved Brand ID from TCR. Required for CSP/self-registered brands. */
|
|
408
|
+
csp_brand_reference: string;
|
|
409
|
+
/** Specify a URL to receive webhook notifications when your brand's state changes. See the [10DLC status callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback) docs for the webhook payload. */
|
|
410
|
+
status_callback_url?: string;
|
|
411
|
+
}
|
|
412
|
+
/** Request body for creating a domain application. */
|
|
413
|
+
export interface CreateDomainApplicationRequest {
|
|
414
|
+
/** A string representing the friendly name for this domain application. */
|
|
415
|
+
name: string;
|
|
416
|
+
/** A string representing the identifier portion of the domain application. */
|
|
417
|
+
identifier: string;
|
|
418
|
+
/** The user portion of the domain application. */
|
|
419
|
+
user?: string;
|
|
420
|
+
/** Whether the domain application will enforce IP authentication for incoming requests. */
|
|
421
|
+
ip_auth_enabled?: boolean;
|
|
422
|
+
/** A list containing whitelisted IP addresses and IP blocks used if ip_auth_enabled is true. */
|
|
423
|
+
ip_auth?: string[];
|
|
424
|
+
/** Whether connections to this domain application require encryption or if encryption is optional. */
|
|
425
|
+
encryption?: 'optional' | 'required' | 'forbidden';
|
|
426
|
+
/** A list of codecs this domain application will support. */
|
|
427
|
+
codecs?: string[];
|
|
428
|
+
/** A list of encryption ciphers this domain application will support. */
|
|
429
|
+
ciphers?: string[];
|
|
430
|
+
/** Specify how the domain application will handle calls. */
|
|
431
|
+
call_handler?: DomainAppCallHandlerRequest;
|
|
432
|
+
/** A string representing the Relay topic to forward incoming calls to. Required when call_handler is relay_topic. */
|
|
433
|
+
call_relay_topic?: string;
|
|
434
|
+
/** A string representing a URL to send status change messages to. */
|
|
435
|
+
call_relay_topic_status_callback_url?: string;
|
|
436
|
+
/** A string representing the Relay Application to forward incoming calls to. Required when call_handler is relay_application. */
|
|
437
|
+
call_relay_application?: string;
|
|
438
|
+
/** A string representing the LaML URL to access when a call is received. Required when call_handler is laml_webhooks. */
|
|
439
|
+
call_request_url?: string;
|
|
440
|
+
/** A string representing the HTTP method to use with call_request_url. */
|
|
441
|
+
call_request_method?: 'GET' | 'POST';
|
|
442
|
+
/** A string representing the LaML URL to access when the call to call_request_url fails. */
|
|
443
|
+
call_fallback_url?: string;
|
|
444
|
+
/** A string representing the HTTP method to use with call_fallback_url. */
|
|
445
|
+
call_fallback_method?: 'GET' | 'POST';
|
|
446
|
+
/** A string representing a URL to send status change messages to. */
|
|
447
|
+
call_status_callback_url?: string;
|
|
448
|
+
/** A string representing the HTTP method to use with call_status_callback_url. */
|
|
449
|
+
call_status_callback_method?: 'GET' | 'POST';
|
|
450
|
+
/** A string representing the ID of the LaML application to forward incoming calls to. Required when call_handler is laml_application. */
|
|
451
|
+
call_laml_application_id?: string;
|
|
452
|
+
/** A string representing the ID of the Video Room to forward incoming calls to. Required when call_handler is video_room. */
|
|
453
|
+
call_video_room_id?: uuid;
|
|
454
|
+
/** A string representing the URL of the Relay script to execute when a call is received. Required when call_handler is relay_script. */
|
|
455
|
+
call_relay_script_url?: string;
|
|
456
|
+
/** A string representing the ID of the Dialogflow Agent to forward incoming calls to. Required when call_handler is dialogflow. */
|
|
457
|
+
call_dialogflow_agent_id?: uuid;
|
|
458
|
+
/** A string representing the ID of the AI Agent to forward incoming calls to. Required when call_handler is ai_agent. */
|
|
459
|
+
call_ai_agent_id?: uuid;
|
|
460
|
+
/** A string representing the ID of the Call Flow to forward incoming calls to. Required when call_handler is call_flow. */
|
|
461
|
+
call_flow_id?: uuid;
|
|
462
|
+
/** A string representing the version of your Call Flow you'd like to use. */
|
|
463
|
+
call_flow_version?: 'working_copy' | 'current_deployed';
|
|
464
|
+
/** This handler type is deprecated. Please use call_relay_application or call_relay_topic instead. */
|
|
465
|
+
call_relay_context?: string;
|
|
466
|
+
/** This property is deprecated. Please use call_relay_topic_status_callback_url instead. */
|
|
467
|
+
call_relay_context_status_callback_url?: string;
|
|
468
|
+
}
|
|
469
|
+
/** Request body for registering a new managed brand for 10DLC registration. */
|
|
470
|
+
export interface CreateManagedBrandRequest {
|
|
471
|
+
/** Brand/Marketing/DBA name of the business. */
|
|
472
|
+
name: string;
|
|
473
|
+
/** The legal name of the business. */
|
|
474
|
+
company_name: string;
|
|
475
|
+
/** A company contact email for this brand. */
|
|
476
|
+
contact_email: string;
|
|
477
|
+
/** A contact phone number for this brand. */
|
|
478
|
+
contact_phone: string;
|
|
479
|
+
/** Country of registration. */
|
|
480
|
+
ein_issuing_country: string;
|
|
481
|
+
/** What type of legal entity is the organization? */
|
|
482
|
+
legal_entity_type: LegalEntityType;
|
|
483
|
+
/** Company EIN Number/Tax ID. */
|
|
484
|
+
ein: string;
|
|
485
|
+
/** Full company address. */
|
|
486
|
+
company_address: string;
|
|
487
|
+
/** An optional Vertical for the brand. */
|
|
488
|
+
company_vertical?: CompanyVertical;
|
|
489
|
+
/** Link to the company website. */
|
|
490
|
+
company_website: string;
|
|
491
|
+
/** Specify a URL to receive webhook notifications when your brand's state changes. See the [10DLC status callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback) docs for the webhook payload. */
|
|
492
|
+
status_callback_url?: string;
|
|
493
|
+
}
|
|
494
|
+
/** Request body for creating a managed campaign. Used when the brand is a managed (non-CSP) brand. */
|
|
495
|
+
export interface CreateManagedCampaignRequest {
|
|
496
|
+
/** A name for the campaign. */
|
|
497
|
+
name: string;
|
|
498
|
+
/** The ID of the brand to associate with this campaign. */
|
|
499
|
+
brand_id: uuid;
|
|
500
|
+
/** An SMS Use Case category for the campaign. */
|
|
501
|
+
sms_use_case: string;
|
|
502
|
+
/** A sub use case category. Required for MIXED (2-5 sub use cases) or LOW_VOLUME_MIXED (1-5 sub use cases) campaigns. Must not be provided for other use cases. */
|
|
503
|
+
sub_use_cases?: string[];
|
|
504
|
+
/** Campaign Verify token. Required if sms_use_case is POLITICAL_SECTION_527. */
|
|
505
|
+
campaign_verify_token?: string;
|
|
506
|
+
/** A description for the campaign. */
|
|
507
|
+
description: string;
|
|
508
|
+
/** Sample message template/content. */
|
|
509
|
+
sample1: string;
|
|
510
|
+
/** Second sample message template/content. */
|
|
511
|
+
sample2: string;
|
|
512
|
+
/** Third sample message template/content. */
|
|
513
|
+
sample3?: string;
|
|
514
|
+
/** Fourth sample message template/content. */
|
|
515
|
+
sample4?: string;
|
|
516
|
+
/** Fifth sample message template/content. */
|
|
517
|
+
sample5?: string;
|
|
518
|
+
/** If your messaging content will be modified in any way beyond what you shared in your templates, please describe the nature of how the content will change. */
|
|
519
|
+
dynamic_messages?: string;
|
|
520
|
+
/** Please describe the call to action/message flow your intended recipients will experience. */
|
|
521
|
+
message_flow: string;
|
|
522
|
+
/** Please share the message subscribers receive when they opt in. */
|
|
523
|
+
opt_in_message?: string;
|
|
524
|
+
/** Please share the message subscribers receive when they opt out. */
|
|
525
|
+
opt_out_message: string;
|
|
526
|
+
/** Please share the message subscribers receive when they request help. */
|
|
527
|
+
help_message: string;
|
|
528
|
+
/** Opt in keywords that subscribers can use. Must be comma-separated values with no spaces between keywords. */
|
|
529
|
+
opt_in_keywords?: string;
|
|
530
|
+
/** Opt out keywords that subscribers can use. Must be comma-separated values with no spaces between keywords. */
|
|
531
|
+
opt_out_keywords?: string;
|
|
532
|
+
/** Help keywords that subscribers can use. Must be comma-separated values with no spaces between keywords. */
|
|
533
|
+
help_keywords?: string;
|
|
534
|
+
/** Will 50 or more numbers be used with this single campaign? */
|
|
535
|
+
number_pooling_required: boolean;
|
|
536
|
+
/** If you will be using number pooling, please provide an explanation as to why it is needed. Required if number_pooling_required is true. */
|
|
537
|
+
number_pooling_per_campaign?: string;
|
|
538
|
+
/** Will this campaign include content related to direct lending or other loan agreements? */
|
|
539
|
+
direct_lending: boolean;
|
|
540
|
+
/** Will you be using an embedded link of any kind? Note that public URL shorteners (bitly, tinyurl) will not be accepted. */
|
|
541
|
+
embedded_link: boolean;
|
|
542
|
+
/** Are you using an embedded phone number (except the required HELP information contact phone number)? */
|
|
543
|
+
embedded_phone: boolean;
|
|
544
|
+
/** Will this campaign include any age gated content as defined by carrier and CTA guidelines? */
|
|
545
|
+
age_gated_content: boolean;
|
|
546
|
+
/** Is there any intent of this campaign to generate leads? */
|
|
547
|
+
lead_generation: boolean;
|
|
548
|
+
/** I agree to the terms and conditions which do not allow me to use this campaign for affiliate marketing. */
|
|
549
|
+
terms_and_conditions: boolean;
|
|
550
|
+
/** Specify a URL to receive webhook notifications when your campaign's state changes. See the [10DLC status callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback) docs for the webhook payload. */
|
|
551
|
+
status_callback_url?: string;
|
|
552
|
+
}
|
|
553
|
+
/** Request body for creating a number group. */
|
|
554
|
+
export interface CreateNumberGroupRequest {
|
|
555
|
+
/** The name given to the number group. Helps to distinguish different groups within your project. */
|
|
556
|
+
name: string;
|
|
557
|
+
/** Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one. */
|
|
558
|
+
sticky_sender?: boolean;
|
|
559
|
+
}
|
|
560
|
+
/** Request body for creating an order. */
|
|
561
|
+
export interface CreateOrderRequest {
|
|
562
|
+
/** A list of phone numbers in E164 format. */
|
|
563
|
+
phone_numbers?: string[];
|
|
564
|
+
/** Optional: Specify a URL to receive webhook notifications when your number assignment order and the number assignments that belong to it change state. See the [10DLC status callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback) docs for the webhook payload. */
|
|
565
|
+
status_callback_url?: string;
|
|
566
|
+
}
|
|
567
|
+
/** Request body for creating a partner/CSP campaign. Used when the brand is a CSP (self-registered) brand. */
|
|
568
|
+
export interface CreatePartnerCampaignRequest {
|
|
569
|
+
/** A name for the campaign. */
|
|
570
|
+
name: string;
|
|
571
|
+
/** The ID of the brand to associate with this campaign. Must be a CSP/partner brand. */
|
|
572
|
+
brand_id: uuid;
|
|
573
|
+
/** The approved Campaign ID from TCR. Required for CSP/self-registered campaigns. */
|
|
574
|
+
csp_campaign_reference: string;
|
|
575
|
+
/** Specify a URL to receive webhook notifications when your campaign's state changes. See the [10DLC status callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback) docs for the webhook payload. */
|
|
576
|
+
status_callback_url?: string;
|
|
577
|
+
}
|
|
578
|
+
/** Request body for creating a queue. */
|
|
579
|
+
export interface CreateQueueRequest {
|
|
580
|
+
/** The name of the queue. */
|
|
581
|
+
name?: string;
|
|
582
|
+
/** The maximum number of callers allowed in the queue. */
|
|
583
|
+
max_size?: number;
|
|
584
|
+
}
|
|
585
|
+
/** Request body for creating a SIP endpoint. */
|
|
586
|
+
export interface CreateSipEndpointRequest {
|
|
587
|
+
/** String representing the username portion of the endpoint. Must be unique across your project and must not contain white space characters or @. */
|
|
588
|
+
username: string;
|
|
589
|
+
/** A password to authenticate registrations to this endpoint. */
|
|
590
|
+
password: string;
|
|
591
|
+
/** Friendly Caller ID used as the CNAM when dialing a phone number or the From when dialing another SIP Endpoint. */
|
|
592
|
+
caller_id?: string;
|
|
593
|
+
/** When dialing a PSTN phone number, you must send it From a number you have purchased or verified. send_as indicates which number this endpoint has set as its origination. random indicates it will randomly choose a purchased or verified number from within the project. */
|
|
594
|
+
send_as?: string;
|
|
595
|
+
/** A list of encryption ciphers this endpoint will support. */
|
|
596
|
+
ciphers?: string[];
|
|
597
|
+
/** A list of codecs this endpoint will support. */
|
|
598
|
+
codecs?: string[];
|
|
599
|
+
/** Specifies the encryption requirements for connections to this endpoint. */
|
|
600
|
+
encryption?: 'default' | 'required' | 'optional';
|
|
601
|
+
/** What type of handler you want to run on inbound calls. */
|
|
602
|
+
call_handler?: 'relay_context' | 'relay_topic' | 'relay_application' | 'relay_connector' | 'relay_script' | 'laml_webhooks' | 'laml_application' | 'dialogflow' | 'video_room' | 'call_flow' | 'ai_agent';
|
|
603
|
+
/** The LaML URL to access when a call is received. Required when call_handler is laml_webhooks. */
|
|
604
|
+
call_request_url?: string;
|
|
605
|
+
/** The HTTP method to use with call_request_url. */
|
|
606
|
+
call_request_method?: 'GET' | 'POST';
|
|
607
|
+
/** The LaML URL to access when the call to call_request_url fails. Required when call_handler is laml_webhooks. */
|
|
608
|
+
call_fallback_url?: string;
|
|
609
|
+
/** The HTTP method to use with call_fallback_url. */
|
|
610
|
+
call_fallback_method?: 'GET' | 'POST';
|
|
611
|
+
/** A URL to send status change messages to. Required when call_handler is laml_webhooks. */
|
|
612
|
+
call_status_callback_url?: string;
|
|
613
|
+
/** The HTTP method to use with call_status_callback_url. */
|
|
614
|
+
call_status_callback_method?: 'GET' | 'POST';
|
|
615
|
+
/** The ID of the LaML application to forward incoming calls to. Required when call_handler is laml_application. */
|
|
616
|
+
call_laml_application_id?: string;
|
|
617
|
+
/** The ID of the Dialogflow agent to forward incoming calls to. Required when call_handler is dialogflow. */
|
|
618
|
+
call_dialogflow_agent_id?: string;
|
|
619
|
+
/** The Relay topic to forward incoming calls to. Required when call_handler is relay_topic. */
|
|
620
|
+
call_relay_topic?: string;
|
|
621
|
+
/** A URL to send status change messages to. Required when call_handler is relay_topic. */
|
|
622
|
+
call_relay_topic_status_callback_url?: string;
|
|
623
|
+
/** The Relay context to forward incoming calls to. Required when call_handler is relay_context. */
|
|
624
|
+
call_relay_context?: string;
|
|
625
|
+
/** A URL to send status change messages to. Required when call_handler is relay_context. */
|
|
626
|
+
call_relay_context_status_callback_url?: string;
|
|
627
|
+
/** The Relay application to forward incoming calls to. Required when call_handler is relay_application. */
|
|
628
|
+
call_relay_application?: string;
|
|
629
|
+
/** The ID of the Video Room to forward incoming calls to. Required when call_handler is video_room. */
|
|
630
|
+
call_video_room_id?: string;
|
|
631
|
+
/** The ID of the Call Flow to forward incoming calls to. Required when call_handler is call_flow. */
|
|
632
|
+
call_flow_id?: string;
|
|
633
|
+
/** The version of the Call Flow to use. Valid values are 'working_copy' or 'current_deployed'. */
|
|
634
|
+
call_flow_version?: string;
|
|
635
|
+
/** The ID of the AI Agent to forward incoming calls to. Required when call_handler is ai_agent. */
|
|
636
|
+
call_ai_agent_id?: string;
|
|
637
|
+
/** A URL of a SWML script to respond to incoming calls. Required when call_handler is relay_script. */
|
|
638
|
+
call_relay_script_url?: string;
|
|
639
|
+
}
|
|
640
|
+
/** Request body for creating a verified caller ID. */
|
|
641
|
+
export interface CreateVerifiedCallerIDRequest {
|
|
642
|
+
/** String representing the phone number for the caller ID. This must be a valid, routeable phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164) that is able to receive a voice phone call for verification. */
|
|
643
|
+
number: string;
|
|
644
|
+
/** The name portion of the caller ID. If not provided, the default will be the formatted number. */
|
|
645
|
+
name?: string;
|
|
646
|
+
/** The extension of the phone number for the caller ID. This is only used when placing the verification call. */
|
|
647
|
+
extension?: string;
|
|
648
|
+
}
|
|
649
|
+
/** All possible call handler types for domain applications. Includes types that can only be assigned via the Fabric API or UI. */
|
|
650
|
+
export type DomainAppCallHandler = 'relay_topic' | 'relay_application' | 'laml_webhooks' | 'laml_application' | 'video_room' | 'relay_script' | 'dialogflow' | 'ai_agent' | 'call_flow' | 'relay_context' | 'relay_connector' | 'fabric_subscriber' | 'sip_gateway' | 'call_queue';
|
|
651
|
+
/** Call handler types that can be assigned via the API. */
|
|
652
|
+
export type DomainAppCallHandlerRequest = 'relay_topic' | 'relay_application' | 'laml_webhooks' | 'laml_application' | 'video_room' | 'relay_script' | 'dialogflow' | 'ai_agent' | 'call_flow' | 'relay_context';
|
|
653
|
+
/** Domain application model. */
|
|
654
|
+
export interface DomainApplication {
|
|
655
|
+
/** The unique identifier of the domain application on SignalWire. */
|
|
656
|
+
id: uuid;
|
|
657
|
+
/** A string representation of the type of object this record is. */
|
|
658
|
+
type: string;
|
|
659
|
+
/** The unique domain for this application, combining your space subdomain and identifier. */
|
|
660
|
+
domain: string;
|
|
661
|
+
/** A string representing the friendly name for this domain application. */
|
|
662
|
+
name: string | null;
|
|
663
|
+
/** A string representing the identifier portion of the domain application. */
|
|
664
|
+
identifier: string;
|
|
665
|
+
/** A string representing the user portion of the domain application. */
|
|
666
|
+
user: string;
|
|
667
|
+
/** Whether the domain application will enforce IP authentication for incoming requests. */
|
|
668
|
+
ip_auth_enabled: boolean;
|
|
669
|
+
/** A list containing whitelisted IP addresses and IP blocks used if ip_auth_enabled is true. */
|
|
670
|
+
ip_auth: string[];
|
|
671
|
+
/** Specify how the domain application will handle calls. */
|
|
672
|
+
call_handler: DomainAppCallHandler | null;
|
|
673
|
+
/** The unique identifier of the calling handler resource. */
|
|
674
|
+
calling_handler_resource_id: uuid | null;
|
|
675
|
+
/** A string representing the Relay topic to forward incoming calls to. */
|
|
676
|
+
call_relay_topic: string | null;
|
|
677
|
+
/** A string representing a URL to send status change messages to. */
|
|
678
|
+
call_relay_topic_status_callback_url: string | null;
|
|
679
|
+
/** Deprecated. Use call_relay_application instead. */
|
|
680
|
+
call_relay_context: string | null;
|
|
681
|
+
/** Deprecated. Use call_relay_topic_status_callback_url instead. */
|
|
682
|
+
call_relay_context_status_callback_url: string | null;
|
|
683
|
+
/** A string representing the LaML URL to access when a call is received. */
|
|
684
|
+
call_request_url: string | null;
|
|
685
|
+
/** A string representing the HTTP method to use with call_request_url. */
|
|
686
|
+
call_request_method: 'GET' | 'POST' | null;
|
|
687
|
+
/** A string representing the LaML URL to access when the call to call_request_url fails. */
|
|
688
|
+
call_fallback_url: string | null;
|
|
689
|
+
/** A string representing the HTTP method to use with call_fallback_url. */
|
|
690
|
+
call_fallback_method: 'GET' | 'POST' | null;
|
|
691
|
+
/** A string representing a URL to send status change messages to. */
|
|
692
|
+
call_status_callback_url: string | null;
|
|
693
|
+
/** A string representing the HTTP method to use with call_status_callback_url. */
|
|
694
|
+
call_status_callback_method: 'GET' | 'POST' | null;
|
|
695
|
+
/** A string representing the ID of the LaML application to forward incoming calls to. */
|
|
696
|
+
call_laml_application_id: string | null;
|
|
697
|
+
/** A string representing the ID of the Video Room to forward incoming calls to. */
|
|
698
|
+
call_video_room_id: uuid | null;
|
|
699
|
+
/** A string representing the URL of the Relay script to execute when a call is received. */
|
|
700
|
+
call_relay_script_url: string | null;
|
|
701
|
+
/** A string representing whether connections to this domain application require encryption or if encryption is optional. Valid values are optional, required, and forbidden. */
|
|
702
|
+
encryption: 'optional' | 'required' | 'forbidden';
|
|
703
|
+
/** A list of codecs this domain application will support. Currently supported values are: OPUS, G722, PCMU, PCMA, G729, VP8, and H264. */
|
|
704
|
+
codecs: string[];
|
|
705
|
+
/** A list of encryption ciphers this domain application will support. Currently supported values are: AEAD_AES_256_GCM_8, AES_256_CM_HMAC_SHA1_80, AES_CM_128_HMAC_SHA1_80, AES_256_CM_HMAC_SHA1_32, and AES_CM_128_HMAC_SHA1_32. */
|
|
706
|
+
ciphers: string[];
|
|
707
|
+
}
|
|
708
|
+
/** Response containing a list of domain applications. */
|
|
709
|
+
export interface DomainApplicationListResponse {
|
|
710
|
+
/** Pagination links. */
|
|
711
|
+
links: PaginationLinks;
|
|
712
|
+
/** List of domain applications. */
|
|
713
|
+
data: DomainApplication[];
|
|
714
|
+
}
|
|
715
|
+
/** Response containing a single domain application. */
|
|
716
|
+
export interface DomainApplicationResponse {
|
|
717
|
+
/** The unique identifier of the domain application on SignalWire. */
|
|
718
|
+
id: uuid;
|
|
719
|
+
/** A string representation of the type of object this record is. */
|
|
720
|
+
type: string;
|
|
721
|
+
/** The unique domain for this application, combining your space subdomain and identifier. */
|
|
722
|
+
domain: string;
|
|
723
|
+
/** A string representing the friendly name for this domain application. */
|
|
724
|
+
name: string | null;
|
|
725
|
+
/** A string representing the identifier portion of the domain application. */
|
|
726
|
+
identifier: string;
|
|
727
|
+
/** A string representing the user portion of the domain application. */
|
|
728
|
+
user: string;
|
|
729
|
+
/** Whether the domain application will enforce IP authentication for incoming requests. */
|
|
730
|
+
ip_auth_enabled: boolean;
|
|
731
|
+
/** A list containing whitelisted IP addresses and IP blocks used if ip_auth_enabled is true. */
|
|
732
|
+
ip_auth: string[];
|
|
733
|
+
/** Specify how the domain application will handle calls. */
|
|
734
|
+
call_handler: DomainAppCallHandler | null;
|
|
735
|
+
/** The unique identifier of the calling handler resource. */
|
|
736
|
+
calling_handler_resource_id: uuid | null;
|
|
737
|
+
/** A string representing the Relay topic to forward incoming calls to. */
|
|
738
|
+
call_relay_topic: string | null;
|
|
739
|
+
/** A string representing a URL to send status change messages to. */
|
|
740
|
+
call_relay_topic_status_callback_url: string | null;
|
|
741
|
+
/** Deprecated. Use call_relay_application instead. */
|
|
742
|
+
call_relay_context: string | null;
|
|
743
|
+
/** Deprecated. Use call_relay_topic_status_callback_url instead. */
|
|
744
|
+
call_relay_context_status_callback_url: string | null;
|
|
745
|
+
/** A string representing the LaML URL to access when a call is received. */
|
|
746
|
+
call_request_url: string | null;
|
|
747
|
+
/** A string representing the HTTP method to use with call_request_url. */
|
|
748
|
+
call_request_method: 'GET' | 'POST' | null;
|
|
749
|
+
/** A string representing the LaML URL to access when the call to call_request_url fails. */
|
|
750
|
+
call_fallback_url: string | null;
|
|
751
|
+
/** A string representing the HTTP method to use with call_fallback_url. */
|
|
752
|
+
call_fallback_method: 'GET' | 'POST' | null;
|
|
753
|
+
/** A string representing a URL to send status change messages to. */
|
|
754
|
+
call_status_callback_url: string | null;
|
|
755
|
+
/** A string representing the HTTP method to use with call_status_callback_url. */
|
|
756
|
+
call_status_callback_method: 'GET' | 'POST' | null;
|
|
757
|
+
/** A string representing the ID of the LaML application to forward incoming calls to. */
|
|
758
|
+
call_laml_application_id: string | null;
|
|
759
|
+
/** A string representing the ID of the Video Room to forward incoming calls to. */
|
|
760
|
+
call_video_room_id: uuid | null;
|
|
761
|
+
/** A string representing the URL of the Relay script to execute when a call is received. */
|
|
762
|
+
call_relay_script_url: string | null;
|
|
763
|
+
/** A string representing whether connections to this domain application require encryption or if encryption is optional. Valid values are optional, required, and forbidden. */
|
|
764
|
+
encryption: 'optional' | 'required' | 'forbidden';
|
|
765
|
+
/** A list of codecs this domain application will support. Currently supported values are: OPUS, G722, PCMU, PCMA, G729, VP8, and H264. */
|
|
766
|
+
codecs: string[];
|
|
767
|
+
/** A list of encryption ciphers this domain application will support. Currently supported values are: AEAD_AES_256_GCM_8, AES_256_CM_HMAC_SHA1_80, AES_CM_128_HMAC_SHA1_80, AES_256_CM_HMAC_SHA1_32, and AES_CM_128_HMAC_SHA1_32. */
|
|
768
|
+
ciphers: string[];
|
|
769
|
+
}
|
|
770
|
+
/** HTTP method type. */
|
|
771
|
+
export type HttpMethod = 'GET' | 'POST';
|
|
772
|
+
/** Request body for importing a phone number. */
|
|
773
|
+
export interface ImportPhoneNumberRequest {
|
|
774
|
+
/** The phone number to import in E.164 format. Number must be between 5 and 30 characters with no special characters besides a leading +. */
|
|
775
|
+
number: string;
|
|
776
|
+
/** The type of phone number being imported. */
|
|
777
|
+
number_type: 'longcode' | 'tollfree';
|
|
778
|
+
/** The capabilities to enable for this phone number. Can include any combination of SMS, Voice, Fax, and MMS. If not provided, defaults to all capabilities. */
|
|
779
|
+
capabilities?: ('sms' | 'voice' | 'fax' | 'mms')[];
|
|
780
|
+
}
|
|
781
|
+
/** Legal entity type for brand registration. */
|
|
782
|
+
export type LegalEntityType = 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT';
|
|
783
|
+
/** Phone number representation within a membership. */
|
|
784
|
+
export interface MembershipPhoneNumber {
|
|
785
|
+
/** The unique identifier of the phone number. */
|
|
786
|
+
id?: uuid;
|
|
787
|
+
/** The name given to the phone number. */
|
|
788
|
+
name?: string;
|
|
789
|
+
/** The phone number in E.164 format. */
|
|
790
|
+
number?: string;
|
|
791
|
+
/** The capabilities of the phone number. */
|
|
792
|
+
capabilities?: string[];
|
|
793
|
+
}
|
|
794
|
+
/** MFA request model. */
|
|
795
|
+
export interface MfaRequest {
|
|
796
|
+
/** The E164 number to use as the destination. */
|
|
797
|
+
to: string;
|
|
798
|
+
/** The E164 number from your account to use as the origin of the message. SignalWire will use a special verified number if not specified. */
|
|
799
|
+
from?: string;
|
|
800
|
+
/** Specify a custom message to send before the token. The message must fit within one segment; either 160 characters or 70 characters when using non-GSM symbols. */
|
|
801
|
+
message?: string;
|
|
802
|
+
/** The number of characters in the token, from 4 to 20. Defaults to 6. */
|
|
803
|
+
token_length?: number;
|
|
804
|
+
/** The number of seconds the token is considered valid for. Defaults to 3600, with a maximum of 604800. */
|
|
805
|
+
valid_for?: number;
|
|
806
|
+
/** The number of allowed verification attempts, including the first one, from 1 to 20. Defaults to 3. */
|
|
807
|
+
max_attempts?: number;
|
|
808
|
+
/** Set to true or false, whether to include letters or just numbers in the token. Defaults to false (numbers only). */
|
|
809
|
+
allow_alphas?: boolean;
|
|
810
|
+
}
|
|
811
|
+
/** MFA response model. */
|
|
812
|
+
export interface MfaResponse {
|
|
813
|
+
/** The MFA request ID. Save this for verification. */
|
|
814
|
+
id: uuid;
|
|
815
|
+
/** Whether the request was successfully queued. */
|
|
816
|
+
success: boolean;
|
|
817
|
+
/** The destination of the MFA request. */
|
|
818
|
+
to: string;
|
|
819
|
+
/** Can be sms for a text message or call for a phone call. */
|
|
820
|
+
channel: string;
|
|
821
|
+
}
|
|
822
|
+
/** MFA verification request model. */
|
|
823
|
+
export interface MfaVerifyRequest {
|
|
824
|
+
/** The token to verify. */
|
|
825
|
+
token: string;
|
|
826
|
+
}
|
|
827
|
+
/** MFA verification response model. */
|
|
828
|
+
export interface MfaVerifyResponse {
|
|
829
|
+
/** Whether the token was successfully verified by the API. When `max_attempts` are reached or the request is no longer valid, the endpoint will return a `404 Not Found`. */
|
|
830
|
+
success: boolean;
|
|
831
|
+
}
|
|
832
|
+
/** Number group model. */
|
|
833
|
+
export interface NumberGroup {
|
|
834
|
+
/** The unique identifier of the Number Group on SignalWire. This can be used to update or delete the group programmatically. */
|
|
835
|
+
id: uuid;
|
|
836
|
+
/** The name given to the number group. Helps to distinguish different groups within your project. */
|
|
837
|
+
name: string;
|
|
838
|
+
/** Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one. */
|
|
839
|
+
sticky_sender: boolean;
|
|
840
|
+
/** The number of phone numbers within the group. */
|
|
841
|
+
phone_number_count: number;
|
|
842
|
+
}
|
|
843
|
+
/** Response containing a list of number groups. */
|
|
844
|
+
export interface NumberGroupListResponse {
|
|
845
|
+
/** Pagination links. */
|
|
846
|
+
links: PaginationLinks;
|
|
847
|
+
/** List of number groups. */
|
|
848
|
+
data: NumberGroup[];
|
|
849
|
+
}
|
|
850
|
+
/** Number group membership model. */
|
|
851
|
+
export interface NumberGroupMembership {
|
|
852
|
+
/** The unique identifier of the Number Group Membership on SignalWire. This can be used to delete the membership programmatically. */
|
|
853
|
+
id: uuid;
|
|
854
|
+
/** The unique identifier of the Number Group this membership is associated with. */
|
|
855
|
+
number_group_id: uuid;
|
|
856
|
+
/** A representation of the phone number this membership is associated with. */
|
|
857
|
+
phone_number: MembershipPhoneNumber;
|
|
858
|
+
/** The date and time when the membership was created. */
|
|
859
|
+
created_at: string;
|
|
860
|
+
/** The date and time when the membership was last updated. */
|
|
861
|
+
updated_at: string;
|
|
862
|
+
}
|
|
863
|
+
/** Response containing a list of number group memberships. */
|
|
864
|
+
export interface NumberGroupMembershipListResponse {
|
|
865
|
+
/** Pagination links. */
|
|
866
|
+
links: PaginationLinks;
|
|
867
|
+
/** List of number group memberships. */
|
|
868
|
+
data: NumberGroupMembership[];
|
|
869
|
+
}
|
|
870
|
+
/** Response containing a single number group membership. */
|
|
871
|
+
export interface NumberGroupMembershipResponse {
|
|
872
|
+
/** The unique identifier of the Number Group Membership on SignalWire. This can be used to delete the membership programmatically. */
|
|
873
|
+
id: uuid;
|
|
874
|
+
/** The unique identifier of the Number Group this membership is associated with. */
|
|
875
|
+
number_group_id: uuid;
|
|
876
|
+
/** A representation of the phone number this membership is associated with. */
|
|
877
|
+
phone_number: MembershipPhoneNumber;
|
|
878
|
+
/** The date and time when the membership was created. */
|
|
879
|
+
created_at: string;
|
|
880
|
+
/** The date and time when the membership was last updated. */
|
|
881
|
+
updated_at: string;
|
|
882
|
+
}
|
|
883
|
+
/** Response containing a single number group. */
|
|
884
|
+
export interface NumberGroupResponse {
|
|
885
|
+
/** The unique identifier of the Number Group on SignalWire. This can be used to update or delete the group programmatically. */
|
|
886
|
+
id: uuid;
|
|
887
|
+
/** The name given to the number group. Helps to distinguish different groups within your project. */
|
|
888
|
+
name: string;
|
|
889
|
+
/** Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one. */
|
|
890
|
+
sticky_sender: boolean;
|
|
891
|
+
/** The number of phone numbers within the group. */
|
|
892
|
+
phone_number_count: number;
|
|
893
|
+
}
|
|
894
|
+
/** Order model for campaign registry operations. */
|
|
895
|
+
export interface Order {
|
|
896
|
+
/** The unique identifier of the order. */
|
|
897
|
+
id: uuid;
|
|
898
|
+
/** The current state of the order. */
|
|
899
|
+
state?: string;
|
|
900
|
+
/** Timestamp when the order was processed. */
|
|
901
|
+
processed_at?: string;
|
|
902
|
+
/** Timestamp when the order was created. */
|
|
903
|
+
created_at?: string;
|
|
904
|
+
/** Timestamp when the order was last updated. */
|
|
905
|
+
updated_at?: string;
|
|
906
|
+
/** Optional: Specify a URL to receive webhook notifications when your number assignment order and the number assignments that belong to it change state. See the [10DLC status callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback) docs for the webhook payload. */
|
|
907
|
+
status_callback_url?: string;
|
|
908
|
+
}
|
|
909
|
+
/** Response containing a list of orders. */
|
|
910
|
+
export interface OrderListResponse {
|
|
911
|
+
/** Pagination links. */
|
|
912
|
+
links?: PaginationLinks;
|
|
913
|
+
/** List of orders. */
|
|
914
|
+
data?: Order[];
|
|
915
|
+
}
|
|
916
|
+
/** Response containing a single order. */
|
|
917
|
+
export interface OrderResponse {
|
|
918
|
+
/** The unique identifier of the order. */
|
|
919
|
+
id: uuid;
|
|
920
|
+
/** The current state of the order. */
|
|
921
|
+
state?: string;
|
|
922
|
+
/** Timestamp when the order was processed. */
|
|
923
|
+
processed_at?: string;
|
|
924
|
+
/** Timestamp when the order was created. */
|
|
925
|
+
created_at?: string;
|
|
926
|
+
/** Timestamp when the order was last updated. */
|
|
927
|
+
updated_at?: string;
|
|
928
|
+
/** Optional: Specify a URL to receive webhook notifications when your number assignment order and the number assignments that belong to it change state. See the [10DLC status callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback) docs for the webhook payload. */
|
|
929
|
+
status_callback_url?: string;
|
|
930
|
+
}
|
|
931
|
+
/** Pagination links for list responses. */
|
|
932
|
+
export interface PaginationLinks {
|
|
933
|
+
/** Link to the current page. */
|
|
934
|
+
self: string;
|
|
935
|
+
/** Link to the first page. */
|
|
936
|
+
first: string;
|
|
937
|
+
/** Link to the next page. Only present when there are more results. */
|
|
938
|
+
next?: string;
|
|
939
|
+
/** Link to the previous page. Only present when not on the first page. */
|
|
940
|
+
prev?: string;
|
|
941
|
+
}
|
|
942
|
+
/** Phone number model. */
|
|
943
|
+
export interface PhoneNumber {
|
|
944
|
+
/** The unique identifier of the phone number. */
|
|
945
|
+
id: uuid;
|
|
946
|
+
/** The phone number in E.164 format. */
|
|
947
|
+
number: string;
|
|
948
|
+
/** The name given to the phone number. Helps to distinguish different phone numbers within your project. */
|
|
949
|
+
name: string | null;
|
|
950
|
+
/** A list of communication methods this phone number supports. */
|
|
951
|
+
capabilities: PhoneNumberCapability[];
|
|
952
|
+
/** The type of number this is defined as. */
|
|
953
|
+
number_type: PhoneNumberType;
|
|
954
|
+
/** The E911 address ID associated with this phone number. */
|
|
955
|
+
e911_address_id: uuid | null;
|
|
956
|
+
/** The date the number was added to your project. */
|
|
957
|
+
created_at: string;
|
|
958
|
+
/** The date the number was last updated. */
|
|
959
|
+
updated_at: string;
|
|
960
|
+
/** The next date the number will be billed for. */
|
|
961
|
+
next_billed_at: string | null;
|
|
962
|
+
/** What type of handler you want to run on inbound calls. */
|
|
963
|
+
call_handler: PhoneNumberCallHandler | null;
|
|
964
|
+
/** The unique identifier of the calling handler resource. */
|
|
965
|
+
calling_handler_resource_id: uuid | null;
|
|
966
|
+
/** How do you want to receive the incoming call. */
|
|
967
|
+
call_receive_mode: CallReceiveMode;
|
|
968
|
+
/** The URL to make a request to when using the laml_webhooks call handler. */
|
|
969
|
+
call_request_url: string | null;
|
|
970
|
+
/** The HTTP method to use when making a request to the call_request_url. */
|
|
971
|
+
call_request_method: HttpMethod | null;
|
|
972
|
+
/** The fallback URL to make a request to when using the laml_webhooks call handler and the call_request_url fails. */
|
|
973
|
+
call_fallback_url: string | null;
|
|
974
|
+
/** The HTTP method to use when making a request to the call_fallback_url. */
|
|
975
|
+
call_fallback_method: HttpMethod | null;
|
|
976
|
+
/** The URL to make status callbacks to when using the laml_webhooks call handler. */
|
|
977
|
+
call_status_callback_url: string | null;
|
|
978
|
+
/** The HTTP method to use when making a request to the call_status_callback_url. */
|
|
979
|
+
call_status_callback_method: HttpMethod | null;
|
|
980
|
+
/** The ID of the LaML Application to use when using the laml_application call handler. */
|
|
981
|
+
call_laml_application_id: string | null;
|
|
982
|
+
/** The ID of the Dialogflow Agent to start when using the dialogflow call handler. */
|
|
983
|
+
call_dialogflow_agent_id: string | null;
|
|
984
|
+
/** A string representing the Relay topic to forward incoming calls to. This is only used (and required) when call_handler is set to relay_topic. */
|
|
985
|
+
call_relay_topic: string | null;
|
|
986
|
+
/** A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to relay_topic. */
|
|
987
|
+
call_relay_topic_status_callback_url: string | null;
|
|
988
|
+
/** The URL to make a request to when using the relay_script call handler. The URL must respond with a valid SWML script. */
|
|
989
|
+
call_relay_script_url: string | null;
|
|
990
|
+
/** The name of the Relay Context to send this call to when using the relay_context call handler. */
|
|
991
|
+
call_relay_context: string | null;
|
|
992
|
+
/** A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to relay_context. */
|
|
993
|
+
call_relay_context_status_callback_url: string | null;
|
|
994
|
+
/** The name of the Relay Application to send this call to when using the relay_application call handler. */
|
|
995
|
+
call_relay_application: string | null;
|
|
996
|
+
/** The ID of the Relay Connector to send this call to when using the relay_connector call handler. */
|
|
997
|
+
call_relay_connector_id: string | null;
|
|
998
|
+
/** The ID of the Relay SIP Endpoint to send this call to when using the relay_sip_endpoint call handler. */
|
|
999
|
+
call_sip_endpoint_id: uuid | null;
|
|
1000
|
+
/** The name of the Verto Relay Endpoint to send this call to when using the relay_verto_endpoint call handler. */
|
|
1001
|
+
call_verto_resource: string | null;
|
|
1002
|
+
/** The ID of the Video Room to send this call to when using the video_room call handler. */
|
|
1003
|
+
call_video_room_id: uuid | null;
|
|
1004
|
+
/** What type of handler you want to run on inbound messages. */
|
|
1005
|
+
message_handler: PhoneNumberMessageHandler | null;
|
|
1006
|
+
/** The unique identifier of the messaging handler resource. */
|
|
1007
|
+
messaging_handler_resource_id: uuid | null;
|
|
1008
|
+
/** The URL to make a request to when using the laml_webhooks message handler. */
|
|
1009
|
+
message_request_url: string | null;
|
|
1010
|
+
/** The HTTP method to use when making a request to the message_request_url. */
|
|
1011
|
+
message_request_method: HttpMethod | null;
|
|
1012
|
+
/** The fallback URL to make a request to when using the laml_webhooks message handler and the message_request_url fails. */
|
|
1013
|
+
message_fallback_url: string | null;
|
|
1014
|
+
/** The HTTP method to use when making a request to the message_fallback_url. */
|
|
1015
|
+
message_fallback_method: HttpMethod | null;
|
|
1016
|
+
/** The ID of the LaML Application to use when using the laml_application message handler. */
|
|
1017
|
+
message_laml_application_id: string | null;
|
|
1018
|
+
/** The name of the Relay Topic to send this message to when using the relay_topic message handler. */
|
|
1019
|
+
message_relay_topic: string | null;
|
|
1020
|
+
/** The name of the Relay Context to send this message to when using the relay_context message handler. */
|
|
1021
|
+
message_relay_context: string | null;
|
|
1022
|
+
/** The ISO 3166-1 alpha-2 country code of the phone number. */
|
|
1023
|
+
country_code: string | null;
|
|
1024
|
+
}
|
|
1025
|
+
/** Call handler type for phone numbers. */
|
|
1026
|
+
export type PhoneNumberCallHandler = 'relay_context' | 'relay_topic' | 'relay_script' | 'relay_application' | 'relay_connector' | 'relay_sip_endpoint' | 'relay_verto_endpoint' | 'laml_webhooks' | 'laml_application' | 'dialogflow' | 'video_room' | 'call_flow' | 'ai_agent' | 'fabric_subscriber' | 'sip_gateway' | 'call_queue';
|
|
1027
|
+
/** Call handler type for phone number update requests. */
|
|
1028
|
+
export type PhoneNumberCallHandlerRequest = 'relay_context' | 'relay_topic' | 'relay_script' | 'relay_application' | 'relay_connector' | 'relay_sip_endpoint' | 'relay_verto_endpoint' | 'laml_webhooks' | 'laml_application' | 'dialogflow' | 'video_room' | 'ai_agent' | 'call_flow';
|
|
1029
|
+
/** Phone number capabilities. */
|
|
1030
|
+
export interface PhoneNumberCapabilities {
|
|
1031
|
+
/** Whether the phone number can receive voice calls. */
|
|
1032
|
+
voice?: boolean;
|
|
1033
|
+
/** Whether the phone number can send/receive SMS. */
|
|
1034
|
+
sms?: boolean;
|
|
1035
|
+
/** Whether the phone number can send/receive MMS. */
|
|
1036
|
+
mms?: boolean;
|
|
1037
|
+
/** Whether the phone number can send/receive fax. */
|
|
1038
|
+
fax?: boolean;
|
|
1039
|
+
}
|
|
1040
|
+
/** Phone number capability. */
|
|
1041
|
+
export type PhoneNumberCapability = 'voice' | 'sms' | 'mms' | 'fax';
|
|
1042
|
+
/** Response containing a list of phone numbers. */
|
|
1043
|
+
export interface PhoneNumberListResponse {
|
|
1044
|
+
/** Pagination links. */
|
|
1045
|
+
links: PaginationLinks;
|
|
1046
|
+
/** List of phone numbers. */
|
|
1047
|
+
data: PhoneNumber[];
|
|
1048
|
+
}
|
|
1049
|
+
/** Response containing phone number lookup result. */
|
|
1050
|
+
export interface PhoneNumberLookupResponse {
|
|
1051
|
+
/** The Country code associated with the number. */
|
|
1052
|
+
country_code_number?: number;
|
|
1053
|
+
/** Number in the countries national format. */
|
|
1054
|
+
national_number?: string;
|
|
1055
|
+
/** Whether the number supplied is a possible number. */
|
|
1056
|
+
possible_number?: boolean;
|
|
1057
|
+
/** Whether the number supplied is a valid number. */
|
|
1058
|
+
valid_number?: boolean;
|
|
1059
|
+
/** The E164 number formatted in national format. */
|
|
1060
|
+
national_number_formatted?: string;
|
|
1061
|
+
/** The E164 number formatted in international format. */
|
|
1062
|
+
international_number_formatted?: string;
|
|
1063
|
+
/** The number in E164 format. */
|
|
1064
|
+
e164?: string;
|
|
1065
|
+
/** The location of the number based on its area code and NPA. */
|
|
1066
|
+
location?: string;
|
|
1067
|
+
/** The ISO3166 alpha 2 country code associated with the number. */
|
|
1068
|
+
country_code?: string;
|
|
1069
|
+
/** The time zones associated with the number. */
|
|
1070
|
+
timezones?: string[];
|
|
1071
|
+
/** The type of number based on its area code and NPA. */
|
|
1072
|
+
number_type?: string;
|
|
1073
|
+
/** Carrier information. Adding include=carrier to your request will do a live lookup to determine the current carrier information about this number. */
|
|
1074
|
+
carrier?: CarrierLookupInfo;
|
|
1075
|
+
/** Caller ID information. Adding include=cnam to your request will do a live lookup to determine the current caller ID information about this number. */
|
|
1076
|
+
cnam?: CnamInfo;
|
|
1077
|
+
}
|
|
1078
|
+
/** Message handler type for phone numbers. */
|
|
1079
|
+
export type PhoneNumberMessageHandler = 'relay_context' | 'relay_topic' | 'relay_application' | 'laml_webhooks' | 'laml_application';
|
|
1080
|
+
/** Response containing a single phone number. */
|
|
1081
|
+
export interface PhoneNumberResponse {
|
|
1082
|
+
/** The unique identifier of the phone number. */
|
|
1083
|
+
id: uuid;
|
|
1084
|
+
/** The phone number in E.164 format. */
|
|
1085
|
+
number: string;
|
|
1086
|
+
/** The name given to the phone number. Helps to distinguish different phone numbers within your project. */
|
|
1087
|
+
name: string | null;
|
|
1088
|
+
/** A list of communication methods this phone number supports. */
|
|
1089
|
+
capabilities: PhoneNumberCapability[];
|
|
1090
|
+
/** The type of number this is defined as. */
|
|
1091
|
+
number_type: PhoneNumberType;
|
|
1092
|
+
/** The E911 address ID associated with this phone number. */
|
|
1093
|
+
e911_address_id: uuid | null;
|
|
1094
|
+
/** The date the number was added to your project. */
|
|
1095
|
+
created_at: string;
|
|
1096
|
+
/** The date the number was last updated. */
|
|
1097
|
+
updated_at: string;
|
|
1098
|
+
/** The next date the number will be billed for. */
|
|
1099
|
+
next_billed_at: string | null;
|
|
1100
|
+
/** What type of handler you want to run on inbound calls. */
|
|
1101
|
+
call_handler: PhoneNumberCallHandler | null;
|
|
1102
|
+
/** The unique identifier of the calling handler resource. */
|
|
1103
|
+
calling_handler_resource_id: uuid | null;
|
|
1104
|
+
/** How do you want to receive the incoming call. */
|
|
1105
|
+
call_receive_mode: CallReceiveMode;
|
|
1106
|
+
/** The URL to make a request to when using the laml_webhooks call handler. */
|
|
1107
|
+
call_request_url: string | null;
|
|
1108
|
+
/** The HTTP method to use when making a request to the call_request_url. */
|
|
1109
|
+
call_request_method: HttpMethod | null;
|
|
1110
|
+
/** The fallback URL to make a request to when using the laml_webhooks call handler and the call_request_url fails. */
|
|
1111
|
+
call_fallback_url: string | null;
|
|
1112
|
+
/** The HTTP method to use when making a request to the call_fallback_url. */
|
|
1113
|
+
call_fallback_method: HttpMethod | null;
|
|
1114
|
+
/** The URL to make status callbacks to when using the laml_webhooks call handler. */
|
|
1115
|
+
call_status_callback_url: string | null;
|
|
1116
|
+
/** The HTTP method to use when making a request to the call_status_callback_url. */
|
|
1117
|
+
call_status_callback_method: HttpMethod | null;
|
|
1118
|
+
/** The ID of the LaML Application to use when using the laml_application call handler. */
|
|
1119
|
+
call_laml_application_id: string | null;
|
|
1120
|
+
/** The ID of the Dialogflow Agent to start when using the dialogflow call handler. */
|
|
1121
|
+
call_dialogflow_agent_id: string | null;
|
|
1122
|
+
/** A string representing the Relay topic to forward incoming calls to. This is only used (and required) when call_handler is set to relay_topic. */
|
|
1123
|
+
call_relay_topic: string | null;
|
|
1124
|
+
/** A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to relay_topic. */
|
|
1125
|
+
call_relay_topic_status_callback_url: string | null;
|
|
1126
|
+
/** The URL to make a request to when using the relay_script call handler. The URL must respond with a valid SWML script. */
|
|
1127
|
+
call_relay_script_url: string | null;
|
|
1128
|
+
/** The name of the Relay Context to send this call to when using the relay_context call handler. */
|
|
1129
|
+
call_relay_context: string | null;
|
|
1130
|
+
/** A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to relay_context. */
|
|
1131
|
+
call_relay_context_status_callback_url: string | null;
|
|
1132
|
+
/** The name of the Relay Application to send this call to when using the relay_application call handler. */
|
|
1133
|
+
call_relay_application: string | null;
|
|
1134
|
+
/** The ID of the Relay Connector to send this call to when using the relay_connector call handler. */
|
|
1135
|
+
call_relay_connector_id: string | null;
|
|
1136
|
+
/** The ID of the Relay SIP Endpoint to send this call to when using the relay_sip_endpoint call handler. */
|
|
1137
|
+
call_sip_endpoint_id: uuid | null;
|
|
1138
|
+
/** The name of the Verto Relay Endpoint to send this call to when using the relay_verto_endpoint call handler. */
|
|
1139
|
+
call_verto_resource: string | null;
|
|
1140
|
+
/** The ID of the Video Room to send this call to when using the video_room call handler. */
|
|
1141
|
+
call_video_room_id: uuid | null;
|
|
1142
|
+
/** What type of handler you want to run on inbound messages. */
|
|
1143
|
+
message_handler: PhoneNumberMessageHandler | null;
|
|
1144
|
+
/** The unique identifier of the messaging handler resource. */
|
|
1145
|
+
messaging_handler_resource_id: uuid | null;
|
|
1146
|
+
/** The URL to make a request to when using the laml_webhooks message handler. */
|
|
1147
|
+
message_request_url: string | null;
|
|
1148
|
+
/** The HTTP method to use when making a request to the message_request_url. */
|
|
1149
|
+
message_request_method: HttpMethod | null;
|
|
1150
|
+
/** The fallback URL to make a request to when using the laml_webhooks message handler and the message_request_url fails. */
|
|
1151
|
+
message_fallback_url: string | null;
|
|
1152
|
+
/** The HTTP method to use when making a request to the message_fallback_url. */
|
|
1153
|
+
message_fallback_method: HttpMethod | null;
|
|
1154
|
+
/** The ID of the LaML Application to use when using the laml_application message handler. */
|
|
1155
|
+
message_laml_application_id: string | null;
|
|
1156
|
+
/** The name of the Relay Topic to send this message to when using the relay_topic message handler. */
|
|
1157
|
+
message_relay_topic: string | null;
|
|
1158
|
+
/** The name of the Relay Context to send this message to when using the relay_context message handler. */
|
|
1159
|
+
message_relay_context: string | null;
|
|
1160
|
+
/** The ISO 3166-1 alpha-2 country code of the phone number. */
|
|
1161
|
+
country_code: string | null;
|
|
1162
|
+
}
|
|
1163
|
+
/** Phone number type. */
|
|
1164
|
+
export type PhoneNumberType = 'toll-free' | 'longcode';
|
|
1165
|
+
/** Recording from a PSTN call leg. */
|
|
1166
|
+
export interface PstnRecording {
|
|
1167
|
+
/** Unique ID of the recording. */
|
|
1168
|
+
id: uuid;
|
|
1169
|
+
/** Unique ID of the project. */
|
|
1170
|
+
project_id: uuid;
|
|
1171
|
+
/** Date and time when the recording was created. */
|
|
1172
|
+
created_at: string;
|
|
1173
|
+
/** Date and time when the recording was last updated. */
|
|
1174
|
+
updated_at: string;
|
|
1175
|
+
/** Duration of the recording in seconds. */
|
|
1176
|
+
duration_in_seconds: number;
|
|
1177
|
+
/** Error code if the recording failed. */
|
|
1178
|
+
error_code?: string;
|
|
1179
|
+
/** Price of the recording. */
|
|
1180
|
+
price: number;
|
|
1181
|
+
/** Currency unit for the price. */
|
|
1182
|
+
price_unit: string;
|
|
1183
|
+
/** Status of the recording. */
|
|
1184
|
+
status: string;
|
|
1185
|
+
/** URL of the recording file. */
|
|
1186
|
+
url: string;
|
|
1187
|
+
/** Indicates whether the recording is stereo. */
|
|
1188
|
+
stereo: boolean;
|
|
1189
|
+
/** Size of the recording file in bytes. */
|
|
1190
|
+
byte_size?: number;
|
|
1191
|
+
/** Audio track of the recording. */
|
|
1192
|
+
track: string;
|
|
1193
|
+
/** ID of the PSTN leg associated with the recording. */
|
|
1194
|
+
relay_pstn_leg_id: uuid;
|
|
1195
|
+
}
|
|
1196
|
+
/** Request body for purchasing a phone number. */
|
|
1197
|
+
export interface PurchasePhoneNumberRequest {
|
|
1198
|
+
/** The phone number in E164 format. */
|
|
1199
|
+
number: string;
|
|
1200
|
+
}
|
|
1201
|
+
/** Queue model. */
|
|
1202
|
+
export interface Queue {
|
|
1203
|
+
/** The unique identifier of the queue. */
|
|
1204
|
+
id: uuid;
|
|
1205
|
+
/** The project ID associated with this queue. */
|
|
1206
|
+
project_id: uuid;
|
|
1207
|
+
/** The friendly name of the queue. */
|
|
1208
|
+
friendly_name: string;
|
|
1209
|
+
/** The maximum number of callers allowed in the queue. */
|
|
1210
|
+
max_size?: number;
|
|
1211
|
+
/** The current number of callers in the queue. */
|
|
1212
|
+
current_size?: number;
|
|
1213
|
+
/** The average wait time in seconds. */
|
|
1214
|
+
average_wait_time?: number;
|
|
1215
|
+
/** The URL of this queue. */
|
|
1216
|
+
uri?: string;
|
|
1217
|
+
/** Timestamp when the queue was created. */
|
|
1218
|
+
date_created?: string;
|
|
1219
|
+
/** Timestamp when the queue was last updated. */
|
|
1220
|
+
date_updated?: string;
|
|
1221
|
+
}
|
|
1222
|
+
/** Response containing a list of queues. */
|
|
1223
|
+
export interface QueueListResponse {
|
|
1224
|
+
/** Pagination links. */
|
|
1225
|
+
links?: PaginationLinks;
|
|
1226
|
+
/** List of queues. */
|
|
1227
|
+
data?: Queue[];
|
|
1228
|
+
}
|
|
1229
|
+
/** Queue member model. */
|
|
1230
|
+
export interface QueueMember {
|
|
1231
|
+
/** The call ID of the queue member. */
|
|
1232
|
+
call_id: uuid;
|
|
1233
|
+
/** The ID of the project associated with this queue member. */
|
|
1234
|
+
project_id: string;
|
|
1235
|
+
/** The ID of the queue associated with this queue member. */
|
|
1236
|
+
queue_id: string;
|
|
1237
|
+
/** Queue member position in the queue. */
|
|
1238
|
+
position: number;
|
|
1239
|
+
/** The URL of this queue member. */
|
|
1240
|
+
uri: string;
|
|
1241
|
+
/** Wait time in seconds since the member was enqueued. If not yet enqueued, it will be null. */
|
|
1242
|
+
wait_time?: number;
|
|
1243
|
+
/** When the queue member was last enqueued. */
|
|
1244
|
+
date_enqueued?: string;
|
|
1245
|
+
}
|
|
1246
|
+
/** Response containing a list of queue members. */
|
|
1247
|
+
export interface QueueMemberListResponse {
|
|
1248
|
+
/** Pagination links. */
|
|
1249
|
+
links?: PaginationLinks;
|
|
1250
|
+
/** List of queue members. */
|
|
1251
|
+
data?: QueueMember[];
|
|
1252
|
+
}
|
|
1253
|
+
/** Response containing a single queue member. */
|
|
1254
|
+
export interface QueueMemberResponse {
|
|
1255
|
+
/** The call ID of the queue member. */
|
|
1256
|
+
call_id: uuid;
|
|
1257
|
+
/** The ID of the project associated with this queue member. */
|
|
1258
|
+
project_id: string;
|
|
1259
|
+
/** The ID of the queue associated with this queue member. */
|
|
1260
|
+
queue_id: string;
|
|
1261
|
+
/** Queue member position in the queue. */
|
|
1262
|
+
position: number;
|
|
1263
|
+
/** The URL of this queue member. */
|
|
1264
|
+
uri: string;
|
|
1265
|
+
/** Wait time in seconds since the member was enqueued. If not yet enqueued, it will be null. */
|
|
1266
|
+
wait_time?: number;
|
|
1267
|
+
/** When the queue member was last enqueued. */
|
|
1268
|
+
date_enqueued?: string;
|
|
1269
|
+
}
|
|
1270
|
+
/** Response containing a single queue. */
|
|
1271
|
+
export interface QueueResponse {
|
|
1272
|
+
/** The unique identifier of the queue. */
|
|
1273
|
+
id: uuid;
|
|
1274
|
+
/** The project ID associated with this queue. */
|
|
1275
|
+
project_id: uuid;
|
|
1276
|
+
/** The friendly name of the queue. */
|
|
1277
|
+
friendly_name: string;
|
|
1278
|
+
/** The maximum number of callers allowed in the queue. */
|
|
1279
|
+
max_size?: number;
|
|
1280
|
+
/** The current number of callers in the queue. */
|
|
1281
|
+
current_size?: number;
|
|
1282
|
+
/** The average wait time in seconds. */
|
|
1283
|
+
average_wait_time?: number;
|
|
1284
|
+
/** The URL of this queue. */
|
|
1285
|
+
uri?: string;
|
|
1286
|
+
/** Timestamp when the queue was created. */
|
|
1287
|
+
date_created?: string;
|
|
1288
|
+
/** Timestamp when the queue was last updated. */
|
|
1289
|
+
date_updated?: string;
|
|
1290
|
+
}
|
|
1291
|
+
/** Recording model. A recording is associated with exactly one call leg type (PSTN, SIP, or WebRTC). */
|
|
1292
|
+
export type Recording = PstnRecording | SipRecording | WebRtcRecording;
|
|
1293
|
+
/** Response containing a list of recordings. */
|
|
1294
|
+
export interface RecordingListResponse {
|
|
1295
|
+
/** Pagination links. */
|
|
1296
|
+
links: PaginationLinks;
|
|
1297
|
+
/** List of recordings. */
|
|
1298
|
+
data: Recording[];
|
|
1299
|
+
}
|
|
1300
|
+
/** Short code model. */
|
|
1301
|
+
export interface ShortCode {
|
|
1302
|
+
/** The unique identifier of the short code. */
|
|
1303
|
+
id: uuid;
|
|
1304
|
+
/** The name given to the short code. */
|
|
1305
|
+
name: string | null;
|
|
1306
|
+
/** The short code number. */
|
|
1307
|
+
number: string;
|
|
1308
|
+
/** The messaging capabilities of the short code. */
|
|
1309
|
+
capabilities: ShortCodeCapability[];
|
|
1310
|
+
/** The type of number (always 'shortcode'). */
|
|
1311
|
+
number_type: 'shortcode';
|
|
1312
|
+
/** The type of short code. */
|
|
1313
|
+
code_type: ShortCodeType;
|
|
1314
|
+
/** The ISO 3166-1 alpha-2 country code. */
|
|
1315
|
+
country_code: string;
|
|
1316
|
+
/** The date and time when the short code was created. */
|
|
1317
|
+
created_at: string;
|
|
1318
|
+
/** The date and time when the short code was last updated. */
|
|
1319
|
+
updated_at: string;
|
|
1320
|
+
/** The date and time when the short code will next be billed. */
|
|
1321
|
+
next_billed_at: string | null;
|
|
1322
|
+
/** The lease duration of the short code (e.g., '12 months'). */
|
|
1323
|
+
lease_duration: string | null;
|
|
1324
|
+
/** The message handler type for incoming messages. */
|
|
1325
|
+
message_handler: ShortCodeMessageHandler | null;
|
|
1326
|
+
/** The URL to send message requests to when using laml_webhooks handler. */
|
|
1327
|
+
message_request_url: string | null;
|
|
1328
|
+
/** The HTTP method to use for message requests. */
|
|
1329
|
+
message_request_method: HttpMethod | null;
|
|
1330
|
+
/** The fallback URL for message requests. */
|
|
1331
|
+
message_fallback_url: string | null;
|
|
1332
|
+
/** The HTTP method to use for fallback requests. */
|
|
1333
|
+
message_fallback_method: HttpMethod | null;
|
|
1334
|
+
/** The ID of the LāML application to handle messages when using laml_application handler. */
|
|
1335
|
+
message_laml_application_id: uuid | null;
|
|
1336
|
+
/** The Relay context to use when using relay_context handler. */
|
|
1337
|
+
message_relay_context: string | null;
|
|
1338
|
+
}
|
|
1339
|
+
/** Short code capabilities. */
|
|
1340
|
+
export type ShortCodeCapability = 'sms' | 'mms';
|
|
1341
|
+
/** Response containing a list of short codes. */
|
|
1342
|
+
export interface ShortCodeListResponse {
|
|
1343
|
+
/** Pagination links. */
|
|
1344
|
+
links: PaginationLinks;
|
|
1345
|
+
/** List of short codes. */
|
|
1346
|
+
data: ShortCode[];
|
|
1347
|
+
}
|
|
1348
|
+
/** Message handler type for short codes. */
|
|
1349
|
+
export type ShortCodeMessageHandler = 'relay_context' | 'laml_webhooks' | 'laml_application';
|
|
1350
|
+
/** Response containing a single short code. */
|
|
1351
|
+
export interface ShortCodeResponse {
|
|
1352
|
+
/** The unique identifier of the short code. */
|
|
1353
|
+
id: uuid;
|
|
1354
|
+
/** The name given to the short code. */
|
|
1355
|
+
name: string | null;
|
|
1356
|
+
/** The short code number. */
|
|
1357
|
+
number: string;
|
|
1358
|
+
/** The messaging capabilities of the short code. */
|
|
1359
|
+
capabilities: ShortCodeCapability[];
|
|
1360
|
+
/** The type of number (always 'shortcode'). */
|
|
1361
|
+
number_type: 'shortcode';
|
|
1362
|
+
/** The type of short code. */
|
|
1363
|
+
code_type: ShortCodeType;
|
|
1364
|
+
/** The ISO 3166-1 alpha-2 country code. */
|
|
1365
|
+
country_code: string;
|
|
1366
|
+
/** The date and time when the short code was created. */
|
|
1367
|
+
created_at: string;
|
|
1368
|
+
/** The date and time when the short code was last updated. */
|
|
1369
|
+
updated_at: string;
|
|
1370
|
+
/** The date and time when the short code will next be billed. */
|
|
1371
|
+
next_billed_at: string | null;
|
|
1372
|
+
/** The lease duration of the short code (e.g., '12 months'). */
|
|
1373
|
+
lease_duration: string | null;
|
|
1374
|
+
/** The message handler type for incoming messages. */
|
|
1375
|
+
message_handler: ShortCodeMessageHandler | null;
|
|
1376
|
+
/** The URL to send message requests to when using laml_webhooks handler. */
|
|
1377
|
+
message_request_url: string | null;
|
|
1378
|
+
/** The HTTP method to use for message requests. */
|
|
1379
|
+
message_request_method: HttpMethod | null;
|
|
1380
|
+
/** The fallback URL for message requests. */
|
|
1381
|
+
message_fallback_url: string | null;
|
|
1382
|
+
/** The HTTP method to use for fallback requests. */
|
|
1383
|
+
message_fallback_method: HttpMethod | null;
|
|
1384
|
+
/** The ID of the LāML application to handle messages when using laml_application handler. */
|
|
1385
|
+
message_laml_application_id: uuid | null;
|
|
1386
|
+
/** The Relay context to use when using relay_context handler. */
|
|
1387
|
+
message_relay_context: string | null;
|
|
1388
|
+
}
|
|
1389
|
+
/** Short code type. */
|
|
1390
|
+
export type ShortCodeType = 'vanity' | 'random';
|
|
1391
|
+
/** SIP endpoint model. */
|
|
1392
|
+
export interface SipEndpoint {
|
|
1393
|
+
/** A string representation of the type of object this record is. */
|
|
1394
|
+
type: string;
|
|
1395
|
+
/** The unique identifier of the SIP endpoint. */
|
|
1396
|
+
id: uuid;
|
|
1397
|
+
/** The username for the SIP endpoint. */
|
|
1398
|
+
username: string;
|
|
1399
|
+
/** Friendly Caller ID used as the CNAM when dialing a phone number or the From when dialing another SIP Endpoint. */
|
|
1400
|
+
caller_id: string | null;
|
|
1401
|
+
/** When dialing a PSTN phone number, you must send it From a number you have purchased or verified. send_as indicates which number this endpoint has set as its origination. random indicates it will randomly choose a purchased or verified number from within the project. */
|
|
1402
|
+
send_as: string;
|
|
1403
|
+
/** A list of encryption ciphers this endpoint will support. */
|
|
1404
|
+
ciphers: string[];
|
|
1405
|
+
/** A list of codecs this endpoint will support. */
|
|
1406
|
+
codecs: string[];
|
|
1407
|
+
/** Whether connections to this endpoint require encryption or if encryption is optional. */
|
|
1408
|
+
encryption: 'default' | 'required' | 'optional';
|
|
1409
|
+
/** What type of handler you want to run on inbound calls. */
|
|
1410
|
+
call_handler: SipEndpointCallHandler | null;
|
|
1411
|
+
/** The unique identifier of the calling handler resource. */
|
|
1412
|
+
calling_handler_resource_id: uuid | null;
|
|
1413
|
+
/** A string representing the LaML URL to access when a call is received. This is only used (and required) when call_handler is set to laml_webhooks. */
|
|
1414
|
+
call_request_url: string | null;
|
|
1415
|
+
/** A string representing the HTTP method to use with call_request_url. Valid values are GET and POST. */
|
|
1416
|
+
call_request_method: 'GET' | 'POST' | null;
|
|
1417
|
+
/** A string representing the LaML URL to access when the call to call_request_url fails. This is only used (and required) when call_handler is set to laml_webhooks. */
|
|
1418
|
+
call_fallback_url: string | null;
|
|
1419
|
+
/** A string representing the HTTP method to use with call_fallback_url. Valid values are GET and POST. */
|
|
1420
|
+
call_fallback_method: 'GET' | 'POST' | null;
|
|
1421
|
+
/** A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to laml_webhooks. */
|
|
1422
|
+
call_status_callback_url: string | null;
|
|
1423
|
+
/** A string representing the HTTP method to use with call_status_callback_url. Valid values are GET and POST. */
|
|
1424
|
+
call_status_callback_method: 'GET' | 'POST' | null;
|
|
1425
|
+
/** A string representing the ID of the LaML application to forward incoming calls to. This is only used (and required) when call_handler is set to laml_application. */
|
|
1426
|
+
call_laml_application_id: string | null;
|
|
1427
|
+
/** A string representing the ID of the Dialogflow agent to forward incoming calls to. This is only used (and required) when call_handler is set to dialogflow. */
|
|
1428
|
+
call_dialogflow_agent_id: string | null;
|
|
1429
|
+
/** A string representing the Relay topic to forward incoming calls to. This is only used (and required) when call_handler is set to relay_topic. */
|
|
1430
|
+
call_relay_topic: string | null;
|
|
1431
|
+
/** A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to relay_topic. */
|
|
1432
|
+
call_relay_topic_status_callback_url: string | null;
|
|
1433
|
+
/** A string representing the Relay context to forward incoming calls to. This is only used (and required) when call_handler is set to relay_context. */
|
|
1434
|
+
call_relay_context: string | null;
|
|
1435
|
+
/** A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to relay_context. */
|
|
1436
|
+
call_relay_context_status_callback_url: string | null;
|
|
1437
|
+
/** A string representing the Relay application to forward incoming calls to. This is only used (and required) when call_handler is set to relay_application. */
|
|
1438
|
+
call_relay_application: string | null;
|
|
1439
|
+
/** A string representing the ID of the Video Room to forward incoming calls to. This is only used (and required) when call_handler is set to video_room. */
|
|
1440
|
+
call_video_room_id: uuid | null;
|
|
1441
|
+
/** A string representing a URL of a SWML script to respond to incoming calls. This is only used (and required) when call_handler is set to relay_script. */
|
|
1442
|
+
call_relay_script_url: string | null;
|
|
1443
|
+
}
|
|
1444
|
+
/** Call handler type for SIP endpoints. */
|
|
1445
|
+
export type SipEndpointCallHandler = 'relay_context' | 'relay_topic' | 'relay_application' | 'relay_connector' | 'relay_script' | 'laml_webhooks' | 'laml_application' | 'dialogflow' | 'video_room' | 'call_flow' | 'ai_agent';
|
|
1446
|
+
/** Response containing a list of SIP endpoints. */
|
|
1447
|
+
export interface SipEndpointListResponse {
|
|
1448
|
+
/** Pagination links. */
|
|
1449
|
+
links: PaginationLinks;
|
|
1450
|
+
/** List of SIP endpoints. */
|
|
1451
|
+
data: SipEndpoint[];
|
|
1452
|
+
}
|
|
1453
|
+
/** Response containing a single SIP endpoint. */
|
|
1454
|
+
export interface SipEndpointResponse {
|
|
1455
|
+
/** A string representation of the type of object this record is. */
|
|
1456
|
+
type: string;
|
|
1457
|
+
/** The unique identifier of the SIP endpoint. */
|
|
1458
|
+
id: uuid;
|
|
1459
|
+
/** The username for the SIP endpoint. */
|
|
1460
|
+
username: string;
|
|
1461
|
+
/** Friendly Caller ID used as the CNAM when dialing a phone number or the From when dialing another SIP Endpoint. */
|
|
1462
|
+
caller_id: string | null;
|
|
1463
|
+
/** When dialing a PSTN phone number, you must send it From a number you have purchased or verified. send_as indicates which number this endpoint has set as its origination. random indicates it will randomly choose a purchased or verified number from within the project. */
|
|
1464
|
+
send_as: string;
|
|
1465
|
+
/** A list of encryption ciphers this endpoint will support. */
|
|
1466
|
+
ciphers: string[];
|
|
1467
|
+
/** A list of codecs this endpoint will support. */
|
|
1468
|
+
codecs: string[];
|
|
1469
|
+
/** Whether connections to this endpoint require encryption or if encryption is optional. */
|
|
1470
|
+
encryption: 'default' | 'required' | 'optional';
|
|
1471
|
+
/** What type of handler you want to run on inbound calls. */
|
|
1472
|
+
call_handler: SipEndpointCallHandler | null;
|
|
1473
|
+
/** The unique identifier of the calling handler resource. */
|
|
1474
|
+
calling_handler_resource_id: uuid | null;
|
|
1475
|
+
/** A string representing the LaML URL to access when a call is received. This is only used (and required) when call_handler is set to laml_webhooks. */
|
|
1476
|
+
call_request_url: string | null;
|
|
1477
|
+
/** A string representing the HTTP method to use with call_request_url. Valid values are GET and POST. */
|
|
1478
|
+
call_request_method: 'GET' | 'POST' | null;
|
|
1479
|
+
/** A string representing the LaML URL to access when the call to call_request_url fails. This is only used (and required) when call_handler is set to laml_webhooks. */
|
|
1480
|
+
call_fallback_url: string | null;
|
|
1481
|
+
/** A string representing the HTTP method to use with call_fallback_url. Valid values are GET and POST. */
|
|
1482
|
+
call_fallback_method: 'GET' | 'POST' | null;
|
|
1483
|
+
/** A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to laml_webhooks. */
|
|
1484
|
+
call_status_callback_url: string | null;
|
|
1485
|
+
/** A string representing the HTTP method to use with call_status_callback_url. Valid values are GET and POST. */
|
|
1486
|
+
call_status_callback_method: 'GET' | 'POST' | null;
|
|
1487
|
+
/** A string representing the ID of the LaML application to forward incoming calls to. This is only used (and required) when call_handler is set to laml_application. */
|
|
1488
|
+
call_laml_application_id: string | null;
|
|
1489
|
+
/** A string representing the ID of the Dialogflow agent to forward incoming calls to. This is only used (and required) when call_handler is set to dialogflow. */
|
|
1490
|
+
call_dialogflow_agent_id: string | null;
|
|
1491
|
+
/** A string representing the Relay topic to forward incoming calls to. This is only used (and required) when call_handler is set to relay_topic. */
|
|
1492
|
+
call_relay_topic: string | null;
|
|
1493
|
+
/** A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to relay_topic. */
|
|
1494
|
+
call_relay_topic_status_callback_url: string | null;
|
|
1495
|
+
/** A string representing the Relay context to forward incoming calls to. This is only used (and required) when call_handler is set to relay_context. */
|
|
1496
|
+
call_relay_context: string | null;
|
|
1497
|
+
/** A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to relay_context. */
|
|
1498
|
+
call_relay_context_status_callback_url: string | null;
|
|
1499
|
+
/** A string representing the Relay application to forward incoming calls to. This is only used (and required) when call_handler is set to relay_application. */
|
|
1500
|
+
call_relay_application: string | null;
|
|
1501
|
+
/** A string representing the ID of the Video Room to forward incoming calls to. This is only used (and required) when call_handler is set to video_room. */
|
|
1502
|
+
call_video_room_id: uuid | null;
|
|
1503
|
+
/** A string representing a URL of a SWML script to respond to incoming calls. This is only used (and required) when call_handler is set to relay_script. */
|
|
1504
|
+
call_relay_script_url: string | null;
|
|
1505
|
+
}
|
|
1506
|
+
/** Response containing the SIP profile. */
|
|
1507
|
+
export interface SipProfileResponse {
|
|
1508
|
+
/** A string representation of the fully qualified domain name for this profile. */
|
|
1509
|
+
domain?: string;
|
|
1510
|
+
/** String representing the domain_identifier portion of the profile. Must be unique across your project. */
|
|
1511
|
+
domain_identifier?: string;
|
|
1512
|
+
/** A list of codecs this profile will support. Currently supported values are: OPUS, G722, PCMU, PCMA, VP8, H264. */
|
|
1513
|
+
default_codecs?: string[];
|
|
1514
|
+
/** A list of encryption ciphers this profile will support. Currently supported values are: AEAD_AES_256_GCM_8, AES_256_CM_HMAC_SHA1_80, AES_CM_128_HMAC_SHA1_80, AES_256_CM_HMAC_SHA1_32, AES_CM_128_HMAC_SHA1_32. */
|
|
1515
|
+
default_ciphers?: string[];
|
|
1516
|
+
/** A string representing whether connections to an endpoint that uses this profile require encryption or if encryption is optional. Encryption will always be used if possible. Possible values are required or optional. */
|
|
1517
|
+
default_encryption?: 'required' | 'optional';
|
|
1518
|
+
/** The e164 formatted number you wish to set as the originating number when dialing PSTN phone numbers from a SIP Endpoint that uses this profile. Specify null or an empty string to randomly choose a purchased or verified number from within the project. */
|
|
1519
|
+
default_send_as?: string;
|
|
1520
|
+
}
|
|
1521
|
+
/** Recording from a SIP call leg. */
|
|
1522
|
+
export interface SipRecording {
|
|
1523
|
+
/** Unique ID of the recording. */
|
|
1524
|
+
id: uuid;
|
|
1525
|
+
/** Unique ID of the project. */
|
|
1526
|
+
project_id: uuid;
|
|
1527
|
+
/** Date and time when the recording was created. */
|
|
1528
|
+
created_at: string;
|
|
1529
|
+
/** Date and time when the recording was last updated. */
|
|
1530
|
+
updated_at: string;
|
|
1531
|
+
/** Duration of the recording in seconds. */
|
|
1532
|
+
duration_in_seconds: number;
|
|
1533
|
+
/** Error code if the recording failed. */
|
|
1534
|
+
error_code?: string;
|
|
1535
|
+
/** Price of the recording. */
|
|
1536
|
+
price: number;
|
|
1537
|
+
/** Currency unit for the price. */
|
|
1538
|
+
price_unit: string;
|
|
1539
|
+
/** Status of the recording. */
|
|
1540
|
+
status: string;
|
|
1541
|
+
/** URL of the recording file. */
|
|
1542
|
+
url: string;
|
|
1543
|
+
/** Indicates whether the recording is stereo. */
|
|
1544
|
+
stereo: boolean;
|
|
1545
|
+
/** Size of the recording file in bytes. */
|
|
1546
|
+
byte_size?: number;
|
|
1547
|
+
/** Audio track of the recording. */
|
|
1548
|
+
track: string;
|
|
1549
|
+
/** ID of the SIP leg associated with the recording. */
|
|
1550
|
+
relay_sip_leg_id: uuid;
|
|
1551
|
+
}
|
|
1552
|
+
/** Details about a specific validation error. */
|
|
1553
|
+
export interface Types_StatusCodes_SpaceApiErrorItem {
|
|
1554
|
+
/** A description of what caused the error. */
|
|
1555
|
+
detail: string;
|
|
1556
|
+
/** The HTTP status code. */
|
|
1557
|
+
status: string;
|
|
1558
|
+
/** A short summary of the error type. */
|
|
1559
|
+
title: string;
|
|
1560
|
+
/** The error code. */
|
|
1561
|
+
code: string;
|
|
1562
|
+
}
|
|
1563
|
+
/** The request is invalid. */
|
|
1564
|
+
export interface Types_StatusCodes_StatusCode400 {
|
|
1565
|
+
error: 'Bad Request';
|
|
1566
|
+
}
|
|
1567
|
+
/** Access is unauthorized. */
|
|
1568
|
+
export interface Types_StatusCodes_StatusCode401 {
|
|
1569
|
+
error: 'Unauthorized';
|
|
1570
|
+
}
|
|
1571
|
+
/** The server cannot find the requested resource. */
|
|
1572
|
+
export interface Types_StatusCodes_StatusCode404 {
|
|
1573
|
+
error: 'Not Found';
|
|
1574
|
+
}
|
|
1575
|
+
/** An internal server error occurred. */
|
|
1576
|
+
export interface Types_StatusCodes_StatusCode500 {
|
|
1577
|
+
error: 'Internal Server Error';
|
|
1578
|
+
}
|
|
1579
|
+
/** The request failed validation. See errors for details. */
|
|
1580
|
+
export interface Types_StatusCodes_ValidationError {
|
|
1581
|
+
/** List of validation errors. */
|
|
1582
|
+
errors: Types_StatusCodes_SpaceApiErrorItem[];
|
|
1583
|
+
}
|
|
1584
|
+
/** Request body for updating a campaign. */
|
|
1585
|
+
export interface UpdateCampaignRequest {
|
|
1586
|
+
/** A name for the campaign. */
|
|
1587
|
+
name?: string;
|
|
1588
|
+
}
|
|
1589
|
+
/** Request body for updating a domain application. */
|
|
1590
|
+
export interface UpdateDomainApplicationRequest {
|
|
1591
|
+
/** A string representing the friendly name for this domain application. */
|
|
1592
|
+
name?: string;
|
|
1593
|
+
/** A string representing the identifier portion of the domain application. */
|
|
1594
|
+
identifier?: string;
|
|
1595
|
+
/** A string representing the user portion of the domain application. */
|
|
1596
|
+
user?: string;
|
|
1597
|
+
/** Whether the domain application will enforce IP authentication for incoming requests. */
|
|
1598
|
+
ip_auth_enabled?: boolean;
|
|
1599
|
+
/** A list containing whitelisted IP addresses and IP blocks used if ip_auth_enabled is true. */
|
|
1600
|
+
ip_auth?: string[];
|
|
1601
|
+
/** Whether connections to this domain application require encryption or if encryption is optional. */
|
|
1602
|
+
encryption?: 'optional' | 'required' | 'forbidden';
|
|
1603
|
+
/** A list of codecs this domain application will support. */
|
|
1604
|
+
codecs?: string[];
|
|
1605
|
+
/** A list of encryption ciphers this domain application will support. */
|
|
1606
|
+
ciphers?: string[];
|
|
1607
|
+
/** Specify how the domain application will handle calls. */
|
|
1608
|
+
call_handler?: DomainAppCallHandlerRequest;
|
|
1609
|
+
/** A string representing the Relay topic to forward incoming calls to. */
|
|
1610
|
+
call_relay_topic?: string;
|
|
1611
|
+
/** A string representing a URL to send status change messages to. */
|
|
1612
|
+
call_relay_topic_status_callback_url?: string;
|
|
1613
|
+
/** A string representing the Relay Application to forward incoming calls to. */
|
|
1614
|
+
call_relay_application?: string;
|
|
1615
|
+
/** A string representing the LaML URL to access when a call is received. */
|
|
1616
|
+
call_request_url?: string;
|
|
1617
|
+
/** A string representing the HTTP method to use with call_request_url. */
|
|
1618
|
+
call_request_method?: 'GET' | 'POST';
|
|
1619
|
+
/** A string representing the LaML URL to access when the call to call_request_url fails. */
|
|
1620
|
+
call_fallback_url?: string;
|
|
1621
|
+
/** A string representing the HTTP method to use with call_fallback_url. */
|
|
1622
|
+
call_fallback_method?: 'GET' | 'POST';
|
|
1623
|
+
/** A string representing a URL to send status change messages to. */
|
|
1624
|
+
call_status_callback_url?: string;
|
|
1625
|
+
/** A string representing the HTTP method to use with call_status_callback_url. */
|
|
1626
|
+
call_status_callback_method?: 'GET' | 'POST';
|
|
1627
|
+
/** A string representing the ID of the LaML application to forward incoming calls to. */
|
|
1628
|
+
call_laml_application_id?: string;
|
|
1629
|
+
/** A string representing the ID of the Video Room to forward incoming calls to. */
|
|
1630
|
+
call_video_room_id?: uuid;
|
|
1631
|
+
/** A string representing the URL of the Relay script to execute when a call is received. */
|
|
1632
|
+
call_relay_script_url?: string;
|
|
1633
|
+
/** A string representing the ID of the Dialogflow Agent to forward incoming calls to. */
|
|
1634
|
+
call_dialogflow_agent_id?: uuid;
|
|
1635
|
+
/** A string representing the ID of the AI Agent to forward incoming calls to. */
|
|
1636
|
+
call_ai_agent_id?: uuid;
|
|
1637
|
+
/** A string representing the ID of the Call Flow to forward incoming calls to. */
|
|
1638
|
+
call_flow_id?: uuid;
|
|
1639
|
+
/** A string representing the version of your Call Flow you'd like to use. */
|
|
1640
|
+
call_flow_version?: 'working_copy' | 'current_deployed';
|
|
1641
|
+
/** This handler type is deprecated. Please use call_relay_application or call_relay_topic instead. */
|
|
1642
|
+
call_relay_context?: string;
|
|
1643
|
+
/** This property is deprecated. Please use call_relay_topic_status_callback_url instead. */
|
|
1644
|
+
call_relay_context_status_callback_url?: string;
|
|
1645
|
+
}
|
|
1646
|
+
/** Request body for updating a number group. */
|
|
1647
|
+
export interface UpdateNumberGroupRequest {
|
|
1648
|
+
/** The name given to the number group. Helps to distinguish different groups within your project. */
|
|
1649
|
+
name: string;
|
|
1650
|
+
/** Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one. */
|
|
1651
|
+
sticky_sender?: boolean;
|
|
1652
|
+
}
|
|
1653
|
+
/** Request body for updating a phone number. */
|
|
1654
|
+
export interface UpdatePhoneNumberRequest {
|
|
1655
|
+
/** The friendly name for the phone number. */
|
|
1656
|
+
name?: string;
|
|
1657
|
+
/** The call handler for the phone number. */
|
|
1658
|
+
call_handler?: PhoneNumberCallHandlerRequest;
|
|
1659
|
+
/** The call receive mode for the phone number. */
|
|
1660
|
+
call_receive_mode?: string;
|
|
1661
|
+
/** The call request URL for the phone number. */
|
|
1662
|
+
call_request_url?: string;
|
|
1663
|
+
/** The call request method for the phone number. */
|
|
1664
|
+
call_request_method?: 'GET' | 'POST';
|
|
1665
|
+
/** The call fallback URL for the phone number. */
|
|
1666
|
+
call_fallback_url?: string;
|
|
1667
|
+
/** The call fallback method for the phone number. */
|
|
1668
|
+
call_fallback_method?: 'GET' | 'POST';
|
|
1669
|
+
/** The call status callback URL for the phone number. */
|
|
1670
|
+
call_status_callback_url?: string;
|
|
1671
|
+
/** The call status callback method for the phone number. */
|
|
1672
|
+
call_status_callback_method?: 'GET' | 'POST';
|
|
1673
|
+
/** The ID of the LaML Application to use when using the laml_application call handler. */
|
|
1674
|
+
call_laml_application_id?: string;
|
|
1675
|
+
/** The ID of the Dialogflow Agent to start when using the dialogflow call handler. */
|
|
1676
|
+
call_dialogflow_agent_id?: string;
|
|
1677
|
+
/** A string representing the Relay topic to forward incoming calls to. */
|
|
1678
|
+
call_relay_topic?: string;
|
|
1679
|
+
/** A string representing a URL to send status change messages to when call_handler is set to relay_topic. */
|
|
1680
|
+
call_relay_topic_status_callback_url?: string;
|
|
1681
|
+
/** The URL to make a request to when using the relay_script call handler. */
|
|
1682
|
+
call_relay_script_url?: string;
|
|
1683
|
+
/** This handler type is deprecated. Please use call_relay_application or call_relay_topic instead. */
|
|
1684
|
+
call_relay_context?: string;
|
|
1685
|
+
/** This property is deprecated. Please use call_relay_topic_status_callback_url instead. */
|
|
1686
|
+
call_relay_context_status_callback_url?: string;
|
|
1687
|
+
/** A string representing the Relay Application to forward incoming calls to. */
|
|
1688
|
+
call_relay_application?: string;
|
|
1689
|
+
/** The ID of the Relay Connector to use when using the relay_connector call handler. */
|
|
1690
|
+
call_relay_connector_id?: string;
|
|
1691
|
+
/** The ID of the SIP Endpoint to use when using the relay_sip_endpoint call handler. */
|
|
1692
|
+
call_sip_endpoint_id?: string;
|
|
1693
|
+
/** The Verto resource to use when using the relay_verto_endpoint call handler. */
|
|
1694
|
+
call_verto_resource?: string;
|
|
1695
|
+
/** The ID of the Video Room to forward incoming calls to when using the video_room call handler. */
|
|
1696
|
+
call_video_room_id?: uuid;
|
|
1697
|
+
/** The ID of the AI Agent to forward incoming calls to when using the ai_agent call handler. */
|
|
1698
|
+
call_ai_agent_id?: uuid;
|
|
1699
|
+
/** The ID of the Call Flow to forward incoming calls to when using the call_flow call handler. */
|
|
1700
|
+
call_flow_id?: uuid;
|
|
1701
|
+
/** The Call Flow version to use when using the call_flow call handler. */
|
|
1702
|
+
call_flow_version?: 'working_copy' | 'current_deployed';
|
|
1703
|
+
/** The message handler for the phone number. */
|
|
1704
|
+
message_handler?: PhoneNumberMessageHandler;
|
|
1705
|
+
/** The message request URL for the phone number. */
|
|
1706
|
+
message_request_url?: string;
|
|
1707
|
+
/** The message request method for the phone number. */
|
|
1708
|
+
message_request_method?: 'GET' | 'POST';
|
|
1709
|
+
/** The message fallback URL for the phone number. */
|
|
1710
|
+
message_fallback_url?: string;
|
|
1711
|
+
/** The message fallback method for the phone number. */
|
|
1712
|
+
message_fallback_method?: 'GET' | 'POST';
|
|
1713
|
+
/** The ID of the LaML Application to use for messages. */
|
|
1714
|
+
message_laml_application_id?: string;
|
|
1715
|
+
/** A string representing the Relay topic to forward incoming messages to. */
|
|
1716
|
+
message_relay_topic?: string;
|
|
1717
|
+
/** This handler type is deprecated. Please use message_relay_application or message_relay_topic instead. */
|
|
1718
|
+
message_relay_context?: string;
|
|
1719
|
+
/** A string representing the Relay Application to forward incoming messages to. */
|
|
1720
|
+
message_relay_application?: string;
|
|
1721
|
+
}
|
|
1722
|
+
/** Request body for updating a queue. */
|
|
1723
|
+
export interface UpdateQueueRequest {
|
|
1724
|
+
/** The name of the queue. */
|
|
1725
|
+
name?: string;
|
|
1726
|
+
/** The maximum number of callers allowed in the queue. */
|
|
1727
|
+
max_size?: number;
|
|
1728
|
+
}
|
|
1729
|
+
/** Request body for updating a short code. */
|
|
1730
|
+
export interface UpdateShortCodeRequest {
|
|
1731
|
+
/** The name given to the short code. */
|
|
1732
|
+
name: string;
|
|
1733
|
+
/** The message handler type for incoming messages. */
|
|
1734
|
+
message_handler: ShortCodeMessageHandler;
|
|
1735
|
+
/** The URL to send message requests to when using laml_webhooks handler. */
|
|
1736
|
+
message_request_url?: string;
|
|
1737
|
+
/** The HTTP method to use for message requests. Defaults to POST. */
|
|
1738
|
+
message_request_method?: HttpMethod;
|
|
1739
|
+
/** The fallback URL for message requests. */
|
|
1740
|
+
message_fallback_url?: string;
|
|
1741
|
+
/** The HTTP method to use for fallback requests. Defaults to POST. */
|
|
1742
|
+
message_fallback_method?: HttpMethod;
|
|
1743
|
+
/** The ID of the LāML application to handle messages when using laml_application handler. */
|
|
1744
|
+
message_laml_application_id?: uuid;
|
|
1745
|
+
/** The Relay context to use when using relay_context handler. */
|
|
1746
|
+
message_relay_context?: string;
|
|
1747
|
+
}
|
|
1748
|
+
/** Request body for updating a SIP endpoint. */
|
|
1749
|
+
export interface UpdateSipEndpointRequest {
|
|
1750
|
+
/** String representing the username portion of the endpoint. Must be unique across your project and must not contain white space characters or @. */
|
|
1751
|
+
username?: string;
|
|
1752
|
+
/** A password to authenticate registrations to this endpoint. */
|
|
1753
|
+
password?: string;
|
|
1754
|
+
/** Friendly Caller ID used as the CNAM when dialing a phone number or the From when dialing another SIP Endpoint. */
|
|
1755
|
+
caller_id?: string;
|
|
1756
|
+
/** When dialing a PSTN phone number, you must send it From a number you have purchased or verified. send_as indicates which number this endpoint has set as its origination. random indicates it will randomly choose a purchased or verified number from within the project. */
|
|
1757
|
+
send_as?: string;
|
|
1758
|
+
/** A list of encryption ciphers this endpoint will support. */
|
|
1759
|
+
ciphers?: string[];
|
|
1760
|
+
/** A list of codecs this endpoint will support. */
|
|
1761
|
+
codecs?: string[];
|
|
1762
|
+
/** Specifies the encryption requirements for connections to this endpoint. */
|
|
1763
|
+
encryption?: 'default' | 'required' | 'optional';
|
|
1764
|
+
/** What type of handler you want to run on inbound calls. */
|
|
1765
|
+
call_handler?: 'relay_context' | 'relay_topic' | 'relay_application' | 'relay_connector' | 'relay_script' | 'laml_webhooks' | 'laml_application' | 'dialogflow' | 'video_room' | 'call_flow' | 'ai_agent';
|
|
1766
|
+
/** The LaML URL to access when a call is received. Required when call_handler is laml_webhooks. */
|
|
1767
|
+
call_request_url?: string;
|
|
1768
|
+
/** The HTTP method to use with call_request_url. */
|
|
1769
|
+
call_request_method?: 'GET' | 'POST';
|
|
1770
|
+
/** The LaML URL to access when the call to call_request_url fails. Required when call_handler is laml_webhooks. */
|
|
1771
|
+
call_fallback_url?: string;
|
|
1772
|
+
/** The HTTP method to use with call_fallback_url. */
|
|
1773
|
+
call_fallback_method?: 'GET' | 'POST';
|
|
1774
|
+
/** A URL to send status change messages to. Required when call_handler is laml_webhooks. */
|
|
1775
|
+
call_status_callback_url?: string;
|
|
1776
|
+
/** The HTTP method to use with call_status_callback_url. */
|
|
1777
|
+
call_status_callback_method?: 'GET' | 'POST';
|
|
1778
|
+
/** The ID of the LaML application to forward incoming calls to. Required when call_handler is laml_application. */
|
|
1779
|
+
call_laml_application_id?: string;
|
|
1780
|
+
/** The ID of the Dialogflow agent to forward incoming calls to. Required when call_handler is dialogflow. */
|
|
1781
|
+
call_dialogflow_agent_id?: string;
|
|
1782
|
+
/** The Relay topic to forward incoming calls to. Required when call_handler is relay_topic. */
|
|
1783
|
+
call_relay_topic?: string;
|
|
1784
|
+
/** A URL to send status change messages to. Required when call_handler is relay_topic. */
|
|
1785
|
+
call_relay_topic_status_callback_url?: string;
|
|
1786
|
+
/** The Relay context to forward incoming calls to. Required when call_handler is relay_context. */
|
|
1787
|
+
call_relay_context?: string;
|
|
1788
|
+
/** A URL to send status change messages to. Required when call_handler is relay_context. */
|
|
1789
|
+
call_relay_context_status_callback_url?: string;
|
|
1790
|
+
/** The Relay application to forward incoming calls to. Required when call_handler is relay_application. */
|
|
1791
|
+
call_relay_application?: string;
|
|
1792
|
+
/** The ID of the Video Room to forward incoming calls to. Required when call_handler is video_room. */
|
|
1793
|
+
call_video_room_id?: string;
|
|
1794
|
+
/** The ID of the Call Flow to forward incoming calls to. Required when call_handler is call_flow. */
|
|
1795
|
+
call_flow_id?: string;
|
|
1796
|
+
/** The version of the Call Flow to use. Valid values are 'working_copy' or 'current_deployed'. */
|
|
1797
|
+
call_flow_version?: string;
|
|
1798
|
+
/** The ID of the AI Agent to forward incoming calls to. Required when call_handler is ai_agent. */
|
|
1799
|
+
call_ai_agent_id?: string;
|
|
1800
|
+
/** A URL of a SWML script to respond to incoming calls. Required when call_handler is relay_script. */
|
|
1801
|
+
call_relay_script_url?: string;
|
|
1802
|
+
}
|
|
1803
|
+
/** Request body for updating the SIP profile. */
|
|
1804
|
+
export interface UpdateSipProfileRequest {
|
|
1805
|
+
/** String representing the domain_identifier portion of the profile. Must be unique across your project. */
|
|
1806
|
+
domain_identifier?: string;
|
|
1807
|
+
/** A list of codecs this profile will support. Currently supported values are: OPUS, G722, PCMU, PCMA, VP8, H264. */
|
|
1808
|
+
default_codecs?: string[];
|
|
1809
|
+
/** A list of encryption ciphers this profile will support. Currently supported values are: AEAD_AES_256_GCM_8, AES_256_CM_HMAC_SHA1_80, AES_CM_128_HMAC_SHA1_80, AES_256_CM_HMAC_SHA1_32, AES_CM_128_HMAC_SHA1_32. */
|
|
1810
|
+
default_ciphers?: string[];
|
|
1811
|
+
/** A string representing whether connections to an endpoint that uses this profile require encryption or if encryption is optional. Encryption will always be used if possible. Possible values are required or optional. */
|
|
1812
|
+
default_encryption?: 'required' | 'optional';
|
|
1813
|
+
/** The e164 formatted number you wish to set as the originating number when dialing PSTN phone numbers from a SIP Endpoint that uses this profile. Specify null or an empty string to randomly choose a purchased or verified number from within the project. */
|
|
1814
|
+
default_send_as?: string;
|
|
1815
|
+
}
|
|
1816
|
+
/** Request body for updating a verified caller ID. */
|
|
1817
|
+
export interface UpdateVerifiedCallerIDRequest {
|
|
1818
|
+
/** The name portion of the caller ID. */
|
|
1819
|
+
name: string;
|
|
1820
|
+
}
|
|
1821
|
+
/** Verified caller ID model. */
|
|
1822
|
+
export interface VerifiedCallerID {
|
|
1823
|
+
/** The type of the returned object, this should be verified_caller_id. */
|
|
1824
|
+
type?: string;
|
|
1825
|
+
/** The unique identifier of the Verified Caller ID on SignalWire. */
|
|
1826
|
+
id: uuid;
|
|
1827
|
+
/** String representing the phone number for the caller ID. This must be a valid, routeable phone number in E.164 format. */
|
|
1828
|
+
number: string;
|
|
1829
|
+
/** String representing the name portion of the caller ID. If not provided, the default will be the formatted number that has been provided. */
|
|
1830
|
+
name?: string;
|
|
1831
|
+
/** String representing the extension of the phone number for the caller ID. This is only used when placing the verification call. */
|
|
1832
|
+
extension?: string;
|
|
1833
|
+
/** A boolean representing whether the number has been verified or not. */
|
|
1834
|
+
verified: boolean;
|
|
1835
|
+
/** Nullable DateTime field representing the date and time that the number was verified. If the number has not been verified, it will be null. */
|
|
1836
|
+
verified_at?: string;
|
|
1837
|
+
/** The verification status for the caller ID. */
|
|
1838
|
+
status?: 'Verified' | 'Awaiting Verification';
|
|
1839
|
+
}
|
|
1840
|
+
/** Response containing a list of verified caller IDs. */
|
|
1841
|
+
export interface VerifiedCallerIDListResponse {
|
|
1842
|
+
/** Pagination links. */
|
|
1843
|
+
links?: PaginationLinks;
|
|
1844
|
+
/** List of verified caller IDs. */
|
|
1845
|
+
data?: VerifiedCallerID[];
|
|
1846
|
+
}
|
|
1847
|
+
/** Response containing a single verified caller ID. */
|
|
1848
|
+
export interface VerifiedCallerIDResponse {
|
|
1849
|
+
/** The type of the returned object, this should be verified_caller_id. */
|
|
1850
|
+
type?: string;
|
|
1851
|
+
/** The unique identifier of the Verified Caller ID on SignalWire. */
|
|
1852
|
+
id: uuid;
|
|
1853
|
+
/** String representing the phone number for the caller ID. This must be a valid, routeable phone number in E.164 format. */
|
|
1854
|
+
number: string;
|
|
1855
|
+
/** String representing the name portion of the caller ID. If not provided, the default will be the formatted number that has been provided. */
|
|
1856
|
+
name?: string;
|
|
1857
|
+
/** String representing the extension of the phone number for the caller ID. This is only used when placing the verification call. */
|
|
1858
|
+
extension?: string;
|
|
1859
|
+
/** A boolean representing whether the number has been verified or not. */
|
|
1860
|
+
verified: boolean;
|
|
1861
|
+
/** Nullable DateTime field representing the date and time that the number was verified. If the number has not been verified, it will be null. */
|
|
1862
|
+
verified_at?: string;
|
|
1863
|
+
/** The verification status for the caller ID. */
|
|
1864
|
+
status?: 'Verified' | 'Awaiting Verification';
|
|
1865
|
+
}
|
|
1866
|
+
/** Request body for verifying a caller ID. */
|
|
1867
|
+
export interface VerifyCallerIDRequest {
|
|
1868
|
+
/** The verification code received via call or SMS. */
|
|
1869
|
+
verification_code: string;
|
|
1870
|
+
}
|
|
1871
|
+
/** Recording from a WebRTC call leg. */
|
|
1872
|
+
export interface WebRtcRecording {
|
|
1873
|
+
/** Unique ID of the recording. */
|
|
1874
|
+
id: uuid;
|
|
1875
|
+
/** Unique ID of the project. */
|
|
1876
|
+
project_id: uuid;
|
|
1877
|
+
/** Date and time when the recording was created. */
|
|
1878
|
+
created_at: string;
|
|
1879
|
+
/** Date and time when the recording was last updated. */
|
|
1880
|
+
updated_at: string;
|
|
1881
|
+
/** Duration of the recording in seconds. */
|
|
1882
|
+
duration_in_seconds: number;
|
|
1883
|
+
/** Error code if the recording failed. */
|
|
1884
|
+
error_code?: string;
|
|
1885
|
+
/** Price of the recording. */
|
|
1886
|
+
price: number;
|
|
1887
|
+
/** Currency unit for the price. */
|
|
1888
|
+
price_unit: string;
|
|
1889
|
+
/** Status of the recording. */
|
|
1890
|
+
status: string;
|
|
1891
|
+
/** URL of the recording file. */
|
|
1892
|
+
url: string;
|
|
1893
|
+
/** Indicates whether the recording is stereo. */
|
|
1894
|
+
stereo: boolean;
|
|
1895
|
+
/** Size of the recording file in bytes. */
|
|
1896
|
+
byte_size?: number;
|
|
1897
|
+
/** Audio track of the recording. */
|
|
1898
|
+
track: string;
|
|
1899
|
+
/** ID of the WebRTC leg associated with the recording. */
|
|
1900
|
+
relay_webrtc_leg_id: uuid;
|
|
1901
|
+
}
|
|
1902
|
+
/** Universal Unique Identifier. */
|
|
1903
|
+
export type uuid = string;
|
|
1904
|
+
export type GetRecordingResponse = PstnRecording | SipRecording | WebRtcRecording;
|
|
1905
|
+
export type CreateBrandRequest = CreateManagedBrandRequest | CreateCspBrandRequest;
|
|
1906
|
+
export type CreateCampaignRequest = CreateManagedCampaignRequest | CreatePartnerCampaignRequest;
|