Get Raw SIP Headers action

Use the Get Raw SIP Headers action in inbound, in-queue, and secure call flows to get existing BYOC Cloud SIP headers in a string-type variable. From the Architect Toolbox, drag a Get Raw SIP Headers Data action into the appropriate location in the task editor.

Note: This action can only obtain the headers present on the initial INVITE for the conversation in question.
Name Description
Name field Type a distinctive name for the action. The label you enter here becomes the action’s name displayed in the task sequence.
Raw SIP Headers Result

Type a distinctive name for the string-type variable that the Get Raw SIP Headers action uses to return the SIP headers in.
Failure Outputs

These outputs allow the flow author to map the results of any resulting errorType and errorMessage variables when the Get Raw SIP Headers action takes the failure path.

  • errorType: A nonempty string that contains the type or category of the error.
  • errorMessage: A non-localized failure message. The string may be empty or NOT_SET.

Note: Hover over the information icon  next to errorType to display the list of allowable errorType values.

Genesys Cloud checks failure path scenarios and if none of them are met, Genesys Cloud retrieves the Raw SIP headers. You can use the following errorType values:

  • ActionInvocationLimitExceeded: If a flow successfully runs the Get Raw SIP Headers action three times, any subsequent invocations of the action takes the failure path.
  • GeneralError: If there is a general error when retrieving the Raw SIP headers, the Get Raw SIP Headers action takes the failure path.
  • NoSipHeadersExist: If no SIP headers exist, the Get Raw SIP Headers action takes the failure path.