wxc_sdk.workspace_settings.numbers package

Numbers API for Workspaces

class wxc_sdk.workspace_settings.numbers.WorkSpaceNumbers(*, phoneNumbers: list[wxc_sdk.common.UserNumber], workspace: IdOnly, location: IdAndName, organization: IdAndName)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

phone_numbers: list[wxc_sdk.common.UserNumber]

Array of numbers (primary/alternate).

workspace: IdOnly

workspace object having a unique identifier for the Workspace.

location: IdAndName

location object having a unique identifier for the location and its name.

organization: IdAndName

organization object having a unique identifier for the organization and its name.

class wxc_sdk.workspace_settings.numbers.WorkspaceNumbersApi(*, session: RestSession, base: str | None = None)

Bases: ApiChild

read(workspace_id: str, org_id: str | None = None) → WorkSpaceNumbers

List the PSTN phone numbers associated with a specific workspace, by ID, within the organization. Also shows the location and Organization associated with the workspace.

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

Parameters:

• workspace_id (str) – List numbers for this workspace.

• org_id (str) – List numbers for a workspace within this organization.

Returns:

Workspace numbers

Return type:

WorkSpaceNumbers

base = 'workspaces'

session: RestSession

REST session