Claiming Broadcast Channels¶

;
; Example Asterisk dialplan configuration for StasisBroadcast()
;
; StasisBroadcast() broadcasts a channel to all connected ARI applications
; (or a filtered subset). The first application to claim the channel wins,
; and the channel is automatically placed under Stasis control with that
; application -- exactly as if Stasis(winner_app) had been called.
;
; If no application claims within the timeout, STASISSTATUS is set to
; "TIMEOUT" and control returns to the dialplan for fallback handling.
;
; Channel variables set by StasisBroadcast():
;   STASISSTATUS = SUCCESS | FAILED | TIMEOUT
;
; Syntax (all arguments are positional and optional):
;   StasisBroadcast([timeout[,app_filter[,args[,notify_claimed]]]])
;
;   timeout         Claim timeout in ms (default: 500, max: 60000)
;   app_filter      Regex: only broadcast to matching app names
;   args            Colon-delimited args passed to the winner via StasisStart
;   notify_claimed  Send CallClaimed event to filtered apps (default: no)
;

[general]

; Basic broadcast -- all ARI apps, default 500 ms timeout
[broadcast-basic]
exten => _X.,1,NoOp(Incoming call from ${CALLERID(num)} to ${EXTEN})
 same => n,StasisBroadcast()
 same => n,GotoIf($["${STASISSTATUS}"="TIMEOUT"]?no_route)
 same => n,Hangup()
 same => n(no_route),Playback(sorry-no-agent-available)
 same => n,Hangup()

; Custom timeout (2 s) and application filter
[broadcast-filtered]
exten => _X.,1,NoOp(Sales call routing)
 same => n,StasisBroadcast(2000,^sales_.*)
 same => n,GotoIf($["${STASISSTATUS}"="TIMEOUT"]?no_route)
 same => n,Hangup()
 same => n(no_route),Playback(sorry-sales-closed)
 same => n,Hangup()

; Arguments passed to the winning application
; Args appear in the StasisStart event, just like Stasis(app,arg1:arg2)
[broadcast-with-args]
exten => _X.,1,NoOp(Support call with context args)
 same => n,StasisBroadcast(2000,^support_.*,tier1:english)
 same => n,GotoIf($["${STASISSTATUS}"="TIMEOUT"]?no_route)
 same => n,Hangup()
 same => n(no_route),Playback(sorry-support-unavailable)
 same => n,Hangup()

; Skill-based routing using channel variables
; ARI apps receive channel variables in the CallBroadcast event
; (requires the variable names to be listed in ari.conf "channelvars")
; and can decide whether to claim based on them
[broadcast-skillbased]
exten => _X.,1,NoOp(Skill-based routing)
 same => n,Set(CHANNEL(language)=en)
 same => n,Set(SKILL_REQUIRED=advanced)
 same => n,Set(PRIORITY=high)
 same => n,StasisBroadcast(3000,^agent_.*)
 same => n,GotoIf($["${STASISSTATUS}"="TIMEOUT"]?no_route)
 same => n,Hangup()
 same => n(no_route),NoOp(No qualified agent available)
 same => n,Playback(please-hold)
 same => n,Queue(default-queue)
 same => n,Hangup()

; Broadcast with CallClaimed notifications enabled for observability
; notify_claimed=yes sends a CallClaimed event to all filtered apps
; when a channel is claimed (disabled by default to reduce traffic)
[broadcast-with-notify]
exten => _X.,1,NoOp(Broadcast with claim notifications)
 same => n,StasisBroadcast(500,^agent_.*,,yes)
 same => n,GotoIf($["${STASISSTATUS}"="TIMEOUT"]?no_route)
 same => n,Hangup()
 same => n(no_route),Playback(sorry-no-agent-available)
 same => n,Hangup()

; Fallback to traditional queue if no ARI app claims
[broadcast-with-fallback]
exten => _X.,1,NoOp(Broadcast with queue fallback)
 same => n,StasisBroadcast(500,^premium_.*)
 same => n,GotoIf($["${STASISSTATUS}"="TIMEOUT"]?fallback)
 same => n,Hangup()
 same => n(fallback),NoOp(No premium agent, falling back to queue)
 same => n,Queue(default-queue,t,,,60)
 same => n,Playback(goodbye)
 same => n,Hangup()

; Only notify applications whose names start with "billing_"
exten => 3000,1,StasisBroadcast(1000,^billing_)

; Notify apps matching either "sales" or "support"
exten => 4000,1,StasisBroadcast(1000,sales|support)

; Use a channel variable to build the regex dynamically
; (dialplan variables are expanded before the application sees its arguments)
exten => 5000,1,Set(REGION=eu-west)
 same => n,StasisBroadcast(2000,^agent-${REGION}-.*)

exten => _1XXX,1,NoOp()
 same => n,Set(SKILL_REQUIRED=billing)
 same => n,Set(PRIORITY=high)
 same => n,StasisBroadcast(1000)

[default]
exten => _X.,1,Answer()
 same => n,StasisBroadcast(2000)   ; wait up to 2 seconds

 ; --- Handle all outcomes ---
 same => n,GotoIf($["${STASISSTATUS}" = "SUCCESS"]?done)
 same => n,GotoIf($["${STASISSTATUS}" = "FAILED"]?failed)
 ; TIMEOUT: no agent claimed the call
 same => n,Playback(sorry-no-agent)
 same => n,Hangup()

 same => n(done),Hangup()

 same => n(failed),Playback(an-error-has-occured)
 same => n,Hangup()

exten => 5000,1,StasisBroadcast(1000,,queue-a:priority-high)