NLnlpearl
Call

Get Call

Retrieves all the information about a call

get/v1/Call/{callId}

Request

Path parameters

callIdstring required

The unique identifier of the call to retrieve information for.

Response

Client informations

idstring nullable

The unique identifier of the call.

pearlIdstring nullable

The unique identifier of the Pearl (API v2).

relatedIdstring nullable

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

leadIdstring nullable

If the call is outbound, this is the unique identifier of the lead that was called. Otherwise, this value is null.

startTimestring date-time nullable

The date and time when the call processing started.

conversationStatusinteger

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

40 - OnGoing

70 - VoiceMailLeft

100 - Success

110 - NotSuccessful

130 - Completed

150 - Unreachable

220 - Blacklisted

300 - QueueAbandon

500 - Error

statusinteger

Represents the current status of a call.

3 - InProgress

4 - Completed

5 - Busy

6 - Failed

7 - NoAnswer

8 - Canceled

10 - OnGoingText

fromstring nullable

The phone number from which the call was made.

tostring nullable

The phone number to which the call was made.

namestring nullable

The name associated with the call, if available.

durationinteger

The duration of the call in seconds.

recordingstring nullable

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

summarystring nullable

A summary of the conversation.

tagsstring[] nullable

The tags or labels triggered during the conversation

isCallTransferredboolean

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

overallSentimentinteger

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

1 - Negative

2 - SlightlyNegative

3 - Neutral

4 - SlightlyPositive

5 - Positive

queueDurationinteger nullable

The time (in seconds) the user spent in the queue, before being connected or transferred to an agent. (inbound only)

creditDebitedinteger

The total amount of credits debited for the entire conversation.

smsCreditDebitedinteger

The total amount of credits debited for SMS usage during this conversation.

Changes

No recorded changes to this operation across all 1 revision of this API.