> ## Documentation Index > Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt > Use this file to discover all available pages before exploring further. # Reserve a batch of numbers from a filter > Discover and hold up to 1000 DIDs matching a country / area-code / number-type / capability filter for 15 minutes, then either finalize (purchase, bill, and route) or cancel (release) the batch. Use this when you want the platform to find a block for you rather than posting a pre-built list of E.164s to `/numbers/buy-bulk`. It polls DIDWW and Telnyx (and platform inventory when `provider` is unset) and picks the cheapest N; partial holds are returned so you can compare `reserved_count` against the requested quantity. Inbound DID provisioning only (invariant #45 untouched). Requires the `numbers:write` scope. ## OpenAPI ````yaml /openapi.yaml post /api/v1/numbers/bulk-reserve openapi: 3.1.0 info: title: Devotel CPaaS API description: Orbit by Devotel — Communications Platform as a Service API version: 1.0.0 contact: name: Devotel url: https://devotel.io email: support@devotel.io license: name: Proprietary servers: - url: https://api.orbit.devotel.io description: Production security: - Bearer: [] - ApiKey: [] tags: - name: Messages description: >- Send and manage messages across all channels (SMS, WhatsApp, RCS, Email, Viber, etc.) - name: Fax description: >- List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers (sending flows through the Messaging API) - name: Agents description: AI agent creation, configuration, and execution - name: Voice description: Voice calls, IVR, conferencing, and SIP trunking - name: OnCall description: On-call rotations and escalation policy planning for incident alerting - name: Webhooks description: Webhook endpoint management and delivery logs - name: Numbers description: Phone number search, provisioning, and configuration - name: Brand Identity description: >- Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp, RCS, branded calling, number KYC) - name: Contacts description: Contact management, segmentation, and lifecycle tracking - name: Campaigns description: Marketing campaign orchestration and analytics - name: Flows description: Automation flow builder and execution engine - name: Templates description: Message template management and approval workflows - name: Settings description: Organization, channel, and user preference settings - name: Verify description: OTP generation and verification across channels - name: Push description: Push notification delivery via FCM and APNs - name: Integrations description: Third-party service connections and OAuth management - name: CDP description: >- Customer Data Platform — activation surface (CRM object sync, streaming destinations, ad-audience activation) - name: Files description: >- Server-to-server media upload, listing, retrieval, and deletion (signed-URL backed) - name: Commerce description: >- Omnichannel conversational-commerce — persistent cart + checkout state machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout, and AP2-style agent payment mandates. - name: Sync description: >- Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps, Lists, and ephemeral Streams, with change events relayed over the /api/v1/ws/sync WebSocket gateway - name: Risk description: >- Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping, URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one composite verdict queryable before a send or a call. - name: Orby description: >- In-dashboard Orby operator assistant: streamed assistant turns, conversation threads, product knowledge-base search, and the tool-action approval gate. Available to signed-in operators only (dashboard session auth — API-key requests are rejected). paths: /api/v1/numbers/bulk-reserve: post: tags: - Numbers summary: Reserve a batch of numbers from a filter description: >- Discover and hold up to 1000 DIDs matching a country / area-code / number-type / capability filter for 15 minutes, then either finalize (purchase, bill, and route) or cancel (release) the batch. Use this when you want the platform to find a block for you rather than posting a pre-built list of E.164s to `/numbers/buy-bulk`. It polls DIDWW and Telnyx (and platform inventory when `provider` is unset) and picks the cheapest N; partial holds are returned so you can compare `reserved_count` against the requested quantity. Inbound DID provisioning only (invariant #45 untouched). Requires the `numbers:write` scope. requestBody: required: true content: application/json: schema: type: object required: - country - quantity properties: country: type: string minLength: 2 maxLength: 2 description: ISO 3166-1 alpha-2 country code. area_code: type: string description: Optional area-code / prefix filter (2–5 digits). number_type: type: string enum: - local - mobile - toll_free default: local quantity: type: integer minimum: 1 maximum: 1000 name_pattern: type: string description: Optional digit-only pattern to match within the number. pattern_type: type: string enum: - contains - starts_with - ends_with default: contains capabilities: type: string description: Comma-separated capability filter (e.g. `sms,voice`). provider: type: string enum: - devotel - telnyx - didww compliance_profile_id: type: string example: country: US area_code: '415' number_type: local quantity: 10 capabilities: sms,voice responses: '201': description: The created reservation with its held items (15-minute TTL). content: application/json: schema: type: object properties: data: type: object properties: reservation_id: type: string status: type: string description: Reservation state (e.g. `ready`, `partial`, `failed`). expires_at: type: string format: date-time requested_quantity: type: integer reserved_count: type: integer total_cost_cents: type: integer items: type: array items: $ref: '#/components/schemas/NumberReservationItem' meta: $ref: '#/components/schemas/ResponseMeta' example: data: reservation_id: numberReservation_01J9Z8ABCDEF status: ready expires_at: '2026-08-11T12:15:00Z' requested_quantity: 10 reserved_count: 10 total_cost_cents: 1000 items: - id: nri_01J9Z8ABCDEF phone_number: '+14155550100' provider: devotel country_code: US monthly_cost_cents: 100 status: reserved meta: request_id: req_01J9Z8ABCDEF timestamp: '2026-08-11T12:00:00Z' '422': $ref: '#/components/responses/StandardError' components: schemas: NumberReservationItem: type: object description: One held DID within a bulk number reservation. properties: id: type: string reservation_id: type: string phone_number: type: string description: E.164 number held for this item. provider: type: string provider_row_id: type: string nullable: true country_code: type: string number_type: type: string nullable: true capabilities: type: array items: type: string monthly_cost_cents: type: integer status: type: string enum: - reserved - purchased - failed - released purchased_number_id: type: string nullable: true description: >- Owned phone-number record id created on finalize (null until purchased). error_code: type: string nullable: true error_message: type: string nullable: true ResponseMeta: type: object required: - request_id - timestamp additionalProperties: false properties: request_id: type: string description: Unique request identifier (also returned as X-Request-Id header) timestamp: type: string format: date-time docs_url: type: string format: uri nullable: true responses: StandardError: description: >- Standard error envelope. `error.code` is machine-readable; see the [error reference](https://docs.orbit.devotel.io/reference/error-codes) for the catalogue. content: application/json: schema: type: object properties: error: type: object required: - code - message - status properties: code: type: string description: Machine-readable error code (e.g. INVALID_PHONE_NUMBER) message: type: string description: Human-readable error description status: type: integer description: HTTP status code details: type: object additionalProperties: true description: Additional context about the error meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri description: Link to relevant error documentation securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT description: Dashboard JWT token from Clerk ApiKey: type: apiKey name: X-API-Key in: header description: Server-to-server API key (dv_live_sk_*) ````