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

# Send an SMS

> Send an SMS message to an E.164 phone number.



## OpenAPI

````yaml /openapi.yaml post /api/v1/messages/sms
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
paths:
  /api/v1/messages/sms:
    post:
      tags:
        - Messages
      summary: Send an SMS
      description: Send an SMS message to an E.164 phone number.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - to
                - body
              properties:
                to:
                  type: string
                  minLength: 1
                  maxLength: 64
                  description: >-
                    Phone number. Accepts E.164 (preferred) or display formats
                    and PBX-extension suffixes (`x1234`, `;ext=1234`,
                    `,ext=1234`); normalized server-side to E.164 before send.
                body:
                  type: string
                  minLength: 1
                  maxLength: 1600
                  description: SMS body text
                webhook_url:
                  type: string
                  format: uri
                  description: DLR callback URL
                metadata:
                  type: object
                  additionalProperties: true
                  description: Custom key-value metadata
                test:
                  type: boolean
                  description: >-
                    When true, marks this send as a throwaway test. The provider
                    call still happens and billing still runs, but the recipient
                    is NOT auto-upserted into the contacts table. Use this for
                    dashboard 'Send Test SMS' flows to avoid polluting the
                    operator's contacts list with verification numbers.
                    TEST-USER P1 / DECISION —
                    TEST_SMS_NO_CONTACT_CREATE_2026_05_28.
                validity_period:
                  type: string
                  pattern: ^[1-9][0-9]*[smhd]?$
                  description: >-
                    Twilio ValidityPeriod parity. Carrier-level expiry hint
                    after which the SMSC drops the attempt. Suffixed grammar: s
                    (seconds, default), m (minutes), h (hours), d (days).
                    Examples: '30m', '1h', '24h', '2d'. Consumed by Telnyx
                    (valid_until), Jasmin (validity-period), and SMPP
                    (validity_period hours). GAP2_CPaaS_33.
                max_price:
                  type: number
                  minimum: 0
                  exclusiveMinimum: 0
                  maximum: 100
                  description: >-
                    Twilio MaxPrice parity. Hard per-message USD ceiling. The
                    send is rejected 422 MAX_PRICE_EXCEEDED if the resolved
                    per-unit cost exceeds this cap — useful as an anti-fraud
                    guard on international SMS to premium-rate destinations.
                    Capped at 100 USD per message to defend against units
                    mistakes. GAP2_CPaaS_33.
                fallback_from:
                  type: string
                  minLength: 1
                  maxLength: 64
                  description: >-
                    Twilio FallbackFrom parity. An optional secondary sender
                    identity recorded on the message as `metadata.fallback_from`
                    for audit and record-keeping. Same allowed shape as `from`
                    (E.164 / alphanumeric sender ID / `__shared_generic__`).
                    Audit-only: the value is stored on the message record and is
                    not currently auto-swapped in on a rejected attempt, so
                    treat it as a record of intent rather than an active
                    carrier-failover retry.
      responses:
        '202':
          description: SMS accepted for delivery
          content:
            application/json:
              schema:
                type: object
                description: SMS accepted for delivery
                properties:
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      id:
                        type: string
                      status:
                        type: string
                      channel:
                        type: string
                        enum:
                          - sms
                      from:
                        type:
                          - 'null'
                          - string
                      to:
                        type:
                          - 'null'
                          - string
                      body:
                        type:
                          - 'null'
                          - string
                      segments:
                        type:
                          - 'null'
                          - integer
                      price:
                        type:
                          - 'null'
                          - string
                          - number
                      currency:
                        type:
                          - 'null'
                          - string
                      external_id:
                        type:
                          - 'null'
                          - string
                      created_at:
                        type:
                          - 'null'
                          - string
                        format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: >-
                          Unique request identifier (also returned in
                          X-Request-Id header)
                      timestamp:
                        type: string
                        format: date-time
                        description: ISO 8601 UTC timestamp of the response
        '422':
          description: Default Response
          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
components:
  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_*)

````