Message Exchange for Cisco UC-One Console

Overview

Restcomm Message Exchange for Cisco UC-One helps service providers enable their enterprise customers to send and receive SMS using their Unified Communication (UC) client. Enterprise customers can send either two-way SMS or an SMS to multiple destinations.

To understand more about Message Exchange for Cisco UC-One please go through Message Exchange for Cisco UC-One Provisioning API documentation. This document covers the features and functionalities of the Message Exchange for Cisco UC-One JUI Console that leverages the underlying APIs.

Home

This is the default page the user will see after user logs in. Here user can find the number of enterprises, mappings added and messages sent/received in the last 24 hours within the organization and 30 days usage report of enterprises, mapping and messages for an organization

Mappings

To navigate to the page, click on the Mappings on the top header.

Users can view a list of all enterprises that have been added under their organization. Enterprises can be filtered based on the name.

The Enterprise entity represents the service provider customers. Service providers can quickly check the number of mappings created per customer, over a specific period of time.

Each Enterprise has a list of mappings which is basically mapping between SMS enabled number and Jabber Address.

Message Exchange for Cisco UC-One Mappings

Adding an enterprise

Click on the add enterprise button.
Enter the name of new enterprise and click add enterprise button

Enterprise names must be unique.

Enterprise mapping Details

If a user clicks on any enterprise in the list, he will see a paginated list of mappings that belong to the enterprise.
Name is the friendly name given to the user, the number is the external address (SMS enabled number), Jabber Address is the Jabber Address Id that is mapped with the external number and last column contains the timestamp when the mapping was last updated and the user who updated it.
User can edit the name of a particular mapping.
User can delete a particular mapping by clicking on the delete icon that appears by hovering mouse on a specific row.
User can edit domain of a particular mapping.

User can edit enterprise of particular mapping * Click on checkbox * Click on the change enterprise button. * A list of enterprises is shown. * Select one from the list.

Add a mapping

User can reach add mapping page by clicking on the Add Mappings button.
User needs to input below 3 fields:
- Friendly name for the user.
- External address i.e. the number to be SMS enabled.
- Jabber Address.
User can add single or multiple mappings under a particular enterprise.
Jabber Address and number have to be unique across the system.
While adding, if all the mappings are valid then the user will see the mapping list else user will see the rejected mappings where user can modify the Jabber Address or number.
When a mapping is added, the number is provisioned on Restcomm and also the number is SMS enabled by Telestax.

Whitelist

Whitelist Search

To navigate to page, click on the Whitelist on the top header.

User can view list of all Whitelists that have been added under their organization. The Whitelist can be filtered based on the Whitelist Ip.

User can edit the IP by clicking on the pencil icon.

Message Exchange for Cisco UC-One Whitelist

Add Whitelist

Click on add Whitelist Ip button.
Enter the Ip of new Whitelist Ip and click add Whitelist Ip button

Domains

Domains List

To navigate to the page click on the Domains on the top navigation.

User can view a list of all Domains that have been added under their organization. Domains can be filtered based on the Domain name.

User can edit the name of a particular domain by clicking on the pencil icon.

User can view and edit certificate of a particular domain by clicking on the certificate icon of the particular domain

Add Domains

Click on the add Domain button.
Enter the name and certificate of the new domain and click on the add Domain button

Search

Enterprise search

The user can perform a search on the enterprises of the organization. Below are the supported filters for enterprise search: * Account Scope: Search in Current Account: Shows the list of Enterprises that are created by the logged in user. Search in All Account: Shows the list of all the enterprises under the organization. ** Search in Specific Account: To search enterprises that are created by a particular user of the organization, the user is presented with a list of users of that organization in a popup window. The user can select the Restcomm account on that popup window. * Start Date: Shows the list of enterprises that were created on or after this date. * End Date: Shows the list of enterprises that were created on or before this date. * Name: Shows the list of enterprises whose name are partially or fully match with the given String:

Message Exchange for Cisco UC-One Search

User can view details of particular enterprise by clicking any Enterprise in the list .

Mappings search

The user can perform a search on the enterprises of the organization. Below are the supported filters for enterprise search:

Account Scope:
- Search in Current Account: Shows the list of mappings that are created by the logged in user.
- Search in All Account: Shows the list of all the mappings under the organization.
- Search in Specific Account: To search mappings that are created a particular user of the organization, the user is presented with a list of users of that organization in a popup window. The user can select the Restcomm account on that popup window.
Start Date: Shows the list of mappings that were created on or after this date.
End Date: Shows the list of mappings that were created on or before this date.
Enterprise: Shows the list of mappings that belong to this enterprise.
Name: Shows the list of mappings whose name partially or fully match the entered String.
Number: Shows the list of mappings whose external address partially or fully match the entered String.
Jabber Address: Shows the list of mappings whose Jabber Address partially or fully match the entered String.
Domain: Shows the list of mappings whose Domain is matched with the selected domain in dropdown.

User can view details of particular Mapping by clicking any mapping in the list.

Messages search

The user can search the messages of the organization by applying below filters.

Start Date: Shows the list of messages that is created on or after this date.
End Date: Shows the list of messages that is created on or before this date.
Enterprise: Shows the list of messages that belong to this enterprise.
To: Shows the list of messages that are sent to this number or Jabber Address.
From: Shows the list of messages that are sent from this number or Jabber Address.
Direction: Shows the list of messages of particular direction (INBOUND,OUTBOUND). Inbound means messages coming from Mobile to Jabber Address. Outbound means message sent from Jabber Address to Mobile.
Type: Shows the list of messages of particular type(SMS,MMS). Please note MMS is still not supported.
Channel Status: Shows the list of messages with this channel status.
Channel Error Code: Shows the list of messages with this Channel Error Code.
Channel Error Message: Shows the list of messages with this Channel error message.

User can view details of a particular Message by clicking any message in the list .

Usage-records

Enterprise Usage-records

The user can view enterprises created records of the organization by applying below filters.

Account Scope:
- Search in Current Account: Shows the list of mappings that are created by the logged in user.
- Search in All Account: Shows the list of all the mappings under the organization.
- Search in Specific Account: To search mappings that are created a particular user of the organization, the user is presented with a list of users of that organization in a popup window. The user can select the Restcomm account on that popup window.
Start Date: Shows the record of enterprise that has created on or after this date.
End Date: Shows the record of enterprise that has created on or before this date.
Subresource:
- Daily: Shows the record of enterprise on a daily basis.
- Monthly: Shows the record of enterprise on a monthly basis.
- Yearly: Shows the record of enterprise on a yearly basis.
- Today: Shows the record of enterprise today.
- Yesterday: Shows the record of enterprise on yesterday.
- This Month: Shows the record of enterprise this month.
- Last Month: Shows the record of enterprise last month.

Mappings Usage-records

The user can view mappings created records of the organization by applying below filters.

Account Scope:
- Search in Current Account: Shows the list of mappings that are created by the logged in user.
- Search in All Account: Shows the list of all the mappings under the organization.
- Search in Specific Account: To search mappings that are created a particular user of the organization, the user is presented with a list of users of that organization in a popup window. The user can select the Restcomm account on that popup window.
Start Date: Shows the record of mapping that has created on or after this date.
End Date: Shows the record of mapping that has created on or before this date.
Enterprise:Shows the record of mapping that belong to this enterprise.
Subresource:
- Daily: Shows the record of mappings on a daily basis.
- Monthly: Shows the record of mappings on a monthly basis
- Yearly: Shows the record of mappings on a yearly basis.
- Today: Shows the record of mappings today.
- Yesterday: Shows the record of mappings on yesterday.
- This Month: Shows the record of mappings this month.
- Last Month: Shows the record of mappings last month.

Messages Usage-records

The user can view Messages records of the organization by applying below filters.

Start Date: Shows the record of messages that has created on or after this date.
End Date: Shows the record of messages that has created on or before this date.
Enterprise: Shows the record of messages that are belong to this enterprise.
Direction: Shows the record of messages of a particular direction (INBOUND, OUTBOUND).
Type: Shows the record of messages of particular type (SMS,MMS).
To: Shows the record of messages that are sent to this number
From: Shows the record of messages that are sent from this number
Channel Status: Shows the record of messages with this channel status.
Channel Error Code:Shows the record of messages with this Channel Error Code.
Channel Error Message: Shows the record of messages with this Channel error message.

If you would like to explore the Message Exchange for Cisco UC-One Provisioning API, we recommend having a loot at the Getting Started with the Message Exchange for Cisco UC-One API Guide