Sipgetheader
![]() |
Allows scripts, along with Sipputheader, to interact with remote SIP This action only affects headers used with a Placecall action. If you need to affect headers for a blind transfer, use the SIPXFERPUTHD action. A setting must be enabled on the SIP trunk groups within the CXone platform to allow for headers to be accepted. Contact your service representative to enable the setting. |
Supported Script Types
![]() |
Phone |
Similar Action
The SIPXFERPUTHD action is similar to Sipputheader, but is for use when doing blind transfers.
Properties
Property | Details |
---|---|
HeaderName |
The name of the header. Must include at least one character. Can include any characters, though only printable ASCII characters can match a SIP |
HeaderValue |
The value of the header. Must include at least one character. |
Branches
Branch | Details |
---|---|
Default |
Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the other branches are not defined. |
OnError | Path taken when the action fails to execute properly. |
Tips & Tricks
- If the same SIP
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 leg
An active piece of a call that connects between routers, gateways, or telephony devices..
- This action only affects headers used with a Placecall action. If you need to affect headers for a blind transfer, use the SIPXFERPUTHD action.