Set SIP Header

This block adds a custom SIP header to the INVITE message of an outgoing call or the outgoing leg part of the call.

The custom SIP header starts with the prefix X-

If the Header Name value already starts with X-, it is not changed. If it starts with x-, it is changed to uppercase (for example x-abc becomes X-abc).

If the Header Name value does not start with either of the above, it is prefixed with X- (for example abc becomes X‑abc).

To use, add this block to the Outgoing Call script or to a custom script that is pointed to from the Outgoing call script by a GoTo block. More than one block can be used in the same script. For each block used, CCaaS Designer adds the appropriate header.

Properties

Values

Description

Header Name

String

The name of the added custom SIP header.

Note

  • The name must contain only alphanumeric characters and hyphens (-). The maximum length is 30 characters (including the prefix).
  • It must not be an empty string or just the prefix.

Header Value

String

The value of the added custom SIP header.

Note

  • The value must contain only alphanumeric characters and the following characters: space, comma, hyphen (-), underscore (_), semi-colon (;), plus sign (+), double-quotes (”), and forward slash (/). The maximum length is 200 characters.
  • It must not be an empty string.