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

# Escalate voice call to video

> Elevates a live voice call into a video room ("move to video"). Creates a room stamped with the originating call SID, returns the agent's host join token and media URL, and issues a public guest invite link for the remote party. Optionally delivers that link to the remote party by SMS. Returns 201.



## OpenAPI

````yaml /openapi.yaml post /api/v1/voice/call-escalation/video
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/voice/call-escalation/video:
    post:
      tags:
        - Voice
      summary: Escalate voice call to video
      description: >-
        Elevates a live voice call into a video room ("move to video"). Creates
        a room stamped with the originating call SID, returns the agent's host
        join token and media URL, and issues a public guest invite link for the
        remote party. Optionally delivers that link to the remote party by SMS.
        Returns 201.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - callSid
              additionalProperties: false
              properties:
                callSid:
                  type: string
                  minLength: 1
                  maxLength: 128
                  description: >-
                    The live call leg being elevated. Stamped onto the created
                    room so it stays traceable back to the originating call.
                callLogId:
                  type: string
                  minLength: 1
                  maxLength: 64
                  description: >-
                    Optional call-log identifier, used to correlate the room
                    back to the originating call.
                remotePartyNumber:
                  type: string
                  maxLength: 32
                  pattern: ^\+?[0-9]*$
                  description: >-
                    E.164 number of the remote leg — used for room naming and,
                    when `notifyRemoteParty` is true, the SMS notification
                    destination.
                remotePartyName:
                  type: string
                  maxLength: 120
                  description: >-
                    Display name of the remote leg (shown in the generated room
                    name when present).
                roomName:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: >-
                    Optional override for the created room's name (defaults to
                    `Call with <remote party>`).
                notifyRemoteParty:
                  type: boolean
                  default: false
                  description: >-
                    When true, sends the guest join link to `remotePartyNumber`
                    by SMS. Requires `remotePartyNumber` and `sipCredentialId`.
                sipCredentialId:
                  type: string
                  minLength: 1
                  maxLength: 64
                  description: >-
                    SIP credential (extension) the notification SMS is sent
                    FROM. Required only when `notifyRemoteParty` is true.
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: object
                    required:
                      - call_sid
                      - room_id
                      - room_sid
                      - host
                      - guest
                      - remote_party_notification
                    properties:
                      call_sid:
                        type: string
                        description: The originating call SID.
                      room_id:
                        type: string
                        description: The created video room id.
                      room_sid:
                        type: string
                        description: The created video room SID.
                      host:
                        type: object
                        required:
                          - token
                          - ws_url
                          - identity
                        description: >-
                          Host (agent) join material — connect the local UA
                          directly.
                        properties:
                          token:
                            type: string
                            description: Host join token.
                          ws_url:
                            type: string
                            description: Media server WebSocket URL.
                          identity:
                            type: string
                            description: Host participant identity.
                      guest:
                        type: object
                        required:
                          - invite_token
                          - join_url
                          - expires_at
                        description: Remote-party guest join material.
                        properties:
                          invite_token:
                            type: string
                            description: Guest invite token.
                          join_url:
                            type: string
                            description: Public guest join URL for the remote party.
                          expires_at:
                            type: string
                            format: date-time
                            description: When the guest invite expires.
                      remote_party_notification:
                        type: string
                        enum:
                          - sent
                          - failed
                          - not_requested
                        description: >-
                          Outcome of the optional remote-party SMS notification.
                          `not_requested` when `notifyRemoteParty` was
                          omitted/false; `failed` is non-blocking (the agent
                          still receives the guest link).
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
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_*)

````