Skip to navigation
API ReferenceConferencesParticipants

Remove Participant

Hang up this participant's call. Everyone else stays in the conference.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired
participantstringRequired

Response

The removed participant (left_reason is removed).

call_idstring

The participant is this call; every call API works on it.

conference_idstring
labelstring or null
statusenum
  • dialing: A dialed participant whose call hasn’t answered yet.
  • ringing: Answered and being connected (or hearing its announce).
  • joined: In the conference.
  • left: Hung up or was removed.
  • failed: Never connected (busy, no answer, rejected, or an error).
Allowed values:
fromstring or null
tostring or null
mutedboolean

Nobody hears this participant; they still hear everyone.

on_holdboolean
They hear hold audio and nobody hears them.
whisper_tolist of strings or null

Call IDs of the only participants who can hear this one, or null for everyone.

end_conference_on_leaveboolean
When this participant leaves, the conference ends for everyone.
joined_atstring or nullformat: "date-time"
left_atstring or nullformat: "date-time"
left_reasonenum or null

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
502
Bad Gateway Error