UCS API

This document provides information about the NG Media Server UCS (Unified Communications Server) API.

Summary

The UCS API (6.1+) enables client applications to manage calls:

• signaling (create call, answer, redirect, hold, transfer, ...)
• conference
• speech (recognition, synthesis, speaker verification, ...)
• recording
• playlist
• tone
• digits (DTMF)

The UCS API is a specific part of the general NG Media Server REST API: it is the "calls" collection of the REST API.

Reference documentation

The UCS API definition file is based on the OpenAPI specification.

The latest UCS API documentation is available at https://ngmediaserver.com/ngmsapi; scroll to the Calls resources. To view the documentation of the Notifications, scroll to the Subscriptions resources, click on POST /subscriptions and then click on the Callbacks tab.

The UCS API definition file of your NG Media Server is available at https://localhost:5081/ngms/ws/api/ucs3.json; replace localhost:5081 with the host name and port of your NG Media Server. The corresponding documentation can be viewed at https://ngmediaserver.com/ngmshub.

Accessing the UCS API

The UCS API must be accessed with the REST over WebSocket protocol.

The corresponding WebSocket URL is wss://localhost:5081/ngms/ucs.

Replace localhost:5081 with the host name and port of your NG Media Server. Authentication username and password must be passed using the HTTP basic authentication mechanism. When the HTTP basic authentication is not available in an environment, a userinfo parameter may be provided in the URL using the format userinfo=username:password

The UCS API Upgrade Guide explains how to upgrade from the Web Services API to the UCS API.

Note: the UCS API may be accessed with the HTTP protocol for test purposes (like with Swagger UI). However subscriptions - to receive Notifications - are not supported by the UCS API with the HTTP protocol.

UCS API Tester

The UCS API Tester web page enables to test calls directly from the UCS API.

Based on the REST over WebSocket protocol, it can also be used as a sample client implementation reference.

History

On October 12, 2020, NG Media introduced the UCS API, superseding the UCS/TEXT API then called the WS (Web Services) API.

The UCS API is based on the REST over WebSocket protocol, a protocol designed to transport CRUD-compliant requests and responses over WebSockets.

Version	Date	News
6.1	October 12, 2020	First release of the UCS API
7	July 20, 2023	SIP cause location support, HLS as the new call recording format
7.3	March 8, 2024	Multi-Channel Call Recording support, sendMessages support