telnyx 5.83.0 → 5.84.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 +13 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/voice_settings.rb +5 -1
- data/lib/telnyx/models/call_hold_webhook_event.rb +147 -0
- data/lib/telnyx/models/call_unhold_webhook_event.rb +147 -0
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +5 -1
- data/lib/telnyx/models/unwrap_webhook_event.rb +5 -1
- data/lib/telnyx/models.rb +4 -0
- data/lib/telnyx/resources/calls/actions.rb +1 -0
- data/lib/telnyx/resources/calls.rb +1 -0
- data/lib/telnyx/resources/webhooks.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +2 -0
- data/rbi/telnyx/models/ai/voice_settings.rbi +10 -2
- data/rbi/telnyx/models/call_hold_webhook_event.rbi +297 -0
- data/rbi/telnyx/models/call_unhold_webhook_event.rbi +304 -0
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +2 -0
- data/rbi/telnyx/models/unwrap_webhook_event.rbi +2 -0
- data/rbi/telnyx/models.rbi +4 -0
- data/rbi/telnyx/resources/calls/actions.rbi +1 -0
- data/rbi/telnyx/resources/calls.rbi +1 -0
- data/rbi/telnyx/resources/webhooks.rbi +4 -0
- data/sig/telnyx/models/call_hold_webhook_event.rbs +151 -0
- data/sig/telnyx/models/call_unhold_webhook_event.rbs +152 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +2 -0
- data/sig/telnyx/models/unwrap_webhook_event.rbs +2 -0
- data/sig/telnyx/models.rbs +4 -0
- data/sig/telnyx/resources/webhooks.rbs +4 -0
- metadata +8 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz: '
|
|
3
|
+
metadata.gz: 93f033c0af93b2ca2defc0d2de7d6354ce841a8a3aa9c2eb6fbc49301a65a159
|
|
4
|
+
data.tar.gz: '0029f02da8b9f2e0c2e92b356c77cabdca92b5afc75e7e9ba11ca8bcab13b39d'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a237debb471c155835ea0f46045d9a86c5052c3844bf7cac17cbcefd6f814e4c815b0e6b3fca3b239c11236be1ed35c0244564a4a366d2ea2bba602f71c99111
|
|
7
|
+
data.tar.gz: a0ef70271ffc0b4c66b48445e98ab7df7a9f3b3f99db41a2a8c3189f20c1e869b035d631bed892835543c58e249ca28e6a4f675ea9c1b86cbca1cac29e84109b
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 5.84.0 (2026-04-24)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v5.83.0...v5.84.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.83.0...v5.84.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* Add call.hold and call.unhold webhook event documentation ([7dbc6b0](https://github.com/team-telnyx/telnyx-ruby/commit/7dbc6b099b5193a72a0faadbbfc6cd7e87ea34eb))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Documentation
|
|
13
|
+
|
|
14
|
+
* document dynamic variable support for voice_settings.voice ([b72a45a](https://github.com/team-telnyx/telnyx-ruby/commit/b72a45a9d7eb19fbbe2138f6dd1cf623256066aa))
|
|
15
|
+
|
|
3
16
|
## 5.83.0 (2026-04-23)
|
|
4
17
|
|
|
5
18
|
Full Changelog: [v5.82.0...v5.83.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.82.0...v5.83.0)
|
data/README.md
CHANGED
|
@@ -11,7 +11,11 @@ module Telnyx
|
|
|
11
11
|
# key as an integration secret under the `api_key_ref` field. See
|
|
12
12
|
# [integration secrets documentation](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
|
|
13
13
|
# for details. For Telnyx voices, use `Telnyx.<model_id>.<voice_id>` (e.g.
|
|
14
|
-
# Telnyx.KokoroTTS.af_heart)
|
|
14
|
+
# Telnyx.KokoroTTS.af_heart). The voice portion of the identifier supports
|
|
15
|
+
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
16
|
+
# using mustache syntax (e.g. `Telnyx.Ultra.{{voice_id}}`). The variable is
|
|
17
|
+
# resolved at call time from your dynamic variables webhook, allowing you to
|
|
18
|
+
# select the voice dynamically per call.
|
|
15
19
|
#
|
|
16
20
|
# @return [String]
|
|
17
21
|
required :voice, String
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class CallHoldWebhookEvent < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute data
|
|
7
|
+
#
|
|
8
|
+
# @return [Telnyx::Models::CallHoldWebhookEvent::Data, nil]
|
|
9
|
+
optional :data, -> { Telnyx::CallHoldWebhookEvent::Data }
|
|
10
|
+
|
|
11
|
+
# @!method initialize(data: nil)
|
|
12
|
+
# @param data [Telnyx::Models::CallHoldWebhookEvent::Data]
|
|
13
|
+
|
|
14
|
+
# @see Telnyx::Models::CallHoldWebhookEvent#data
|
|
15
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
16
|
+
# @!attribute id
|
|
17
|
+
# Identifies the type of resource.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :id, String
|
|
21
|
+
|
|
22
|
+
# @!attribute event_type
|
|
23
|
+
# The type of event being delivered.
|
|
24
|
+
#
|
|
25
|
+
# @return [Symbol, Telnyx::Models::CallHoldWebhookEvent::Data::EventType, nil]
|
|
26
|
+
optional :event_type, enum: -> { Telnyx::CallHoldWebhookEvent::Data::EventType }
|
|
27
|
+
|
|
28
|
+
# @!attribute occurred_at
|
|
29
|
+
# ISO 8601 datetime of when the event occurred.
|
|
30
|
+
#
|
|
31
|
+
# @return [Time, nil]
|
|
32
|
+
optional :occurred_at, Time
|
|
33
|
+
|
|
34
|
+
# @!attribute payload
|
|
35
|
+
#
|
|
36
|
+
# @return [Telnyx::Models::CallHoldWebhookEvent::Data::Payload, nil]
|
|
37
|
+
optional :payload, -> { Telnyx::CallHoldWebhookEvent::Data::Payload }
|
|
38
|
+
|
|
39
|
+
# @!attribute record_type
|
|
40
|
+
# Identifies the type of the resource.
|
|
41
|
+
#
|
|
42
|
+
# @return [Symbol, Telnyx::Models::CallHoldWebhookEvent::Data::RecordType, nil]
|
|
43
|
+
optional :record_type, enum: -> { Telnyx::CallHoldWebhookEvent::Data::RecordType }
|
|
44
|
+
|
|
45
|
+
# @!method initialize(id: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
|
|
46
|
+
# @param id [String] Identifies the type of resource.
|
|
47
|
+
#
|
|
48
|
+
# @param event_type [Symbol, Telnyx::Models::CallHoldWebhookEvent::Data::EventType] The type of event being delivered.
|
|
49
|
+
#
|
|
50
|
+
# @param occurred_at [Time] ISO 8601 datetime of when the event occurred.
|
|
51
|
+
#
|
|
52
|
+
# @param payload [Telnyx::Models::CallHoldWebhookEvent::Data::Payload]
|
|
53
|
+
#
|
|
54
|
+
# @param record_type [Symbol, Telnyx::Models::CallHoldWebhookEvent::Data::RecordType] Identifies the type of the resource.
|
|
55
|
+
|
|
56
|
+
# The type of event being delivered.
|
|
57
|
+
#
|
|
58
|
+
# @see Telnyx::Models::CallHoldWebhookEvent::Data#event_type
|
|
59
|
+
module EventType
|
|
60
|
+
extend Telnyx::Internal::Type::Enum
|
|
61
|
+
|
|
62
|
+
CALL_HOLD = :"call.hold"
|
|
63
|
+
|
|
64
|
+
# @!method self.values
|
|
65
|
+
# @return [Array<Symbol>]
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
# @see Telnyx::Models::CallHoldWebhookEvent::Data#payload
|
|
69
|
+
class Payload < Telnyx::Internal::Type::BaseModel
|
|
70
|
+
# @!attribute call_control_id
|
|
71
|
+
# Call ID used to issue commands via Call Control API.
|
|
72
|
+
#
|
|
73
|
+
# @return [String, nil]
|
|
74
|
+
optional :call_control_id, String
|
|
75
|
+
|
|
76
|
+
# @!attribute call_leg_id
|
|
77
|
+
# ID that is unique to the call and can be used to correlate webhook events.
|
|
78
|
+
#
|
|
79
|
+
# @return [String, nil]
|
|
80
|
+
optional :call_leg_id, String
|
|
81
|
+
|
|
82
|
+
# @!attribute call_session_id
|
|
83
|
+
# ID that is unique to the call session and can be used to correlate webhook
|
|
84
|
+
# events. Call session is a group of related call legs that logically belong to
|
|
85
|
+
# the same phone call, e.g. an inbound and outbound leg of a transferred call.
|
|
86
|
+
#
|
|
87
|
+
# @return [String, nil]
|
|
88
|
+
optional :call_session_id, String
|
|
89
|
+
|
|
90
|
+
# @!attribute client_state
|
|
91
|
+
# State received from a command.
|
|
92
|
+
#
|
|
93
|
+
# @return [String, nil]
|
|
94
|
+
optional :client_state, String
|
|
95
|
+
|
|
96
|
+
# @!attribute connection_id
|
|
97
|
+
# Call Control App ID (formerly Telnyx connection ID) used in the call.
|
|
98
|
+
#
|
|
99
|
+
# @return [String, nil]
|
|
100
|
+
optional :connection_id, String
|
|
101
|
+
|
|
102
|
+
# @!attribute from
|
|
103
|
+
# Number or SIP URI placing the call.
|
|
104
|
+
#
|
|
105
|
+
# @return [String, nil]
|
|
106
|
+
optional :from, String
|
|
107
|
+
|
|
108
|
+
# @!attribute to
|
|
109
|
+
# Destination number or SIP URI of the call.
|
|
110
|
+
#
|
|
111
|
+
# @return [String, nil]
|
|
112
|
+
optional :to, String
|
|
113
|
+
|
|
114
|
+
# @!method initialize(call_control_id: nil, call_leg_id: nil, call_session_id: nil, client_state: nil, connection_id: nil, from: nil, to: nil)
|
|
115
|
+
# Some parameter documentations has been truncated, see
|
|
116
|
+
# {Telnyx::Models::CallHoldWebhookEvent::Data::Payload} for more details.
|
|
117
|
+
#
|
|
118
|
+
# @param call_control_id [String] Call ID used to issue commands via Call Control API.
|
|
119
|
+
#
|
|
120
|
+
# @param call_leg_id [String] ID that is unique to the call and can be used to correlate webhook events.
|
|
121
|
+
#
|
|
122
|
+
# @param call_session_id [String] ID that is unique to the call session and can be used to correlate webhook event
|
|
123
|
+
#
|
|
124
|
+
# @param client_state [String] State received from a command.
|
|
125
|
+
#
|
|
126
|
+
# @param connection_id [String] Call Control App ID (formerly Telnyx connection ID) used in the call.
|
|
127
|
+
#
|
|
128
|
+
# @param from [String] Number or SIP URI placing the call.
|
|
129
|
+
#
|
|
130
|
+
# @param to [String] Destination number or SIP URI of the call.
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
# Identifies the type of the resource.
|
|
134
|
+
#
|
|
135
|
+
# @see Telnyx::Models::CallHoldWebhookEvent::Data#record_type
|
|
136
|
+
module RecordType
|
|
137
|
+
extend Telnyx::Internal::Type::Enum
|
|
138
|
+
|
|
139
|
+
EVENT = :event
|
|
140
|
+
|
|
141
|
+
# @!method self.values
|
|
142
|
+
# @return [Array<Symbol>]
|
|
143
|
+
end
|
|
144
|
+
end
|
|
145
|
+
end
|
|
146
|
+
end
|
|
147
|
+
end
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class CallUnholdWebhookEvent < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute data
|
|
7
|
+
#
|
|
8
|
+
# @return [Telnyx::Models::CallUnholdWebhookEvent::Data, nil]
|
|
9
|
+
optional :data, -> { Telnyx::CallUnholdWebhookEvent::Data }
|
|
10
|
+
|
|
11
|
+
# @!method initialize(data: nil)
|
|
12
|
+
# @param data [Telnyx::Models::CallUnholdWebhookEvent::Data]
|
|
13
|
+
|
|
14
|
+
# @see Telnyx::Models::CallUnholdWebhookEvent#data
|
|
15
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
16
|
+
# @!attribute id
|
|
17
|
+
# Identifies the type of resource.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :id, String
|
|
21
|
+
|
|
22
|
+
# @!attribute event_type
|
|
23
|
+
# The type of event being delivered.
|
|
24
|
+
#
|
|
25
|
+
# @return [Symbol, Telnyx::Models::CallUnholdWebhookEvent::Data::EventType, nil]
|
|
26
|
+
optional :event_type, enum: -> { Telnyx::CallUnholdWebhookEvent::Data::EventType }
|
|
27
|
+
|
|
28
|
+
# @!attribute occurred_at
|
|
29
|
+
# ISO 8601 datetime of when the event occurred.
|
|
30
|
+
#
|
|
31
|
+
# @return [Time, nil]
|
|
32
|
+
optional :occurred_at, Time
|
|
33
|
+
|
|
34
|
+
# @!attribute payload
|
|
35
|
+
#
|
|
36
|
+
# @return [Telnyx::Models::CallUnholdWebhookEvent::Data::Payload, nil]
|
|
37
|
+
optional :payload, -> { Telnyx::CallUnholdWebhookEvent::Data::Payload }
|
|
38
|
+
|
|
39
|
+
# @!attribute record_type
|
|
40
|
+
# Identifies the type of the resource.
|
|
41
|
+
#
|
|
42
|
+
# @return [Symbol, Telnyx::Models::CallUnholdWebhookEvent::Data::RecordType, nil]
|
|
43
|
+
optional :record_type, enum: -> { Telnyx::CallUnholdWebhookEvent::Data::RecordType }
|
|
44
|
+
|
|
45
|
+
# @!method initialize(id: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
|
|
46
|
+
# @param id [String] Identifies the type of resource.
|
|
47
|
+
#
|
|
48
|
+
# @param event_type [Symbol, Telnyx::Models::CallUnholdWebhookEvent::Data::EventType] The type of event being delivered.
|
|
49
|
+
#
|
|
50
|
+
# @param occurred_at [Time] ISO 8601 datetime of when the event occurred.
|
|
51
|
+
#
|
|
52
|
+
# @param payload [Telnyx::Models::CallUnholdWebhookEvent::Data::Payload]
|
|
53
|
+
#
|
|
54
|
+
# @param record_type [Symbol, Telnyx::Models::CallUnholdWebhookEvent::Data::RecordType] Identifies the type of the resource.
|
|
55
|
+
|
|
56
|
+
# The type of event being delivered.
|
|
57
|
+
#
|
|
58
|
+
# @see Telnyx::Models::CallUnholdWebhookEvent::Data#event_type
|
|
59
|
+
module EventType
|
|
60
|
+
extend Telnyx::Internal::Type::Enum
|
|
61
|
+
|
|
62
|
+
CALL_UNHOLD = :"call.unhold"
|
|
63
|
+
|
|
64
|
+
# @!method self.values
|
|
65
|
+
# @return [Array<Symbol>]
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
# @see Telnyx::Models::CallUnholdWebhookEvent::Data#payload
|
|
69
|
+
class Payload < Telnyx::Internal::Type::BaseModel
|
|
70
|
+
# @!attribute call_control_id
|
|
71
|
+
# Call ID used to issue commands via Call Control API.
|
|
72
|
+
#
|
|
73
|
+
# @return [String, nil]
|
|
74
|
+
optional :call_control_id, String
|
|
75
|
+
|
|
76
|
+
# @!attribute call_leg_id
|
|
77
|
+
# ID that is unique to the call and can be used to correlate webhook events.
|
|
78
|
+
#
|
|
79
|
+
# @return [String, nil]
|
|
80
|
+
optional :call_leg_id, String
|
|
81
|
+
|
|
82
|
+
# @!attribute call_session_id
|
|
83
|
+
# ID that is unique to the call session and can be used to correlate webhook
|
|
84
|
+
# events. Call session is a group of related call legs that logically belong to
|
|
85
|
+
# the same phone call, e.g. an inbound and outbound leg of a transferred call.
|
|
86
|
+
#
|
|
87
|
+
# @return [String, nil]
|
|
88
|
+
optional :call_session_id, String
|
|
89
|
+
|
|
90
|
+
# @!attribute client_state
|
|
91
|
+
# State received from a command.
|
|
92
|
+
#
|
|
93
|
+
# @return [String, nil]
|
|
94
|
+
optional :client_state, String
|
|
95
|
+
|
|
96
|
+
# @!attribute connection_id
|
|
97
|
+
# Call Control App ID (formerly Telnyx connection ID) used in the call.
|
|
98
|
+
#
|
|
99
|
+
# @return [String, nil]
|
|
100
|
+
optional :connection_id, String
|
|
101
|
+
|
|
102
|
+
# @!attribute from
|
|
103
|
+
# Number or SIP URI placing the call.
|
|
104
|
+
#
|
|
105
|
+
# @return [String, nil]
|
|
106
|
+
optional :from, String
|
|
107
|
+
|
|
108
|
+
# @!attribute to
|
|
109
|
+
# Destination number or SIP URI of the call.
|
|
110
|
+
#
|
|
111
|
+
# @return [String, nil]
|
|
112
|
+
optional :to, String
|
|
113
|
+
|
|
114
|
+
# @!method initialize(call_control_id: nil, call_leg_id: nil, call_session_id: nil, client_state: nil, connection_id: nil, from: nil, to: nil)
|
|
115
|
+
# Some parameter documentations has been truncated, see
|
|
116
|
+
# {Telnyx::Models::CallUnholdWebhookEvent::Data::Payload} for more details.
|
|
117
|
+
#
|
|
118
|
+
# @param call_control_id [String] Call ID used to issue commands via Call Control API.
|
|
119
|
+
#
|
|
120
|
+
# @param call_leg_id [String] ID that is unique to the call and can be used to correlate webhook events.
|
|
121
|
+
#
|
|
122
|
+
# @param call_session_id [String] ID that is unique to the call session and can be used to correlate webhook event
|
|
123
|
+
#
|
|
124
|
+
# @param client_state [String] State received from a command.
|
|
125
|
+
#
|
|
126
|
+
# @param connection_id [String] Call Control App ID (formerly Telnyx connection ID) used in the call.
|
|
127
|
+
#
|
|
128
|
+
# @param from [String] Number or SIP URI placing the call.
|
|
129
|
+
#
|
|
130
|
+
# @param to [String] Destination number or SIP URI of the call.
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
# Identifies the type of the resource.
|
|
134
|
+
#
|
|
135
|
+
# @see Telnyx::Models::CallUnholdWebhookEvent::Data#record_type
|
|
136
|
+
module RecordType
|
|
137
|
+
extend Telnyx::Internal::Type::Enum
|
|
138
|
+
|
|
139
|
+
EVENT = :event
|
|
140
|
+
|
|
141
|
+
# @!method self.values
|
|
142
|
+
# @return [Array<Symbol>]
|
|
143
|
+
end
|
|
144
|
+
end
|
|
145
|
+
end
|
|
146
|
+
end
|
|
147
|
+
end
|
|
@@ -37,6 +37,8 @@ module Telnyx
|
|
|
37
37
|
|
|
38
38
|
variant -> { Telnyx::CallHangupWebhookEvent }
|
|
39
39
|
|
|
40
|
+
variant -> { Telnyx::CallHoldWebhookEvent }
|
|
41
|
+
|
|
40
42
|
variant -> { Telnyx::CallInitiatedWebhookEvent }
|
|
41
43
|
|
|
42
44
|
variant -> { Telnyx::CallLeftQueueWebhookEvent }
|
|
@@ -81,6 +83,8 @@ module Telnyx
|
|
|
81
83
|
|
|
82
84
|
variant -> { Telnyx::CallStreamingStoppedWebhookEvent }
|
|
83
85
|
|
|
86
|
+
variant -> { Telnyx::CallUnholdWebhookEvent }
|
|
87
|
+
|
|
84
88
|
variant -> { Telnyx::CampaignStatusUpdate }
|
|
85
89
|
|
|
86
90
|
variant -> { Telnyx::ConferenceCreatedWebhookEvent }
|
|
@@ -134,7 +138,7 @@ module Telnyx
|
|
|
134
138
|
variant -> { Telnyx::TranscriptionWebhookEvent }
|
|
135
139
|
|
|
136
140
|
# @!method self.variants
|
|
137
|
-
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
141
|
+
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
138
142
|
end
|
|
139
143
|
end
|
|
140
144
|
end
|
|
@@ -37,6 +37,8 @@ module Telnyx
|
|
|
37
37
|
|
|
38
38
|
variant -> { Telnyx::CallHangupWebhookEvent }
|
|
39
39
|
|
|
40
|
+
variant -> { Telnyx::CallHoldWebhookEvent }
|
|
41
|
+
|
|
40
42
|
variant -> { Telnyx::CallInitiatedWebhookEvent }
|
|
41
43
|
|
|
42
44
|
variant -> { Telnyx::CallLeftQueueWebhookEvent }
|
|
@@ -81,6 +83,8 @@ module Telnyx
|
|
|
81
83
|
|
|
82
84
|
variant -> { Telnyx::CallStreamingStoppedWebhookEvent }
|
|
83
85
|
|
|
86
|
+
variant -> { Telnyx::CallUnholdWebhookEvent }
|
|
87
|
+
|
|
84
88
|
variant -> { Telnyx::CampaignStatusUpdate }
|
|
85
89
|
|
|
86
90
|
variant -> { Telnyx::ConferenceCreatedWebhookEvent }
|
|
@@ -134,7 +138,7 @@ module Telnyx
|
|
|
134
138
|
variant -> { Telnyx::TranscriptionWebhookEvent }
|
|
135
139
|
|
|
136
140
|
# @!method self.variants
|
|
137
|
-
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
141
|
+
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
138
142
|
end
|
|
139
143
|
end
|
|
140
144
|
end
|
data/lib/telnyx/models.rb
CHANGED
|
@@ -245,6 +245,8 @@ module Telnyx
|
|
|
245
245
|
|
|
246
246
|
CallHangupWebhookEvent = Telnyx::Models::CallHangupWebhookEvent
|
|
247
247
|
|
|
248
|
+
CallHoldWebhookEvent = Telnyx::Models::CallHoldWebhookEvent
|
|
249
|
+
|
|
248
250
|
CallInitiated = Telnyx::Models::CallInitiated
|
|
249
251
|
|
|
250
252
|
CallInitiatedWebhookEvent = Telnyx::Models::CallInitiatedWebhookEvent
|
|
@@ -338,6 +340,8 @@ module Telnyx
|
|
|
338
340
|
|
|
339
341
|
CallStreamingStoppedWebhookEvent = Telnyx::Models::CallStreamingStoppedWebhookEvent
|
|
340
342
|
|
|
343
|
+
CallUnholdWebhookEvent = Telnyx::Models::CallUnholdWebhookEvent
|
|
344
|
+
|
|
341
345
|
CampaignStatusUpdate = Telnyx::Models::CampaignStatusUpdate
|
|
342
346
|
|
|
343
347
|
ChannelZoneListParams = Telnyx::Models::ChannelZoneListParams
|
|
@@ -45,6 +45,7 @@ module Telnyx
|
|
|
45
45
|
# **Expected Webhooks:**
|
|
46
46
|
#
|
|
47
47
|
# - `call.answered`
|
|
48
|
+
# - `call.hold` and `call.unhold` if the call is held/unheld
|
|
48
49
|
# - `call.deepfake_detection.result` if `deepfake_detection` was enabled
|
|
49
50
|
# - `call.deepfake_detection.error` if `deepfake_detection` was enabled and an
|
|
50
51
|
# error occurred
|
|
@@ -18,6 +18,7 @@ module Telnyx
|
|
|
18
18
|
#
|
|
19
19
|
# - `call.initiated`
|
|
20
20
|
# - `call.answered` or `call.hangup`
|
|
21
|
+
# - `call.hold` and `call.unhold` if the call is held/unheld
|
|
21
22
|
# - `call.machine.detection.ended` if `answering_machine_detection` was requested
|
|
22
23
|
# - `call.machine.greeting.ended` if `answering_machine_detection` was requested
|
|
23
24
|
# to detect the end of machine greeting
|
|
@@ -5,7 +5,7 @@ module Telnyx
|
|
|
5
5
|
class Webhooks
|
|
6
6
|
# @param payload [String] The raw webhook payload as a string
|
|
7
7
|
#
|
|
8
|
-
# @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
|
|
8
|
+
# @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
|
|
9
9
|
def unsafe_unwrap(payload)
|
|
10
10
|
parsed = JSON.parse(payload, symbolize_names: true)
|
|
11
11
|
Telnyx::Internal::Type::Converter.coerce(Telnyx::Models::UnsafeUnwrapWebhookEvent, parsed)
|
|
@@ -17,7 +17,7 @@ module Telnyx
|
|
|
17
17
|
#
|
|
18
18
|
# @param key [String, nil] The webhook signing key
|
|
19
19
|
#
|
|
20
|
-
# @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
|
|
20
|
+
# @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
|
|
21
21
|
def unwrap(payload, headers:, key: @client.public_key)
|
|
22
22
|
if key.nil?
|
|
23
23
|
raise ArgumentError.new("Cannot verify a webhook without a key on either the client's public_key or passed in as an argument")
|
data/lib/telnyx/version.rb
CHANGED
data/lib/telnyx.rb
CHANGED
|
@@ -513,6 +513,7 @@ require_relative "telnyx/models/call_gather_ended"
|
|
|
513
513
|
require_relative "telnyx/models/call_gather_ended_webhook_event"
|
|
514
514
|
require_relative "telnyx/models/call_hangup"
|
|
515
515
|
require_relative "telnyx/models/call_hangup_webhook_event"
|
|
516
|
+
require_relative "telnyx/models/call_hold_webhook_event"
|
|
516
517
|
require_relative "telnyx/models/call_initiated"
|
|
517
518
|
require_relative "telnyx/models/call_initiated_webhook_event"
|
|
518
519
|
require_relative "telnyx/models/call_left_queue"
|
|
@@ -653,6 +654,7 @@ require_relative "telnyx/models/call_streaming_started"
|
|
|
653
654
|
require_relative "telnyx/models/call_streaming_started_webhook_event"
|
|
654
655
|
require_relative "telnyx/models/call_streaming_stopped"
|
|
655
656
|
require_relative "telnyx/models/call_streaming_stopped_webhook_event"
|
|
657
|
+
require_relative "telnyx/models/call_unhold_webhook_event"
|
|
656
658
|
require_relative "telnyx/models/campaign_status_update"
|
|
657
659
|
require_relative "telnyx/models/channel_zone_list_params"
|
|
658
660
|
require_relative "telnyx/models/channel_zone_list_response"
|
|
@@ -15,7 +15,11 @@ module Telnyx
|
|
|
15
15
|
# key as an integration secret under the `api_key_ref` field. See
|
|
16
16
|
# [integration secrets documentation](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
|
|
17
17
|
# for details. For Telnyx voices, use `Telnyx.<model_id>.<voice_id>` (e.g.
|
|
18
|
-
# Telnyx.KokoroTTS.af_heart)
|
|
18
|
+
# Telnyx.KokoroTTS.af_heart). The voice portion of the identifier supports
|
|
19
|
+
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
20
|
+
# using mustache syntax (e.g. `Telnyx.Ultra.{{voice_id}}`). The variable is
|
|
21
|
+
# resolved at call time from your dynamic variables webhook, allowing you to
|
|
22
|
+
# select the voice dynamically per call.
|
|
19
23
|
sig { returns(String) }
|
|
20
24
|
attr_accessor :voice
|
|
21
25
|
|
|
@@ -153,7 +157,11 @@ module Telnyx
|
|
|
153
157
|
# key as an integration secret under the `api_key_ref` field. See
|
|
154
158
|
# [integration secrets documentation](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
|
|
155
159
|
# for details. For Telnyx voices, use `Telnyx.<model_id>.<voice_id>` (e.g.
|
|
156
|
-
# Telnyx.KokoroTTS.af_heart)
|
|
160
|
+
# Telnyx.KokoroTTS.af_heart). The voice portion of the identifier supports
|
|
161
|
+
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
162
|
+
# using mustache syntax (e.g. `Telnyx.Ultra.{{voice_id}}`). The variable is
|
|
163
|
+
# resolved at call time from your dynamic variables webhook, allowing you to
|
|
164
|
+
# select the voice dynamically per call.
|
|
157
165
|
voice:,
|
|
158
166
|
# The `identifier` for an integration secret
|
|
159
167
|
# [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
|