API User Talk Time - Shape Software - Automate your business!

Instructions

Shape Software API

POST API Calls

GET API Calls

User Talk Time

GET api/get/user/talktime

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

Parameters

Get user talk time with these parameters:

Parameter — The user ID is the User’s identifier, this can be found in the “Manage Users” settings page.

Parameter — Using a start and end date range will return the values for the date range used.

Parameter — Using a start and end date range will return the values for the date range used.

Request Header

The authentication token should be passed in the request header for every API request. 

Content-Type: application/json
Authorization=xxxxxxxxxxxxxxxxxxxxxxxx

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 talk time fetched successfully",
    "total_talk_time": "370:41 minutes:seconds"
}

How to Get Field Names

Field names can be found within your CRM System’s settings pages under: Settings > Marketing Sources > Edit Any Marketing Source > Campaign Source Post URL Instructions.

 

After navigating to the marketing sources settings page and opening up a campaign, scroll to the bottom of the page to the “Campaign Source Post URL Instructions” section. Here, you will find a searchable table with a breakdown of all of the field names available for use. These field names can also be exported to a CSV via the “Export” dropdown.