How to Configure Inbound and Outbound Rules on CMS via API

Introduction

This document describes how to route calls to a space configured on Cisco Meeting Server (CMS) via Application Programing Interface (API). Cisco introduced a new interactive API reference tool on version 3.0 to see a high level view of the API objects.

Contributed by Jefferson Madriz and Octavio Miralrio, Cisco TAC Engineers.

Prerequisites

Requirements

Cisco recommends that you have knowledge of these topics:

• Session Initiation Protocol (SIP)
• Basic configuration of CMS

Components Used

The information in this document is based on CMS version 3.0.

The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, ensure that you understand the potential impact of any command.

Configuration

Inbound call routing

When an incoming SIP call is routed to the CMS, the Callbridge looks through the configured inbound dial plan rules first and tries to match the domain part of the destination against the rules.

The new interactive API reference tool, can be accessed via Web Interface. Navigate to Configuration > API

In order to check the already created inbound rules, enter the value inboundDialPlanRules in the Filter section. 

The output is the already configured dial rules, as shown in the image:

In this example there is an Inbound rule, that matches anything that comes with domain meet.cmspod02.mxc.lab.

Note: On the Web admin Interface, the table of inbound rules can be configured on the Configuration > Incoming calls page.

In order to create a new Inbound rule, follow the next steps:

1. Navigate to Configuration > API, in Filter field enter: inboundDialPlanRules.
2. Select Create New.

3. Enter the next values, select the appropiate values for the domain you want to route.

Domain: meet.mxc.lab 
Priority: 10 

4. Select Create.
5. Confirm the new rule is created, enter inboundDialPlanRules in the Filter:

Note: Rules with a higher priority value are matched first. In cases where multiple rules have the same priority, the match occurs based on alphabetical order of the domain.

Outboud call rounting

The trunks and proxie configuration to use for outbound calls is based on the destination SIP domain, and must be specified in the outgoing dial plan.

In order to validate already created outbound rules, navigate to Configuration > API and enter outboundDialPlanRules in the Filter.

In order to create a new Outbound rule, follow the next steps:

1. Navigate to Configuration > API, in Filter field enter outboundDialPlanRules.
   
2. Select Create New.
3. Enter the next values, select the appropiate values for the domain you want to route.

Domain name: [Leave blank. Note that this is a special use that allows us to match all domains]

SIP Proxy to use: Enter the Fully Qualified Domain Name (FQDN) of your Cisco Unified Communication Manager (CUCM) or Expressway call control node (IP Address can be used, but FQDN is recommended)

Local contact domain: [Leave blank]

Local from domain: Enter your SIP domain for Meeting Server (for example: meet.mxc.lab)

Trunk type: Standard SIP

Behavior: Continue

Priority: 20

Encryption: Auto

4. Select Add New to save the changes.
5. Validate the new Outbound Rule created, enter outboundDialPlanRules in the Filter:

Verify

1. Create an space on CMS in order to test inbound rules. 
2. Navigate to Configuration > API.
3. In the Filter field enter coSpaces.

. 

4. Select Create New.
5. Enter the next values, select the appropiate values to the space information you want to use.

Name: Test. Human-readeble name that will be shown. 

uri: 5001. The Uniform Resourcfe Identifier (URI) that a SIP system would use to dial in to this coSpace. 

6. You can add more details to each coSpace, like callid, passcode.

7. From an Endpoint that can route calls to CMS, call the Space URI 5001@meet.mxc.lab.
8. Confirm the call is connected successfully.