The VoiceCall Object

Represents a phone call record, including participants, status, recording and audit timestamps.

Properties

NameDescriptionTypeRequired
uidUnique identifier of the VoiceCall objectstring
durationDuration of the call in secondsinteger
created_atThe time the call was createdstring
updated_atThe time the call was last updatedstring
statusThe status of the callstring (enum: incoming call, answered by staff, missed, answered by vonage)
directionWhether the call is inbound or outboundstring (enum: inbound/outbound)
staff_uidUnique identifier of the staff member who answered the callstring
client_uidUnique identifier of the client who made the callstring
from_numberThe phone number the call was made fromstring
to_numberThe phone number the call was made tostring
recording_urlLink to the call recordingstring
call_summaryText summary of the callstring
external_app_urlLink to an application page with additional details about the call.

| string | | | handled_by_staff_uid | The unique identifier of the staff who handled the call | string | | | handled_at | The date and time when the call was handled | string | | | deleted_at | Time the call was deleted - is null if the call is not deleted | string | |

Example

JSON

{
  "uid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "created_at": "2021-07-20T14:00:00.000Z",
  "updated_at": "2021-07-20T14:00:00.000Z",
  "duration": 120,
  "status": "answered by staff",
  "direction": "inbound",
  "staff_uid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "client_uid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "from_number": "183466347342",
  "to_number": "183466347342",
  "recording_url": "https://example.com/recording.mp3",
  "call_summary": "Client called to ask about their account balance",
  "external_app_url": "https://example.com/call-details",
  "handled_by_staff_uid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "handled_at": "2021-07-20T14:00:00.000Z",
  "deleted_at": null
}