Public/Get-GCTelephonySites.ps1
|
<# .SYNOPSIS Retrieves a list of telephony sites from Genesys Cloud. .DESCRIPTION Queries the Genesys Cloud API to retrieve a paginated list of telephony sites. Supports filtering by name and sorting. API Endpoint: GET /api/v2/telephony/providers/edges/sites .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 sites by name. Supports partial matching. .EXAMPLE Get-GCTelephonySites Retrieves the first page of telephony sites with default page size. .EXAMPLE Get-GCTelephonySites -PageSize 50 -Name 'Headquarters' Retrieves telephony sites matching the name 'Headquarters' with 50 results per page. .NOTES Genesys Cloud API: GET /api/v2/telephony/providers/edges/sites #> function Get-GCTelephonySites { [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/sites" return Invoke-GCApiRequest -Endpoint $endpoint -Method GET -QueryParameters $queryParams } |