For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
        • ApiNinjasTriviaSkill
        • AskClaudeSkill
        • ClaudeSkillsSkill
        • CustomSkillsSkill
        • DataSphereServerlessSkill
        • DataSphereSkill
        • DateTimeSkill
        • GoogleMapsSkill
        • InfoGathererSkill
        • JokeSkill
        • MathSkill
        • McpGatewaySkill
        • NativeVectorSearchSkill
        • PlayBackgroundFileSkill
        • SpiderSkill
        • SwmlTransferSkill
        • WeatherApiSkill
        • WebSearchSkill
        • WikipediaSearchSkill
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
      • Datasphere
      • Fabric
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • transfers
  • patterns
  • allow_arbitrary
  • tool_name
  • description
  • parameter_name
  • parameter_description
  • default_message
  • default_post_process
  • required_fields
  • Example — TypeScript patterns
  • Example — Python-style transfers
AgentsSkills

SwmlTransferSkill

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

WeatherApiSkill

Next
Built with

Transfer calls between agents or endpoints using SWML transfer actions. The skill accepts either a Python-style transfers config (regex pattern → per-entry config) or a TypeScript-style patterns array of named destinations. At least one of the two shapes is required — setup() fails closed otherwise.

Class: SwmlTransferSkill

Tools: transfer_call always; list_transfer_destinations additionally registered when at least one entry is supplied in patterns.

Env vars: None

Multi-instance: yes — set a distinct tool_name per instance.

transfers
Record<string, TransferConfig>

Python-style map of transfer configs keyed by regex pattern (or name). Each entry includes either url or address (not both), plus optional message, return_message, post_process, final, and from_addr.

Either transfers or patterns must be provided; both may be combined. setup() fails closed when neither is configured.

patterns
TransferPattern[]

TypeScript-style array of named transfer patterns. Each object has:

  • name (string, required) — friendly name for the destination.
  • destination (string, required) — SIP URI, phone number, or agent URL.
  • description (string) — optional human-readable description.
  • message / returnMessage / postProcess / final / fromAddr — optional per-pattern overrides.
allow_arbitrary
boolean

Whether to allow transfers to arbitrary destinations not listed in patterns / transfers. When unset, defaults depend on whether any patterns are configured.

tool_name
stringDefaults to transfer_call

Name of the transfer tool exposed to the AI.

description
stringDefaults to Transfer call based on pattern matching

Description for the transfer tool shown to the AI.

parameter_name
stringDefaults to transfer_type

Name of the parameter that accepts the transfer type.

parameter_description
stringDefaults to The type of transfer to perform

Description for the transfer-type parameter.

default_message
stringDefaults to Please specify a valid transfer type.

Message spoken when no pattern matches.

default_post_process
booleanDefaults to false

Whether to post-process the default message with the AI.

required_fields
Record<string, string>Defaults to {}

Map of additional fields (name → description) the agent must collect before a transfer.

Regex patterns in transfers are matched case-sensitively. Use character classes or flags in the source pattern when case-insensitive matching is needed.

Example — TypeScript patterns

1import { AgentBase, SwmlTransferSkill } from '@signalwire/sdk';
2
3const agent = new AgentBase({ name: 'assistant', route: '/assistant' });
4agent.setPromptText('You are a helpful assistant.');
5
6await agent.addSkill(new SwmlTransferSkill({
7  patterns: [
8    {
9      name: 'sales',
10      destination: 'https://your-server.com/sales-agent',
11      description: 'Sales team',
12    },
13    {
14      name: 'support',
15      destination: '+15551234567',
16      description: 'Technical support line',
17    },
18  ],
19  default_message: 'Please specify sales or support.',
20}));
21
22agent.run();

Example — Python-style transfers

1import { AgentBase, SwmlTransferSkill } from '@signalwire/sdk';
2
3const agent = new AgentBase({ name: 'assistant', route: '/assistant' });
4agent.setPromptText('You are a helpful assistant.');
5
6await agent.addSkill(new SwmlTransferSkill({
7  transfers: {
8    '^sales$':   { address: 'sip:sales@signalwire.com' },
9    '^support$': { url: 'https://your-server.com/support-agent' },
10  },
11}));
12
13agent.run();