POST
/
v1
/
Outbound
/
{outboundId}
/
Calls
Search Calls
curl --request POST \
  --url https://api.nlpearl.ai/v1/Outbound/{outboundId}/Calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "skip": 123,
  "limit": 123,
  "sortProp": "<string>",
  "isAscending": true,
  "fromDate": "2023-11-07T05:31:56Z",
  "toDate": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "statuses": [
    123
  ],
  "searchInput": "<string>"
}'
{
  "count": 123,
  "results": [
    {
      "id": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "conversationStatus": 123,
      "status": 123,
      "from": "<string>",
      "to": "<string>",
      "duration": 123,
      "tags": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
outboundId
string
required

The outbound's unique identifier.

Body

The search criteria including date range and sorting parameters.

​
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

Number of entries to skip for pagination.

​
limit
integer

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

List of Status to filter by.

1 - New

10 - NeedRetry

20 - InCallQueue

30 - WrongCountryCode

40 - OnCall

70 - VoiceMailLeft

100 - Success

110 - NotSuccessfull

130 - Completed

150 - Unreachable

500 - Error

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

130 - Completed

150 - Unreachable

500 - Error

​
searchInput
string | null

Text to filter by.

Response

Calls within the specified date range for the outbound.

​
count
integer

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.