wxc_sdk.workspace_settings.numbers package
Numbers API for Workspaces
- class wxc_sdk.workspace_settings.numbers.WorkspaceNumbers(*, phoneNumbers: list[UserNumber], workspace: IdOnly, location: IdAndName, organization: IdAndName)[source]
Bases:
ApiModel
- phone_numbers: list[UserNumber]
Array of numbers (primary/alternate).
- class wxc_sdk.workspace_settings.numbers.WorkspaceNumbersApi(*, session: RestSession, base: str | None = None)[source]
Bases:
ApiChild
- read(workspace_id: str, org_id: str | None = None) WorkspaceNumbers [source]
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:
- base = 'workspaces'