> 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.

# Create SIP gateway

POST https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/sip_gateways
Content-Type: application/json

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](/docs/apis/rest/sip-credentials/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](/docs/platform/your-signalwire-api-space).

Reference: https://signalwire.com/docs/apis/rest/sip-gateway/create-sip-gateway

## 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) ```

## Request

### Body (application/json)

This endpoint expects a SipGatewayRequest.

- `name` (string, required) — Display name for the SIP Gateway.
- `uri` (string, required) — External SIP URI.
- `encryption` (enum, required) — Specifies the encryption requirement for the SIP connection.
  - Allowed values: `required`, `optional`, `default`
- `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 for media transmission.
  - Allowed values: `PCMU`, `PCMA`, `G722`, `G729`, `OPUS`, `OPUS@48000H@20I`, `OPUS@24000H@20I`, `OPUS@16000H@20I`, `OPUS@8000H@20I`, `VP8`, `H264`

## Response

### 201

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

- `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.

## 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`

### 422 Unprocessable Entity Error

The request contains invalid parameters. See errors for details.

- `errors` (list of Types.StatusCodes.RestApiErrorItem, required) — List of validation errors.

### 500 Internal Server Error

An internal server error occurred.

- `error` (enum, required)
  - Allowed values: `Internal Server Error`

## Types

### 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`

### Types.StatusCodes.RestApiErrorItem

Details about a specific error.

- `type` (string, required) — The category of error.
- `code` (string, required) — A specific error code.
- `message` (string, required) — A description of what caused the error.
- `url` (string, required) — A link to documentation about this error.
- `attribute` (string, optional, nullable) — The request parameter that caused the error, if applicable.

## Examples

**Request**

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

**Response**

```json
{
  "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"
  }
}
```

**SDK Code**

```python
import requests

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

payload = {
    "name": "My SIP Gateway",
    "uri": "user2@domain.com",
    "encryption": "required",
    "ciphers": ["AEAD_AES_256_GCM_8", "AES_256_CM_HMAC_SHA1_80"],
    "codecs": ["OPUS"]
}
headers = {
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers, auth=("<project_id>", "<api_token>"))

print(response.json())
```

```javascript
const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways';
const credentials = btoa("<project_id>:<api_token>");

const options = {
  method: 'POST',
  headers: {
    Authorization: `Basic ${credentials}`,
    'Content-Type': 'application/json'
  },
  body: '{"name":"My SIP Gateway","uri":"user2@domain.com","encryption":"required","ciphers":["AEAD_AES_256_GCM_8","AES_256_CM_HMAC_SHA1_80"],"codecs":["OPUS"]}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"My SIP Gateway\",\n  \"uri\": \"user2@domain.com\",\n  \"encryption\": \"required\",\n  \"ciphers\": [\n    \"AEAD_AES_256_GCM_8\",\n    \"AES_256_CM_HMAC_SHA1_80\"\n  ],\n  \"codecs\": [\n    \"OPUS\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.SetBasicAuth("<project_id>", "<api_token>")
	req.Header.Add("Content-Type", "application/json")

	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::Post.new(url)
request.basic_auth("<project_id>", "<api_token>")
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My SIP Gateway\",\n  \"uri\": \"user2@domain.com\",\n  \"encryption\": \"required\",\n  \"ciphers\": [\n    \"AEAD_AES_256_GCM_8\",\n    \"AES_256_CM_HMAC_SHA1_80\"\n  ],\n  \"codecs\": [\n    \"OPUS\"\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways")
  .basicAuth("<project_id>", "<api_token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My SIP Gateway\",\n  \"uri\": \"user2@domain.com\",\n  \"encryption\": \"required\",\n  \"ciphers\": [\n    \"AEAD_AES_256_GCM_8\",\n    \"AES_256_CM_HMAC_SHA1_80\"\n  ],\n  \"codecs\": [\n    \"OPUS\"\n  ]\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways', [
  'body' => '{
  "name": "My SIP Gateway",
  "uri": "user2@domain.com",
  "encryption": "required",
  "ciphers": [
    "AEAD_AES_256_GCM_8",
    "AES_256_CM_HMAC_SHA1_80"
  ],
  "codecs": [
    "OPUS"
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
    'auth' => ['<project_id>', '<api_token>'],
]);

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("<project_id>", "<api_token>");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"My SIP Gateway\",\n  \"uri\": \"user2@domain.com\",\n  \"encryption\": \"required\",\n  \"ciphers\": [\n    \"AEAD_AES_256_GCM_8\",\n    \"AES_256_CM_HMAC_SHA1_80\"\n  ],\n  \"codecs\": [\n    \"OPUS\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<project_id>:<api_token>".utf8).base64EncodedString()

let headers = [
  "Authorization": "Basic \(credentials)",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "My SIP Gateway",
  "uri": "user2@domain.com",
  "encryption": "required",
  "ciphers": ["AEAD_AES_256_GCM_8", "AES_256_CM_HMAC_SHA1_80"],
  "codecs": ["OPUS"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

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 = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```