v1

latestOpenAPI 3.0.12026-07-2665150231.1 KB
Pearl

Get Pearl Settings

Retrieves the Settings for the specified Pearl. The shape of the response depends on the Pearl: the Pearl section is a Simple Pearl configuration (opening sentence + flow script) or a Pearl configuration (node graph), and the Inbound/Outbound section carries the voice or the text settings according to the AgentType field (1 = Voice, 2 = Text). AgentType also tells you which update endpoint to use: Update Pearl (Simple Pearl), Update Voice Pearl, or Update Text Pearl.

get/v2/Pearl/{pearlId}/Settings

Path parameters

pearlIdstring required

The unique identifier of the Pearl.

Response

The settings for the specified Pearl: a Simple Pearl, a voice Pearl, or a text Pearl configuration depending on the Pearl.

OR
OR