Skip to main content
GET
/
api
/
v1
/
sip-credentials
/
{id}
/
affected-agents
Get agents using SIP credential
const options = {method: 'GET'};

fetch('https://blackbox.dasha.ai/api/v1/sip-credentials/{id}/affected-agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "phoneNumbers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phoneNumber": "<string>",
      "affectedAgents": [
        {
          "agentId": "<string>",
          "agentName": "<string>",
          "uses": []
        }
      ]
    }
  ],
  "affectedCallsCount": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.blackbox.dasha.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Response Information

This endpoint returns:
  • Agents grouped by phone number: Shows which agents use each phone number for inbound/outbound calls
  • Queued calls count: Number of calls currently in queue that use phone numbers with these credentials

​
Relationship Hierarchy

SIP credentials are used through this hierarchy:
  1. SIP Credentials → authenticate with SIP trunk provider
  2. Phone Numbers → use credentials to enable calling
  3. Agents → use phone numbers for inbound/outbound calls

​
Use Cases

  • Before updating credentials: Check which agents and queued calls will be affected
  • Before deleting credentials: Understand the full impact on agents and active operations
  • Troubleshooting: Identify all resources using a specific SIP provider

Path Parameters

​
id
string<uuid>
required

Credential identifier

Response

Returns affected agents and queued calls count successfully

Impact analysis showing which agents and scheduled calls will be affected by changes to SIP credentials. Organized by phone numbers that use these credentials, helping you understand the scope of impact before modifying or deleting trunk configuration.

​
phoneNumbers
object[]
required

Phone numbers configured to use these SIP credentials, along with the agents using each number. Changes to the credentials will affect all calls made through these phone numbers and their associated agents.

​
affectedCallsCount
integer<int32>
required

Number of scheduled calls that explicitly reference these credentials via OverrideOutboundConfig. These calls have overridden their agent's default SIP configuration to use these specific credentials.