Voice Call

Entity description

A VoiceCall object represents details of a voice call between a client and a staff member. It includes information such as the call duration, status, direction, phone numbers, and recording details.

Properties

NameDescriptionTypeExample
uidUnique identifier of the VoiceCall objectstringd290f1ee-6c54-4b01-90e6-d701748f0851
durationDuration of the call in secondsinteger120
created_atThe time the call was createdstring2021-07-20T14:00:00.000Z
updated_atThe time the call was last updatedstring2021-07-20T14:00:00.000Z
statusThe status of the call (incoming call, answered by staff, missed, answered by vonage)stringanswered by staff
directionIndicates whether the call is inbound or outbound (inbound, outbound)stringinbound
staff_uidUnique identifier of the staff member who answered the callstringd290f1ee-6c54-4b01-90e6-d701748f0851
client_uidUnique identifier of the client who made the callstringd290f1ee-6c54-4b01-90e6-d701748f0851
from_numberThe phone number the call was made fromstring183466347342
to_numberThe phone number the call was made tostring183466347342
recording_urlLink to the call recordingstringhttps://example.com/recording.mp3
call_summaryText summary of the callstringClient called to ask about their account balance
external_app_urlLink to an application page with additional details about the callstringhttps://example.com/call-details
deleted_atTime the call was deleted (null if not deleted)stringnull

Example

{
  "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",
  "deleted_at": null
}