Skip to main content
POST
/
v2
/
Pearl
/
{pearlId}
/
Calls
/
Bulk
Get Calls Bulk
curl --request POST \
  --url https://api.nlpearl.ai/v2/Pearl/{pearlId}/Calls/Bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fromDate": "2023-11-07T05:31:56Z",
  "toDate": "2023-11-07T05:31:56Z",
  "skip": 123,
  "limit": 123,
  "sortProp": "<string>",
  "isAscending": true,
  "tags": [
    "<string>"
  ],
  "statuses": [
    123
  ],
  "searchInput": "<string>",
  "fields": [
    "<string>"
  ]
}
'
{
  "count": 123,
  "results": [
    {
      "id": "<string>",
      "pearlId": "<string>",
      "relatedId": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "conversationStatus": 123,
      "status": 123,
      "from": "<string>",
      "to": "<string>",
      "duration": 123,
      "tags": [
        "<string>"
      ],
      "name": "<string>",
      "summary": "<string>",
      "recording": "<string>",
      "transcript": [
        {
          "role": 123,
          "content": "<string>",
          "startTime": 123,
          "endTime": 123
        }
      ],
      "collectedInfo": [
        {
          "id": "<string>",
          "name": "<string>",
          "value": "<unknown>"
        }
      ],
      "overallSentiment": 123,
      "isCallTransferred": true,
      "queueDuration": 123,
      "creditDebited": 123,
      "smsCreditDebited": 123,
      "leadId": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
pearlId
string
required

Body

​
fromDate
string<date-time>
required

The start date for filtering the search results.

​
toDate
string<date-time>
required

The end date for filtering the search results.

​
skip
integer<int32>

Number of entries to skip for pagination.

​
limit
integer<int32>

Limit on the number of entries to return.

​
sortProp
string | null

Property name to sort by.

​
isAscending
boolean

Whether the sort order is ascending.

​
tags
string[] | null

List of tags to filter by.

​
statuses
integer<int32>[] | null

List of Status to filter by.

The Status of the lead is the status of the last conversation.

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

1 - New

10 - NeedRetry

20 - InCallQueue

30 - WrongCountryCode

40 - OnCall

70 - VoiceMailLeft

100 - Success

110 - NotSuccessful

130 - Completed

150 - Unreachable

220 - Blacklisted

300 - QueueAbandon

500 - Error

​
searchInput
string | null

Text to filter by.

​
fields
string[] | null

Optional list selecting which additional fields are included in each returned call. Only the requested fields are populated; all others are omitted. Allowed values: Tags, Name, Summary, Recording, Transcript, CollectedInfo, OverallSentiment, IsCallTransferred, QueueDuration, CreditDebited, SmsCreditDebited, LeadId.

Response

Calls within the specified date range, including the requested fields.

​
count
integer<int64>

The total number of items matching the search criteria.

​
results
object[] | null

The list of results for the current page, based on the search criteria.