POST
/
v1
/
Outbound
/
{outboundId}
/
Call
Make Call
curl --request POST \
  --url https://api.nlpearl.ai/v1/Outbound/{outboundId}/Call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "to": "<string>",
  "callData": {}
}'
{
  "id": "<string>",
  "from": "<string>",
  "to": "<string>",
  "queuePosition": 123
}

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 call is being initiated.

Body

The details required to make the outbound phone call, encapsulated in an NLPearl.Core.Models.OutboundMakeCallRequest object.

Defines the request structure for making an outbound call.

​
to
string
required
Minimum length: 1
​
callData
object | null

A dictionary containing additional information about the call. It is used as variables that you can use in "Opening Sentence" or "Flow Script" when you create a Pearl on the platform. The keys represent the field names, and the values contain the corresponding data. This information can be used to personalize the conversation or manage lead-specific details. This parameter is optional. see Variables for more information. Here is an exemple of the json to send: { "email" : "joe@gmail.com", "address": "3 Abbey Road UK" , "carLicense" : "90-929-82" }

Response

The outbound phone call was successfully initiated and the active state is returned.

Defines the result structure for an outbound call operation.

​
id
string | null

The unique identifier for the Request. This Request ID can be used to track or reference the specific call request from Get Call Request.

​
from
string | null

The phone number from which the call was made. This is the originating number used in the outbound call.

​
to
string | null

The phone number to which the call was made. This is the destination number that was dialed.

​
queuePosition
integer

The position of the call in the queue if the call is placed in a waiting queue.