wxc_sdk.telephony.conference package

class wxc_sdk.telephony.conference.ConferenceControlsApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Conference Controls

Conference Control APIs in support of Webex Calling.

All GET commands require the spark:calls_read scope while all other commands require the spark:calls_write scope.

release_conference(line_owner_id: str | None = None)[source]

Release Conference

Release the conference (the host and all participants). Note that for a 3WC (three-way call) the Transfer API can be used to perform an attended transfer so that the participants remain connected.

param line_owner_id: The ID of a user, workspace, or virtual line for which there is a secondary line on a: device owned by the user invoking the API.

get_conference_details(line_owner_id: str | None = None) → ConferenceDetails[source]

Get Conference Details

Get the details of the conference. An empty JSON object body is returned if there is no conference.

Parameters:: line_owner_id – The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.:rtype: ConferenceDetails

start_conference(call_ids: list[str], line_owner_id: str | None = None)[source]

Start Conference

Join the user’s calls into a conference. A minimum of two call IDs are required. Each call ID identifies an existing call between the user and a participant to be added to the conference.

Parameters:

call_ids (list[str]) – List of call identifiers of the participants to join into the conference. A minimum of two call IDs are required.
line_owner_id (str) – The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.

Return type:

None

add_participant(call_id: str, line_owner_id: str | None = None)[source]

Add Participant

Adds a participant to an existing conference. The request body contains the participant’s call ID.

Parameters:

call_id (str) – The call identifier of the participant to add.
line_owner_id (str:rtype: None) – The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.

deafen_participant(call_id: str)[source]

Deafen Participant

Deafens a participant (i.e. media stream will not be transmitted to the participant). The request body contains the call ID of the participant to deafen

Parameters:: call_id (str) – The call identifier of the participant to deafen.
Return type:: None

hold(line_owner_id: str | None = None)[source]

Hold

Hold the conference host. There is no request body.

Parameters:: line_owner_id (str:rtype: None) – The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.

mute(call_id: str | None = None)[source]

Mute

Mutes the host or a participant. Mutes the host when no request body is provided (i.e. media stream from the host will not be transmitted to the conference). Mutes a participant when the request body contains the participant’s call ID (i.e. media stream from the participant will not be transmitted to the conference).

Parameters:: call_id (str) – The call identifier of the participant to mute. The conference host is muted when this attribute is not provided.
Return type:: None

resume(line_owner_id: str | None = None)[source]

Resume

Resumes the held conference host. There is no request body.

Parameters:: line_owner_id (str) – The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.
Return type:: None

undeafen_participant(call_id: str)[source]

Undeafen Participant

Undeafens a participant (i.e. resume transmitting the conference media stream to the participant). The request body contains the call ID of the participant to undeafen.

Parameters:: call_id (str) – The call identifier of the participant to undeafen.
Return type:: None

unmute(call_id: str | None = None)[source]

Unmute

Unmutes the host or a participant. Unmutes the host when no request body is provided (i.e. media stream from the host will be transmitted to the conference). Unmutes a participant when the request body contains the participant’s call ID (i.e. media stream from the participant will be transmitted to the conference).

Parameters:: call_id (str) – The call identifier of the participant to unmute. The conference host is unmuted when this attribute is not provided.
Return type:: None

base = 'telephony/conference'

class wxc_sdk.telephony.conference.ConferenceDetails(*, state: ConferenceState | None = None, appearance: int | None = None, created: datetime | None = None, muted: bool | None = None, type: ConferenceTypeEnum | None = None, participants: list[ConferenceParticipant] | None = None, **extra_data: Any)[source]

Bases: ApiModel

state: ConferenceState | None: The state of the conference.

appearance: int | None: The appearance index for the conference leg. Only present when the conference has an appearance value assigned.

created: datetime | None: The conference start time in ISO 8601 format.

muted: bool | None: Indicates if the host of the conference has been muted.

type: ConferenceTypeEnum | None: The type of conference for a non-standard conference.

participants: list[ConferenceParticipant] | None: The participants in the conference.

class wxc_sdk.telephony.conference.ConferenceParticipant(*, callId: str | None = None, muted: bool | None = None, deafened: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

call_id: str | None: The callId of the call.

muted: bool | None: Indicates if the participant has been muted.

deafened: bool | None: Indicates if the participant has been deafened (i.e. media stream is not being transmitting to the participant)

class wxc_sdk.telephony.conference.ConferenceState(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

connected = 'connected': The controller is an active participant.

held = 'held': The controller has held the conference and so is no longer an active participant.

disconnected = 'disconnected': The conference has been released.

class wxc_sdk.telephony.conference.ConferenceTypeEnum(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

barge_in = 'bargeIn'

silent_monitoring = 'silentMonitoring'

coaching = 'coaching'