Send the VoIP client events.
HTTP Method | URL | Requires Auth |
---|---|---|
POST | /api/v1/voip/events | yes |
{% hint style="info" %}
Permission required: view-l-room
{% endhint %}
Key | Example Value | Description |
---|---|---|
rid * | c9YW3rejo7HeL6ZDW | The room ID. |
event * | string | List of VoIP client events. |
comment | string | The comment. |
List of VoIP client Events available in enum format.
{
"VOIP-CALL-STARTED" = "voip-call-started",
"VOIP-CALL-ENDED" = "voip-call-ended",
"VOIP-CALL-DECLINED" = "voip-call-declined",
"VOIP-CALL-ON-HOLD" = "voip-call-on-hold",
"VOIP-CALL-UNHOLD" = "voip-call-unhold",
"VOIP-CALL-DURATION" = "voip-call-duration",
}
curl --location --request POST 'localhost:3000/api/v1/voip/events' \
--header 'X-Auth-Token: aEoKaT8qus3IZHlr_OlAzcsnz46SzZLJeqoRbbctcDQ' \
--header 'X-User-Id: 6vHSSqdBHdm2R4gfi' \
--header 'Content-Type: application/json' \
--data-raw '{
"rid": "oWLW6v8c8oRGb4cC9",
"event": "voip-call-started"
}'