const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://blackbox.dasha.ai/api/v1/sip-phone-numbers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://blackbox.dasha.ai/api/v1/sip-phone-numbers/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://blackbox.dasha.ai/api/v1/sip-phone-numbers/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"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>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Get phone number
Retrieves a specific SIP phone number by its unique identifier including linked agent information if applicable.
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://blackbox.dasha.ai/api/v1/sip-phone-numbers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://blackbox.dasha.ai/api/v1/sip-phone-numbers/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://blackbox.dasha.ai/api/v1/sip-phone-numbers/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"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>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Path Parameters
Phone number identifier
Response
Returns phone number 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.
Unique identifier for this phone number configuration. Use this ID when referencing the number in agent configurations or API calls.
Organization that owns this phone number. Used for access control and resource isolation.
1Phone number configured for outbound calling or inbound routing.
1SIP credentials used by this phone number. References the trunk configuration that handles authentication and routing for calls.
Timestamp when this phone number configuration was originally created.
Timestamp when this phone number configuration was last modified. Updates when settings like DisplayName, Registration, or IncomingCallsAgentId change.
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.
Show child attributes
Show child attributes
Human-readable description of this phone number. Helps document the number's purpose or usage.
Display name shown in caller ID when making outbound calls with this number. Helps recipients identify the caller.
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.
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.
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.
Was this page helpful?