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

# Get per-channel frequency-cap status for a contact

> Return a per-channel frequency-cap snapshot for a contact so the composer can show how many sends remain before the operator hits Send, instead of discovering the cap from a 429 afterwards. For each requested channel it reports whether an addressable identifier exists, the contact's consent state, and every cap that applies with its window, max count, current in-window count, sends remaining and the next time a slot re-opens. Pass `?channels=sms,email,voice` to scope the read; omit it to read every supported channel.



## OpenAPI

````yaml /openapi.yaml get /api/v1/contacts/{id}/cap-status
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/contacts/{id}/cap-status:
    get:
      tags:
        - Contacts
      summary: Get per-channel frequency-cap status for a contact
      description: >-
        Return a per-channel frequency-cap snapshot for a contact so the
        composer can show how many sends remain before the operator hits Send,
        instead of discovering the cap from a 429 afterwards. For each requested
        channel it reports whether an addressable identifier exists, the
        contact's consent state, and every cap that applies with its window, max
        count, current in-window count, sends remaining and the next time a slot
        re-opens. Pass `?channels=sms,email,voice` to scope the read; omit it to
        read every supported channel.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
        - schema:
            type: string
          in: query
          name: channels
          required: false
          description: >-
            Optional CSV of channels to scope the read (e.g. sms,email,voice).
            Defaults to all supported channels.
      responses:
        '200':
          description: The per-channel frequency-cap and consent snapshot.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      contact_id:
                        type: string
                      requested_channels:
                        type: array
                        items:
                          type: string
                      channels:
                        type: object
                        additionalProperties: true
                      cache_degraded:
                        type: boolean
                      generated_at:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
              example:
                data:
                  contact_id: contact_01HZX8Y7QJK4M
                  requested_channels:
                    - sms
                    - email
                  channels:
                    sms:
                      recipient: '+14155552671'
                      identifier_present: true
                      consent_state: opted_in
                      cache_degraded: false
                      slots:
                        - cap_id: cap_01HZX8
                          scope: channel
                          channel: sms
                          window_seconds: 86400
                          max_count: 3
                          current_count: 1
                          sends_remaining: 2
                          applies_to_categories:
                            - marketing
                          next_slot_at: null
                    email:
                      recipient: jane@example.com
                      identifier_present: true
                      consent_state: unknown
                      cache_degraded: false
                      slots: []
                  cache_degraded: false
                  generated_at: '2026-02-02T12:00:00.000Z'
                meta:
                  request_id: req_01HZX9MNOPQR
                  timestamp: '2026-02-02T12:00:00.000Z'
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_*)

````