Class ConferencesApi

Hierarchy

VoiceDomainApi
- ConferencesApi

Index

Methods

call get kickAll kickParticipant manageParticipant setBasePath

Methods

call

call(data: ConferenceCalloutRequestData): Promise<CalloutResponse>
Conference Callout Request Makes a conference callout to a phone number.
Parameters
- data: ConferenceCalloutRequestData
  The data to provide to the API call.
Returns Promise<CalloutResponse>

get

get(data: GetConferenceInfoRequestData): Promise<GetConferenceInfoResponse>
Get Conference Info Returns information about a conference that matches the provided conference ID.
Parameters
- data: GetConferenceInfoRequestData
  The data to provide to the API call.
Returns Promise<GetConferenceInfoResponse>

kickAll

kickAll(data: KickAllRequestData): Promise<void>
Kick Conference All Removes all participants from a conference.
Parameters
- data: KickAllRequestData
  The data to provide to the API call.
Returns Promise<void>

kickParticipant

kickParticipant(data: KickParticipantRequestData): Promise<void>
Kick Conference Participant Remove a specified conference participant from a specified conference.
Parameters
- data: KickParticipantRequestData
  The data to provide to the API call.
Returns Promise<void>

manageParticipant

manageParticipant(data: ManageParticipantRequestData): Promise<void>
Manage Conference Participant Manages conference participant in a specified conference: * mute / unmute * put on hold / resume.
Parameters
- data: ManageParticipantRequestData
  The data to provide to the API call.
Returns Promise<void>

setBasePath

setBasePath(basePath: string): void
Update the default basePath for the API
Parameters
- basePath: string
  The new base path to use for the APIs.
Returns void
Inherited from VoiceDomainApi.setBasePath