📞
API Docs
  • Welcome
  • NUMBERS / ORDERING
    • List Areas
    • List Numbers
    • Order Numbers - No Cart
    • Delete Numbers
    • Change Call Forward
    • Vanity Tollfree - Search
    • Vanity Toll Free - Order
  • Shopping Cart Ordering
    • Add Number to Cart
    • List Numbers in Cart
    • Delete Number from Cart
    • Complete Order Cart
  • MY INVENTORY
    • List My Nmbers
    • List Call Flows
    • Change CallFlow
    • CDR Records
  • SMS/MMS
    • Send SMS
    • Send MMS
    • Receive SMS/MMS
    • Receive Delivery Receipts
  • Campaigns
    • Submit TollFree Campaign
  • CALL APIS
    • Calls
    • Set Incoming URL
    • Incoming Calls
    • Listing Calls
    • Making Calls
      • Example Code
        • Outbound to Tel#
        • Outbound to SIP Device
        • Example Responses
    • Modifying Live Calls
      • Examples
    • Recordings
      • Get List of Recordings
      • Delete a Recording
  • CALL API MARKUP
    • API Call Markup Language
      • Say
      • Dial
        • Number
        • Client
        • SIP
      • Play
      • Gather
      • Record
      • Hangup
      • Pause
      • Reject
      • Redirect
  • LOOKUPS
    • Carrier and CNAM
  • Number Portability
    • Validate Portability
    • Lookup Port Request
    • Submit Port Request
  • FAXING
    • Create Outbound Fax
    • Lookup Outbound Fax Status
    • List Faxes
    • Download File
  • registered agent
    • List Companies
    • List Registered Agents
    • List Documents
    • Download Document
    • Create Company
    • Delete Company
    • Create Registered Agent
    • Modify Registered Agent
Powered by GitBook
On this page
  1. NUMBERS / ORDERING

List Numbers

List all numbers available for specific ratecenter / state

GET or POST Request

https://v1.api19.com/dids/available/list?key=yourkey​

Send us a GET/POST request with your key (in the URI as key or as http password)

Ratecenter / State search You can send ratecenter=[ratecenter] and state=[state]

Area Code Search If you would rather get by area code, you can send npa=[areacode]

Toll Free Search To request toll free, send state=tf in your request

We give you the City and Ratecenter so you can get human readable data (for instance ratecenter LSAN DA 01 is actually Los Angeles: 01 as the City.

Argument

Required

Type

state

yes

string

ratecenter

yes

string

quantity

no

int

npa

no

int

key

yes

your API key

curl -X POST https://v1.api19.com/dids/available/list \
 -d 'ratecenter=AUSTIN' \
 -d 'state=TX' \
 -d 'quantity=2' \
 -d 'key=your-api-key'
 
or area code based

curl -X POST https://v1.api19.com/dids/available/list \
 -d 'npa=303' \
 -d 'quantity=2' \
 -d 'key=your-api-key'
 
or toll free request

curl -X POST https://v1.api19.com/dids/available/list \
 -d 'state=tf' \
 -d 'key=your-api-key'
curl https://v1.api19.com/dids/available/list?ratecenter=AUSTIN&state=TX&key=api_token

or area code based

curl https://v1.api19.com/dids/available/list?npa=720&key=api_token

or a toll free request

curl https://v1.api19.com/dids/available/list?state=tf&key=api_token
{
    "status": "ok",
    "numbers": {
        "17202224017": {
            "did": "17202224017",
            "number": "(720) 222-4017",
            "tier": 1,
            "price_monthly": "1.5",
            "price_setup": "1.5",
            "price_minute": "0.0075",
            "ratecenter": "DENVER",
            "state": "CO"
        },
        "17209922019": {
            "did": "17209922019",
            "number": "(720) 992-2019",
            "tier": 1,
            "price_monthly": "1.5",
            "price_setup": "1.5",
            "price_minute": "0.0075",
            "ratecenter": "DENVER",
            "state": "CO"
        }
    },
    "count": 2
} 
{
    "status": "error",
    "error": "no numbers available for search",
    "verbose": "none"
} 

PreviousList AreasNextOrder Numbers - No Cart

Last updated 4 days ago