wxc_sdk.telephony.paging module

Paging group API

class wxc_sdk.telephony.paging.PagingApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

list(location_id: str | None = None, name: str | None = None, phone_number: str | None = None, org_id: str | None = None, **params) → Generator[Paging, None, None][source]

Read the List of Paging Groups List all Paging Groups for the organization.

Group Paging allows a person to place a one-way call or group page to up to 75 people and/or workspaces by dialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.

Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • location_id (str) – Return only paging groups with matching location ID. Default is all locations

  • name (str) – Return only paging groups with the matching name.

  • phone_number (str) – Return only paging groups with matching primary phone number or extension.

  • org_id (str) – List paging groups for this organization.

Returns:

generator of class:Paging objects

create(location_id: str, settings: Paging, org_id: str | None = None) → str[source]

Create a new Paging Group Create a new Paging Group for the given location.

Group Paging allows a person to place a one-way call or group page to up to 75 people and/or workspaces by dialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.

Creating a paging group requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Create the paging group for this location.

  • settings (Paging) – new paging group

  • org_id (str) – Create the paging group for this organization.

Returns:

ID of the newly created paging group.

Return type:

str

delete_paging(location_id: str, paging_id: str, org_id: str | None = None)[source]

Delete a Paging Group Delete the designated Paging Group.

Group Paging allows a person to place a one-way call or group page to up to 75 people and/or workspaces by dialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.

Deleting a paging group requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Location from which to delete a paging group.

  • paging_id – Delete the paging group with the matching ID.

  • org_id – Delete the paging group from this organization.

details(location_id: str, paging_id: str, org_id: str | None = None) → Paging[source]

Get Details for a Paging Group Retrieve Paging Group details.

Group Paging allows a person to place a one-way call or group page to up to 75 people and/or workspaces by dialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.

Retrieving paging group details requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read. :param location_id: Retrieve settings for a paging group in this location. :param paging_id: Retrieve settings for the paging group with this identifier. :param org_id: Retrieve paging group settings from this organization. :return: Paging object

update(location_id: str, update: Paging, paging_id: str, org_id: str | None = None)[source]

Update the designated Paging Group.

Group Paging allows a person to place a one-way call or group page to up to 75 people and/or workspaces by dialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.

Updating a paging group requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Update settings for a paging group in this location.

  • update (Paging) – update parameters

  • paging_id (str) – Update settings for the paging group with this identifier.

  • org_id (str) – Update paging group settings from this organization.

base = 'telephony/config'
class wxc_sdk.telephony.paging.Paging(*, id: str | None = None, enabled: bool | None = None, name: str | None = None, phoneNumber: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None, tollFreeNumber: bool | None = None, language: str | None = None, languageCode: str | None = None, firstName: str | None = None, lastName: str | None = None, originatorCallerIdEnabled: bool | None = None, originators: list[PagingAgent] | None = None, targets: list[PagingAgent] | None = None, locationName: str | None = None, locationId: str | None = None)[source]

Bases: ApiModel

paging_id: str | None

A unique identifier for the paging group.

enabled: bool | None

Whether or not the paging group is enabled.

name: str | None

Unique name for the paging group. Minimum length is 1. Maximum length is 30.

phone_number: str | None

Paging group phone number. Minimum length is 1. Maximum length is 23. Either phoneNumber or extension is mandatory.

extension: str | None

Paging group extension. Minimum length is 2. Maximum length is 10. Either phoneNumber or extension is mandatory.

routingPrefix: str | None

is the phone numer a toll free number? Routing prefix of location.

esn: str | None

Routing prefix + extension of a person or workspace.

toll_free_number: bool | None
language: str | None

Paging language. Minimum length is 1. Maximum length is 40.

language_code: str | None

Language code.

first_name: str | None

First name that displays when a group page is performed. Minimum length is 1. Maximum length is 30.

last_name: str | None

Last name that displays when a group page is performed. Minimum length is 1. Maximum length is 30.

originator_caller_id_enabled: bool | None

Determines what is shown on target users caller ID when a group page is performed. If true shows page originator ID.

originators: list[PagingAgent] | None

An array of people and/or workspaces, who may originate pages to this paging group.

targets: list[PagingAgent] | None

An array of people, workspaces and virtual lines IDs will add to a paging group as paging call targets.

location_name: str | None

Name of location for paging group. Only present in list() response. When creating a paging group then this is a list of agent IDs. The details() call returns detailed agent information

location_id: str | None

ID of location for paging group. Only present in list() response.

create_or_update() → str[source]

Get JSON for create or update call

Returns:

JSON

Return type:

str

static create(*, name: str, phone_number: str | None = None, extension: str | None = None) → Paging[source]

Get minimal paging group settings that can be used to create a paging group by calling PagingApi.create() with these settings.

Parameters:

  • name (str) – Unique name for the paging group. Minimum length is 1. Maximum length is 30.

  • phone_number (str) – Paging group phone number. Minimum length is 1. Maximum length is 23. Either phone_number or extension is mandatory.

  • extension (str) – Paging group extension. Minimum length is 2. Maximum length is 10. Either phone_number or extension is mandatory.

Returns:

settings for PagingApi.create() call

Return type:

Paging

class wxc_sdk.telephony.paging.PagingAgent(*, id: str | None = None, firstName: str | None = None, lastName: str | None = None, type: UserType | None = None, phoneNumber: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None)[source]

Bases: ApiModel

agent_id: str | None

Agents ID

first_name: str | None

Agents first name. Minimum length is 1. Maximum length is 30.

last_name: str | None

Agents last name. Minimum length is 1. Maximum length is 30.

agent_type: UserType | None

Type of the person or workspace.

phone_number: str | None

Agents phone number. Minimum length is 1. Maximum length is 23. Either phoneNumber or extension is mandatory.

extension: str | None

Agents extension. Minimum length is 2. Maximum length is 10. Either phoneNumber or extension is mandatory.

routingPrefix: str | None

Routing prefix of location.

esn: str | None

Routing prefix + extension of a person or workspace.