Calls
List Calls
Returns all Calls available in the user's ForceManager implementation database.
You will only receive the List of Calls after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
REQUEST
You can apply filters. The order of the parameters does not matter.
| Parameter | Type | Description |
|---|---|---|
| offset | Integer | Define position from which the records must be returned |
| count | Integer | Define the number of results to return |
e.g.
https://api.forcemanager.com/api/v4/users/scores?offset=VALUE&count=VALUE
RESPONSE
This endpoint returns information about all Calls available in the database.
If you didn't apply any page or count number in the header the default number of records in the response is 50.
List of the supported Calls attributes:
| Attribute | Type | Description |
|---|---|---|
| duration | Integer | Duration of the Call, in seconds |
| startDate | String | Moment in which the Call is started |
| endDate | String | Moment in which the Call is ended |
| type | Integer | 0 if it is an incoming Call, 1 if it is an outgoing call, 2 if it is a missed call |
| terminalType | Integer | Set to 1, it is a free field to eventually distinguish the type of terminals |
| phone | String | The called phone number |
| accountId | Integer | Account to which the Call is linked to (see Accounts resource) |
| contactId | Integer | Contact to which the Call is linked to (see Contacts resource) |
| salesRepId | Integer | Unique identifier of the User associated to the Call (see Users resource) |
| opportunityId | Integer | Opportunity to which the Call is linked to (see Opportunities resource) |
| phoneAlias | String | An alias of the phone number, e.g. a Contact name |
| description | String | A descriptive text of the Call content |
| timeZoneId | Integer | TimeZone of the Call (see TimeZones resource) |
| id | Integer | Unique identifier for the Call in ForceManager |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Call |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Call |
| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Call |
| dateCreated | String | Date and time when the Call was created |
| dateDeleted | String | Date and time when the Call was deleted |
| dateUpdated | String | Date and time when the Call was last updated |
| deleted | boolean | If true, the Call has been deleted and archived |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
get/calls
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/calls
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Countstring
Response
List Calls
Changes
No recorded changes to this operation across all 1 revision of this API.