tenantCallsummary

GET

tenantCallsummary

RELATED INSIGHTS Assess and evaluate employee's use of headsets based on calls made and received and the duration of calls made/received (by device). Identify users who use headsets most often to ensure support is available. Identify patterns of user behavior re: headsets to help org determine future product orders.Calls are defined by their "Call End Time" in order to calculate call duration and other values. e.g. A call that begins on April 30 at 11:45pm and ends at 12:15am on May 1 will be recorded as occurring: on May 1 between 12:00am and 1:00am in the daily view with a duration of 30 minutes
This dataset is addressing the details. tenantApiCode value of "af0813e6-81c0-4a77-89d2-3338d0277c42" and apikey value of "1hKMMPFMmaldnC0rcohvXN0UX7UeWPjb" can be used as url parameters to test this api for accessing sample data.
Note:
  1. The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only.
  2. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant.
  3. Please register here http://developer.plantronics.com/user/register and generate your apikey for apps when you are ready to integrate with a production tenant data and your app.  

Resource URL

https://oda-sandbox.plantronicsmanager.com /reports/usage/tenant/{tenantApiCode}/callsummary

Query Parameters


Name Values Description
apikey
(required)

Key to access this api.

username

User name of the call

userGroups

User group of the device/s

deviceId

device unique identifiers; Display Id of the device as seen on Plantronics Hub

softphone

softphone names e.g. Skype, Jabra etc.

product

Product names e.g. DA80 etc. For supported products, take a look at products API

callStartFromDateTime
(required)

Start date time range for call start time. ISO 8601 format

callEndToDateTime
(required)

End date time for range call end time. ISO 8601 format

page
(required)

Page of the result, start from 0

count
(required)

count or number of results in a page


Header Parameters


Name Values Description
appId
(required)

Application Unique Id

Request Body

tenantApiCode Tenant Api code of the tenant; Should be a valid hexa decimal af0813e6-81c0-4a77-89d2-3338d0277c42 true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400

    Generic mal formed request.

  • 401

    Unauthorized

  • 403

    Unauthorized token error.

  • 404

    No device entity could be found for the requested device path parameters

  • 422

    One or more of the required parameters not found in the request URI.

  • 500

    Internal server error.

Resource Summary

Security

Content Type

application/json

Category

Call Quality and Analytics

Name Type Description
Name Type Description

Working...