SIP Gateway

Create SIP gateway

Changed on

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

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/fabric/resources/sip_gateways
  • Auth
    HTTP basic

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

  • 9709f1df4022Revision changes
    • warning

      added the new OPUS@16000H@20I enum value to the ////// response property for the response status

    • warning

      added the new OPUS@24000H@20I enum value to the ////// response property for the response status

    • warning

      added the new OPUS@48000H@20I enum value to the ////// response property for the response status

    • warning

      added the new OPUS@8000H@20I enum value to the ////// response property for the response status

    • info

      added the new OPUS@16000H@20I enum value to the request property /

    • info

      added the new OPUS@24000H@20I enum value to the request property /

    • info

      added the new OPUS@48000H@20I enum value to the request property /

    • info

      added the new OPUS@8000H@20I enum value to the request property /

  • a888562fa415Revision changes
    • breaking

      removed the enum value OPUS@16000H@20I of the request property /

    • breaking

      removed the enum value OPUS@24000H@20I of the request property /

    • breaking

      removed the enum value OPUS@48000H@20I of the request property /

    • breaking

      removed the enum value OPUS@8000H@20I of the request property /

    • info

      removed the OPUS@16000H@20I enum value from the ////// response property for the response status

    • info

      removed the OPUS@24000H@20I enum value from the ////// response property for the response status

    • info

      removed the OPUS@48000H@20I enum value from the ////// response property for the response status

    • info

      removed the OPUS@8000H@20I enum value from the ////// response property for the response status

Some revisions have not been checked yet.