Wholesale

Order a wholesale number

Allocates a number from an area and starts delivering its inbound calls to your SIP endpoint. Prepaid: the first month at your contract rate is charged from your wallet at allocation, then monthly; inbound minutes are charged per call as they complete.

deliverTo accepts three forms:

a bare host (pbx.example.com or a public IP) — we deliver as sip:<allocated-number>@host
a sip: URI containing {number} — replaced with the allocated number
a full sip: URI, used verbatim

Allocation can take up to ~40 seconds. On order_failed for a specific area, order from a DIFFERENT area — retrying the same one will not help.

post/api/v1/wholesale/numbers

Request

Base URL: https://api.callnode.io
URL: https://api.callnode.io/api/v1/wholesale/numbers
Auth: API key in header X-Api-Key and API key in header X-Timestamp and API key in header X-Signature

Headers

X-Idempotency-Keystring uuid

A UUID. Replaying the same key returns the original result rather than acting twice.

Request body

areaIdstring required

From /wholesale/areas

deliverTostring required

Host, {number} template, or full sip URI (public hosts only).

friendlyNamestring

countryIdstring

Pass when ordering outside the US.

Example request

{
  "deliverTo": "pbx.example.com"
}

Response

Number allocated, delivering, and charged.

chargednumber

First month

monthlyRatenumber

billing'wallet'

Example response

{
  "number": {
    "phoneNumber": "+16135551234",
    "deliverTo": "sip:+17869517433@pbx.example.com"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.