• Home
  • API DETAIL PAGE

GET v1/Shops/{shopId}/VoipCalls

Get a list with all available VoipCalls, for given shop.
REQUEST INFORMATION
Requires Authorization
URI PARAMETERS
NAMEDESCRIPTIONTYPEADDITIONAL INFORMATION
shopIdThe id of the shop.integerRequired
fromDateOptionally specify a from date.dateIs Optional. Default value is (null).
untilDateOptionally specify a from date.dateIs Optional. Default value is (null).
dispostionIdOptionally specify a dispositionId. Answered = 0, NoAnswer = 1, Busy = 2, Other = 3integerIs Optional. Default value is 100.
pageSizeThe max number of items returned. Default this value is 100.integerIs Optional. Default value is 1.
BODY PARAMETERS
None
RESPONSE INFORMATION
RESOURCE DESCRIPTION
A list of the VoipCallBasicInfo objects.
Collection of VoipCallBasicInfo
NAMEDESCRIPTIONTYPEADDITIONAL INFORMATION
IdGets or sets the identifier.integerRequired
ShopIdGets or sets the shop identifier.integerRequired
StartTimestampGets or sets the start timestamp.dateRequired
DurationSecGets or sets the duration seconds.integerRequired
OrderCodeGets or sets the order code.stringNone
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
  }
]
<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>