> For the complete documentation index, see [llms.txt](https://developer.acquire.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.acquire.io/rest-apis/analytics/voip-call-sms.md).
# VoIP - Call SMS
## Calls Overview
`GET` `https://{{account_id}}.acquire.io/api/v1/analytics/voip/calls-overview`
View call metrics including number of calls and the average duration per time period.
#### Query Parameters
| Name | Type | Description |
| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| start\_date | string | Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00) |
| end\_date | string | Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59) |
| offset | 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 | string | json or csv |
#### Headers
| Name | Type | Description |
| ------------- | ------ | --------------------------------- |
| Authorization | string | Bearer \*\*\*YOUR\_API\_KEY\*\*\* |
{% tabs %}
{% tab title="200 " %}
```
{
"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"
}
}
}
```
{% endtab %}
{% endtabs %}
## SMS Metrics
`GET` `https://{{account_id}}.acquire.io/api/v1/analytics/voip/sms-metrics`
See how many SMS messages your team receives and responds to as well as their average response time.
#### Query Parameters
| Name | Type | Description |
| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| start\_date | string | Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00) |
| end\_date | string | Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59) |
| offset | 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 | string | json or csv |
#### Headers
| Name | Type | Description |
| ------------- | ------ | --------------------------------- |
| Authorization | string | Bearer \*\*\*YOUR\_API\_KEY\*\*\* |
{% tabs %}
{% tab title="200 " %}
```
{
"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"
}
}
}
```
{% endtab %}
{% endtabs %}
## Call Analysis
`GET` `https://{{account_id}}.acquire.io/api/v1/analytics/voip/call-analysis`
Retrieve a list of IVR and hold time data.
#### Query Parameters
| Name | Type | Description |
| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| start\_date | string | Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00) |
| end\_date | string | Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59) |
| offset | 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 | string | json or csv |
#### Headers
| Name | Type | Description |
| ------------- | ------ | --------------------------------- |
| Authorization | string | Bearer \*\*\*YOUR\_API\_KEY\*\*\* |
{% tabs %}
{% tab title="200 " %}
```
{
"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"
}
}
}
```
{% endtab %}
{% endtabs %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://developer.acquire.io/rest-apis/analytics/voip-call-sms.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.