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

# Handle the outcome of a dial verb

> Internal jambonz action-hook fetched when a `dial` verb completes on a forwarded, ring-group, or queued inbound leg. The handler records the dial outcome (answered, busy, no-answer, failed) against the call log and dialer feedback, corrects the parent call's status, and returns the route's fallback verbs — typically voicemail — when the dial did not connect, or an empty verb array to hang up cleanly when it did. Signed with the jambonz webhook HMAC and not intended for direct client use. Bounded by a handler deadline and fails OPEN with a clean hangup so a transient fault never drops the caller mid-transaction.



## OpenAPI

````yaml /openapi.yaml post /api/v1/jambonz/dial-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/jambonz/dial-status:
    post:
      summary: Handle the outcome of a dial verb
      description: >-
        Internal jambonz action-hook fetched when a `dial` verb completes on a
        forwarded, ring-group, or queued inbound leg. The handler records the
        dial outcome (answered, busy, no-answer, failed) against the call log
        and dialer feedback, corrects the parent call's status, and returns the
        route's fallback verbs — typically voicemail — when the dial did not
        connect, or an empty verb array to hang up cleanly when it did. Signed
        with the jambonz webhook HMAC and not intended for direct client use.
        Bounded by a handler deadline and fails OPEN with a clean hangup so a
        transient fault never drops the caller mid-transaction.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                call_sid:
                  type: string
                  description: jambonz call SID of the parent leg.
                dial_call_status:
                  type: string
                  description: >-
                    Outcome of the dial (`completed`, `busy`, `no-answer`,
                    `failed`).
                dial_sip_status:
                  type: integer
                  description: Final SIP response code of the dialed leg.
                dial_call_duration:
                  type: number
                  description: Duration of the dialed leg in seconds.
            example:
              call_sid: 5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c
              dial_call_status: no-answer
              dial_sip_status: 480
      responses:
        '200':
          description: >-
            The jambonz fallback verbs to run when the dial did not connect
            (e.g. voicemail), or an empty array to end the call cleanly when it
            was answered.
          content:
            application/json:
              schema:
                type: array
                description: jambonz verb array.
                items:
                  type: object
                  properties:
                    verb:
                      type: string
              example:
                - verb: say
                  text: >-
                    The party you called is unavailable. Please leave a message
                    after the tone.
                - verb: record
                  action_hook: /api/v1/jambonz/ivr-record-finalize
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_*)

````