Sign in

v1

latestOpenAPI 3.0.12026-07-2665150231.1 KB
Outbound

Make Call

Initiates an outbound phone call associated with the specified outbound ID. The request body must contain the necessary details for making the call. Once initiated, the call will be routed to the first available agent.

post/v1/Outbound/{outboundId}/Call

Path parameters

outboundIdstring required

The unique identifier of the outbound campaign for which the call is being initiated.

Request body

tostring required
callDataobject nullable

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 example 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.

idstring nullable

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

fromstring nullable

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

tostring nullable

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

queuePositioninteger

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