Sending SIP headers

This section describes configuration related to SIP headers.

Sending SIP header values to the bot

By default, VoiceAI Connect Enterprise sends specific SIP headers received from the SBC to the bot. For bot dial-in calls, the SIP headers are received in the Start message and sent to the bot in the start message (see Call initiation). For bot dial-out calls, SIP headers received in the Connect message can also be sent to the bot.

You can use the sipHeadersToBot parameter to customize which SIP headers are sent to the bot. The same parameter is used for both bot dial-in and bot dial-out calls.

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.

How do I use it?

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

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

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

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

Sending SIP headers from Re-INVITE and UPDATE messages

By default, the SIP headers configured by the sipHeadersToBot parameter are sent to the bot only in the start message, using values received in the initial SIP INVITE request.

By default, the SIP headers configured by the sipHeadersToBot parameter are sent to the bot during call establishment. For bot dial-in calls, the header values are received in the Start message; for bot dial-out calls, they are received in the Connect message. You can also configure VoiceAI Connect Enterprise to send the configured SIP headers to the bot when the SBC receives a SIP re-INVITE or UPDATE request during an active call.

When the SBC receives a SIP re-INVITE or UPDATE request and this feature is enabled, it sends a SessionUpdate message to VoiceAI Connect Enterprise containing the SIP headers received in the request. VoiceAI Connect Enterprise then sends a sessionUpdate event to the bot containing the configured SIP header values.

How do I use it?

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

To enable this feature, add sessionUpdate to the sendEventsToBot parameter:

{
  "sendEventsToBot": [
    "sessionUpdate"
  ]
}

The SIP headers included in the sessionUpdate event are configured using the existing sipHeadersToBot parameter. For example:

{
  "sipHeadersToBot": {
    "fromHeader": "From",
    "pAssertedIdentityHeader": "P-Asserted-Identity"
  }
}

When the SBC receives a SIP re-INVITE or SIP UPDATE request, VoiceAI Connect sends a sessionUpdate event similar to the following:

{
  "type": "sessionUpdate",
  "fromHeader": "sip:alice@example.com",
  "pAssertedIdentityHeader": "sip:+15551234567@example.com"
}

If none of the SIP headers configured in sipHeadersToBot are present in the SIP re-INVITE or SIP UPDATE request, no sessionUpdate event is sent to the bot.

Sending SIP headers from 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:

• Headers sent to user in start message for outbound calling

• Headers sent to user upon a ring or connect message

How do I use it?

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

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

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

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