REST API

NMS provides RESTful API for submitting calls and performing callbacks through IVR Adapter.

HTTPS transport is used by default (access over HTTP is disabled).

Authentication

Basic HTTP authentication is used to authenticate requests.

Supported Data Flows

Submit Calls

Submits one or more calls to NMS through IVR Adapter.

URL: https://<server>:<port>/nms-ws/nms-c2m/submit-calls

Retrieve Callback Requests

Retrieves all new callback requests. Once given callback is returned by this API it will not be returned again.

URL: https://<server>:<port>/nms-ws/ivr/cb-requests

Submit Callback Responses

Submits callback responses to NMS through IVR Adapter.

URL: https://<server>:<port>/nms-ws/ivr/cb-responses

Detailed information about REST API, such as payload format, is available in form of OpenAPI specifications. Specification for the API to submit calls is available at https://<server>:<port>/nms-ws/openapi-c2m.json.

Specification for callback-related APIs is available at https://<server>:<port>/nms-ws/openapi-ivr.json.