Skip to content

Commit 0e23183

Browse files
author
Faisal Rahman
committed
Call Queue cmdlets Doc updated
1 parent 3a27194 commit 0e23183

File tree

5 files changed

+144
-44
lines changed

5 files changed

+144
-44
lines changed

‎skype/skype-ps/skype/Find-CsGroup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
external help file:
2+
external help file: Find-CsGroup.xml
33
applicable: Skype for Business Online
44
title: Find-CsGroup
55
schema: 2.0.0
@@ -47,7 +47,7 @@ Parameter Sets: (All)
4747
Aliases:
4848
Applicable: Skype for Business Online
4949

50-
Required: False
50+
Required: True
5151
Position: Named
5252
Default value: None
5353
Accept pipeline input: False

‎skype/skype-ps/skype/Get-CsHuntGroup.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
external help file:
2+
external help file: Get-CsHuntGroup.xml
33
applicable: Skype for Business Online
44
title: Get-CsHuntGroup
55
schema: 2.0.0
@@ -18,7 +18,11 @@ Get-CsHuntGroup [-BypassDualWrite <Object>] [-DomainController <Object>] [-Force
1818
```
1919

2020
## DESCRIPTION
21-
The Get-CsHuntGroup cmdlet lets you retrieve information about the call queues in your organization. Call queue output contains statistical data on the number of active calls that are in the queue.
21+
The Get-CsHuntGroup cmdlet lets you retrieve information about the call queues in your organization. Call queue output contains statistical data on the number of active calls that are in the queue.
22+
23+
If called without parameters, Get-CsHuntgroup returns a collection of all call queues configured to be used in your organization.
24+
25+
If you are a hybrid tenant, you may need to execute additional cmdlets on your on-premise deployments. The Get-CsHuntGroup will request further steps, if those steps are necessary for you.
2226

2327
## EXAMPLES
2428

@@ -31,10 +35,10 @@ This example gets all call queues in the organization.
3135

3236
### -------------------------- Example 2 --------------------------
3337
```
34-
Get-CsHuntGroup -PrimaryUri "sip:helpdesk@litwareinc.com"
38+
Get-CsHuntGroup -PrimaryUri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com"
3539
```
3640

37-
This example gets all call queues for helpdesk@litwareinc.com.
41+
This example gets the call queue with the primary uri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com". If no call queue exists with the primary uri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com", then this example generates an error.
3842

3943

4044
## PARAMETERS
@@ -88,7 +92,7 @@ Accept wildcard characters: False
8892
```
8993
9094
### -PrimaryUri
91-
The PrimaryUri parameter represents the SIP address for the call queue.
95+
The PrimaryUri parameter represents the SIP address for the call queue. It must start with "sip:".
9296
9397
```yaml
9498
Type: Object
@@ -120,7 +124,7 @@ Accept wildcard characters: False
120124
```
121125
122126
### -AsJob
123-
{{Fill AsJob Description}}
127+
PARAMVALUE: SwitchParameter
124128
125129
```yaml
126130
Type: SwitchParameter

‎skype/skype-ps/skype/New-CsHuntGroup.md

Lines changed: 59 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
external help file:
2+
external help file: New-CsHuntGroup.xml
33
applicable: Skype for Business Online
44
title: New-CsHuntGroup
55
schema: 2.0.0
@@ -13,12 +13,12 @@ Creates new Call Queue in your Skype for Business Online organization. Call Queu
1313
## SYNTAX
1414

1515
```
16-
New-CsHuntGroup [-Domain <Object>] [-LineUri <Object>] [-Name <Object>] [-AgentAlertTime <Object>]
16+
New-CsHuntGroup [-Domain <Object>] [-Name <Object>] [-AgentAlertTime <Object>] [-AllowOptOut <Object>]
1717
[-BypassDualWrite <Object>] [-ClientAudience <Object>] [-DistributionLists <Object>]
18-
[-DomainController <Object>] [-Force] [-HuntGroupServiceCallbackUri <Object>]
18+
[-DomainController <Object>] [-Force] [-HuntGroupServiceCallbackUri <Object>] [-LineUri <Object>]
1919
[-MusicOnHoldFileContent <Object>] [-MusicOnHoldFileName <Object>] [-OverflowAction <Object>]
20-
[-OverflowActionTarget <Object>] [-OverflowThreshold <Object>] [-Ring <Object>] [-Tenant <Object>]
21-
[-TimeoutAction <Object>] [-TimeoutActionTarget <Object>] [-TimeoutThreshold <Object>]
20+
[-OverflowActionTarget <Object>] [-OverflowThreshold <Object>] [-Ring <Object>] [-RoutingMethod <Object>]
21+
[-Tenant <Object>] [-TimeoutAction <Object>] [-TimeoutActionTarget <Object>] [-TimeoutThreshold <Object>]
2222
[-UseDefaultMusicOnHold <Object>] [-WelcomeMusicFileContent <Object>] [-WelcomeMusicFileName <Object>]
2323
[-AsJob] [<CommonParameters>]
2424
```
@@ -30,18 +30,28 @@ Note, you need to specify UseDefaultMusicOnHold $True (default is none), or prov
3030

3131
MusicOnHoldFileName and MusicOnHoldFileContent cannot be empty so you must specify a valid MusicOnHoldFileName and MusicOnHoldFileContent or set UseDefaultMusicOnHold to true.
3232

33-
The following parameters are not applicable to Skype for Business Online: AllowOptOut, AsJob, ClientAudience, DomainController, Force, HuntGroupServiceCallbackUri, PipelineVariable, Ring, and RoutingMethod
33+
If you are a hybrid tenant, you may need to execute additional cmdlets on your on-premise deployments. The New-CsHuntGroup will request further steps, if those steps are necessary for you.
34+
35+
The following parameters are not applicable to Skype for Business Online: AsJob, ClientAudience, DomainController, Force, HuntGroupServiceCallbackUri, PipelineVariable, and Ring.
3436

3537

3638
## EXAMPLES
3739

3840
### -------------------------- Example 1 --------------------------
3941
```
42+
New-CsHuntGroup -Name "Help Desk" -Domain "litwareinc.com" -UseDefaultMusicOnHold $true
43+
```
4044

41-
Insert example commands for example 1.
45+
This example creates a call queue for the organization named "Help Desk" in the domain "litwareinc.com" using default music on hold.
46+
47+
### -------------------------- Example 2 --------------------------
48+
```
49+
$musicOnHoldContent = Get-Content ".\MusicOnHold.wav" -ReadCount 0 -Encoding Byte
50+
$welcomeMusicContent = Get-Content ".\WelcomeMusic.wav" -ReadCount 0 -Encoding Byte
51+
New-CsHuntGroup -Name "Help desk" -Domain "litwareinc.com" -LineUri "tel:+19998881234" -RoutingMethod Attendant -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -AllowOptOut $false -AgentAlertTime 30 -OverflowThreshold 15 -OverflowAction Forward -OverflowActionTarget "sip:[email protected]" -TimeoutThreshold 30 -TimeoutAction Disconnect -MusicOnHoldFileName "MusicOnHold.wav" -MusicOnHoldFileContent $musicOnHoldContent -WelcomeMusicFileName "WelcomeMusic.wav"
4252
```
4353

44-
Insert descriptive text for example 1.
54+
This example saves the contents of music on hold and welcome music files in temporary variables. Then, it creates a call queue for the organization named "Help Desk" in the domain "litwareinc.com" using those contents and other configurable parameters.
4555

4656

4757
## PARAMETERS
@@ -62,8 +72,9 @@ Accept pipeline input: False
6272
Accept wildcard characters: False
6373
```
6474
65-
### -LineUri
66-
PARAMVALUE: Uri
75+
76+
### -Name
77+
PARAMVALUE: String
6778
6879
```yaml
6980
Type: Object
@@ -78,24 +89,24 @@ Accept pipeline input: False
7889
Accept wildcard characters: False
7990
```
8091
81-
### -Name
82-
PARAMVALUE: String
92+
### -AgentAlertTime
93+
PARAMVALUE: Int16
8394
8495
```yaml
8596
Type: Object
8697
Parameter Sets: (All)
8798
Aliases:
8899
Applicable: Skype for Business Online
89100

90-
Required: True
101+
Required: False
91102
Position: Named
92103
Default value: None
93104
Accept pipeline input: False
94105
Accept wildcard characters: False
95106
```
96107
97-
### -AgentAlertTime
98-
PARAMVALUE: Int16
108+
### -AllowOptOut
109+
PARAMVALUE: $true | $false
99110
100111
```yaml
101112
Type: Object
@@ -206,6 +217,22 @@ Accept pipeline input: False
206217
Accept wildcard characters: False
207218
```
208219
220+
### -LineUri
221+
PARAMVALUE: Uri
222+
223+
```yaml
224+
Type: Object
225+
Parameter Sets: (All)
226+
Aliases:
227+
Applicable: Skype for Business Online
228+
229+
Required: False
230+
Position: Named
231+
Default value: None
232+
Accept pipeline input: False
233+
Accept wildcard characters: False
234+
```
235+
209236
### -MusicOnHoldFileContent
210237
PARAMVALUE: Byte\[\]
211238
@@ -302,6 +329,22 @@ Accept pipeline input: False
302329
Accept wildcard characters: False
303330
```
304331
332+
### -RoutingMethod
333+
PARAMVALUE: Attendant | Serial
334+
335+
```yaml
336+
Type: Object
337+
Parameter Sets: (All)
338+
Aliases:
339+
Applicable: Skype for Business Online
340+
341+
Required: False
342+
Position: Named
343+
Default value: None
344+
Accept pipeline input: False
345+
Accept wildcard characters: False
346+
```
347+
305348
### -Tenant
306349
PARAMVALUE: Guid
307350
@@ -415,7 +458,7 @@ Accept wildcard characters: False
415458
```
416459
417460
### -AsJob
418-
{{Fill AsJob Description}}
461+
PARAMVALUE: SwitchParameter
419462
420463
```yaml
421464
Type: SwitchParameter

‎skype/skype-ps/skype/Remove-CsHuntGroup.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
external help file:
2+
external help file: Remove-CsHuntGroup.xml
33
applicable: Skype for Business Online
44
title: Remove-CsHuntGroup
55
schema: 2.0.0
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Remove-CsHuntGroup
99

1010
## SYNOPSIS
11-
Provide the topic introduction here.
11+
The Remove-CsHuntGroup cmdlet deletes an existing call queue.
1212

1313
## SYNTAX
1414

@@ -18,16 +18,20 @@ Remove-CsHuntGroup [-PrimaryUri <Object>] [-BypassDualWrite <Object>] [-Confirm]
1818
```
1919

2020
## DESCRIPTION
21-
Provide the detailed description here.
21+
The Remove-CsHuntGroup cmdlet deletes an existing call queue specified by the PrimaryUri parameter.
22+
23+
If you are a hybrid tenant, you may need to execute additional cmdlets on your on-premise deployments. The Remove-CsHuntGroup will request further steps, if those steps are necessary for you.
2224

2325
## EXAMPLES
2426

2527
### -------------------------- Example 1 --------------------------
2628
```
27-
Insert example commands for example 1.
29+
Remove-CsHuntGroup -PrimaryUri "sip:[email protected]"
2830
```
2931

30-
Insert descriptive text for example 1.
32+
This example deletes the call queue with the primary uri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com".
33+
34+
3135

3236

3337
## PARAMETERS
@@ -41,7 +45,7 @@ Parameter Sets: (All)
4145
Aliases:
4246
Applicable: Skype for Business Online
4347

44-
Required: False
48+
Required: True
4549
Position: Named
4650
Default value: None
4751
Accept pipeline input: False
@@ -145,7 +149,7 @@ Accept wildcard characters: False
145149
```
146150
147151
### -AsJob
148-
{{Fill AsJob Description}}
152+
PARAMVALUE: SwitchParameter
149153
150154
```yaml
151155
Type: SwitchParameter
@@ -164,8 +168,11 @@ Accept wildcard characters: False
164168
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
165169
166170
## INPUTS
171+
### System.Uri
172+
Represents the SIP uri of a call queue.
167173
168174
## OUTPUTS
175+
### Microsoft.Skype.Rgs.Configuration.Huntgroup
169176
170177
## NOTES
171178

0 commit comments

Comments
 (0)