Skip to navigation

Relay WebRTC offer

Sends the browser's SDP offer to the call's agent and returns the SDP answer.

Authentication

AuthorizationBearer

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

Path parameters

callIdstringRequiredformat: "uuid"
Call ID

Request

This endpoint expects an object.
sdpstringRequired
WebRTC SDP offer string
iceServerslist of objects or nullOptional

ICE servers from GET /api/v1/calls/webrtc/ice-servers, so both ends use the same servers

useSmartTurnbooleanOptional
Whether to use smart TURN server selection

Response

WebRTC offer relayed
sdpstring
WebRTC SDP answer string
sdpTypestring

SDP type (always “answer”)

botIdstring or nullOptional
Identifier of the agent instance serving the call

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error