Outbound

Search Call Requests

Fetches a list of API call requests associated with a specific outbound identifier. The search criteria, such as filters or pagination options, should be provided in the request body.

post/v1/Outbound/{outboundId}/CallRequest

Request

Base URL
https://api.nlpearl.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v1/Outbound/:outboundId/CallRequest/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

outboundIdstring required

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

Request body

skipinteger

Number of entries to skip for pagination.

limitinteger

Limit on the number of entries to return.

sortPropstring nullable

Property name to sort by.

isAscendingboolean

Whether the sort order is ascending.

fromDatestring date-time required

The start date for filtering the search results.

toDatestring date-time required

The end date for filtering the search results.

Response

A list of API call requests related to the specified outbound ID was successfully retrieved.

countinteger

The total number of items matching the search criteria.

Changes

No recorded changes to this operation across all 1 revision of this API.