Skip to main content
GET
/
api
/
v1
/
sip-credentials
/
{id}
Get SIP credential
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://blackbox.dasha.ai/api/v1/sip-credentials/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orgId": "<string>",
  "server": "<string>",
  "transport": "udp",
  "source": "manual",
  "createdTime": "2023-11-07T05:31:56Z",
  "lastUpdateTime": "2023-11-07T05:31:56Z",
  "domain": "<string>",
  "authUser": "<string>",
  "authPassword": "<string>",
  "description": "<string>",
  "cpsLimit": 123,
  "cpsKey": "<string>",
  "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Path Parameters

​
id
string<uuid>
required

Credential identifier

Response

Returns SIP credential successfully

SIP trunk credentials information including connection settings, authentication, rate limiting, and metadata. Contains all configuration needed to connect to a SIP provider for making and receiving calls.

​
id
string<uuid>
required

Unique identifier for these SIP credentials. Use this ID when configuring phone numbers or referencing these credentials in agent configurations.

​
orgId
string
required

Organization that owns these SIP credentials. Used for access control and resource isolation.

Minimum string length: 1
​
server
string
required

SIP server hostname or IP address with optional port, following RFC 3261 specifications. Specifies where to send SIP registration and call signaling.

Minimum string length: 1
​
transport
enum<string>
required

Transport protocol used for SIP signaling. Indicates whether this trunk uses UDP, TCP, or TLS for communication.

Available options:
udp,
tcp,
tls
​
source
enum<string>
required

Indicates how these credentials were created. 'manual' means user-entered credentials, 'provider' means automatically configured by a connected VoIP provider integration (such as Twilio).

Available options:
manual,
provider
​
createdTime
string<date-time>
required

Timestamp when these credentials were originally created.

​
lastUpdateTime
string<date-time>
required

Timestamp when these credentials were last modified. Updates when configuration changes are made.

​
domain
string | null

SIP domain for authentication realm as defined in RFC 3261. Used by some SIP providers as the authentication domain.

​
authUser
string | null

Authentication user identifier as defined in RFC 3261. Different providers may call this "username", "account", "user ID", or other names.

​
authPassword
string | null

Password for SIP authentication as defined in RFC 3261.

​
description
string | null

Human-readable description of these credentials. Helps identify which SIP provider or trunk these credentials represent.

​
cpsLimit
integer<int32> | null

Maximum calls per second allowed through this SIP trunk. Controls call pacing to prevent exceeding provider rate limits.

​
cpsKey
string | null

Shared rate limiting key for grouping multiple credentials under a common CPS limit. When set, multiple trunks with the same key share the rate limit.

​
providerId
string<uuid> | null

Reference to the VoIP provider that manages these credentials. Present only for provider-managed credentials where Source is 'provider'. When present, the provider handles credential lifecycle and configuration.