Response Format
Type | Type | Description |
|---|---|---|
hid | String | The record ID. |
roomID | String | The room ID of the call. |
type | String | The type of the call. It can be "call", or "conference". |
status | String | The value can be
|
inquiryID | String | The ID of the call enquiry. |
displayCaseNumber | String | The display enquiry ID of the call. |
callID | String | The ID of the Call. |
callDuration | Number | The time the call spent in seconds. |
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. |
byeReason | String | The value shows the reason behind the call disconnection. Please refer to the Last Response Code & Bye Reason section for details. |
releaseParty | String | The party who ended the call. The value must be "Caller" or "Callee" (Call receiver). |
virtualNumber | Number | The virtual number used for the call. |
mediaType | String | The value must be "audio" when it is an audio call or, "video" when it is a video call. |
callerInfo.countryCode | String | The caller's country. The result is shown in the following format: |
callerInfo.displayName | String | The display name of the caller. |
callerInfo.eid | String | The staff ID of the callee (call receiver / called party). |
callerInfo.isStaff | Boolean | The value must be true or false. It is "true" when the caller is a staff member, while it is "false" when the caller is not. |
callerInfo.phoneNumber | Number | The phone number of the caller. The format is "Country code + Phone number", e.g. +85298765432. |
callerInfo.serviceId | String | The service ID of the caller. |
calleeInfo.displayName | String | The display name of the call receiver. |
calleeInfo.eid | String | The staff ID of the call receiver. |
calleeInfo.ipLocDetail.city | String | The callee's city. If there are no details on the city, an empty value is provided. |
calleeInfo.ipLocDetail.province | String | The callee's province. If there are no details on the city, an empty value is provided. |
calleeInfo.ipLocDetail.regionCode | String | The code of the callee's region. The result is represented in the following format: (Country represented by Two-letter country code based on ISO 3166-2) Example: VE. Country=Venezuela. |
calleeInfo.ipLocDetail.subdivision | String | The subdivision of the callee's country. The result is represented in the following format: (Subdivision represented by the subdivision code of the country based on ISO 3166-2) Example: AU-NSW = New South Wales in Australia. |
calleeInfo.isStaff | Boolean | The value must be true or false. It is "true" when the call receiver is a staff member, while it is "false" when the call receiver is not. |
calleeInfo.serviceId | String | The service ID of the call receiver. |