NLnlpearl
Outbound

Get Outbound

Retrieve a specific outbound by its ID

get/v1/Outbound/{outboundId}

Request

Path parameters

outboundIdstring required

The unique identifier of the outbound.

Response

Detailed view of a specific outbound.

idstring nullable

The unique identifier of the outbound activity.

namestring nullable

The name of the outbound activity.

totalLeadsinteger

The total number of leads associated with this outbound activity.

totalLeadsCompletedinteger

The total number of leads that have been completed.

totalLeadsSuccessinteger

The total number of leads that were successfully converted.

phoneNumberstring nullable

The phone number used for this outbound activity.

pearlNamestring nullable

The name of the Pearl associated with this outbound activity.

budgetTotalinteger nullable

The total budget allocated for this outbound activity.

budgetConsumedinteger

The amount of the budget that has been consumed so far.

totalAgentsinteger

The total number of agents allocated to this outbound activity.

totalOngoingCallsinteger

The total number of call now.

statusinteger

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

createdstring date-time

The date and time when the outbound activity was created.

totalTodayCallsinteger

The total number of calls made today during this outbound activity.

Changes

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