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
        • Addresses
        • AI Agents
        • Call Flows
        • Conference Rooms
        • cXML Applications
        • cXML Scripts
        • cXML Webhooks
        • FreeSWITCH Connectors
        • RELAY Applications
        • Resources
        • SIP Endpoints
        • SIP Gateways
        • Subscribers
          • create
          • createSipEndpoint
          • delete
          • deleteSipEndpoint
          • get
          • getSipEndpoint
          • list
          • listAddresses
          • listSipEndpoints
          • update
          • updateSipEndpoint
        • SWML Scripts
        • SWML Webhooks
        • Tokens
      • 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
  • Response Example
  • Example
REST ClientFabricSubscribers

createSipEndpoint

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

delete

Next
Built with

Create a new SIP endpoint for a subscriber.

Path parameters

fabric_subscriber_idstringRequiredformat: "uuid"
Unique ID of a Fabric Subscriber.

Request

usernamestringRequired
Username of the Sip Endpoint.
passwordstringRequired
Password of the Sip Endpoint.
caller_idstringOptional
Caller ID of the Sip Endpoint.
send_asstringOptional
The Number to send as.
cipherslist of enumsOptional
Ciphers of the Sip Endpoint.
Allowed values:
codecslist of enumsOptional
Codecs of the Sip Endpoint.
encryptionenumOptionalDefaults to default
Encryption requirement of the Sip Endpoint.
Allowed values:

Response

idstringRequiredformat: "uuid"
Unique ID of the Sip Endpoint.
usernamestringRequired
Username of the Sip Endpoint.
caller_idstringRequired
Caller ID of the Sip Endpoint.
send_asstringRequired
Purchased or verified number
cipherslist of enumsRequired
Ciphers of the Sip Endpoint.
Allowed values:
codecslist of enumsRequired
Codecs of the Sip Endpoint.
encryptionenumRequired
Encryption requirement of the Sip Endpoint.
Allowed values:

Response Example

Response
1{
2 "id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
3 "username": "justice-league",
4 "caller_id": "call-id-123",
5 "send_as": "+14632322867",
6 "ciphers": [
7 "AEAD_AES_256_GCM_8"
8 ],
9 "codecs": [
10 "PCMU"
11 ],
12 "encryption": "optional"
13}

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
9const result = await client.fabric.subscribers.createSipEndpoint("subscriber-id", {
10 username: "alice-sip",
11 password: "s3cret"
12});
13console.log("Created SIP endpoint:", result.id);