List SIP gateways

GET

https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways

GET

/api/fabric/resources/sip_gateways

curl https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways \
     -u "<project_id>:<api_token>"

{
  "data": [
    {
      "id": "0823a606-0aff-4c90-9eba-f88ba118fe05",
      "project_id": "bc949800-7b40-43cf-8438-a85facfcbdd1",
      "display_name": "My SIP Gateway",
      "type": "sip_gateway",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z",
      "sip_gateway": {
        "id": "cce59cad-104d-4c28-ada4-98cfd102ae09",
        "uri": "user3@domain.com",
        "name": "My SIP Gateway",
        "ciphers": [
          "AEAD_AES_256_GCM_8"
        ],
        "codecs": [
          "OPUS"
        ],
        "encryption": "required"
      }
    }
  ],
  "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"
  }
}

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.

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](/docs/apis/rest/sip-credentials/list-sip-credentials) when a device registers with SignalWire, or [SIP Addresses](/docs/apis/rest/sip-addresses/list-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](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Response

The request has succeeded.

datalist of objects

An array of objects that contain a list of SIP Gateway data

linksobject

Pagination links for the response.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error