Get an available phone number

GET

/v1/numbers/available/{number}

// A number a carrier supplies is only on sale while the carrier still has it,
// so a 404 here means someone else took it.
const candidate = await bird.numbers.available.get("+447700900201");
console.log(candidate.country_code, candidate.capabilities);

# A number a carrier supplies is only on sale while the carrier still has
# it, so a 404 here means someone else took it.
candidate = client.numbers.available.get("+447700900201")
print(candidate.country_code, candidate.capabilities)

candidate, err := client.Numbers.Available.Get(context.Background(), "+447700900201")
if err != nil {
	log.Fatal(err)
}
fmt.Println(candidate.CountryCode)

// A number a carrier supplies is only on sale while the carrier still has it,
// so a 404 here means someone else took it.
$candidate = $bird->numbers->available->get('+447700900201');
echo $candidate->getCountryCode(), "\n";

bird numbers available get <number>

curl -X GET "https://us1.platform.bird.com/v1/numbers/available/{number}" \
  -H "Authorization: Bearer $TOKEN"

Antwort200

{
  "country_code": "US",
  "number_type": "mobile",
  "capabilities": [
    "sms"
  ]
}

Returns a single phone number available for purchase, whether it is already in inventory or can be acquired for you. Numbers supplied through a carrier remain available only while the carrier has them, so a number listed a moment ago may already be gone. A 404 means the number is currently unavailable for sale.

Parameter

number

string

Phone number in E.164 format. The leading + is optional.

Antwort-Payload

number

string

erforderlich

Phone number in E.164 format.

country_code

string

erforderlich

ISO 3166-1 alpha-2 country code.

number_type

string

erforderlich

Physical type of this phone number.

capabilities

array of string

erforderlich

Capabilities supported by this number.

ownership_registration_required

boolean

erforderlich

Whether ownership paperwork must be approved before outbound SMS and voice use. Customer availability accounts for organization exemptions; admin supplier searches report the general country and number-type requirement. You can acquire the number, including Bird stock, and submit paperwork afterward. Any setup fee is charged during purchase. Monthly billing starts at assignment even while approval is pending; assignment may follow completion of a pending supplier order.

Verwandte Ressourcen

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema. Die Ressourcen sind auf Englisch.

Das Konzept verstehenWhat is a virtual phone number (VMN)?Die Funktion erkundenSMS numbers ImplementierungsleitfadenNumber types

Implementierungs-Briefing erhalten

// A number a carrier supplies is only on sale while the carrier still has it,
// so a 404 here means someone else took it.
const candidate = await bird.numbers.available.get("+447700900201");
console.log(candidate.country_code, candidate.capabilities);

# A number a carrier supplies is only on sale while the carrier still has
# it, so a 404 here means someone else took it.
candidate = client.numbers.available.get("+447700900201")
print(candidate.country_code, candidate.capabilities)

candidate, err := client.Numbers.Available.Get(context.Background(), "+447700900201")
if err != nil {
	log.Fatal(err)
}
fmt.Println(candidate.CountryCode)

// A number a carrier supplies is only on sale while the carrier still has it,
// so a 404 here means someone else took it.
$candidate = $bird->numbers->available->get('+447700900201');
echo $candidate->getCountryCode(), "\n";

bird numbers available get <number>

curl -X GET "https://us1.platform.bird.com/v1/numbers/available/{number}" \
  -H "Authorization: Bearer $TOKEN"

Antwort200

{
  "country_code": "US",
  "number_type": "mobile",
  "capabilities": [
    "sms"
  ]
}