Public/Get-GCTelephonyPhones.ps1
|
<# .SYNOPSIS Retrieves a list of phones from Genesys Cloud. .DESCRIPTION Queries the Genesys Cloud API to retrieve a paginated list of telephony phone devices. Supports filtering by name and sorting. API Endpoint: GET /api/v2/telephony/providers/edges/phones .PARAMETER PageSize The number of results per page. Default is 25. .PARAMETER PageNumber The page number to retrieve. Default is 1. .PARAMETER SortBy The field to sort results by. .PARAMETER SortOrder The sort order for results. Valid values are 'ascending' or 'descending'. .PARAMETER Name Filter phones by name. Supports partial matching. .EXAMPLE Get-GCTelephonyPhones Retrieves the first page of phones with default page size. .EXAMPLE Get-GCTelephonyPhones -PageSize 100 -Name 'Polycom' Retrieves phones matching the name 'Polycom' with 100 results per page. .NOTES Genesys Cloud API: GET /api/v2/telephony/providers/edges/phones #> function Get-GCTelephonyPhones { [CmdletBinding()] param( [Parameter(Mandatory = $false)] [int]$PageSize = 25, [Parameter(Mandatory = $false)] [int]$PageNumber = 1, [Parameter(Mandatory = $false)] [string]$SortBy, [Parameter(Mandatory = $false)] [string]$SortOrder, [Parameter(Mandatory = $false)] [string]$Name ) $queryParams = @{ pageSize = $PageSize pageNumber = $PageNumber } if ($SortBy) { $queryParams['sortBy'] = $SortBy } if ($SortOrder) { $queryParams['sortOrder'] = $SortOrder } if ($Name) { $queryParams['name'] = $Name } $endpoint = "telephony/providers/edges/phones" return Invoke-GCApiRequest -Endpoint $endpoint -Method GET -QueryParameters $queryParams } |