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)[source]

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)[source]

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.

class wxc_sdk.telephony.prem_pstn.route_list.NumberAndAction(*, number: str, action: PatternAction)[source]

Bases: ApiModel

number: str

Number to be deleted/added

action: PatternAction

action to add or delete a number

static add(number: str) → NumberAndAction[source]
static delete(number: str) → NumberAndAction[source]
class wxc_sdk.telephony.prem_pstn.route_list.UpdateNumbersResponse(*, number: str, numberStatus: str, message: str)[source]

Bases: ApiModel

number: str
number_status: str
message: str
class wxc_sdk.telephony.prem_pstn.route_list.RouteListApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

API for everything route lists

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

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 = None) → str[source]

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 = None) → RouteListDetail[source]

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, rg_id: str, org_id: str | None = None)[source]

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 = None)[source]

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 = None, number: str | None = None, org_id: str | None = None, **params) → Generator[str, None, None][source]

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], org_id: str | None = None) → List[UpdateNumbersResponse][source]

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.

  • 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 = None)[source]
base = 'telephony/config/premisePstn/routeLists'