> ## 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.

# Buy multiple phone numbers in one request

> Purchase up to 50 already-selected phone numbers in a single call, with an up-front wallet check against the summed per-number cost. Partial success is expected: provisioned numbers are returned in `succeeded[]` and per-row carrier failures in `failed[]` (a failed row is never charged), and the response is 200 even when every row fails — inspect `succeeded` to decide the UI state. The result is also persisted as a pollable order record (`GET /numbers/orders/{id}`) so partial fulfillment can be audited later. Inbound DID provisioning only (invariant #45 untouched). Requires the `numbers:write` scope.



## OpenAPI

````yaml /openapi.yaml post /api/v1/numbers/buy-bulk
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/buy-bulk:
    post:
      tags:
        - Numbers
      summary: Buy multiple phone numbers in one request
      description: >-
        Purchase up to 50 already-selected phone numbers in a single call, with
        an up-front wallet check against the summed per-number cost. Partial
        success is expected: provisioned numbers are returned in `succeeded[]`
        and per-row carrier failures in `failed[]` (a failed row is never
        charged), and the response is 200 even when every row fails — inspect
        `succeeded` to decide the UI state. The result is also persisted as a
        pollable order record (`GET /numbers/orders/{id}`) so partial
        fulfillment can be audited later. Inbound DID provisioning only
        (invariant #45 untouched). Requires the `numbers:write` scope.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - items
              properties:
                items:
                  type: array
                  minItems: 1
                  maxItems: 50
                  items:
                    type: object
                    required:
                      - phone_number
                    properties:
                      phone_number:
                        type: string
                        description: E.164 number to purchase.
                      country_code:
                        type: string
                        minLength: 2
                        maxLength: 2
                        default: US
                      provider:
                        type: string
                        enum:
                          - devotel
                          - telnyx
                          - didww
                        description: Optional provider pin; omit to let the platform route.
                compliance_profile_id:
                  type: string
                  description: Compliance profile applied to every item that needs one.
            example:
              items:
                - phone_number: '+14155550100'
                  country_code: US
                - phone_number: '+14155550101'
                  country_code: US
              compliance_profile_id: cmpl_01J9Z8ABCDEF
      responses:
        '200':
          description: >-
            Per-row purchase outcome (200 even on partial or total failure —
            inspect `succeeded`/`failed`).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      order_id:
                        type: string
                        nullable: true
                        description: >-
                          Pollable bulk-order record id (null only if
                          persistence degraded).
                      succeeded:
                        type: array
                        items:
                          type: object
                          additionalProperties: true
                      failed:
                        type: array
                        items:
                          type: object
                          properties:
                            phone_number:
                              type: string
                            error:
                              type: object
                              properties:
                                code:
                                  type: string
                                message:
                                  type: string
                      total_cost_cents:
                        type: integer
                      debited_cents:
                        type: integer
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
              example:
                data:
                  order_id: numOrder_01J9Z8ABCDEF
                  succeeded:
                    - id: num_01J9Z8ABCDEF
                      phone_number: '+14155550100'
                  failed:
                    - phone_number: '+14155550101'
                      error:
                        code: CARRIER_UNAVAILABLE
                        message: Number no longer available
                  total_cost_cents: 200
                  debited_cents: 100
                meta:
                  request_id: req_01J9Z8ABCDEF
                  timestamp: '2026-08-11T12:00:00Z'
        '402':
          $ref: '#/components/responses/StandardError'
        '422':
          $ref: '#/components/responses/StandardError'
components:
  schemas:
    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_*)

````