v1

latestOpenAPI 3.0.12026-07-2665150231.1 KB

Pearl

Update Inbound Settings

Updates the inbound settings for the specified Pearl. The update applies to the published version of the Pearl: if several versions exist on the platform, only the currently published one is modified.

put/v2/Pearl/{pearlId}/Settings/Inbound

Path parameters

pearlIdstring required

The unique identifier of the Pearl.

Request body

totalAgentsinteger

Total number of agents allocated to this inbound activity.

transcriptOptionsinteger

1 - FullTranscript

2 - SensitiveInfoRemoved

3 - NoTranscript

callWebhookUrlstring nullable

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

phoneNumberIdstring nullable

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.

recordingOptionsboolean

Enables or disables call recording.

isStopRecordingAfterTransferCallboolean nullable

Indicates whether recording should continue after a call is transferred.

waitingSentencestring nullable

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

Max 300 characters only.

isSayQueueDetailsboolean

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

Response

Inbound settings updated successfully.

boolean required