POST v1/Shops/{shopId}/VoipCalls/{voipCallId}/SetHandled

Sets a voip call handled. Can be used on managed and unmanaged voipcalls.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
shopId

Id of shop

integer

Required.

voipCallId

If of VoipCall

integer

Required.

Body Parameters

Set handled arguments

VoipCallSetHandledDto
NameDescriptionTypeAdditional information
Handled

Call is handled

boolean

Required

Note

Agent remarks

string

None.

EmployeeId

Employee that handled the call

integer

Required

MailCategoryId

Array of MailCategoryIds. MailCategories are also used to classify voip calls.

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Handled": true,
  "Note": "sample string 2",
  "EmployeeId": 3,
  "MailCategoryId": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<VoipCallSetHandledDto xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Handled>true</Handled>
  <Note>sample string 2</Note>
  <EmployeeId>3</EmployeeId>
  <MailCategoryId>
    <int>1</int>
    <int>2</int>
  </MailCategoryId>
</VoipCallSetHandledDto>

Response Information

Resource Description

Updated VoipCall

VoipCall
NameDescriptionTypeAdditional 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

Must be 0 (for insert operations)

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.

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:24.5248029+01:00",
  "DurationSec": 8,
  "CallType": 0,
  "OrderCode": "sample string 9",
  "DispositionId": 10,
  "Handled": true
}