Vonage Video API

Vonage Video API (formerly OpenTok / TokBox) is a programmable live video platform for building real-time interactive video, voice, and messaging into apps. Its REST API on the Vonage Video Cloud creates sessions and drives advanced server-side features - recording (archives), live streaming broadcasts, signaling, SIP interconnect, and the Experience Composer render service - authenticated with JWT Bearer tokens.

6 APIs 0 Features

VideoWebRTCLive StreamingReal-Time CommunicationsCPaaS

APIs

Vonage Video Sessions API

Create video sessions, list and force-disconnect connections, mute streams and whole sessions, and migrate active sessions across media regions.

Vonage Video Streams & Signaling API

Inspect individual and all streams in a session, set stream classes and layout, and send server-side signals to a whole session or a single connection.

Vonage Video Archives API

Record sessions as composed or individual-stream archives - start, stop, list, retrieve, and delete archives, change archive layout, and select streams.

Vonage Video Broadcasts API

Broadcast a session to HLS and RTMP destinations - start, stop, list, and retrieve broadcasts, change broadcast layout, and select streams to include.

Vonage Video SIP & Render API

Dial PSTN/SIP endpoints into a session, play DTMF tones, start and stop live captions, and run the Experience Composer render service for custom layouts.

Vonage Video Webhooks API

Session monitoring, archive, broadcast, SIP, captions, and render callback events delivered to a registered URL, with secure (signed) callback verification.

Collections

Vonage Video API

OPEN

Pricing Plans

Vonage Video Plans Pricing

3 plans

PLANS

Rate Limits

Vonage Video Rate Limits

7 limits

RATE LIMITS

FinOps

Vonage Video Finops

FINOPS

Resources

👥

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Vonage Video API
  version: '2.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Sessions
    type: folder
  items:
  - info:
      name: Create session
      type: http
    http:
      method: POST
      url: https://video.api.vonage.com/session/create
      body:
        type: form
        data: archiveMode=manual&p2p.preference=disabled
    docs: Create a new Vonage Video session and return its session ID.
  - info:
      name: List connections
      type: http
    http:
      method: GET
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/session/{sessionId}/connection
    docs: List active connections in a session.
  - info:
      name: Force disconnect
      type: http
    http:
      method: DELETE
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/session/{sessionId}/connection/{connectionId}
    docs: Force a client to disconnect from a session.
  - info:
      name: Migrate session
      type: http
    http:
      method: POST
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/session/{sessionId}/migrate
    docs: Migrate an active session to a different media region.
- info:
    name: Streams & Signaling
    type: folder
  items:
  - info:
      name: List streams
      type: http
    http:
      method: GET
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/session/{sessionId}/stream
    docs: Get information on all streams in a session.
  - info:
      name: Get stream
      type: http
    http:
      method: GET
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/session/{sessionId}/stream/{streamId}
    docs: Get information on a single stream.
  - info:
      name: Signal session
      type: http
    http:
      method: POST
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/session/{sessionId}/signal
      body:
        type: json
        data: '{"type":"chat","data":"hello"}'
    docs: Send a signal to all connections in a session.
  - info:
      name: Mute session
      type: http
    http:
      method: POST
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/session/{sessionId}/mute
      body:
        type: json
        data: '{"active":true,"excludedStreamIds":[]}'
    docs: Mute all streams in a session.
- info:
    name: Archives
    type: folder
  items:
  - info:
      name: List archives
      type: http
    http:
      method: GET
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/archive
    docs: List archives for a project.
  - info:
      name: Start archive
      type: http
    http:
      method: POST
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/archive
      body:
        type: json
        data: '{"sessionId":"<string>","hasAudio":true,"hasVideo":true,"outputMode":"composed","resolution":"1280x720"}'
    docs: Start recording a session as a composed or individual-stream archive.
  - info:
      name: Stop archive
      type: http
    http:
      method: POST
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/archive/{archiveId}/stop
    docs: Stop a recording archive.
  - info:
      name: Get archive
      type: http
    http:
      method: GET
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/archive/{archiveId}
    docs: Get information on an archive.
  - info:
      name: Delete archive
      type: http
    http:
      method: DELETE
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/archive/{archiveId}
    docs: Delete an archive.
- info:
    name: Broadcasts
    type: folder
  items:
  - info:
      name: List broadcasts
      type: http
    http:
      method: GET
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/broadcast
    docs: List broadcasts for a project.
  - info:
      name: Start broadcast
      type: http
    http:
      method: POST
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/broadcast
      body:
        type: json
        data: '{"sessionId":"<string>","outputs":{"hls":{"dvr":false,"lowLatency":false}},"resolution":"1280x720","maxDuration":7200}'
    docs: Start a live streaming broadcast to HLS and/or RTMP destinations.
  - info:
      name: Stop broadcast
      type: http
    http:
      method: POST
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/broadcast/{broadcastId}/stop
    docs: Stop a live streaming broadcast.
- info:
    name: SIP & Render
    type: folder
  items:
  - info:
      name: Dial SIP
      type: http
    http:
      method: POST
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/dial
      body:
        type: json
        data: '{"sessionId":"<string>","token":"<jwt>","sip":{"uri":"sip:user@sip.example.com"}}'
    docs: Dial a SIP/PSTN endpoint into a session.
  - info:
      name: Play DTMF
      type: http
    http:
      method: POST
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/session/{sessionId}/play-dtmf
      body:
        type: json
        data: '{"digits":"1234#"}'
    docs: Play DTMF tones to all connections in a session.
  - info:
      name: Start render
      type: http
    http:
      method: POST
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/render
      body:
        type: json
        data: '{"sessionId":"<string>","token":"<jwt>","url":"https://example.com/composer","resolution":"1280x720"}'
    docs: Start an Experience Composer render.
  - info:
      name: Stop render
      type: http
    http:
      method: DELETE
      url: https://video.api.vonage.com/v2/project/{{applicationId}}/render/{renderId}
    docs: Stop an Experience Composer render.