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
      • 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
        • create
        • delete
        • get
        • list
        • search
        • setAiAgent
        • setCallFlow
        • setCxmlApplication
        • setCxmlWebhook
        • setRelayApplication
        • setRelayTopic
        • setSwmlWebhook
        • update
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Parameters
  • Returns
  • Example
REST ClientPhone Numbers

setAiAgent

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

setCallFlow

Next
Built with

Route inbound calls on this phone number to an existing AI Agent Fabric resource by its ID.

This is a typed wrapper over update that sets call_handler to ai_agent and populates call_ai_agent_id for you.

Parameters

resourceId
stringRequired

ID of the phone number to bind.

agentId
stringRequired

ID of the AI Agent Fabric resource to route calls to.

extra
Record<string, unknown>Defaults to {}

Additional wire-level fields merged into the PUT body.

Returns

Promise<any> — The updated phone-number resource.

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4 project: "your-project-id",
5 token: "your-api-token",
6 host: "your-space.signalwire.com"
7});
8
9await client.phoneNumbers.setAiAgent("phone-number-id", "ai-agent-id");