Get a list with all available VoipCalls, for given shop.
- Home
- API DETAIL PAGE
GET v1/Shops/{shopId}/VoipCalls
REQUEST INFORMATION
Requires Authorization
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 a from 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 100. |
pageSize | The max number of items returned. Default this value is 100. | 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 |
OrderCode | Gets or sets the order code. | string | None |
RESPONSE FORMATS
- application/json, text/json
- application/xml, text/xml
[
{
"Id": 1,
"ShopId": 2,
"StartTimestamp": "2016-08-22T10:39:10.1667081+02:00",
"DurationSec": 4,
"OrderCode": "sample string 5",
"DispositionId": 6
},
{
"Id": 1,
"ShopId": 2,
"StartTimestamp": "2016-08-22T10:39:10.1667081+02:00",
"DurationSec": 4,
"OrderCode": "sample string 5",
"DispositionId": 6
}
]
{
"Id": 1,
"ShopId": 2,
"StartTimestamp": "2016-08-22T10:39:10.1667081+02:00",
"DurationSec": 4,
"OrderCode": "sample string 5",
"DispositionId": 6
},
{
"Id": 1,
"ShopId": 2,
"StartTimestamp": "2016-08-22T10:39:10.1667081+02:00",
"DurationSec": 4,
"OrderCode": "sample string 5",
"DispositionId": 6
}
]
<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>2016-08-22T10:39:10.1667081+02:00</StartTimestamp>
<DurationSec>4</DurationSec>
<OrderCode>sample string 5</OrderCode>
<DispositionId>6</DispositionId>
</VoipCallBasicInfo>
<VoipCallBasicInfo>
<Id>1</Id>
<ShopId>2</ShopId>
<StartTimestamp>2016-08-22T10:39:10.1667081+02:00</StartTimestamp>
<DurationSec>4</DurationSec>
<OrderCode>sample string 5</OrderCode>
<DispositionId>6</DispositionId>
</VoipCallBasicInfo>
</ArrayOfVoipCallBasicInfo>
<VoipCallBasicInfo>
<Id>1</Id>
<ShopId>2</ShopId>
<StartTimestamp>2016-08-22T10:39:10.1667081+02:00</StartTimestamp>
<DurationSec>4</DurationSec>
<OrderCode>sample string 5</OrderCode>
<DispositionId>6</DispositionId>
</VoipCallBasicInfo>
<VoipCallBasicInfo>
<Id>1</Id>
<ShopId>2</ShopId>
<StartTimestamp>2016-08-22T10:39:10.1667081+02:00</StartTimestamp>
<DurationSec>4</DurationSec>
<OrderCode>sample string 5</OrderCode>
<DispositionId>6</DispositionId>
</VoipCallBasicInfo>
</ArrayOfVoipCallBasicInfo>