Skip to main content

Retrieve a SIP Profile

GET 
/sip_profile

Retrieves the details of a SIP Profile that has been previously created. Use the current project id that was set by authentication to identify the specific SIP Profile.

Permissions​

The API token must include the following scopes: Voice.

Responses​

OK

Schema

    domain string

    A string representation of the fully qualified domain name for this profile.

    Example: your-space-example.sip.signalwire.com
    domain_identifier string

    String representing the domain_identifier portion of the profile. Must be unique across your project.

    Example: example
    default_codecs string[]

    A list of codecs this profile will support. Currently supported values are: OPUS, G722, PCMU, PCMA, VP8, H264.

    Example: ["OPUS"]
    default_ciphers string[]

    A list of encryption ciphers this profile will support. Currently supported values are: 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.

    Example: ["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"]
    default_encryption string

    A string representing whether connections to an endpoint that uses this profile require encryption or if encryption is optional. Encryption will always be used if possible. Possible values are required or optional.

    Example: optional
    default_send_as string

    The e164 formatted number you wish to set as the originating number when dialing PSTN phone numbers from a SIP Endpoint that uses this profile. Specify null or an empty string to randomly choose a purchased or verified number from within the project.

    Example: +15551234567