ultracart_api 3.10.191 → 3.10.193
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +19 -4
- data/docs/AutoOrder.md +1 -0
- data/docs/AutoOrderItem.md +2 -0
- data/docs/ConversationApi.md +408 -0
- data/docs/ConversationPbxVoicemailMessage.md +20 -0
- data/docs/ConversationPbxVoicemailMessageResponse.md +12 -0
- data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +12 -0
- data/docs/ConversationPbxVoicemailMessageSummary.md +17 -0
- data/docs/ItemApi.md +53 -0
- data/docs/WorkflowTask.md +2 -2
- data/docs/WorkflowTasksRequest.md +2 -0
- data/lib/ultracart_api/api/conversation_api.rb +448 -0
- data/lib/ultracart_api/api/item_api.rb +60 -0
- data/lib/ultracart_api/models/auto_order.rb +11 -1
- data/lib/ultracart_api/models/auto_order_item.rb +21 -1
- data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +29 -5
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +339 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +223 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +309 -0
- data/lib/ultracart_api/models/workflow_task.rb +2 -2
- data/lib/ultracart_api/models/workflow_tasks_request.rb +21 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +10 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 55941bc46b67a46d7df5bee22e345c8bbadd7b595d3c2710fa0808760fbc180c
|
4
|
+
data.tar.gz: a46044f44d9df9daaa3cc228ba4d0b782935baee6a06f1ba52e1ff993774271a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2c1f64049f617c604437b8be7454bc42ac5fa9aa52f17eee49c3879edb3ae88a8f8408902cbb3329d4654e98a443e3d8f54c12b1a7f814e93db7cfe05e77a674
|
7
|
+
data.tar.gz: c2df03ac5a0dfdca71f01e4404027561edb2ddcdb71c4f58f8f3870344efb6176c240a8b8db283f720105902921d25695996e748585bcbba43d40d7d7eb480ae
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.10.
|
10
|
+
- Package version: 3.10.193
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.10.
|
27
|
+
gem install ./ultracart_api-3.10.193.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.193.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.193'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -136,10 +136,12 @@ Class | Method | HTTP request | Description
|
|
136
136
|
*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
137
137
|
*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
138
138
|
*UltracartClient::ConversationApi* | [**delete_pbx_agent**](docs/ConversationApi.md#delete_pbx_agent) | **DELETE** /conversation/pbx/agent/{conversationPbxAgentUuid} | Delete pbx agent
|
139
|
+
*UltracartClient::ConversationApi* | [**delete_pbx_agent_voicemail**](docs/ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
|
139
140
|
*UltracartClient::ConversationApi* | [**delete_pbx_audio**](docs/ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
|
140
141
|
*UltracartClient::ConversationApi* | [**delete_pbx_menu**](docs/ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
|
141
142
|
*UltracartClient::ConversationApi* | [**delete_pbx_phone_number**](docs/ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
|
142
143
|
*UltracartClient::ConversationApi* | [**delete_pbx_queue**](docs/ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue
|
144
|
+
*UltracartClient::ConversationApi* | [**delete_pbx_queue_voicemail**](docs/ConversationApi.md#delete_pbx_queue_voicemail) | **DELETE** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Delete Queue Voicemail
|
143
145
|
*UltracartClient::ConversationApi* | [**delete_pbx_time_based**](docs/ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased
|
144
146
|
*UltracartClient::ConversationApi* | [**delete_pbx_time_range**](docs/ConversationApi.md#delete_pbx_time_range) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange
|
145
147
|
*UltracartClient::ConversationApi* | [**delete_pbx_voicemail_mailbox**](docs/ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
|
@@ -164,6 +166,8 @@ Class | Method | HTTP request | Description
|
|
164
166
|
*UltracartClient::ConversationApi* | [**get_conversations_search**](docs/ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
|
165
167
|
*UltracartClient::ConversationApi* | [**get_locations_for_engagement**](docs/ConversationApi.md#get_locations_for_engagement) | **POST** /conversation/locations | Get location data for engagement configuration
|
166
168
|
*UltracartClient::ConversationApi* | [**get_pbx_agent**](docs/ConversationApi.md#get_pbx_agent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent
|
169
|
+
*UltracartClient::ConversationApi* | [**get_pbx_agent_voicemail**](docs/ConversationApi.md#get_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid} | Get Agent Voicemail
|
170
|
+
*UltracartClient::ConversationApi* | [**get_pbx_agent_voicemails**](docs/ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails
|
167
171
|
*UltracartClient::ConversationApi* | [**get_pbx_agents**](docs/ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents
|
168
172
|
*UltracartClient::ConversationApi* | [**get_pbx_audio**](docs/ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
|
169
173
|
*UltracartClient::ConversationApi* | [**get_pbx_audios**](docs/ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
|
@@ -172,6 +176,8 @@ Class | Method | HTTP request | Description
|
|
172
176
|
*UltracartClient::ConversationApi* | [**get_pbx_phone_number**](docs/ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber
|
173
177
|
*UltracartClient::ConversationApi* | [**get_pbx_phone_numbers**](docs/ConversationApi.md#get_pbx_phone_numbers) | **GET** /conversation/pbx/phone_number | Get pbx phoneNumbers
|
174
178
|
*UltracartClient::ConversationApi* | [**get_pbx_queue**](docs/ConversationApi.md#get_pbx_queue) | **GET** /conversation/pbx/queue/{conversationPbxQueueUuid} | Get pbx queue
|
179
|
+
*UltracartClient::ConversationApi* | [**get_pbx_queue_voicemail**](docs/ConversationApi.md#get_pbx_queue_voicemail) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Get Queue Voicemail
|
180
|
+
*UltracartClient::ConversationApi* | [**get_pbx_queue_voicemails**](docs/ConversationApi.md#get_pbx_queue_voicemails) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails | Get Queue Voicemails
|
175
181
|
*UltracartClient::ConversationApi* | [**get_pbx_queues**](docs/ConversationApi.md#get_pbx_queues) | **GET** /conversation/pbx/queue | Get pbx queues
|
176
182
|
*UltracartClient::ConversationApi* | [**get_pbx_time_based**](docs/ConversationApi.md#get_pbx_time_based) | **GET** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Get pbx timeBased
|
177
183
|
*UltracartClient::ConversationApi* | [**get_pbx_time_baseds**](docs/ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds
|
@@ -192,6 +198,8 @@ Class | Method | HTTP request | Description
|
|
192
198
|
*UltracartClient::ConversationApi* | [**insert_pbx_voicemail_mailbox**](docs/ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox
|
193
199
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
194
200
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
201
|
+
*UltracartClient::ConversationApi* | [**listened_pbx_agent_voicemail**](docs/ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail
|
202
|
+
*UltracartClient::ConversationApi* | [**listened_pbx_queue_voicemail**](docs/ConversationApi.md#listened_pbx_queue_voicemail) | **GET** /conversation/pbx/{queue_uuid}/voicemails/voicemails/{recording_sid}/listened | Listened Queue Voicemail
|
195
203
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
196
204
|
*UltracartClient::ConversationApi* | [**reset_conversation_pbx_queue_statistics**](docs/ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue
|
197
205
|
*UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
|
@@ -298,6 +306,7 @@ Class | Method | HTTP request | Description
|
|
298
306
|
*UltracartClient::ItemApi* | [**insert_digital_item**](docs/ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
|
299
307
|
*UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
|
300
308
|
*UltracartClient::ItemApi* | [**insert_review**](docs/ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
|
309
|
+
*UltracartClient::ItemApi* | [**insert_update_item_content_attribute**](docs/ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute
|
301
310
|
*UltracartClient::ItemApi* | [**update_digital_item**](docs/ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
|
302
311
|
*UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
|
303
312
|
*UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
|
@@ -773,6 +782,10 @@ Class | Method | HTTP request | Description
|
|
773
782
|
- [UltracartClient::ConversationPbxVoicemailMailbox](docs/ConversationPbxVoicemailMailbox.md)
|
774
783
|
- [UltracartClient::ConversationPbxVoicemailMailboxResponse](docs/ConversationPbxVoicemailMailboxResponse.md)
|
775
784
|
- [UltracartClient::ConversationPbxVoicemailMailboxesResponse](docs/ConversationPbxVoicemailMailboxesResponse.md)
|
785
|
+
- [UltracartClient::ConversationPbxVoicemailMessage](docs/ConversationPbxVoicemailMessage.md)
|
786
|
+
- [UltracartClient::ConversationPbxVoicemailMessageResponse](docs/ConversationPbxVoicemailMessageResponse.md)
|
787
|
+
- [UltracartClient::ConversationPbxVoicemailMessageSummariesResponse](docs/ConversationPbxVoicemailMessageSummariesResponse.md)
|
788
|
+
- [UltracartClient::ConversationPbxVoicemailMessageSummary](docs/ConversationPbxVoicemailMessageSummary.md)
|
776
789
|
- [UltracartClient::ConversationPermissions](docs/ConversationPermissions.md)
|
777
790
|
- [UltracartClient::ConversationPermissionsResponse](docs/ConversationPermissionsResponse.md)
|
778
791
|
- [UltracartClient::ConversationResponse](docs/ConversationResponse.md)
|
@@ -1486,6 +1499,8 @@ Not every change is committed to every SDK.
|
|
1486
1499
|
|
1487
1500
|
| Version | Date | Comments |
|
1488
1501
|
| --: | :-: | --- |
|
1502
|
+
| 3.10.193 | 04/04/2024 | AutoOrder.calculated_next_shipment_dts |
|
1503
|
+
| 3.10.192 | 04/01/2024 | added merchant_id as read-only top level property of AutoOrder object |
|
1489
1504
|
| 3.10.191 | 03/26/2024 | WorkflowTask - added assigned_to_user_or_group field |
|
1490
1505
|
| 3.10.190 | 03/25/2024 | workflowtask - add global_task_number and object_task_number |
|
1491
1506
|
| 3.10.189 | 03/25/2024 | added sales_rep_code to Channel partner order |
|
data/docs/AutoOrder.md
CHANGED
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
|
|
20
20
|
**items** | [**Array<AutoOrderItem>**](AutoOrderItem.md) | The items that are setup to rebill | [optional]
|
21
21
|
**logs** | [**Array<AutoOrderLog>**](AutoOrderLog.md) | Logs associated with this auto order | [optional]
|
22
22
|
**management** | [**AutoOrderManagement**](AutoOrderManagement.md) | | [optional]
|
23
|
+
**merchant_id** | **String** | UltraCart merchant ID owning this order | [optional]
|
23
24
|
**next_attempt** | **String** | The next time that the auto order will be attempted for processing | [optional]
|
24
25
|
**original_order** | [**Order**](Order.md) | | [optional]
|
25
26
|
**original_order_id** | **String** | The original order id that this auto order is associated with. | [optional]
|
data/docs/AutoOrderItem.md
CHANGED
@@ -10,11 +10,13 @@ Name | Type | Description | Notes
|
|
10
10
|
**arbitrary_unit_cost** | **Float** | Arbitrary unit cost that rebills of this item should occur at | [optional]
|
11
11
|
**arbitrary_unit_cost_remaining_orders** | **Integer** | The number of rebills to give the arbitrary unit cost on before reverting to normal pricing. | [optional]
|
12
12
|
**auto_order_item_oid** | **Integer** | Primary key of AutoOrderItem | [optional]
|
13
|
+
**calculated_next_shipment_dts** | **String** | Calculated Date/time that this item is scheduled to rebill. Will be null if no more shipments are going to occur on this item | [optional]
|
13
14
|
**first_order_dts** | **String** | Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet. | [optional]
|
14
15
|
**frequency** | **String** | Frequency of the rebill if not a fixed schedule | [optional]
|
15
16
|
**future_schedules** | [**Array<AutoOrderItemFutureSchedule>**](AutoOrderItemFutureSchedule.md) | The future rebill schedule for this item up to the next ten rebills | [optional]
|
16
17
|
**last_order_dts** | **String** | Date/time of the last order of this item | [optional]
|
17
18
|
**life_time_value** | **Float** | The life time value of this item including the original purchase | [optional]
|
19
|
+
**next_item_id** | **String** | Calculated next item id | [optional]
|
18
20
|
**next_preshipment_notice_dts** | **String** | The date/time of when the next pre-shipment notice should be sent | [optional]
|
19
21
|
**next_shipment_dts** | **String** | Date/time that this item is scheduled to rebill | [optional]
|
20
22
|
**no_order_after_dts** | **String** | Date/time after which no additional rebills of this item should occur | [optional]
|
data/docs/ConversationApi.md
CHANGED
@@ -8,10 +8,12 @@ Method | HTTP request | Description
|
|
8
8
|
[**delete_department**](ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
9
9
|
[**delete_engagement**](ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
10
10
|
[**delete_pbx_agent**](ConversationApi.md#delete_pbx_agent) | **DELETE** /conversation/pbx/agent/{conversationPbxAgentUuid} | Delete pbx agent
|
11
|
+
[**delete_pbx_agent_voicemail**](ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
|
11
12
|
[**delete_pbx_audio**](ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
|
12
13
|
[**delete_pbx_menu**](ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
|
13
14
|
[**delete_pbx_phone_number**](ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
|
14
15
|
[**delete_pbx_queue**](ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue
|
16
|
+
[**delete_pbx_queue_voicemail**](ConversationApi.md#delete_pbx_queue_voicemail) | **DELETE** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Delete Queue Voicemail
|
15
17
|
[**delete_pbx_time_based**](ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased
|
16
18
|
[**delete_pbx_time_range**](ConversationApi.md#delete_pbx_time_range) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange
|
17
19
|
[**delete_pbx_voicemail_mailbox**](ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
|
@@ -36,6 +38,8 @@ Method | HTTP request | Description
|
|
36
38
|
[**get_conversations_search**](ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
|
37
39
|
[**get_locations_for_engagement**](ConversationApi.md#get_locations_for_engagement) | **POST** /conversation/locations | Get location data for engagement configuration
|
38
40
|
[**get_pbx_agent**](ConversationApi.md#get_pbx_agent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent
|
41
|
+
[**get_pbx_agent_voicemail**](ConversationApi.md#get_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid} | Get Agent Voicemail
|
42
|
+
[**get_pbx_agent_voicemails**](ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails
|
39
43
|
[**get_pbx_agents**](ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents
|
40
44
|
[**get_pbx_audio**](ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
|
41
45
|
[**get_pbx_audios**](ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
|
@@ -44,6 +48,8 @@ Method | HTTP request | Description
|
|
44
48
|
[**get_pbx_phone_number**](ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber
|
45
49
|
[**get_pbx_phone_numbers**](ConversationApi.md#get_pbx_phone_numbers) | **GET** /conversation/pbx/phone_number | Get pbx phoneNumbers
|
46
50
|
[**get_pbx_queue**](ConversationApi.md#get_pbx_queue) | **GET** /conversation/pbx/queue/{conversationPbxQueueUuid} | Get pbx queue
|
51
|
+
[**get_pbx_queue_voicemail**](ConversationApi.md#get_pbx_queue_voicemail) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Get Queue Voicemail
|
52
|
+
[**get_pbx_queue_voicemails**](ConversationApi.md#get_pbx_queue_voicemails) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails | Get Queue Voicemails
|
47
53
|
[**get_pbx_queues**](ConversationApi.md#get_pbx_queues) | **GET** /conversation/pbx/queue | Get pbx queues
|
48
54
|
[**get_pbx_time_based**](ConversationApi.md#get_pbx_time_based) | **GET** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Get pbx timeBased
|
49
55
|
[**get_pbx_time_baseds**](ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds
|
@@ -64,6 +70,8 @@ Method | HTTP request | Description
|
|
64
70
|
[**insert_pbx_voicemail_mailbox**](ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox
|
65
71
|
[**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
66
72
|
[**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
73
|
+
[**listened_pbx_agent_voicemail**](ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail
|
74
|
+
[**listened_pbx_queue_voicemail**](ConversationApi.md#listened_pbx_queue_voicemail) | **GET** /conversation/pbx/{queue_uuid}/voicemails/voicemails/{recording_sid}/listened | Listened Queue Voicemail
|
67
75
|
[**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
68
76
|
[**reset_conversation_pbx_queue_statistics**](ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue
|
69
77
|
[**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
|
@@ -281,6 +289,55 @@ Name | Type | Description | Notes
|
|
281
289
|
|
282
290
|
|
283
291
|
|
292
|
+
# **delete_pbx_agent_voicemail**
|
293
|
+
> delete_pbx_agent_voicemail(recording_sid)
|
294
|
+
|
295
|
+
Delete Agent Voicemail
|
296
|
+
|
297
|
+
Delete pbx agent Voicemail
|
298
|
+
|
299
|
+
### Example
|
300
|
+
```ruby
|
301
|
+
# load the gem
|
302
|
+
require 'ultracart_api'
|
303
|
+
|
304
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
305
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
306
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
307
|
+
|
308
|
+
|
309
|
+
recording_sid = 'recording_sid_example' # String |
|
310
|
+
|
311
|
+
|
312
|
+
begin
|
313
|
+
#Delete Agent Voicemail
|
314
|
+
api_instance.delete_pbx_agent_voicemail(recording_sid)
|
315
|
+
rescue UltracartClient::ApiError => e
|
316
|
+
puts "Exception when calling ConversationApi->delete_pbx_agent_voicemail: #{e}"
|
317
|
+
end
|
318
|
+
```
|
319
|
+
|
320
|
+
### Parameters
|
321
|
+
|
322
|
+
Name | Type | Description | Notes
|
323
|
+
------------- | ------------- | ------------- | -------------
|
324
|
+
**recording_sid** | **String**| |
|
325
|
+
|
326
|
+
### Return type
|
327
|
+
|
328
|
+
nil (empty response body)
|
329
|
+
|
330
|
+
### Authorization
|
331
|
+
|
332
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
333
|
+
|
334
|
+
### HTTP request headers
|
335
|
+
|
336
|
+
- **Content-Type**: application/json
|
337
|
+
- **Accept**: application/json
|
338
|
+
|
339
|
+
|
340
|
+
|
284
341
|
# **delete_pbx_audio**
|
285
342
|
> ConversationPbxAudioResponse delete_pbx_audio(conversation_pbx_audio_uuid)
|
286
343
|
|
@@ -481,6 +538,58 @@ Name | Type | Description | Notes
|
|
481
538
|
|
482
539
|
|
483
540
|
|
541
|
+
# **delete_pbx_queue_voicemail**
|
542
|
+
> delete_pbx_queue_voicemail(queue_uuid, recording_sid)
|
543
|
+
|
544
|
+
Delete Queue Voicemail
|
545
|
+
|
546
|
+
Delete pbx queue Voicemail
|
547
|
+
|
548
|
+
### Example
|
549
|
+
```ruby
|
550
|
+
# load the gem
|
551
|
+
require 'ultracart_api'
|
552
|
+
|
553
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
554
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
555
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
556
|
+
|
557
|
+
|
558
|
+
queue_uuid = 'queue_uuid_example' # String |
|
559
|
+
|
560
|
+
recording_sid = 'recording_sid_example' # String |
|
561
|
+
|
562
|
+
|
563
|
+
begin
|
564
|
+
#Delete Queue Voicemail
|
565
|
+
api_instance.delete_pbx_queue_voicemail(queue_uuid, recording_sid)
|
566
|
+
rescue UltracartClient::ApiError => e
|
567
|
+
puts "Exception when calling ConversationApi->delete_pbx_queue_voicemail: #{e}"
|
568
|
+
end
|
569
|
+
```
|
570
|
+
|
571
|
+
### Parameters
|
572
|
+
|
573
|
+
Name | Type | Description | Notes
|
574
|
+
------------- | ------------- | ------------- | -------------
|
575
|
+
**queue_uuid** | **String**| |
|
576
|
+
**recording_sid** | **String**| |
|
577
|
+
|
578
|
+
### Return type
|
579
|
+
|
580
|
+
nil (empty response body)
|
581
|
+
|
582
|
+
### Authorization
|
583
|
+
|
584
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
585
|
+
|
586
|
+
### HTTP request headers
|
587
|
+
|
588
|
+
- **Content-Type**: application/json
|
589
|
+
- **Accept**: application/json
|
590
|
+
|
591
|
+
|
592
|
+
|
484
593
|
# **delete_pbx_time_based**
|
485
594
|
> ConversationPbxTimeBasedResponse delete_pbx_time_based(conversation_pbx_time_based_uuid)
|
486
595
|
|
@@ -1648,6 +1757,101 @@ Name | Type | Description | Notes
|
|
1648
1757
|
|
1649
1758
|
|
1650
1759
|
|
1760
|
+
# **get_pbx_agent_voicemail**
|
1761
|
+
> ConversationPbxVoicemailMessageResponse get_pbx_agent_voicemail(recording_sid)
|
1762
|
+
|
1763
|
+
Get Agent Voicemail
|
1764
|
+
|
1765
|
+
Retrieve pbx agent Voicemail
|
1766
|
+
|
1767
|
+
### Example
|
1768
|
+
```ruby
|
1769
|
+
# load the gem
|
1770
|
+
require 'ultracart_api'
|
1771
|
+
|
1772
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1773
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1774
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
1775
|
+
|
1776
|
+
|
1777
|
+
recording_sid = 'recording_sid_example' # String |
|
1778
|
+
|
1779
|
+
|
1780
|
+
begin
|
1781
|
+
#Get Agent Voicemail
|
1782
|
+
result = api_instance.get_pbx_agent_voicemail(recording_sid)
|
1783
|
+
p result
|
1784
|
+
rescue UltracartClient::ApiError => e
|
1785
|
+
puts "Exception when calling ConversationApi->get_pbx_agent_voicemail: #{e}"
|
1786
|
+
end
|
1787
|
+
```
|
1788
|
+
|
1789
|
+
### Parameters
|
1790
|
+
|
1791
|
+
Name | Type | Description | Notes
|
1792
|
+
------------- | ------------- | ------------- | -------------
|
1793
|
+
**recording_sid** | **String**| |
|
1794
|
+
|
1795
|
+
### Return type
|
1796
|
+
|
1797
|
+
[**ConversationPbxVoicemailMessageResponse**](ConversationPbxVoicemailMessageResponse.md)
|
1798
|
+
|
1799
|
+
### Authorization
|
1800
|
+
|
1801
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1802
|
+
|
1803
|
+
### HTTP request headers
|
1804
|
+
|
1805
|
+
- **Content-Type**: application/json
|
1806
|
+
- **Accept**: application/json
|
1807
|
+
|
1808
|
+
|
1809
|
+
|
1810
|
+
# **get_pbx_agent_voicemails**
|
1811
|
+
> ConversationPbxVoicemailMessageSummariesResponse get_pbx_agent_voicemails
|
1812
|
+
|
1813
|
+
Get Agent Voicemails
|
1814
|
+
|
1815
|
+
Retrieve pbx agent Voicemails
|
1816
|
+
|
1817
|
+
### Example
|
1818
|
+
```ruby
|
1819
|
+
# load the gem
|
1820
|
+
require 'ultracart_api'
|
1821
|
+
|
1822
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1823
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1824
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
1825
|
+
|
1826
|
+
|
1827
|
+
|
1828
|
+
begin
|
1829
|
+
#Get Agent Voicemails
|
1830
|
+
result = api_instance.get_pbx_agent_voicemails
|
1831
|
+
p result
|
1832
|
+
rescue UltracartClient::ApiError => e
|
1833
|
+
puts "Exception when calling ConversationApi->get_pbx_agent_voicemails: #{e}"
|
1834
|
+
end
|
1835
|
+
```
|
1836
|
+
|
1837
|
+
### Parameters
|
1838
|
+
This endpoint does not need any parameter.
|
1839
|
+
|
1840
|
+
### Return type
|
1841
|
+
|
1842
|
+
[**ConversationPbxVoicemailMessageSummariesResponse**](ConversationPbxVoicemailMessageSummariesResponse.md)
|
1843
|
+
|
1844
|
+
### Authorization
|
1845
|
+
|
1846
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1847
|
+
|
1848
|
+
### HTTP request headers
|
1849
|
+
|
1850
|
+
- **Content-Type**: application/json
|
1851
|
+
- **Accept**: application/json
|
1852
|
+
|
1853
|
+
|
1854
|
+
|
1651
1855
|
# **get_pbx_agents**
|
1652
1856
|
> ConversationPbxAgentsResponse get_pbx_agents
|
1653
1857
|
|
@@ -2028,6 +2232,109 @@ Name | Type | Description | Notes
|
|
2028
2232
|
|
2029
2233
|
|
2030
2234
|
|
2235
|
+
# **get_pbx_queue_voicemail**
|
2236
|
+
> ConversationPbxVoicemailMessageResponse get_pbx_queue_voicemail(queue_uuid, recording_sid)
|
2237
|
+
|
2238
|
+
Get Queue Voicemail
|
2239
|
+
|
2240
|
+
Retrieve pbx queue Voicemail
|
2241
|
+
|
2242
|
+
### Example
|
2243
|
+
```ruby
|
2244
|
+
# load the gem
|
2245
|
+
require 'ultracart_api'
|
2246
|
+
|
2247
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
2248
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
2249
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
2250
|
+
|
2251
|
+
|
2252
|
+
queue_uuid = 'queue_uuid_example' # String |
|
2253
|
+
|
2254
|
+
recording_sid = 'recording_sid_example' # String |
|
2255
|
+
|
2256
|
+
|
2257
|
+
begin
|
2258
|
+
#Get Queue Voicemail
|
2259
|
+
result = api_instance.get_pbx_queue_voicemail(queue_uuid, recording_sid)
|
2260
|
+
p result
|
2261
|
+
rescue UltracartClient::ApiError => e
|
2262
|
+
puts "Exception when calling ConversationApi->get_pbx_queue_voicemail: #{e}"
|
2263
|
+
end
|
2264
|
+
```
|
2265
|
+
|
2266
|
+
### Parameters
|
2267
|
+
|
2268
|
+
Name | Type | Description | Notes
|
2269
|
+
------------- | ------------- | ------------- | -------------
|
2270
|
+
**queue_uuid** | **String**| |
|
2271
|
+
**recording_sid** | **String**| |
|
2272
|
+
|
2273
|
+
### Return type
|
2274
|
+
|
2275
|
+
[**ConversationPbxVoicemailMessageResponse**](ConversationPbxVoicemailMessageResponse.md)
|
2276
|
+
|
2277
|
+
### Authorization
|
2278
|
+
|
2279
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2280
|
+
|
2281
|
+
### HTTP request headers
|
2282
|
+
|
2283
|
+
- **Content-Type**: application/json
|
2284
|
+
- **Accept**: application/json
|
2285
|
+
|
2286
|
+
|
2287
|
+
|
2288
|
+
# **get_pbx_queue_voicemails**
|
2289
|
+
> ConversationPbxVoicemailMessageSummariesResponse get_pbx_queue_voicemails(queue_uuid)
|
2290
|
+
|
2291
|
+
Get Queue Voicemails
|
2292
|
+
|
2293
|
+
Retrieve pbx queue voicemails
|
2294
|
+
|
2295
|
+
### Example
|
2296
|
+
```ruby
|
2297
|
+
# load the gem
|
2298
|
+
require 'ultracart_api'
|
2299
|
+
|
2300
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
2301
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
2302
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
2303
|
+
|
2304
|
+
|
2305
|
+
queue_uuid = 'queue_uuid_example' # String |
|
2306
|
+
|
2307
|
+
|
2308
|
+
begin
|
2309
|
+
#Get Queue Voicemails
|
2310
|
+
result = api_instance.get_pbx_queue_voicemails(queue_uuid)
|
2311
|
+
p result
|
2312
|
+
rescue UltracartClient::ApiError => e
|
2313
|
+
puts "Exception when calling ConversationApi->get_pbx_queue_voicemails: #{e}"
|
2314
|
+
end
|
2315
|
+
```
|
2316
|
+
|
2317
|
+
### Parameters
|
2318
|
+
|
2319
|
+
Name | Type | Description | Notes
|
2320
|
+
------------- | ------------- | ------------- | -------------
|
2321
|
+
**queue_uuid** | **String**| |
|
2322
|
+
|
2323
|
+
### Return type
|
2324
|
+
|
2325
|
+
[**ConversationPbxVoicemailMessageSummariesResponse**](ConversationPbxVoicemailMessageSummariesResponse.md)
|
2326
|
+
|
2327
|
+
### Authorization
|
2328
|
+
|
2329
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2330
|
+
|
2331
|
+
### HTTP request headers
|
2332
|
+
|
2333
|
+
- **Content-Type**: application/json
|
2334
|
+
- **Accept**: application/json
|
2335
|
+
|
2336
|
+
|
2337
|
+
|
2031
2338
|
# **get_pbx_queues**
|
2032
2339
|
> ConversationPbxQueuesResponse get_pbx_queues
|
2033
2340
|
|
@@ -3010,6 +3317,107 @@ nil (empty response body)
|
|
3010
3317
|
|
3011
3318
|
|
3012
3319
|
|
3320
|
+
# **listened_pbx_agent_voicemail**
|
3321
|
+
> listened_pbx_agent_voicemail(recording_sid)
|
3322
|
+
|
3323
|
+
Listened Agent Voicemail
|
3324
|
+
|
3325
|
+
Listened pbx agent Voicemail
|
3326
|
+
|
3327
|
+
### Example
|
3328
|
+
```ruby
|
3329
|
+
# load the gem
|
3330
|
+
require 'ultracart_api'
|
3331
|
+
|
3332
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
3333
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
3334
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
3335
|
+
|
3336
|
+
|
3337
|
+
recording_sid = 'recording_sid_example' # String |
|
3338
|
+
|
3339
|
+
|
3340
|
+
begin
|
3341
|
+
#Listened Agent Voicemail
|
3342
|
+
api_instance.listened_pbx_agent_voicemail(recording_sid)
|
3343
|
+
rescue UltracartClient::ApiError => e
|
3344
|
+
puts "Exception when calling ConversationApi->listened_pbx_agent_voicemail: #{e}"
|
3345
|
+
end
|
3346
|
+
```
|
3347
|
+
|
3348
|
+
### Parameters
|
3349
|
+
|
3350
|
+
Name | Type | Description | Notes
|
3351
|
+
------------- | ------------- | ------------- | -------------
|
3352
|
+
**recording_sid** | **String**| |
|
3353
|
+
|
3354
|
+
### Return type
|
3355
|
+
|
3356
|
+
nil (empty response body)
|
3357
|
+
|
3358
|
+
### Authorization
|
3359
|
+
|
3360
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
3361
|
+
|
3362
|
+
### HTTP request headers
|
3363
|
+
|
3364
|
+
- **Content-Type**: application/json
|
3365
|
+
- **Accept**: application/json
|
3366
|
+
|
3367
|
+
|
3368
|
+
|
3369
|
+
# **listened_pbx_queue_voicemail**
|
3370
|
+
> listened_pbx_queue_voicemail(queue_uuid, recording_sid)
|
3371
|
+
|
3372
|
+
Listened Queue Voicemail
|
3373
|
+
|
3374
|
+
Listened pbx queue Voicemail
|
3375
|
+
|
3376
|
+
### Example
|
3377
|
+
```ruby
|
3378
|
+
# load the gem
|
3379
|
+
require 'ultracart_api'
|
3380
|
+
|
3381
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
3382
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
3383
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
3384
|
+
|
3385
|
+
|
3386
|
+
queue_uuid = 'queue_uuid_example' # String |
|
3387
|
+
|
3388
|
+
recording_sid = 'recording_sid_example' # String |
|
3389
|
+
|
3390
|
+
|
3391
|
+
begin
|
3392
|
+
#Listened Queue Voicemail
|
3393
|
+
api_instance.listened_pbx_queue_voicemail(queue_uuid, recording_sid)
|
3394
|
+
rescue UltracartClient::ApiError => e
|
3395
|
+
puts "Exception when calling ConversationApi->listened_pbx_queue_voicemail: #{e}"
|
3396
|
+
end
|
3397
|
+
```
|
3398
|
+
|
3399
|
+
### Parameters
|
3400
|
+
|
3401
|
+
Name | Type | Description | Notes
|
3402
|
+
------------- | ------------- | ------------- | -------------
|
3403
|
+
**queue_uuid** | **String**| |
|
3404
|
+
**recording_sid** | **String**| |
|
3405
|
+
|
3406
|
+
### Return type
|
3407
|
+
|
3408
|
+
nil (empty response body)
|
3409
|
+
|
3410
|
+
### Authorization
|
3411
|
+
|
3412
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
3413
|
+
|
3414
|
+
### HTTP request headers
|
3415
|
+
|
3416
|
+
- **Content-Type**: application/json
|
3417
|
+
- **Accept**: application/json
|
3418
|
+
|
3419
|
+
|
3420
|
+
|
3013
3421
|
# **mark_read_conversation**
|
3014
3422
|
> mark_read_conversation(conversation_uuid)
|
3015
3423
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**call_sid** | **String** | Call SID | [optional]
|
7
|
+
**duration** | **Integer** | Duration in seconds | [optional]
|
8
|
+
**from** | **String** | From phone number in E.164 | [optional]
|
9
|
+
**from_caller_id** | **String** | From caller id (if available) | [optional]
|
10
|
+
**listened** | **BOOLEAN** | True if the voicemail has been listened to in the user interface | [optional]
|
11
|
+
**merchant_id** | **String** | Merchant ID | [optional]
|
12
|
+
**recording_sid** | **String** | Recording SID | [optional]
|
13
|
+
**recording_size_bytes** | **Integer** | Recording size in bytes | [optional]
|
14
|
+
**recording_status** | **String** | Recording Status | [optional]
|
15
|
+
**recording_url** | **String** | Recording URL (expires in 4 hours) | [optional]
|
16
|
+
**transcript_json** | **String** | JSON version of the transcript | [optional]
|
17
|
+
**transcript_text** | **String** | Formatted text of the transcript | [optional]
|
18
|
+
**voicemail_dts** | **String** | Voicemail date/time | [optional]
|
19
|
+
|
20
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessageResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
9
|
+
**voicemail_message** | [**ConversationPbxVoicemailMessage**](ConversationPbxVoicemailMessage.md) | | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessageSummariesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
9
|
+
**voicemail_message_summaries** | [**Array<ConversationPbxVoicemailMessageSummary>**](ConversationPbxVoicemailMessageSummary.md) | | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|