wxc_sdk.telephony.prem_pstn package

class wxc_sdk.telephony.prem_pstn.DialPatternValidationResult(*, status: ValidationStatus, dialPatternStatus: list[DialPatternValidate], **extra_data: Any)[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

__init__(session: RestSession)[source]
dial_plan: DialPlanApi

dial plan configuration

base = 'telephony/config/premisePstn'
trunk: TrunkApi

trunk configuration

route_group: RouteGroupApi

route group configuration

route_list: RouteListApi

route list configuration

validate_pattern(dial_patterns: str | list[str], org_id: str = 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:

DialPatternValidationResult

Submodules