Conferences > participants

Add Participant

Add someone: dial a new number (to + from) or pull in a call you already have (call_id).

A dialed participant is returned with status dialing and joins when they answer; you'll get participant.joined (or participant.failed if they don't answer). With announce, they hear it alone before joining.

post/conferences/{id}/participants

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/conferences/{id}/participants
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

idstring required

Headers

Idempotency-Keystring

Makes dialing safe to retry; the number is dialed at most once.

Request body

OR

Response

Participant added.

call_idstring required

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

conference_idstring required
labelstring nullable required
status'dialing' | 'ringing' | 'joined' | 'left' | 'failed' required
  • 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).
fromstring nullable required
tostring nullable required
mutedboolean required

Nobody hears this participant; they still hear everyone.

on_holdboolean required

They hear hold audio and nobody hears them.

whisper_tostring[] nullable required

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

end_conference_on_leaveboolean required

When this participant leaves, the conference ends for everyone.

joined_atstring date-time nullable required
left_atstring date-time nullable required
left_reason'hangup' | 'removed' | 'busy' | 'no_answer' | 'rejected' | 'failed' | 'conference_ended' required

Changes

No recorded changes to this operation across all 1 revision of this API.