Search phone numbers

cURL

curl --request GET \
  --url https://api.teamfollowup.ai/api/agent-builder/phone-numbers/search \
  --header 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/phone-numbers/search"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.teamfollowup.ai/api/agent-builder/phone-numbers/search', 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.teamfollowup.ai/api/agent-builder/phone-numbers/search",
  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: Bearer <token>"
  ],
]);

$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.teamfollowup.ai/api/agent-builder/phone-numbers/search"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/phone-numbers/search")

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

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

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

{
  "success": true,
  "searchable": true,
  "candidates": [
    {
      "phoneNumber": "+14155559876",
      "locality": "San Francisco",
      "region": "CA"
    }
  ],
  "matched": {
    "label": "San Francisco, CA",
    "city": "San Francisco",
    "state": "CA",
    "country": "US"
  },
  "placeUnresolved": false
}

{
  "success": false,
  "error": "VALIDATION",
  "message": "A campaignId is required."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Forbidden",
  "message": "You do not have access to phone number endpoints."
}

{
  "success": false,
  "error": "NotFound",
  "message": "Campaign \"campaign_missing\" not found or not accessible."
}

{
  "success": false,
  "error": "CONFLICT",
  "message": "This is the only number on an active campaign. Pause the campaign or add another number before removing it."
}

{
  "success": false,
  "error": "TooManyRequests",
  "message": "Too many requests, please try again later."
}

{
  "success": false,
  "error": "InternalError",
  "message": "Unexpected server error."
}

GET

api

agent-builder

phone-numbers

cURL

curl --request GET \
  --url https://api.teamfollowup.ai/api/agent-builder/phone-numbers/search \
  --header 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/phone-numbers/search"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.teamfollowup.ai/api/agent-builder/phone-numbers/search', 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.teamfollowup.ai/api/agent-builder/phone-numbers/search",
  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: Bearer <token>"
  ],
]);

$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.teamfollowup.ai/api/agent-builder/phone-numbers/search"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/phone-numbers/search")

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

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

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

{
  "success": true,
  "searchable": true,
  "candidates": [
    {
      "phoneNumber": "+14155559876",
      "locality": "San Francisco",
      "region": "CA"
    }
  ],
  "matched": {
    "label": "San Francisco, CA",
    "city": "San Francisco",
    "state": "CA",
    "country": "US"
  },
  "placeUnresolved": false
}

{
  "success": false,
  "error": "VALIDATION",
  "message": "A campaignId is required."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Forbidden",
  "message": "You do not have access to phone number endpoints."
}

{
  "success": false,
  "error": "NotFound",
  "message": "Campaign \"campaign_missing\" not found or not accessible."
}

{
  "success": false,
  "error": "CONFLICT",
  "message": "This is the only number on an active campaign. Pause the campaign or add another number before removing it."
}

{
  "success": false,
  "error": "TooManyRequests",
  "message": "Too many requests, please try again later."
}

{
  "success": false,
  "error": "InternalError",
  "message": "Unexpected server error."
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

campaignId

string

Campaign id used to scope the operation to one campaign.

Minimum string length: 1

place

string

City, state, province, or country to search near.

Minimum string length: 1

areaCode

integer

Three-digit area code preference.

Required range: 200 <= x <= 999

countryCode

enum<string>

Country code for number search.

Available options:

US,

CA

contains

string

Digit sequence the available number should contain.

Minimum string length: 1

tollFree

boolean

Search toll-free inventory instead of local inventory.

Response

Available phone number candidates.

success

boolean

required

searchable

boolean

required

Whether number inventory search is currently available.

Example:

true

candidates

object[]

required

Show child attributes

matched

object | null

required

Show child attributes

placeUnresolved

boolean

required

True when a free-text place could not be resolved.

Example:

false

Agents

Skills & Tools

Campaigns

Campaign Workflows

Calls

Analytics

Projects

Power Dialer

Contacts

Phone Numbers

Voices

GHL

Authorizations

Query Parameters

Response