Addresses3

AI Agents: Custom6

AI Agents: Dialogflow5

AI Chat1

Call Flows8

Caller ID Name3

Calls1

Campaign Registry: Brands3

Campaign Registry: Campaigns4

Campaign Registry: Phone Number Assignments5

Chat Tokens1

Chunks3

Conference Logs1

Conference Rooms6

Conference Tokens3

cXML Applications5

cXML Scripts6

cXML Webhook6

Documents6

Domain Applications1

E911 Addresses7

Fax Logs2

FreeSWITCH Connector6

Imported Phone Numbers1

Message Logs2

Messages2

Multi-Factor Authentication3

Number Group Membership4

Number Groups5

Phone Number Lookup1

Phone Numbers6

Phone Routes1

Project Tokens3

Projects6

PubSub Tokens1

Queue Members3

Queues5

Recordings3

Relay Application6

Resources3

Room Recordings4

Room Sessions5

Room Tokens1

Rooms6

Short Codes3

SIP Addresses5

SIP Credentials7

SIP Endpoints (Legacy)5

SIP Gateway6

SIP Profile2

Space Domain Applications5

Streams7

Subscriber SIP Credentials5

Subscriber Tokens5

Subscribers6

SWML Scripts6

SWML Webhook6

Verified Caller ID7

Video Conferences5

Video Logs2

Voice Logs3

WhatsApp Businesses1

WhatsApp Numbers2

WhatsApp Templates5

Webhooks

AI Webhooks8

Calling Webhooks3

Messaging Webhooks3

SIP Gateway

Create SIP gateway

Creates a SIP Gateway resource that forwards calls to an external SIP destination. Use it for outbound routing to a provider, PBX, or other SIP system that SignalWire dials. Use Create SIP credential when the external device registers with SignalWire instead.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

post/api/fabric/resources/sip_gateways

Request body

namestring required

Display name for the SIP Gateway.

uristring required

External SIP URI.

encryption'required' | 'optional' | 'default' required

ciphersCiphers[] required

List of supported SIP ciphers.

codecsCodecs[] required

List of supported codecs for media transmission.

Example request

{
  "name": "My SIP Gateway",
  "uri": "user2@domain.com",
  "ciphers": [
    "AEAD_AES_256_GCM_8",
    "AES_256_CM_HMAC_SHA1_80"
  ],
  "codecs": [
    "OPUS"
  ]
}

Response

The request has succeeded and a new resource has been created as a result.

idstring uuid required

Universal Unique Identifier.

project_idstring uuid required

Universal Unique Identifier.

display_namestring required

Display name of the SIP Gateway.

type'sip_gateway' required

Type of the resource.

created_atstring date-time required

Timestamp when the resource was created.

updated_atstring date-time required

Timestamp when the resource was last updated.

Example response

{
  "display_name": "My SIP Gateway",
  "type": "sip_gateway",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "sip_gateway": {
    "uri": "user3@domain.com",
    "name": "My SIP Gateway",
    "ciphers": [
      "AEAD_AES_256_GCM_8"
    ],
    "codecs": [
      "OPUS"
    ]
  }
}

Changes

Changed in 3 of the 137 revisions of this API.4812

Jul 8, 20269709f1df402244See the full diff
- ●
  added the new OPUS@16000H@20I enum value to the sip_gateway/allOf[SipGateway]/codecs/items/ response property for the response status 201
  response-property-enum-value-added
- ●
  added the new OPUS@24000H@20I enum value to the sip_gateway/allOf[SipGateway]/codecs/items/ response property for the response status 201
  response-property-enum-value-added
- ●
  added the new OPUS@48000H@20I enum value to the sip_gateway/allOf[SipGateway]/codecs/items/ response property for the response status 201
  response-property-enum-value-added
- ●
  added the new OPUS@8000H@20I enum value to the sip_gateway/allOf[SipGateway]/codecs/items/ response property for the response status 201
  response-property-enum-value-added
- ○
  added the new OPUS@16000H@20I enum value to the request property codecs/items/
  request-property-enum-value-added
- ○
  added the new OPUS@24000H@20I enum value to the request property codecs/items/
  request-property-enum-value-added
- ○
  added the new OPUS@48000H@20I enum value to the request property codecs/items/
  request-property-enum-value-added
- ○
  added the new OPUS@8000H@20I enum value to the request property codecs/items/
  request-property-enum-value-added
Jul 8, 2026a888562fa41544See the full diff
- ▲
  removed the enum value OPUS@16000H@20I of the request property codecs/items/
  request-property-enum-value-removed
- ▲
  removed the enum value OPUS@24000H@20I of the request property codecs/items/
  request-property-enum-value-removed
- ▲
  removed the enum value OPUS@48000H@20I of the request property codecs/items/
  request-property-enum-value-removed
- ▲
  removed the enum value OPUS@8000H@20I of the request property codecs/items/
  request-property-enum-value-removed
- ○
  removed the OPUS@16000H@20I enum value from the sip_gateway/allOf[SipGateway]/codecs/items/ response property for the response status 201
  response-property-enum-value-removed
- ○
  removed the OPUS@24000H@20I enum value from the sip_gateway/allOf[SipGateway]/codecs/items/ response property for the response status 201
  response-property-enum-value-removed
- ○
  removed the OPUS@48000H@20I enum value from the sip_gateway/allOf[SipGateway]/codecs/items/ response property for the response status 201
  response-property-enum-value-removed
- ○
  removed the OPUS@8000H@20I enum value from the sip_gateway/allOf[SipGateway]/codecs/items/ response property for the response status 201
  response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 24, 20262e508a40b46144See the full diff
- ●
  added the new OPUS@16000H@20I enum value to the sip_gateway/allOf[SipGateway]/codecs/items/ response property for the response status 201
  response-property-enum-value-added
- ●
  added the new OPUS@24000H@20I enum value to the sip_gateway/allOf[SipGateway]/codecs/items/ response property for the response status 201
  response-property-enum-value-added
- ●
  added the new OPUS@48000H@20I enum value to the sip_gateway/allOf[SipGateway]/codecs/items/ response property for the response status 201
  response-property-enum-value-added
- ●
  added the new OPUS@8000H@20I enum value to the sip_gateway/allOf[SipGateway]/codecs/items/ response property for the response status 201
  response-property-enum-value-added
- ○
  added the new OPUS@16000H@20I enum value to the request property codecs/items/
  request-property-enum-value-added
- ○
  added the new OPUS@24000H@20I enum value to the request property codecs/items/
  request-property-enum-value-added
- ○
  added the new OPUS@48000H@20I enum value to the request property codecs/items/
  request-property-enum-value-added
- ○
  added the new OPUS@8000H@20I enum value to the request property codecs/items/
  request-property-enum-value-added

Of the 137 revisions, 3 have a changelog that could not be searched.

Full history