ultracart_api 3.11.51 → 3.11.54
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 +28 -4
- data/docs/ConversationApi.md +110 -0
- data/docs/ConversationPbxAgent.md +1 -0
- data/docs/ConversationPbxCall.md +29 -0
- data/docs/ConversationPbxCallAgent.md +16 -0
- data/docs/ConversationPbxCallAiCost.md +11 -0
- data/docs/ConversationPbxCallAiEngagement.md +17 -0
- data/docs/ConversationPbxCallAiToolCall.md +16 -0
- data/docs/ConversationPbxCallAiWhisper.md +11 -0
- data/docs/ConversationPbxCallCaller.md +12 -0
- data/docs/ConversationPbxCallFinancial.md +14 -0
- data/docs/ConversationPbxCallHold.md +11 -0
- data/docs/ConversationPbxCallQueue.md +13 -0
- data/docs/ConversationPbxCallRecording.md +14 -0
- data/docs/ConversationPbxCallResponse.md +12 -0
- data/docs/ConversationPbxCallRouting.md +10 -0
- data/docs/ConversationPbxCallSearchRequest.md +23 -0
- data/docs/ConversationPbxCallSearchResponse.md +12 -0
- data/docs/ConversationPbxCallTimeline.md +13 -0
- data/docs/ConversationPbxCallTranscript.md +14 -0
- data/docs/ConversationPbxCallTranscriptSegment.md +14 -0
- data/docs/ConversationPbxCallTransfer.md +12 -0
- data/docs/ConversationPbxPhoneNumber.md +1 -0
- data/lib/ultracart_api/api/conversation_api.rb +119 -0
- data/lib/ultracart_api/models/conversation_pbx_agent.rb +11 -1
- data/lib/ultracart_api/models/conversation_pbx_call.rb +403 -0
- data/lib/ultracart_api/models/conversation_pbx_call_agent.rb +265 -0
- data/lib/ultracart_api/models/conversation_pbx_call_ai_cost.rb +215 -0
- data/lib/ultracart_api/models/conversation_pbx_call_ai_engagement.rb +312 -0
- data/lib/ultracart_api/models/conversation_pbx_call_ai_tool_call.rb +265 -0
- data/lib/ultracart_api/models/conversation_pbx_call_ai_whisper.rb +215 -0
- data/lib/ultracart_api/models/conversation_pbx_call_caller.rb +225 -0
- data/lib/ultracart_api/models/conversation_pbx_call_financial.rb +245 -0
- data/lib/ultracart_api/models/conversation_pbx_call_hold.rb +215 -0
- data/lib/ultracart_api/models/conversation_pbx_call_queue.rb +235 -0
- data/lib/ultracart_api/models/conversation_pbx_call_recording.rb +244 -0
- data/lib/ultracart_api/models/conversation_pbx_call_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_pbx_call_routing.rb +204 -0
- data/lib/ultracart_api/models/conversation_pbx_call_search_request.rb +341 -0
- data/lib/ultracart_api/models/conversation_pbx_call_search_response.rb +224 -0
- data/lib/ultracart_api/models/conversation_pbx_call_timeline.rb +235 -0
- data/lib/ultracart_api/models/conversation_pbx_call_transcript.rb +247 -0
- data/lib/ultracart_api/models/conversation_pbx_call_transcript_segment.rb +279 -0
- data/lib/ultracart_api/models/conversation_pbx_call_transfer.rb +225 -0
- data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +19 -0
- metadata +40 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7f68314de104ad1ae9fd57aaec292759c4f5df2dbc987f5086c6dcc7675c9a36
|
|
4
|
+
data.tar.gz: 92b252aceef615cc93d75615d053c400ec69ac7527f5f061186f2c81c597ef78
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e5d4527c6646304be0077c6a11c4f3e5a127611ed197d66dd7de15d8d90a020f4730f0a875da9bf49208387350ca41444a19e5da83bfca5e195c4fc2c0f8126a
|
|
7
|
+
data.tar.gz: 734cc6170ed0510be54b2cb15cdb0154768ea6e74c5f258ca3b1751360ae04c883759909c46179d095cc3450cf1ade6efd5cafadf8558affe1a0ad429b7009fc
|
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.11.
|
|
10
|
+
- Package version: 3.11.54
|
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
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.11.
|
|
27
|
+
gem install ./ultracart_api-3.11.54.gem
|
|
28
28
|
```
|
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.11.
|
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.11.54.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.11.
|
|
35
|
+
gem 'ultracart_api', '~> 3.11.54'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -184,6 +184,7 @@ Class | Method | HTTP request | Description
|
|
|
184
184
|
*UltracartClient::ConversationApi* | [**get_pbx_audio**](docs/ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
|
|
185
185
|
*UltracartClient::ConversationApi* | [**get_pbx_audio_usage**](docs/ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage
|
|
186
186
|
*UltracartClient::ConversationApi* | [**get_pbx_audios**](docs/ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
|
|
187
|
+
*UltracartClient::ConversationApi* | [**get_pbx_call**](docs/ConversationApi.md#get_pbx_call) | **GET** /conversation/pbx/call/{callUuid} | Get pbx call record
|
|
187
188
|
*UltracartClient::ConversationApi* | [**get_pbx_hardware_phone**](docs/ConversationApi.md#get_pbx_hardware_phone) | **GET** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Get pbx hardware phone
|
|
188
189
|
*UltracartClient::ConversationApi* | [**get_pbx_hardware_phone_manufacturers**](docs/ConversationApi.md#get_pbx_hardware_phone_manufacturers) | **GET** /conversation/pbx/hardware_phone/manufacturers | Get pbx hardware phone manufacturers
|
|
189
190
|
*UltracartClient::ConversationApi* | [**get_pbx_hardware_phones**](docs/ConversationApi.md#get_pbx_hardware_phones) | **GET** /conversation/pbx/hardware_phone | Get pbx hardware phones
|
|
@@ -227,6 +228,7 @@ Class | Method | HTTP request | Description
|
|
|
227
228
|
*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
|
|
228
229
|
*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
|
|
229
230
|
*UltracartClient::ConversationApi* | [**search_pbx_available_phone_numbers**](docs/ConversationApi.md#search_pbx_available_phone_numbers) | **GET** /conversation/pbx/phone_number/search | Search for available phone numbers
|
|
231
|
+
*UltracartClient::ConversationApi* | [**search_pbx_calls**](docs/ConversationApi.md#search_pbx_calls) | **POST** /conversation/pbx/call/search | Search pbx call records
|
|
230
232
|
*UltracartClient::ConversationApi* | [**sms_unsubscribe_conversation**](docs/ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
|
|
231
233
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
|
232
234
|
*UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
|
|
@@ -841,6 +843,25 @@ Class | Method | HTTP request | Description
|
|
|
841
843
|
- [UltracartClient::ConversationPbxAudiosResponse](docs/ConversationPbxAudiosResponse.md)
|
|
842
844
|
- [UltracartClient::ConversationPbxAvailablePhoneNumber](docs/ConversationPbxAvailablePhoneNumber.md)
|
|
843
845
|
- [UltracartClient::ConversationPbxAvailablePhoneNumbersResponse](docs/ConversationPbxAvailablePhoneNumbersResponse.md)
|
|
846
|
+
- [UltracartClient::ConversationPbxCall](docs/ConversationPbxCall.md)
|
|
847
|
+
- [UltracartClient::ConversationPbxCallAgent](docs/ConversationPbxCallAgent.md)
|
|
848
|
+
- [UltracartClient::ConversationPbxCallAiCost](docs/ConversationPbxCallAiCost.md)
|
|
849
|
+
- [UltracartClient::ConversationPbxCallAiEngagement](docs/ConversationPbxCallAiEngagement.md)
|
|
850
|
+
- [UltracartClient::ConversationPbxCallAiToolCall](docs/ConversationPbxCallAiToolCall.md)
|
|
851
|
+
- [UltracartClient::ConversationPbxCallAiWhisper](docs/ConversationPbxCallAiWhisper.md)
|
|
852
|
+
- [UltracartClient::ConversationPbxCallCaller](docs/ConversationPbxCallCaller.md)
|
|
853
|
+
- [UltracartClient::ConversationPbxCallFinancial](docs/ConversationPbxCallFinancial.md)
|
|
854
|
+
- [UltracartClient::ConversationPbxCallHold](docs/ConversationPbxCallHold.md)
|
|
855
|
+
- [UltracartClient::ConversationPbxCallQueue](docs/ConversationPbxCallQueue.md)
|
|
856
|
+
- [UltracartClient::ConversationPbxCallRecording](docs/ConversationPbxCallRecording.md)
|
|
857
|
+
- [UltracartClient::ConversationPbxCallResponse](docs/ConversationPbxCallResponse.md)
|
|
858
|
+
- [UltracartClient::ConversationPbxCallRouting](docs/ConversationPbxCallRouting.md)
|
|
859
|
+
- [UltracartClient::ConversationPbxCallSearchRequest](docs/ConversationPbxCallSearchRequest.md)
|
|
860
|
+
- [UltracartClient::ConversationPbxCallSearchResponse](docs/ConversationPbxCallSearchResponse.md)
|
|
861
|
+
- [UltracartClient::ConversationPbxCallTimeline](docs/ConversationPbxCallTimeline.md)
|
|
862
|
+
- [UltracartClient::ConversationPbxCallTranscript](docs/ConversationPbxCallTranscript.md)
|
|
863
|
+
- [UltracartClient::ConversationPbxCallTranscriptSegment](docs/ConversationPbxCallTranscriptSegment.md)
|
|
864
|
+
- [UltracartClient::ConversationPbxCallTransfer](docs/ConversationPbxCallTransfer.md)
|
|
844
865
|
- [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
|
|
845
866
|
- [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
|
|
846
867
|
- [UltracartClient::ConversationPbxHardwarePhone](docs/ConversationPbxHardwarePhone.md)
|
|
@@ -1637,6 +1658,9 @@ Not every change is committed to every SDK.
|
|
|
1637
1658
|
|
|
1638
1659
|
| Version | Date | Comments |
|
|
1639
1660
|
| --: | :-: | --- |
|
|
1661
|
+
| 3.11.54 | 02/02/2026 | build error fix |
|
|
1662
|
+
| 3.11.53 | 02/02/2026 | conversations default pricing phone number settings |
|
|
1663
|
+
| 3.11.52 | 01/31/2026 | conversation - pbx call log objects |
|
|
1640
1664
|
| 3.11.51 | 01/30/2026 | conversations queue setting for automatic AI coaching |
|
|
1641
1665
|
| 3.11.50 | 01/27/2026 | conversations - refinements to support hardware phones |
|
|
1642
1666
|
| 3.11.49 | 01/26/2026 | no changes - testing changes to build automation |
|
data/docs/ConversationApi.md
CHANGED
|
@@ -55,6 +55,7 @@ Method | HTTP request | Description
|
|
|
55
55
|
[**get_pbx_audio**](ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
|
|
56
56
|
[**get_pbx_audio_usage**](ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage
|
|
57
57
|
[**get_pbx_audios**](ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
|
|
58
|
+
[**get_pbx_call**](ConversationApi.md#get_pbx_call) | **GET** /conversation/pbx/call/{callUuid} | Get pbx call record
|
|
58
59
|
[**get_pbx_hardware_phone**](ConversationApi.md#get_pbx_hardware_phone) | **GET** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Get pbx hardware phone
|
|
59
60
|
[**get_pbx_hardware_phone_manufacturers**](ConversationApi.md#get_pbx_hardware_phone_manufacturers) | **GET** /conversation/pbx/hardware_phone/manufacturers | Get pbx hardware phone manufacturers
|
|
60
61
|
[**get_pbx_hardware_phones**](ConversationApi.md#get_pbx_hardware_phones) | **GET** /conversation/pbx/hardware_phone | Get pbx hardware phones
|
|
@@ -98,6 +99,7 @@ Method | HTTP request | Description
|
|
|
98
99
|
[**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
|
|
99
100
|
[**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
|
|
100
101
|
[**search_pbx_available_phone_numbers**](ConversationApi.md#search_pbx_available_phone_numbers) | **GET** /conversation/pbx/phone_number/search | Search for available phone numbers
|
|
102
|
+
[**search_pbx_calls**](ConversationApi.md#search_pbx_calls) | **POST** /conversation/pbx/call/search | Search pbx call records
|
|
101
103
|
[**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
|
|
102
104
|
[**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
|
103
105
|
[**update_agent_profile**](ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
|
|
@@ -2623,6 +2625,56 @@ This endpoint does not need any parameter.
|
|
|
2623
2625
|
|
|
2624
2626
|
|
|
2625
2627
|
|
|
2628
|
+
# **get_pbx_call**
|
|
2629
|
+
> ConversationPbxCallResponse get_pbx_call(call_uuid)
|
|
2630
|
+
|
|
2631
|
+
Get pbx call record
|
|
2632
|
+
|
|
2633
|
+
Retrieve a single PBX call record with full details
|
|
2634
|
+
|
|
2635
|
+
### Example
|
|
2636
|
+
```ruby
|
|
2637
|
+
# load the gem
|
|
2638
|
+
require 'ultracart_api'
|
|
2639
|
+
|
|
2640
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
2641
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
2642
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
2643
|
+
|
|
2644
|
+
|
|
2645
|
+
call_uuid = 'call_uuid_example' # String |
|
|
2646
|
+
|
|
2647
|
+
|
|
2648
|
+
begin
|
|
2649
|
+
#Get pbx call record
|
|
2650
|
+
result = api_instance.get_pbx_call(call_uuid)
|
|
2651
|
+
p result
|
|
2652
|
+
rescue UltracartClient::ApiError => e
|
|
2653
|
+
puts "Exception when calling ConversationApi->get_pbx_call: #{e}"
|
|
2654
|
+
end
|
|
2655
|
+
```
|
|
2656
|
+
|
|
2657
|
+
### Parameters
|
|
2658
|
+
|
|
2659
|
+
Name | Type | Description | Notes
|
|
2660
|
+
------------- | ------------- | ------------- | -------------
|
|
2661
|
+
**call_uuid** | **String**| |
|
|
2662
|
+
|
|
2663
|
+
### Return type
|
|
2664
|
+
|
|
2665
|
+
[**ConversationPbxCallResponse**](ConversationPbxCallResponse.md)
|
|
2666
|
+
|
|
2667
|
+
### Authorization
|
|
2668
|
+
|
|
2669
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2670
|
+
|
|
2671
|
+
### HTTP request headers
|
|
2672
|
+
|
|
2673
|
+
- **Content-Type**: application/json
|
|
2674
|
+
- **Accept**: application/json
|
|
2675
|
+
|
|
2676
|
+
|
|
2677
|
+
|
|
2626
2678
|
# **get_pbx_hardware_phone**
|
|
2627
2679
|
> ConversationPbxHardwarePhoneResponse get_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid)
|
|
2628
2680
|
|
|
@@ -4750,6 +4802,64 @@ Name | Type | Description | Notes
|
|
|
4750
4802
|
|
|
4751
4803
|
|
|
4752
4804
|
|
|
4805
|
+
# **search_pbx_calls**
|
|
4806
|
+
> ConversationPbxCallSearchResponse search_pbx_calls(search_request, opts)
|
|
4807
|
+
|
|
4808
|
+
Search pbx call records
|
|
4809
|
+
|
|
4810
|
+
Search and list PBX call records with filtering, sorting, and pagination
|
|
4811
|
+
|
|
4812
|
+
### Example
|
|
4813
|
+
```ruby
|
|
4814
|
+
# load the gem
|
|
4815
|
+
require 'ultracart_api'
|
|
4816
|
+
|
|
4817
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
4818
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
4819
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
4820
|
+
|
|
4821
|
+
|
|
4822
|
+
search_request = UltracartClient::ConversationPbxCallSearchRequest.new # ConversationPbxCallSearchRequest | Search Request
|
|
4823
|
+
|
|
4824
|
+
opts = {
|
|
4825
|
+
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
|
|
4826
|
+
_offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
|
|
4827
|
+
_sort: '_sort_example' # String | The sort order of the calls.
|
|
4828
|
+
}
|
|
4829
|
+
|
|
4830
|
+
begin
|
|
4831
|
+
#Search pbx call records
|
|
4832
|
+
result = api_instance.search_pbx_calls(search_request, opts)
|
|
4833
|
+
p result
|
|
4834
|
+
rescue UltracartClient::ApiError => e
|
|
4835
|
+
puts "Exception when calling ConversationApi->search_pbx_calls: #{e}"
|
|
4836
|
+
end
|
|
4837
|
+
```
|
|
4838
|
+
|
|
4839
|
+
### Parameters
|
|
4840
|
+
|
|
4841
|
+
Name | Type | Description | Notes
|
|
4842
|
+
------------- | ------------- | ------------- | -------------
|
|
4843
|
+
**search_request** | [**ConversationPbxCallSearchRequest**](ConversationPbxCallSearchRequest.md)| Search Request |
|
|
4844
|
+
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Maximum 200) | [optional] [default to 100]
|
|
4845
|
+
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
|
4846
|
+
**_sort** | **String**| The sort order of the calls. | [optional]
|
|
4847
|
+
|
|
4848
|
+
### Return type
|
|
4849
|
+
|
|
4850
|
+
[**ConversationPbxCallSearchResponse**](ConversationPbxCallSearchResponse.md)
|
|
4851
|
+
|
|
4852
|
+
### Authorization
|
|
4853
|
+
|
|
4854
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4855
|
+
|
|
4856
|
+
### HTTP request headers
|
|
4857
|
+
|
|
4858
|
+
- **Content-Type**: application/json
|
|
4859
|
+
- **Accept**: application/json
|
|
4860
|
+
|
|
4861
|
+
|
|
4862
|
+
|
|
4753
4863
|
# **sms_unsubscribe_conversation**
|
|
4754
4864
|
> sms_unsubscribe_conversation(conversation_uuid)
|
|
4755
4865
|
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**call_routing_preference** | **String** | The call routing preference | [optional]
|
|
8
8
|
**cellphone** | **String** | Cellphone number of agent in E.164 format | [optional]
|
|
9
9
|
**conversation_pbx_agent_uuid** | **String** | Conversation Pbx Agent unique identifier | [optional]
|
|
10
|
+
**default_phone_number_uuid** | **String** | The default phone number that this agent should dial out to the PSTN with. | [optional]
|
|
10
11
|
**extension** | **Integer** | Extension | [optional]
|
|
11
12
|
**full_name** | **String** | Full name | [optional]
|
|
12
13
|
**hardware_phone_uuids** | **Array<String>** | Array of hardware phones UUIDs associated with this agent | [optional]
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCall
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**account_sid** | **String** | Twilio account SID | [optional]
|
|
7
|
+
**agents** | [**Array<ConversationPbxCallAgent>**](ConversationPbxCallAgent.md) | List of agents who participated in this call | [optional]
|
|
8
|
+
**ai_agent_engagements** | [**Array<ConversationPbxCallAiEngagement>**](ConversationPbxCallAiEngagement.md) | List of AI agent engagements during the call | [optional]
|
|
9
|
+
**call_sid** | **String** | Twilio call SID for the primary (customer) call leg | [optional]
|
|
10
|
+
**call_uuid** | **String** | Unique identifier for this call record | [optional]
|
|
11
|
+
**caller** | [**ConversationPbxCallCaller**](ConversationPbxCallCaller.md) | | [optional]
|
|
12
|
+
**conference_sid** | **String** | Twilio conference SID if this call used conferencing | [optional]
|
|
13
|
+
**created_at_dts** | **String** | Timestamp when the call record was created | [optional]
|
|
14
|
+
**customer_name** | **String** | Customer name associated with this call | [optional]
|
|
15
|
+
**customer_profile_oid** | **String** | UltraCart customer profile OID if the caller was matched to a customer | [optional]
|
|
16
|
+
**disposition** | **String** | Call disposition describing how the call ended | [optional]
|
|
17
|
+
**email** | **String** | Email address of the caller if known | [optional]
|
|
18
|
+
**financial** | [**ConversationPbxCallFinancial**](ConversationPbxCallFinancial.md) | | [optional]
|
|
19
|
+
**holds** | [**Array<ConversationPbxCallHold>**](ConversationPbxCallHold.md) | List of hold events during the call | [optional]
|
|
20
|
+
**merchant_id** | **String** | Merchant identifier | [optional]
|
|
21
|
+
**recording_sids** | **Array<String>** | List of all Twilio recording SIDs associated with this call | [optional]
|
|
22
|
+
**recordings** | [**Array<ConversationPbxCallRecording>**](ConversationPbxCallRecording.md) | List of recordings made during the call | [optional]
|
|
23
|
+
**routing** | [**ConversationPbxCallRouting**](ConversationPbxCallRouting.md) | | [optional]
|
|
24
|
+
**status** | **String** | Final status of the call | [optional]
|
|
25
|
+
**timeline** | [**ConversationPbxCallTimeline**](ConversationPbxCallTimeline.md) | | [optional]
|
|
26
|
+
**transfers** | [**Array<ConversationPbxCallTransfer>**](ConversationPbxCallTransfer.md) | List of transfer events during the call | [optional]
|
|
27
|
+
**updated_at_dts** | **String** | Timestamp when the call record was last updated | [optional]
|
|
28
|
+
|
|
29
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallAgent
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**agent_extension** | **String** | Agent's phone extension | [optional]
|
|
7
|
+
**agent_id** | **String** | Unique identifier for the agent | [optional]
|
|
8
|
+
**agent_name** | **String** | Display name of the agent | [optional]
|
|
9
|
+
**answered** | **BOOLEAN** | Whether the agent answered the call | [optional]
|
|
10
|
+
**call_sid** | **String** | Twilio call SID for the agent's call leg | [optional]
|
|
11
|
+
**joined_at_dts** | **String** | Timestamp when the agent joined the call | [optional]
|
|
12
|
+
**left_at_dts** | **String** | Timestamp when the agent left the call | [optional]
|
|
13
|
+
**role** | **String** | Role of the agent in the call | [optional]
|
|
14
|
+
**worker_sid** | **String** | Twilio TaskRouter worker SID | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallAiCost
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**amount** | **Float** | Total cost amount in the specified currency | [optional]
|
|
7
|
+
**billed_minutes** | **Float** | Number of minutes billed for AI usage | [optional]
|
|
8
|
+
**cost_per_minute** | **Float** | Cost per minute for AI usage | [optional]
|
|
9
|
+
**currency** | **String** | Currency code (always USD) | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallAiEngagement
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**agent_name** | **String** | Display name of the AI agent | [optional]
|
|
7
|
+
**agent_uuid** | **String** | UUID of the AI agent configuration used | [optional]
|
|
8
|
+
**cost** | [**ConversationPbxCallAiCost**](ConversationPbxCallAiCost.md) | | [optional]
|
|
9
|
+
**ended_at_dts** | **String** | Timestamp when the AI engagement ended | [optional]
|
|
10
|
+
**engagement_type** | **String** | Type of AI engagement | [optional]
|
|
11
|
+
**session_uuid** | **String** | Unique identifier for this AI engagement session | [optional]
|
|
12
|
+
**started_at_dts** | **String** | Timestamp when the AI engagement started | [optional]
|
|
13
|
+
**status** | **String** | Status of the AI engagement | [optional]
|
|
14
|
+
**tool_calls** | [**Array<ConversationPbxCallAiToolCall>**](ConversationPbxCallAiToolCall.md) | List of tool calls made by the AI agent during this engagement | [optional]
|
|
15
|
+
**whispers** | [**Array<ConversationPbxCallAiWhisper>**](ConversationPbxCallAiWhisper.md) | List of coaching whispers sent during this engagement | [optional]
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallAiToolCall
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**called_at_dts** | **String** | Timestamp when the tool was called | [optional]
|
|
7
|
+
**completed_at_dts** | **String** | Timestamp when the tool call completed | [optional]
|
|
8
|
+
**duration_ms** | **Integer** | Duration of the tool call in milliseconds | [optional]
|
|
9
|
+
**error_message** | **String** | Error message if the tool call failed | [optional]
|
|
10
|
+
**parameters** | **Object** | Parameters passed to the tool (structure varies by tool) | [optional]
|
|
11
|
+
**result** | **Object** | Result returned by the tool (structure varies by tool) | [optional]
|
|
12
|
+
**success** | **BOOLEAN** | Whether the tool call succeeded | [optional]
|
|
13
|
+
**tool_call_uuid** | **String** | Unique identifier for this tool call | [optional]
|
|
14
|
+
**tool_name** | **String** | Name of the tool that was called | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallAiWhisper
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**message** | **String** | The whisper message content | [optional]
|
|
7
|
+
**priority** | **String** | Priority level of the whisper | [optional]
|
|
8
|
+
**whisper_uuid** | **String** | Unique identifier for this whisper | [optional]
|
|
9
|
+
**whispered_at_dts** | **String** | Timestamp when the whisper was sent | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallCaller
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**caller_id** | **String** | Caller ID name if available | [optional]
|
|
7
|
+
**city** | **String** | City associated with the phone number | [optional]
|
|
8
|
+
**country** | **String** | Country associated with the phone number (ISO 3166-1 alpha-2) | [optional]
|
|
9
|
+
**phone_number** | **String** | Phone number in E.164 format | [optional]
|
|
10
|
+
**state** | **String** | State or province associated with the phone number | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallFinancial
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**ai_agent_billed_minutes** | **Float** | Total AI agent billed minutes for this call | [optional]
|
|
7
|
+
**ai_agent_cost** | **Float** | Total AI agent cost for this call | [optional]
|
|
8
|
+
**ai_agent_cost_currency** | **String** | Currency for AI agent cost | [optional]
|
|
9
|
+
**call_currency** | **String** | Currency for call price (default USD) | [optional]
|
|
10
|
+
**call_price** | **Float** | Twilio call cost | [optional]
|
|
11
|
+
**call_price_estimated** | **BOOLEAN** | True if call price is a fallback-rate estimate, false if Twilio-confirmed | [optional]
|
|
12
|
+
**transcription_cost** | **Float** | AWS Transcribe transcription cost | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallHold
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**held_by_agent_id** | **String** | ID of the agent who placed the caller on hold | [optional]
|
|
7
|
+
**hold_duration_seconds** | **Integer** | Duration of the hold in seconds | [optional]
|
|
8
|
+
**hold_end_dts** | **String** | Timestamp when the hold ended | [optional]
|
|
9
|
+
**hold_start_dts** | **String** | Timestamp when the hold started | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallQueue
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**answered_at_dts** | **String** | Timestamp when the call was answered from the queue | [optional]
|
|
7
|
+
**entered_at_dts** | **String** | Timestamp when the call entered the queue | [optional]
|
|
8
|
+
**queue_name** | **String** | Display name of the queue | [optional]
|
|
9
|
+
**queue_uuid** | **String** | Unique identifier for the queue | [optional]
|
|
10
|
+
**result** | **String** | Result of queue routing (e.g., answered, abandoned, timeout) | [optional]
|
|
11
|
+
**wait_seconds** | **Integer** | Number of seconds the caller waited in the queue | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallRecording
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**channels** | **Integer** | Number of audio channels in the recording (1 for mono, 2 for stereo/dual-channel) | [optional]
|
|
7
|
+
**duration_seconds** | **Integer** | Duration of the recording in seconds | [optional]
|
|
8
|
+
**is_primary** | **BOOLEAN** | Whether this is the primary recording for the call | [optional]
|
|
9
|
+
**recording_sid** | **String** | Twilio recording SID | [optional]
|
|
10
|
+
**recording_url** | **String** | URL to access the recording | [optional]
|
|
11
|
+
**status** | **String** | Status of the recording | [optional]
|
|
12
|
+
**transcript** | [**ConversationPbxCallTranscript**](ConversationPbxCallTranscript.md) | | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**call** | [**ConversationPbxCall**](ConversationPbxCall.md) | | [optional]
|
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallRouting
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**call_type** | **String** | Type of call routing used | [optional]
|
|
7
|
+
**direction** | **String** | Direction of the call | [optional]
|
|
8
|
+
**queue** | [**ConversationPbxCallQueue**](ConversationPbxCallQueue.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallSearchRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**agent_ids** | **Array<String>** | Filter by agent IDs | [optional]
|
|
7
|
+
**customer_name** | **String** | Filter by customer name | [optional]
|
|
8
|
+
**direction** | **String** | Filter by call direction (inbound/outbound) | [optional]
|
|
9
|
+
**disposition** | **String** | Filter by call disposition | [optional]
|
|
10
|
+
**end_date** | **String** | Filter calls created on or before this date (ISO 8601) | [optional]
|
|
11
|
+
**has_ai_engagement** | **BOOLEAN** | Filter to calls with AI agent engagement | [optional]
|
|
12
|
+
**has_recording** | **BOOLEAN** | Filter to calls that have a recording | [optional]
|
|
13
|
+
**has_transcript** | **BOOLEAN** | Filter to calls that have a transcript | [optional]
|
|
14
|
+
**max_duration_seconds** | **Integer** | Filter by maximum call duration in seconds | [optional]
|
|
15
|
+
**min_duration_seconds** | **Integer** | Filter by minimum call duration in seconds | [optional]
|
|
16
|
+
**phone_number** | **String** | Filter by phone number (partial match supported) | [optional]
|
|
17
|
+
**queue_uuids** | **Array<String>** | Filter by queue UUIDs | [optional]
|
|
18
|
+
**search_term** | **String** | Free text search term - smart-routed based on content (phone, email, UUID, or general text) | [optional]
|
|
19
|
+
**start_date** | **String** | Filter calls created on or after this date (ISO 8601) | [optional]
|
|
20
|
+
**statuses** | **Array<String>** | Filter by call statuses | [optional]
|
|
21
|
+
**transcript_search** | **String** | Search within transcript text | [optional]
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallSearchResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**calls** | [**Array<ConversationPbxCall>**](ConversationPbxCall.md) | calls | [optional]
|
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallTimeline
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**answer_dts** | **String** | Timestamp when the call was answered | [optional]
|
|
7
|
+
**created_dts** | **String** | Timestamp when the call was created/initiated | [optional]
|
|
8
|
+
**end_dts** | **String** | Timestamp when the call ended | [optional]
|
|
9
|
+
**queue_wait_seconds** | **Integer** | Time spent waiting in queue in seconds | [optional]
|
|
10
|
+
**talk_time_seconds** | **Integer** | Actual talk time in seconds (excluding hold time and queue wait) | [optional]
|
|
11
|
+
**total_duration_seconds** | **Integer** | Total duration of the call in seconds from creation to end | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallTranscript
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**full_transcript_s3_key** | **String** | S3 key for the full transcript text file | [optional]
|
|
7
|
+
**job_name** | **String** | AWS Transcribe job name | [optional]
|
|
8
|
+
**language_code** | **String** | Language code for transcription | [optional]
|
|
9
|
+
**provider** | **String** | Transcription service provider | [optional]
|
|
10
|
+
**segments** | [**Array<ConversationPbxCallTranscriptSegment>**](ConversationPbxCallTranscriptSegment.md) | Transcript segments with speaker labels and timestamps | [optional]
|
|
11
|
+
**status** | **String** | Status of the transcription | [optional]
|
|
12
|
+
**transcript_json_s3_key** | **String** | S3 key for the detailed transcript JSON with speaker diarization | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallTranscriptSegment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**agent_id** | **String** | Agent ID if speaker is an agent | [optional]
|
|
7
|
+
**channel** | **String** | Audio channel identifier (e.g. ch_0, ch_1) | [optional]
|
|
8
|
+
**confidence** | **Float** | Transcription confidence score (0-1) | [optional]
|
|
9
|
+
**end_time** | **Float** | End time in seconds from beginning of recording | [optional]
|
|
10
|
+
**speaker** | **String** | Speaker role | [optional]
|
|
11
|
+
**start_time** | **Float** | Start time in seconds from beginning of recording | [optional]
|
|
12
|
+
**text** | **String** | Transcribed text for this segment | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallTransfer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**transfer_reason** | **String** | Reason provided for the transfer | [optional]
|
|
7
|
+
**transfer_type** | **String** | Type of transfer performed | [optional]
|
|
8
|
+
**transferred_at_dts** | **String** | Timestamp when the transfer occurred | [optional]
|
|
9
|
+
**transferred_by_agent_id** | **String** | ID of the agent who initiated the transfer | [optional]
|
|
10
|
+
**transferred_to** | **String** | Destination of the transfer (agent ID, queue name, or phone number) | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**action_target** | **String** | Action target. This is the UUID associated with the configuration object of that particular type. | [optional]
|
|
8
8
|
**address_sid** | **String** | Twilio Address SID linked to this phone number for regulatory compliance | [optional]
|
|
9
9
|
**conversation_pbx_phone_number_uuid** | **String** | Conversation Pbx Phone Number UUID | [optional]
|
|
10
|
+
**default_phone_number** | **BOOLEAN** | Default phone number for outbound calling. | [optional]
|
|
10
11
|
**deletion_protected** | **BOOLEAN** | If true, this phone number cannot be deleted through the API. It must be deleted via the Twilio console. | [optional]
|
|
11
12
|
**merchant_id** | **String** | Merchant Id | [optional]
|
|
12
13
|
**phone_number** | **String** | Phone number | [optional]
|