Skip to main content
GET
/
v2
/
Call
/
{callId}
Get Call
curl --request GET \
  --url https://api.nlpearl.ai/v2/Call/{callId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "pearlId": "<string>",
  "relatedId": "<string>",
  "startTime": "2023-11-07T05:31:56Z",
  "conversationStatus": 123,
  "status": 123,
  "from": "<string>",
  "to": "<string>",
  "name": "<string>",
  "duration": 123,
  "recording": "<string>",
  "transcript": [
    {
      "role": 123,
      "content": "<string>",
      "startTime": 123,
      "endTime": 123
    }
  ],
  "summary": "<string>",
  "collectedInfo": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": "<unknown>"
    }
  ],
  "tags": [
    "<string>"
  ],
  "isCallTransferred": true,
  "overallSentiment": 123
}

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
callId
string
required

Response

Call information

​
id
string | null

The unique identifier of the call.

​
pearlId
string | null

The unique identifier of the Pearl (API v2).

​
relatedId
string | null

The unique identifier of the inbound/outbound (API v1).

​
startTime
string<date-time> | null

The date and time when the call processing started.

​
conversationStatus
integer<int32>

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

20 - InCallQueue

70 - VoiceMailLeft

100 - Success

110 - NotSuccessful

130 - Completed

150 - Unreachable

220 - Blacklisted

300 - QueueAbandon

500 - Error

​
status
integer<int32>

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<int32>

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 information collected during the call.

​
tags
string[] | null

The tags or labels triggered during the conversation

​
isCallTransferred
boolean

Indicates whether the call was transferred to a human or another endpoint.

​
overallSentiment
integer<int32>

Represents the overall emotional tone detected from the client during the conversation.

1 - Negative

2 - SlightlyNegative

3 - Neutral

4 - SlightlyPositive

5 - Positive