Create WebRTC test call

Starts a browser call that runs the flow definition sent in the request instead of the published version, so changes can be tried before publishing. The definition is validated first. The call is recorded with version draft and billed like any other call.

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Request

This endpoint expects an object.

definitionobjectRequired

Flow definition to run instead of the published version

flowIdstringRequiredformat: "uuid"

Flow ID to test with a draft definition

metadataobject or nullOptional

Additional metadata to attach to the call

Response

WebRTC test call created

callIdstringformat: "uuid"

Unique call identifier

flowIdstringformat: "uuid"

Flow ID used for the AI conversation

statusenum

Current call status

botIdstring or nullOptional

Identifier of the agent instance serving the call, if one is assigned yet

offerDeadlineAtstring or nullOptional

The agent waits for your SDP offer until this time (RFC 3339), then releases itself and the call can no longer start. Send the offer well before it: connecting still takes a few seconds after the offer. Absent when no agent is assigned or the agent did not report its window.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error