GET v1/Shops/{shopId}/VoipCalls?fromDate={fromDate}&untilDate={untilDate}&dispostionId={dispostionId}&pageSize={pageSize}&pageNumber={pageNumber}
Get a list with all available VoipCalls, for given shop.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| shopId |
The id of the shop. |
integer |
Required. |
| fromDate |
Optionally specify a from date. |
date |
Is Optional. Default value is (null). |
| untilDate |
Optionally specify an until date. |
date |
Is Optional. Default value is (null). |
| dispostionId |
Optionally specify a dispositionId. Answered = 0, NoAnswer = 1, Busy = 2, Other = 3 |
integer |
Is Optional. Default value is (null). |
| pageSize |
The max number of items returned. Default this value is 100. |
integer |
Is Optional. Default value is 100. |
| pageNumber |
The page to return. Default page 1 will be returned. |
integer |
Is Optional. Default value is 1. |
Body Parameters
None.
Response Information
Resource Description
A list of the VoipCallBasicInfo objects.
Collection of VoipCallBasicInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Gets or sets the identifier. |
integer |
Required |
| ShopId |
Gets or sets the shop identifier. |
integer |
Required |
| StartTimestamp |
Gets or sets the start timestamp. |
date |
Required |
| DurationSec |
Gets or sets the duration seconds. |
integer |
Required |
| CallType |
Gets or sets the Call type. |
CallTypeEnum |
Required |
| OrderCode |
Gets or sets the order code. |
string |
None. |
| DispositionId |
Gets or sets the disposition identifier. |
integer |
Required |
| Handled |
Indication if call was marked Handled by employee |
boolean |
Required |
Response Formats
application/json, text/json
[
{
"Id": 1,
"ShopId": 2,
"StartTimestamp": "2026-01-11T16:17:12.6349492+01:00",
"DurationSec": 4,
"CallType": 0,
"OrderCode": "sample string 5",
"DispositionId": 6,
"Handled": true
},
{
"Id": 1,
"ShopId": 2,
"StartTimestamp": "2026-01-11T16:17:12.6349492+01:00",
"DurationSec": 4,
"CallType": 0,
"OrderCode": "sample string 5",
"DispositionId": 6,
"Handled": true
}
]
application/xml, text/xml
<ArrayOfVoipCallBasicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<VoipCallBasicInfo>
<Id>1</Id>
<ShopId>2</ShopId>
<StartTimestamp>2026-01-11T16:17:12.6349492+01:00</StartTimestamp>
<DurationSec>4</DurationSec>
<CallType>Inbound</CallType>
<OrderCode>sample string 5</OrderCode>
<DispositionId>6</DispositionId>
<Handled>true</Handled>
</VoipCallBasicInfo>
<VoipCallBasicInfo>
<Id>1</Id>
<ShopId>2</ShopId>
<StartTimestamp>2026-01-11T16:17:12.6349492+01:00</StartTimestamp>
<DurationSec>4</DurationSec>
<CallType>Inbound</CallType>
<OrderCode>sample string 5</OrderCode>
<DispositionId>6</DispositionId>
<Handled>true</Handled>
</VoipCallBasicInfo>
</ArrayOfVoipCallBasicInfo>