User Talk Time

Use this API call to gather total talk time for your reps within a particular date range or for all time

GET api/get/user/talktime

To get users’ total talk time, send an authorized GET request to https://secure-api.setshape.com/api/get/user/talktime

Parameters

Get user talk time with these parameters:

  • user_id

    This is required in order for this API call to work. Find the user IDs in the "Manage Users" system settings page.

  • start_date

    Use a start and end date to return values for the date range desired. If no date range is used, the response will give you all time for that user ID.

  • end_date

    Use a start and end date to return values for the date range desired. If no date range is used, the response will give you all time for that user ID.

Request Header

The authentication token must be passed in the request header for every API request. You can find and generate your authentication token in your system settings page under “API Integrations.”

Request Body

JSON request body formatting example:

{

     “user_id”: “10”,

}

Response

Upon success, the server returns HTTP codes and messages in the header with some additional elements and properties that are set by the server, such as id.

{

     “message”: “User total number of calls fetched successfully”,

     “total_calls”: 52

}