import Surge from '@surgeapi/node';
const client = new Surge({
apiKey: process.env['SURGE_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const phoneNumberListAvailableNumbersResponse of client.phoneNumbers.listAvailableNumbers(
'acct_01j9a43avnfqzbjfch6pygv1td',
{ type: 'local' },
)) {
console.log(phoneNumberListAvailableNumbersResponse.country);
}import os
from surge import Surge
client = Surge(
api_key=os.environ.get("SURGE_API_KEY"), # This is the default and can be omitted
)
page = client.phone_numbers.list_available_numbers(
account_id="acct_01j9a43avnfqzbjfch6pygv1td",
type="local",
)
page = page.data[0]
print(page.country)package main
import (
"context"
"fmt"
"github.com/stainless-sdks/surge-go"
"github.com/stainless-sdks/surge-go/option"
)
func main() {
client := surge.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.PhoneNumbers.ListAvailableNumbers(
context.TODO(),
"acct_01j9a43avnfqzbjfch6pygv1td",
surge.PhoneNumberListAvailableNumbersParams{
Type: surge.PhoneNumberListAvailableNumbersParamsTypeLocal,
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
require "surge_api"
surge = SurgeAPI::Client.new(api_key: "My API Key")
page = surge.phone_numbers.list_available_numbers("acct_01j9a43avnfqzbjfch6pygv1td", type: :local)
puts(page)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Surge\Client;
use Surge\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('SURGE_API_KEY') ?: 'My API Key');
try {
$page = $client->phoneNumbers->listAvailableNumbers(
'acct_01j9a43avnfqzbjfch6pygv1td',
type: 'local',
after: 'after',
areaCode: '801',
before: 'before',
country: 'US',
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}curl --request GET \
--url https://api.surge.app/accounts/{account_id}/available_phone_numbers \
--header 'Authorization: Bearer <token>'HttpResponse<String> response = Unirest.get("https://api.surge.app/accounts/{account_id}/available_phone_numbers")
.header("Authorization", "Bearer <token>")
.asString();{
"data": [
{
"country": "US",
"number": "+18015551234",
"type": "local"
}
],
"pagination": {
"next_cursor": null,
"previous_cursor": null
}
}{
"error": {
"message": "The requested resource could not be found.",
"type": "not_found"
}
}List available numbers
Browse purchasable phone numbers from Surge inventory before buying.
Pagination cursors are always null for now.
import Surge from '@surgeapi/node';
const client = new Surge({
apiKey: process.env['SURGE_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const phoneNumberListAvailableNumbersResponse of client.phoneNumbers.listAvailableNumbers(
'acct_01j9a43avnfqzbjfch6pygv1td',
{ type: 'local' },
)) {
console.log(phoneNumberListAvailableNumbersResponse.country);
}import os
from surge import Surge
client = Surge(
api_key=os.environ.get("SURGE_API_KEY"), # This is the default and can be omitted
)
page = client.phone_numbers.list_available_numbers(
account_id="acct_01j9a43avnfqzbjfch6pygv1td",
type="local",
)
page = page.data[0]
print(page.country)package main
import (
"context"
"fmt"
"github.com/stainless-sdks/surge-go"
"github.com/stainless-sdks/surge-go/option"
)
func main() {
client := surge.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.PhoneNumbers.ListAvailableNumbers(
context.TODO(),
"acct_01j9a43avnfqzbjfch6pygv1td",
surge.PhoneNumberListAvailableNumbersParams{
Type: surge.PhoneNumberListAvailableNumbersParamsTypeLocal,
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
require "surge_api"
surge = SurgeAPI::Client.new(api_key: "My API Key")
page = surge.phone_numbers.list_available_numbers("acct_01j9a43avnfqzbjfch6pygv1td", type: :local)
puts(page)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Surge\Client;
use Surge\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('SURGE_API_KEY') ?: 'My API Key');
try {
$page = $client->phoneNumbers->listAvailableNumbers(
'acct_01j9a43avnfqzbjfch6pygv1td',
type: 'local',
after: 'after',
areaCode: '801',
before: 'before',
country: 'US',
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}curl --request GET \
--url https://api.surge.app/accounts/{account_id}/available_phone_numbers \
--header 'Authorization: Bearer <token>'HttpResponse<String> response = Unirest.get("https://api.surge.app/accounts/{account_id}/available_phone_numbers")
.header("Authorization", "Bearer <token>")
.asString();{
"data": [
{
"country": "US",
"number": "+18015551234",
"type": "local"
}
],
"pagination": {
"next_cursor": null,
"previous_cursor": null
}
}{
"error": {
"message": "The requested resource could not be found.",
"type": "not_found"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The account ID to list available phone numbers for.
"acct_01j9a43avnfqzbjfch6pygv1td"
Query Parameters
Filter by 3-digit area code.
^\d{3}$"801"
ISO country code to search in.
US, CA "US"
Whether to search for local or toll-free numbers.
local, toll_free "local"
Cursor for forward pagination. Use the next_cursor from a previous response.
Cursor for backward pagination. Use the previous_cursor from a previous response.
Response
List of available phone numbers
A list of phone numbers available for purchase
The list of available phone numbers
Show child attributes
Show child attributes
Cursor-based pagination information
Show child attributes
Show child attributes
{
"next_cursor": "g3QAAAABZAACaWRtAAAAGnBuXzAxamtzY2s5eDdkeW0wZnBxZjdjYmRyeQ==",
"previous_cursor": null
}