SIPGetHeader
![]() |
Allows scripts, along with SIPPutHeader, to interact with remote SIPSession Initiated Protocol; used for signaling and controlling multimedia communication sessions such as voice and video calls. carriers via SIP headers. A setting must be enabled on the SIP trunk groups within the NICE inContact platform to allow for headers to be accepted. Contact your customer service representative to enable the setting. |
Supported Script Types
![]() |
Phone |
Properties
- HeaderName
- The name of the header. Must include at least one character. Can include any characters, though only printable ASCII characters can match a SIPSession Initiated Protocol; used for signaling and controlling multimedia communication sessions such as voice and video calls. header name.
- HeaderValue
- The value of the header. Must include at least one character.
Branches
- Default
- This branch is taken if the SIPGetHeader was successful or an OnError branch is not defined.
- OnError
- This branch is taken if the SIPGetHeader was unsuccessful.
Tips and Tricks
- If the same SIPSession Initiated Protocol; used for signaling and controlling multimedia communication sessions such as voice and video calls. header is received multiple times in a message, only one of the values for the SIP header can be “got” no matter how many times SIPGetHeader is invoked.
- SIP headers can be sent and received only on the initial SIP Invite message or the final 2xx response to an initial Invite. Only headers that start with “X-“ or “P-“ can be sent and only headers that start with “X-“ can be received.
- If the call with the remote carrier does not use SIP, the SIP header actions have no effect. No SIP header can be sent and no SIP header can be received for the call legAn active piece of a call that connects between routers, gateways, or telephony devices..