Skip to main content
GuidesAPI Reference
Version: 1.0.21

Quality Management and Speech Analytics API

The Quality Management and Speech Analytics (QMSA) API enables you to access raw resources such as interaction metadata, evaluation results, and users.

Authentication​

You can try out this API through request authentication using your client credentials. Refer to Client Credentials on the Getting Started page for more information. All requests must be made over HTTPS - calls made over HTTP will fail.

Regions​

The API resources are available distinctly for each geographical region in which the customer is located or provisioned. The base URLs for regions are as follows:

URL Region
https://api.8x8.com/qm/us-west/v1Western US
https://api.8x8.com/qm/us-east/v1Eastern US
https://api.8x8.com/qm/uk/v1United Kingdom
https://api.8x8.com/qm/ap/v1Australia
https://api.8x8.com/qm/ca/v1Canada

Headers​

With every API call, the header should contain the pbx name from which the data is to be derived. The header key is pbx.

Resource IDs​

The QMSA API uses short non-sequential unique ids. Every resource id must consist of URL friendly characters such as:

  • Uppercase or lowercase letters of the alphabet (A-Z or a-z)

  • Numbers (0-9)

  • Underscores (_) or hyphens (-) The QMSA API uses the following resoruce ids:

  • userReference (e.g., 283) - The unique identifier of the system registered user.

  • interactionGuid (e.g.,int-15bd0b19d21-KKx2fSQPPTD3DRpOS8UfhmgALh-phone-03-sample) - The interaction object's globally unique identifier for a single interaction.

  • customField (e.g., customField1) - One of 25 custom field identifiers.

  • evaluationId (e.g., 45) - The unique identifier for a system evaluation.

Representation of Date and Time​

All exchange of date and time-related data must be completed according to the ISO 8601 standard and stored in UTC. When returning date and time-related data YYYY-MM-DDThh:mm:ss format must be used.

Payload Media Type​

Where applicable the QMSA API requires the use pf the JSON media-type. Requests that contain a message-body use plain JSON to set or update resource states. Content-type: application/json and Accept: application/json headers must be set on all requests if not stated otherwise.

Ordering​

By default, all resources returned in collections are ordered by their creation time in ascending order.

Pagination​

The QMSA API uses URI query pagination to retrieve resource collections. When a resource collection is obtained, the method used to obtain the total count of the type resourced is also returned. The pages must be zero (0) based, and the page size must be a value between 1 and 100. The default value is 100. The answer can contain links to the either the nextPage or previousPage.

HATEOAS​

The QMSA API uses the Spring HATEOAS model for retrieving links to related resources within responses.

Filtering​

The QMSA API is designed with limited filtering capiblities. The filtering that is available in each method is possible only for important key/value pairs. More information on what is avaiable for filtering can be found with each method description.

Error response​

The QMSA API returns both machine-readable error codes and human-readable error messages in the response body when an error occurs.

Versioning​

This API uses URI versioning. Subsequent versions may introduce breaking changes.

Example​

Second version of method: https://api.8x8.com/qm/us-west/V2/method

Authentication​

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

access_token

Contact

QM/SA Team: qm-team@8x8.com