wxc_sdk.me.speed_dials package

class wxc_sdk.me.speed_dials.MeSpeedDial(*, id: str | None = None, lastName: str | None = None, firstName: str | None = None, displayName: str | None = None, type: UserType | None = None, phoneNumber: str | None = None, extension: str | None = None, routingPrefix: str | None = None, locationName: str | None = None, locationId: str | None = None, lineKeyLabel: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

The identifier of the person, place or virtual line. See type for the resource type (PEOPLE, PLACE, or VIRTUAL_LINE). Only present for org speed dials.

last_name: str | None

The last name of the person or virtual line.

first_name: str | None

The first name of the person or virtual line.

display_name: str | None

The display name of the person, place or virtual line.

type: UserType | None

Indicates whether the type is PEOPLE, PLACE or VIRTUAL_LINE. Only present for org speed dials.

phone_number: str | None

The phone number of the person, place or virtual line.

extension: str | None

The extension number for the person, place or virtual line.

routing_prefix: str | None

Routing prefix of location.

location_name: str | None

The location name where the speed dial is. Only present for org speed dials.

location_id: str | None

The ID for the location. Only present for org speed dials.

line_key_label: str | None

This is a custom label configured for the speed dial on the device.

class wxc_sdk.me.speed_dials.MeSpeedDials(*, speedDials: list[MeSpeedDial] | None = None, availableEntriesCount: int | None = None, **extra_data: Any)[source]

Bases: ApiModel

speed_dials: list[MeSpeedDial] | None

List of speed dial entries configured for the person.

available_entries_count: int | None

This is the number of additional entries that can be stored (more than the number of entries listed).

class wxc_sdk.me.speed_dials.MeSpeedDialModify(*, id: str | None = None, phoneNumber: str | None = None, lineKeyLabel: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

The identifier of the person (PEOPLE), place (PLACE), or virtual line (VIRTUAL_LINE) to add as a speed dial. Use this field when adding a speed dial for an existing member in the organization. Either id or phoneNumber must be provided.

phone_number: str | None

The phone number to add as a speed dial. Use this field when adding a speed dial for an external contact or custom number. Either id or phoneNumber must be provided.

line_key_label: str | None

This is a custom label configured for the speed dial on the device.

class wxc_sdk.me.speed_dials.MeSpeedDialAvailableMember(*, id: str | None = None, lastName: str | None = None, firstName: str | None = None, displayName: str | None = None, phoneNumber: str | None = None, extension: str | None = None, type: UserType | None = None, locationId: str | None = None, locationName: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

The identifier of the person, place or virtual line. See type for the resource type.

last_name: str | None

The last name of the person or virtual line.

first_name: str | None

The first name of the person or virtual line.

display_name: str | None

The display name of the person, place or virtual line.

phone_number: str | None

The phone number of the person, place or virtual line.

extension: str | None

The extension number for the person, place or virtual line.

type: UserType | None

Indicates whether the type is PEOPLE, VIRTUAL_LINE or PLACE.

location_id: str | None

The ID for the location.

location_name: str | None

The location name where the member is.

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

Bases: ApiChild

get() → MeSpeedDials[source]

Get Speed Dials

Get the Speed Dials settings for the authenticated user. This API returns all configured speed dials (no pagination).

Speed Dials allow Webex Calling users to quickly dial frequently contacted people, places, or virtual lines by assigning them to dedicated keys on their desk phones or soft clients.

This API requires a user auth token with a scope of spark:telephony_config_read.

Return type:

MeSpeedDials

modify(speed_dials: list[MeSpeedDialModify]) → None[source]

Modify Speed Dials

Modify the Speed Dials settings for the authenticated user. This is a replacement list for speed dials.

Speed Dials allow Webex Calling users to quickly dial frequently contacted people, places, or virtual lines by assigning them to dedicated keys on their desk phones or soft clients.

This API requires a user auth token with a scope of spark:telephony_config_write.

Parameters:

speed_dials (list[MeSpeedDialModify]) – List of speed dial entries to be configured for the person. This is a replacement list.

Return type:

None

available_members(location_id: str = None, name: list[str] = None, phone_number: list[str] = None, order: str = None, **params: Any) → Generator[MeSpeedDialAvailableMember, None, None][source]

Get Speed Dial Available Members

Get the available members which can be configured as Speed Dials for the authenticated user.

Speed Dials allow Webex Calling users to quickly dial frequently contacted people, places, or virtual lines by assigning them to dedicated keys on their desk phones or soft clients.

This API requires a user auth token with a scope of spark:telephony_config_read.

Parameters:

  • location_id (str) – Return the members list available in this location.

  • name (list[str]) – Search (Contains) based on first name and last name.

  • phone_number (list[str]) – Search (Contains) based on number and extension.

  • order – Sort by first name (firstName) or last name (lastName). Sort directions asc or desc.

  • asc - Sort in ascending order.

  • desc - Sort in descending order.

Returns:

Generator yielding SpeedDialAvailableMember instances

base = 'telephony/config/people/me'