Sign in

v1

latestOpenAPI 3.0.12026-07-2665150231.1 KB
Outbound

Get Lead via Phone Number

Retrieves details of a specific lead within an outbound via phone number

get/v1/Outbound/{outboundId}/Lead/PhoneNumber/{phoneNumber}

Path parameters

outboundIdstring required

The unique identifier of the outbound campaign.

phoneNumberstring required

The phone number of the lead to retrieve.

Response

Details of the specific lead.

idstring nullable

The unique identifier of the lead, represented as an ObjectId.

externalIdstring nullable

The identifier for the lead from an external system, such as a CRM.

phoneNumberstring nullable

The phone number of the lead.

timeZonestring nullable

The time zone of the lead, represented as a float (e.g., -5.0 for EST).

statusinteger

The Status of the lead is the status of the last conversation.

To determine the definition of 'Success' or 'Not Successful,' please refer to the Create a Pearl page at step 4.

1 - New

10 - NeedRetry

20 - InCallQueue

30 - WrongCountryCode

40 - OnCall

70 - VoiceMailLeft

100 - Success

110 - NotSuccessful

130 - Completed

150 - Unreachable

220 - Blacklisted

500 - Error

createdstring date-time

The date and time when the lead was created.

callsIdstring[] nullable

The list of the ID's of all the calls this lead has received.

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" }

collectedDataobject nullable

A dictionary containing all the information collected about the lead during the call.
These values are the result of the conversation and reflect the answers or actions taken by the lead.
The key represents the ID of the variable configured on the platform,
and the value corresponds to the collected data.

This information can be used to understand user intent, track specific responses, or power further automation.
For more details on how variables work, see Variables.

Here is an example of the JSON format: { "confirmBooking": true, "dropOffLocation": "Orly Airport", "rideTime": "Friday at 12:00", "userIntent": "Book a taxi to the airport" }