Query Sales Agent settings - Lofty Developer API

GET

v2.0

sales-agent

settings

Query Sales Agent settings

curl --request GET \
  --url https://api.lofty.com/v2.0/sales-agent/settings \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.lofty.com/v2.0/sales-agent/settings"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.lofty.com/v2.0/sales-agent/settings', 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.lofty.com/v2.0/sales-agent/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.lofty.com/v2.0/sales-agent/settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.lofty.com/v2.0/sales-agent/settings")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lofty.com/v2.0/sales-agent/settings")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

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

{
  "id": 12345,
  "assistantName": "Anna",
  "headUrl": "https://example.com/avatar.jpg",
  "virtualNumber": "+1234567890",
  "virtualNumberCountry": "US",
  "callTransferType": "Disabled",
  "fixedNumber": "+1234567890",
  "agentExperience": "10 years in real estate",
  "rentalBusiness": false,
  "websiteChannel": true,
  "textChannel": true,
  "emailChannel": true,
  "startActiveHour": 8,
  "endActiveHour": 20,
  "activeDays": [
    1,
    2,
    3,
    4,
    5
  ],
  "leadTypes": [
    1,
    2
  ],
  "leadSources": [
    1001,
    1002
  ],
  "leadPipelines": [
    2001,
    2002
  ],
  "agentIds": [
    101,
    102
  ],
  "officeIds": [
    201,
    202
  ],
  "leadPondIds": [
    301,
    302
  ],
  "newLeadEnable": true,
  "visitorsEnable": true,
  "followUpRole": "AI",
  "hostedStatus": "ACTIVE"
}

"<string>"

"<string>"

"<string>"

Headers

Authorization

string

required

Bearer [access_token]

Response

Settings retrieved successfully.

Sales agent setting response

integer<int64>

AI Assistant ID

Example:

12345

assistantName

string

Assistant name

Example:

"Anna"

headUrl

string

Assistant avatar URL

Example:

"https://example.com/avatar.jpg"

virtualNumber

string

Virtual phone number

Example:

"+1234567890"

virtualNumberCountry

string

Virtual number country

Example:

"US"

callTransferType

string

Call transfer type: Disabled, ToAssignedAgent

Example:

"Disabled"

fixedNumber

string

Fixed phone number

Example:

"+1234567890"

agentExperience

string

Agent experience description

Example:

"10 years in real estate"

rentalBusiness

boolean

Whether agent handles rental business

Example:

false

websiteChannel

boolean

Whether website channel is enabled

Example:

true

textChannel

boolean

Whether text channel is enabled

Example:

true

emailChannel

boolean

Whether email channel is enabled

Example:

true

startActiveHour

integer<int32>

Active start hour (0-23)

Example:

8

endActiveHour

integer<int32>

Active end hour (0-23)

Example:

20

activeDays

integer<int32>[]

Active days of week (0=Sun, 6=Sat)

Example:

[1, 2, 3, 4, 5]

leadTypes

integer<int32>[]

Lead types filter

Example:

[1, 2]

leadSources

integer<int64>[]

Lead source IDs filter

Example:

[1001, 1002]

leadPipelines

integer<int64>[]

Lead pipeline IDs filter

Example:

[2001, 2002]

agentIds

integer<int64>[]

Agent IDs with access

Example:

[101, 102]

officeIds

integer<int64>[]

Office IDs with access

Example:

[201, 202]

leadPondIds

integer<int64>[]

Lead pond IDs with access

Example:

[301, 302]

newLeadEnable

boolean

Whether new lead follow-up is enabled

Example:

true

visitorsEnable

boolean

Whether visitor follow-up is enabled

Example:

true

followUpRole

string

Follow up role: AI or Agent

Example:

"AI"

hostedStatus

string

Hosted status

Example:

"ACTIVE"

Get Sales Agent by lead ID

Update Sales Agent settings

Query Sales Agent settings

curl --request GET \
  --url https://api.lofty.com/v2.0/sales-agent/settings \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.lofty.com/v2.0/sales-agent/settings"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.lofty.com/v2.0/sales-agent/settings', 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.lofty.com/v2.0/sales-agent/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.lofty.com/v2.0/sales-agent/settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.lofty.com/v2.0/sales-agent/settings")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lofty.com/v2.0/sales-agent/settings")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

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

{
  "id": 12345,
  "assistantName": "Anna",
  "headUrl": "https://example.com/avatar.jpg",
  "virtualNumber": "+1234567890",
  "virtualNumberCountry": "US",
  "callTransferType": "Disabled",
  "fixedNumber": "+1234567890",
  "agentExperience": "10 years in real estate",
  "rentalBusiness": false,
  "websiteChannel": true,
  "textChannel": true,
  "emailChannel": true,
  "startActiveHour": 8,
  "endActiveHour": 20,
  "activeDays": [
    1,
    2,
    3,
    4,
    5
  ],
  "leadTypes": [
    1,
    2
  ],
  "leadSources": [
    1001,
    1002
  ],
  "leadPipelines": [
    2001,
    2002
  ],
  "agentIds": [
    101,
    102
  ],
  "officeIds": [
    201,
    202
  ],
  "leadPondIds": [
    301,
    302
  ],
  "newLeadEnable": true,
  "visitorsEnable": true,
  "followUpRole": "AI",
  "hostedStatus": "ACTIVE"
}

"<string>"

"<string>"

"<string>"