GET v1/VoipCalls/{VoipCallId}
Get detailed information about an VoipCall.
Request Information
Requires Authorization!
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| VoipCallId |
The id of the VoipCall. |
integer |
Required. |
Body Parameters
None.
Response Information
Resource Description
The VoipCall object.
VoipCall
| Name | Description | Type | Additional information |
|---|---|---|---|
| Source |
Gets or sets the source. |
string |
Max length: 50 |
| Destination |
Gets or sets the destination. |
string |
Max length: 50 |
| PbxUniqueId |
Gets or sets the PBX (private branch exchange) unique identifier. |
string |
Max length: 50 |
| Note |
Gets or sets the note. |
string |
Max length: 2147483647 |
| Categories |
Gets or sets the list of the categories. |
Collection of MessageCategoryBasicInfo |
None. |
| EmployeeId |
Gets or sets the employee identifier. |
integer |
None. |
| CustomerId |
Gets or sets the customer identifier. |
integer |
None. |
| OrderId |
Gets or sets the order identifier. |
integer |
None. |
| 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. |
| DispositionId |
Gets or sets the disposition identifier. |
integer |
Required |
Response Formats
application/json, text/json
{
"Source": "sample string 1",
"Destination": "sample string 2",
"PbxUniqueId": "sample string 3",
"Note": "sample string 4",
"Categories": [
{
"Id": 1,
"Name": "sample string 2"
},
{
"Id": 1,
"Name": "sample string 2"
}
],
"EmployeeId": 1,
"CustomerId": 1,
"OrderId": 1,
"Id": 5,
"ShopId": 6,
"StartTimestamp": "2026-04-03T18:25:29.8111014+02:00",
"DurationSec": 8,
"OrderCode": "sample string 9",
"DispositionId": 10
}
application/xml, text/xml
<VoipCall xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Id>5</Id>
<ShopId>6</ShopId>
<StartTimestamp>2026-04-03T18:25:29.8111014+02:00</StartTimestamp>
<DurationSec>8</DurationSec>
<OrderCode>sample string 9</OrderCode>
<DispositionId>10</DispositionId>
<Source>sample string 1</Source>
<Destination>sample string 2</Destination>
<PbxUniqueId>sample string 3</PbxUniqueId>
<Note>sample string 4</Note>
<Categories>
<MessageCategoryBasicInfo>
<Id>1</Id>
<Name>sample string 2</Name>
</MessageCategoryBasicInfo>
<MessageCategoryBasicInfo>
<Id>1</Id>
<Name>sample string 2</Name>
</MessageCategoryBasicInfo>
</Categories>
<EmployeeId>1</EmployeeId>
<CustomerId>1</CustomerId>
<OrderId>1</OrderId>
</VoipCall>