> ## 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 a WhatsApp message

> Send a WhatsApp text, template, or media message. Outside Meta's 24h re-engagement window only `template` type is permitted; the API rejects freeform text/media with 422 in that case.



## OpenAPI

````yaml /openapi.yaml post /api/v1/messages/whatsapp
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/whatsapp:
    post:
      tags:
        - Messages
      summary: Send a WhatsApp message
      description: >-
        Send a WhatsApp text, template, or media message. Outside Meta's 24h
        re-engagement window only `template` type is permitted; the API rejects
        freeform text/media with 422 in that case.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - to
                - type
              properties:
                to:
                  type: string
                  description: >-
                    E.164 phone number OR WhatsApp Business Solution UID (5-130
                    alphanumeric chars).
                from:
                  type: string
                  minLength: 1
                  maxLength: 64
                  description: Sender E.164 (overrides default WABA number).
                type:
                  type: string
                  enum:
                    - text
                    - template
                    - image
                    - document
                    - audio
                    - video
                    - location
                    - contact
                text:
                  type: object
                  properties:
                    body:
                      type: string
                      minLength: 1
                      maxLength: 4096
                  required:
                    - body
                template:
                  type: object
                  properties:
                    name:
                      type: string
                    language:
                      type: object
                      properties:
                        code:
                          type: string
                          default: en
                      required:
                        - code
                    components:
                      type: array
                      items:
                        type: object
                  required:
                    - name
                    - language
                media:
                  type: object
                  properties:
                    url:
                      type: string
                      format: uri
                    caption:
                      type: string
                    filename:
                      type: string
                  required:
                    - url
                webhook_url:
                  type: string
                  format: uri
                metadata:
                  type: object
                  additionalProperties:
                    type: string
                scheduled_at:
                  type: string
                  format: date-time
      responses:
        '202':
          description: Message accepted for delivery (whatsapp)
          content:
            application/json:
              schema:
                type: object
                description: Message accepted for delivery (whatsapp)
                properties:
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      id:
                        type: string
                        description: Devotel message id
                      status:
                        type: string
                        description: >-
                          Lifecycle state at acceptance time (queued | scheduled
                          | sent)
                      channel:
                        type: string
                        enum:
                          - whatsapp
                      from:
                        type:
                          - 'null'
                          - string
                      to:
                        type:
                          - 'null'
                          - string
                      body:
                        type:
                          - 'null'
                          - string
                      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
        '403':
          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
        '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_*)

````