Get SIP credential

GET

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

GET

/api/fabric/resources/sip_endpoints/:id

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

{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Conference Room Phone",
  "type": "sip_endpoint",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "sip_endpoint": {
    "id": "993ed018-9e79-4e50-b97b-984bd5534095",
    "username": "User",
    "caller_id": "123456789",
    "send_as": "Support",
    "ciphers": [
      "AEAD_AES_256_GCM_8",
      "AES_256_CM_HMAC_SHA1_32"
    ],
    "codecs": [
      "G722",
      "PCMA",
      "PCMU",
      "VP8"
    ],
    "encryption": "default",
    "call_handler": "default",
    "calling_handler_resource_id": "993ed018-9e79-4e50-b97b-984bd5534095"
  }
}

Retrieves one project-scoped SIP Credential by resource ID so you can inspect how its device registers and places calls through SignalWire. Use List SIP credentials to discover IDs, or the Subscriber endpoint for a credential owned by one Subscriber.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, 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 the SIP endpoint.

Response

The request has succeeded.

idstringformat: "uuid"

Unique ID of the SIP Endpoint.

project_idstringformat: "uuid"

Unique ID of the Project.

display_namestring

Display name of the SIP Endpoint Fabric Resource

typeenum

Type of the Fabric Resource

Allowed values:

created_atdatetime

Date and time when the resource was created.

updated_atdatetime

Date and time when the resource was updated.

sip_endpointobject

SIP Endpoint data.

Errors

500

Internal Server Error