Base URI pattern

REST APIs make use of existing HTTP methods, such as GET and POST requests, to trigger various operations. These operations depend on the HTTP method and the URI pattern that is used.

Here is the base URI pattern for Nuance CEAPI that is built around the customer API domain:

https://{api.domain}/engagementAPI/

Where api.domain is the value of the customer API domain (for example: api.nuance.com).

The general format used for an API request is:

https://{api.domain}/engagementAPI/{version}/{resource-type}/{resource}?{param_list}

Where:

  • resource-type is either customer, agent, or automation

  • resource is one of the calls starting with Agent Availability

Note: Swagger page is only available for version v2:
https://{api.domain}/engagementAPI/v2/customer/swagger-ui/index.html