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

# Claim the next preview-mode contact for an agent

> Hands the agent frontend the next contact to review for a preview-mode campaign, atomically claiming it so two agents polling concurrently never receive the same number and double-dial. Returns the claimed contact plus the per-campaign decision countdown, `204 No Content` for progressive / predictive / agentless campaigns (their calls are originated automatically by the pacing engine), or `404` when the campaign is not active. The agent then reviews the contact and launches the call via `POST /api/v1/dialer/dial`.



## OpenAPI

````yaml /openapi.yaml get /api/v1/dialer/next-call
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/dialer/next-call:
    get:
      tags:
        - Dialer
      summary: Claim the next preview-mode contact for an agent
      description: >-
        Hands the agent frontend the next contact to review for a preview-mode
        campaign, atomically claiming it so two agents polling concurrently
        never receive the same number and double-dial. Returns the claimed
        contact plus the per-campaign decision countdown, `204 No Content` for
        progressive / predictive / agentless campaigns (their calls are
        originated automatically by the pacing engine), or `404` when the
        campaign is not active. The agent then reviews the contact and launches
        the call via `POST /api/v1/dialer/dial`.
      parameters:
        - schema:
            type: string
          in: query
          name: campaign_id
          required: false
          description: The active preview-mode campaign to claim the next contact from.
      responses:
        '200':
          description: >-
            The claimed preview contact (or `contact: null` when none are
            currently eligible) plus the agent decision countdown.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  The claimed preview contact (or `contact: null` when none are
                  currently eligible) plus the agent decision countdown.
                properties:
                  data:
                    type: object
                    properties:
                      contact:
                        type:
                          - object
                          - 'null'
                        description: >-
                          The claimed contact, or null when no eligible contact
                          is currently available.
                        properties:
                          id:
                            type: string
                            description: >-
                              Dialer list-contact id (pass this as `contact_id`
                              when dialing).
                          phone_e164:
                            type: string
                            description: Destination number in E.164 format.
                          display_name:
                            type:
                              - string
                              - 'null'
                            description: >-
                              Contact display name for the agent's screen-pop,
                              when known.
                          contact_id:
                            type:
                              - string
                              - 'null'
                            description: >-
                              Linked CRM contact id, when the list row resolves
                              to a contact.
                          attempts:
                            type: integer
                            description: >-
                              Number of dial attempts already made against this
                              contact.
                      preview_decision_seconds:
                        type: integer
                        description: >-
                          Seconds the agent has to decide before the claim is
                          auto-skipped (per-campaign override, else the platform
                          default).
                      decision_expires_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: >-
                          Server-side wall-clock time at which the claim
                          auto-skips; null when no contact was claimed.
                  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
        '204':
          description: >-
            No agent-claimable work — the campaign is progressive / predictive /
            agentless, so the pacing engine originates its calls automatically.
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_*)

````