livechat-start-call.md

Start Call

{% hint style="danger" %} WebRTC is no longer supported with Omnichannel Livechat. To configure audio/video calls, see Omnichannel Audio/Video Call Configuration. {% endhint %}

Start a WebRTC audio/video call in a room.

HTTP Method	URL	Requires Auth
GET	/api/v1/livechat/webrtc.call	yes

{% hint style="info" %} Permission required: view-l-room {% endhint %}

Query Parameters

Key	Example Value	Description
rid*	zRAeTszXor8CCPceB	The room ID.

Example Call

{% code overflow="wrap" %}

curl --location --request GET 'http://localhost:3000/api/v1/livechat/webrtc.call?rid=123abcxyz123\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'

{% endcode %}

Example Response

{
    "videoCall": {
        "rid": "123abcxyz123",
        "provider": "webrtc",
        "callStatus": "ringing"
    },
    "success": true
}