10. Reference of Actions

The actions are grouped as follows:

10.1. SIP Mediation

Action Name Description Parameters
Set RURI Set request URI to a new value
  • new URI
See Request-URI Modifications.
Prefix RURI user Prefix userpart of request URI
  • prefix string
See Request-URI Modifications.
Set RURI user Replace userpart of request URI
  • new userpart
See Request-URI Modifications.
Append to RURI user Add a suffix to userpart of request URI. The result is accumulated if actions is used multiple times.
  • suffix
See Request-URI Modifications.
Strip RURI User Remove leading characters of userpart of request URI
  • number of leading characters
See Request-URI Modifications.
Set RURI Host Replace hostpart of request URI
  • new hostpart
  See Request-URI Modifications.  
Set RURI Parameter Set request URI parameter
  • parameter name
  • parameter value
See Request-URI Modifications.
Set From Replace From Header Field Value
  • From HF value
See Changing Identity.
Set From display name Replace From Display name
  • new From Display name
See Changing Identity.
Set From User Replace userpart of From URI
  • new From userpart
See Changing Identity.
Set From Host Replace hostname of From URI
  • new From hostname
See Changing Identity.
Set To Replace To Header Field Value
  • To HF value
See Changing Identity.
Set To Display Name Replace To Display name
  • new To Display name
See Changing Identity.
Set To User Replace userpart of To URI
  • new To userpart
See Changing Identity.
Set To Host Replace hostname of To URI
  • new To hostname
See Changing Identity.
UAC auth Authenticate on behalf of UAC against a UAS. Any request passing this action and challenged to authenticate by a downstream server will be resent with credentials passed in the action’s parameters.
  • username
  • password
  • realm
See Changing Identity.
UAS auth Authenticate a UAC against the SBC. Either HA1 or password can be provisioned on the SBC; HA1 is safer as the plaintext password does not need to be saved on the SBC. The HA1 can be calculated as MD5(username:realm:password) or with the tool sbc-calc-ha1 on the command line. Can be used together with provisioned tables and the “Save REGISTER contact in registrar” action to create a full registrar.
  • username
  • realm
  • H(A1) or password
Remove Header Removes all occurences of a header field. The action is applied to initial message, newly added header fields are not removed
  • header field name
See SIP Header Processing.
Add Header Add a new Header Field to a request
  • HF Name
  • HF Value
See SIP Header Processing.
Set header whitelist Removes all but mandatory and white-listed header-fields. Names are comma-separated, case-insensitive and need to specify compact forms explicitely. The list is applied to the final appearance of the INVITE request after all A and R rules have been processed.
  • comma-separated header-field name list
See SIP Header Processing.
Set header blacklist Removes all blacklisted header-fields. Names are comma-separated, case-insensitive and need to specify compact form explicitely The list is applied to the final appearance of the INVITE request after all A and R rules have been processed.
  • comma-separated header-field name list
See SIP Header Processing.
Add Dialog Contact Parameter Add parameters to the Contact URI generated by the SBC
  • Leg: A or B
  • parameter name
  • parameter value
See Other mediation actions.
Set Contact-HF parameter whitelist/blacklist Specify which Contact header field parameters in incoming request to forward downstream.
  • comma-separated list of parameter names
See Other mediation actions.
Forward Contact-HF parameters Forward all Contact header field parameters “as is” downstream.
  • none
See Other mediation actions.
Translate Reply Code Translate SIP reply codes to other value
  • matching reply code
  • new reply code
  • new reason phrase
See Other mediation actions.
Set Max Forwards Reset the number of hops a request can be forwarded to specified value
  • the new value of Max-Forwards header field
See Other mediation actions.
Enable transparent dialog IDs Enforce use of the same dialog IDs on both sides of a call
  • none
See Other mediation actions.
Forward Via-HFs Force the SBC to keep the Via header fields while forwarding the request.
  • none
See Other mediation actions.
Diversion to History-Info converts SIP diversion header-field into History Info
  • none
See Other mediation actions.
Call transfer handling Defines the mode in which REFERs are handled: rejection, local processing or forwarding
  • REFER processing mode
See Other mediation actions.
Handle INVITE with Replaces header Activates internal processing of INVITE with Replaces header
  • none
See INVITE with Replaces handling.
Map Replaces header Activates mapping of dialog identifiers in INVITE with Replaces
  • none
See Mapping Dialog-IDs in INVITEs with Replaces.
Set Content Type whitelists/blacklists Specifies which SIP payload types (such as SDP) will be permitted.
  • comma-separated list of content types
See Other mediation actions.
Enable SIP Session Timer caller-leg Enforce use of Session timer
  • session expiration (sec)
  • minimum expiration (sec)
See Controlling SIP Session Timers (SST).
Enable SIP Session Timer callee-leg Enforce use of Session timer
  • session expiration (sec)
  • minimum expiration (sec)
See Controlling SIP Session Timers (SST).
Add X-Org-ConnID header

The X-Org-ConnID header field contains a unique value that remains constant for the duration of the transaction and any dialog created from this request.

By enabling this action, a X-Org-ConnID header is added to every outgoing initial SIP INVITE request product of this dialog.

The header helps to correlate calls that have been internally redirected (due to a 302 SIP response) or blindly transferred (due to a REFER SIP request).

The value can be retrieved in the CDR by specifying the keyword “$x_org_connid” in the cdr_format (see cc_syslog_cdr.conf).

 

10.2. SDP Mediation

Action Name Description Parameters
Set CODEC Whitelist Remove all but listed codecs from SDP.
  • comma-separated codec-list
See CODEC Filtering.
Set CODEC Blacklist Remove all listed codecs from SDP.
  • comma-separated codec-list
See CODEC Filtering.
Set CODEC Preferences Define the order in which available codecs are chosen.
  • comma-separated codec-list
See CODEC Preference.
Set SDP attribute whitelist/blacklist Removes specified CODEC attributes from SDP payload.
  • comma-separated list of attribute names
See CODEC Preference.
Set Media whitelist Permit only listed media types, audio or video
  • audio,video list
See Media Type Filtering.
Set Media blacklist Remove listed media types, audio or video
  • audio,video list
See Media Type Filtering.
Drop early media Drop early media (audio only).
  • none
See Early Media, Ring Back Tone and Forking.
Drop SDP from 1xx replies Drop SDP from listed 1xx replies
  • list of affected reply codes
See Early Media, Ring Back Tone and Forking.

10.3. Monitoring and Logging

Action Name Description Parameters
Increment SNMP counter Increment an SNMP counter
  • counter name
  • increment
See User Defined Counters.
Log received traffic Log SIP/RTP traffic into PCAP file.
  • log type
  • PCAP file name Use filename with .pcap extension.
See Diagnostics Dashboard.
Log Event Generate custom event
  • event text
See SEMS Parameters.
Set log level

Set a specific log level for this traffic.

Note: The global log level will be applied until this Action is processed.

See Diagnostics Events.
Log Message Use syslog facility
  • log level
  • message text
Log Message for Replies

Report on a transaction that completed with a specific response code. Depending on parameters, such a report can lead to blacklisting or promoting a whitelisted IP address.

Typically used to alarm on requests that were declined because of a possible security risk. The action can report via events, syslog or suggest that the request originator is put on blacklist or promoted on a greylist.

  • reply codes that trigger the reports (comma-separated list or asterisk for any response code)
  • syslog level
  • use syslog
  • send an event
  • Blacklist UAC IP Address
  • Blacklist UAS IP Address
  • Greylist UAC IP Address
  • Greylist UAS IP Address
See Automatic IP Address Blocking and Automatic Proactive Blocking: Greylisting.
Log to grey list Promote a source IP address from greylist to whitelist.
  • label – token that differentiates internally the promotion reason; choose some short descriptive string
See Automatic Proactive Blocking: Greylisting

10.4. Traffic Shaping

Action Name Description Parameters
Limit parallel calls Put a quota on number of parallel calls for some specific part of traffic identified by a key. The limit applies separately to inbound and outbound traffic in A and C rules respectivelly and realm or CA to which the action’s rule is linked unless “global key” is turned on. Exceeding calls attempts are rejected using 403.
  • max number of calls
  • key (optional) that identifies a subset traffic
  • global key
  • SIP header
  • soft limit
  • report abuse
  • SIP response code and phrase
See Traffic Limiting and Shaping.
Limit CAPS Put a quota on number of call attempts per second for a traffic subset identified by a key. The limit applies separately to inbound and outbound traffic in A and C rules respectivelly and realm or CA to which the action’s rule is linked unless “global key” is turned on. Authentication counts towards the limit as well. Exceeding calls attempts are rejected using 403.
  • max number of request per unit of time
  • time unit – lenght in seconds
  • key and global key
  • SIP response code and phrase
  • report abuse
  • soft limit
See Traffic Limiting and Shaping.
Limit Bandwidth per Call Put a quota on RTP traffic in kbps. A rules steer bandwidth for inbound calls, C rules for outbound. Exceeding RTP traffic is dropped.
  • limit (kbps)
  • key and global key
  • SIP response code and phrase
  • soft limit
  • report abuse
See Traffic Limiting and Shaping.
Limit Bandwidth Don’t admit signaling if its codecs in SDP exceed a limit.
  • limit (kbps)
See Traffic Limiting and Shaping.
Set call Timer Terminate a call if it exceeds a limit length.
  • max call length (sec)
See Setting Call Length Limits

10.5. Media Processing

Action Name Description Parameters
Enable RTP anchoring Anchors RTP media to the ABC SBC. Allows to centralize media forwarding. Additionally, ICE connectivity checks and RTP keep-alive can be introduced for anchored calls. If RTP timeout is introduced and no RTP packet appears, the call is terminated. Anchoring is a prerequisity for other media processing such as recording.
  • Force symmetric media
  • Enable intelligent relay (IR)
  • Source IP Header field for IR
  • Offer ICE-lite
  • Offer RTCP feedback
  • Keepalive (sec)
  • timeout (sec)
See Media Anchoring (RTP Relay)
Force RTP/SRTP Enforces conversion to the requested protocol in C-rules. In A-rules it only admits specified protocol and declines requests otherwise.
  • Key exchange mechanism (DTLS/SDES)
See RTP and SRTP Interworking
Activate audio recording Record audio into stereo WAV file.
  • destination
See Audio Recording
Activate transcoding Activate transcoding for list of codecs. Listed codecs are added to SDP and transcoded if selected.
  • comma-separated codec list
See Transcoding
Relay DTMF as AVT RTP Relay DTMF as AVT RTP packets (RFC4733/RFC2833)
  • none
See Other mediation actions.
Relay DTMF as SIP INFO Relay DTMF as SIP INFO
  • none
See Other mediation actions.
Refuse call with audio prompt see SIP Dropping bellow  
join meet-me conference Make a call join a conference.
  • room via keypad
  • Room id
See Onboard Conferencing.
Refuse call with audio prompt: Play an audio announcement and decline an incoming call
  • filename of the announcement relative to the global config option “Prompts/ Base Directory”
  • As Early Media
  • Loop
  • SIP Reply and HF
See Playing Audio Announcements.
Play prompt on final response Play an audio announcement on receipt of a negative final response from downstream
  • SIP responese codes to trigger the announcement
  • As Early Media
  • New response code if “as early media”
  • Optional header fields
  • announcement WAV filename OR ...
  • ... characteristics of a generated ringtone
See Playing Audio Announcements.
Generate Ring-Back Tone Play an audio file or a dual-frequency tone isntead of default ringing tone.
  • on downstream 180: start playing when a 180 response arrives
  • on Timer: start playing if a number of seconds elapses (turned off if zero)
  • Generate Ringtone if turned on, a dual-tone with specified frequencies and durations will be played; otherwise a specified audio file will be used.
  • Loop: when audio file is chosen this option choses whether to play it once or in a loop
See Playing Audio Announcements.
Activate Music On Hold Use this action on a call to play an audio file when a call participant puts the call on hold. It is possible to specify how to signal the onhold status in SDP.
  • music file name
  • playback in loop
  • Hold indication (sendonly, sendrcv, preserve incoming, inactive, rfc2543 0.0.0.0 IP
See Playing Audio Announcements.

10.6. SIP Dropping

Action Name Description Parameters
Reply to request Send a negative response to a SIP request
  • Code
  • Reason phrase
  • optional header field
See Manual SIP Traffic Blocking.
Drop request Drop request silently
  • Event throttling key
See Manual SIP Traffic Blocking.
Allow unsolicited NOTIFYs Allow forwarding NOTIFY requests without a prior subscription (either implicit with REFER, or explicit with SUBSCRIBE).
  • none
See Other mediation actions.

10.7. Scripting

Action Name Description Parameters
Set Call Variable Stores a computing result in an variable. The variable can be tested using the Call Variable condition and/ or referred to from actions using the $V(gui.varname) replacement.
  • variable name
  • variable value
See Binding Rules together with Call Variables.

10.8. Register Processing

Action Name Description Parameters
Enable REGISTER caching Stores a cached copy of REGISTER contacts before forwarding.
  • none
See Registration Handling Configuration Options.
Retarget R-URI from cache Rewrites AoR in request URI with contacts cached using Enable REGISTER caching
  • enable NAT handling
  • enable sticky transport
See Registration Handling Configuration Options.
REGISTER throttling Force UAs to refresh registrations within a time window. Particularly useful to trigger REGISTER-based keep-alives to facilitate NAT traversal.
  • minimum registrar expiration
  • maximum UA expiration
See Registration Handling Configuration Options.
Save REGISTER contact Act as local registrar and store registers locally.
  • none
See Registration Handling Configuration Options.
Restore contract from registrar Restore contact from registrar
  • none
See Registration Handling Configuration Options.

10.9. External Interaction

Action Name Description Parameters
ENUM query make an ENUM dip. The queried value may containt replacement expression, suffix is appended to the query.
  • queried value
  • domain suffix
  • ENUM services
See Enum Queries.
Read call variables over REST Do REST query to given URL and set call variables received in reply.
  • REST URI
See RESTful Interface.
Read call variables Read variables from a provisioned table
  • table name
  • query key
See Provisioned Tables.

10.10. NAT Handling

Action Name Description Parameters
Enable dialog NAT handling. Remember during dialog lifetime where the initial dialog-initiating request came from and sends all subsequent SIP traffic there.
  • none
See NAT Traversal.

10.11. Other

Action Name Description Parameters
Support serial forking proxy Permit to reset early media upon 181-indicated serial forking
  • none
See Early Media, Ring Back Tone and Forking.
Fork Fork a new parallel branch to a URI
  • SIP URI
See Early Media, Ring Back Tone and Forking.