Keystone Developers
Open Keystone
API reference

Console API

Voice calls

2 endpoints.

GET/api/v1/admin/businesses/{business_id}/voice-calls/{call_id}

Front Desk call detail (transcript + analysis)

Parameters

NameInTypeDescription
business_idrequiredpathstring (uuid)
call_idrequiredpathstring (uuid)
authorizationheaderstring | null

Responses

200Successful Response
application/jsonSuccessResponse_VoiceCallDetailData_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredVoiceCallDetailData
VoiceCallDetailData fields
FieldTypeDescription
idrequiredstring
business_idrequiredstring
contact_idstring | null
providerrequiredstring
from_numberstring | null
to_numberstring | null
started_atstring | null
ended_atstring | null
duration_msinteger | null
disconnection_reasonstring | null
transcriptstring | null
summarystring | null
captured_namestring | null
captured_emailstring | null
custom_analysisobject | null
has_recordingrequiredboolean
metadataResponseMetadata | null
ResponseMetadata fields
FieldTypeDescription
paginationPaginationMetadata | null
PaginationMetadata fields
FieldTypeDescription
limitrequiredinteger
next_cursorstring | null
prev_cursorstring | null
has_morerequiredboolean
has_prevbooleandefault false
total_countinteger | null
status_countsobject | null
object | null fields

Map of string to integer

lifecycle_countsLifecycleCounts | null
LifecycleCounts fields
FieldTypeDescription
leadintegerdefault 0
prospectintegerdefault 0
customerintegerdefault 0
former_customerintegerdefault 0
classification_countsClassificationCounts | null
ClassificationCounts fields
FieldTypeDescription
signalobject
object fields

Nested object (not expanded)

touchobject
object fields

Nested object (not expanded)

stageobject
object fields

Nested object (not expanded)

metaResponseMeta | null
ResponseMeta fields
FieldTypeDescription
totalinteger | null
total_countinteger | null
pageinteger | null
per_pageinteger | null
  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/voice-calls/{call_id}/recording

Stream the call recording (audit-logged)

Parameters

NameInTypeDescription
business_idrequiredpathstring (uuid)
call_idrequiredpathstring (uuid)
authorizationheaderstring | null

Responses

200Successful Response
  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.