Skip to main content

Sending Custom SIP Headers to Targets

Amanda Cross
Updated

When routing calls to a SIP target, you might need to pass additional information along with the call, such as campaign data, caller details, or internal identifiers. Ringba lets you attach custom SIP headers that contain your additional information to outbound calls when you set up your targets.

Note: This article builds on the information in the Targets guide. If you're not already familiar with targets, you should read that article first. 

This article contains the following sections:

Defining Custom SIP Headers

You define your customer header on the Manage Targets screen. When you select SIP as the number Type, additional fields appear where you can configure the custom headers.

sip_header_fields.png

The SIP Headers fields let you enter a key:value pair to send with every call routed to that target.

Hard-Coded and Dynamic Header Values

When you set the value for your SIP header, you can choose to enter a static value or you can make the header value dynamic based on the value of a tag. 

You should use a hard-coded value when you want to send the same static string every time, such as if you're sending your account ID. To send a hard-coded value, just enter the string you want to send in the value field. For example, 

key account-ID: value 99999

Every call sent to this target includes exactly the header 

account-ID:99999

You should send a dynamic value when you want the header to contain the value of a tag at call time. To send a dynamic value, enter the token that represents the tag whose value you want to send. You can use any valid Ringba tag token.  At call time, Ringba populates the value with the value from the tag.

For example,

key Campaign-Name:value [tag:Campaign:Name]

Every call sent to this target includes a Campaign-Name header with the value from the Campaign:Name tag. 

How to Add a Header

Use the following steps to add a custom SIP header to your calls:

  1. Open the target where you want to add the custom SIP headers.
  2. Make sure the Type field is set to SIP. 
  3. Enter a header name in the key field.  
  4. Enter the header value in the value field. To enter a dynamic value, click the TOKEN button and select the token that represents the tag value you want to include. 
    The header appears in a row below the key:value fields. Note: You can use the trash can icon on the right side of the row to delete the header.
  5. Repeat these steps for each header you want to add.

Custom SIP Header FAQ

What should I do if I need help with SIP headers?

If you have any questions or need additional help, please reach out to our support team via chat or email at support@ringba.com.

Related articles