Get Call Details

Response Format

Parameter

Type

Description

id

String

The unique ID of the call record.

hid

String

The history ID of the call record.

svcID

String

The service account ID was used for the call.

date

String

The date of the call in YYMMDD format, e.g. "20230704"

roomID

String

The ID of the room for the call.

seq

Number

The sequence number of this call.

type

String

The type of the call. It must be a "call".

fromEID

String

The call ID is represented as the staff ID.

toEID

String

The callee (aka called party/receiver) ID of the staff ID.

fromSvcID

String

The service account ID of the caller.

toSvcID

String

The service account ID of the callee (aka called party/receiver).

fromRegion

String

The region of the caller.

callSeq

Number

The sequence number of the call record in the call history.

callID

String

The ID of each call record.

callDirection

String

The call direction. It can be "Inbound" (Inbound Call) or
"Outbound" (Outbound Call).

callType

String

The type of the call. It can be "onnet" (On-net), "offnet"(Off-net) or "smartcall"(Smart Calling).

fromIP

String

The IP address of the caller.

callPrepareFromNum

String

The number of SIP Truck or PSTN for the call.

caller

Number

The caller's phone number.

callee

Number

The callee's (aka called party/receiver) phone number.

callDate

String

The start date and time of the call. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z.

callEndTime

String

The end date and time of the call. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z.

status

String

Call status. Please refer to the Call status table.

lastResponseCode

String

Please refer to the Bye Reason and Last Response Code page for details.

byeReason

String

The reason for how the call ended.
Please refer to the Bye Reason and Last Response Code page for details.

releaseParty

String

The staff who hung up (ended) the call.

mediaType

String

The media type of the record. It can be "audio" (Audio) or "video" (Video).

isRecording

Boolean

True = The call is recorded;
False = The call is not recorded.

hasAudioFile

Boolean

True = The audio file of the call is saved;
False = The audio file of the call is not saved.

recordingEventList.recorderEID

String

The staff EID who recorded the call
recording the call represented as a staff ID.

recordingEventList.startAt

String

The start date and time of recording the call. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z.

recordingEventList.endAt

String

The end date and time of recording the call. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z.

recordingEventList.files.id

string

The file ID of the call record.

recordingEventList.files.name

String

The file name of the call record.

recordingEventList.files.downloadUrl

String

The URL for downloading the call record.

recordingEventList.files.duration

Number

The duration of the recording is in milliseconds.

recordingEventList.files.mimeType

String

The file format of the record. It can be "video' or "mp4".

recordingEventList.files.size

Number

The file size of the record is bytes.

recordingEventList.files.type

Integer

The type of the recording file. The value must be 2 or 3.
2 = Video and 3 = Audio.

recordingEventList.files.isPrivate

Boolean

The value must be True, meaning the call record is privately accessible.

recordType

String

The type of the record. It can be "voicemail", "call", or "conference".

fromRole

String

The role of the caller. It can be "ADMIN"(Administrator), "SUPERVISOR"(Supervisor) or "AGENT"(Agent).

toRole

String

The role of the caller. It can be "ADMIN"(Administrator), "SUPERVISOR"(Supervisor) or "AGENT"(Agent).

fromRoleName

String

The role name of the caller.

toRoleName

String

The role name of the callee (aka called party/receiver).

fromDepartment

String

The caller's department.

toDepartment

String

The callee's (aka called party/receiver) department.

fromDisplayName

String

The display name of the caller.

toDisplayName

String

The display name of the callee (aka called party/receiver).

lastHandledParty

String

The staff handled the call until it ended. The staff represents with the Staff ID.

fromDepartmentID

String

The ID of the caller's department.

toDepartmentID

String

The ID of the callee's (aka called party/receiver) department.

callerFirstName

String

The first name of the caller.

callerLastName

String

The last name of the caller.

calleeFirstName

String

The first name of the callee (aka called party/receiver).

calleeLastName

String

The last name of the callee (aka called party/receiver).

Language