Skip to main content

Retrieve a SIP Endpoint

Retrieves the details of a SIP Endpoint that has been previously created. Use the unique ID that was returned from your previous request to identify the specific SIP Endpoint.

Path Parameters
id uuid REQUIRED

Unique ID of the SIP endpoint

Responses
200

OK

Schema
id string

The unique identifier of the SIP Endpoint on SignalWire. This can be used to update or delete the endpoint programmatically.

username string

String representing the username portion of the endpoint. Must be unique across your project and must not container white space characters or @.

caller_id string

Friendly Caller ID used as the CNAM when dialing a phone number or the From when dialing another SIP Endpoint.

send_as string

When dialing a PSTN phone number, you must send it From a number you have purchased or verified. send_as indicates which number this endpoint has set as its origination. random indicates it will randomly choose a purchased or verified number from within the project.

Defaults to the project's SIP Settings default send as number.

ciphers string[]

A list of encryption ciphers this endpoint 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.

Defaults to the project's SIP Settings default cipher list. You can unset the custom cipher list and use the project's SIP Settings default cipher list by sending an empty array.

codecs string[]

A list of codecs this endpoint will support.

Currently supported values are: OPUS, G722, PCMU, PCMA, VP8, H264.

Defaults to the project's SIP Settings default codec list. You can unset the custom codec list and use the project's SIP Settings default codec list by sending an empty array.

encryption string

A string representing whether connections to this endpoint require encryption or if encryption is optional. Encryption will always be used if possible.

Possible values are default, required, optional.

Defaults to the project's SIP Settings default.

type string

A string representation of the type of object this record is.