revox 0.1.0 → 0.3.0
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/CHANGELOG.md +81 -0
- data/README.md +39 -14
- data/lib/revox/client.rb +23 -1
- data/lib/revox/internal/transport/base_client.rb +5 -0
- data/lib/revox/internal/type/base_model.rb +3 -3
- data/lib/revox/internal/util.rb +22 -7
- data/lib/revox/models/assistant_clone_params.rb +20 -0
- data/lib/revox/models/assistant_clone_response.rb +1594 -0
- data/lib/revox/models/assistant_create_params.rb +1038 -13
- data/lib/revox/models/assistant_create_response.rb +1071 -11
- data/lib/revox/models/assistant_list_response.rb +1070 -11
- data/lib/revox/models/assistant_retrieve_response.rb +1066 -11
- data/lib/revox/models/assistant_update_params.rb +1038 -13
- data/lib/revox/models/assistant_update_response.rb +1097 -12
- data/lib/revox/models/auth_status_retrieve_params.rb +14 -0
- data/lib/revox/models/auth_status_retrieve_response.rb +17 -0
- data/lib/revox/models/call_cancel_params.rb +20 -0
- data/lib/revox/models/call_cancel_response.rb +16 -0
- data/lib/revox/models/call_create_params.rb +1065 -13
- data/lib/revox/models/call_create_response.rb +1820 -98
- data/lib/revox/models/call_export_params.rb +205 -0
- data/lib/revox/models/call_export_response.rb +22 -0
- data/lib/revox/models/call_pause_params.rb +20 -0
- data/lib/revox/models/call_pause_response.rb +16 -0
- data/lib/revox/models/call_phone_history_params.rb +14 -0
- data/lib/revox/models/call_phone_history_response.rb +98 -0
- data/lib/revox/models/call_resume_params.rb +20 -0
- data/lib/revox/models/call_resume_response.rb +16 -0
- data/lib/revox/models/call_retrieve_response.rb +1822 -98
- data/lib/revox/models/call_search_params.rb +171 -0
- data/lib/revox/models/call_search_response.rb +3114 -0
- data/lib/revox/models/campaign_create_params.rb +67 -2
- data/lib/revox/models/campaign_create_response.rb +1314 -59
- data/lib/revox/models/campaign_get_rows_params.rb +1 -46
- data/lib/revox/models/campaign_get_rows_response.rb +1833 -115
- data/lib/revox/models/campaign_launch_params.rb +20 -0
- data/lib/revox/models/campaign_launch_response.rb +2030 -0
- data/lib/revox/models/campaign_list_response.rb +1312 -59
- data/lib/revox/models/campaign_pause_params.rb +20 -0
- data/lib/revox/models/campaign_pause_response.rb +16 -0
- data/lib/revox/models/campaign_resume_params.rb +20 -0
- data/lib/revox/models/campaign_resume_response.rb +16 -0
- data/lib/revox/models/campaign_retrieve_response.rb +1312 -56
- data/lib/revox/models/campaign_statistics_params.rb +20 -0
- data/lib/revox/models/campaign_statistics_response.rb +486 -0
- data/lib/revox/models/campaign_update_params.rb +234 -0
- data/lib/revox/models/campaign_update_response.rb +2030 -0
- data/lib/revox/models/phone_number_delete_params.rb +20 -0
- data/lib/revox/models/phone_number_delete_response.rb +16 -0
- data/lib/revox/models/phone_number_list_params.rb +14 -0
- data/lib/revox/models/phone_number_list_response.rb +1777 -0
- data/lib/revox/models/phone_number_update_params.rb +32 -0
- data/lib/revox/models/phone_number_update_response.rb +1777 -0
- data/lib/revox/models/user_retrieve_params.rb +14 -0
- data/lib/revox/models/user_retrieve_response.rb +99 -0
- data/lib/revox/models/voice_clone_params.rb +78 -0
- data/lib/revox/models/voice_clone_response.rb +40 -0
- data/lib/revox/models/voice_delete_params.rb +20 -0
- data/lib/revox/models/voice_delete_response.rb +16 -0
- data/lib/revox/models/voice_list_response.rb +55 -1
- data/lib/revox/models/voice_preview_params.rb +49 -1
- data/lib/revox/models.rb +36 -2
- data/lib/revox/resources/assistants.rb +137 -8
- data/lib/revox/resources/auth_status.rb +32 -0
- data/lib/revox/resources/call.rb +131 -15
- data/lib/revox/resources/campaigns.rb +143 -17
- data/lib/revox/resources/phone_numbers.rb +74 -0
- data/lib/revox/resources/users.rb +17 -3
- data/lib/revox/resources/voices.rb +66 -10
- data/lib/revox/version.rb +1 -1
- data/lib/revox.rb +40 -7
- data/rbi/revox/client.rbi +6 -0
- data/rbi/revox/internal/util.rbi +8 -0
- data/rbi/revox/models/assistant_clone_params.rbi +33 -0
- data/rbi/revox/models/assistant_clone_response.rbi +3341 -0
- data/rbi/revox/models/assistant_create_params.rbi +2138 -103
- data/rbi/revox/models/assistant_create_response.rbi +2454 -199
- data/rbi/revox/models/assistant_list_response.rbi +2448 -195
- data/rbi/revox/models/assistant_retrieve_response.rbi +2401 -210
- data/rbi/revox/models/assistant_update_params.rbi +2138 -103
- data/rbi/revox/models/assistant_update_response.rbi +2504 -198
- data/rbi/revox/models/auth_status_retrieve_params.rbi +27 -0
- data/rbi/revox/models/auth_status_retrieve_response.rbi +30 -0
- data/rbi/revox/models/call_cancel_params.rbi +33 -0
- data/rbi/revox/models/call_cancel_response.rbi +23 -0
- data/rbi/revox/models/call_create_params.rbi +2382 -225
- data/rbi/revox/models/call_create_response.rbi +4116 -384
- data/rbi/revox/models/call_export_params.rbi +456 -0
- data/rbi/revox/models/call_export_response.rbi +26 -0
- data/rbi/revox/models/call_pause_params.rbi +31 -0
- data/rbi/revox/models/call_pause_response.rbi +23 -0
- data/rbi/revox/models/call_phone_history_params.rbi +27 -0
- data/rbi/revox/models/call_phone_history_response.rbi +224 -0
- data/rbi/revox/models/call_resume_params.rbi +33 -0
- data/rbi/revox/models/call_resume_response.rbi +23 -0
- data/rbi/revox/models/call_retrieve_response.rbi +4133 -399
- data/rbi/revox/models/call_search_params.rbi +288 -0
- data/rbi/revox/models/call_search_response.rbi +6593 -0
- data/rbi/revox/models/campaign_create_params.rbi +136 -0
- data/rbi/revox/models/campaign_create_response.rbi +2911 -231
- data/rbi/revox/models/campaign_get_rows_params.rbi +2 -82
- data/rbi/revox/models/campaign_get_rows_response.rbi +4146 -409
- data/rbi/revox/models/campaign_launch_params.rbi +33 -0
- data/rbi/revox/models/campaign_launch_response.rbi +4170 -0
- data/rbi/revox/models/campaign_list_response.rbi +2904 -230
- data/rbi/revox/models/campaign_pause_params.rbi +33 -0
- data/rbi/revox/models/campaign_pause_response.rbi +23 -0
- data/rbi/revox/models/campaign_resume_params.rbi +33 -0
- data/rbi/revox/models/campaign_resume_response.rbi +23 -0
- data/rbi/revox/models/campaign_retrieve_response.rbi +2911 -231
- data/rbi/revox/models/campaign_statistics_params.rbi +33 -0
- data/rbi/revox/models/campaign_statistics_response.rbi +1011 -0
- data/rbi/revox/models/campaign_update_params.rbi +431 -0
- data/rbi/revox/models/campaign_update_response.rbi +4170 -0
- data/rbi/revox/models/phone_number_delete_params.rbi +33 -0
- data/rbi/revox/models/phone_number_delete_response.rbi +26 -0
- data/rbi/revox/models/phone_number_list_params.rbi +27 -0
- data/rbi/revox/models/phone_number_list_response.rbi +3680 -0
- data/rbi/revox/models/phone_number_update_params.rbi +53 -0
- data/rbi/revox/models/phone_number_update_response.rbi +3683 -0
- data/rbi/revox/models/user_retrieve_params.rbi +27 -0
- data/rbi/revox/models/user_retrieve_response.rbi +140 -0
- data/rbi/revox/models/voice_clone_params.rbi +141 -0
- data/rbi/revox/models/voice_clone_response.rbi +53 -0
- data/rbi/revox/models/voice_delete_params.rbi +33 -0
- data/rbi/revox/models/voice_delete_response.rbi +23 -0
- data/rbi/revox/models/voice_list_response.rbi +105 -3
- data/rbi/revox/models/voice_preview_params.rbi +69 -0
- data/rbi/revox/models.rbi +36 -2
- data/rbi/revox/resources/assistants.rbi +296 -8
- data/rbi/revox/resources/auth_status.rbi +21 -0
- data/rbi/revox/resources/call.rbi +92 -6
- data/rbi/revox/resources/campaigns.rbi +106 -19
- data/rbi/revox/resources/phone_numbers.rbi +43 -0
- data/rbi/revox/resources/users.rbi +8 -2
- data/rbi/revox/resources/voices.rbi +56 -9
- data/sig/revox/client.rbs +4 -0
- data/sig/revox/internal/util.rbs +4 -0
- data/sig/revox/models/assistant_clone_params.rbs +20 -0
- data/sig/revox/models/assistant_clone_response.rbs +1318 -0
- data/sig/revox/models/assistant_create_params.rbs +844 -11
- data/sig/revox/models/assistant_create_response.rbs +860 -3
- data/sig/revox/models/assistant_list_response.rbs +860 -3
- data/sig/revox/models/assistant_retrieve_response.rbs +859 -3
- data/sig/revox/models/assistant_update_params.rbs +844 -11
- data/sig/revox/models/assistant_update_response.rbs +886 -6
- data/sig/revox/models/auth_status_retrieve_params.rbs +15 -0
- data/sig/revox/models/auth_status_retrieve_response.rbs +13 -0
- data/sig/revox/models/call_cancel_params.rbs +20 -0
- data/sig/revox/models/call_cancel_response.rbs +13 -0
- data/sig/revox/models/call_create_params.rbs +847 -13
- data/sig/revox/models/call_create_response.rbs +1519 -34
- data/sig/revox/models/call_export_params.rbs +234 -0
- data/sig/revox/models/call_export_response.rbs +15 -0
- data/sig/revox/models/call_pause_params.rbs +20 -0
- data/sig/revox/models/call_pause_response.rbs +13 -0
- data/sig/revox/models/call_phone_history_params.rbs +15 -0
- data/sig/revox/models/call_phone_history_response.rbs +102 -0
- data/sig/revox/models/call_resume_params.rbs +20 -0
- data/sig/revox/models/call_resume_response.rbs +13 -0
- data/sig/revox/models/call_retrieve_response.rbs +1519 -34
- data/sig/revox/models/call_search_params.rbs +198 -0
- data/sig/revox/models/call_search_response.rbs +2654 -0
- data/sig/revox/models/campaign_create_params.rbs +54 -0
- data/sig/revox/models/campaign_create_response.rbs +1034 -6
- data/sig/revox/models/campaign_get_rows_params.rbs +2 -64
- data/sig/revox/models/campaign_get_rows_response.rbs +1527 -54
- data/sig/revox/models/campaign_launch_params.rbs +20 -0
- data/sig/revox/models/campaign_launch_response.rbs +1694 -0
- data/sig/revox/models/campaign_list_response.rbs +1034 -6
- data/sig/revox/models/campaign_pause_params.rbs +20 -0
- data/sig/revox/models/campaign_pause_response.rbs +13 -0
- data/sig/revox/models/campaign_resume_params.rbs +20 -0
- data/sig/revox/models/campaign_resume_response.rbs +13 -0
- data/sig/revox/models/campaign_retrieve_response.rbs +1034 -6
- data/sig/revox/models/campaign_statistics_params.rbs +20 -0
- data/sig/revox/models/campaign_statistics_response.rbs +458 -0
- data/sig/revox/models/campaign_update_params.rbs +203 -0
- data/sig/revox/models/campaign_update_response.rbs +1694 -0
- data/sig/revox/models/phone_number_delete_params.rbs +20 -0
- data/sig/revox/models/phone_number_delete_response.rbs +13 -0
- data/sig/revox/models/phone_number_list_params.rbs +15 -0
- data/sig/revox/models/phone_number_list_response.rbs +1462 -0
- data/sig/revox/models/phone_number_update_params.rbs +32 -0
- data/sig/revox/models/phone_number_update_response.rbs +1460 -0
- data/sig/revox/models/user_retrieve_params.rbs +14 -0
- data/sig/revox/models/user_retrieve_response.rbs +71 -0
- data/sig/revox/models/voice_clone_params.rbs +79 -0
- data/sig/revox/models/voice_clone_response.rbs +40 -0
- data/sig/revox/models/voice_delete_params.rbs +20 -0
- data/sig/revox/models/voice_delete_response.rbs +13 -0
- data/sig/revox/models/voice_list_response.rbs +45 -3
- data/sig/revox/models/voice_preview_params.rbs +42 -1
- data/sig/revox/models.rbs +36 -2
- data/sig/revox/resources/assistants.rbs +61 -2
- data/sig/revox/resources/auth_status.rbs +11 -0
- data/sig/revox/resources/call.rbs +41 -3
- data/sig/revox/resources/campaigns.rbs +35 -5
- data/sig/revox/resources/phone_numbers.rbs +23 -0
- data/sig/revox/resources/users.rbs +3 -1
- data/sig/revox/resources/voices.rbs +17 -0
- metadata +122 -23
- data/lib/revox/models/call_list_params.rb +0 -52
- data/lib/revox/models/call_list_response.rb +0 -259
- data/lib/revox/models/users/me_retrieve_params.rb +0 -16
- data/lib/revox/models/users/me_retrieve_response.rb +0 -89
- data/lib/revox/models/users/me_update_params.rb +0 -22
- data/lib/revox/models/users/me_update_response.rb +0 -89
- data/lib/revox/resources/users/me.rb +0 -55
- data/rbi/revox/models/call_list_params.rbi +0 -94
- data/rbi/revox/models/call_list_response.rbi +0 -563
- data/rbi/revox/models/users/me_retrieve_params.rbi +0 -29
- data/rbi/revox/models/users/me_retrieve_response.rbi +0 -139
- data/rbi/revox/models/users/me_update_params.rbi +0 -43
- data/rbi/revox/models/users/me_update_response.rbi +0 -139
- data/rbi/revox/resources/users/me.rbi +0 -33
- data/sig/revox/models/call_list_params.rbs +0 -63
- data/sig/revox/models/call_list_response.rbs +0 -226
- data/sig/revox/models/users/me_retrieve_params.rbs +0 -16
- data/sig/revox/models/users/me_retrieve_response.rbs +0 -70
- data/sig/revox/models/users/me_update_params.rbs +0 -28
- data/sig/revox/models/users/me_update_response.rbs +0 -70
- data/sig/revox/resources/users/me.rbs +0 -18
|
@@ -49,11 +49,21 @@ module Revox
|
|
|
49
49
|
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Status]
|
|
50
50
|
required :status, enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Status }
|
|
51
51
|
|
|
52
|
+
# @!attribute type
|
|
53
|
+
#
|
|
54
|
+
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Type]
|
|
55
|
+
required :type, enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Type }
|
|
56
|
+
|
|
52
57
|
# @!attribute updated_at
|
|
53
58
|
#
|
|
54
59
|
# @return [Object]
|
|
55
60
|
required :updated_at, Revox::Internal::Type::Unknown
|
|
56
61
|
|
|
62
|
+
# @!attribute active_takeover_call_id
|
|
63
|
+
#
|
|
64
|
+
# @return [String, nil]
|
|
65
|
+
optional :active_takeover_call_id, String, nil?: true
|
|
66
|
+
|
|
57
67
|
# @!attribute assistant
|
|
58
68
|
#
|
|
59
69
|
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant, nil]
|
|
@@ -68,16 +78,39 @@ module Revox
|
|
|
68
78
|
-> { Revox::Models::CampaignRetrieveResponse::Campaign::CallRetryConfig },
|
|
69
79
|
nil?: true
|
|
70
80
|
|
|
81
|
+
# @!attribute created_by
|
|
82
|
+
# A member of the current organization.
|
|
83
|
+
#
|
|
84
|
+
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::CreatedBy, nil]
|
|
85
|
+
optional :created_by, -> { Revox::Models::CampaignRetrieveResponse::Campaign::CreatedBy }, nil?: true
|
|
86
|
+
|
|
71
87
|
# @!attribute from_phone_number
|
|
72
88
|
#
|
|
73
89
|
# @return [String, nil]
|
|
74
90
|
optional :from_phone_number, String, nil?: true
|
|
75
91
|
|
|
92
|
+
# @!attribute funnel_stats
|
|
93
|
+
#
|
|
94
|
+
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::FunnelStats, nil]
|
|
95
|
+
optional :funnel_stats, -> { Revox::Models::CampaignRetrieveResponse::Campaign::FunnelStats }
|
|
96
|
+
|
|
76
97
|
# @!attribute max_concurrent_calls
|
|
77
98
|
#
|
|
78
99
|
# @return [Float, nil]
|
|
79
100
|
optional :max_concurrent_calls, Float, nil?: true
|
|
80
101
|
|
|
102
|
+
# @!attribute paused_reason
|
|
103
|
+
#
|
|
104
|
+
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::PausedReason, nil]
|
|
105
|
+
optional :paused_reason,
|
|
106
|
+
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::PausedReason },
|
|
107
|
+
nil?: true
|
|
108
|
+
|
|
109
|
+
# @!attribute present_count
|
|
110
|
+
#
|
|
111
|
+
# @return [Float, nil]
|
|
112
|
+
optional :present_count, Float
|
|
113
|
+
|
|
81
114
|
# @!attribute row_stats
|
|
82
115
|
#
|
|
83
116
|
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::RowStats, nil]
|
|
@@ -88,7 +121,14 @@ module Revox
|
|
|
88
121
|
# @return [Object, nil]
|
|
89
122
|
optional :scheduled_at, Revox::Internal::Type::Unknown
|
|
90
123
|
|
|
91
|
-
# @!
|
|
124
|
+
# @!attribute structured_output_extraction
|
|
125
|
+
# The status of the structured output extraction.
|
|
126
|
+
#
|
|
127
|
+
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::StructuredOutputExtraction, nil]
|
|
128
|
+
optional :structured_output_extraction,
|
|
129
|
+
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::StructuredOutputExtraction }
|
|
130
|
+
|
|
131
|
+
# @!method initialize(id:, assistant_id:, created_at:, is_cancelled:, name:, organization_id:, status:, type:, updated_at:, active_takeover_call_id: nil, assistant: nil, call_retry_config: nil, created_by: nil, from_phone_number: nil, funnel_stats: nil, max_concurrent_calls: nil, paused_reason: nil, present_count: nil, row_stats: nil, scheduled_at: nil, structured_output_extraction: nil)
|
|
92
132
|
# Some parameter documentations has been truncated, see
|
|
93
133
|
# {Revox::Models::CampaignRetrieveResponse::Campaign} for more details.
|
|
94
134
|
#
|
|
@@ -106,19 +146,33 @@ module Revox
|
|
|
106
146
|
#
|
|
107
147
|
# @param status [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Status]
|
|
108
148
|
#
|
|
149
|
+
# @param type [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Type]
|
|
150
|
+
#
|
|
109
151
|
# @param updated_at [Object]
|
|
110
152
|
#
|
|
153
|
+
# @param active_takeover_call_id [String, nil]
|
|
154
|
+
#
|
|
111
155
|
# @param assistant [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant]
|
|
112
156
|
#
|
|
113
157
|
# @param call_retry_config [Revox::Models::CampaignRetrieveResponse::Campaign::CallRetryConfig, nil] Configuration for call retry behavior including time windows, delays, and max it
|
|
114
158
|
#
|
|
159
|
+
# @param created_by [Revox::Models::CampaignRetrieveResponse::Campaign::CreatedBy, nil] A member of the current organization.
|
|
160
|
+
#
|
|
115
161
|
# @param from_phone_number [String, nil]
|
|
116
162
|
#
|
|
163
|
+
# @param funnel_stats [Revox::Models::CampaignRetrieveResponse::Campaign::FunnelStats]
|
|
164
|
+
#
|
|
117
165
|
# @param max_concurrent_calls [Float, nil]
|
|
118
166
|
#
|
|
167
|
+
# @param paused_reason [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::PausedReason, nil]
|
|
168
|
+
#
|
|
169
|
+
# @param present_count [Float]
|
|
170
|
+
#
|
|
119
171
|
# @param row_stats [Revox::Models::CampaignRetrieveResponse::Campaign::RowStats]
|
|
120
172
|
#
|
|
121
173
|
# @param scheduled_at [Object]
|
|
174
|
+
#
|
|
175
|
+
# @param structured_output_extraction [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::StructuredOutputExtraction] The status of the structured output extraction.
|
|
122
176
|
|
|
123
177
|
# @see Revox::Models::CampaignRetrieveResponse::Campaign#status
|
|
124
178
|
module Status
|
|
@@ -133,6 +187,17 @@ module Revox
|
|
|
133
187
|
# @return [Array<Symbol>]
|
|
134
188
|
end
|
|
135
189
|
|
|
190
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign#type
|
|
191
|
+
module Type
|
|
192
|
+
extend Revox::Internal::Type::Enum
|
|
193
|
+
|
|
194
|
+
REGULAR = :regular
|
|
195
|
+
JUMP_IN = :jump_in
|
|
196
|
+
|
|
197
|
+
# @!method self.values
|
|
198
|
+
# @return [Array<Symbol>]
|
|
199
|
+
end
|
|
200
|
+
|
|
136
201
|
# @see Revox::Models::CampaignRetrieveResponse::Campaign#assistant
|
|
137
202
|
class Assistant < Revox::Internal::Type::BaseModel
|
|
138
203
|
# @!attribute id
|
|
@@ -140,15 +205,36 @@ module Revox
|
|
|
140
205
|
# @return [String]
|
|
141
206
|
required :id, String
|
|
142
207
|
|
|
208
|
+
# @!attribute after_call_sms_outcomes
|
|
209
|
+
# Which call outcomes trigger the after-call SMS. When empty or null, no
|
|
210
|
+
# after-call SMS is sent. Use "none" when outcome is null.
|
|
211
|
+
#
|
|
212
|
+
# @return [Array<Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::AfterCallSMSOutcome>, nil]
|
|
213
|
+
required :after_call_sms_outcomes,
|
|
214
|
+
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::AfterCallSMSOutcome] },
|
|
215
|
+
nil?: true
|
|
216
|
+
|
|
217
|
+
# @!attribute after_call_sms_prompt
|
|
218
|
+
# Prompt / instructions for the after-call SMS. Supports {{variable}}
|
|
219
|
+
# placeholders. When null, no after-call SMS is sent.
|
|
220
|
+
#
|
|
221
|
+
# @return [String, nil]
|
|
222
|
+
required :after_call_sms_prompt, String, nil?: true
|
|
223
|
+
|
|
143
224
|
# @!attribute background_sound
|
|
144
|
-
#
|
|
145
|
-
# your AI agent is in an office.
|
|
225
|
+
# Ambient background sound to play during the call. null disables it.
|
|
146
226
|
#
|
|
147
227
|
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::BackgroundSound, nil]
|
|
148
228
|
required :background_sound,
|
|
149
229
|
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::BackgroundSound },
|
|
150
230
|
nil?: true
|
|
151
231
|
|
|
232
|
+
# @!attribute background_sound_volume
|
|
233
|
+
# Volume of the ambient background sound (0 = silent, 1 = max).
|
|
234
|
+
#
|
|
235
|
+
# @return [Float]
|
|
236
|
+
required :background_sound_volume, Float
|
|
237
|
+
|
|
152
238
|
# @!attribute calendly
|
|
153
239
|
#
|
|
154
240
|
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Calendly, nil]
|
|
@@ -165,11 +251,48 @@ module Revox
|
|
|
165
251
|
-> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CallRetryConfig },
|
|
166
252
|
nil?: true
|
|
167
253
|
|
|
254
|
+
# @!attribute cartesia_dictionary_pronunciation_id
|
|
255
|
+
# Optional Cartesia pronunciation dictionary ID linked to this assistant.
|
|
256
|
+
#
|
|
257
|
+
# @return [String, nil]
|
|
258
|
+
required :cartesia_dictionary_pronunciation_id, String, nil?: true
|
|
259
|
+
|
|
168
260
|
# @!attribute created_at
|
|
169
261
|
#
|
|
170
262
|
# @return [Object]
|
|
171
263
|
required :created_at, Revox::Internal::Type::Unknown
|
|
172
264
|
|
|
265
|
+
# @!attribute custom_tools
|
|
266
|
+
#
|
|
267
|
+
# @return [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool>, nil]
|
|
268
|
+
required :custom_tools,
|
|
269
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool] },
|
|
270
|
+
nil?: true
|
|
271
|
+
|
|
272
|
+
# @!attribute email_notification_address
|
|
273
|
+
# Email address(es) to receive notifications when a call ends with a matching
|
|
274
|
+
# outcome. Accepts a single email or a comma-separated list (e.g. "alice@x.com,
|
|
275
|
+
# bob@y.com").
|
|
276
|
+
#
|
|
277
|
+
# @return [String, nil]
|
|
278
|
+
required :email_notification_address, String, nil?: true
|
|
279
|
+
|
|
280
|
+
# @!attribute email_notification_language
|
|
281
|
+
# The language used for the notification email content. One of "en" or "fr".
|
|
282
|
+
#
|
|
283
|
+
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::EmailNotificationLanguage]
|
|
284
|
+
required :email_notification_language,
|
|
285
|
+
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::EmailNotificationLanguage }
|
|
286
|
+
|
|
287
|
+
# @!attribute email_notification_outcomes
|
|
288
|
+
# Which call outcomes trigger an email notification. E.g. ["interested",
|
|
289
|
+
# "completed", "none"]. Use "none" when outcome is null.
|
|
290
|
+
#
|
|
291
|
+
# @return [Array<Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::EmailNotificationOutcome>, nil]
|
|
292
|
+
required :email_notification_outcomes,
|
|
293
|
+
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::EmailNotificationOutcome] },
|
|
294
|
+
nil?: true
|
|
295
|
+
|
|
173
296
|
# @!attribute end_of_call_sentence
|
|
174
297
|
#
|
|
175
298
|
# @return [String, nil]
|
|
@@ -192,6 +315,22 @@ module Revox
|
|
|
192
315
|
required :first_sentence_mode,
|
|
193
316
|
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::FirstSentenceMode }
|
|
194
317
|
|
|
318
|
+
# @!attribute from_phone_number
|
|
319
|
+
# Override the default outbound phone number for calls placed with this assistant.
|
|
320
|
+
# When null, the organization's default phone number is used.
|
|
321
|
+
#
|
|
322
|
+
# @return [String, nil]
|
|
323
|
+
required :from_phone_number, String, nil?: true
|
|
324
|
+
|
|
325
|
+
# @!attribute human_transfer_mode
|
|
326
|
+
# Warm or cold transfer when transfer_phone_number is set; null when transfer is
|
|
327
|
+
# not configured.
|
|
328
|
+
#
|
|
329
|
+
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::HumanTransferMode, nil]
|
|
330
|
+
required :human_transfer_mode,
|
|
331
|
+
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::HumanTransferMode },
|
|
332
|
+
nil?: true
|
|
333
|
+
|
|
195
334
|
# @!attribute ivr_navigation_enabled
|
|
196
335
|
# Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
|
|
197
336
|
# skip turns to navigate phone menus.
|
|
@@ -201,9 +340,16 @@ module Revox
|
|
|
201
340
|
|
|
202
341
|
# @!attribute llm_model
|
|
203
342
|
#
|
|
204
|
-
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember0, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember1]
|
|
343
|
+
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember0, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember1, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember2, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember3]
|
|
205
344
|
required :llm_model, union: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel }
|
|
206
345
|
|
|
346
|
+
# @!attribute logo_url
|
|
347
|
+
# Public URL of the brand logo shown on the assistant's demo page. Null when
|
|
348
|
+
# unset.
|
|
349
|
+
#
|
|
350
|
+
# @return [String, nil]
|
|
351
|
+
required :logo_url, String, nil?: true
|
|
352
|
+
|
|
207
353
|
# @!attribute max_call_duration_secs
|
|
208
354
|
# The maximum duration of the call in seconds. This is the maximum time the call
|
|
209
355
|
# will be allowed to run.
|
|
@@ -211,6 +357,14 @@ module Revox
|
|
|
211
357
|
# @return [Float]
|
|
212
358
|
required :max_call_duration_secs, Float
|
|
213
359
|
|
|
360
|
+
# @!attribute max_duration_end_message
|
|
361
|
+
# Optional message the agent will say, without being interruptible, when the call
|
|
362
|
+
# reaches its max duration. Kept short so it fits inside the farewell buffer. If
|
|
363
|
+
# null, the call ends silently.
|
|
364
|
+
#
|
|
365
|
+
# @return [String, nil]
|
|
366
|
+
required :max_duration_end_message, String, nil?: true
|
|
367
|
+
|
|
214
368
|
# @!attribute name
|
|
215
369
|
#
|
|
216
370
|
# @return [String]
|
|
@@ -221,11 +375,45 @@ module Revox
|
|
|
221
375
|
# @return [String]
|
|
222
376
|
required :organization_id, String
|
|
223
377
|
|
|
378
|
+
# @!attribute position
|
|
379
|
+
#
|
|
380
|
+
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Position, nil]
|
|
381
|
+
required :position,
|
|
382
|
+
-> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Position },
|
|
383
|
+
nil?: true
|
|
384
|
+
|
|
224
385
|
# @!attribute prompt
|
|
225
386
|
#
|
|
226
387
|
# @return [String]
|
|
227
388
|
required :prompt, String
|
|
228
389
|
|
|
390
|
+
# @!attribute prompt_flow
|
|
391
|
+
#
|
|
392
|
+
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow, nil]
|
|
393
|
+
required :prompt_flow,
|
|
394
|
+
-> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow },
|
|
395
|
+
nil?: true
|
|
396
|
+
|
|
397
|
+
# @!attribute slack
|
|
398
|
+
#
|
|
399
|
+
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack, nil]
|
|
400
|
+
required :slack, -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack }, nil?: true
|
|
401
|
+
|
|
402
|
+
# @!attribute sms_enabled
|
|
403
|
+
# Enable SMS tool during calls. When enabled, the agent can send SMS messages to
|
|
404
|
+
# the user on the call.
|
|
405
|
+
#
|
|
406
|
+
# @return [Boolean]
|
|
407
|
+
required :sms_enabled, Revox::Internal::Type::Boolean
|
|
408
|
+
|
|
409
|
+
# @!attribute sms_template
|
|
410
|
+
# Hardcoded SMS template to send during calls. When set, this exact text is sent
|
|
411
|
+
# instead of letting the agent generate the message. Supports {{variable}}
|
|
412
|
+
# placeholders.
|
|
413
|
+
#
|
|
414
|
+
# @return [String, nil]
|
|
415
|
+
required :sms_template, String, nil?: true
|
|
416
|
+
|
|
229
417
|
# @!attribute structured_output_config
|
|
230
418
|
# The structured output config to use for the call. This is used to extract the
|
|
231
419
|
# data from the call (like email, name, company name, etc.).
|
|
@@ -235,12 +423,63 @@ module Revox
|
|
|
235
423
|
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::StructuredOutputConfig] },
|
|
236
424
|
nil?: true
|
|
237
425
|
|
|
426
|
+
# @!attribute structured_output_prompt
|
|
427
|
+
# Custom prompt for structured data extraction. If not provided, a default prompt
|
|
428
|
+
# is used. Available variables: {{transcript}}, {{call_direction}},
|
|
429
|
+
# {{user_phone_number}}, {{agent_phone_number}}.
|
|
430
|
+
#
|
|
431
|
+
# @return [String, nil]
|
|
432
|
+
required :structured_output_prompt, String, nil?: true
|
|
433
|
+
|
|
434
|
+
# @!attribute stt_context
|
|
435
|
+
# Assistant-level speech-to-text context: structured `general` key/value pairs
|
|
436
|
+
# plus a list of domain `terms`. Prompt-derived context is merged in without
|
|
437
|
+
# replacing existing entries.
|
|
438
|
+
#
|
|
439
|
+
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::SttContext, nil]
|
|
440
|
+
required :stt_context,
|
|
441
|
+
-> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::SttContext },
|
|
442
|
+
nil?: true
|
|
443
|
+
|
|
444
|
+
# @!attribute stt_model
|
|
445
|
+
# Transcriber (speech-to-text) model used for the assistant.
|
|
446
|
+
#
|
|
447
|
+
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::SttModel]
|
|
448
|
+
required :stt_model, enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::SttModel }
|
|
449
|
+
|
|
450
|
+
# @!attribute thinking_sound
|
|
451
|
+
# Audio clip to play while the agent is processing a response. One of the built-in
|
|
452
|
+
# LiveKit audio clips; null disables it.
|
|
453
|
+
#
|
|
454
|
+
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::ThinkingSound, nil]
|
|
455
|
+
required :thinking_sound,
|
|
456
|
+
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::ThinkingSound },
|
|
457
|
+
nil?: true
|
|
458
|
+
|
|
459
|
+
# @!attribute thinking_sound_probability
|
|
460
|
+
# Probability [0..1] that the thinking sound plays on any given turn; otherwise
|
|
461
|
+
# the agent is silent while thinking.
|
|
462
|
+
#
|
|
463
|
+
# @return [Float]
|
|
464
|
+
required :thinking_sound_probability, Float
|
|
465
|
+
|
|
466
|
+
# @!attribute thinking_sound_volume
|
|
467
|
+
# Volume of the thinking sound (0 = silent, 1 = max).
|
|
468
|
+
#
|
|
469
|
+
# @return [Float]
|
|
470
|
+
required :thinking_sound_volume, Float
|
|
471
|
+
|
|
238
472
|
# @!attribute transfer_phone_number
|
|
239
473
|
# Phone number to transfer calls to when users request to speak to a human agent.
|
|
240
474
|
#
|
|
241
475
|
# @return [String, nil]
|
|
242
476
|
required :transfer_phone_number, String, nil?: true
|
|
243
477
|
|
|
478
|
+
# @!attribute type
|
|
479
|
+
#
|
|
480
|
+
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Type]
|
|
481
|
+
required :type, enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Type }
|
|
482
|
+
|
|
244
483
|
# @!attribute updated_at
|
|
245
484
|
#
|
|
246
485
|
# @return [Object]
|
|
@@ -258,37 +497,85 @@ module Revox
|
|
|
258
497
|
# @return [String, nil]
|
|
259
498
|
required :voicemail_message, String, nil?: true
|
|
260
499
|
|
|
500
|
+
# @!attribute voicemail_sms_prompt
|
|
501
|
+
# Prompt / instructions for the voicemail SMS. Supports {{variable}} placeholders.
|
|
502
|
+
# When null, no SMS is sent on voicemail.
|
|
503
|
+
#
|
|
504
|
+
# @return [String, nil]
|
|
505
|
+
required :voicemail_sms_prompt, String, nil?: true
|
|
506
|
+
|
|
507
|
+
# @!attribute warm_transfer_summary_instructions
|
|
508
|
+
# Warm transfer only: instructions for the supervisor handoff summary; null when
|
|
509
|
+
# not configured or cold transfer.
|
|
510
|
+
#
|
|
511
|
+
# @return [String, nil]
|
|
512
|
+
required :warm_transfer_summary_instructions, String, nil?: true
|
|
513
|
+
|
|
261
514
|
# @!attribute webhook_url
|
|
262
515
|
# The webhook URL to call when the call is completed.
|
|
263
516
|
#
|
|
264
517
|
# @return [String, nil]
|
|
265
518
|
required :webhook_url, String, nil?: true
|
|
266
519
|
|
|
520
|
+
# @!attribute zoho
|
|
521
|
+
#
|
|
522
|
+
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Zoho, nil]
|
|
523
|
+
required :zoho, -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Zoho }, nil?: true
|
|
524
|
+
|
|
525
|
+
# @!attribute created_by
|
|
526
|
+
# The user who created the assistant.
|
|
527
|
+
#
|
|
528
|
+
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CreatedBy, nil]
|
|
529
|
+
optional :created_by,
|
|
530
|
+
-> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CreatedBy },
|
|
531
|
+
nil?: true
|
|
532
|
+
|
|
267
533
|
# @!attribute faq_items
|
|
268
534
|
#
|
|
269
535
|
# @return [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::FaqItem>, nil]
|
|
270
536
|
optional :faq_items,
|
|
271
537
|
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::FaqItem] }
|
|
272
538
|
|
|
539
|
+
# @!attribute is_realestate_assistant
|
|
540
|
+
#
|
|
541
|
+
# @return [Boolean, nil]
|
|
542
|
+
optional :is_realestate_assistant, Revox::Internal::Type::Boolean
|
|
543
|
+
|
|
273
544
|
# @!attribute pending_faq_count
|
|
274
545
|
#
|
|
275
546
|
# @return [Float, nil]
|
|
276
547
|
optional :pending_faq_count, Float
|
|
277
548
|
|
|
278
|
-
# @!method initialize(id:, background_sound:, calendly:, call_retry_config:, created_at:, end_of_call_sentence:, first_sentence:, first_sentence_delay_ms:, first_sentence_mode:, ivr_navigation_enabled:, llm_model:, max_call_duration_secs:, name:, organization_id:, prompt:, structured_output_config:, transfer_phone_number:, updated_at:, voice:, voicemail_message:, webhook_url:, faq_items: nil, pending_faq_count: nil)
|
|
549
|
+
# @!method initialize(id:, after_call_sms_outcomes:, after_call_sms_prompt:, background_sound:, background_sound_volume:, calendly:, call_retry_config:, cartesia_dictionary_pronunciation_id:, created_at:, custom_tools:, email_notification_address:, email_notification_language:, email_notification_outcomes:, end_of_call_sentence:, first_sentence:, first_sentence_delay_ms:, first_sentence_mode:, from_phone_number:, human_transfer_mode:, ivr_navigation_enabled:, llm_model:, logo_url:, max_call_duration_secs:, max_duration_end_message:, name:, organization_id:, position:, prompt:, prompt_flow:, slack:, sms_enabled:, sms_template:, structured_output_config:, structured_output_prompt:, stt_context:, stt_model:, thinking_sound:, thinking_sound_probability:, thinking_sound_volume:, transfer_phone_number:, type:, updated_at:, voice:, voicemail_message:, voicemail_sms_prompt:, warm_transfer_summary_instructions:, webhook_url:, zoho:, created_by: nil, faq_items: nil, is_realestate_assistant: nil, pending_faq_count: nil)
|
|
279
550
|
# Some parameter documentations has been truncated, see
|
|
280
551
|
# {Revox::Models::CampaignRetrieveResponse::Campaign::Assistant} for more details.
|
|
281
552
|
#
|
|
282
553
|
# @param id [String]
|
|
283
554
|
#
|
|
284
|
-
# @param
|
|
555
|
+
# @param after_call_sms_outcomes [Array<Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::AfterCallSMSOutcome>, nil] Which call outcomes trigger the after-call SMS. When empty or null, no after-cal
|
|
556
|
+
#
|
|
557
|
+
# @param after_call_sms_prompt [String, nil] Prompt / instructions for the after-call SMS. Supports {{variable}} placeholders
|
|
558
|
+
#
|
|
559
|
+
# @param background_sound [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::BackgroundSound, nil] Ambient background sound to play during the call. null disables it.
|
|
560
|
+
#
|
|
561
|
+
# @param background_sound_volume [Float] Volume of the ambient background sound (0 = silent, 1 = max).
|
|
285
562
|
#
|
|
286
563
|
# @param calendly [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Calendly, nil]
|
|
287
564
|
#
|
|
288
565
|
# @param call_retry_config [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CallRetryConfig, nil] Configuration for call retry behavior including time windows, delays, and max it
|
|
289
566
|
#
|
|
567
|
+
# @param cartesia_dictionary_pronunciation_id [String, nil] Optional Cartesia pronunciation dictionary ID linked to this assistant.
|
|
568
|
+
#
|
|
290
569
|
# @param created_at [Object]
|
|
291
570
|
#
|
|
571
|
+
# @param custom_tools [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool>, nil]
|
|
572
|
+
#
|
|
573
|
+
# @param email_notification_address [String, nil] Email address(es) to receive notifications when a call ends with a matching outc
|
|
574
|
+
#
|
|
575
|
+
# @param email_notification_language [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::EmailNotificationLanguage] The language used for the notification email content. One of "en" or "fr".
|
|
576
|
+
#
|
|
577
|
+
# @param email_notification_outcomes [Array<Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::EmailNotificationOutcome>, nil] Which call outcomes trigger an email notification. E.g. ["interested", "complete
|
|
578
|
+
#
|
|
292
579
|
# @param end_of_call_sentence [String, nil]
|
|
293
580
|
#
|
|
294
581
|
# @param first_sentence [String, nil]
|
|
@@ -297,36 +584,93 @@ module Revox
|
|
|
297
584
|
#
|
|
298
585
|
# @param first_sentence_mode [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::FirstSentenceMode]
|
|
299
586
|
#
|
|
587
|
+
# @param from_phone_number [String, nil] Override the default outbound phone number for calls placed with this assistant.
|
|
588
|
+
#
|
|
589
|
+
# @param human_transfer_mode [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::HumanTransferMode, nil] Warm or cold transfer when transfer_phone_number is set; null when transfer is n
|
|
590
|
+
#
|
|
300
591
|
# @param ivr_navigation_enabled [Boolean] Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
|
|
301
592
|
#
|
|
302
|
-
# @param llm_model [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember0, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember1]
|
|
593
|
+
# @param llm_model [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember0, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember1, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember2, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember3]
|
|
594
|
+
#
|
|
595
|
+
# @param logo_url [String, nil] Public URL of the brand logo shown on the assistant's demo page. Null when unset
|
|
303
596
|
#
|
|
304
597
|
# @param max_call_duration_secs [Float] The maximum duration of the call in seconds. This is the maximum time the call w
|
|
305
598
|
#
|
|
599
|
+
# @param max_duration_end_message [String, nil] Optional message the agent will say, without being interruptible, when the call
|
|
600
|
+
#
|
|
306
601
|
# @param name [String]
|
|
307
602
|
#
|
|
308
603
|
# @param organization_id [String]
|
|
309
604
|
#
|
|
605
|
+
# @param position [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Position, nil]
|
|
606
|
+
#
|
|
310
607
|
# @param prompt [String]
|
|
311
608
|
#
|
|
609
|
+
# @param prompt_flow [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow, nil]
|
|
610
|
+
#
|
|
611
|
+
# @param slack [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack, nil]
|
|
612
|
+
#
|
|
613
|
+
# @param sms_enabled [Boolean] Enable SMS tool during calls. When enabled, the agent can send SMS messages to t
|
|
614
|
+
#
|
|
615
|
+
# @param sms_template [String, nil] Hardcoded SMS template to send during calls. When set, this exact text is sent i
|
|
616
|
+
#
|
|
312
617
|
# @param structured_output_config [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::StructuredOutputConfig>, nil] The structured output config to use for the call. This is used to extract the da
|
|
313
618
|
#
|
|
619
|
+
# @param structured_output_prompt [String, nil] Custom prompt for structured data extraction. If not provided, a default prompt
|
|
620
|
+
#
|
|
621
|
+
# @param stt_context [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::SttContext, nil] Assistant-level speech-to-text context: structured `general` key/value pairs plu
|
|
622
|
+
#
|
|
623
|
+
# @param stt_model [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::SttModel] Transcriber (speech-to-text) model used for the assistant.
|
|
624
|
+
#
|
|
625
|
+
# @param thinking_sound [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::ThinkingSound, nil] Audio clip to play while the agent is processing a response. One of the built-in
|
|
626
|
+
#
|
|
627
|
+
# @param thinking_sound_probability [Float] Probability [0..1] that the thinking sound plays on any given turn; otherwise th
|
|
628
|
+
#
|
|
629
|
+
# @param thinking_sound_volume [Float] Volume of the thinking sound (0 = silent, 1 = max).
|
|
630
|
+
#
|
|
314
631
|
# @param transfer_phone_number [String, nil] Phone number to transfer calls to when users request to speak to a human agent.
|
|
315
632
|
#
|
|
633
|
+
# @param type [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Type]
|
|
634
|
+
#
|
|
316
635
|
# @param updated_at [Object]
|
|
317
636
|
#
|
|
318
637
|
# @param voice [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Voice, nil]
|
|
319
638
|
#
|
|
320
639
|
# @param voicemail_message [String, nil] If set, when voicemail is detected the agent will speak this message then hang u
|
|
321
640
|
#
|
|
641
|
+
# @param voicemail_sms_prompt [String, nil] Prompt / instructions for the voicemail SMS. Supports {{variable}} placeholders.
|
|
642
|
+
#
|
|
643
|
+
# @param warm_transfer_summary_instructions [String, nil] Warm transfer only: instructions for the supervisor handoff summary; null when n
|
|
644
|
+
#
|
|
322
645
|
# @param webhook_url [String, nil] The webhook URL to call when the call is completed.
|
|
323
646
|
#
|
|
647
|
+
# @param zoho [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Zoho, nil]
|
|
648
|
+
#
|
|
649
|
+
# @param created_by [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CreatedBy, nil] The user who created the assistant.
|
|
650
|
+
#
|
|
324
651
|
# @param faq_items [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::FaqItem>]
|
|
325
652
|
#
|
|
653
|
+
# @param is_realestate_assistant [Boolean]
|
|
654
|
+
#
|
|
326
655
|
# @param pending_faq_count [Float]
|
|
327
656
|
|
|
328
|
-
|
|
329
|
-
|
|
657
|
+
module AfterCallSMSOutcome
|
|
658
|
+
extend Revox::Internal::Type::Enum
|
|
659
|
+
|
|
660
|
+
NOT_INTERESTED = :not_interested
|
|
661
|
+
INTERESTED = :interested
|
|
662
|
+
COMPLETED = :completed
|
|
663
|
+
REQUESTED_CALLBACK_LATER = :requested_callback_later
|
|
664
|
+
REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
|
|
665
|
+
DO_NOT_CONTACT = :do_not_contact
|
|
666
|
+
AI_AVERSE = :ai_averse
|
|
667
|
+
NONE = :none
|
|
668
|
+
|
|
669
|
+
# @!method self.values
|
|
670
|
+
# @return [Array<Symbol>]
|
|
671
|
+
end
|
|
672
|
+
|
|
673
|
+
# Ambient background sound to play during the call. null disables it.
|
|
330
674
|
#
|
|
331
675
|
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#background_sound
|
|
332
676
|
module BackgroundSound
|
|
@@ -365,6 +709,23 @@ module Revox
|
|
|
365
709
|
|
|
366
710
|
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#call_retry_config
|
|
367
711
|
class CallRetryConfig < Revox::Internal::Type::BaseModel
|
|
712
|
+
# @!attribute allowed_days
|
|
713
|
+
# Days of the week when calls are allowed, in the recipient's timezone. Default:
|
|
714
|
+
# Monday through Friday.
|
|
715
|
+
#
|
|
716
|
+
# @return [Array<Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CallRetryConfig::AllowedDay>]
|
|
717
|
+
required :allowed_days,
|
|
718
|
+
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CallRetryConfig::AllowedDay] }
|
|
719
|
+
|
|
720
|
+
# @!attribute call_twice_in_a_row
|
|
721
|
+
# If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping
|
|
722
|
+
# retry_delay_seconds) when attempt #1 didn't reach a human.
|
|
723
|
+
# Calling-window/allowed-days checks still apply. Only affects the 1→2 transition.
|
|
724
|
+
# Default: false.
|
|
725
|
+
#
|
|
726
|
+
# @return [Boolean]
|
|
727
|
+
required :call_twice_in_a_row, Revox::Internal::Type::Boolean
|
|
728
|
+
|
|
368
729
|
# @!attribute calling_windows
|
|
369
730
|
#
|
|
370
731
|
# @return [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CallRetryConfig::CallingWindow>]
|
|
@@ -385,7 +746,7 @@ module Revox
|
|
|
385
746
|
# @return [String, nil]
|
|
386
747
|
optional :timezone, String, nil?: true
|
|
387
748
|
|
|
388
|
-
# @!method initialize(calling_windows:, max_retry_attempts:, timezone: nil)
|
|
749
|
+
# @!method initialize(allowed_days:, call_twice_in_a_row:, calling_windows:, max_retry_attempts:, timezone: nil)
|
|
389
750
|
# Some parameter documentations has been truncated, see
|
|
390
751
|
# {Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CallRetryConfig}
|
|
391
752
|
# for more details.
|
|
@@ -393,12 +754,31 @@ module Revox
|
|
|
393
754
|
# Configuration for call retry behavior including time windows, delays, and max
|
|
394
755
|
# iterations. If not provided, defaults will be used.
|
|
395
756
|
#
|
|
757
|
+
# @param allowed_days [Array<Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CallRetryConfig::AllowedDay>] Days of the week when calls are allowed, in the recipient's timezone. Default: M
|
|
758
|
+
#
|
|
759
|
+
# @param call_twice_in_a_row [Boolean] If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retr
|
|
760
|
+
#
|
|
396
761
|
# @param calling_windows [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CallRetryConfig::CallingWindow>]
|
|
397
762
|
#
|
|
398
763
|
# @param max_retry_attempts [Integer] Maximum number of call retry attempts. Default: 3.
|
|
399
764
|
#
|
|
400
765
|
# @param timezone [String, nil] Optional IANA timezone identifier to override the automatic timezone detection f
|
|
401
766
|
|
|
767
|
+
module AllowedDay
|
|
768
|
+
extend Revox::Internal::Type::Enum
|
|
769
|
+
|
|
770
|
+
MONDAY = :monday
|
|
771
|
+
TUESDAY = :tuesday
|
|
772
|
+
WEDNESDAY = :wednesday
|
|
773
|
+
THURSDAY = :thursday
|
|
774
|
+
FRIDAY = :friday
|
|
775
|
+
SATURDAY = :saturday
|
|
776
|
+
SUNDAY = :sunday
|
|
777
|
+
|
|
778
|
+
# @!method self.values
|
|
779
|
+
# @return [Array<Symbol>]
|
|
780
|
+
end
|
|
781
|
+
|
|
402
782
|
class CallingWindow < Revox::Internal::Type::BaseModel
|
|
403
783
|
# @!attribute calling_window_end_time
|
|
404
784
|
# End time for the calling window in the recipient's timezone (or
|
|
@@ -435,83 +815,586 @@ module Revox
|
|
|
435
815
|
end
|
|
436
816
|
end
|
|
437
817
|
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
818
|
+
class CustomTool < Revox::Internal::Type::BaseModel
|
|
819
|
+
# @!attribute body_template
|
|
820
|
+
# JSON body template for the request. Use quoted {{variable}} placeholders (e.g.
|
|
821
|
+
# "{{name}}") for dynamic values
|
|
822
|
+
#
|
|
823
|
+
# @return [String, nil]
|
|
824
|
+
required :body_template, String, nil?: true
|
|
441
825
|
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
826
|
+
# @!attribute description
|
|
827
|
+
# Human-readable description of what the tool does, used by the LLM to decide when
|
|
828
|
+
# to call it
|
|
829
|
+
#
|
|
830
|
+
# @return [String]
|
|
831
|
+
required :description, String
|
|
445
832
|
|
|
446
|
-
# @!
|
|
447
|
-
#
|
|
448
|
-
|
|
833
|
+
# @!attribute headers
|
|
834
|
+
# HTTP headers to include in the request. Values support {{variable}} placeholders
|
|
835
|
+
#
|
|
836
|
+
# @return [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::Header>]
|
|
837
|
+
required :headers,
|
|
838
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::Header] }
|
|
449
839
|
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
840
|
+
# @!attribute input_schema
|
|
841
|
+
# Schema defining the parameters the LLM should extract from the conversation to
|
|
842
|
+
# pass to this tool
|
|
843
|
+
#
|
|
844
|
+
# @return [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::InputSchema>]
|
|
845
|
+
required :input_schema,
|
|
846
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::InputSchema] }
|
|
453
847
|
|
|
454
|
-
|
|
848
|
+
# @!attribute method_
|
|
849
|
+
# HTTP method to use when calling the API endpoint
|
|
850
|
+
#
|
|
851
|
+
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::Method]
|
|
852
|
+
required :method_,
|
|
853
|
+
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::Method },
|
|
854
|
+
api_name: :method
|
|
455
855
|
|
|
456
|
-
|
|
856
|
+
# @!attribute name
|
|
857
|
+
# Unique tool name in lowercase_snake_case (e.g. check_inventory)
|
|
858
|
+
#
|
|
859
|
+
# @return [String]
|
|
860
|
+
required :name, String
|
|
457
861
|
|
|
458
|
-
|
|
862
|
+
# @!attribute query_params
|
|
863
|
+
# Query string parameters appended to the URL. Values support {{variable}}
|
|
864
|
+
# placeholders
|
|
865
|
+
#
|
|
866
|
+
# @return [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::QueryParam>]
|
|
867
|
+
required :query_params,
|
|
868
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::QueryParam] }
|
|
869
|
+
|
|
870
|
+
# @!attribute url
|
|
871
|
+
# Full URL of the API endpoint. Supports {{variable}} placeholders for dynamic
|
|
872
|
+
# values
|
|
873
|
+
#
|
|
874
|
+
# @return [String]
|
|
875
|
+
required :url, String
|
|
876
|
+
|
|
877
|
+
# @!method initialize(body_template:, description:, headers:, input_schema:, method_:, name:, query_params:, url:)
|
|
878
|
+
# Some parameter documentations has been truncated, see
|
|
879
|
+
# {Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool} for
|
|
880
|
+
# more details.
|
|
881
|
+
#
|
|
882
|
+
# @param body_template [String, nil] JSON body template for the request. Use quoted {{variable}} placeholders (e.g. "
|
|
883
|
+
#
|
|
884
|
+
# @param description [String] Human-readable description of what the tool does, used by the LLM to decide when
|
|
885
|
+
#
|
|
886
|
+
# @param headers [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::Header>] HTTP headers to include in the request. Values support {{variable}} placeholders
|
|
887
|
+
#
|
|
888
|
+
# @param input_schema [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::InputSchema>] Schema defining the parameters the LLM should extract from the conversation to p
|
|
889
|
+
#
|
|
890
|
+
# @param method_ [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::Method] HTTP method to use when calling the API endpoint
|
|
891
|
+
#
|
|
892
|
+
# @param name [String] Unique tool name in lowercase_snake_case (e.g. check_inventory)
|
|
893
|
+
#
|
|
894
|
+
# @param query_params [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::QueryParam>] Query string parameters appended to the URL. Values support {{variable}} placeho
|
|
895
|
+
#
|
|
896
|
+
# @param url [String] Full URL of the API endpoint. Supports {{variable}} placeholders for dynamic val
|
|
897
|
+
|
|
898
|
+
class Header < Revox::Internal::Type::BaseModel
|
|
899
|
+
# @!attribute key
|
|
900
|
+
#
|
|
901
|
+
# @return [String]
|
|
902
|
+
required :key, String
|
|
903
|
+
|
|
904
|
+
# @!attribute value
|
|
905
|
+
#
|
|
906
|
+
# @return [String]
|
|
907
|
+
required :value, String
|
|
908
|
+
|
|
909
|
+
# @!method initialize(key:, value:)
|
|
910
|
+
# @param key [String]
|
|
911
|
+
# @param value [String]
|
|
912
|
+
end
|
|
913
|
+
|
|
914
|
+
class InputSchema < Revox::Internal::Type::BaseModel
|
|
459
915
|
# @!attribute name
|
|
460
916
|
#
|
|
461
|
-
# @return [
|
|
462
|
-
required :name,
|
|
463
|
-
|
|
917
|
+
# @return [String]
|
|
918
|
+
required :name, String
|
|
919
|
+
|
|
920
|
+
# @!attribute required
|
|
921
|
+
#
|
|
922
|
+
# @return [Boolean]
|
|
923
|
+
required :required, Revox::Internal::Type::Boolean
|
|
464
924
|
|
|
465
925
|
# @!attribute type
|
|
466
926
|
#
|
|
467
|
-
# @return [Symbol,
|
|
468
|
-
required :type,
|
|
927
|
+
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::InputSchema::Type]
|
|
928
|
+
required :type,
|
|
929
|
+
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::InputSchema::Type }
|
|
469
930
|
|
|
470
|
-
# @!
|
|
471
|
-
#
|
|
472
|
-
# @
|
|
931
|
+
# @!attribute description
|
|
932
|
+
#
|
|
933
|
+
# @return [String, nil]
|
|
934
|
+
optional :description, String
|
|
473
935
|
|
|
474
|
-
#
|
|
475
|
-
|
|
936
|
+
# @!attribute enum_options
|
|
937
|
+
#
|
|
938
|
+
# @return [Array<String>, nil]
|
|
939
|
+
optional :enum_options, Revox::Internal::Type::ArrayOf[String]
|
|
940
|
+
|
|
941
|
+
# @!method initialize(name:, required:, type:, description: nil, enum_options: nil)
|
|
942
|
+
# @param name [String]
|
|
943
|
+
# @param required [Boolean]
|
|
944
|
+
# @param type [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::InputSchema::Type]
|
|
945
|
+
# @param description [String]
|
|
946
|
+
# @param enum_options [Array<String>]
|
|
947
|
+
|
|
948
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool::InputSchema#type
|
|
949
|
+
module Type
|
|
476
950
|
extend Revox::Internal::Type::Enum
|
|
477
951
|
|
|
478
|
-
|
|
479
|
-
|
|
952
|
+
STRING = :string
|
|
953
|
+
NUMBER = :number
|
|
954
|
+
BOOLEAN = :boolean
|
|
955
|
+
ENUM = :enum
|
|
956
|
+
DATE = :date
|
|
957
|
+
DATETIME = :datetime
|
|
480
958
|
|
|
481
959
|
# @!method self.values
|
|
482
960
|
# @return [Array<Symbol>]
|
|
483
961
|
end
|
|
484
962
|
end
|
|
485
963
|
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
964
|
+
# HTTP method to use when calling the API endpoint
|
|
965
|
+
#
|
|
966
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::CustomTool#method_
|
|
967
|
+
module Method
|
|
968
|
+
extend Revox::Internal::Type::Enum
|
|
969
|
+
|
|
970
|
+
GET = :GET
|
|
971
|
+
POST = :POST
|
|
972
|
+
PUT = :PUT
|
|
973
|
+
PATCH = :PATCH
|
|
974
|
+
DELETE = :DELETE
|
|
975
|
+
|
|
976
|
+
# @!method self.values
|
|
977
|
+
# @return [Array<Symbol>]
|
|
978
|
+
end
|
|
979
|
+
|
|
980
|
+
class QueryParam < Revox::Internal::Type::BaseModel
|
|
981
|
+
# @!attribute key
|
|
489
982
|
#
|
|
490
983
|
# @return [String]
|
|
491
|
-
required :
|
|
984
|
+
required :key, String
|
|
492
985
|
|
|
493
|
-
# @!attribute
|
|
494
|
-
# The provider to use from OpenRouter. eg: nebius, openai, azure, etc.
|
|
986
|
+
# @!attribute value
|
|
495
987
|
#
|
|
496
988
|
# @return [String]
|
|
497
|
-
required :
|
|
989
|
+
required :value, String
|
|
498
990
|
|
|
499
|
-
# @!
|
|
500
|
-
#
|
|
501
|
-
#
|
|
502
|
-
|
|
503
|
-
|
|
991
|
+
# @!method initialize(key:, value:)
|
|
992
|
+
# @param key [String]
|
|
993
|
+
# @param value [String]
|
|
994
|
+
end
|
|
995
|
+
end
|
|
504
996
|
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
997
|
+
# The language used for the notification email content. One of "en" or "fr".
|
|
998
|
+
#
|
|
999
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#email_notification_language
|
|
1000
|
+
module EmailNotificationLanguage
|
|
1001
|
+
extend Revox::Internal::Type::Enum
|
|
1002
|
+
|
|
1003
|
+
EN = :en
|
|
1004
|
+
FR = :fr
|
|
1005
|
+
|
|
1006
|
+
# @!method self.values
|
|
1007
|
+
# @return [Array<Symbol>]
|
|
1008
|
+
end
|
|
1009
|
+
|
|
1010
|
+
module EmailNotificationOutcome
|
|
1011
|
+
extend Revox::Internal::Type::Enum
|
|
1012
|
+
|
|
1013
|
+
NOT_INTERESTED = :not_interested
|
|
1014
|
+
INTERESTED = :interested
|
|
1015
|
+
COMPLETED = :completed
|
|
1016
|
+
REQUESTED_CALLBACK_LATER = :requested_callback_later
|
|
1017
|
+
REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
|
|
1018
|
+
DO_NOT_CONTACT = :do_not_contact
|
|
1019
|
+
AI_AVERSE = :ai_averse
|
|
1020
|
+
NONE = :none
|
|
1021
|
+
|
|
1022
|
+
# @!method self.values
|
|
1023
|
+
# @return [Array<Symbol>]
|
|
1024
|
+
end
|
|
1025
|
+
|
|
1026
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#first_sentence_mode
|
|
1027
|
+
module FirstSentenceMode
|
|
1028
|
+
extend Revox::Internal::Type::Enum
|
|
1029
|
+
|
|
1030
|
+
GENERATED = :generated
|
|
1031
|
+
STATIC = :static
|
|
1032
|
+
NONE = :none
|
|
1033
|
+
|
|
1034
|
+
# @!method self.values
|
|
1035
|
+
# @return [Array<Symbol>]
|
|
1036
|
+
end
|
|
1037
|
+
|
|
1038
|
+
# Warm or cold transfer when transfer_phone_number is set; null when transfer is
|
|
1039
|
+
# not configured.
|
|
1040
|
+
#
|
|
1041
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#human_transfer_mode
|
|
1042
|
+
module HumanTransferMode
|
|
1043
|
+
extend Revox::Internal::Type::Enum
|
|
1044
|
+
|
|
1045
|
+
WARM = :warm
|
|
1046
|
+
COLD = :cold
|
|
1047
|
+
|
|
1048
|
+
# @!method self.values
|
|
1049
|
+
# @return [Array<Symbol>]
|
|
1050
|
+
end
|
|
1051
|
+
|
|
1052
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#llm_model
|
|
1053
|
+
module LlmModel
|
|
1054
|
+
extend Revox::Internal::Type::Union
|
|
1055
|
+
|
|
1056
|
+
variant -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember0 }
|
|
1057
|
+
|
|
1058
|
+
variant -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember1 }
|
|
1059
|
+
|
|
1060
|
+
variant -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember2 }
|
|
1061
|
+
|
|
1062
|
+
variant -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember3 }
|
|
1063
|
+
|
|
1064
|
+
class UnionMember0 < Revox::Internal::Type::BaseModel
|
|
1065
|
+
# @!attribute name
|
|
1066
|
+
#
|
|
1067
|
+
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember0::Name]
|
|
1068
|
+
required :name,
|
|
1069
|
+
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember0::Name }
|
|
1070
|
+
|
|
1071
|
+
# @!attribute type
|
|
1072
|
+
#
|
|
1073
|
+
# @return [Symbol, :"dedicated-instance"]
|
|
1074
|
+
required :type, const: :"dedicated-instance"
|
|
1075
|
+
|
|
1076
|
+
# @!method initialize(name:, type: :"dedicated-instance")
|
|
1077
|
+
# @param name [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember0::Name]
|
|
1078
|
+
# @param type [Symbol, :"dedicated-instance"]
|
|
1079
|
+
|
|
1080
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember0#name
|
|
1081
|
+
module Name
|
|
1082
|
+
extend Revox::Internal::Type::Enum
|
|
1083
|
+
|
|
1084
|
+
GPT_4_1 = :"gpt-4.1"
|
|
1085
|
+
MINISTRAL_3_8B_INSTRUCT = :"ministral-3-8b-instruct"
|
|
1086
|
+
|
|
1087
|
+
# @!method self.values
|
|
1088
|
+
# @return [Array<Symbol>]
|
|
1089
|
+
end
|
|
1090
|
+
end
|
|
1091
|
+
|
|
1092
|
+
class UnionMember1 < Revox::Internal::Type::BaseModel
|
|
1093
|
+
# @!attribute openrouter_model_id
|
|
1094
|
+
# The model ID to use from OpenRouter. eg: openai/gpt-4.1
|
|
1095
|
+
#
|
|
1096
|
+
# @return [String]
|
|
1097
|
+
required :openrouter_model_id, String
|
|
1098
|
+
|
|
1099
|
+
# @!attribute openrouter_provider
|
|
1100
|
+
# The provider to use from OpenRouter. eg: nebius, openai, azure, etc.
|
|
1101
|
+
#
|
|
1102
|
+
# @return [String]
|
|
1103
|
+
required :openrouter_provider, String
|
|
1104
|
+
|
|
1105
|
+
# @!attribute type
|
|
1106
|
+
# Use a model from OpenRouter.
|
|
1107
|
+
#
|
|
1108
|
+
# @return [Symbol, :openrouter]
|
|
1109
|
+
required :type, const: :openrouter
|
|
1110
|
+
|
|
1111
|
+
# @!method initialize(openrouter_model_id:, openrouter_provider:, type: :openrouter)
|
|
1112
|
+
# @param openrouter_model_id [String] The model ID to use from OpenRouter. eg: openai/gpt-4.1
|
|
1113
|
+
#
|
|
1114
|
+
# @param openrouter_provider [String] The provider to use from OpenRouter. eg: nebius, openai, azure, etc.
|
|
509
1115
|
#
|
|
510
1116
|
# @param type [Symbol, :openrouter] Use a model from OpenRouter.
|
|
511
1117
|
end
|
|
512
1118
|
|
|
1119
|
+
class UnionMember2 < Revox::Internal::Type::BaseModel
|
|
1120
|
+
# @!attribute api_key
|
|
1121
|
+
# API key sent as Bearer token to the custom endpoint.
|
|
1122
|
+
#
|
|
1123
|
+
# @return [String]
|
|
1124
|
+
required :api_key, String
|
|
1125
|
+
|
|
1126
|
+
# @!attribute api_url
|
|
1127
|
+
# Base URL for the OpenAI-compatible API, e.g. https://api.together.xyz/v1
|
|
1128
|
+
#
|
|
1129
|
+
# @return [String]
|
|
1130
|
+
required :api_url, String
|
|
1131
|
+
|
|
1132
|
+
# @!attribute model_name
|
|
1133
|
+
# Model name as expected by the provider, e.g. meta-llama/llama-3-70b
|
|
1134
|
+
#
|
|
1135
|
+
# @return [String]
|
|
1136
|
+
required :model_name, String
|
|
1137
|
+
|
|
1138
|
+
# @!attribute type
|
|
1139
|
+
# OpenAI-compatible chat completions API (bring your own endpoint and key).
|
|
1140
|
+
#
|
|
1141
|
+
# @return [Symbol, :custom]
|
|
1142
|
+
required :type, const: :custom
|
|
1143
|
+
|
|
1144
|
+
# @!method initialize(api_key:, api_url:, model_name:, type: :custom)
|
|
1145
|
+
# @param api_key [String] API key sent as Bearer token to the custom endpoint.
|
|
1146
|
+
#
|
|
1147
|
+
# @param api_url [String] Base URL for the OpenAI-compatible API, e.g. https://api.together.xyz/v1
|
|
1148
|
+
#
|
|
1149
|
+
# @param model_name [String] Model name as expected by the provider, e.g. meta-llama/llama-3-70b
|
|
1150
|
+
#
|
|
1151
|
+
# @param type [Symbol, :custom] OpenAI-compatible chat completions API (bring your own endpoint and key).
|
|
1152
|
+
end
|
|
1153
|
+
|
|
1154
|
+
class UnionMember3 < Revox::Internal::Type::BaseModel
|
|
1155
|
+
# @!attribute provider
|
|
1156
|
+
# The provider to use from Realtime. eg: openai, google.
|
|
1157
|
+
#
|
|
1158
|
+
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember3::Provider]
|
|
1159
|
+
required :provider,
|
|
1160
|
+
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember3::Provider }
|
|
1161
|
+
|
|
1162
|
+
# @!attribute realtime_model_id
|
|
1163
|
+
# The model ID to use from Realtime. eg: gpt-4.1
|
|
1164
|
+
#
|
|
1165
|
+
# @return [String]
|
|
1166
|
+
required :realtime_model_id, String
|
|
1167
|
+
|
|
1168
|
+
# @!attribute type
|
|
1169
|
+
# Use a model from Realtime.
|
|
1170
|
+
#
|
|
1171
|
+
# @return [Symbol, :realtime]
|
|
1172
|
+
required :type, const: :realtime
|
|
1173
|
+
|
|
1174
|
+
# @!attribute realtime_voice_id
|
|
1175
|
+
# Output voice for the realtime provider (e.g. OpenAI: marin; Gemini: Puck).
|
|
1176
|
+
#
|
|
1177
|
+
# @return [String, nil]
|
|
1178
|
+
optional :realtime_voice_id, String
|
|
1179
|
+
|
|
1180
|
+
# @!method initialize(provider:, realtime_model_id:, realtime_voice_id: nil, type: :realtime)
|
|
1181
|
+
# @param provider [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember3::Provider] The provider to use from Realtime. eg: openai, google.
|
|
1182
|
+
#
|
|
1183
|
+
# @param realtime_model_id [String] The model ID to use from Realtime. eg: gpt-4.1
|
|
1184
|
+
#
|
|
1185
|
+
# @param realtime_voice_id [String] Output voice for the realtime provider (e.g. OpenAI: marin; Gemini: Puck).
|
|
1186
|
+
#
|
|
1187
|
+
# @param type [Symbol, :realtime] Use a model from Realtime.
|
|
1188
|
+
|
|
1189
|
+
# The provider to use from Realtime. eg: openai, google.
|
|
1190
|
+
#
|
|
1191
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember3#provider
|
|
1192
|
+
module Provider
|
|
1193
|
+
extend Revox::Internal::Type::Enum
|
|
1194
|
+
|
|
1195
|
+
OPENAI = :openai
|
|
1196
|
+
GOOGLE = :google
|
|
1197
|
+
|
|
1198
|
+
# @!method self.values
|
|
1199
|
+
# @return [Array<Symbol>]
|
|
1200
|
+
end
|
|
1201
|
+
end
|
|
1202
|
+
|
|
513
1203
|
# @!method self.variants
|
|
514
|
-
# @return [Array(Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember0, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember1)]
|
|
1204
|
+
# @return [Array(Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember0, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember1, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember2, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::LlmModel::UnionMember3)]
|
|
1205
|
+
end
|
|
1206
|
+
|
|
1207
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#position
|
|
1208
|
+
class Position < Revox::Internal::Type::BaseModel
|
|
1209
|
+
# @!attribute x
|
|
1210
|
+
#
|
|
1211
|
+
# @return [Float]
|
|
1212
|
+
required :x, Float
|
|
1213
|
+
|
|
1214
|
+
# @!attribute y_
|
|
1215
|
+
#
|
|
1216
|
+
# @return [Float]
|
|
1217
|
+
required :y_, Float, api_name: :y
|
|
1218
|
+
|
|
1219
|
+
# @!method initialize(x:, y_:)
|
|
1220
|
+
# @param x [Float]
|
|
1221
|
+
# @param y_ [Float]
|
|
1222
|
+
end
|
|
1223
|
+
|
|
1224
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#prompt_flow
|
|
1225
|
+
class PromptFlow < Revox::Internal::Type::BaseModel
|
|
1226
|
+
# @!attribute edges
|
|
1227
|
+
#
|
|
1228
|
+
# @return [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Edge>]
|
|
1229
|
+
required :edges,
|
|
1230
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Edge] }
|
|
1231
|
+
|
|
1232
|
+
# @!attribute nodes
|
|
1233
|
+
#
|
|
1234
|
+
# @return [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Node>]
|
|
1235
|
+
required :nodes,
|
|
1236
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Node] }
|
|
1237
|
+
|
|
1238
|
+
# @!method initialize(edges:, nodes:)
|
|
1239
|
+
# @param edges [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Edge>]
|
|
1240
|
+
# @param nodes [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Node>]
|
|
1241
|
+
|
|
1242
|
+
class Edge < Revox::Internal::Type::BaseModel
|
|
1243
|
+
# @!attribute id
|
|
1244
|
+
#
|
|
1245
|
+
# @return [String]
|
|
1246
|
+
required :id, String
|
|
1247
|
+
|
|
1248
|
+
# @!attribute source
|
|
1249
|
+
#
|
|
1250
|
+
# @return [String]
|
|
1251
|
+
required :source, String
|
|
1252
|
+
|
|
1253
|
+
# @!attribute target
|
|
1254
|
+
#
|
|
1255
|
+
# @return [String]
|
|
1256
|
+
required :target, String
|
|
1257
|
+
|
|
1258
|
+
# @!method initialize(id:, source:, target:)
|
|
1259
|
+
# @param id [String]
|
|
1260
|
+
# @param source [String]
|
|
1261
|
+
# @param target [String]
|
|
1262
|
+
end
|
|
1263
|
+
|
|
1264
|
+
class Node < Revox::Internal::Type::BaseModel
|
|
1265
|
+
# @!attribute id
|
|
1266
|
+
#
|
|
1267
|
+
# @return [String]
|
|
1268
|
+
required :id, String
|
|
1269
|
+
|
|
1270
|
+
# @!attribute data
|
|
1271
|
+
#
|
|
1272
|
+
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Node::Data]
|
|
1273
|
+
required :data,
|
|
1274
|
+
-> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Node::Data }
|
|
1275
|
+
|
|
1276
|
+
# @!attribute position
|
|
1277
|
+
#
|
|
1278
|
+
# @return [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Node::Position]
|
|
1279
|
+
required :position,
|
|
1280
|
+
-> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Node::Position }
|
|
1281
|
+
|
|
1282
|
+
# @!attribute type
|
|
1283
|
+
#
|
|
1284
|
+
# @return [Symbol, :promptBlock]
|
|
1285
|
+
required :type, const: :promptBlock
|
|
1286
|
+
|
|
1287
|
+
# @!method initialize(id:, data:, position:, type: :promptBlock)
|
|
1288
|
+
# @param id [String]
|
|
1289
|
+
# @param data [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Node::Data]
|
|
1290
|
+
# @param position [Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Node::Position]
|
|
1291
|
+
# @param type [Symbol, :promptBlock]
|
|
1292
|
+
|
|
1293
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Node#data
|
|
1294
|
+
class Data < Revox::Internal::Type::BaseModel
|
|
1295
|
+
# @!attribute body
|
|
1296
|
+
#
|
|
1297
|
+
# @return [String]
|
|
1298
|
+
required :body, String
|
|
1299
|
+
|
|
1300
|
+
# @!attribute title
|
|
1301
|
+
#
|
|
1302
|
+
# @return [String]
|
|
1303
|
+
required :title, String
|
|
1304
|
+
|
|
1305
|
+
# @!method initialize(body:, title:)
|
|
1306
|
+
# @param body [String]
|
|
1307
|
+
# @param title [String]
|
|
1308
|
+
end
|
|
1309
|
+
|
|
1310
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::PromptFlow::Node#position
|
|
1311
|
+
class Position < Revox::Internal::Type::BaseModel
|
|
1312
|
+
# @!attribute x
|
|
1313
|
+
#
|
|
1314
|
+
# @return [Float]
|
|
1315
|
+
required :x, Float
|
|
1316
|
+
|
|
1317
|
+
# @!attribute y_
|
|
1318
|
+
#
|
|
1319
|
+
# @return [Float]
|
|
1320
|
+
required :y_, Float, api_name: :y
|
|
1321
|
+
|
|
1322
|
+
# @!method initialize(x:, y_:)
|
|
1323
|
+
# @param x [Float]
|
|
1324
|
+
# @param y_ [Float]
|
|
1325
|
+
end
|
|
1326
|
+
end
|
|
1327
|
+
end
|
|
1328
|
+
|
|
1329
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#slack
|
|
1330
|
+
class Slack < Revox::Internal::Type::BaseModel
|
|
1331
|
+
# @!attribute channel_id
|
|
1332
|
+
# The Slack channel ID where the notification will be posted.
|
|
1333
|
+
#
|
|
1334
|
+
# @return [String]
|
|
1335
|
+
required :channel_id, String
|
|
1336
|
+
|
|
1337
|
+
# @!attribute connection_id
|
|
1338
|
+
# The Nango connection ID linking the org's Slack workspace to Revox.
|
|
1339
|
+
#
|
|
1340
|
+
# @return [String]
|
|
1341
|
+
required :connection_id, String
|
|
1342
|
+
|
|
1343
|
+
# @!attribute outcomes
|
|
1344
|
+
# Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']).
|
|
1345
|
+
# Use 'none' to notify when outcome is null.
|
|
1346
|
+
#
|
|
1347
|
+
# @return [Array<Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack::Outcome>]
|
|
1348
|
+
required :outcomes,
|
|
1349
|
+
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack::Outcome] }
|
|
1350
|
+
|
|
1351
|
+
# @!attribute channel_name
|
|
1352
|
+
# Human-readable Slack channel name, cached for display in the UI.
|
|
1353
|
+
#
|
|
1354
|
+
# @return [String, nil]
|
|
1355
|
+
optional :channel_name, String, nil?: true
|
|
1356
|
+
|
|
1357
|
+
# @!attribute template
|
|
1358
|
+
# Optional message template. Supports {{summary}}, {{outcome}}, {{phone}},
|
|
1359
|
+
# {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{first_name}},
|
|
1360
|
+
# {{last_name}}, {{email}}, {{company}}, {{contact_name}}, {{contact_line}}, plus
|
|
1361
|
+
# prompt_variables and structured_output keys. When null/empty a default template
|
|
1362
|
+
# is used.
|
|
1363
|
+
#
|
|
1364
|
+
# @return [String, nil]
|
|
1365
|
+
optional :template, String, nil?: true
|
|
1366
|
+
|
|
1367
|
+
# @!method initialize(channel_id:, connection_id:, outcomes:, channel_name: nil, template: nil)
|
|
1368
|
+
# Some parameter documentations has been truncated, see
|
|
1369
|
+
# {Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack} for more
|
|
1370
|
+
# details.
|
|
1371
|
+
#
|
|
1372
|
+
# @param channel_id [String] The Slack channel ID where the notification will be posted.
|
|
1373
|
+
#
|
|
1374
|
+
# @param connection_id [String] The Nango connection ID linking the org's Slack workspace to Revox.
|
|
1375
|
+
#
|
|
1376
|
+
# @param outcomes [Array<Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack::Outcome>] Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']).
|
|
1377
|
+
#
|
|
1378
|
+
# @param channel_name [String, nil] Human-readable Slack channel name, cached for display in the UI.
|
|
1379
|
+
#
|
|
1380
|
+
# @param template [String, nil] Optional message template. Supports {{summary}}, {{outcome}}, {{phone}},
|
|
1381
|
+
# {{call\_
|
|
1382
|
+
|
|
1383
|
+
module Outcome
|
|
1384
|
+
extend Revox::Internal::Type::Enum
|
|
1385
|
+
|
|
1386
|
+
NOT_INTERESTED = :not_interested
|
|
1387
|
+
INTERESTED = :interested
|
|
1388
|
+
COMPLETED = :completed
|
|
1389
|
+
REQUESTED_CALLBACK_LATER = :requested_callback_later
|
|
1390
|
+
REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
|
|
1391
|
+
DO_NOT_CONTACT = :do_not_contact
|
|
1392
|
+
AI_AVERSE = :ai_averse
|
|
1393
|
+
NONE = :none
|
|
1394
|
+
|
|
1395
|
+
# @!method self.values
|
|
1396
|
+
# @return [Array<Symbol>]
|
|
1397
|
+
end
|
|
515
1398
|
end
|
|
516
1399
|
|
|
517
1400
|
class StructuredOutputConfig < Revox::Internal::Type::BaseModel
|
|
@@ -564,6 +1447,88 @@ module Revox
|
|
|
564
1447
|
end
|
|
565
1448
|
end
|
|
566
1449
|
|
|
1450
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#stt_context
|
|
1451
|
+
class SttContext < Revox::Internal::Type::BaseModel
|
|
1452
|
+
# @!attribute general
|
|
1453
|
+
#
|
|
1454
|
+
# @return [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::SttContext::General>]
|
|
1455
|
+
required :general,
|
|
1456
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::SttContext::General] }
|
|
1457
|
+
|
|
1458
|
+
# @!attribute terms
|
|
1459
|
+
#
|
|
1460
|
+
# @return [Array<String>]
|
|
1461
|
+
required :terms, Revox::Internal::Type::ArrayOf[String]
|
|
1462
|
+
|
|
1463
|
+
# @!method initialize(general:, terms:)
|
|
1464
|
+
# Assistant-level speech-to-text context: structured `general` key/value pairs
|
|
1465
|
+
# plus a list of domain `terms`. Prompt-derived context is merged in without
|
|
1466
|
+
# replacing existing entries.
|
|
1467
|
+
#
|
|
1468
|
+
# @param general [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::SttContext::General>]
|
|
1469
|
+
# @param terms [Array<String>]
|
|
1470
|
+
|
|
1471
|
+
class General < Revox::Internal::Type::BaseModel
|
|
1472
|
+
# @!attribute key
|
|
1473
|
+
#
|
|
1474
|
+
# @return [String]
|
|
1475
|
+
required :key, String
|
|
1476
|
+
|
|
1477
|
+
# @!attribute value
|
|
1478
|
+
#
|
|
1479
|
+
# @return [String]
|
|
1480
|
+
required :value, String
|
|
1481
|
+
|
|
1482
|
+
# @!method initialize(key:, value:)
|
|
1483
|
+
# @param key [String]
|
|
1484
|
+
# @param value [String]
|
|
1485
|
+
end
|
|
1486
|
+
end
|
|
1487
|
+
|
|
1488
|
+
# Transcriber (speech-to-text) model used for the assistant.
|
|
1489
|
+
#
|
|
1490
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#stt_model
|
|
1491
|
+
module SttModel
|
|
1492
|
+
extend Revox::Internal::Type::Enum
|
|
1493
|
+
|
|
1494
|
+
STT_RT_V4 = :"stt-rt-v4"
|
|
1495
|
+
STT_RT_V5 = :"stt-rt-v5"
|
|
1496
|
+
|
|
1497
|
+
# @!method self.values
|
|
1498
|
+
# @return [Array<Symbol>]
|
|
1499
|
+
end
|
|
1500
|
+
|
|
1501
|
+
# Audio clip to play while the agent is processing a response. One of the built-in
|
|
1502
|
+
# LiveKit audio clips; null disables it.
|
|
1503
|
+
#
|
|
1504
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#thinking_sound
|
|
1505
|
+
module ThinkingSound
|
|
1506
|
+
extend Revox::Internal::Type::Enum
|
|
1507
|
+
|
|
1508
|
+
CITY_AMBIENCE_OGG = :"city-ambience.ogg"
|
|
1509
|
+
FOREST_AMBIENCE_OGG = :"forest-ambience.ogg"
|
|
1510
|
+
OFFICE_AMBIENCE_OGG = :"office-ambience.ogg"
|
|
1511
|
+
CROWDED_ROOM_OGG = :"crowded-room.ogg"
|
|
1512
|
+
KEYBOARD_TYPING_OGG = :"keyboard-typing.ogg"
|
|
1513
|
+
KEYBOARD_TYPING2_OGG = :"keyboard-typing2.ogg"
|
|
1514
|
+
HOLD_MUSIC_OGG = :"hold_music.ogg"
|
|
1515
|
+
|
|
1516
|
+
# @!method self.values
|
|
1517
|
+
# @return [Array<Symbol>]
|
|
1518
|
+
end
|
|
1519
|
+
|
|
1520
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#type
|
|
1521
|
+
module Type
|
|
1522
|
+
extend Revox::Internal::Type::Enum
|
|
1523
|
+
|
|
1524
|
+
STANDALONE = :standalone
|
|
1525
|
+
MULTI_STEP = :"multi-step"
|
|
1526
|
+
SUB_ASSISTANT = :"sub-assistant"
|
|
1527
|
+
|
|
1528
|
+
# @!method self.values
|
|
1529
|
+
# @return [Array<Symbol>]
|
|
1530
|
+
end
|
|
1531
|
+
|
|
567
1532
|
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#voice
|
|
568
1533
|
class Voice < Revox::Internal::Type::BaseModel
|
|
569
1534
|
# @!attribute id
|
|
@@ -579,6 +1544,13 @@ module Revox
|
|
|
579
1544
|
required :provider,
|
|
580
1545
|
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Voice::Provider }
|
|
581
1546
|
|
|
1547
|
+
# @!attribute model
|
|
1548
|
+
# Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored
|
|
1549
|
+
# for other providers.
|
|
1550
|
+
#
|
|
1551
|
+
# @return [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Voice::Model, nil]
|
|
1552
|
+
optional :model, enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Voice::Model }
|
|
1553
|
+
|
|
582
1554
|
# @!attribute speed
|
|
583
1555
|
# The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs
|
|
584
1556
|
# 0.7–1.2. Default is 1.0.
|
|
@@ -586,7 +1558,14 @@ module Revox
|
|
|
586
1558
|
# @return [Float, nil]
|
|
587
1559
|
optional :speed, Float
|
|
588
1560
|
|
|
589
|
-
# @!
|
|
1561
|
+
# @!attribute volume
|
|
1562
|
+
# Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other
|
|
1563
|
+
# providers.
|
|
1564
|
+
#
|
|
1565
|
+
# @return [Float, nil]
|
|
1566
|
+
optional :volume, Float
|
|
1567
|
+
|
|
1568
|
+
# @!method initialize(id:, provider:, model: nil, speed: nil, volume: nil)
|
|
590
1569
|
# Some parameter documentations has been truncated, see
|
|
591
1570
|
# {Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Voice} for more
|
|
592
1571
|
# details.
|
|
@@ -595,7 +1574,11 @@ module Revox
|
|
|
595
1574
|
#
|
|
596
1575
|
# @param provider [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Voice::Provider] The provider of the voice.
|
|
597
1576
|
#
|
|
1577
|
+
# @param model [Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Voice::Model] Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored fo
|
|
1578
|
+
#
|
|
598
1579
|
# @param speed [Float] The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs
|
|
1580
|
+
#
|
|
1581
|
+
# @param volume [Float] Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other pro
|
|
599
1582
|
|
|
600
1583
|
# The provider of the voice.
|
|
601
1584
|
#
|
|
@@ -609,6 +1592,160 @@ module Revox
|
|
|
609
1592
|
# @!method self.values
|
|
610
1593
|
# @return [Array<Symbol>]
|
|
611
1594
|
end
|
|
1595
|
+
|
|
1596
|
+
# Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored
|
|
1597
|
+
# for other providers.
|
|
1598
|
+
#
|
|
1599
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Voice#model
|
|
1600
|
+
module Model
|
|
1601
|
+
extend Revox::Internal::Type::Enum
|
|
1602
|
+
|
|
1603
|
+
SONIC_3 = :"sonic-3"
|
|
1604
|
+
SONIC_3_5 = :"sonic-3.5"
|
|
1605
|
+
|
|
1606
|
+
# @!method self.values
|
|
1607
|
+
# @return [Array<Symbol>]
|
|
1608
|
+
end
|
|
1609
|
+
end
|
|
1610
|
+
|
|
1611
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#zoho
|
|
1612
|
+
class Zoho < Revox::Internal::Type::BaseModel
|
|
1613
|
+
# @!attribute connection_id
|
|
1614
|
+
# The Nango connection ID linking the org's Zoho CRM account to Revox.
|
|
1615
|
+
#
|
|
1616
|
+
# @return [String]
|
|
1617
|
+
required :connection_id, String
|
|
1618
|
+
|
|
1619
|
+
# @!attribute field_mapping
|
|
1620
|
+
# Maps extracted call fields (structured_output / prompt variables) onto Zoho
|
|
1621
|
+
# field API names on the upserted record.
|
|
1622
|
+
#
|
|
1623
|
+
# @return [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Zoho::FieldMapping>]
|
|
1624
|
+
required :field_mapping,
|
|
1625
|
+
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Zoho::FieldMapping] }
|
|
1626
|
+
|
|
1627
|
+
# @!attribute log_call_activity
|
|
1628
|
+
# When true, also log the call as a record in Zoho's Calls module (related to the
|
|
1629
|
+
# upserted prospect via Who_Id).
|
|
1630
|
+
#
|
|
1631
|
+
# @return [Boolean]
|
|
1632
|
+
required :log_call_activity, Revox::Internal::Type::Boolean
|
|
1633
|
+
|
|
1634
|
+
# @!attribute module_
|
|
1635
|
+
# Zoho module the prospect record is upserted into (e.g. 'Leads' or 'Contacts').
|
|
1636
|
+
#
|
|
1637
|
+
# @return [String]
|
|
1638
|
+
required :module_, String, api_name: :module
|
|
1639
|
+
|
|
1640
|
+
# @!attribute outcomes
|
|
1641
|
+
# Which call outcomes trigger the Zoho push (e.g. ['interested', 'none']). Use
|
|
1642
|
+
# 'none' to push when outcome is null.
|
|
1643
|
+
#
|
|
1644
|
+
# @return [Array<Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Zoho::Outcome>]
|
|
1645
|
+
required :outcomes,
|
|
1646
|
+
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Zoho::Outcome] }
|
|
1647
|
+
|
|
1648
|
+
# @!attribute template
|
|
1649
|
+
# Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}},
|
|
1650
|
+
# {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{transcript}}, plus
|
|
1651
|
+
# prompt_variables and structured_output keys. When null/empty a default note
|
|
1652
|
+
# (outcome + summary + auto-listed extracted fields) is used.
|
|
1653
|
+
#
|
|
1654
|
+
# @return [String, nil]
|
|
1655
|
+
optional :template, String, nil?: true
|
|
1656
|
+
|
|
1657
|
+
# @!method initialize(connection_id:, field_mapping:, log_call_activity:, module_:, outcomes:, template: nil)
|
|
1658
|
+
# Some parameter documentations has been truncated, see
|
|
1659
|
+
# {Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Zoho} for more
|
|
1660
|
+
# details.
|
|
1661
|
+
#
|
|
1662
|
+
# @param connection_id [String] The Nango connection ID linking the org's Zoho CRM account to Revox.
|
|
1663
|
+
#
|
|
1664
|
+
# @param field_mapping [Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Zoho::FieldMapping>] Maps extracted call fields (structured_output / prompt variables) onto Zoho fiel
|
|
1665
|
+
#
|
|
1666
|
+
# @param log_call_activity [Boolean] When true, also log the call as a record in Zoho's Calls module (related to the
|
|
1667
|
+
#
|
|
1668
|
+
# @param module_ [String] Zoho module the prospect record is upserted into (e.g. 'Leads' or 'Contacts').
|
|
1669
|
+
#
|
|
1670
|
+
# @param outcomes [Array<Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Zoho::Outcome>] Which call outcomes trigger the Zoho push (e.g. ['interested', 'none']). Use 'no
|
|
1671
|
+
#
|
|
1672
|
+
# @param template [String, nil] Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}}, {{cal
|
|
1673
|
+
|
|
1674
|
+
class FieldMapping < Revox::Internal::Type::BaseModel
|
|
1675
|
+
# @!attribute source
|
|
1676
|
+
# Source key to read from the call: a structured_output field name, falling back
|
|
1677
|
+
# to a prompt variable of the same name.
|
|
1678
|
+
#
|
|
1679
|
+
# @return [String]
|
|
1680
|
+
required :source, String
|
|
1681
|
+
|
|
1682
|
+
# @!attribute zoho_field
|
|
1683
|
+
# Destination Zoho field API name on the upserted record (e.g. 'Email', 'Company',
|
|
1684
|
+
# or a custom 'Budget\_\_c').
|
|
1685
|
+
#
|
|
1686
|
+
# @return [String]
|
|
1687
|
+
required :zoho_field, String
|
|
1688
|
+
|
|
1689
|
+
# @!method initialize(source:, zoho_field:)
|
|
1690
|
+
# Some parameter documentations has been truncated, see
|
|
1691
|
+
# {Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Zoho::FieldMapping}
|
|
1692
|
+
# for more details.
|
|
1693
|
+
#
|
|
1694
|
+
# @param source [String] Source key to read from the call: a structured_output field name, falling back t
|
|
1695
|
+
#
|
|
1696
|
+
# @param zoho_field [String] Destination Zoho field API name on the upserted record (e.g. 'Email', 'Company',
|
|
1697
|
+
end
|
|
1698
|
+
|
|
1699
|
+
module Outcome
|
|
1700
|
+
extend Revox::Internal::Type::Enum
|
|
1701
|
+
|
|
1702
|
+
NOT_INTERESTED = :not_interested
|
|
1703
|
+
INTERESTED = :interested
|
|
1704
|
+
COMPLETED = :completed
|
|
1705
|
+
REQUESTED_CALLBACK_LATER = :requested_callback_later
|
|
1706
|
+
REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
|
|
1707
|
+
DO_NOT_CONTACT = :do_not_contact
|
|
1708
|
+
AI_AVERSE = :ai_averse
|
|
1709
|
+
NONE = :none
|
|
1710
|
+
|
|
1711
|
+
# @!method self.values
|
|
1712
|
+
# @return [Array<Symbol>]
|
|
1713
|
+
end
|
|
1714
|
+
end
|
|
1715
|
+
|
|
1716
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant#created_by
|
|
1717
|
+
class CreatedBy < Revox::Internal::Type::BaseModel
|
|
1718
|
+
# @!attribute id
|
|
1719
|
+
# The database user id of the creator.
|
|
1720
|
+
#
|
|
1721
|
+
# @return [String]
|
|
1722
|
+
required :id, String
|
|
1723
|
+
|
|
1724
|
+
# @!attribute email
|
|
1725
|
+
#
|
|
1726
|
+
# @return [String]
|
|
1727
|
+
required :email, String
|
|
1728
|
+
|
|
1729
|
+
# @!attribute first_name
|
|
1730
|
+
#
|
|
1731
|
+
# @return [String, nil]
|
|
1732
|
+
required :first_name, String, nil?: true
|
|
1733
|
+
|
|
1734
|
+
# @!attribute last_name
|
|
1735
|
+
#
|
|
1736
|
+
# @return [String, nil]
|
|
1737
|
+
required :last_name, String, nil?: true
|
|
1738
|
+
|
|
1739
|
+
# @!method initialize(id:, email:, first_name:, last_name:)
|
|
1740
|
+
# The user who created the assistant.
|
|
1741
|
+
#
|
|
1742
|
+
# @param id [String] The database user id of the creator.
|
|
1743
|
+
#
|
|
1744
|
+
# @param email [String]
|
|
1745
|
+
#
|
|
1746
|
+
# @param first_name [String, nil]
|
|
1747
|
+
#
|
|
1748
|
+
# @param last_name [String, nil]
|
|
612
1749
|
end
|
|
613
1750
|
|
|
614
1751
|
class FaqItem < Revox::Internal::Type::BaseModel
|
|
@@ -660,6 +1797,23 @@ module Revox
|
|
|
660
1797
|
|
|
661
1798
|
# @see Revox::Models::CampaignRetrieveResponse::Campaign#call_retry_config
|
|
662
1799
|
class CallRetryConfig < Revox::Internal::Type::BaseModel
|
|
1800
|
+
# @!attribute allowed_days
|
|
1801
|
+
# Days of the week when calls are allowed, in the recipient's timezone. Default:
|
|
1802
|
+
# Monday through Friday.
|
|
1803
|
+
#
|
|
1804
|
+
# @return [Array<Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::CallRetryConfig::AllowedDay>]
|
|
1805
|
+
required :allowed_days,
|
|
1806
|
+
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::CampaignRetrieveResponse::Campaign::CallRetryConfig::AllowedDay] }
|
|
1807
|
+
|
|
1808
|
+
# @!attribute call_twice_in_a_row
|
|
1809
|
+
# If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping
|
|
1810
|
+
# retry_delay_seconds) when attempt #1 didn't reach a human.
|
|
1811
|
+
# Calling-window/allowed-days checks still apply. Only affects the 1→2 transition.
|
|
1812
|
+
# Default: false.
|
|
1813
|
+
#
|
|
1814
|
+
# @return [Boolean]
|
|
1815
|
+
required :call_twice_in_a_row, Revox::Internal::Type::Boolean
|
|
1816
|
+
|
|
663
1817
|
# @!attribute calling_windows
|
|
664
1818
|
#
|
|
665
1819
|
# @return [Array<Revox::Models::CampaignRetrieveResponse::Campaign::CallRetryConfig::CallingWindow>]
|
|
@@ -680,7 +1834,7 @@ module Revox
|
|
|
680
1834
|
# @return [String, nil]
|
|
681
1835
|
optional :timezone, String, nil?: true
|
|
682
1836
|
|
|
683
|
-
# @!method initialize(calling_windows:, max_retry_attempts:, timezone: nil)
|
|
1837
|
+
# @!method initialize(allowed_days:, call_twice_in_a_row:, calling_windows:, max_retry_attempts:, timezone: nil)
|
|
684
1838
|
# Some parameter documentations has been truncated, see
|
|
685
1839
|
# {Revox::Models::CampaignRetrieveResponse::Campaign::CallRetryConfig} for more
|
|
686
1840
|
# details.
|
|
@@ -688,12 +1842,31 @@ module Revox
|
|
|
688
1842
|
# Configuration for call retry behavior including time windows, delays, and max
|
|
689
1843
|
# iterations. If not provided, defaults will be used.
|
|
690
1844
|
#
|
|
1845
|
+
# @param allowed_days [Array<Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::CallRetryConfig::AllowedDay>] Days of the week when calls are allowed, in the recipient's timezone. Default: M
|
|
1846
|
+
#
|
|
1847
|
+
# @param call_twice_in_a_row [Boolean] If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retr
|
|
1848
|
+
#
|
|
691
1849
|
# @param calling_windows [Array<Revox::Models::CampaignRetrieveResponse::Campaign::CallRetryConfig::CallingWindow>]
|
|
692
1850
|
#
|
|
693
1851
|
# @param max_retry_attempts [Integer] Maximum number of call retry attempts. Default: 3.
|
|
694
1852
|
#
|
|
695
1853
|
# @param timezone [String, nil] Optional IANA timezone identifier to override the automatic timezone detection f
|
|
696
1854
|
|
|
1855
|
+
module AllowedDay
|
|
1856
|
+
extend Revox::Internal::Type::Enum
|
|
1857
|
+
|
|
1858
|
+
MONDAY = :monday
|
|
1859
|
+
TUESDAY = :tuesday
|
|
1860
|
+
WEDNESDAY = :wednesday
|
|
1861
|
+
THURSDAY = :thursday
|
|
1862
|
+
FRIDAY = :friday
|
|
1863
|
+
SATURDAY = :saturday
|
|
1864
|
+
SUNDAY = :sunday
|
|
1865
|
+
|
|
1866
|
+
# @!method self.values
|
|
1867
|
+
# @return [Array<Symbol>]
|
|
1868
|
+
end
|
|
1869
|
+
|
|
697
1870
|
class CallingWindow < Revox::Internal::Type::BaseModel
|
|
698
1871
|
# @!attribute calling_window_end_time
|
|
699
1872
|
# End time for the calling window in the recipient's timezone (or
|
|
@@ -730,6 +1903,75 @@ module Revox
|
|
|
730
1903
|
end
|
|
731
1904
|
end
|
|
732
1905
|
|
|
1906
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign#created_by
|
|
1907
|
+
class CreatedBy < Revox::Internal::Type::BaseModel
|
|
1908
|
+
# @!attribute id
|
|
1909
|
+
# The database user id (foreign key target on calls.assignee_id).
|
|
1910
|
+
#
|
|
1911
|
+
# @return [String]
|
|
1912
|
+
required :id, String
|
|
1913
|
+
|
|
1914
|
+
# @!attribute email
|
|
1915
|
+
#
|
|
1916
|
+
# @return [String]
|
|
1917
|
+
required :email, String
|
|
1918
|
+
|
|
1919
|
+
# @!attribute first_name
|
|
1920
|
+
#
|
|
1921
|
+
# @return [String, nil]
|
|
1922
|
+
required :first_name, String, nil?: true
|
|
1923
|
+
|
|
1924
|
+
# @!attribute last_name
|
|
1925
|
+
#
|
|
1926
|
+
# @return [String, nil]
|
|
1927
|
+
required :last_name, String, nil?: true
|
|
1928
|
+
|
|
1929
|
+
# @!method initialize(id:, email:, first_name:, last_name:)
|
|
1930
|
+
# A member of the current organization.
|
|
1931
|
+
#
|
|
1932
|
+
# @param id [String] The database user id (foreign key target on calls.assignee_id).
|
|
1933
|
+
#
|
|
1934
|
+
# @param email [String]
|
|
1935
|
+
#
|
|
1936
|
+
# @param first_name [String, nil]
|
|
1937
|
+
#
|
|
1938
|
+
# @param last_name [String, nil]
|
|
1939
|
+
end
|
|
1940
|
+
|
|
1941
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign#funnel_stats
|
|
1942
|
+
class FunnelStats < Revox::Internal::Type::BaseModel
|
|
1943
|
+
# @!attribute hot
|
|
1944
|
+
#
|
|
1945
|
+
# @return [Float]
|
|
1946
|
+
required :hot, Float
|
|
1947
|
+
|
|
1948
|
+
# @!attribute talked_to_human
|
|
1949
|
+
#
|
|
1950
|
+
# @return [Float]
|
|
1951
|
+
required :talked_to_human, Float
|
|
1952
|
+
|
|
1953
|
+
# @!attribute total_leads
|
|
1954
|
+
#
|
|
1955
|
+
# @return [Float]
|
|
1956
|
+
required :total_leads, Float
|
|
1957
|
+
|
|
1958
|
+
# @!method initialize(hot:, talked_to_human:, total_leads:)
|
|
1959
|
+
# @param hot [Float]
|
|
1960
|
+
# @param talked_to_human [Float]
|
|
1961
|
+
# @param total_leads [Float]
|
|
1962
|
+
end
|
|
1963
|
+
|
|
1964
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign#paused_reason
|
|
1965
|
+
module PausedReason
|
|
1966
|
+
extend Revox::Internal::Type::Enum
|
|
1967
|
+
|
|
1968
|
+
MANUAL = :manual
|
|
1969
|
+
NO_PRESENCE = :no_presence
|
|
1970
|
+
|
|
1971
|
+
# @!method self.values
|
|
1972
|
+
# @return [Array<Symbol>]
|
|
1973
|
+
end
|
|
1974
|
+
|
|
733
1975
|
# @see Revox::Models::CampaignRetrieveResponse::Campaign#row_stats
|
|
734
1976
|
class RowStats < Revox::Internal::Type::BaseModel
|
|
735
1977
|
# @!attribute calling
|
|
@@ -770,6 +2012,20 @@ module Revox
|
|
|
770
2012
|
# @param retry_ [Float]
|
|
771
2013
|
# @param total [Float]
|
|
772
2014
|
end
|
|
2015
|
+
|
|
2016
|
+
# The status of the structured output extraction.
|
|
2017
|
+
#
|
|
2018
|
+
# @see Revox::Models::CampaignRetrieveResponse::Campaign#structured_output_extraction
|
|
2019
|
+
module StructuredOutputExtraction
|
|
2020
|
+
extend Revox::Internal::Type::Enum
|
|
2021
|
+
|
|
2022
|
+
NONE = :none
|
|
2023
|
+
RUNNING = :running
|
|
2024
|
+
COMPLETED = :completed
|
|
2025
|
+
|
|
2026
|
+
# @!method self.values
|
|
2027
|
+
# @return [Array<Symbol>]
|
|
2028
|
+
end
|
|
773
2029
|
end
|
|
774
2030
|
end
|
|
775
2031
|
end
|