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

# Open a hosted-messaging order

> Open a new hosted-messaging order to text-enable an existing landline, toll-free, or mobile number without porting it — the number's voice service stays with its current carrier. Supply the E.164 `phoneNumber`, the `voiceCarrier` of record, the `numberType`, and the `inboundRoute` that inbound SMS should be delivered to once the order is active. The order starts in `draft`; sign the LOA and submit it to progress. A second in-flight order for the same number is rejected. Requires the `numbers:write` scope.



## OpenAPI

````yaml /openapi.yaml post /api/v1/numbers/hosted-messaging
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/hosted-messaging:
    post:
      tags:
        - Numbers
      summary: Open a hosted-messaging order
      description: >-
        Open a new hosted-messaging order to text-enable an existing landline,
        toll-free, or mobile number without porting it — the number's voice
        service stays with its current carrier. Supply the E.164 `phoneNumber`,
        the `voiceCarrier` of record, the `numberType`, and the `inboundRoute`
        that inbound SMS should be delivered to once the order is active. The
        order starts in `draft`; sign the LOA and submit it to progress. A
        second in-flight order for the same number is rejected. Requires the
        `numbers:write` scope.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HostedMessagingCreate'
            example:
              phoneNumber: '+14155550123'
              voiceCarrier: AT&T
              numberType: landline
              businessName: Acme Inc
              inboundRoute:
                type: webhook
                target: https://hooks.example.com/inbound-sms
      responses:
        '201':
          description: The created hosted-messaging order (status `draft`).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/HostedMessagingOrder'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
components:
  schemas:
    HostedMessagingCreate:
      type: object
      required:
        - phoneNumber
        - voiceCarrier
        - numberType
        - inboundRoute
      additionalProperties: false
      description: Fields required to open a new hosted-messaging order.
      properties:
        phoneNumber:
          type: string
          description: >-
            E.164 number to text-enable (e.g. `+14155550123`). Its voice service
            stays with the current carrier.
        voiceCarrier:
          type: string
          minLength: 1
          maxLength: 200
          description: >-
            Carrier of record that keeps voice service for the number
            (informational).
        numberType:
          type: string
          enum:
            - landline
            - tollfree
            - mobile
          description: Number class the hosting carrier will text-enable.
        inboundRoute:
          $ref: '#/components/schemas/HostedMessagingInboundRoute'
        businessName:
          type: string
          minLength: 1
          maxLength: 200
          description: >-
            Business / brand name on the carrier-of-record account (used for LOA
            matching).
    HostedMessagingOrder:
      type: object
      description: A hosted-messaging ("text-enable") order stored for the organization.
      properties:
        id:
          type: string
        phoneNumber:
          type: string
          description: E.164 number being text-enabled.
        voiceCarrier:
          type: string
        numberType:
          type: string
          enum:
            - landline
            - tollfree
            - mobile
        status:
          type: string
          enum:
            - draft
            - loa_signed
            - submitted
            - active
            - rejected
            - cancelled
          description: Order lifecycle state.
        inboundRoute:
          $ref: '#/components/schemas/HostedMessagingInboundRoute'
        businessName:
          type: string
          nullable: true
        loaFileUrl:
          type: string
          nullable: true
          description: Signed URL of the signed LOA artefact, when attached.
        loaSignedAt:
          type: string
          format: date-time
          nullable: true
        submittedAt:
          type: string
          format: date-time
          nullable: true
        activatedAt:
          type: string
          format: date-time
          nullable: true
        rejectionReason:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    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
    HostedMessagingInboundRoute:
      type: object
      required:
        - type
        - target
      description: >-
        Delivery target for inbound SMS received on a hosted (text-enabled)
        number once the order is active. Inbound only — no outbound (MT) path is
        created.
      properties:
        type:
          type: string
          enum:
            - webhook
            - inbox
            - messaging_service
          description: Kind of destination the inbound message is routed to.
        target:
          type: string
          minLength: 1
          maxLength: 2048
          description: >-
            Route target — an https URL for `webhook`, or the id of the
            destination resource for `inbox` / `messaging_service`.
  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_*)

````