Phone numbers

Find extra numbers to buy

Searches the carrier for numbers a business that has its first number can buy for another of its agents. Starter, Pro and Enterprise sell them, each at the carrier’s monthly price for its country and kind with no markup, billed monthly through the extra phone numbers add-on; monthly_price says what each costs. A self-hosted server’s cost nothing extra. A business without a paid plan, without a number yet, or a partner’s business is a 409. Each offer expires after 5 minutes, and searches count against the same limit as POST /phone-numbers/search. Partner platform keys can’t buy extra numbers.

POST

phone-numbers

extra

curl --request POST \
  --url https://app.lobbystack.com/api/v1/phone-numbers/extra/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "area_code": "<string>",
  "city": "<string>",
  "region": "<string>",
  "postal_code": "<string>",
  "limit": 10
}
'

import requests

url = "https://app.lobbystack.com/api/v1/phone-numbers/extra/search"

payload = {
    "area_code": "<string>",
    "city": "<string>",
    "region": "<string>",
    "postal_code": "<string>",
    "limit": 10
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    area_code: '<string>',
    city: '<string>',
    region: '<string>',
    postal_code: '<string>',
    limit: 10
  })
};

fetch('https://app.lobbystack.com/api/v1/phone-numbers/extra/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://app.lobbystack.com/api/v1/phone-numbers/extra/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'area_code' => '<string>',
    'city' => '<string>',
    'region' => '<string>',
    'postal_code' => '<string>',
    'limit' => 10
  ]),
  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://app.lobbystack.com/api/v1/phone-numbers/extra/search"

	payload := strings.NewReader("{\n  \"area_code\": \"<string>\",\n  \"city\": \"<string>\",\n  \"region\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"limit\": 10\n}")

	req, _ := http.NewRequest("POST", 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.post("https://app.lobbystack.com/api/v1/phone-numbers/extra/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"area_code\": \"<string>\",\n  \"city\": \"<string>\",\n  \"region\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"limit\": 10\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.lobbystack.com/api/v1/phone-numbers/extra/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"area_code\": \"<string>\",\n  \"city\": \"<string>\",\n  \"region\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"limit\": 10\n}"

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

{
  "data": [
    {
      "phone_number": "<string>",
      "country": "US",
      "kind": "local",
      "locality": "<string>",
      "region": "<string>",
      "capabilities": {
        "voice": true,
        "sms": true
      },
      "monthly_price": {
        "amount_cents": 0,
        "currency": "USD"
      },
      "add_on_active": true,
      "offer_token": "<string>",
      "expires_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Autorizaciones

Authorization

string

header

requerido

An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create, phone_numbers:purchase, partner:read, partner.businesses:write, partner.demos:write, partner.packages:write, partner.branding:write, partner.templates:write, partner.team:write, partner.billing:read, partner.billing:write. Only platform keys can hold businesses:create and users:create, and only a key a partner made in its console can hold the partner scopes, which the Partner endpoints use. Only a partner's owners grant partner.billing:read and partner.billing:write.

Encabezados

LobbyStack-Business

string<uuid>

The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.

Cuerpo

application/json

country

enum<string>

Defaults to the country of the business's time zone, or US.

Opciones disponibles:

US,

CA,

PR,

GB,

AU,

NZ

kind

enum<string>

Defaults to local. GB and AU numbers are always mobile, and NZ numbers local. A kind a country doesn't sell as an extra number is a 400.

Opciones disponibles:

local,

mobile,

toll_free

area_code

string

Pattern: ^\d{1,6}$

city

string

Required string length: 1 - 100

region

string

A state or province, such as ON or NY.

Required string length: 1 - 64

postal_code

string

Required string length: 1 - 16

limit

integer

How many offers to return. Defaults to 10.

Rango requerido: 1 <= x <= 20

Respuesta

data

object[]

requerido

Show child attributes

next_cursor

string | null

requerido

Pass as cursor to get the next page. Null on the last page.

has_more

boolean

requerido

Find extra numbers to buy

curl --request POST \
  --url https://app.lobbystack.com/api/v1/phone-numbers/extra/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "area_code": "<string>",
  "city": "<string>",
  "region": "<string>",
  "postal_code": "<string>",
  "limit": 10
}
'

import requests

url = "https://app.lobbystack.com/api/v1/phone-numbers/extra/search"

payload = {
    "area_code": "<string>",
    "city": "<string>",
    "region": "<string>",
    "postal_code": "<string>",
    "limit": 10
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    area_code: '<string>',
    city: '<string>',
    region: '<string>',
    postal_code: '<string>',
    limit: 10
  })
};

fetch('https://app.lobbystack.com/api/v1/phone-numbers/extra/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://app.lobbystack.com/api/v1/phone-numbers/extra/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'area_code' => '<string>',
    'city' => '<string>',
    'region' => '<string>',
    'postal_code' => '<string>',
    'limit' => 10
  ]),
  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://app.lobbystack.com/api/v1/phone-numbers/extra/search"

	payload := strings.NewReader("{\n  \"area_code\": \"<string>\",\n  \"city\": \"<string>\",\n  \"region\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"limit\": 10\n}")

	req, _ := http.NewRequest("POST", 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.post("https://app.lobbystack.com/api/v1/phone-numbers/extra/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"area_code\": \"<string>\",\n  \"city\": \"<string>\",\n  \"region\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"limit\": 10\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.lobbystack.com/api/v1/phone-numbers/extra/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"area_code\": \"<string>\",\n  \"city\": \"<string>\",\n  \"region\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"limit\": 10\n}"

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

{
  "data": [
    {
      "phone_number": "<string>",
      "country": "US",
      "kind": "local",
      "locality": "<string>",
      "region": "<string>",
      "capabilities": {
        "voice": true,
        "sms": true
      },
      "monthly_price": {
        "amount_cents": 0,
        "currency": "USD"
      },
      "add_on_active": true,
      "offer_token": "<string>",
      "expires_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Primeros pasos

General

Agentes

Configuración

Marca blanca

API

Asistentes de IA

Referencia de la API

Autoalojamiento

Find extra numbers to buy

Autorizaciones

Encabezados

Cuerpo

Respuesta