Send Call Center Events

Prev Next
Post
/api/v1/voip/events

Send the VoIP client events. Permission required: view-l-room

VoIP Client Events

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" }
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example 1
{
  "rid": "oWLW6v8c8oRGb4cC9",
  "event": "voip-call-started"
}
object
rid
string
event
string
comment
string
Responses
400

Bad Request

Example 1
{
  "success": false,
  "error": "Match error: Missing key 'event'"
}
Example 2
{
  "success": false,
  "error": "Match error: Missing key 'rid'"
}
object
success
boolean
error
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string
404

Not Found

Example 1
{
  "success": false,
  "error": "Resource not found"
}
object
success
boolean
error
string