Bitcall APIOverview
The Bitcall API gateway — one authenticated entry point to every Bitcall product.
The Bitcall API is a single, hardened gateway in front of every Bitcall product. Instead of integrating each product separately, you get one base URL and one authentication scheme.
Beta. This API is in beta and its workflow is polling-based: you submit an operation and poll its resource for the outcome (order, activation or lookup status) — see each product guide. Webhooks / callbacks are out of scope for the beta; there is no push notification, so do not build against one. Breaking changes are announced before they ship.
How it works
Your app ──key id + secret──▶ Bitcall API gateway ──▶ OTP · eSIM · HLR
auth · limits (downstream products)- You hold one key id and secret for the Bitcall API.
- Your app sends them as two headers on each request.
- The gateway authenticates the request, applies your rate limit, then proxies it to the right product — minting the downstream credential itself.
Your app never holds or sees a downstream product's credentials. It only ever holds its Bitcall key id + secret.
Why a gateway
- One credential model. The same key, the same authentication and the same limits across every product.
- Nothing to compute. Two headers on every request, from any language or tool. No SDK required.
- Safe by default. Failures reveal nothing about why they failed, and a 404 never tells you an identifier belongs to someone else.
- Add products without re-integrating. New products appear as new routes behind the same gateway.
Start here
Quick Start
Send your first authenticated request.
Authentication
The two headers every request needs.
API Keys & Secrets
What a key carries and how to rotate it.
Products
OTP, eSIM and HLR — each with its own API reference.
Shared rules
Every product uses the same envelopes, pagination, error format and retry semantics. Learn them once:
Conventions
Response envelopes, pagination, request ids, timestamps and money.
Errors
One error shape, thirteen codes, and which are worth retrying.
The products
| Product | What it does | API reference |
|---|---|---|
| OTP | Rent numbers and receive one‑time passcodes | OTP |
| eSIM | Provision and manage eSIM profiles and data plans | eSIM |
| HLR | Home Location Register lookups and number intelligence | HLR |
WebPhone (SIP voice calling) is documented separately and is not yet part of this API reference.
Each product is a standalone microservice with its own API. They share one credential model through the gateway, and each has its own API reference — see Products.