Start Call

Starts a webrtc audio/video call.

Start a WebRTC audio/video call in a room.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/webrtc.call
​yes​
Permission required: view-l-room
Query Parameters
Key
Example Value
Description
rid*
zRAeTszXor8CCPceB
The room ID.
Example Call
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'
Example Response
{
    "videoCall": {
        "rid": "123abcxyz123",
        "provider": "webrtc",
        "callStatus": "ringing"
    },
    "success": true
}

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

Key	Example Value	Description
`rid*`	`zRAeTszXor8CCPceB`	The room ID.

Last modified 2d ago