POST
/
v1
/
Outbound
/
{outboundId}
/
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.

Response

200
text/plain

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

Defines the result structure for an outbound call operation.