Outbound

Get Call Request

Fetches detailed information about a specific API request identified by its unique requestId.

get/v1/Outbound/CallRequest/{requestId}

Request

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

requestIdstring required

The unique identifier of the API request to retrieve.

The details of the API request were successfully retrieved.

idstring nullable

The unique identifier of the API request.

statusinteger

1 - InCallQueue

2 - OnCall

10 - Completed

20 - BlackListed

100 - Error

outboundIdstring nullable

The unique identifier of the outbound campaign associated with this API request.

createdstring date-time

The date and time when the API request was created.

errorsstring[] nullable

A list of errors that occurred during the API request, if any.

callIdstring nullable

The unique identifier of the call associated with this API request, if available.

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