Special Actions using X-AC-Action SIP Header
You can use AudioCodes proprietary SIP header, X-AC-Action in message manipulation rules to trigger certain actions. These actions can be used to support, for example, interworking of SIP-I and SIP endpoints for the ISUP SPIROU variant.
The following actions are supported by the X-AC-Action header:
■ | To disconnect a call (optionally, after a user-defined time): |
X-AC-Action: 'disconnect' X-AC-Action: 'disconnect;delay=<time in ms>'
■ | To resume a previously suspended call: |
X-AC-Action: 'abort-disconnect'
■ | To automatically reply to a message without forwarding the response to the other side: |
X-AC-Action: 'reply'
■ | To automatically reply to a message with a specific SIP response without forwarding the response to the other side: |
X-AC-Action: 'reply;response=<response code, e.g., 200>]'
■ | To override the device's handling of SIP REFER messages for SBC calls, configured by the 'Remote Refer Mode' (IpProfile_SBCRemoteReferBehavior) parameter. The X-AC-Action header can be added to the incoming SIP REFER request using Message Manipulation rules. This is useful if you don’t want the settings of this parameter to apply to all calls that are associated with the IP Profile. For example, if you configure the 'Remote Refer Mode' parameter to Handle Locally, all incoming SIP REFER requests associated with the IP Profile are terminated at the device. However, you can configure a Message Manipulation rule with the proprietary header to override this parameter setting and allow the device to forward the REFER requests as is for calls with a specific URI, for example. You can configure Message Manipulation rules to add this X-AC-Action header for REFER handling, with one of the following values: |
● | To allow the device to forward the REFER as is, regardless of the 'Remote Refer Mode' parameter settings: |
X-AC-Action: 'use-config;refer-behavior=regular'
● | To allow the device to handle (terminate) the REFER request regardless of the 'Remote Refer Mode' parameter settings: |
X-AC-Action: 'use-config;refer-behavior= handle-locally'
■ | To switch to a different IP Profile for the call (re-INVITE only), as defined in the IP Group: |
X-AC-Action: 'switch-profile;profile-name=<IP Profile Name>' X-AC-Action: 'switch-profile;profile-name=<IP Profile Name>;reason=<PoorInVoiceQuality or PoorInVoiceQualityFailure>]'
If the IP Profile name contains one or more spaces (e.g., "ITSP NET"), enclose the name in double quotation marks, for example:
X-AC-Action: 'switch-profile;profile-name="ITSP NET"'
The X-AC-Action header for triggering the actions disconnect, abort-disconnect, and reply is supported only for the following SIP messages (methods):
● | re-INVITE |
● | UPDATE |
● | INFO |
● | REFER |
The following table provides examples of the X-AC-Action header.
X-AC-Action Header Manipulation Rule Example
Message Type |
Condition |
Action |
Action Type |
Action |
Description |
---|---|---|---|---|---|
info.request |
body.isup.sus exists |
header.x-ac-action |
Modify |
'disconnect;delay=3000,reply' |
Disconnects a call after 3 seconds if the received SIP INFO message contains the ISUP SUS field. |
reinvite.request |
body.sdp regex (.*)(m=audio 7550 RTP/AVP)(.*) |
header.x-ac-action |
Add |
'switch-profile;profile-name=ITSP-Profile-2' |
If a re-INVITE message is received and whose media port value is 7550, the device adds the SIP header "X-AC-Action: switch-profile;profile-name=ITSP-Profile-2"to the incoming re-INVITE message. As a result of receiving this manipulated message, the device starts using IP Profile "ITSP-Profile-2" instead of "ITSP-Profile-1", for the IP Group to which the rule is applied. |