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

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

​
Usage Types

Phone numbers can be used by agents in two ways: Inbound (Linked Agent):
  • One agent can be linked to receive inbound calls on this number
  • Incoming calls are automatically routed to the linked agent
Outbound:
  • Multiple agents can use this number for making outbound calls
  • The number appears as caller ID when agents make calls
This endpoint returns all agents using the phone number for either inbound or outbound purposes.

Path Parameters

​
id
string<uuid>
required

Phone number identifier

Response

Returns affected agents successfully

Phone number and its associated agents that will be impacted by SIP configuration changes. Shows which agents use this phone number for inbound or outbound calls, helping you assess the impact before making changes.

​
id
string<uuid>
required

Unique identifier of the phone number configuration.

​
phoneNumber
string
required

Phone number that agents are using. Changes to this number's configuration will affect all listed agents.

Minimum string length: 1
​
affectedAgents
object[]
required

Agents using this phone number for inbound or outbound calls. Each agent entry indicates how they use the number (inbound routing, outbound calling, or both).