Purchase a number

POST /v1/numbers

Supports the Idempotency-Key header: a retried purchase replays the original 201.

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.

Headers

Name	Type	Required	Description
`Idempotency-Key`	string	No	Makes retries safe for 24 hours: the same key and body replays the original successful response (with Idempotent-Replayed: true); a different body returns 409. Failed requests release the key. At most 255 characters.

Request body

JSON (Content-Type: application/json).

Field	Type	Required	Description
`phone_number`	string	Yes	Example: `+15005550132`.
`customer_id`	string	No	Optional: assign the number to one of your customers
`registration_id`	string	No	Optional (live numbers): the registration this number should send for. Without it the number follows your account's registration.

Responses

Status	Meaning	Body
201	Number purchased	`Number`
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`
409	Idempotency conflict	`Error`
429	Rate limit or quota exceeded	`Error`

201: `Number` fields

Field	Type	Description
`id`	string	Example: `+15005550132`.
`object`	`number`
`phone_number`	string
`status`	`active`, `released`
`mode`	`test`, `live`
`created_at`	string (date-time)
`customer_id`	string	The customer this number is assigned to Nullable.
`label`	string	Nullable.
`tags`	array of string
`pools`	array of string	Pool ids
`sender`	object	How the number stands with the carriers. null on sandbox numbers and on numbers that need no registration (toll-free, Canadian). Only an active number can text anyone; in every other state it can text only your verified numbers. Nullable.
`sender.state`	`test_only`, `pending`, `active`, `action_needed`	test_only: no registration submitted. pending: a registration is in review, or approved and being linked. active: linked to an approved registration. action_needed: see reason.
`sender.registration_id`	string	The registration it is (being) linked to Nullable.
`sender.reason`	string	What to do, in plain words, when state is action_needed Nullable.
`sender.updated_at`	string (date-time)

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
409	Idempotency conflict
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"
  }
}

Idempotency

Send an Idempotency-Key header to make retries safe. For 24 hours the same key with the same body replays the original successful response (with Idempotent-Replayed: true); the same key with a different body returns 409. A failed request releases its key.

Examples

curl

bash

curl -X POST "https://api.joinsimplesms.com/v1/numbers" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6f1c2f0e-order-1042" \
  -d '{
  "phone_number": "+15005550132"
}'

Node.js

javascript

import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

const number = await sms.numbers.buy('+14155550132');

console.log(number.phone_number);

Python

python

import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

number = client.numbers.buy("+14155550132")

print(number["phone_number"])