SIP Gateway

List SIP gateways

Changed on

Lists the SIP Gateways in your SignalWire project. A gateway forwards outbound calls from SignalWire to an external SIP provider, PBX, or other destination. Use SIP Credentials when a device registers with SignalWire, or SIP Addresses for standalone SIP URIs with inbound handlers.

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.

get/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

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "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"
        ]
      }
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/sip_gateways?page_number=0&page_size=50",
    "first": "https://example.signalwire.com/api/fabric/resources/sip_gateways?page_number=0&page_size=50",
    "next": "https://example.signalwire.com/api/fabric/resources/sip_gateways?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
    "prev": "https://example.signalwire.com/api/fabric/resources/sip_gateways?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
  }
}

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

  • a888562fa415Revision changes
    • 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.