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