Prospect Simulation

Mint a live observer WebSocket URL for a prospect call

Changed on

Public endpoint scoped by the report token. Returns a short-lived, self-authenticating WebSocket URL for watching a prospect call live, but only while that call is actually in flight; otherwise wsUrl is null. Pass callId (from the live progress list) to pick one of the parallel calls; without it the most recently started live call is used.

get/v1/public/prospect-sim/report/{token}/observer-url

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/public/prospect-sim/report/{token}/observer-url
  • Auth
    HTTP bearer

Path parameters

tokenstring required

Query parameters

callIdstring uuid

Response

The live observer URL, or null when not currently watchable

Changes