GET
/
v1
/
Outbound
/
{outboundId}

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.

Response

200 - text/plain
budgetConsumed
number

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

budgetTotal
number | null

The total budget allocated for this outbound activity.

created
string

The date and time when the outbound activity was created.

id
string | null

The unique identifier of the outbound activity.

name
string | null

The name of the outbound activity.

pearlName
string | null

The name of the Pearl associated with this outbound activity.

phoneNumber
string | null

The phone number used for this outbound activity.

status
integer

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

totalAgents
integer

The total number of agents allocated to this outbound activity.

totalLeads
integer

The total number of leads associated with this outbound activity.

totalLeadsCompleted
integer

The total number of leads that have been completed.

totalLeadsSuccess
integer

The total number of leads that were successfully converted.

totalTodayCalls
integer

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