Skip to main content
POST
Stage an inbound SIP call

Authorizations

X-Api-Key
string
header
required

The API Key created in Rounded Studio.

Query Parameters

sync
boolean
default:false

If true, block until the call is ready (status 'staged') or timeout.

Body

application/json

Request body for staging an inbound SIP call.

This endpoint is only supported for inbound calls. Staging pre-initializes the call (agent configuration, variables, and resources) before the actual inbound SIP call arrives, reducing cold-start latency to near zero.

Once staged, the inbound SIP call must include the header X-Rounded-Call-Id: <call_id> so it is routed to the staged call.

from_number
string
required

The caller's phone number in E.164 format.

Example:

"+33912345678"

to_number
string
required

The destination phone number in E.164 format.

Example:

"+33612345678"

agent_id
string<uuid>
required

The ID of the agent that will handle the call.

Example:

"411b82c8-462a-4e1b-89bc-10ab3ce1ed29"

dynamic_variables_values
Dynamic Variables Values · object | null

Initial variable values to inject into the agent conversation before it starts.

Response

Call staging initiated (async) or call staged and ready (sync)

Response from staging a SIP call.

The call_id is used to:

  • Poll GET /v1/calls/{call_id} to check when the status becomes staged (call ready).
  • Pass as the X-Rounded-Call-Id SIP header value when triggering the inbound call.
message
string
required
data
StageSipCallApiResponseData · object
required
error
ApiResponseError · object | null
Example:
status
integer
default:201