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

# Return hold verbs while a caller waits in a queue

> Internal jambonz `enqueue` wait-hook, polled every few seconds for every caller waiting in a contact-center queue. It returns the verbs to run for this tick: hold music, position or estimated-wait announcements, and an optional mid-queue keypress prompt, chosen from the caller's live queue position and the queue configuration. Signed with the jambonz webhook HMAC. Fails open with an empty verb array (the caller stays enqueued and the next tick retries) rather than dropping a live caller.



## OpenAPI

````yaml /openapi.yaml post /api/v1/jambonz/queue-wait
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/jambonz/queue-wait:
    post:
      summary: Return hold verbs while a caller waits in a queue
      description: >-
        Internal jambonz `enqueue` wait-hook, polled every few seconds for every
        caller waiting in a contact-center queue. It returns the verbs to run
        for this tick: hold music, position or estimated-wait announcements, and
        an optional mid-queue keypress prompt, chosen from the caller's live
        queue position and the queue configuration. Signed with the jambonz
        webhook HMAC. Fails open with an empty verb array (the caller stays
        enqueued and the next tick retries) rather than dropping a live caller.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                call_sid:
                  type: string
                  description: jambonz call SID of the queued leg.
                queue_position:
                  type: integer
                  description: The caller's 1-based position in the queue.
                queue_size:
                  type: integer
                  description: Total number of callers currently in the queue.
                queue_time:
                  type: number
                  description: Seconds the caller has waited so far.
            example:
              call_sid: 5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c
              queue_position: 3
              queue_size: 7
              queue_time: 42
      responses:
        '200':
          description: >-
            The jambonz verb array to run for this wait tick (hold music and/or
            an announcement). An empty array leaves the caller enqueued with no
            action this tick.
          content:
            application/json:
              schema:
                type: array
                description: jambonz verb array for this wait tick.
                items:
                  type: object
                  properties:
                    verb:
                      type: string
              example:
                - verb: play
                  url: https://assets.example/hold-music.mp3
                - verb: say
                  text: You are caller number 3. Estimated wait is about 2 minutes.
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_*)

````