Skip to content

Commit b1941a8

Browse files
kenwithkenwith
authored
Merge pull request MicrosoftDocs#1841 from CHILIU-MSFT/addvoicemailusersettingscmdletdocs
Add document for Get/Set-CsOnlineVoicemailUserSettings cmdlets
2 parents 2e2820e + 606fc7c commit b1941a8

File tree

2 files changed

+343
-0
lines changed

2 files changed

+343
-0
lines changed

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

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
applicable: Skype for Business Online
4+
title: Get-CsOnlineVoicemailUserSettings
5+
schema: 2.0.0
6+
---
7+
8+
# Get-CsOnlineVoicemailUserSettings
9+
10+
## SYNOPSIS
11+
Use the Get-CsOnlineVoicemailUserSettings cmdlet to get information about online voicemail user settings of a specific user.
12+
13+
## SYNTAX
14+
15+
```
16+
Get-CsOnlineVoicemailUserSettings -Identity <String> [-Tenant <Guid>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
The Get-CsOnlineVoicemailUserSettings cmdlet returns information about online voicemail user settings of a specific user in your organization.
21+
22+
**NOTE**
23+
- **This cmdlet is currently available to PREVIEW customers only.**
24+
25+
## EXAMPLES
26+
27+
### -------------------------- Example 1 --------------------------
28+
```
29+
Get-CsOnlineVoicemailUserSettings -Identity sip:[email protected]
30+
```
31+
32+
This example gets the online voicemail user settings of user with SIP URI sip:user@contoso.com.
33+
34+
### -------------------------- Example 2 --------------------------
35+
```
36+
Get-CsOnlineVoicemailUserSettings -Identity "00000000-0000-0000-0000-000000000000"
37+
```
38+
39+
This example gets the online voicemail user settings of user with Object ID "00000000-0000-0000-0000-000000000000".
40+
41+
42+
## PARAMETERS
43+
44+
### -Identity
45+
The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID.
46+
47+
```yaml
48+
Type: System.String
49+
Parameter Sets: (All)
50+
Aliases:
51+
Applicable: Skype for Business Online
52+
53+
Required: True
54+
Position: Named
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### -Tenant
61+
62+
```yaml
63+
Type: System.Guid
64+
Parameter Sets: (All)
65+
Aliases:
66+
Applicable: Skype for Business Online
67+
68+
Required: False
69+
Position: Named
70+
Default value: None
71+
Accept pipeline input: False
72+
Accept wildcard characters: False
73+
```
74+
75+
### CommonParameters
76+
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).
77+
78+
79+
## INPUTS
80+
81+
### None
82+
83+
## OUTPUTS
84+
85+
### Microsoft.Rtc.Management.Hosted.Voicemail.Models.VoicemailUserSettings
86+
87+
88+
## NOTES
89+
90+
91+
## RELATED LINKS
92+

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

Lines changed: 251 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,251 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
applicable: Skype for Business Online
4+
title: Set-CsOnlineVoicemailUserSettings
5+
schema: 2.0.0
6+
---
7+
8+
# Set-CsOnlineVoicemailUserSettings
9+
10+
## SYNOPSIS
11+
Use the Set-CsOnlineVoicemailUserSettings cmdlet to modify the online voicemail user settings of a specific user.
12+
New online voicemail user settings of the user would be returned after executing.
13+
14+
## SYNTAX
15+
16+
```
17+
Set-CsOnlineVoicemailUserSettings -Identity <String> [-VoicemailEnabled <Boolean>] [-PromptLanguage <String>] [-OofGreetingEnabled <Boolean>] [-OofGreetingFollowAutomaticRepliesEnabled <Boolean>] [-OofGreetingFollowCalendarEnabled <Boolean>] [-CallAnswerRule <DeclineCall | PromptOnly | PromptOnlyWithTransfer | RegularVoicemail | VoicemailWithTransferOption>] [-TransferTarget <String>] [-Tenant <Guid>] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
The Set-CsOnlineVoicemailUserSettings cmdlet lets tenant admin modify the online voicemail user settings of a specific user in the organization. New online voicemail user settings of the user would be returned after executing.
22+
For example, tenant admin could enable/disable voicemail, change voicemail prompt language, modify out-of-office voicemail greeting settings, or setup simple call answer rules. Only those properties that tenant admin have actually provided with be modified. If an online voicemail user setting was not set by tenant admin, it would remain the old value after this cmdlet has been executed.
23+
24+
**NOTE**
25+
- **This cmdlet is currently available to PREVIEW customers only.**
26+
27+
## EXAMPLES
28+
29+
### -------------------------- Example 1 --------------------------
30+
```
31+
Set-CsOnlineVoicemailUserSettings -Identity sip:[email protected] -VoicemailEnabled $true
32+
```
33+
34+
This example changes VoicemailEnabled setting to true for the user with SIP URI sip:user@contoso.com.
35+
36+
### -------------------------- Example 2 --------------------------
37+
```
38+
Set-CsOnlineVoicemailUserSettings -Identity "00000000-0000-0000-0000-000000000000" -PromptLanguage "en-US" -OofGreetingFollowCalendarEnabled $false
39+
```
40+
41+
This example changes PromptLanguage setting to "en-US" and OofGreetingFollowCalendarEnabled setting to false for the user with Object ID "00000000-0000-0000-0000-000000000000".
42+
43+
### -------------------------- Example 3 --------------------------
44+
```
45+
Set-CsOnlineVoicemailUserSettings -Identity "00000000-0000-0000-0000-000000000000" -CallAnswerRule PromptOnlyWithTransfer -TransferTarget sip:[email protected]
46+
```
47+
48+
This example changes CallAnswerRule setting to PromptOnlyWithTransfer and set TransferTarget to "sip:user2@contoso.com" for the user with Object ID "00000000-0000-0000-0000-000000000000".
49+
50+
51+
## PARAMETERS
52+
53+
### -Identity
54+
The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID.
55+
56+
```yaml
57+
Type: System.String
58+
Parameter Sets: (All)
59+
Aliases:
60+
Applicable: Skype for Business Online
61+
62+
Required: True
63+
Position: Named
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
### -VoicemailEnabled
70+
The VoicemailEnabled parameter represents whether to enable voicemail service.
71+
72+
```yaml
73+
Type: System.Boolean
74+
Parameter Sets: (All)
75+
Aliases:
76+
Applicable: Skype for Business Online
77+
78+
Required: False
79+
Position: Named
80+
Default value: None
81+
Accept pipeline input: False
82+
Accept wildcard characters: False
83+
```
84+
85+
### -PromptLanguage
86+
The PromptLanguage parameter represents the language that is used to play voicemail prompts.
87+
88+
Now the following languages are supported:
89+
90+
- "ar-EG" (Arabic - Egypt)
91+
- "ca-ES" (Catalan - Catalan)
92+
- "da-DK" (Danish - Denmark)
93+
- "de-DE" (German - Germany)
94+
- "en-AU" (English - Australia)
95+
- "en-CA" (English - Canada)
96+
- "en-GB" (English - United Kingdom)
97+
- "en-IN" (English - India)
98+
- "en-US" (English - United States)
99+
- "es-ES" (Spanish - Spain)
100+
- "es-MX" (Spanish - Mexico)
101+
- "fi-FI" (Finnish - Finland)
102+
- "fr-CA" (French - Canada)
103+
- "fr-FR" (French - France)
104+
- "it-IT" (Italian - Italy)
105+
- "ja-JP" (Japanese - Japan)
106+
- "ko-KR" (Korean - Korea)
107+
- "nl-NL" (Dutch - Netherlands)
108+
- "nb-NO" (Norwegian, Bokmål - Norway)
109+
- "pl-PL" (Polish - Poland)
110+
- "pt-BR" (Portuguese - Brazil)
111+
- "pt-PT" (Portuguese - Portugal)
112+
- "ru-RU" (Russian - Russia)
113+
- "sv-SE" (Swedish - Sweden)
114+
- "tr-TR" (Turkish - Turkey)
115+
- "zh-CN" (Chinese - Simplified, PRC)
116+
- "zh-TW" (Chinese - Traditional, Taiwan)
117+
- "zh-HK" (Chinese - Traditional, Hong Kong S.A.R.)
118+
119+
```yaml
120+
Type: System.String
121+
Parameter Sets: (All)
122+
Aliases:
123+
Applicable: Skype for Business Online
124+
125+
Required: False
126+
Position: Named
127+
Default value: None
128+
Accept pipeline input: False
129+
Accept wildcard characters: False
130+
```
131+
132+
### -OofGreetingEnabled
133+
The OofGreetingEnabled parameter represents whether to play out-of-office greeting in voicemail deposit scenario.
134+
135+
```yaml
136+
Type: System.Boolean
137+
Parameter Sets: (All)
138+
Aliases:
139+
Applicable: Skype for Business Online
140+
141+
Required: False
142+
Position: Named
143+
Default value: None
144+
Accept pipeline input: False
145+
Accept wildcard characters: False
146+
```
147+
148+
### -OofGreetingFollowAutomaticRepliesEnabled
149+
The OofGreetingFollowAutomaticRepliesEnabled parameter represents whether to play out-of-office greeting in voicemail deposit scenario when user set automatic replies in Outlook.
150+
151+
```yaml
152+
Type: System.Boolean
153+
Parameter Sets: (All)
154+
Aliases:
155+
Applicable: Skype for Business Online
156+
157+
Required: False
158+
Position: Named
159+
Default value: None
160+
Accept pipeline input: False
161+
Accept wildcard characters: False
162+
```
163+
164+
### -OofGreetingFollowCalendarEnabled
165+
The OofGreetingFollowCalendarEnabled parameter represents whether to play out-of-office greeting in voicemail deposit scenario when user set out-of-office in calendar.
166+
167+
```yaml
168+
Type: System.Boolean
169+
Parameter Sets: (All)
170+
Aliases:
171+
Applicable: Skype for Business Online
172+
173+
Required: False
174+
Position: Named
175+
Default value: None
176+
Accept pipeline input: False
177+
Accept wildcard characters: False
178+
```
179+
180+
### -CallAnswerRule
181+
The CallAnswerRule parameter represents the value of the call answer rule, which can be any of the following:
182+
183+
- DeclineCall
184+
- PromptOnly
185+
- PromptOnlyWithTransfer
186+
- RegularVoicemail
187+
- VoicemailWithTransferOption
188+
189+
```yaml
190+
Type: Object
191+
Parameter Sets: (All)
192+
Aliases:
193+
Applicable: Skype for Business Online
194+
195+
Required: False
196+
Position: Named
197+
Default value: None
198+
Accept pipeline input: False
199+
Accept wildcard characters: False
200+
```
201+
202+
### -TransferTarget
203+
The TransferTarget parameter represents the target to transfer the call when call answer rule set to PromptOnlyWithTransfer or VoicemailWithTransferOption.
204+
Value of this parameter should be a SIP URI of another user, an auto attendant, or a hunt group (call queue) in your organization.
205+
206+
```yaml
207+
Type: System.String
208+
Parameter Sets: (All)
209+
Aliases:
210+
Applicable: Skype for Business Online
211+
212+
Required: False
213+
Position: Named
214+
Default value: None
215+
Accept pipeline input: False
216+
Accept wildcard characters: False
217+
```
218+
219+
### -Tenant
220+
221+
```yaml
222+
Type: System.Guid
223+
Parameter Sets: (All)
224+
Aliases:
225+
Applicable: Skype for Business Online
226+
227+
Required: False
228+
Position: Named
229+
Default value: None
230+
Accept pipeline input: False
231+
Accept wildcard characters: False
232+
```
233+
234+
### CommonParameters
235+
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).
236+
237+
238+
## INPUTS
239+
240+
### None
241+
242+
## OUTPUTS
243+
244+
### Microsoft.Rtc.Management.Hosted.Voicemail.Models.VoicemailUserSettings
245+
246+
247+
## NOTES
248+
249+
250+
## RELATED LINKS
251+

0 commit comments

Comments
 (0)