Sign in
SIP Addresses

Get SIP address

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.

get/api/fabric/sip_addresses/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a SIP Address.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

type'sip_address' required

The object type. Always sip_address.

resource_idstring uuid required

Universal Unique Identifier.

namestring required

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

display_namestring required

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

contextstring required

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

uristring required

Full SIP URI for this address.

userstring required

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

encryption'required' | 'optional' | 'forbidden' required
codecsSipAddressCodec[] required

Enabled codecs for calls to this address.

ciphersCiphers[] required

Enabled SRTP ciphers for calls to this address.

ip_auth_enabledboolean required

Whether IP authentication is enforced for this address.

ip_authstring[] required

Whitelisted IP/CIDR entries used when ip_auth_enabled is true.

calling_handler_resource_idstring uuid required

Universal Unique Identifier.

created_atstring date-time required

Date and time when the SIP address was created.

updated_atstring date-time required

Date and time when the SIP address was last updated.

Example response

{
  "type": "sip_address",
  "name": "support-line",
  "display_name": "support-line",
  "context": "public",
  "uri": "sip:my-space-support-line@sip.signalwire.com",
  "user": "*",
  "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": [],
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z"
}

Changes

Changed in 3 of the 138 revisions of this API.12

Of the 138 revisions, 3 have a changelog that could not be searched.