POST
/
v1
/
Outbound
/
{outboundId}
/
CallRequest
curl --request POST \
  --url https://api.nlpearl.ai/v1/Outbound/{outboundId}/CallRequest \
  --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"
}'
{
  "count": 123,
  "results": [
    {
      "id": "<string>",
      "status": 123,
      "outboundId": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "errors": [
        "<string>"
      ],
      "callId": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
outboundId
string
required

The unique identifier of the outbound campaign for which the API call requests are being retrieved.

Body

The search criteria, including filters or pagination options, provided in the request body.

Extends TableSearch to include date filtering for more specific searches.

​
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
A list of API call requests related to the specified outbound ID was successfully retrieved.
​
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.