AGagentphone
calls

Create Web Call

Create a browser-based web call.

Returns connection details that your frontend passes to the AgentPhone Web SDK (agentphone-web-sdk >= 0.2.0) to start the call in the browser. expiresAt is the access token's expiry as Unix epoch milliseconds. id identifies the AgentPhone call; callId identifies the media connection.

Flow:

  1. Validates the agent belongs to your account
  2. Creates a web call and returns its connection details
  3. Your client calls webClient.startCall({ accessToken, callId, transport, iceServers })
  4. Call lifecycle (transcripts, webhooks) works the same as phone calls
post/v1/calls/web

Request

  • Base URL
    https://api.agentphone.ai
  • URL
    https://api.agentphone.ai/v1/calls/web
  • Auth
    HTTP bearer

Request body

agentIdstring required

Agent ID to start the web call with

metadataobject nullable

Optional metadata to attach to the call

variablesobject nullable

Optional per-call dynamic variables. Values are substituted into {{var_name}} placeholders in the agent's system prompt and begin message at call time. Requires a hosted-mode agent.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 42 revisions of this API.