Inbound

Get Inbound

Retrieves a specific inbound by its ID

get/v1/Inbound/{inboundId}

Request

Base URL
https://api.nlpearl.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v1/Inbound/:inboundId/get.ts
A function with typed inputs. Its response is checked against the schema.

inboundIdstring required

The unique identifier of the inbound.

Details of the specific inbound.

idstring nullable

The unique identifier of the inbound activity.

namestring nullable

The name of the inbound activity.

statusinteger

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

pearlNamestring nullable

The name of the Pearl associated with this inbound activity.

totalAgentsinteger

The total number of agents allocated to this inbound activity.

phoneNumberstring nullable

The phone number associated with this inbound activity.

totalTodayCallsinteger

The total number of calls received today.

totalOngoingCallsinteger

The total number of ongoing calls.

totalOnQueueinteger

The total number of calls currently in the queue.

createdstring date-time

The date and time when the inbound activity was created.

creditUsedinteger

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