Sending SIP headers

This section describes configuration related to SIP headers.

Sending SIP header values to bot

By default, VoiceAI Connect sends specific SIP headers received in the INVITE request, to the bot in the start message (see Call initiation). However, you can customize this initial message to include additional headers (parameters) or even overwrite the values of a default parameter with the value of a specified SIP header.

For example, you might want your bot to receive the date, which is provided by the SIP Date header. This feature allows you to create a new parameter (with your own unique name e.g., "callIdentification") and to obtain the value for that parameter from the SIP X-Conversation-ID header.

In some cases, a specific SIP header may appear more than once in the same SIP message. you can indicate which of those duplicate SIP headers you want to take the value from.

The SBC's Message Manipulation feature can be used to populate a SIP header to send any available information to the bot.

To enable the SBC to forward the SIP headers to VoiceAI Connect (which can then send the selected headers to the bot), make sure that the 'Send SIP headers' parameter on the SBC is set to Yes (default).

This feature is applicable only to VoiceAI Connect Enterprise (Version 2.6 and later).

How do I use it?

This feature is configured by the VoiceAI Connect Administrator using the following bot configuration parameter:

Parameter

Type

Description

sipHeadersToBot

Object

Enables the value of a specified header to be sent in the start message to the bot, using a newly created or existing parameter name.

The syntax is shown below:

"sipHeadersToBot": { 
  "new-parameter-name": "<SIP header whose value to use>"
}

To specify which repeated header (by Index, where 0 is the first concurrence in the SIP message):

"sipHeadersToBot": {
  "new-parameter": "<SIP header whose value to use>.<Index of header>"
}

This example does the following:

  • Assigns the value of SIP header X-Conversation-ID to a newly created "callIdentification" parameter.

  • Overwrites the value of the "callerDisplayName" parameter which is sent by default, by the value of the SIP header X-Calling-User.

  • Assigns the value of the 2nd concurrence of SIP header P-Asserted-Identity to a newly created "assertedId" parameter.

{
  "callIdentification": "X-Conversation-ID",
  "callerDisplayName": "X-Calling-User",
  "assertedId": "P-Asserted-Identity.1"
}

Sending SIP headers for bot to SBC

You can configure VoiceAI Connect to send customized SIP headers and values for the bot to the user (through the SBC). You can configure this functionality for the following:

This feature is applicable only to VoiceAI Connect Enterprise (Version 3.2 and later).

How do I use it?

This feature is configured by the VoiceAI Connect Administrator using the following bot configuration parameter:

Parameter

Type

Description

dialoutSipHeaders

Object

Defines customized SIP headers and values that are sent in the start message to the user for Outbound calling.

The syntax is shown below:

{
   "dialoutSipHeaders":[
      {
         "name":"<name of SIP header>",
         "value":"<value of header>"
      },
      {
         "name":"<name of SIP header2>",
         "value":"<value of header2>"
      }
   ]
}

connectSipHeaders

Object

Defines customized SIP headers and values that are sent in the connect message to the SBC upon a reply from the bot.

The syntax is shown below:

{
   "connectSipHeaders":[
      {
         "name":"<name of SIP header>",
         "value":"<value of header>"
      },
      {
         "name":"<name of SIP header2>",
         "value":"<value of header2>"
      }
   ]
}

ringSipHeaders

Object

Defines customized SIP headers and values that are sent in the ring message to the SBC when bot is ringing.

The syntax is shown below:

{
   "ringSipHeaders":[
      {
         "name":"<name of SIP header>",
         "value":"<value of header>"
      },
      {
         "name":"<name of SIP header2>",
         "value":"<value of header2>"
      }
   ]
}