wxc_sdk.telephony.prem_pstn.route_list module

class wxc_sdk.telephony.prem_pstn.route_list.RouteListDetail(*, id: str, name: str, location: IdAndName, routeGroup: IdAndName, **extra_data: Any)

Bases: ApiModel

rl_id: str

UUID of the Route List.

name: str

Route list name

location: IdAndName

Location associated with the Route List

route_group: IdAndName

Route group associated with the Route list.

class wxc_sdk.telephony.prem_pstn.route_list.RouteList(*, id: str, name: str, locationId: str, locationName: str, routeGroupId: str, routeGroupName: str, peakActiveRouteListCallsOrg: int | None = None, currentActiveRouteListCallsOrg: int | None = None, routeListCallsVolumeOrg: int | None = None, peakActiveRouteListCalls: int | None = None, currentActiveRouteListCalls: int | None = None, **extra_data: Any)

Bases: ApiModel

rl_id: str

UUID of the Route List.

name: str

Name of the Route List.

location_id: str

Location associated with the Route List.

location_name: str

Location associated with the Route List.

rg_id: str

UUID of the route group associated with Route List.

rg_name: str

Name of the Route Group associated with Route List.

peak_active_route_list_calls_org: int | None

Peak active calls on the Route List in the organization.

current_active_route_list_calls_org: int | None

Current active calls on the Route List in the organization.

route_list_calls_volume_org: int | None

Total calls volume on the Route List in the organization.

peak_active_route_list_calls: int | None

Peak active calls on the Route List.

current_active_route_list_calls: int | None

Current active calls on the Route List.

class wxc_sdk.telephony.prem_pstn.route_list.NumberAndAction(*, number: str, action: PatternAction, **extra_data: Any)

Bases: ApiModel

number: str

Number to be deleted/added

action: PatternAction

action to add or delete a number

static add(number: str) → NumberAndAction

static delete(number: str) → NumberAndAction

class wxc_sdk.telephony.prem_pstn.route_list.UpdateNumbersResponse(*, number: str, numberStatus: str, message: str, **extra_data: Any)

Bases: ApiModel

number: str

number_status: str

message: str

class wxc_sdk.telephony.prem_pstn.route_list.RouteListApi(*, session: RestSession, base: str = None)

Bases: ApiChild

API for everything route lists

list(name: list[str] = None, location_id: list[str] = None, order: str = None, org_id: str = None, **params) → Generator[RouteList, None, None]

List all Route Lists for the organization.

A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

Retrieving the Route List requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

• name (str) – Return the list of Route List matching the route list name.

• location_id (str) – Return the list of Route Lists matching the location id.

• order (str) – Order the Route List according to the designated fields.Available sort fields: name, locationId. Sort order is ascending by default

• org_id (str) – List all Route List for this organization.

Returns:

generator yielding RouteList instances

create(name: str, location_id: str, rg_id: str, org_id: str = None) → str

Create a Route List for the organization.

A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

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

Parameters:

• name (str) – Name of the Route List

• location_id (str) – Location associated with the Route List.

• rg_id (str) – UUID of the route group associated with Route List.

• org_id (str) – Organization to which Route List belongs.

Returns:

ID of the newly route list created.

Return type:

str

details(rl_id: str, org_id: str = None) → RouteListDetail

Get Route List Details.

A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

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

Parameters:

• rl_id (str) – ID of the Route List.

• org_id (str) – Organization to which Route List belongs.

Returns:

route list details

Return type:

RouteListDetail

update(rl_id: str, name: str = None, rg_id: str = None, org_id: str = None)

Modify the details for a Route List.

A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

Retrieving a Route List requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

• rl_id (str) – ID of the Route List.

• name (str) – Route List new name.

• rg_id (str) – New route group id.

• org_id (str) – Organization to which Route List belongs.

delete_route_list(rl_id: str, org_id: str = None)

Delete Route List for a Customer

A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

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

Parameters:

• rl_id (str) – ID of the Route List.

• org_id (str) – Organization to which Route List belongs.

numbers(rl_id: str, order: str = None, number: str = None, org_id: str = None, **params) → Generator[str, None, None]

Get numbers assigned to a Route List

A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

Retrieving a Route List requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

• rl_id (str) – ID of the Route List.

• order (str) – Order the Route Lists according to number.

• number (str) – Number assigned to the route list.

• org_id (str) – Organization to which Route List belongs.

Returns:

generator yielding str

update_numbers(rl_id: str, numbers: list[NumberAndAction] = None, delete_all_numbers: bool = None, org_id: str = None) → list[UpdateNumbersResponse]

Modify Numbers for Route List

Modify numbers for a specific Route List of a Customer.

A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

Retrieving a Route List requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

• rl_id (str) – ID of the Route List.

• numbers (list[NumberAndAction]) – Array of the numbers to be deleted/added.

• delete_all_numbers (bool) – If present, the numbers array is ignored and all numbers in the route list are deleted.

• org_id (str) – Organization to which Route List belongs.

Returns:

list of update number status

Return type:

list[UpdateNumbersResponse]

delete_all_numbers(rl_id: str, org_id: str = None)

base = 'telephony/config/premisePstn/routeLists'