1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
use crate::apis::client::Client;
use std::fmt::Display;
pub mod models;
pub mod params;
pub struct Channels<'c> {
client: &'c Client,
}
impl<'c> Channels<'c> {
pub fn new(client: &'c Client) -> Self {
Self { client }
}
}
impl Channels<'_> {
/// List all active channels in Asterisk.
pub async fn list(&self) -> crate::errors::Result<Vec<models::Channel>> {
self.client.get("/channels").await
}
/// Channel details
pub async fn get(
&self,
channel_id: impl Into<String> + Display + Send,
) -> crate::errors::Result<models::Channel> {
self.client
.get(format!("/channels/{channel_id}").as_str())
.await
}
/// Create a new channel
///
/// *Implementation Notes*
/// The new channel is created immediately and a snapshot of it returned.
/// If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.
pub async fn originate(
&self,
request: params::OriginateRequest,
) -> crate::errors::Result<models::Channel> {
self.client
.post_with_query("/channels", &request.variables, &request)
.await
}
/// Create a channel
///
/// *Implementation Notes*
/// The new channel is created immediately and a snapshot of it returned.
/// If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.
pub async fn create(
&self,
request: params::CreateRequest,
) -> crate::errors::Result<models::Channel> {
self.client
.post_with_query("/channels", &request.variables, &request)
.await
}
/// Create a new channel (originate with id).
///
/// *Implementation Notes*
/// The new channel is created immediately and a snapshot of it returned.
/// If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.
pub async fn create_with_id(
&self,
request: params::OriginateWithIdRequest,
) -> crate::errors::Result<models::Channel> {
self.client
.post_with_query(
format!("/channels/{}", request.channel_id).as_str(),
&request.variables,
&request,
)
.await
}
/// Delete (i.e. hangup) a channel.
pub async fn delete(&self, request: params::DeleteRequest) -> crate::errors::Result<()> {
self.client
.delete_with_query(
format!("/channels/{}", request.channel_id).as_str(),
&request,
)
.await
}
/// Exit application; continue execution in the dialplan.
pub async fn r#continue(&self, request: params::ContinueRequest) -> crate::errors::Result<()> {
self.client
.post_with_query(
format!("/channels/{}/continue", request.channel_id).as_str(),
vec![] as Vec<String>,
&request,
)
.await
}
/// Move the channel from one Stasis application to another
pub async fn r#move(&self, request: params::MoveRequest) -> crate::errors::Result<()> {
self.client
.post_with_query(
format!("/channels/{}/move", request.channel_id).as_str(),
vec![] as Vec<String>,
&request,
)
.await
}
/// Redirect the channel to a different location.
pub async fn redirect(
&self,
channel_id: impl Into<String> + Display + Send,
endpoint: impl Into<String> + Send,
) -> crate::errors::Result<()> {
self.client
.post_with_query(
format!("/channels/{channel_id}/redirect").as_str(),
vec![] as Vec<String>,
&[("endpoint", endpoint.into())],
)
.await
}
/// Answer a channel
pub async fn answer(
&self,
channel_id: impl Into<String> + Display + Send,
) -> crate::errors::Result<()> {
self.client
.post(
format!("/channels/{channel_id}/answer",).as_str(),
vec![] as Vec<String>,
)
.await
}
/// Indicate ringing to a channel.
pub async fn ring(
&self,
channel_id: impl Into<String> + Display + Send,
) -> crate::errors::Result<()> {
self.client
.post(
format!("/channels/{channel_id}/ring").as_str(),
vec![] as Vec<String>,
)
.await
}
/// Stop ringing indication on a channel if locally generated.
pub async fn stop_ring(
&self,
channel_id: impl Into<String> + Display + Send,
) -> crate::errors::Result<()> {
self.client
.delete(format!("/channels/{channel_id}/ring").as_str())
.await
}
/// Send provided DTMF to a given channel.
pub async fn dtmf(&self, request: params::DtmfRequest) -> crate::errors::Result<()> {
self.client
.post_with_query(
format!("/channels/{}/dtmf", request.channel_id).as_str(),
vec![] as Vec<String>,
&request,
)
.await
}
/// Mute a channel.
pub async fn mute(
&self,
channel_id: impl Into<String> + Display + Send,
direction: crate::apis::params::Direction,
) -> crate::errors::Result<()> {
self.client
.post_with_query(
format!("/channels/{channel_id}/mute",).as_str(),
vec![] as Vec<String>,
&[("direction", direction)],
)
.await
}
/// Unmute a channel.
pub async fn unmute(
&self,
channel_id: impl Into<String> + Display + Send,
direction: crate::apis::params::Direction,
) -> crate::errors::Result<()> {
self.client
.delete_with_query(
format!("/channels/{channel_id}/mute").as_str(),
&[("direction", direction)],
)
.await
}
/// Hold a channel.
pub async fn hold(
&self,
channel_id: impl Into<String> + Display + Send,
) -> crate::errors::Result<()> {
self.client
.post(
format!("/channels/{channel_id}/hold").as_str(),
vec![] as Vec<String>,
)
.await
}
/// Remove a channel from hold.
pub async fn unhold(
&self,
channel_id: impl Into<String> + Display + Send,
) -> crate::errors::Result<()> {
self.client
.delete(format!("/channels/{channel_id}/hold").as_str())
.await
}
/// Play music on hold to a channel.
///
/// *Implementation Notes*
/// Using media operations such as /play on a channel playing MOH in this manner will suspend MOH without resuming automatically.
/// If continuing music on hold is desired, the stasis application must reinitiate music on hold.
pub async fn moh(&self, request: params::MohRequest) -> crate::errors::Result<()> {
self.client
.post_with_query(
format!("/channels/{}/moh", request.channel_id).as_str(),
vec![] as Vec<String>,
&request,
)
.await
}
/// Stop playing music on hold to a channel.
pub async fn unmoh(
&self,
channel_id: impl Into<String> + Display + Send,
) -> crate::errors::Result<()> {
self.client
.delete(format!("/channels/{channel_id}/moh",).as_str())
.await
}
/// Play silence to a channel.
///
/// *Implementation Notes*
/// Using media operations such as /play on a channel playing silence in this manner will suspend silence without resuming automatically.
pub async fn silence(
&self,
channel_id: impl Into<String> + Display + Send,
) -> crate::errors::Result<()> {
self.client
.post(
format!("/channels/{channel_id}/silence").as_str(),
vec![] as Vec<String>,
)
.await
}
/// Stop playing silence to a channel.
pub async fn stop_silence(
&self,
channel_id: impl Into<String> + Display + Send,
) -> crate::errors::Result<()> {
self.client
.delete(format!("/channels/{channel_id}/silence").as_str())
.await
}
/// Start playback of media.
///
/// *Implementation Notes*
/// The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)
pub async fn play(
&self,
request: params::PlayRequest,
) -> crate::errors::Result<crate::apis::playbacks::models::Playback> {
self.client
.post_with_query(
format!("/channels/{}/play", request.channel_id).as_str(),
vec![] as Vec<String>,
&request,
)
.await
}
/// Start playback of media and specify the playbackId.
///
/// *Implementation Notes*
/// The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)
pub async fn play_with_playback_id(
&self,
request: params::PlayWithPlaybackIdRequest,
) -> crate::errors::Result<crate::apis::playbacks::models::Playback> {
self.client
.post_with_query(
format!(
"/channels/{}/play/{}",
request.channel_id, request.playback_id
)
.as_str(),
vec![] as Vec<String>,
&request,
)
.await
}
/// Start a recording.
///
/// *Implementation Notes*
/// Record audio from a channel.
/// Note that this will not capture audio sent to the channel.
/// The bridge itself has a record feature if that's what you want.
pub async fn record(
&self,
request: params::RecordRequest,
) -> crate::errors::Result<crate::apis::recordings::models::LiveRecording> {
self.client
.post_with_query(
format!("/channels/{}/record", request.channel_id).as_str(),
vec![] as Vec<String>,
&request,
)
.await
}
/// Get the value of a channel variable or function
pub async fn get_variable(
&self,
channel_id: impl Into<String> + Display + Send,
variable: impl Into<String> + Send,
) -> crate::errors::Result<crate::apis::asterisk::variables::models::Variable> {
self.client
.post_with_query(
format!("/channels/{channel_id}/variable").as_str(),
vec![] as Vec<String>,
&[("variable", variable.into())],
)
.await
}
/// Set the value of a channel variable or function.
pub async fn set_variable(
&self,
channel_id: impl Into<String> + Display + Send,
variable: impl Into<String> + Send,
value: impl Into<String> + Send,
) -> crate::errors::Result<crate::apis::asterisk::variables::models::Variable> {
self.client
.post_with_query(
format!("/channels/{channel_id}/variable").as_str(),
vec![] as Vec<String>,
&[("variable", variable.into()), ("value", value.into())],
)
.await
}
/// Start snooping.
///
/// *Implementation Notes*
/// Snoop (spy/whisper) on a specific channel.
pub async fn snoop(
&self,
request: params::SnoopRequest,
) -> crate::errors::Result<models::Channel> {
self.client
.post_with_query(
format!("/channels/{}/snoop", request.channel_id).as_str(),
vec![] as Vec<String>,
&request,
)
.await
}
/// Start snooping with specific ID.
///
/// *Implementation Notes*
/// Snoop (spy/whisper) on a specific channel.
pub async fn snoop_with_id(
&self,
request: params::SnoopWithIdRequest,
) -> crate::errors::Result<models::Channel> {
self.client
.post_with_query(
format!(
"/channels/{}/snoop/{}",
request.channel_id, request.snoop_id
)
.as_str(),
vec![] as Vec<String>,
&request,
)
.await
}
/// Dial a created channel.
pub async fn dial(&self, request: params::DialRequest) -> crate::errors::Result<()> {
self.client
.post_with_query(
format!("/channels/{}/dial", request.channel_id).as_str(),
vec![] as Vec<String>,
&request,
)
.await
}
/// RTP stats on a channel.
pub async fn rtp_statistics(
&self,
channel_id: impl Into<String> + Display + Send,
) -> crate::errors::Result<models::RTPStatistics> {
self.client
.get(format!("/channels/{channel_id}/rtp_statistics").as_str())
.await
}
/// Start an External Media session.
pub async fn external_media(
&self,
request: params::ExternalMediaRequest,
) -> crate::errors::Result<models::Channel> {
self.client
.post_with_query("/channels/externalMedia", &request.variables, &request)
.await
}
}