Public/Get-GCArchitectIvrs.ps1
|
<# .SYNOPSIS Retrieves a list of IVR configurations from Genesys Cloud. .DESCRIPTION Queries the Genesys Cloud API to retrieve a paginated list of architect IVR configurations. Supports filtering by name and sorting options. API Endpoint: GET /api/v2/architect/ivrs .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 'asc' or 'desc'. .PARAMETER Name Filter IVRs by name. Supports partial matching. .EXAMPLE Get-GCArchitectIvrs Retrieves the first page of IVR configurations with default page size. .EXAMPLE Get-GCArchitectIvrs -Name 'Main IVR' -PageSize 50 Retrieves IVR configurations matching the name 'Main IVR'. .NOTES Genesys Cloud API: GET /api/v2/architect/ivrs #> function Get-GCArchitectIvrs { [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 = "architect/ivrs" return Invoke-GCApiRequest -Endpoint $endpoint -Method GET -QueryParameters $queryParams } |