Set & parse custom SIP headers

​

Parse custom SIP headers for inbound calls

For inbound calls, the custom SIP headers (headers that starts with X- or x-) are automatically received, extracted and available in the call.custom_sip_headers, it’s also automatically added to your collection of dynamic variables, and you can access it within your agent by stripping the X- or x- prefix. There’s no configuration needed for this feature.

For example, if this is the SIP header received for an inbound call:

{
  "X-test-header": "something",
  "X-another-header": "something else",
  "from": "1234567890"
  "to": "0987654321"
}

Then here’s your call.custom_sip_headers field, and they will be added to your dynamic variables.

{
  "test-header": "something",
  "another-header": "something else",
}

If you have already specific dynamic variables with the same name for this inbound call, it will override the value received from the SIP header.

​

Set custom SIP headers for outbound calls

For outbound calls, you can add custom SIP headers as needed. It must starts with X-.

​

Set custom SIP headers for call transfers

For call transfers, you can also add custom SIP headers as needed. It must starts with X-. You can use dynamic variable for your custom SIP header value, so you can pass information extracted from the call to the receiving party.

If you are using:

• Conversation flow agents, check out call transfer node for more details.
• Single / multi agent, check out call transfer function for more details.