livechat-update-call-status.md

Update Call Status

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

Update the call status of an existing WebRTC audio/video call.

HTTP Method	URL	Requires Auth
PUT	/api/v1/livechat/webrtc.call/:callId	yes

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

Path Variables

Key	Example Value	Description
callId*	zRAeTszXor8CCPceB	The call message _id.

Body Parameters

Key	Example Value	Description
rid*	abc123xyzabc	The room ID.
status*	ended	The status of the call.

Example Call

{% code overflow="wrap" %}

curl --location --request GET 'http://localhost:3000/api/v1/livechat/webrtc.call/zRAeTszXor8CCPceB\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name' \
-d '{ 
    "rid": "abc123xyzabc", 
    "status": "ended" 
}'

{% endcode %}

Example Response

{
    "status": "ended",
    "success": true
}