Skip to navigation
API ReferenceConferencesParticipants

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.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional<=255 characters

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

Request

This endpoint expects an object.
DialobjectRequired

Dial someone new. This creates a new outbound call, exactly like POST /calls.

OR
Existing callobjectRequired
Pull in a call your team already has. It must be answered and not in another conference.

Response

Participant added.
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

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error
502
Bad Gateway Error