Phone numbers
Get a bulk order by id
Retrieve the status of a bulk order created with
POST /v1/phone-numbers/bulk.
Orders that belong to another organization return 404 NOT_FOUND. Once
an order reaches a terminal status (complete, partial, or failed),
pending_count is 0; failed_count is populated on partial and
failed orders.
Requires the numbers:read scope.
AuthorizationBearer <token>
Authenticate by sending your API key as a bearer token:
Authorization: Bearer am_live_.... Every request is automatically
scoped to the organization that owns the key and to the scopes granted
to that key.
In: header
Path Parameters
id*string
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/phone-numbers/bulk/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"success": true,
"data": {
"order_id": "f3a5b1c2-4d8e-4a91-9c3a-7b6e1d0f2a3b",
"status": "complete",
"quantity": 100,
"assigned_count": 100,
"pending_count": 0,
"assigned_numbers": [
"+14155557001",
"+14155557002"
]
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "validation failed",
"request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM",
"details": {
"to": "must be E.164",
"body": "must be 1..1600 chars"
}
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "authentication failed",
"request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "missing required scope",
"request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "not found",
"request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
}
}