wxc_sdk.telephony.prem_pstn package
- class wxc_sdk.telephony.prem_pstn.DialPatternValidationResult(*, status: ValidationStatus, dialPatternStatus: list[DialPatternValidate])[source]
Bases:
ApiModel
- status: ValidationStatus
Overall validation result status.
- dial_pattern_status: list[DialPatternValidate]
- property ok: bool
- class wxc_sdk.telephony.prem_pstn.PremisePstnApi(session: RestSession)[source]
Bases:
ApiChild
Premises PSTN API
- dial_plan: DialPlanApi
dial plan configuration
- base = 'telephony/config/premisePstn'
- route_group: RouteGroupApi
route group configuration
- route_list: RouteListApi
route list configuration
- validate_pattern(dial_patterns: str | List[str], org_id: str | None = None) DialPatternValidationResult [source]
Validate a Dial Pattern.
Dial plans route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location. A dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns. Specific dial patterns can be defined as part of your dial plan.
Validating a dial pattern requires a full administrator auth token with a scope of spark-admin:telephony_config_write.
- Parameters:
dial_patterns (list[str] or str) – Array of dial patterns.
org_id – Organization to which dial plan belongs.
- Returns:
validation result
- Return type:
Submodules
- wxc_sdk.telephony.prem_pstn.dial_plan module
- wxc_sdk.telephony.prem_pstn.route_group module
RGTrunk
RouteGroup
RouteGroupUsage
UsageRouteLists
RouteGroupApi
RouteGroupApi.list()
RouteGroupApi.create()
RouteGroupApi.details()
RouteGroupApi.update()
RouteGroupApi.delete_route_group()
RouteGroupApi.usage()
RouteGroupApi.usage_call_to_extension()
RouteGroupApi.usage_dial_plan()
RouteGroupApi.usage_location_pstn()
RouteGroupApi.usage_route_lists()
RouteGroupApi.base
- wxc_sdk.telephony.prem_pstn.route_list module
- wxc_sdk.telephony.prem_pstn.trunk module
TrunkType
Trunk
TrunkDeviceType
TrunkTypeWithDeviceType
DeviceStatus
ResponseStatusType
ResponseStatus
CnameRecord
OutboundProxy
TrunkDetail
TrunkDetail.trunk_id
TrunkDetail.name
TrunkDetail.organization
TrunkDetail.location
TrunkDetail.otg_dtg_id
TrunkDetail.line_port
TrunkDetail.locations_using_trunk
TrunkDetail.pilot_user_id
TrunkDetail.outbound_proxy
TrunkDetail.sip_authentication_user_name
TrunkDetail.status
TrunkDetail.error_codes
TrunkDetail.response_status
TrunkDetail.dual_identity_support_enabled
TrunkDetail.trunk_type
TrunkDetail.device_type
TrunkDetail.address
TrunkDetail.domain
TrunkDetail.port
TrunkDetail.max_concurrent_calls
TrunkDetail.is_restricted_to_dedicated_instance
TrunkUsage
TrunkApi
TrunkApi.list()
TrunkApi.create()
TrunkApi.details()
TrunkApi.update()
TrunkApi.delete_trunk()
TrunkApi.trunk_types()
TrunkApi.usage()
TrunkApi.usage_dial_plan()
TrunkApi.usage_location_pstn()
TrunkApi.usage_route_group()
TrunkApi.usage_call_to_extension()
TrunkApi.validate_fqdn_and_domain()
TrunkApi.base