Skip to main content
DELETE
/
api
/
v1
/
sip-phone-numbers
/
{id}
/
agent-link
Unlink phone number from agent
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://blackbox.dasha.ai/api/v1/sip-phone-numbers/{id}/agent-link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orgId": "<string>",
  "phoneNumber": "<string>",
  "credentialsId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdTime": "2023-11-07T05:31:56Z",
  "lastUpdateTime": "2023-11-07T05:31:56Z",
  "registrationStatus": {
    "state": "Disabled",
    "errorDescription": "<string>",
    "sipResponseMessage": "<string>",
    "lastUpdated": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "description": "<string>",
  "displayName": "<string>",
  "registration": true,
  "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "incomingCallsAgentId": "<string>"
}

​
After Unlinking

Once unlinked:
  • If mode=inbound: Inbound calls to this number will not be routed to any agent
  • If mode=replaceOutbound: The specified agent will no longer use this number for making outbound calls
  • The phone number becomes available to link to a different agent

Path Parameters

​
id
string<uuid>
required

Phone number identifier

Query Parameters

​
mode
enum<string>
default:inbound

Unlink mode: "inbound" for inbound call routing (default), "replaceOutbound" to remove from agent's outbound config Specifies the type of agent-phone number link operation.

Available options:
inbound,
replaceOutbound
​
agentId
string

Agent identifier (required for mode=replaceOutbound to specify which agent to unlink from)

Response

Phone number unlinked from agent successfully

SIP phone number configuration including associated credentials, caller ID settings, inbound routing, and registration status. Contains all information needed to use this number for making and receiving calls.

​
id
string<uuid>
required

Unique identifier for this phone number configuration. Use this ID when referencing the number in agent configurations or API calls.

​
orgId
string
required

Organization that owns this phone number. Used for access control and resource isolation.

Minimum string length: 1
​
phoneNumber
string
required

Phone number configured for outbound calling or inbound routing.

Minimum string length: 1
​
credentialsId
string<uuid>
required

SIP credentials used by this phone number. References the trunk configuration that handles authentication and routing for calls.

​
createdTime
string<date-time>
required

Timestamp when this phone number configuration was originally created.

​
lastUpdateTime
string<date-time>
required

Timestamp when this phone number configuration was last modified. Updates when settings like DisplayName, Registration, or IncomingCallsAgentId change.

​
registrationStatus
object
required

Current SIP registration status for this phone number. Indicates whether the number is successfully registered with the SIP provider and able to receive inbound calls.

​
description
string | null

Human-readable description of this phone number. Helps document the number's purpose or usage.

​
displayName
string | null

Display name shown in caller ID when making outbound calls with this number. Helps recipients identify the caller.

​
registration
boolean

Whether SIP registration is performed for this phone number. Some SIP providers require registration before making calls. Indicates if registration is enabled for this configuration.

​
providerId
string<uuid> | null

Reference to the VoIP provider that manages this phone number. Present only for provider-imported phone numbers. When present, the provider handles phone number lifecycle and trunk configuration.

​
incomingCallsAgentId
string | null

Agent that handles inbound calls to this phone number. When specified, incoming calls automatically route to this agent. When not set, inbound calls to this number are not answered.