Get Phone Number Details - DialNexa Documentation

GET

organization-phone-numbers

{id}

Get Phone Number Details

curl --request GET \
  --url https://api.dialnexa.com/v1/organization-phone-numbers/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dialnexa.com/v1/organization-phone-numbers/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/organization-phone-numbers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/organization-phone-numbers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/organization-phone-numbers/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.dialnexa.com/v1/organization-phone-numbers/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/organization-phone-numbers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "phn_abc123",
  "phone_number": "+14155552671",
  "provider": "plivo",
  "status": "active",
  "country_code": "US",
  "nickname": "US Sales Line"
}

{
  "statusCode": 401,
  "message": "API key is missing or invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 403,
  "message": "You do not have permission to access this resource",
  "error": "Forbidden"
}

{
  "statusCode": 404,
  "message": "Phone number not found",
  "error": "Not Found"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "error": "Internal Server Error"
}

Read only

Recommended. This endpoint is part of the public /v1 API reference and is the supported path for new integrations. See the migration guide for versioning guidance.

Returns the full record for a single purchased phone number: the E.164 phone_number, the country_code, the type (local, toll-free, or mobile), the monthly rental cost, the supported capabilities (voice, SMS where available), the display nickname, the currently assigned inbound_agent_id, and the purchase timestamp.

When to use this

Number management UIs: render the per-number detail view in a phone-number management page.
Routing audits: verify which agent is currently handling inbound calls on a specific number before making changes.
Cost attribution: pull monthly_cost_usd to attribute telephony spend per workspace or per use case in internal reports.
Compliance reviews: confirm the number’s country and capabilities match the use case it is being used for.

For the entire portfolio of numbers on the workspace, use List Phone Numbers.

Path parameters

Parameter	Description
`id`	The phone number ID, for example `phn_f7w2kx5mb9qz`.

Errors

404 Not Found is returned when the number does not exist on this workspace.
403 Forbidden is returned when the API key cannot read phone number records.

List Phone Numbers: see every number on the workspace.
Search Available Numbers: find provider numbers available for purchase.
Link SIP Trunk: connect a bring-your-own number.
Buy a Phone Number: purchase a new number.
Delete Phone Number: remove this number from the workspace.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Phone number ID

Example:

"phn_abc123"

Response

Phone number returned successfully.

string

Example:

"phn_abc123"

phone_number

string

Example:

"+919876543210"

provider

string

status

string

Search Plivo NumbersSearch available phone numbers from Plivo.

Get Phone Number Details

curl --request GET \
  --url https://api.dialnexa.com/v1/organization-phone-numbers/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dialnexa.com/v1/organization-phone-numbers/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/organization-phone-numbers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/organization-phone-numbers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/organization-phone-numbers/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.dialnexa.com/v1/organization-phone-numbers/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/organization-phone-numbers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "phn_abc123",
  "phone_number": "+14155552671",
  "provider": "plivo",
  "status": "active",
  "country_code": "US",
  "nickname": "US Sales Line"
}

{
  "statusCode": 401,
  "message": "API key is missing or invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 403,
  "message": "You do not have permission to access this resource",
  "error": "Forbidden"
}

{
  "statusCode": 404,
  "message": "Phone number not found",
  "error": "Not Found"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "error": "Internal Server Error"
}

​When to use this

​Path parameters

​Errors

​Related endpoints

Authorizations

Path Parameters

Response

When to use this

Path parameters

Errors

Related endpoints