GET
/
v1
/
Inbound
/
{InboundId}

Authorizations

Authorization
string
headerrequired

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

InboundId
string
required

The unique identifier of the inbound.

Response

200 - text/plain
id
string | null

The unique identifier of the inbound activity.

name
string | null

The name of the inbound activity.

status
integer

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

pearlName
string | null

The name of the Pearl associated with this inbound activity.

totalAgents
integer

The total number of agents allocated to this inbound activity.

phoneNumber
string | null

The phone number associated with this inbound activity.

totalTodayCalls
integer

The total number of calls received today.

totalOngoingCalls
integer

The total number of ongoing calls.

totalOnQueue
integer

The total number of calls currently in the queue.

created
string

The date and time when the inbound activity was created.