Create a number order
/v1/numbers/ordersconst order = await bird.numbers.orders.create({ number: "+447700900201" });
// Most orders finish inside the request. One that has to wait on a carrier
// comes back without a number_id. Poll it until it is completed or failed.
if (order.status === "completed") {
console.log("allocated as", order.number_id);
} else {
console.log("still", order.status, "; poll", order.id);
}order = client.numbers.orders.create(number="+447700900201")
# Most orders finish inside the request. One that has to wait on a carrier
# comes back without a number_id. Poll it until completed or failed.
if order.status == "completed":
print("allocated as", order.number_id)
else:
print("still", order.status, "; poll", order.id)order, err := client.Numbers.Orders.Create(context.Background(), bird.NumbersOrdersCreateParams{
Number: "+447700900201",
})
if err != nil {
log.Fatal(err)
}
// An order that has to wait on a carrier comes back without a NumberId.
// Poll it until it is completed or failed.
fmt.Println(order.Status, order.Id)$order = $bird->numbers->orders->create(
(new NumbersOrderCreate())->setNumber('+447700900201'),
);
// Most orders finish inside the request. One that has to wait on a carrier
// comes back without a number_id. Poll it until it is completed or failed.
if ($order->getStatus() === 'completed') {
echo 'allocated as ', $order->getNumberId(), "\n";
} else {
echo 'still ', $order->getStatus(), '; poll ', $order->getId(), "\n";
}bird numbers orders create --number +18005550100 --reference STORE-042curl -X POST "https://us1.platform.bird.com/v1/numbers/orders" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"number": "+18005550100",
"reference": "STORE-042"
}'{
"id": "nor_01krdgeqcxet5s7t44vh8rt9mg",
"country_code": "US",
"number_type": "mobile",
"status": "charging",
"number_id": "nda_01krdgeqcxet5s7t44vh8rt9mg"
}
Orders a number for your workspace and starts its monthly charge. Pass a
number from GET /v1/numbers/available. Whether the number is already in
inventory or acquired from a supplier, the response contains an order.
Most orders complete immediately and return 201 with status of
completed and number_id populated. Read the number with
GET /v1/numbers/{number_id}. An order that cannot complete in the request
returns 202; poll GET /v1/numbers/orders/{order_id} until it is
completed or failed.
A 412 means required identity verification is incomplete or organization
eligibility prevents the purchase. Follow the error's recovery guidance:
complete missing verification, or contact support about an eligibility review
or denial. An eligibility assessment still in progress returns 503; retry later.
Request Payload
numberThe number to acquire, in E.164 format, as returned by GET /v1/numbers/available.
referenceYour own reference to set on the number when this purchase completes. Leading and trailing whitespace is removed. A pending order keeps the reference until the number is allocated.
Response Payload
idIdentifier of this purchase order.
numberThe number being acquired, in E.164 format.
country_codenumber_typePhysical type of the number being acquired.
statusnumber_idIdentifier of the number this order produced, set when status is completed. Pass it as number_id to GET /v1/numbers/{number_id} or DELETE /v1/numbers/{number_id}. null until the order completes.
failure_reasonHuman-readable reason the purchase failed. null unless status is failed. An order can fail some time after it was created, so updated_at tells you when the failure was recorded rather than when the order was placed.
completed_atWhen the purchase completed and the number became owned (status completed). null for orders still in progress or failed.
created_atupdated_atRelated resources
Continue with the documentation, guides and examples for this topic.