Get a caller ID

GET

/v1/voice/caller-ids/{caller_id}

const callerId = await bird.voice.callerIds.get("caller-id");
console.log(callerId.phone_number, callerId.status, callerId.verified_at);

caller_id = client.voice.caller_ids.get("caller-id")
print(caller_id.phone_number, caller_id.status, caller_id.verified_at)

callerID, err := client.Voice.CallerIDs.Get(context.Background(), "caller-id")
if err != nil {
	log.Fatal(err)
}
fmt.Println(callerID.PhoneNumber, callerID.Status, callerID.VerifiedAt)

$callerId = $bird->voice->callerIds->get('caller-id');
echo $callerId->getPhoneNumber(), ' ', $callerId->getStatus(), "\n";

bird voice caller-ids get <caller-id>

curl -X GET "https://us1.platform.bird.com/v1/voice/caller-ids/{caller_id}" \
  -H "Authorization: Bearer $TOKEN"

Odpowiedź200

{
  "id": "vci_01krdgeqcxet5s7t44vh8rt9mg",
  "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
  "phone_number": "+14155551234",
  "name": "Support line",
  "status": "pending",
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Returns the caller ID with the given ID, including its verification status.

Parametry

caller_id

string

Treść odpowiedzi

string

wymagane

Unique identifier for this caller ID.

workspace_id

string

wymagane

phone_number

string

wymagane

The phone number in E.164 format registered as a caller ID.

name

nullable string

wymagane

Your label for this caller ID, to tell several registered numbers apart. null when the caller ID has no label. It is yours to choose and appears nowhere on a call, so changing it never affects what the person you are calling sees. Set it with the caller ID update operation.

status

string

wymagane

Verification state of the caller ID.

pending: the number is registered but ownership has not yet been proven.
verified: the workspace completed the verification call, so the number can be presented as the outbound caller ID.
failed: terminal because the verification challenge expired or the attempt limit was exhausted. Use the dashboard to remove and register the caller ID again to retry.

Possible values (may grow over time): pending, verified, failed

verified_at

nullable string

wymagane

When the caller ID was verified. null when its status is pending or failed.

created_at

string

wymagane

updated_at

string

wymagane

Powiązane zasoby

Kontynuuj z dokumentacją, przewodnikami i przykładami dotyczącymi tego tematu. Zasoby są w języku angielskim.

Zrozum koncepcjęShould I use a Bird SDK or call the API directly?Podążaj ścieżką naukiBuild your first integration Przewodnik wdrożeniowySend your first email

Uzyskaj brief wdrożeniowy

const callerId = await bird.voice.callerIds.get("caller-id");
console.log(callerId.phone_number, callerId.status, callerId.verified_at);

caller_id = client.voice.caller_ids.get("caller-id")
print(caller_id.phone_number, caller_id.status, caller_id.verified_at)

callerID, err := client.Voice.CallerIDs.Get(context.Background(), "caller-id")
if err != nil {
	log.Fatal(err)
}
fmt.Println(callerID.PhoneNumber, callerID.Status, callerID.VerifiedAt)

$callerId = $bird->voice->callerIds->get('caller-id');
echo $callerId->getPhoneNumber(), ' ', $callerId->getStatus(), "\n";

bird voice caller-ids get <caller-id>

curl -X GET "https://us1.platform.bird.com/v1/voice/caller-ids/{caller_id}" \
  -H "Authorization: Bearer $TOKEN"

Odpowiedź200

{
  "id": "vci_01krdgeqcxet5s7t44vh8rt9mg",
  "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
  "phone_number": "+14155551234",
  "name": "Support line",
  "status": "pending",
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}