Connect Avaya IP Office to Xima CCaaS via SBC

This article demonstrates how to connect Avaya IP Office to Xima CCaaS.

Article #: 18

How To: Register and authenticate Xima CCaaS with Avaya IP Office

Similar questions: Connecting IPO to Xima CCaaS, linking IPO to Xima CCaaS, registering Xima CCaaS with IPO, authenticating Xima CCaaS with IPO, registering and authenticating Xima CCaaS with IPO

Purpose: To learn how to connect Avaya IP Office to Xima CCaaS using an SBC connection

NOTE: Xima Support will not set up or manage your IP Office or SBC. This document is only meant for demonstration purposes


Before you start with the steps below, there are a few prerequisites:

  • You must be utilizing an SBC (Session Border Controller) with your instance of IP Office

Verify PBX Settings

Create a new User

  1. Open a connection to your IP Office via the Manager utility
  2. Within the User menu, create a new user named XimaCCaaS
  3. Under the User tab, set up the following:
    • Password
    • Extension
    • Profile
      • Should be either "Basic" or "Telephony User"
    • Select "Enable Remote Worker"
    • In the "Working hours User Rights" dropdown, it should be set to Application
  1. Under the Voicemail tab set a "Voicemail Code"
  2. After you save your changes, IPO Manager will ask if you wish to create a new extension, select a new SIP Extension

Set up your new SIP Extension

  1. Navigate to the new SIP extension
  2. Verify that the information looks correct under the Extn tab
  1. Under the VoIP tab, in the Codec Selection section, verify that it displays "G.711 ULAW 64K" under Selected
    • If it does not, change the Codec Selection dropdown to "Custom"
  2. Verify that "Re-invite Supported" is selected
  3. Verify that "Allow Direct Media Path" is NOT selected

Create a new Short Code

  1. Open the Short Code menu within IP Office Manager

  2. Under the Code section, set which range of calls you wish to forward to the new extension

    • In the example below, we will be sending any 5xx to 401 and send tag with CDN
  3. Set Feature to "Dial Extension"

  4. Under Telephone Number create your command to forward calls along to your new extension

  1. Save and make live your changes

Avaya SBC: Configure SBC Settings

Initial Requirements

  • External public static IP Address that needs to be available on your Avaya SBCE
  • An 'Advanced' Networking license on the Avaya SBCE
  • A self-signed certification that is to be shared with Xima Software, if using TLS

SBCE Configuration Steps

  1. Add the new public IP Address to 'Ext_Media_Intl_Cogent'
    1. Navigate to System Management>Device Specific Settings>Media Interface

    2. Select 'Edit'
    3. Once the new menu appears, select 'Add'
    4. Add your new public IP to the list
      • Example shown: ***.***.154.201

    5. Select 'Finish' to Save
  2. Add the new Public IP as a new 'Signaling Interface'
    1. Navigate to System Management>Device Specific Settings>Media Interface
    2. Select 'Add' from the top right corner and a new menu will appear
    3. Give the new signaling interface a new name in the 'Name' field entry
      • The name can be whatever you want, but you will need to remember it
    4. Select the new public IP Address from the drop-down
      • NOTE: If you wish to do TLS (use port 5061), turn it on and provide the self-signed certificate to Xima

    5. Click Finish to save
  3. Create a User Agent (found in Xima's installation guide)
    1. Navigate to System Parameters>User Agents
    2. Select 'Add' top right

    3. A new menu will appear, enter 'Xima CCaaS' in the 'Name' entry field
    4. Enter 'Xima Virtual Handset' in the 'Regular Expression' entry field

    5. Action: Click Finish to save
  4. Create a new Subscriber Flow
    1. Navigate to Network & Flows>End Point Flows>Subscriber Flows
      • NOTE: The image below is shown for illustration purposes only
    2. Action: Click on 'Add' - top right corner - a new menu will appear

    3. Create a Flow Name
      • The name can be whatever you want, but you will need to remember it
    4. Select the URI Group
    5. Select the "User Agent" from the User Agent field entry that you created in the steps above
    6. Ensure that your Signaling Interface is correct
    7. Ensure that your TLS Client Profile is correct

    8. Click Finish to save

Alternate: Configure SBC Settings

  1. You will need to already have the SBC set for remote users but will be tying it to a particular User Agents
  2. Create a Xima CCaaS User Agent
  1. Create a new subscriber flow and add the Xima CCaaS user agent using the pre-assigned Signaling
    & Media Interfaces and the TLS Client Profile
    • NOTE: Please also verify that the setting "Methods Allowed Before REGISTER" is completely blank

  1. Save all of your changes

Xima CCaaS Config

  1. Log into your Xima CCaaS instance via the web portal
  2. Highlight the settings cog and under “Target Platform” add the SIP Domain and SIP Outbound Proxy info for your SBC
  1. Under the “SIP Extensions” enter the info for the SIP extension you created within IP Office
  1. Within the “Call Routing” menu create a new Call Route for each CDN, changing the Value to the required value from the Short Code dialed from the IPO
    • In the example below, we are using 5XX to match our Short Code within the IPO
  1. Set the "Destination" to whichever Skill group you wish those calls to route to