Skip to main content
PUT
/
v2
/
Pearl
/
{pearlId}
/
Settings
/
Inbound
Update Inbound Settings
curl --request PUT \
  --url https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Inbound \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumberId": "<string>",
  "waitingSentence": "<string>",
  "totalAgents": 123,
  "recordingOptions": true,
  "isStopRecordingAfterTransferCall": true,
  "transcriptOptions": 123,
  "callWebhookUrl": "<string>",
  "isSayQueueDetails": true
}
'
true

Documentation Index

Fetch the complete documentation index at: https://developers.nlpearl.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
pearlId
string
required

The unique identifier of the Pearl.

Body

The inbound settings to apply.

​
phoneNumberId
string
required

The phone number ID to use for this Pearl. To retrieve available phone numbers, see: Get Phone Numbers

Constraints:

  • A phone number cannot be assigned to more than one active inbound Pearl at the same time.
Minimum string length: 1
​
waitingSentence
string
required

Message played to the caller when no agent is available and the caller is waiting in the queue.

Max 300 characters only.

Minimum string length: 1
​
totalAgents
integer<int32>

Total number of agents allocated to this inbound activity.

​
recordingOptions
boolean

Enables or disables call recording.

​
isStopRecordingAfterTransferCall
boolean | null

Indicates whether recording should continue after a call is transferred.

​
transcriptOptions
integer<int32>

1 - FullTranscript

2 - SensitiveInfoRemoved

3 - NoTranscript

​
callWebhookUrl
string | null

Optional webhook URL to receive call events (for example call started and call ended).

​
isSayQueueDetails
boolean

When enabled, the caller is informed about queue details (for example how many callers are ahead) while waiting.

Response

Inbound settings updated successfully.

The response is of type boolean.