The future of
OTP verification.

Every request — temp number or rental — must include your API Key in the query string.

Every response is JSON, except the Premium (Call + SMS) handler which uses a short plain-text protocol (shown below). The endpoints use slightly different envelopes, so check which one you're calling:

SMS OTP API — /stubs/handler_api.php

Rental API — /stubs/rental-handler.php

Premium (Call + SMS) API — /stubs/premium-handler.php

HTTP status codes are meaningful on both endpoints too (401 bad key, 402 insufficient balance, 404 not found, 502 upstream error) — but always check the JSON body (success or status) first, not just the HTTP code.

All prices and balances are in PKR by default. Add the optional currency parameter to any request to receive amounts converted into another currency. The rates are the same ones used by the website currency converter and are refreshed automatically. Use Get Currencies to see the supported codes.

How it works

Works on

getBalance, getServices / getCountries, getPrice and the purchase actions of every endpoint: SMS OTP, Premium, Rentals and Email OTP.

Examples

Lists every currency you can pass as &currency=, sorted A-Z by name, with the rate of 1 PKR in that currency. The same action exists on every endpoint (handler_api.php, premium-handler.php, rental-handler.php, email-handler.php).

Check your account balance in PKR (add &currency=XXX for another currency — see Currency) by entering this URL in your browser.

Lists every server type (1-5) and whether it's currently active — check this before assuming a given type value has any countries/services behind it.

List all available countries for temp numbers. You can filter by server type (1-5). See Get Servers below to discover which types are currently active.

Get available services for a specific country and provider.

Price of ONE service — exactly what getNumber would charge — without buying. Add &currency=XXX for another currency.

Order a new phone number to receive SMS. This will deduct PKR from your balance.

Check if an SMS has been received for an order ID.

sms is the code (unchanged); code is the latest code and text is the full message when we have it (otherwise the same as the code). If a number receives several messages, text holds them all. Prefer push? See Webhook.

Same as getStatus (same id, same waiting / cancelled answers), but a received SMS comes back in a structured form with the latest code and the full message text. Plain getStatus keeps working exactly as before — use whichever you prefer.

text is the full message when the server delivers it, otherwise the same as code. If a number receives several messages, code is the latest one. A cancelled order answers {"status":"STATUS_CANCEL"} like getStatus.

Webhook or polling — your choice. Instead of polling getStatus / getStatusV2, give us an HTTPS address and we will POST every received SMS to it the moment it arrives. It is optional: if you set nothing, nothing changes — getStatus and getStatusV2 keep working exactly as before, and you can use both together.

Set it up

Dashboard → API Tool page → Webhook: enter your Webhook URL (must be https://, a public address). A Webhook secret is generated for you on first save; use Send test to check your endpoint.

A push is a speed-up, not a guarantee: keep a slow fallback poll (for example every 15–30 seconds) so an order is never missed if a push does not arrive.

What we send

POST with Content-Type: application/json:

activationId is the same order id you got from getNumber. text is the full message when we have it, otherwise the code.

Verify the request

Every request carries X-Webhook-Signature: sha256=<hex> (also sent as X-MeOTP-Signature) — the HMAC-SHA256 of the raw request body using your Webhook secret. Compare it before trusting the call:

Delivery rules

• Answer with any 2xx status within a few seconds. Otherwise we retry up to 3 times (immediately, after ~5 s, after ~20 s); if your endpoint keeps failing we only try once per message until it recovers.
• The same message can in rare cases arrive twice — treat activationId + code as idempotent.
• HTTPS only. Redirects are not followed. Local / private addresses are rejected.
• If an order receives a second message, you get a second POST with the new code and text.

Cancel an activation for a refund or complete a successful one.

Long-term numbers you keep for weeks or months, instead of a single OTP. This is a separate endpoint from the SMS OTP API above — same api_key, different base URL and a different response shape.

Every response here uses a status string ("200" for success, an error code otherwise) rather than the success/data shape used by the SMS OTP API:

List all countries available for long-term number rentals.

Get all available duration/price tiers for a country.

Live stock check for a country before buying.

Purchase a phone number for rental. Check getRentalPricing first to confirm a valid duration_hours.

List all your rented numbers. Use order_id to fetch SMS. Use id to renew.

Fetch all SMS messages received on a rented number. Use order_id from rentNumber or getMyRentals.

Extend the rental period on an active number. Use id from getMyRentals as rental_id.

Cancel an active rental for a refund — only available within 20 minutes of purchase. This actually cancels the number with the upstream provider (not just a local flag) — the refund only happens once that succeeds. Use id from getMyRentals as rental_id.

Premium numbers receive the verification code by SMS or by phone call. Same api_key as everywhere else, own base URL and a short plain-text protocol. Catalogue and prices are live; amounts are PKR by default (optional currency — see Currency).

A refund is given only after the cancel is confirmed. Once a code has arrived the order can no longer be cancelled — finish it with status=6. Unclear upstream replies never refund; retry getStatus/setStatus a moment later.

Countries available for Premium numbers with the lowest price in each.

Services (with price) available on one server.

Exact price of one service without buying.

Buys a number and charges your wallet. The price is taken from the live catalogue; if no number can be delivered you are not charged.

Poll for the code (SMS or call). Poll every 3-5 seconds.

Cancel (refund) or finish an order.

Temporary email addresses for OTP verification. A third, separate endpoint from SMS OTP and Rental — same api_key, own base URL and response shape.

Every request needs api_key, action, and server (1 or 2, default 1):

Response shape, same convention as Rental:

200 success · 202 still waiting · 300 cancelled · anything else is an error.

Server 1: services available for a domain. Server 2: domains available for a site.

Price of ONE email product — exactly what buyEmail would charge — without buying.

Server 1 needs service_id + domain. Server 2 needs domain + site.

Poll every 5–10 seconds after buying to retrieve the verification code.

Cancel an activation. If a code already arrived, this completes it instead. If still waiting, it cancels and refunds.

Request a fresh code on the same mailbox — the order stays open, it does not close/finish it. Only for Server 2 emails that already received a code. After a successful reorder the order flips back to "waiting" so you can poll getEmailCode again.

Retrieve your past email purchases. Paginated, 20 per page.