VoIP - Call SMS

See an overview of all call and SMS interactions.

get
Calls Overview

https://{{account_id}}.acquire.io/api/v1/analytics/voip/calls-overview
View call metrics including number of calls and duration.
Request
Response
Request
Headers
Authorization
required
string
Bearer ***YOUR_API_KEY***
Query Parameters
start_date
required
string
Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00)
end_date
required
string
Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59)
offset
optional
string
This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00
output
optional
string
json or csv
Response
200: OK
{
"data": {
"callsOverview": {
"data": {
"graphRow": {
"labels": [
"16 Mar 2020",
"16 Apr 2020",
"16 May 2020",
"16 Jun 2020",
"16 Jul 2020",
"16 Aug 2020",
"16 Sep 2020",
"16 Oct 2020",
"16 Nov 2020",
"16 Dec 2020",
"16 Jan 2021",
"16 Feb 2021",
"16 Mar 2021"
],
"outgoingCalls": [
0,
0,
0,
0,
0,
0,
7,
3,
19,
2,
0,
5,
0
],
"incomingCalls": [
0,
0,
0,
0,
0,
0,
11,
7,
34,
2,
1,
0,
0
],
"missedCalls": [
0,
0,
0,
0,
0,
0,
6,
0,
8,
2,
1,
0,
0
],
"averageCallTime": [
0,
0,
0,
0,
0,
0,
12,
5.7,
20.75,
0,
0,
37.5,
0
]
},
"summary": {
"outgoingCalls": {
"current": 36,
"previous": 0
},
"incomingCalls": {
"current": 55,
"previous": 0
},
"missedCalls": {
"current": 17,
"previous": 0
},
"averageCallTime": {
"current": 18,
"previous": 0
},
"averageResponseTime": {
"current": 26247,
"previous": 0
}
}
},
"success": true,
"output": "json"
}
}
}

get
SMS Metrics

https://{{account_id}}.acquire.io/api/v1/analytics/voip/sms-metrics
See how many SMS messages your team receives and responds to.
Request
Response
Request
Headers
Authorization
required
string
Bearer ***YOUR_API_KEY***
Query Parameters
start_date
required
string
Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00)
end_date
required
string
Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59)
offset
optional
string
This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00
output
optional
string
json or csv
Response
200: OK
{
"data": {
"smsMetrics": {
"data": {
"graphRow": {
"labels": [
"16 Mar 2020",
"16 Apr 2020",
"16 May 2020",
"16 Jun 2020",
"16 Jul 2020",
"16 Aug 2020",
"16 Sep 2020",
"16 Oct 2020",
"16 Nov 2020",
"16 Dec 2020",
"16 Jan 2021",
"16 Feb 2021",
"16 Mar 2021"
],
"incomingSms": [
0,
0,
0,
0,
0,
0,
2,
1,
17,
0,
0,
0,
0
],
"outgoingSms": [
0,
0,
0,
0,
0,
0,
8,
0,
28,
1,
1,
0,
0
],
"failedSms": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"averageResponseTime": [
0,
0,
0,
0,
0,
0,
0,
0,
458.75,
0,
0,
0,
0
]
},
"summary": {
"outgoingSms": {
"current": 38,
"previous": 0
},
"incomingSms": {
"current": 20,
"previous": 0
},
"failedSms": {
"current": 0,
"previous": 0
},
"averageResponseTime": {
"current": 459,
"previous": null
}
}
},
"success": true,
"output": "json"
}
}
}

get
Call Analysis

https://{{account_id}}.acquire.io/api/v1/analytics/voip/calls-overview
Request
Response
Request
Headers
Authorization
required
string
Bearer ***YOUR_API_KEY***
Query Parameters
start_date
required
string
Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00)
end_date
required
string
Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59)
offset
optional
string
This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00
output
optional
string
json or csv
Response
200: OK
{
"data": {
"callAnalysis": {
"data": {
"graphRow": {
"labels": [
"03 PM",
"04 PM",
"05 PM",
"06 PM",
"07 PM",
"08 PM",
"09 PM",
"10 PM",
"11 PM",
"12 AM",
"01 AM",
"02 AM",
"03 AM",
"04 AM",
"05 AM",
"06 AM",
"07 AM",
"08 AM",
"09 AM",
"10 AM",
"11 AM",
"12 PM",
"01 PM",
"02 PM"
],
"peopleAddedInCall": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"peopleLeftIVR": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"peopleLeftFromHold": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"averageIVRTime": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"averageHoldTime": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
"summary": {
"peopleAddedInCall": {
"current": 0,
"previous": 0
},
"peopleLeftIVR": {
"current": 0,
"previous": 0
},
"peopleLeftFromHold": {
"current": 0,
"previous": 0
},
"averageIVRTime": {
"current": 0
},
"averageHoldTime": {
"current": null,
"previous": 0
}
}
},
"success": true,
"output": "json"
}
}
}