> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt

# Create SIP address

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

Creates a SIP address, along with its username, encryption, codec, cipher, and IP authentication settings.

#### Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Calling_, _Fax_, _Messaging_, or _Video_.

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

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

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: signalwire-rest
  version: 1.0.0
paths:
  /api/fabric/sip_addresses:
    post:
      operationId: create_sip_address
      summary: Create SIP address
      description: >-
        Creates a SIP address, along with its username, encryption, codec,
        cipher, and IP authentication settings.


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _Calling_, _Fax_, _Messaging_, or
        _Video_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - sipAddresses
      parameters:
        - name: Authorization
          in: header
          description: >-
            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)

            ```
          required: true
          schema:
            type: string
      responses:
        '201':
          description: >-
            The request has succeeded and a new resource has been created as a
            result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipAddress'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipAddressCreateStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SipAddressCreateRequest'
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com
    description: SignalWire API
components:
  schemas:
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    SipAddressCodec:
      type: string
      enum:
        - OPUS
        - G722
        - PCMU
        - PCMA
        - G729
        - VP8
        - H264
      title: SipAddressCodec
    Ciphers:
      type: string
      enum:
        - 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
      title: Ciphers
    SipAddressEncryption:
      type: string
      enum:
        - required
        - optional
        - forbidden
      title: SipAddressEncryption
    SipAddressCreateRequest:
      type: object
      properties:
        name:
          type: string
          description: >-
            URL-safe name for the SIP address — lowercase letters, numbers, and
            hyphens only (no spaces or other special characters). Must be unique
            within the project and is used to build the address's SIP URI.
        user:
          type: string
          default: '*'
          description: >-
            SIP username used to reach this address (no spaces). Defaults to
            `*`, which accepts any username. Together with the address's Domain,
            must be unique across your SignalWire account.
        context_id:
          $ref: '#/components/schemas/uuid'
          description: >-
            ID of the Domain this address should be grouped under. Must exist in
            your project. Defaults to your project's default Domain.
        calling_handler_resource_id:
          $ref: '#/components/schemas/uuid'
          description: >-
            ID of the resource that handles inbound calls to this address. Must
            reference a resource in the caller's project.
        ip_auth_enabled:
          type: boolean
          default: false
          description: Whether to enforce IP authentication for this address.
        ip_auth:
          type: array
          items:
            type: string
          default: []
          description: >-
            Whitelisted IP/CIDR entries. Required (at least one) when
            `ip_auth_enabled` is `true`. Maximum 256 entries.
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/SipAddressCodec'
          default:
            - PCMU
            - PCMA
          description: Non-empty subset of enabled codecs.
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          default:
            - 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
          description: Non-empty subset of enabled SRTP ciphers.
        encryption:
          $ref: '#/components/schemas/SipAddressEncryption'
          default: optional
          description: SRTP encryption requirement for calls to this address.
        password:
          type: string
          description: >-
            Write-only SIP registration password. Never returned in any
            response.
      required:
        - name
        - calling_handler_resource_id
      title: SipAddressCreateRequest
    SipAddressType:
      type: string
      enum:
        - sip_address
      description: The object type. Always `sip_address`.
      title: SipAddressType
    SipAddress:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique identifier for the SIP address.
        type:
          $ref: '#/components/schemas/SipAddressType'
          description: The object type. Always `sip_address`.
        resource_id:
          $ref: '#/components/schemas/uuid'
          description: ID of the resource this address belongs to.
        name:
          type: string
          description: URL-safe name for the SIP address. Used to build its SIP URI.
        display_name:
          type: string
          description: Human-friendly label for the SIP address. Defaults to `name`.
        context:
          type: string
          description: >-
            The Domain this address is grouped under — for example, `public` for
            your project's default Domain.
        uri:
          type: string
          description: Full SIP URI for this address.
        user:
          type: string
          description: SIP username used to reach this address. `*` accepts any username.
        encryption:
          $ref: '#/components/schemas/SipAddressEncryption'
          description: SRTP encryption requirement for calls to this address.
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/SipAddressCodec'
          description: Enabled codecs for calls to this address.
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: Enabled SRTP ciphers for calls to this address.
        ip_auth_enabled:
          type: boolean
          description: Whether IP authentication is enforced for this address.
        ip_auth:
          type: array
          items:
            type: string
          description: Whitelisted IP/CIDR entries used when `ip_auth_enabled` is `true`.
        calling_handler_resource_id:
          $ref: '#/components/schemas/uuid'
          description: ID of the resource that handles inbound calls to this address.
        created_at:
          type: string
          format: date-time
          description: Date and time when the SIP address was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the SIP address was last updated.
      required:
        - id
        - type
        - resource_id
        - name
        - display_name
        - context
        - uri
        - user
        - encryption
        - codecs
        - ciphers
        - ip_auth_enabled
        - ip_auth
        - calling_handler_resource_id
        - created_at
        - updated_at
      title: SipAddress
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    Types.StatusCodes.RestApiErrorItem:
      type: object
      properties:
        type:
          type: string
          description: The category of error.
        code:
          type: string
          description: A specific error code.
        message:
          type: string
          description: A description of what caused the error.
        attribute:
          type:
            - string
            - 'null'
          description: The request parameter that caused the error, if applicable.
        url:
          type: string
          description: A link to documentation about this error.
      required:
        - type
        - code
        - message
        - url
      description: Details about a specific error.
      title: Types.StatusCodes.RestApiErrorItem
    SipAddressCreateStatusCode422:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.RestApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request contains invalid parameters. See errors for details.
      title: SipAddressCreateStatusCode422
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        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)

        ```

```

## Examples



**Request**

```json
{
  "name": "sales-line",
  "calling_handler_resource_id": "1f2e3d4c-5b6a-7980-a1b2-c3d4e5f60718"
}
```

**Response**

```json
{
  "id": "b3f1c0a2-0f6e-4a9d-9b2a-1c2d3e4f5a6b",
  "type": "sip_address",
  "resource_id": "8a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
  "name": "support-line",
  "display_name": "support-line",
  "context": "public",
  "uri": "sip:my-space-support-line@sip.signalwire.com",
  "user": "*",
  "encryption": "optional",
  "codecs": [
    "PCMU",
    "PCMA"
  ],
  "ciphers": [
    "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"
  ],
  "ip_auth_enabled": false,
  "ip_auth": [],
  "calling_handler_resource_id": "1f2e3d4c-5b6a-7980-a1b2-c3d4e5f60718",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z"
}
```

**SDK Code**

```python
import requests

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

payload = {
    "name": "sales-line",
    "calling_handler_resource_id": "1f2e3d4c-5b6a-7980-a1b2-c3d4e5f60718"
}
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/sip_addresses';
const credentials = btoa("<project_id>:<api_token>");

const options = {
  method: 'POST',
  headers: {
    Authorization: `Basic ${credentials}`,
    'Content-Type': 'application/json'
  },
  body: '{"name":"sales-line","calling_handler_resource_id":"1f2e3d4c-5b6a-7980-a1b2-c3d4e5f60718"}'
};

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/sip_addresses"

	payload := strings.NewReader("{\n  \"name\": \"sales-line\",\n  \"calling_handler_resource_id\": \"1f2e3d4c-5b6a-7980-a1b2-c3d4e5f60718\"\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/sip_addresses")

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\": \"sales-line\",\n  \"calling_handler_resource_id\": \"1f2e3d4c-5b6a-7980-a1b2-c3d4e5f60718\"\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/sip_addresses")
  .basicAuth("<project_id>", "<api_token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"sales-line\",\n  \"calling_handler_resource_id\": \"1f2e3d4c-5b6a-7980-a1b2-c3d4e5f60718\"\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/sip_addresses', [
  'body' => '{
  "name": "sales-line",
  "calling_handler_resource_id": "1f2e3d4c-5b6a-7980-a1b2-c3d4e5f60718"
}',
  '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/sip_addresses");
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\": \"sales-line\",\n  \"calling_handler_resource_id\": \"1f2e3d4c-5b6a-7980-a1b2-c3d4e5f60718\"\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": "sales-line",
  "calling_handler_resource_id": "1f2e3d4c-5b6a-7980-a1b2-c3d4e5f60718"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/fabric/sip_addresses")! 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()
```