Call Trackings

Create CallTracking

Creates a new CallTracking

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
call_Key
required
integer <int32>

ID assigned to the Call. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

auth_Number
string or null <= 20 characters

Authorization number of the claim associated with the call.

call_Destination
string or null <= 32 characters

Identifies the location where the call was received. 'Call Destinations' are configured within 'Call Tracking Configuration'.

call_Length
integer or null <int32>

Identifies the length of the call.

call_Start
string or null <date-time>

Identifies the date and time when the call was started.

call_Status
string or null <= 32 characters

Identifies the status of the call. 'Call Statuses' are configured within 'Call Tracking Configuration'.

call_Type
string or null <= 32 characters

Identifies the type of call. This usually identifies the subject or purpose of the call. 'Call Types' are configured within 'Call Tracking Configuration'.

caller_Type
string or null <= 32 characters

Identifies the type of Caller. 'Caller Types' are configured within 'Call Tracking Configuration'.

contacts_List
boolean or null

Indicates that the associated Caller may be found within the 'Contacts Folder'.

email_Address
string or null <= 128 characters

Email address of the Caller.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

extension
string or null <= 10 characters

Extension of the Caller's phone number.

fax_Number
string or null <= 20 characters

Fax number of the Caller.

first_Name
string or null <= 64 characters

First name of the Caller.

general_Notes
string or null <= 1000 characters

Text area where the User may enter any relevant notes regarding the call.

last_Name
string or null <= 64 characters

Last name of the Caller.

organization
string or null <= 128 characters

Organization that the Caller belongs to.

phone_Country_Code
string or null <= 8 characters

Country code of the Caller's phone number.

phone_Number
string or null <= 20 characters

Phone number of the Caller.

provider_ID
string or null <= 20 characters

ID of the Provider associated with the call.

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/call-trackings
Request samples
{
  • "call_Key": 0,
  • "auth_Number": "string",
  • "call_Destination": "string",
  • "call_Length": 0,
  • "call_Start": "2019-08-24T14:15:22Z",
  • "call_Status": "string",
  • "call_Type": "string",
  • "caller_Type": "string",
  • "contacts_List": true,
  • "email_Address": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "extension": "string",
  • "fax_Number": "string",
  • "first_Name": "string",
  • "general_Notes": "string",
  • "last_Name": "string",
  • "organization": "string",
  • "phone_Country_Code": "string",
  • "phone_Number": "string",
  • "provider_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CallTracking

Lists all CallTracking

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/call-trackings
Request samples 
Response samples 
No sample
Get CallTracking
Gets CallTracking


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
callKey
required
integer <int32> 
Call Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/call-trackings/{callKey}
Request samples 
Response samples 
No sample
Update CallTracking
Updates a specific CallTracking.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
callKey
required
integer <int32> 
Call Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
call_Key
required
integer <int32> 
ID assigned to the Call.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
auth_Number
string or null  <= 20 characters 
Authorization number of the claim associated with the call.


 
call_Destination
string or null  <= 32 characters 
Identifies the location where the call was received. 'Call Destinations' are configured within 'Call Tracking Configuration'.


 
call_Length
integer or null <int32> 
Identifies the length of the call.


 
call_Start
string or null <date-time> 
Identifies the date and time when the call was started.


 
call_Status
string or null  <= 32 characters 
Identifies the status of the call. 'Call Statuses' are configured within 'Call Tracking Configuration'.


 
call_Type
string or null  <= 32 characters 
Identifies the type of call. This usually identifies the subject or purpose of the call. 'Call Types' are configured within 'Call Tracking Configuration'.


 
caller_Type
string or null  <= 32 characters 
Identifies the type of Caller. 'Caller Types' are configured within 'Call Tracking Configuration'.


 
contacts_List
boolean or null
Indicates that the associated Caller may be found within the 'Contacts Folder'.


 
email_Address
string or null  <= 128 characters 
Email address of the Caller.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
extension
string or null  <= 10 characters 
Extension of the Caller's phone number.


 
fax_Number
string or null  <= 20 characters 
Fax number of the Caller.


 
first_Name
string or null  <= 64 characters 
First name of the Caller.


 
general_Notes
string or null  <= 1000 characters 
Text area where the User may enter any relevant notes regarding the call.


 
last_Name
string or null  <= 64 characters 
Last name of the Caller.


 
organization
string or null  <= 128 characters 
Organization that the Caller belongs to.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the Caller's phone number.


 
phone_Number
string or null  <= 20 characters 
Phone number of the Caller.


 
provider_ID
string or null  <= 20 characters 
ID of the Provider associated with the call.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


put/call-trackings/{callKey}
Request samples 
{
  • "call_Key": 0,
  • "auth_Number": "string",
  • "call_Destination": "string",
  • "call_Length": 0,
  • "call_Start": "2019-08-24T14:15:22Z",
  • "call_Status": "string",
  • "call_Type": "string",
  • "caller_Type": "string",
  • "contacts_List": true,
  • "email_Address": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "extension": "string",
  • "fax_Number": "string",
  • "first_Name": "string",
  • "general_Notes": "string",
  • "last_Name": "string",
  • "organization": "string",
  • "phone_Country_Code": "string",
  • "phone_Number": "string",
  • "provider_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CallTracking
Deletes an CallTracking


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
callKey
required
integer <int32> 
Call Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/call-trackings/{callKey}
Request samples 
Create or Update Batch CallTracking
Create or Update multiple CallTracking at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
call_Key
required
integer <int32> 
ID assigned to the Call.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
auth_Number
string or null  <= 20 characters 
Authorization number of the claim associated with the call.


 
call_Destination
string or null  <= 32 characters 
Identifies the location where the call was received. 'Call Destinations' are configured within 'Call Tracking Configuration'.


 
call_Length
integer or null <int32> 
Identifies the length of the call.


 
call_Start
string or null <date-time> 
Identifies the date and time when the call was started.


 
call_Status
string or null  <= 32 characters 
Identifies the status of the call. 'Call Statuses' are configured within 'Call Tracking Configuration'.


 
call_Type
string or null  <= 32 characters 
Identifies the type of call. This usually identifies the subject or purpose of the call. 'Call Types' are configured within 'Call Tracking Configuration'.


 
caller_Type
string or null  <= 32 characters 
Identifies the type of Caller. 'Caller Types' are configured within 'Call Tracking Configuration'.


 
contacts_List
boolean or null
Indicates that the associated Caller may be found within the 'Contacts Folder'.


 
email_Address
string or null  <= 128 characters 
Email address of the Caller.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
extension
string or null  <= 10 characters 
Extension of the Caller's phone number.


 
fax_Number
string or null  <= 20 characters 
Fax number of the Caller.


 
first_Name
string or null  <= 64 characters 
First name of the Caller.


 
general_Notes
string or null  <= 1000 characters 
Text area where the User may enter any relevant notes regarding the call.


 
last_Name
string or null  <= 64 characters 
Last name of the Caller.


 
organization
string or null  <= 128 characters 
Organization that the Caller belongs to.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the Caller's phone number.


 
phone_Number
string or null  <= 20 characters 
Phone number of the Caller.


 
provider_ID
string or null  <= 20 characters 
ID of the Provider associated with the call.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
207
Success


401
Unauthorized


put/call-trackings-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}