Class: SignalWire::REST::Namespaces::CallingNamespace

Inherits:
BaseResource
  • Object
show all
Defined in:
lib/signalwire/rest/namespaces/calling.rb

Overview

REST call control – all 37 commands dispatched via single POST endpoint.

Instance Method Summary collapse

Constructor Details

#initialize(http) ⇒ CallingNamespace

Returns a new instance of CallingNamespace.



8
9
10
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 8

def initialize(http)
  super(http, '/api/calling/calls')
end

Instance Method Details

#ai_hold(call_id, **params) ⇒ Object 



129
130
131
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 129

def ai_hold(call_id, **params)
  _execute('calling.ai_hold', call_id: call_id, **params)
end

#ai_message(call_id, **params) ⇒ Object

AI



125
126
127
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 125

def ai_message(call_id, **params)
  _execute('calling.ai_message', call_id: call_id, **params)
end

#ai_stop(call_id, **params) ⇒ Object 



137
138
139
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 137

def ai_stop(call_id, **params)
  _execute('calling.ai.stop', call_id: call_id, **params)
end

#ai_unhold(call_id, **params) ⇒ Object 



133
134
135
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 133

def ai_unhold(call_id, **params)
  _execute('calling.ai_unhold', call_id: call_id, **params)
end

#collect(call_id, **params) ⇒ Object

Collect



67
68
69
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 67

def collect(call_id, **params)
  _execute('calling.collect', call_id: call_id, **params)
end

#collect_start_input_timers(call_id, **params) ⇒ Object 



75
76
77
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 75

def collect_start_input_timers(call_id, **params)
  _execute('calling.collect.start_input_timers', call_id: call_id, **params)
end

#collect_stop(call_id, **params) ⇒ Object 



71
72
73
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 71

def collect_stop(call_id, **params)
  _execute('calling.collect.stop', call_id: call_id, **params)
end

#denoise(call_id, **params) ⇒ Object

Denoise



107
108
109
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 107

def denoise(call_id, **params)
  _execute('calling.denoise', call_id: call_id, **params)
end

#denoise_stop(call_id, **params) ⇒ Object 



111
112
113
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 111

def denoise_stop(call_id, **params)
  _execute('calling.denoise.stop', call_id: call_id, **params)
end

#detect(call_id, **params) ⇒ Object

Detect



80
81
82
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 80

def detect(call_id, **params)
  _execute('calling.detect', call_id: call_id, **params)
end

#detect_stop(call_id, **params) ⇒ Object 



84
85
86
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 84

def detect_stop(call_id, **params)
  _execute('calling.detect.stop', call_id: call_id, **params)
end

#dial(**params) ⇒ Object

Call lifecycle



13
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 13

def dial(**params)       = _execute('dial', **params)

#disconnect(call_id, **params) ⇒ Object 



24
25
26
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 24

def disconnect(call_id, **params)
  _execute('calling.disconnect', call_id: call_id, **params)
end

#end_call(call_id, **params) ⇒ Object 



16
17
18
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 16

def end_call(call_id, **params)
  _execute('calling.end', call_id: call_id, **params)
end

#live_transcribe(call_id, **params) ⇒ Object

Live transcribe / translate



142
143
144
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 142

def live_transcribe(call_id, **params)
  _execute('calling.live_transcribe', call_id: call_id, **params)
end

#live_translate(call_id, **params) ⇒ Object 



146
147
148
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 146

def live_translate(call_id, **params)
  _execute('calling.live_translate', call_id: call_id, **params)
end

#play(call_id, **params) ⇒ Object

Play



29
30
31
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 29

def play(call_id, **params)
  _execute('calling.play', call_id: call_id, **params)
end

#play_pause(call_id, **params) ⇒ Object 



33
34
35
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 33

def play_pause(call_id, **params)
  _execute('calling.play.pause', call_id: call_id, **params)
end

#play_resume(call_id, **params) ⇒ Object 



37
38
39
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 37

def play_resume(call_id, **params)
  _execute('calling.play.resume', call_id: call_id, **params)
end

#play_stop(call_id, **params) ⇒ Object 



41
42
43
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 41

def play_stop(call_id, **params)
  _execute('calling.play.stop', call_id: call_id, **params)
end

#play_volume(call_id, **params) ⇒ Object 



45
46
47
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 45

def play_volume(call_id, **params)
  _execute('calling.play.volume', call_id: call_id, **params)
end

#receive_fax_stop(call_id, **params) ⇒ Object 



155
156
157
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 155

def receive_fax_stop(call_id, **params)
  _execute('calling.receive_fax.stop', call_id: call_id, **params)
end

#record(call_id, **params) ⇒ Object

Record



50
51
52
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 50

def record(call_id, **params)
  _execute('calling.record', call_id: call_id, **params)
end

#record_pause(call_id, **params) ⇒ Object 



54
55
56
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 54

def record_pause(call_id, **params)
  _execute('calling.record.pause', call_id: call_id, **params)
end

#record_resume(call_id, **params) ⇒ Object 



58
59
60
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 58

def record_resume(call_id, **params)
  _execute('calling.record.resume', call_id: call_id, **params)
end

#record_stop(call_id, **params) ⇒ Object 



62
63
64
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 62

def record_stop(call_id, **params)
  _execute('calling.record.stop', call_id: call_id, **params)
end

#refer(call_id, **params) ⇒ Object

SIP



160
161
162
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 160

def refer(call_id, **params)
  _execute('calling.refer', call_id: call_id, **params)
end

#send_fax_stop(call_id, **params) ⇒ Object

Fax



151
152
153
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 151

def send_fax_stop(call_id, **params)
  _execute('calling.send_fax.stop', call_id: call_id, **params)
end

#stream(call_id, **params) ⇒ Object

Stream



98
99
100
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 98

def stream(call_id, **params)
  _execute('calling.stream', call_id: call_id, **params)
end

#stream_stop(call_id, **params) ⇒ Object 



102
103
104
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 102

def stream_stop(call_id, **params)
  _execute('calling.stream.stop', call_id: call_id, **params)
end

#tap(call_id, **params) ⇒ Object

Tap



89
90
91
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 89

def tap(call_id, **params)
  _execute('calling.tap', call_id: call_id, **params)
end

#tap_stop(call_id, **params) ⇒ Object 



93
94
95
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 93

def tap_stop(call_id, **params)
  _execute('calling.tap.stop', call_id: call_id, **params)
end

#transcribe(call_id, **params) ⇒ Object

Transcribe



116
117
118
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 116

def transcribe(call_id, **params)
  _execute('calling.transcribe', call_id: call_id, **params)
end

#transcribe_stop(call_id, **params) ⇒ Object 



120
121
122
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 120

def transcribe_stop(call_id, **params)
  _execute('calling.transcribe.stop', call_id: call_id, **params)
end

#transfer(call_id, **params) ⇒ Object 



20
21
22
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 20

def transfer(call_id, **params)
  _execute('calling.transfer', call_id: call_id, **params)
end

#update(**params) ⇒ Object 



14
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 14

def update(**params)     = _execute('update', **params)

#user_event(call_id, **params) ⇒ Object

Custom events



165
166
167
 
# File 'lib/signalwire/rest/namespaces/calling.rb', line 165

def user_event(call_id, **params)
  _execute('calling.user_event', call_id: call_id, **params)
end