rustpbx 0.4.3

A SIP PBX implementation in Rust
Documentation
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
use super::SipSession;
use crate::call::domain::LegId;
use anyhow::Result;
use rsipstack::dialog::dialog::DialogState;
use rsipstack::sip::StatusCode;
use std::time::Duration;
use tokio::sync::mpsc;
use tracing::{debug, info, warn};

impl SipSession {
    pub(super) async fn execute_queue(
        &mut self,
        plan: &crate::call::QueuePlan,
        callee_state_rx: &mut mpsc::UnboundedReceiver<DialogState>,
    ) -> Result<(), (StatusCode, Option<String>)> {
        use crate::call::DialStrategy;

        self.queue_name = Some(plan.queue_name.clone());

        info!("Executing queue plan");

        let agents = match &plan.dial_strategy {
            Some(DialStrategy::Sequential(locations)) => locations.clone(),
            Some(DialStrategy::Parallel(locations)) => locations.clone(),
            None => {
                warn!("No dial strategy in queue plan");
                return Ok(());
            }
        };

        if agents.is_empty() {
            warn!("No agents configured in queue plan");
            return Ok(());
        }

        let resolved_agents = self
            .resolve_custom_targets(agents, plan.acd_policy.as_deref())
            .await;

        let transfer_prompt = plan
            .voice_prompts
            .as_ref()
            .and_then(|prompts| prompts.transfer_prompt.as_deref());

        if resolved_agents.is_empty() {
            warn!("No agents available after resolving queue targets");

            self.prepare_queue_fallback_audio_media().await;
            self.play_queue_transfer_prompt_before_bridge(transfer_prompt)
                .await;

            return self.execute_queue_fallback(plan).await;
        }

        if plan.accept_immediately {
            info!("Queue: answering call immediately");
            let caller_answer = self.prepare_queue_early_answer(&resolved_agents).await;
            if let Err(e) = self.accept_call(None, caller_answer, None).await {
                warn!(error = %e, "Failed to answer call in queue");
            }
        }

        self.play_queue_transfer_prompt_before_bridge(transfer_prompt)
            .await;

        let hold_handle = if let Some(ref hold) = plan.hold {
            if let Some(ref audio_file) = hold.audio_file {
                info!(file = %audio_file, "Queue: starting hold music");

                match self
                    .play_audio_file(
                        audio_file,
                        false,
                        Self::QUEUE_HOLD_TRACK_ID,
                        hold.loop_playback,
                    )
                    .await
                {
                    Ok(()) => {
                        info!(track_id = %Self::QUEUE_HOLD_TRACK_ID, "Queue: hold music started");
                        true
                    }
                    Err(error) => {
                        warn!(
                            error = %error,
                            track_id = %Self::QUEUE_HOLD_TRACK_ID,
                            "Queue: failed to start hold music"
                        );
                        false
                    }
                }
            } else {
                false
            }
        } else {
            false
        };

        let result = match &plan.dial_strategy {
            Some(DialStrategy::Sequential(_)) => {
                self.dial_queue_sequential(&resolved_agents, plan.ring_timeout, callee_state_rx)
                    .await
            }
            Some(DialStrategy::Parallel(_)) => {
                self.dial_queue_parallel(&resolved_agents, plan.ring_timeout, callee_state_rx)
                    .await
            }
            None => Ok(()),
        };

        if hold_handle {
            info!("Queue: stopping hold music");
            self.stop_playback_track(Self::QUEUE_HOLD_TRACK_ID, false)
                .await;
        }

        if self.cancel_token.is_cancelled() || self.server_dialog.state().is_terminated() {
            info!("Queue: caller ended, stopping queue execution");
            return Ok(());
        }

        match result {
            Ok(()) => {
                info!("Queue: agent connected successfully");
                Ok(())
            }
            Err(e) => {
                warn!(error = ?e, "Queue: all agents failed, executing fallback");
                self.execute_queue_fallback(plan).await
            }
        }
    }

    pub(super) async fn dial_queue_sequential(
        &mut self,
        agents: &[crate::call::Location],
        _ring_timeout: Option<Duration>,
        callee_state_rx: &mut mpsc::UnboundedReceiver<DialogState>,
    ) -> Result<(), (StatusCode, Option<String>)> {
        let mut last_error = (
            StatusCode::TemporarilyUnavailable,
            Some("All agents unavailable".to_string()),
        );

        for (idx, agent) in agents.iter().enumerate() {
            if self.cancel_token.is_cancelled() || self.server_dialog.state().is_terminated() {
                info!("Queue: caller ended before next agent");
                return Ok(());
            }

            info!(index = idx, agent = %agent.aor, "Queue: trying agent");

            match self
                .try_single_target(agent, callee_state_rx, Some(Self::QUEUE_HOLD_TRACK_ID))
                .await
            {
                Ok(()) => {
                    info!(index = idx, "Queue: agent connected");
                    return Ok(());
                }
                Err(e) => {
                    warn!(index = idx, error = ?e, "Queue: agent failed");
                    last_error = e;
                }
            }
        }

        Err(last_error)
    }

    pub(super) async fn dial_queue_parallel(
        &mut self,
        agents: &[crate::call::Location],
        _ring_timeout: Option<Duration>,
        callee_state_rx: &mut mpsc::UnboundedReceiver<DialogState>,
    ) -> Result<(), (StatusCode, Option<String>)> {
        if let Some(agent) = agents.first() {
            info!(agent = %agent.aor, "Queue: trying parallel agent");
            self.try_single_target(agent, callee_state_rx, Some(Self::QUEUE_HOLD_TRACK_ID))
                .await
        } else {
            Err((
                StatusCode::TemporarilyUnavailable,
                Some("No agents available".to_string()),
            ))
        }
    }

    pub(super) async fn play_queue_transfer_prompt_before_bridge(
        &mut self,
        transfer_prompt: Option<&str>,
    ) {
        let Some(audio_file) = transfer_prompt
            .map(str::trim)
            .filter(|value| !value.is_empty())
        else {
            debug!("Queue: no transfer prompt configured");
            return;
        };

        info!(file = %audio_file, "Queue: playing transfer prompt before bridging agent audio");
        match self
            .play_audio_file(audio_file, true, "queue-transfer-prompt", false)
            .await
        {
            Ok(()) => {
                let maybe_track = self.playback_tracks.get("queue-transfer-prompt").cloned();
                let cancel = self.cancel_token.clone();
                if let Some(track) = maybe_track {
                    tokio::select! {
                        _ = track.wait_for_completion() => {}
                        _ = cancel.cancelled() => {}
                    }
                }
                self.stop_playback_track("queue-transfer-prompt", false)
                    .await;
                info!(file = %audio_file, "Queue: transfer prompt completed");
            }
            Err(error) => {
                warn!(
                    error = %error,
                    file = %audio_file,
                    "Queue: failed to play transfer prompt before bridging agent audio"
                );
            }
        }
    }

    pub(super) async fn execute_queue_fallback(
        &mut self,
        plan: &crate::call::QueuePlan,
    ) -> Result<(), (StatusCode, Option<String>)> {
        use crate::call::{FailureAction, QueueFallbackAction, TransferEndpoint};

        let pre_action_audio: Option<String> =
            plan.failure_audio.clone().or_else(|| match &plan.fallback {
                Some(QueueFallbackAction::Failure(FailureAction::PlayThenHangup {
                    audio_file,
                    ..
                })) => Some(audio_file.clone()),
                _ => None,
            });

        if let Some(ref audio_file) = pre_action_audio {
            self.prepare_queue_fallback_audio_media().await;
            if let Err(e) = self
                .play_audio_file(audio_file, true, "caller", false)
                .await
            {
                warn!(error = %e, "Failed to play queue failure audio");
            } else {
                let maybe_track = self.playback_tracks.get("caller").cloned();
                let cancel = self.cancel_token.clone();
                if let Some(track) = maybe_track {
                    tokio::select! {
                        _ = track.wait_for_completion() => {}
                        _ = cancel.cancelled() => {}
                    }
                }
            }
        }

        match &plan.fallback {
            Some(QueueFallbackAction::Failure(FailureAction::Hangup { code, reason })) => {
                info!(?code, ?reason, "Queue fallback - hangup");
                Err((
                    code.clone().unwrap_or(StatusCode::TemporarilyUnavailable),
                    reason.clone(),
                ))
            }
            Some(QueueFallbackAction::Failure(FailureAction::PlayThenHangup {
                status_code,
                reason,
                ..
            })) => {
                info!("Queue fallback - play then hangup");
                Err((status_code.clone(), reason.clone()))
            }
            Some(QueueFallbackAction::Failure(FailureAction::Transfer(target))) => {
                info!(target = ?target, "Queue fallback - transfer");

                match target {
                    TransferEndpoint::Uri(uri) => {
                        Box::pin(self.handle_blind_transfer(LegId::from("caller"), uri.clone()))
                            .await
                            .map_err(|e| {
                                (
                                    StatusCode::TemporarilyUnavailable,
                                    Some(format!("Transfer failed: {}", e)),
                                )
                            })
                    }
                    TransferEndpoint::Queue(queue_name) => Box::pin(self.handle_queue_transfer(
                        LegId::from("caller"),
                        queue_name,
                        None,
                    ))
                    .await
                    .map_err(|e| {
                        (
                            StatusCode::TemporarilyUnavailable,
                            Some(format!("Transfer failed: {}", e)),
                        )
                    }),
                    TransferEndpoint::Ivr(ivr_name) => {
                        info!(ivr = %ivr_name, "Queue fallback - transferring to IVR");
                        self.start_ivr_app(ivr_name).await.map_err(|e| {
                            (
                                StatusCode::ServerInternalError,
                                Some(format!("Failed to start IVR: {}", e)),
                            )
                        })?;
                        Ok(())
                    }
                }
            }
            Some(QueueFallbackAction::Redirect { target }) => {
                info!(target = %target, "Queue fallback - redirecting call");

                Box::pin(self.handle_blind_transfer(LegId::from("caller"), target.to_string()))
                    .await
                    .map_err(|e| {
                        (
                            StatusCode::TemporarilyUnavailable,
                            Some(format!("Redirect failed: {}", e)),
                        )
                    })
            }
            Some(QueueFallbackAction::Queue { name }) => {
                if name.starts_with("skill-group:") {
                    let skill_group_id = name.strip_prefix("skill-group:").unwrap_or(name).trim();
                    info!(skill_group = %skill_group_id, "Queue fallback - transfer to skill group");

                    if let Some(registry) = self.server.agent_registry.clone() {
                        let skill_group_uri = format!("skill-group:{}", skill_group_id);
                        let agents = registry.resolve_target(&skill_group_uri).await;
                        if !agents.is_empty() {
                            info!(agents = ?agents, "Resolved skill group to agents");
                            let target = agents[0].clone();
                            Box::pin(self.handle_blind_transfer(LegId::from("caller"), target))
                                .await
                                .map_err(|e| {
                                    (
                                        StatusCode::TemporarilyUnavailable,
                                        Some(format!("Transfer failed: {}", e)),
                                    )
                                })
                        } else {
                            warn!(skill_group = %skill_group_id, "No agents found for this skill group");
                            Err((
                                StatusCode::TemporarilyUnavailable,
                                Some(format!(
                                    "No agents available for skill group {}",
                                    skill_group_id
                                )),
                            ))
                        }
                    } else {
                        warn!("No agent registry available for skill group resolution");
                        Err((
                            StatusCode::TemporarilyUnavailable,
                            Some("Agent registry not available".to_string()),
                        ))
                    }
                } else {
                    info!(queue = %name, "Queue fallback - transfer to another queue");
                    match Box::pin(self.handle_queue_transfer(LegId::from("caller"), name, None))
                        .await
                    {
                        Ok(_) => {
                            info!(queue = %name, "Queue fallback - re-enqueue succeeded");
                            Ok(())
                        }
                        Err(e) => {
                            warn!(queue = %name, error = %e, "Queue fallback - re-enqueue operation failed");
                            Err((
                                StatusCode::TemporarilyUnavailable,
                                Some(format!("Re-enqueue failed: {}", e)),
                            ))
                        }
                    }
                }
            }
            None => {
                info!("Queue fallback - default hangup with busy tone");
                Err((
                    StatusCode::BusyHere,
                    Some("All agents unavailable".to_string()),
                ))
            }
        }
    }

    pub(super) async fn prepare_queue_fallback_audio_media(&mut self) {
        if self.server_dialog.state().is_confirmed() {
            let _ = self.ensure_caller_answer_sdp().await;
            return;
        }

        let caller_answer = self.ensure_caller_answer_sdp().await;
        if let Err(error) = self.accept_call(None, caller_answer, None).await {
            warn!(
                error = %error,
                "Queue fallback: failed to prepare caller media before fallback audio"
            );
        }
    }
}