Lease a SIP name from the relay pool for a BYO agent call

Creates a lease - to is the destination number, from is your own volai number the call should appear to come from. The returned sipName is the BARE name for ElevenLabs's to_number (not sipUri - ElevenLabs rejects a full SIP URI). Set your platform's outbound trunk to outboundTrunkAddress from GET /v1/numbers/{e164}/sip - a different address means the call is not routed on the network and the platform reports a timeout.

post/v1/relay

Request

  • Base URL: https://volai.cz
  • URL: https://volai.cz/v1/relay
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional key for one logical request. Its scope is global to this API key, independent of the HTTP method, path, or body: use a new value for every distinct logical action across all endpoints and request bodies, and reuse it only to retry the exact same logical request. Reusing a non-blank key within 24 hours returns the stored response; a concurrent request with the same key returns 409 idempotency_in_progress. A missing or whitespace-only value disables idempotency.

Request body

tostring required

Destination the leased SIP name will dial. The lease must be used before it expires.

fromstring required

Owned volai number used as the caller id for the outbound leg.

ttlSecsinteger

Lease lifetime in seconds, 15-300. Omit to use the server default. Creating a lease does not itself place a call.

Response

Created lease

idstring required
sipNamestring required
sipUristring required
expiresAtnumber required
callIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.