docs/VoicemailApi.md in purecloudplatformclientv2-49.0.0 vs docs/VoicemailApi.md in purecloudplatformclientv2-49.0.1
- old
+ new
@@ -34,11 +34,11 @@
[**put_voicemail_policy**](VoicemailApi.html#put_voicemail_policy) | Update a policy
{: class="table table-striped"}
<a name="delete_voicemail_message"></a>
-## - delete_voicemail_message(message_id)
+## delete_voicemail_message(message_id)
Delete a voicemail message.
@@ -49,11 +49,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -74,11 +74,11 @@
#Delete a voicemail message.
api_instance.delete_voicemail_message(message_id)
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->delete_voicemail_message: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -97,11 +97,11 @@
<a name="delete_voicemail_messages"></a>
-## - delete_voicemail_messages
+## delete_voicemail_messages
Delete all voicemail messages
@@ -112,11 +112,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -134,11 +134,11 @@
#Delete all voicemail messages
api_instance.delete_voicemail_messages
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->delete_voicemail_messages: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -154,11 +154,11 @@
<a name="get_voicemail_group_mailbox"></a>
-## -[**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_voicemail_group_mailbox(group_id)
+## [**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_voicemail_group_mailbox(group_id)
Get the group's mailbox information
@@ -169,11 +169,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -195,11 +195,11 @@
result = api_instance.get_voicemail_group_mailbox(group_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_group_mailbox: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -218,11 +218,11 @@
<a name="get_voicemail_group_messages"></a>
-## -[**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_group_messages(group_id, opts)
+## [**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_group_messages(group_id, opts)
List voicemail messages
@@ -233,11 +233,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -263,11 +263,11 @@
result = api_instance.get_voicemail_group_messages(group_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_group_messages: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -288,11 +288,11 @@
<a name="get_voicemail_group_policy"></a>
-## -[**VoicemailGroupPolicy**](VoicemailGroupPolicy.html) get_voicemail_group_policy(group_id)
+## [**VoicemailGroupPolicy**](VoicemailGroupPolicy.html) get_voicemail_group_policy(group_id)
Get a group's voicemail policy
@@ -307,11 +307,11 @@
* group_administration
* group_creation
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -333,11 +333,11 @@
result = api_instance.get_voicemail_group_policy(group_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_group_policy: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -356,11 +356,11 @@
<a name="get_voicemail_mailbox"></a>
-## -[**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_voicemail_mailbox
+## [**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_voicemail_mailbox
Get the current user's mailbox information
@@ -371,11 +371,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -394,11 +394,11 @@
result = api_instance.get_voicemail_mailbox
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_mailbox: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -414,11 +414,11 @@
<a name="get_voicemail_me_mailbox"></a>
-## -[**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_voicemail_me_mailbox
+## [**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_voicemail_me_mailbox
Get the current user's mailbox information
@@ -429,11 +429,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -452,11 +452,11 @@
result = api_instance.get_voicemail_me_mailbox
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_me_mailbox: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -472,11 +472,11 @@
<a name="get_voicemail_me_messages"></a>
-## -[**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_me_messages(opts)
+## [**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_me_messages(opts)
List voicemail messages
@@ -487,11 +487,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -515,11 +515,11 @@
result = api_instance.get_voicemail_me_messages(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_me_messages: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -539,11 +539,11 @@
<a name="get_voicemail_me_policy"></a>
-## -[**VoicemailUserPolicy**](VoicemailUserPolicy.html) get_voicemail_me_policy
+## [**VoicemailUserPolicy**](VoicemailUserPolicy.html) get_voicemail_me_policy
Get the current user's voicemail policy
@@ -554,11 +554,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -577,11 +577,11 @@
result = api_instance.get_voicemail_me_policy
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_me_policy: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -597,11 +597,11 @@
<a name="get_voicemail_message"></a>
-## -[**VoicemailMessage**](VoicemailMessage.html) get_voicemail_message(message_id, opts)
+## [**VoicemailMessage**](VoicemailMessage.html) get_voicemail_message(message_id, opts)
Get a voicemail message
@@ -612,11 +612,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -641,11 +641,11 @@
result = api_instance.get_voicemail_message(message_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_message: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -665,11 +665,11 @@
<a name="get_voicemail_message_media"></a>
-## -[**VoicemailMediaInfo**](VoicemailMediaInfo.html) get_voicemail_message_media(message_id, opts)
+## [**VoicemailMediaInfo**](VoicemailMediaInfo.html) get_voicemail_message_media(message_id, opts)
Get media playback URI for this voicemail message
@@ -680,11 +680,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -709,11 +709,11 @@
result = api_instance.get_voicemail_message_media(message_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_message_media: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -733,11 +733,11 @@
<a name="get_voicemail_messages"></a>
-## -[**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_messages(opts)
+## [**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_messages(opts)
List voicemail messages
@@ -748,11 +748,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -776,11 +776,11 @@
result = api_instance.get_voicemail_messages(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_messages: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -800,11 +800,11 @@
<a name="get_voicemail_policy"></a>
-## -[**VoicemailOrganizationPolicy**](VoicemailOrganizationPolicy.html) get_voicemail_policy
+## [**VoicemailOrganizationPolicy**](VoicemailOrganizationPolicy.html) get_voicemail_policy
Get a policy
@@ -816,11 +816,11 @@
* telephony:plugin:all
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -839,11 +839,11 @@
result = api_instance.get_voicemail_policy
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_policy: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -859,11 +859,11 @@
<a name="get_voicemail_queue_messages"></a>
-## -[**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_queue_messages(queue_id, opts)
+## [**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_queue_messages(queue_id, opts)
List voicemail messages
@@ -875,11 +875,11 @@
* voicemail:acdVoicemail:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -905,11 +905,11 @@
result = api_instance.get_voicemail_queue_messages(queue_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_queue_messages: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -930,11 +930,11 @@
<a name="get_voicemail_search"></a>
-## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) get_voicemail_search(q64, opts)
+## [**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) get_voicemail_search(q64, opts)
Search voicemails using the q64 value returned from a previous search
@@ -945,11 +945,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -974,11 +974,11 @@
result = api_instance.get_voicemail_search(q64, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -998,11 +998,11 @@
<a name="get_voicemail_userpolicy"></a>
-## -[**VoicemailUserPolicy**](VoicemailUserPolicy.html) get_voicemail_userpolicy(user_id)
+## [**VoicemailUserPolicy**](VoicemailUserPolicy.html) get_voicemail_userpolicy(user_id)
Get a user's voicemail policy
@@ -1013,11 +1013,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1039,11 +1039,11 @@
result = api_instance.get_voicemail_userpolicy(user_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->get_voicemail_userpolicy: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1062,11 +1062,11 @@
<a name="patch_voicemail_group_policy"></a>
-## -[**VoicemailGroupPolicy**](VoicemailGroupPolicy.html) patch_voicemail_group_policy(group_id, body)
+## [**VoicemailGroupPolicy**](VoicemailGroupPolicy.html) patch_voicemail_group_policy(group_id, body)
Update a group's voicemail policy
@@ -1081,11 +1081,11 @@
* group_administration
* group_creation
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1109,11 +1109,11 @@
result = api_instance.patch_voicemail_group_policy(group_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->patch_voicemail_group_policy: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1133,11 +1133,11 @@
<a name="patch_voicemail_me_policy"></a>
-## -[**VoicemailUserPolicy**](VoicemailUserPolicy.html) patch_voicemail_me_policy(body)
+## [**VoicemailUserPolicy**](VoicemailUserPolicy.html) patch_voicemail_me_policy(body)
Update the current user's voicemail policy
@@ -1148,11 +1148,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1174,11 +1174,11 @@
result = api_instance.patch_voicemail_me_policy(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->patch_voicemail_me_policy: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1197,11 +1197,11 @@
<a name="patch_voicemail_message"></a>
-## -[**VoicemailMessage**](VoicemailMessage.html) patch_voicemail_message(message_id, body)
+## [**VoicemailMessage**](VoicemailMessage.html) patch_voicemail_message(message_id, body)
Update a voicemail message
@@ -1212,11 +1212,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1240,11 +1240,11 @@
result = api_instance.patch_voicemail_message(message_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->patch_voicemail_message: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1264,11 +1264,11 @@
<a name="patch_voicemail_userpolicy"></a>
-## -[**VoicemailUserPolicy**](VoicemailUserPolicy.html) patch_voicemail_userpolicy(user_id, body)
+## [**VoicemailUserPolicy**](VoicemailUserPolicy.html) patch_voicemail_userpolicy(user_id, body)
Update a user's voicemail policy
@@ -1279,11 +1279,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1307,11 +1307,11 @@
result = api_instance.patch_voicemail_userpolicy(user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->patch_voicemail_userpolicy: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1331,11 +1331,11 @@
<a name="post_voicemail_messages"></a>
-## -[**VoicemailMessage**](VoicemailMessage.html) post_voicemail_messages(opts)
+## [**VoicemailMessage**](VoicemailMessage.html) post_voicemail_messages(opts)
Copy a voicemail message to a user or group
@@ -1346,11 +1346,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1373,11 +1373,11 @@
result = api_instance.post_voicemail_messages(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->post_voicemail_messages: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1396,11 +1396,11 @@
<a name="post_voicemail_search"></a>
-## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) post_voicemail_search(body)
+## [**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) post_voicemail_search(body)
Search voicemails
@@ -1411,11 +1411,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1437,11 +1437,11 @@
result = api_instance.post_voicemail_search(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->post_voicemail_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1460,11 +1460,11 @@
<a name="put_voicemail_message"></a>
-## -[**VoicemailMessage**](VoicemailMessage.html) put_voicemail_message(message_id, body)
+## [**VoicemailMessage**](VoicemailMessage.html) put_voicemail_message(message_id, body)
Update a voicemail message
@@ -1475,11 +1475,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1503,11 +1503,11 @@
result = api_instance.put_voicemail_message(message_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->put_voicemail_message: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1527,11 +1527,11 @@
<a name="put_voicemail_policy"></a>
-## -[**VoicemailOrganizationPolicy**](VoicemailOrganizationPolicy.html) put_voicemail_policy(body)
+## [**VoicemailOrganizationPolicy**](VoicemailOrganizationPolicy.html) put_voicemail_policy(body)
Update a policy
@@ -1543,11 +1543,11 @@
* telephony:plugin:all
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1569,10 +1569,10 @@
result = api_instance.put_voicemail_policy(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling VoicemailApi->put_voicemail_policy: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------