|
Allows scripts, along with SIPGetHeader, 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 be one of:
- User-to-User — One User-to-User header is allowed with outbound calls in the SIPSession Initiated Protocol; used for signaling and controlling multimedia communication sessions such as voice and video calls. Invite message.
- X-* — Any number of custom headers prefixed by "X-" can be included in outgoing SIP Invite messages.
- P-* — Any number of custom headers prefixed by "P-" can be included in outgoing SIP Invite messages, with the following exceptions (headers that can manipulate billing rules):
- p-asserted-identity
- p-charge-info
- HeaderValue
- Header values can be arbitrary data or script variables.
Branches
- Default
- This branch is taken if the SIPPutHeader was successful or an OnError branch is not defined.
- OnError
- This branch is taken if the SIPPutHeader was unsuccessful.
Script Example Using SIPPUTHEADER
Tips and Tricks
- Execute the SIPPutHeader action, multiple times if desired, before execution of a PLACECALL action.
- The same SIPSession Initiated Protocol; used for signaling and controlling multimedia communication sessions such as voice and video calls. header can be put multiple times, which means the same header, with different values, will be repeated in the SIP messages.
- 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.
