Developers
Everything in the portal, available over REST
Search and order numbers, build routing plans, forward calls and read call records from your own code. JSON in, JSON out, with webhooks for call events.
Get a number and route it in two calls
Authenticate with a bearer token from the portal. Every resource is a plain JSON object and every list is paged the same way. Sandbox credentials are available on request so you can build before you buy.
- Bearer token auth, HTTPS only
- Idempotent orders with your own reference
- Rate limit: 10 requests a second per account
- Webhooks signed with HMAC-SHA256
# Search for a 702 number in Las Vegas curl https://api.nring.io/v1/numbers/search \ -H "Authorization: Bearer $NRING_TOKEN" \ -d '{ "npa": "702", "city": "Las Vegas", "limit": 5 }' # Order it and forward it to a mobile curl https://api.nring.io/v1/numbers \ -H "Authorization: Bearer $NRING_TOKEN" \ -d '{ "tn": "7025550100", "route": { "forward_to": "+17025550142" }, "reference": "acme-main-line" }'
Numbers
Search inventory, order, port and release numbers.
POST/v1/numbers/searchSearch inventory
POST/v1/numbersOrder a number
GET/v1/numbersList your numbers
GET/v1/numbers/{tn}Number detail
POST/v1/portsStart a port-in
DELETE/v1/numbers/{tn}Release a number
Routing
Plans, forwarding and the destinations calls go to.
POST/v1/plansCreate a routing plan
PUT/v1/plans/{id}Replace a plan's steps
PUT/v1/numbers/{tn}/routeAttach a plan or forward
GET/v1/callsCall records (CDRs)
POST/v1/usersCreate a web phone user
GET/v1/usageUsage and charges
Webhooks for every call
Subscribe to call events and port status changes. Each delivery carries a signature header so you can verify it came from NRing. Failed deliveries retry with backoff for 24 hours.
- call.started, call.answered, call.ended, call.voicemail
- port.submitted, port.foc, port.completed, port.rejected
- number.activated, number.released
POST https://yourapp.example/nring
X-Nring-Signature: sha256=3f1a…
{
"event": "call.ended",
"tn": "7025550199",
"from": "+14155550190",
"answered_by": "user_j4k",
"plan_step": 2,
"duration_seconds": 252,
"cost": "0.04"
}
Want sandbox access?
Tell us what you are building and we will set up API credentials and a sandbox account.