PUT v1/Shops/{shopId}/VoipCalls/{voipCallId}

Updates an unmanaged VoipCall. VoipServer needs to be of type 'Generic', can't be used with ShopCtrl managed Asterisk calls.

Request Information

URI Parameters

Name	Description	Type	Additional information
shopId	Id of shop	integer	Required.
voipCallId	If of VoipCall	integer	Required.

Body Parameters

Voip call arguments

UpdateVoipCall

Name	Description	Type	Additional information
Destination	Destination of call. Receiving extension when inbound call, otherwise number which is called (outbound)	string	None.
BillSec	Billable time of call in seconds	integer	Required
TimeInQueue	Optional time in queue in seconds	integer	None.
TimeInIvr	Optional time spend in IVR in seconds	integer	None.
AnnouncementTime	Optional time of announcement in seconds	integer	None.
ForwardTime	Optional time of call that was forwarded to external (overflow) party	integer	None.
Duration	Total duration of call in seconds	integer	None.
Handled	Call is handled	boolean	None.
Note	Agent remarks	string	None.
EmployeeId	Employee that handled the call	integer	None.
Disposition	Disposition of call	DispositionEnum	None.
CallStatus	Status of call	CallStatusEnum	None.
MailCategoryId	Array of MailCategoryIds. MailCategories are also used to classify voip calls.	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Destination": "sample string 1",
  "BillSec": 2,
  "TimeInQueue": 1,
  "TimeInIvr": 1,
  "AnnouncementTime": 1,
  "ForwardTime": 1,
  "Duration": 3,
  "Handled": true,
  "Note": "sample string 4",
  "EmployeeId": 1,
  "Disposition": 0,
  "CallStatus": 0,
  "MailCategoryId": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<UpdateVoipCall xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Destination>sample string 1</Destination>
  <BillSec>2</BillSec>
  <TimeInQueue>1</TimeInQueue>
  <TimeInIvr>1</TimeInIvr>
  <AnnouncementTime>1</AnnouncementTime>
  <ForwardTime>1</ForwardTime>
  <Handled>true</Handled>
  <Note>sample string 4</Note>
  <EmployeeId>1</EmployeeId>
  <Disposition>Answered</Disposition>
  <CallStatus>Unknown</CallStatus>
  <MailCategoryId>
    <int>1</int>
    <int>2</int>
  </MailCategoryId>
</UpdateVoipCall>

Response Information

Resource Description

Updated VoipCall

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 MessageCategory	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
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

Sample:

{
  "Source": "sample string 1",
  "Destination": "sample string 2",
  "PbxUniqueId": "sample string 3",
  "Note": "sample string 4",
  "Categories": null,
  "EmployeeId": 1,
  "CustomerId": 1,
  "OrderId": 1,
  "Id": 5,
  "ShopId": 6,
  "StartTimestamp": "2026-01-11T16:16:36.1944563+01:00",
  "DurationSec": 8,
  "CallType": 0,
  "OrderCode": "sample string 9",
  "DispositionId": 10,
  "Handled": true
}