> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # List SIP gateways GET https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/sip_gateways 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). Reference: https://signalwire.com/docs/apis/rest/sip-gateway/list-sip-gateways ## Authentication - `Authorization` header (basic auth, required) — 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 ### 200 The request has succeeded. - `data` (list of SipGatewayResponse, required) — An array of objects that contain a list of SIP Gateway data - `links` (SipGatewayPaginationResponse, required) — Pagination links for the response. ## Errors ### 401 Unauthorized Error Access is unauthorized. - `error` (enum, required) - Allowed values: `Unauthorized` ### 404 Not Found Error The server cannot find the requested resource. - `error` (enum, required) - Allowed values: `Not Found` ### 500 Internal Server Error An internal server error occurred. - `error` (enum, required) - Allowed values: `Internal Server Error` ## Types ### SipGatewayResponse - `id` (string, required) — Unique ID of the resource. - `project_id` (string, required) — Project ID associated with the resource. - `display_name` (string, required) — Display name of the SIP Gateway. - `type` (enum, required) — Type of the resource. - Allowed values: `sip_gateway` - `created_at` (datetime, required) — Timestamp when the resource was created. - `updated_at` (datetime, required) — Timestamp when the resource was last updated. - `sip_gateway` (SipGateway, required) — SIP Gateway configuration details. ### SipGatewayPaginationResponse - `self` (string, required) — Link to the current page of results - `first` (string, required) — Link to the first page of results - `next` (string, optional) — Link to the next page of results - `prev` (string, optional) — Link to the previous page of results ### SipGateway - `id` (string, required) — Unique ID of the SIP Gateway. - `uri` (string, required) — The URI for the SIP Gateway. - `name` (string, required) — Display name of the SIP Gateway. - `ciphers` (list of enum, required) — List of supported SIP ciphers. - Allowed values: `AEAD_AES_256_GCM_8`, `AES_256_CM_HMAC_SHA1_80`, `AES_CM_128_HMAC_SHA1_80`, `AES_256_CM_HMAC_SHA1_32`, `AES_CM_128_HMAC_SHA1_32` - `codecs` (list of enum, required) — List of supported codecs. - Allowed values: `PCMU`, `PCMA`, `G722`, `G729`, `OPUS`, `OPUS@48000H@20I`, `OPUS@24000H@20I`, `OPUS@16000H@20I`, `OPUS@8000H@20I`, `VP8`, `H264` - `encryption` (enum, required) — Specifies the encryption requirement. - Allowed values: `required`, `optional`, `default` ## Examples **Response** ```json { "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" } } ``` **SDK Code** ```python import requests url = "https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways" response = requests.get(url, auth=("", "")) print(response.json()) ``` ```javascript const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways'; const credentials = btoa(":"); const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways" req, _ := http.NewRequest("GET", url, nil) req.SetBasicAuth("", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request.basic_auth("", "") response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways") .basicAuth("", "") .asString(); ``` ```php request('GET', 'https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways', [ 'headers' => [ ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = ["Authorization": "Basic \(credentials)"] let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```