Skip to main content
POST
Simulate voice call

Authorizations

Authorization
string
header
required

Bearer authentication: send your API key, agent key, or OAuth access token as Authorization: Bearer <credential>.

Headers

Idempotency-Key
string
required

Unique key for safely retrying a request without creating duplicates.

Maximum string length: 255
X-Instance-ID
string | null

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Maximum string length: 1024

Path Parameters

voiceSessionId
string
required

Voice session ID (vos_*).

Pattern: ^vos_[0-9a-f]{32}$

Body

application/json
merchantPartyId
string

Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

Pattern: ^pty_[0-9a-f]{32}$

Response

Successful Response

data
VoiceCallSimulationResource · object
required