wxc_sdk.me.calls package

class wxc_sdk.me.calls.MeCallControlApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

Call Controls Members Me

Call Control Me 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.

Notes:

  • These APIs support 3rd Party Call Control only.

  • The Call Control APIs are only for use by Webex Calling Multi Tenant users and not applicable for users hosted on

UCM, including Dedicated Instance users.

  • The Call Control APIs are not supported by Service Apps. Please see Call Control Members APIs for Service Apps

support.

answer(call_id: str, endpoint_id: str = None, line_owner_id: str = None) → None[source]

Answer

Answer an incoming call. When no endpointId is specified, the call is answered on the user’s primary device. When an endpointId is specified, the call is answered on the device or application identified by the endpointId. The answer API is rejected if the device is not alerting for the call or the device does not support answer via API.

Parameters:

  • call_id (str) – The call identifier of the call to be answered.

  • endpoint_id (str) – The ID of the device or application to answer the call on. The endpointId must be one of the endpointIds returned by the Get Preferred Answer Endpoint API.

  • 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

barge_in(target: str, endpoint_id: str = None, single_number_reach_phone_number: str = None, line_owner_id: str = None) → CallInfo[source]

Barge In

Barge-in on another user’s answered call. A new call is initiated to perform the barge-in in a similar manner to the dial command.

Parameters:

  • target (str) – Identifies the user to barge-in on. The target can be digits or a URI. Some examples for target include: 1234, 2223334444, +12223334444, tel:+12223334444, user@company.domain, sip:user@company.domain

  • endpoint_id (str) –

    The ID of the device or application to use for the barge-in. The endpointId must be one of the endpointIds returned by the Get Preferred Answer Endpoint API. Mutually exclusive with singleNumberReachPhoneNumber.

  • single_number_reach_phone_number (str) – The Single Number Reach phone number to use for the barge-in. Mutually exclusive with endpointId.

  • 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:

CallInfo

list_calls(line_owner_id: str = None) → list[TelephonyCall][source]

List Calls

Get the list of details for all active calls associated with the user.

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:

list[TelephonyCall]

call_details(call_id: str, line_owner_id: str = None) → TelephonyCall[source]

Get Call Details

Get the details of the specified active call for the user.

Parameters:

  • call_id (str) – The call identifier of the call.

  • 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:

TelephonyCall

dial(destination: str, endpoint_id: str = None, single_number_reach_phone_number: str = None, line_owner_id: str = None) → CallInfo[source]

Dial

Initiate an outbound call to a specified destination. This is also commonly referred to as Click to Call or Click to Dial. Alerts occur on all the devices belonging to a user unless an optional endpointId is specified in which case only the device or application identified by the endpointId is alerted. When a user answers an alerting device, an outbound call is placed from that device to the destination.

Parameters:

  • destination (str) – The destination to be dialed. The destination can be digits or a URI. Some examples for destination include: 1234, 2223334444, +12223334444, *73, tel:+12223334444, user@company.domain, and sip:user@company.domain.

  • endpoint_id (str) –

    The ID of the device or application to use for the call. The endpointId must be one of the endpointIds returned by the Get Preferred Answer Endpoint API. Mutually exclusive with singleNumberReachPhoneNumber.

  • single_number_reach_phone_number (str) – The Single Number Reach phone number to use for the call. Mutually exclusive with endpointId.

  • 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:

CallInfo

divert(call_id: str, destination: str = None, to_voicemail: bool = None, line_owner_id: str = None) → None[source]

Divert

Divert a call to a destination or a user’s voicemail. This is also commonly referred to as a Blind Transfer.

Parameters:

  • call_id (str) – The call identifier of the call to divert.

  • destination (str) – The destination to divert the call to. If toVoicemail is false, destination is required. The destination can be digits or a URI. Some examples for destination include: 1234, 2223334444, +12223334444, *73, tel:+12223334444, user@company.domain, sip:user@company.domain

  • to_voicemail (bool) – If set to true, the call is diverted to voicemail. If no destination is specified, the call is diverted to the user’s own voicemail. If a destination is specified, the call is diverted to the specified user’s voicemail.

  • 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

hangup(call_id: str, line_owner_id: str = None) → None[source]

Hangup

Hangup a call. If used on an unanswered incoming call, the call is rejected and sent to busy.

Parameters:

  • call_id (str) – The call identifier of the call to hangup.

  • 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

call_history(type_: HistoryType = None) → list[CallHistoryRecord][source]

List Call History

Get the list of call history records for the user. A maximum of 20 call history records per type (placed, missed, received) are returned.

Parameters:

type (HistoryType) – The type of call history records to retrieve. If not specified, then all call history records are retrieved.

Return type:

list[CallHistoryRecord]

hold(call_id: str, line_owner_id: str = None) → None[source]

Hold

Hold a connected call.

Parameters:

  • call_id (str) – The call identifier of the call to hold.

  • 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

mute(call_id: str, line_owner_id: str = None) → None[source]

Mute

Mute a call. This API can only be used for a call that reports itself as mute capable via the muteCapable field in the call details.

Parameters:

  • call_id (str) – The call identifier of the call to mute.

  • 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

park(call_id: str, destination: str = None, is_group_park: bool = None, line_owner_id: str = None) → TelephonyParty[source]

Park

Park a connected call. The number field in the response can be used as the destination for the retrieve command to retrieve the parked call.

Parameters:

  • call_id (str) – The call identifier of the call to park.

  • destination (str) – Identifes where the call is to be parked. If not provided, the call is parked against the parking user. The destination can be digits or a URI. Some examples for destination include: 1234, 2223334444, +12223334444, *73, tel:+12223334444, user@company.domain, sip:user@company.domain

  • is_group_park (bool) – If set to`true`, the call is parked against an automatically selected member of the user’s call park group and the destination parameter is ignored.

  • 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:

TelephonyParty

pauserecording(call_id: str = None, line_owner_id: str = None) → None[source]

Pause Recording

Pause recording on a call. Use of this API is only valid when a call is being recorded and the user’s call recording mode is set to “On Demand” or “Always with Pause/Resume”.

Parameters:

  • call_id (str) – The call identifier of the call to pause recording.

  • 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

pickup(target: str = None, endpoint_id: str = None, single_number_reach_phone_number: str = None, line_owner_id: str = None) → CallInfo[source]

Pickup

Picks up an incoming call to another user. A new call is initiated to perform the pickup in a similar manner to the dial command. When target is not present, the API pickups up a call from the user’s call pickup group. When target is present, the API pickups an incoming call from the specified target user.

Parameters:

  • target (str) – Identifies the user to pickup an incoming call from. If not provided, an incoming call to the user’s call pickup group is picked up. The target can be digits or a URI. Some examples for target include: 1234, 2223334444, +12223334444, tel:+12223334444, user@company.domain, sip:user@company.domain

  • endpoint_id (str) –

    The ID of the device or application to use for the pickup. The endpointId must be one of the endpointIds returned by the Get Preferred Answer Endpoint API. Mutually exclusive with singleNumberReachPhoneNumber.

  • single_number_reach_phone_number (str) – The Single Number Reach phone number to use for the pickup. Mutually exclusive with endpointId.

  • 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:

CallInfo

pull(endpoint_id: str = None, line_owner_id: str = None) → CallInfo[source]

Pull

Pull a call from one device to another. A temporary new call is initiated to perform the call pull in a similar manner to the dial command. When a user answers an alerting device, the device is connected to the pulled call and the new call created for the call pull is released.

Parameters:

  • endpoint_id (str) –

    The ID of the device or application to use for the retrieval. The endpointId must be one of the endpointIds returned by the Get Preferred Answer Endpoint API.

  • 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:

CallInfo

push(call_id: str = None, line_owner_id: str = None) → None[source]

Push

Pushes a call from the assistant to the executive the call is associated with. Use of this API is only valid when the assistant’s call is associated with an executive.

Parameters:

  • call_id (str) – The call identifier of the call to push.

  • 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

reject(call_id: str, action: RejectAction = None, line_owner_id: str = None) → None[source]

Reject

Reject an unanswered incoming call.

Parameters:

  • call_id (str) – The call identifier of the call to be rejected.

  • action (RejectAction) – The rejection action to apply to the call. The busy action is applied if no specific action is provided.

  • 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

resume(call_id: str, line_owner_id: str = None) → None[source]

Resume

Resume a held call.

Parameters:

  • call_id (str) – The call identifier of the call to resume.

  • 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

resumerecording(call_id: str = None, line_owner_id: str = None) → None[source]

Resume Recording

Resume recording a call. Use of this API is only valid when a call’s recording is paused and the user’s call recording mode is set to “On Demand” or “Always with Pause/Resume”.

Parameters:

  • call_id (str) – The call identifier of the call to resume recording.

  • 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

retrieve(destination: str = None, endpoint_id: str = None, single_number_reach_phone_number: str = None, line_owner_id: str = None) → CallInfo[source]

Retrieve

Retrieve a parked call. A new call is initiated to perform the retrieval in a similar manner to the dial command. The number field from the park command response can be used as the destination for the retrieve command.

Parameters:

  • destination (str) – Identifies where the call is parked. The number field from the park command response can be used as the destination for the retrieve command. If not provided, the call parked against the retrieving user is retrieved. The destination can be digits or a URI. Some examples for destination include: 1234, 2223334444, +12223334444, *73, tel:+12223334444, user@company.domain, sip:user@company.domain

  • endpoint_id (str) –

    The ID of the device or application to use for the retrieval. The endpointId must be one of the endpointIds returned by the Get Preferred Answer Endpoint API. Mutually exclusive with singleNumberReachPhoneNumber.

  • single_number_reach_phone_number (str) – The Single Number Reach phone number to use for the retrieval. Mutually exclusive with endpointId.

  • 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:

CallInfo

startrecording(call_id: str = None, line_owner_id: str = None) → None[source]

Start Recording

Start recording a call. Use of this API is only valid when the user’s call recording mode is set to “On Demand”.

Parameters:

  • call_id (str) – The call identifier of the call to start recording.

  • 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

stoprecording(call_id: str = None, line_owner_id: str = None) → None[source]

Stop Recording

Stop recording a call. Use of this API is only valid when a call is being recorded and the user’s call recording mode is set to “On Demand”.

Parameters:

  • call_id (str) – The call identifier of the call to stop recording.

  • 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

transfer(call_id1: str = None, call_id2: str = None, destination: str = None, line_owner_id: str = None) → CallInfo[source]

Transfer

Transfer two calls together.

Unanswered incoming calls cannot be transferred but can be diverted using the divert API.

If the user has only two calls and wants to transfer them together, the callId1 and callId2 parameters are optional and when not provided the calls are automatically selected and transferred.

If the user has more than two calls and wants to transfer two of them together, the callId1 and callId2 parameters are mandatory to specify which calls are being transferred. Those are also commonly referred to as Attended Transfer, Consultative Transfer, or Supervised Transfer and will return a 204 response.

If the user wants to transfer one call to a new destination but only when the destination responds, the callId1 and destination parameters are mandatory to specify the call being transferred and the destination.

This is referred to as a Mute Transfer and is similar to the divert API with the difference of waiting for the destination to respond prior to transferring the call. If the destination does not respond, the call is not transferred. This will return a 201 response.

Parameters:

  • call_id1 (str) – The call identifier of the first call to transfer. This parameter is mandatory if either callId2 or destination is provided.

  • call_id2 (str) – The call identifier of the second call to transfer. This parameter is mandatory if callId1 is provided and destination is not provided.

  • destination (str) – The destination to be transferred to. The destination can be digits or a URI. Some examples for destination include: 1234, 2223334444, +12223334444, tel:+12223334444, user@company.domain, sip:user@company.domain. This parameter is mandatory if callId1 is provided and callId2 is not provided.

  • 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:

CallInfo

transmit_dtmf(call_id: str = None, dtmf: str = None, line_owner_id: str = None) → None[source]

Transmit DTMF

Transmit DTMF digits to a call.

Parameters:

  • call_id (str) – The call identifier of the call to transmit DTMF digits for.

  • dtmf (str) – The DTMF digits to transmit. Each digit must be part of the following set: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #, A, B, C, D]. A comma “,” may be included to indicate a pause between digits. For the value “1,234”, the DTMF 1 digit is initially sent. After a pause, the DTMF 2, 3, and 4 digits are sent successively.

  • 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

unmute(call_id: str, line_owner_id: str = None) → None[source]

Unmute

Unmute a call. This API can only be used for a call that reports itself as mute capable via the muteCapable field in the call details.

Parameters:

  • call_id (str) – The call identifier of the call to unmute.

  • 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

set_wrapup_reasons(wrapup_reasons: list[str] = None) → None[source]

Set Wrap-up Reasons

Sets wrap-up reasons for the authenticated user’s last completed call. The request must provide wrapupReasons.

Parameters:

wrapup_reasons (list[str]) – Array of wrap-up reason names to apply to the agent’s last completed call.

Return type:

None

base = 'telephony/calls/members/me'