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