curl --request GET \
--url https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings \
--header 'Authorization: Bearer <token>'{
"name": "<string>",
"type": 123,
"pearl": {
"agents": [
{
"name": "<string>",
"voiceId": "<string>"
}
],
"agentPersonality": "<string>",
"timeZone": "<string>",
"modelType": 123,
"companyName": "<string>",
"companyDescription": "<string>",
"knowledgeBase": "<string>",
"memory": true,
"speechRecognitionKeywords": [
{
"word": "<string>",
"pronunciations": [
"<string>"
]
}
],
"openingSentence": "<string>",
"flowScript": "<string>",
"transferCallSettings": [
{
"transferCallPhoneNumber": "<string>",
"triggerDescription": "<string>",
"warmTransferMessage": "<string>"
}
],
"smsSettings": [
{
"body": "<string>",
"triggerDescription": "<string>"
}
],
"emailSettings": [
{
"subject": "<string>",
"body": "<string>",
"triggerDescription": "<string>",
"smtpSettings": {
"id": "<string>",
"provider": 123,
"smtpServer": "<string>",
"port": 123,
"enableSsl": true,
"senderEmail": "<string>",
"senderPassword": "<string>",
"displayName": "<string>"
}
}
],
"apiSettings": [
{
"name": "<string>",
"method": 123,
"endpointUrl": "<string>",
"body": [
{
"key": "<string>",
"variableId": "<string>",
"type": 123,
"value": "<string>",
"required": true
}
],
"headers": {},
"triggerDescription": "<string>"
}
],
"successDescription": "<string>",
"indicatorTags": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"color": 123
}
],
"notifications": [
{
"apiSettings": {
"name": "<string>",
"method": 123,
"endpointUrl": "<string>",
"body": [
{
"key": "<string>",
"variableId": "<string>",
"type": 123,
"value": "<string>",
"required": true
}
],
"headers": {},
"triggerDescription": "<string>"
},
"emailTemplate": {
"to": [
"<string>"
],
"cc": [
"<string>"
],
"subject": "<string>",
"body": "<string>",
"triggerDescription": "<string>",
"smtpSettings": {
"id": "<string>",
"provider": 123,
"smtpServer": "<string>",
"port": 123,
"enableSsl": true,
"senderEmail": "<string>",
"senderPassword": "<string>",
"displayName": "<string>"
}
},
"indicatorTagsIds": [
"<string>"
]
}
]
},
"variables": [
{
"id": "<string>",
"name": "<string>",
"group": 123,
"type": 123,
"isList": true,
"description": "<string>",
"value": "<string>",
"options": [
{
"value": "<string>",
"code": "<string>"
}
],
"required": true,
"readOnly": true
}
],
"inbound": {
"phoneNumberId": "<string>",
"totalAgents": 123,
"recordingOptions": true,
"isStopRecordingAfterTransferCall": true,
"transcriptOptions": 123,
"callWebhookUrl": "<string>",
"waitingSentence": "<string>",
"isSayQueueDetails": true
},
"outbound": {
"phoneNumberId": "<string>",
"totalAgents": 123,
"recordingTrack": 123,
"isStopRecordingAfterTransferCall": true,
"transcriptOptions": 123,
"budgetTotal": 123,
"timeZone": "<string>",
"maximumCallAttempts": 123,
"minimumRetryIntervalHours": 123,
"ringDuration": 123,
"callTimeout": 123,
"voiceMail": "<string>",
"callingHours": [
{
"day": 123,
"start": "<string>",
"end": "<string>"
}
],
"callWebhookUrl": "<string>",
"leadWebhookUrl": "<string>"
}
}Retrieves the Settings for the specified Pearl. The Pearl and Variables sections in the response are populated only if the Pearl was created via the API. If the Pearl was created through the platform interface, these fields will be returned empty.
curl --request GET \
--url https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings \
--header 'Authorization: Bearer <token>'{
"name": "<string>",
"type": 123,
"pearl": {
"agents": [
{
"name": "<string>",
"voiceId": "<string>"
}
],
"agentPersonality": "<string>",
"timeZone": "<string>",
"modelType": 123,
"companyName": "<string>",
"companyDescription": "<string>",
"knowledgeBase": "<string>",
"memory": true,
"speechRecognitionKeywords": [
{
"word": "<string>",
"pronunciations": [
"<string>"
]
}
],
"openingSentence": "<string>",
"flowScript": "<string>",
"transferCallSettings": [
{
"transferCallPhoneNumber": "<string>",
"triggerDescription": "<string>",
"warmTransferMessage": "<string>"
}
],
"smsSettings": [
{
"body": "<string>",
"triggerDescription": "<string>"
}
],
"emailSettings": [
{
"subject": "<string>",
"body": "<string>",
"triggerDescription": "<string>",
"smtpSettings": {
"id": "<string>",
"provider": 123,
"smtpServer": "<string>",
"port": 123,
"enableSsl": true,
"senderEmail": "<string>",
"senderPassword": "<string>",
"displayName": "<string>"
}
}
],
"apiSettings": [
{
"name": "<string>",
"method": 123,
"endpointUrl": "<string>",
"body": [
{
"key": "<string>",
"variableId": "<string>",
"type": 123,
"value": "<string>",
"required": true
}
],
"headers": {},
"triggerDescription": "<string>"
}
],
"successDescription": "<string>",
"indicatorTags": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"color": 123
}
],
"notifications": [
{
"apiSettings": {
"name": "<string>",
"method": 123,
"endpointUrl": "<string>",
"body": [
{
"key": "<string>",
"variableId": "<string>",
"type": 123,
"value": "<string>",
"required": true
}
],
"headers": {},
"triggerDescription": "<string>"
},
"emailTemplate": {
"to": [
"<string>"
],
"cc": [
"<string>"
],
"subject": "<string>",
"body": "<string>",
"triggerDescription": "<string>",
"smtpSettings": {
"id": "<string>",
"provider": 123,
"smtpServer": "<string>",
"port": 123,
"enableSsl": true,
"senderEmail": "<string>",
"senderPassword": "<string>",
"displayName": "<string>"
}
},
"indicatorTagsIds": [
"<string>"
]
}
]
},
"variables": [
{
"id": "<string>",
"name": "<string>",
"group": 123,
"type": 123,
"isList": true,
"description": "<string>",
"value": "<string>",
"options": [
{
"value": "<string>",
"code": "<string>"
}
],
"required": true,
"readOnly": true
}
],
"inbound": {
"phoneNumberId": "<string>",
"totalAgents": 123,
"recordingOptions": true,
"isStopRecordingAfterTransferCall": true,
"transcriptOptions": 123,
"callWebhookUrl": "<string>",
"waitingSentence": "<string>",
"isSayQueueDetails": true
},
"outbound": {
"phoneNumberId": "<string>",
"totalAgents": 123,
"recordingTrack": 123,
"isStopRecordingAfterTransferCall": true,
"transcriptOptions": 123,
"budgetTotal": 123,
"timeZone": "<string>",
"maximumCallAttempts": 123,
"minimumRetryIntervalHours": 123,
"ringDuration": 123,
"callTimeout": 123,
"voiceMail": "<string>",
"callingHours": [
{
"day": 123,
"start": "<string>",
"end": "<string>"
}
],
"callWebhookUrl": "<string>",
"leadWebhookUrl": "<string>"
}
}Specify the authorization token.
For more information, check out the Authorization Guide.
The unique identifier of the Pearl.
The settings for the specified Pearl.
The name of the Pearl.
Defines the type of activity of the pearl.
1 - Inbound
2 - Outbound
Conversation flow and agent behavior configuration for the Pearl.
This field is populated only if the Pearl was created via the API. If the Pearl was created through the platform interface, this field will be empty.
Show child attributes
Variables defined for the Pearl and used by the agent during conversations.
This field is populated only if the Pearl was created via the API. If the Pearl was created through the platform interface, this field will be empty.
Show child attributes
Inbound settings for the Pearl. Present only when the Pearl type is inbound.
Show child attributes
Outbound settings for the Pearl. Present only when the Pearl type is outbound.
Show child attributes