GET
/
v1
/
Call
/
{callId}

Authorizations

Authorization
string
headerrequired

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

callId
string
required

The unique identifier of the call to retrieve information for.

Response

200 - text/plain
id
string | null

The unique identifier of the call.

The ID of the related activity. This could be the OutboundId if the call is an outbound call, the InboundId if the call is an inbound call, or the PearlId if it is a test call.

startTime
string | null

The date and time when the call processing started.

conversationStatus
integer

The outcome of the conversation during the call.

To determine the definition of 'Success' or 'Not Successful,' please refer to the Create a Pearl page at step 4.

10 - NeedRetry

100 - Success

110 - NotSuccessfull

130 - Complete

500 - Error

status
integer

Represents the current status of a call.

3 - InProgress

4 - Completed

5 - Busy

6 - Failed

7 - NoAnswer

8 - Canceled

from
string | null

The phone number from which the call was made.

to
string | null

The phone number to which the call was made.

name
string | null

The name associated with the call, if available.

duration
integer

The duration of the call in seconds.

recording
string | null

The URL of the recording of the call, if available.

transcript
object[] | null

The transcript of the conversation, represented as a list of chat messages.

summary
string | null

A summary of the conversation.

collectedInfo
object[] | null

A List containing informations collected during the call.

tags
string[] | null

The tags or labels triggered during the conversation