Buy many numbers in an area code

POST /v1/numbers/bulk-purchase

Quota is checked for the whole quantity up front (429, nothing bought). After that, carrier refusals are reported per number and backfilled from spare inventory; shortfall counts any the area code could not supply. Test keys mint sandbox numbers.

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Request body

JSON (Content-Type: application/json).

Field	Type	Required	Description
`area_code`	string	Yes	Example: `415`.
`quantity`	integer	Yes	Maximum 50. Minimum 1.
`pool_id`	string	No	Add the new numbers to this pool
`tags`	array of string	No

Responses

Status	Meaning	Body
201	At least one number purchased	JSON object
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
429	Rate limit or quota exceeded	`Error`

201: response fields

Field	Type	Description
`object`	`bulk_purchase`
`requested`	integer
`purchased`	array of Number
`failed`	array of object
`failed[].phone_number`	string
`failed[].error`	string
`failed[].message`	string
`shortfall`	integer

Errors

Status	When
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X POST "https://api.joinsimplesms.com/v1/numbers/bulk-purchase" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "area_code": "415",
  "quantity": 1
}'

Node.js

The Node.js SDK does not wrap this endpoint yet; call it with fetch.

javascript

const res = await fetch('https://api.joinsimplesms.com/v1/numbers/bulk-purchase', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SIMPLESMS_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "area_code": "415",
    "quantity": 1
  }),
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Python

The Python SDK does not wrap this endpoint yet; call it over HTTP.

python

import json, os, urllib.request

req = urllib.request.Request(
    "https://api.joinsimplesms.com/v1/numbers/bulk-purchase",
    method="POST",
    headers={
        "Authorization": f"Bearer {os.environ['SIMPLESMS_API_KEY']}",
        "Content-Type": "application/json",
    },
    data=json.dumps({
        "area_code": "415",
        "quantity": 1
    }).encode(),
)
with urllib.request.urlopen(req) as res:
    data = json.load(res)