Search Calls

POST

Outbound

{outboundId}

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

required

The start date for filtering the search results.

toDate

string

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.

Response

200

text/plain

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.

Set Activity State Add Lead

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>"
      ]
    }
  ]
}

Account

Call

Pearl

Inbound

Outbound

Authorizations

Path Parameters

Body

Response