docs/VoicemailApi.md in purecloudplatformclientv2-34.0.0 vs docs/VoicemailApi.md in purecloudplatformclientv2-35.0.0
- old
+ new
@@ -36,17 +36,23 @@
<a name="delete_voicemail_message"></a>
## - delete_voicemail_message(message_id)
+
+
Delete a voicemail message.
A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission.
Wraps DELETE /api/v2/voicemail/messages/{messageId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -94,17 +100,23 @@
<a name="delete_voicemail_messages"></a>
## - delete_voicemail_messages
+
+
Delete all voicemail messages
Wraps DELETE /api/v2/voicemail/messages
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -146,17 +158,23 @@
<a name="get_voicemail_group_mailbox"></a>
## -[**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_voicemail_group_mailbox(group_id)
+
+
Get the group's mailbox information
Wraps GET /api/v2/voicemail/groups/{groupId}/mailbox
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -205,17 +223,23 @@
<a name="get_voicemail_group_messages"></a>
## -[**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_group_messages(group_id, opts)
+
+
List voicemail messages
Wraps GET /api/v2/voicemail/groups/{groupId}/messages
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -270,17 +294,23 @@
<a name="get_voicemail_group_policy"></a>
## -[**VoicemailGroupPolicy**](VoicemailGroupPolicy.html) get_voicemail_group_policy(group_id)
+
+
Get a group's voicemail policy
Wraps GET /api/v2/voicemail/groups/{groupId}/policy
+Requires ANY permissions:
+* directory:group:add* directory:group:edit* group_administration* group_creation
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -329,17 +359,23 @@
<a name="get_voicemail_mailbox"></a>
## -[**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_voicemail_mailbox
+
+
Get the current user's mailbox information
Wraps GET /api/v2/voicemail/mailbox
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -382,17 +418,23 @@
<a name="get_voicemail_me_mailbox"></a>
## -[**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_voicemail_me_mailbox
+
+
Get the current user's mailbox information
Wraps GET /api/v2/voicemail/me/mailbox
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -435,17 +477,23 @@
<a name="get_voicemail_me_messages"></a>
## -[**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_me_messages(opts)
+
+
List voicemail messages
Wraps GET /api/v2/voicemail/me/messages
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -497,17 +545,23 @@
<a name="get_voicemail_me_policy"></a>
## -[**VoicemailUserPolicy**](VoicemailUserPolicy.html) get_voicemail_me_policy
+
+
Get the current user's voicemail policy
Wraps GET /api/v2/voicemail/me/policy
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -550,17 +604,23 @@
<a name="get_voicemail_message"></a>
## -[**VoicemailMessage**](VoicemailMessage.html) get_voicemail_message(message_id, opts)
+
+
Get a voicemail message
Wraps GET /api/v2/voicemail/messages/{messageId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -613,17 +673,23 @@
<a name="get_voicemail_message_media"></a>
## -[**VoicemailMediaInfo**](VoicemailMediaInfo.html) get_voicemail_message_media(message_id, opts)
+
+
Get media playback URI for this voicemail message
Wraps GET /api/v2/voicemail/messages/{messageId}/media
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -676,17 +742,23 @@
<a name="get_voicemail_messages"></a>
## -[**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_messages(opts)
+
+
List voicemail messages
Wraps GET /api/v2/voicemail/messages
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -738,17 +810,23 @@
<a name="get_voicemail_policy"></a>
## -[**VoicemailOrganizationPolicy**](VoicemailOrganizationPolicy.html) get_voicemail_policy
+
+
Get a policy
Wraps GET /api/v2/voicemail/policy
+Requires ANY permissions:
+* telephony:plugin:all
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -791,17 +869,23 @@
<a name="get_voicemail_queue_messages"></a>
## -[**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_queue_messages(queue_id, opts)
+
+
List voicemail messages
Wraps GET /api/v2/voicemail/queues/{queueId}/messages
+Requires ANY permissions:
+* voicemail:acdVoicemail:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -856,17 +940,23 @@
<a name="get_voicemail_search"></a>
## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) get_voicemail_search(q64, opts)
+
+
Search voicemails using the q64 value returned from a previous search
Wraps GET /api/v2/voicemail/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -919,17 +1009,23 @@
<a name="get_voicemail_userpolicy"></a>
## -[**VoicemailUserPolicy**](VoicemailUserPolicy.html) get_voicemail_userpolicy(user_id)
+
+
Get a user's voicemail policy
Wraps GET /api/v2/voicemail/userpolicies/{userId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -978,17 +1074,23 @@
<a name="patch_voicemail_group_policy"></a>
## -[**VoicemailGroupPolicy**](VoicemailGroupPolicy.html) patch_voicemail_group_policy(group_id, body)
+
+
Update a group's voicemail policy
Wraps PATCH /api/v2/voicemail/groups/{groupId}/policy
+Requires ANY permissions:
+* directory:group:add* directory:group:edit* group_administration* group_creation
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1040,17 +1142,23 @@
<a name="patch_voicemail_me_policy"></a>
## -[**VoicemailUserPolicy**](VoicemailUserPolicy.html) patch_voicemail_me_policy(body)
+
+
Update the current user's voicemail policy
Wraps PATCH /api/v2/voicemail/me/policy
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1099,17 +1207,23 @@
<a name="patch_voicemail_message"></a>
## -[**VoicemailMessage**](VoicemailMessage.html) patch_voicemail_message(message_id, body)
+
+
Update a voicemail message
A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.
Wraps PATCH /api/v2/voicemail/messages/{messageId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1161,17 +1275,23 @@
<a name="patch_voicemail_userpolicy"></a>
## -[**VoicemailUserPolicy**](VoicemailUserPolicy.html) patch_voicemail_userpolicy(user_id, body)
+
+
Update a user's voicemail policy
Wraps PATCH /api/v2/voicemail/userpolicies/{userId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1223,17 +1343,23 @@
<a name="post_voicemail_messages"></a>
## -[**VoicemailMessage**](VoicemailMessage.html) post_voicemail_messages(opts)
+
+
Copy a voicemail message to a user or group
Wraps POST /api/v2/voicemail/messages
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1283,17 +1409,23 @@
<a name="post_voicemail_search"></a>
## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) post_voicemail_search(body)
+
+
Search voicemails
Wraps POST /api/v2/voicemail/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1342,17 +1474,23 @@
<a name="put_voicemail_message"></a>
## -[**VoicemailMessage**](VoicemailMessage.html) put_voicemail_message(message_id, body)
+
+
Update a voicemail message
A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.
Wraps PUT /api/v2/voicemail/messages/{messageId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1404,14 +1542,20 @@
<a name="put_voicemail_policy"></a>
## -[**VoicemailOrganizationPolicy**](VoicemailOrganizationPolicy.html) put_voicemail_policy(body)
+
+
Update a policy
Wraps PUT /api/v2/voicemail/policy
+
+Requires ANY permissions:
+
+* telephony:plugin:all
### Example
~~~ruby
# load the gem