Skip to content
This repository was archived by the owner on Dec 27, 2017. It is now read-only.

Commit e7f1c04

Browse files
muwaqarmuwaqar
authored
Call Queue cmdlets Doc updated
Call Queue cmdlets Doc updated
2 parents 3a27194 + e91fd7c commit e7f1c04

File tree

5 files changed

+90
-52
lines changed

5 files changed

+90
-52
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+
The Get-CsHuntGroup cmdlet may suggest additional steps required to complete the call queue setup.
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: 36 additions & 24 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>]
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>]
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+
The New-CsHuntGroup cmdlet may suggest additional steps required to complete the call queue setup.
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+
```
44+
45+
This example creates a call queue for the organization named "Help Desk" in the domain "litwareinc.com" using default music on hold.
4046

41-
Insert example commands for example 1.
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,21 +72,6 @@ Accept pipeline input: False
6272
Accept wildcard characters: False
6373
```
6474
65-
### -LineUri
66-
PARAMVALUE: Uri
67-
68-
```yaml
69-
Type: Object
70-
Parameter Sets: (All)
71-
Aliases:
72-
Applicable: Skype for Business Online
73-
74-
Required: True
75-
Position: Named
76-
Default value: None
77-
Accept pipeline input: False
78-
Accept wildcard characters: False
79-
```
8075
8176
### -Name
8277
PARAMVALUE: String
@@ -110,6 +105,7 @@ Accept pipeline input: False
110105
Accept wildcard characters: False
111106
```
112107
108+
113109
### -BypassDualWrite
114110
PARAMVALUE: $true | $false
115111
@@ -206,6 +202,22 @@ Accept pipeline input: False
206202
Accept wildcard characters: False
207203
```
208204
205+
### -LineUri
206+
PARAMVALUE: Uri
207+
208+
```yaml
209+
Type: Object
210+
Parameter Sets: (All)
211+
Aliases:
212+
Applicable: Skype for Business Online
213+
214+
Required: False
215+
Position: Named
216+
Default value: None
217+
Accept pipeline input: False
218+
Accept wildcard characters: False
219+
```
220+
209221
### -MusicOnHoldFileContent
210222
PARAMVALUE: Byte\[\]
211223
@@ -415,7 +427,7 @@ Accept wildcard characters: False
415427
```
416428
417429
### -AsJob
418-
{{Fill AsJob Description}}
430+
PARAMVALUE: SwitchParameter
419431
420432
```yaml
421433
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+
The Remove-CsHuntGroup cmdlet may suggest additional steps required to complete the call queue setup.
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

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

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

1010
## SYNOPSIS
11-
Provide the topic introduction here.
11+
Updates a Call Queue in your Skype for Business Online organization.
1212

1313
## SYNTAX
1414

1515
```
16-
Set-CsHuntGroup [-PrimaryUri <Object>] [-AgentAlertTime <Object>] [-BypassDualWrite <Object>]
17-
[-ClientAudience <Object>] [-Confirm] [-DistributionLists <Object>] [-DomainController <Object>] [-Force]
18-
[-HuntGroupServiceCallbackUri <Object>] [-LineUri <Object>] [-MusicOnHoldFileContent <Object>]
19-
[-MusicOnHoldFileName <Object>] [-Name <Object>] [-OverflowAction <Object>] [-OverflowActionTarget <Object>]
20-
[-OverflowThreshold <Object>] [-Tenant <Object>] [-TimeoutAction <Object>] [-TimeoutActionTarget <Object>]
16+
Set-CsHuntGroup [-PrimaryUri <Object>] [-AgentAlertTime <Object>]
17+
[-BypassDualWrite <Object>] [-ClientAudience <Object>] [-Confirm] [-DistributionLists <Object>]
18+
[-DomainController <Object>] [-Force] [-HuntGroupServiceCallbackUri <Object>] [-LineUri <Object>]
19+
[-MusicOnHoldFileContent <Object>] [-MusicOnHoldFileName <Object>] [-Name <Object>]
20+
[-OverflowAction <Object>] [-OverflowActionTarget <Object>] [-OverflowThreshold <Object>]
21+
[-Tenant <Object>] [-TimeoutAction <Object>] [-TimeoutActionTarget <Object>]
2122
[-TimeoutThreshold <Object>] [-UseDefaultMusicOnHold <Object>] [-WelcomeMusicFileContent <Object>]
2223
[-WelcomeMusicFileName <Object>] [-WhatIf] [-AsJob] [<CommonParameters>]
2324
```
2425

2526
## DESCRIPTION
2627

27-
The following parameters are not applicable to Skype for Business Online: AllowOptOut, AsJob, ClientAudience, DomainController, Force, HuntGroupServiceCallbackUri, PipelineVariable, and RoutingMethod
28+
Set-CsHuntGroup cmdlet provides a way for you to modify the properties of an existing call queue; for example, you can change the phone number for the call queue, the distribution lists associated with the huntgroup, or the welcome audio file.
29+
30+
The Set-CsHuntGroup cmdlet may suggest additional steps required to complete the call queue setup.
31+
32+
The following parameters are not applicable to Skype for Business Online: AsJob, ClientAudience, DomainController, Force, HuntGroupServiceCallbackUri, and PipelineVariable
2833

2934
## EXAMPLES
3035

31-
### -------------------------- Example 1 --------------------------
36+
### -------------------------- Example 1 --------------------------
37+
```
38+
Set-CsHuntGroup -PrimaryUri "sip:[email protected]" -UseDefaultMusicOnHold $true
39+
```
40+
41+
This example updates the call queue with primary uri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com" by making it use the default music on hold.
42+
43+
### -------------------------- Example 2 --------------------------
3244
```
33-
Insert example commands for example 1.
45+
$musicOnHoldContent = Get-Content ".\MusicOnHold.wav" -ReadCount 0 -Encoding Byte
46+
Set-CsHuntGroup -PrimaryUri "sip:[email protected]" -LineUri "tel:+19998881234" -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -MusicOnHoldFileName "MusicOnHold.wav" -MusicOnHoldFileContent $musicOnHoldContent
3447
```
3548

36-
Insert descriptive text for example 1.
49+
This example saves the contents of music on hold to a temporary variable. Then, it updates the call queue with new phone number, distribution lists, and the name and content of the music on hold file.
3750

3851

3952
## PARAMETERS
@@ -47,7 +60,7 @@ Parameter Sets: (All)
4760
Aliases:
4861
Applicable: Skype for Business Online
4962

50-
Required: False
63+
Required: True
5164
Position: Named
5265
Default value: None
5366
Accept pipeline input: False
@@ -70,6 +83,7 @@ Accept pipeline input: False
7083
Accept wildcard characters: False
7184
```
7285
86+
7387
### -BypassDualWrite
7488
PARAMVALUE: $true | $false
7589
@@ -294,6 +308,7 @@ Accept pipeline input: False
294308
Accept wildcard characters: False
295309
```
296310
311+
297312
### -Tenant
298313
PARAMVALUE: Guid
299314
@@ -423,7 +438,7 @@ Accept wildcard characters: False
423438
```
424439
425440
### -AsJob
426-
{{Fill AsJob Description}}
441+
PARAMVALUE: SwitchParameter
427442
428443
```yaml
429444
Type: SwitchParameter

0 commit comments

Comments
 (0)