Get Call

GET

Call

{callId}

Get Call

curl --request GET \
  --url https://api.nlpearl.ai/v2/Call/{callId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nlpearl.ai/v2/Call/{callId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nlpearl.ai/v2/Call/{callId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nlpearl.ai/v2/Call/{callId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.nlpearl.ai/v2/Call/{callId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "pearlId": "<string>",
  "relatedId": "<string>",
  "leadId": "<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,
  "queueDuration": 123,
  "creditDebited": 123,
  "smsCreditDebited": 123,
  "pearlVersion": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

Authorizations

Authorization

string

header

required

Specify the authorization token in the form AccountId:SecretKey, or an OAuth 2.0 access token.

For more information, check out the Authorization Guide and the OAuth 2.0 Guide.

Path Parameters

callId

string

required

Response

Call information

string | null

The unique identifier of the call.

pearlId

string | null

The unique identifier of the Pearl (API v2).

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

leadId

string | null

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

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

35 - InQueue

40 - OnGoing

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

10 - OnGoingText

from

string | null

The phone number from which the call was made.

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.

Show child attributes

summary

string | null

A summary of the conversation.

collectedInfo

object[] | null

A List containing information collected during the call.

Show child attributes

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

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

1 - Negative

2 - SlightlyNegative

3 - Neutral

4 - SlightlyPositive

5 - Positive

queueDuration

integer<int32> | null

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

creditDebited

integer<int32>

The total amount of credits debited for the entire conversation.

smsCreditDebited

integer<int32>

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

pearlVersion

integer<int32> | null

The published version of the Pearl that handled this call. This value is null when no version was recorded for the call.

Get Call

curl --request GET \
  --url https://api.nlpearl.ai/v2/Call/{callId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nlpearl.ai/v2/Call/{callId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nlpearl.ai/v2/Call/{callId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nlpearl.ai/v2/Call/{callId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.nlpearl.ai/v2/Call/{callId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "pearlId": "<string>",
  "relatedId": "<string>",
  "leadId": "<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,
  "queueDuration": 123,
  "creditDebited": 123,
  "smsCreditDebited": 123,
  "pearlVersion": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

Getting Started

API V2

API V1

Authorizations

Path Parameters

Response