Update Inbound Settings

PUT

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 '
{
  "totalAgents": 123,
  "transcriptOptions": 123,
  "callWebhookUrl": "<string>",
  "phoneNumberId": "<string>",
  "recordingOptions": true,
  "isStopRecordingAfterTransferCall": true,
  "waitingSentence": "<string>",
  "isSayQueueDetails": true
}
'

import requests

url = "https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Inbound"

payload = {
    "totalAgents": 123,
    "transcriptOptions": 123,
    "callWebhookUrl": "<string>",
    "phoneNumberId": "<string>",
    "recordingOptions": True,
    "isStopRecordingAfterTransferCall": True,
    "waitingSentence": "<string>",
    "isSayQueueDetails": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    totalAgents: 123,
    transcriptOptions: 123,
    callWebhookUrl: '<string>',
    phoneNumberId: '<string>',
    recordingOptions: true,
    isStopRecordingAfterTransferCall: true,
    waitingSentence: '<string>',
    isSayQueueDetails: true
  })
};

fetch('https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Inbound', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Inbound",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'totalAgents' => 123,
    'transcriptOptions' => 123,
    'callWebhookUrl' => '<string>',
    'phoneNumberId' => '<string>',
    'recordingOptions' => true,
    'isStopRecordingAfterTransferCall' => true,
    'waitingSentence' => '<string>',
    'isSayQueueDetails' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Inbound"

	payload := strings.NewReader("{\n  \"totalAgents\": 123,\n  \"transcriptOptions\": 123,\n  \"callWebhookUrl\": \"<string>\",\n  \"phoneNumberId\": \"<string>\",\n  \"recordingOptions\": true,\n  \"isStopRecordingAfterTransferCall\": true,\n  \"waitingSentence\": \"<string>\",\n  \"isSayQueueDetails\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Inbound")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"totalAgents\": 123,\n  \"transcriptOptions\": 123,\n  \"callWebhookUrl\": \"<string>\",\n  \"phoneNumberId\": \"<string>\",\n  \"recordingOptions\": true,\n  \"isStopRecordingAfterTransferCall\": true,\n  \"waitingSentence\": \"<string>\",\n  \"isSayQueueDetails\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Inbound")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"totalAgents\": 123,\n  \"transcriptOptions\": 123,\n  \"callWebhookUrl\": \"<string>\",\n  \"phoneNumberId\": \"<string>\",\n  \"recordingOptions\": true,\n  \"isStopRecordingAfterTransferCall\": true,\n  \"waitingSentence\": \"<string>\",\n  \"isSayQueueDetails\": true\n}"

response = http.request(request)
puts response.read_body

true

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

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.

Inbound settings of a voice Pearl.

totalAgents

integer<int32>

Total number of agents allocated to this inbound activity.

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).

phoneNumberId

string | null

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.

recordingOptions

boolean

Enables or disables call recording.

isStopRecordingAfterTransferCall

boolean | null

Indicates whether recording should continue after a call is transferred.

waitingSentence

string | null

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

Max 300 characters only.

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.

Update Outbound SettingsUpdates the outbound 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.

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 '
{
  "totalAgents": 123,
  "transcriptOptions": 123,
  "callWebhookUrl": "<string>",
  "phoneNumberId": "<string>",
  "recordingOptions": true,
  "isStopRecordingAfterTransferCall": true,
  "waitingSentence": "<string>",
  "isSayQueueDetails": true
}
'

import requests

url = "https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Inbound"

payload = {
    "totalAgents": 123,
    "transcriptOptions": 123,
    "callWebhookUrl": "<string>",
    "phoneNumberId": "<string>",
    "recordingOptions": True,
    "isStopRecordingAfterTransferCall": True,
    "waitingSentence": "<string>",
    "isSayQueueDetails": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    totalAgents: 123,
    transcriptOptions: 123,
    callWebhookUrl: '<string>',
    phoneNumberId: '<string>',
    recordingOptions: true,
    isStopRecordingAfterTransferCall: true,
    waitingSentence: '<string>',
    isSayQueueDetails: true
  })
};

fetch('https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Inbound', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Inbound",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'totalAgents' => 123,
    'transcriptOptions' => 123,
    'callWebhookUrl' => '<string>',
    'phoneNumberId' => '<string>',
    'recordingOptions' => true,
    'isStopRecordingAfterTransferCall' => true,
    'waitingSentence' => '<string>',
    'isSayQueueDetails' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Inbound"

	payload := strings.NewReader("{\n  \"totalAgents\": 123,\n  \"transcriptOptions\": 123,\n  \"callWebhookUrl\": \"<string>\",\n  \"phoneNumberId\": \"<string>\",\n  \"recordingOptions\": true,\n  \"isStopRecordingAfterTransferCall\": true,\n  \"waitingSentence\": \"<string>\",\n  \"isSayQueueDetails\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Inbound")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"totalAgents\": 123,\n  \"transcriptOptions\": 123,\n  \"callWebhookUrl\": \"<string>\",\n  \"phoneNumberId\": \"<string>\",\n  \"recordingOptions\": true,\n  \"isStopRecordingAfterTransferCall\": true,\n  \"waitingSentence\": \"<string>\",\n  \"isSayQueueDetails\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Inbound")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"totalAgents\": 123,\n  \"transcriptOptions\": 123,\n  \"callWebhookUrl\": \"<string>\",\n  \"phoneNumberId\": \"<string>\",\n  \"recordingOptions\": true,\n  \"isStopRecordingAfterTransferCall\": true,\n  \"waitingSentence\": \"<string>\",\n  \"isSayQueueDetails\": true\n}"

response = http.request(request)
puts response.read_body

true

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

Getting Started

API V2

API V1

Authorizations

Path Parameters

Body

Response