Conventions and Terminology

The following conventions and terminology will be used in this document: Data will be added using JSON formatted objects and GET, PUT, POST and DELETE methods.

This is the base URL that is implemented in the REST API:https://<mxone-micollab>:22228/api/v1/mxoneCallHistoryApi/pbx/

GET method must be used for reading data. POST method must be used for creating data. PUT method must be used for changing data. DELETE method must be used for deleting data.

All requests will return a standard HTTP response, for example:
  • 200 OK, the request was performed
  • 400 Bad request; the data could not be parsed
  • 401 Authentication failed (unauthorized)
  • 403 Authentication rejected
  • 404 User number not found

  • 500 Internal Server Error

  • 503 Service Unavailable

GET requests return additional data in the response body.

The messages shown in the following figure are used.

Figure 1. Central Call History Messages


Parent topic: Call History REST API — Description
↑