Get SIP address

GET

https://{your_space_name}.signalwire.com/api/fabric/sip_addresses/:id

GET

/api/fabric/sip_addresses/:id

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

{
  "id": "b3f1c0a2-0f6e-4a9d-9b2a-1c2d3e4f5a6b",
  "type": "sip",
  "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"
}

Retrieves one standalone SIP Address from your SignalWire project. Use List SIP addresses to find addresses. Generic resource addresses and physical E911 addresses use different operations.

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.

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)

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a SIP Address.

Response

The request has succeeded.

idstringformat: "uuid"

Unique identifier for the SIP address.

typeenum

The object type. Always sip.

Allowed values:

resource_idstringformat: "uuid"

ID of the resource this address belongs to.

namestring

URL-safe name for the SIP address. Used to build its SIP URI.

display_namestring

Human-friendly label for the SIP address. Defaults to name.

contextstring

The Domain this address is grouped under — for example, public for your project’s default Domain.

uristring

Full SIP URI for this address.

userstring

SIP username used to reach this address. * accepts any username.

encryptionenum

SRTP encryption requirement for calls to this address.

Allowed values:

codecslist of enums

Enabled codecs for calls to this address.

cipherslist of enums

Enabled SRTP ciphers for calls to this address.

Allowed values:

ip_auth_enabledboolean

Whether IP authentication is enforced for this address.

ip_authlist of strings

Whitelisted IP/CIDR entries used when ip_auth_enabled is true.

calling_handler_resource_idstringformat: "uuid"

ID of the resource that handles inbound calls to this address.

created_atdatetime

Date and time when the SIP address was created.

updated_atdatetime

Date and time when the SIP address was last updated.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error