API Documentation | zealsmsotp

Authentication

Pass your personal API key on every request. Find or regenerate it in the developer API area after logging in.

api_key=YOUR_API_KEY

Number API

Virtual numbers and OTP — base path https://zealsmsotp.com/api/v1. Responses are plain text unless noted.

Flow: servers → countries → services (with prices) → get-number

GET /api/v1/balance

Returns wallet balance as plain text.

https://zealsmsotp.com/api/v1/balance?api_key=YOUR_API_KEY

Response: ACCESS_BALANCE:25.40

GET /api/v1/servers

List active number servers (JSON).

https://zealsmsotp.com/api/v1/servers?api_key=YOUR_API_KEY

{ "status": "success", "servers": [{ "id": 1, "name": "Server A" }] }

GET /api/v1/countries

Countries for a server (JSON). Requires server_id from servers list.

https://zealsmsotp.com/api/v1/countries?api_key=YOUR_API_KEY&server_id=1

{ "status": "success", "countries": [{ "id": 5, "name": "United States", "code": "US", "country_id": "12" }] }

GET /api/v1/services

Services with prices for a server + country (JSON). Use code when ordering.

https://zealsmsotp.com/api/v1/services?api_key=YOUR_API_KEY&server_id=1&country=5

{ "status": "success", "services": [
  { "id": 10, "code": "wa", "name": "WhatsApp", "price": "1.50" }
] }

GET /api/v1/get-number

Buy a virtual number. Deducts wallet balance at the listed price.

https://zealsmsotp.com/api/v1/get-number?api_key=YOUR_API_KEY&country=COUNTRY_ID&service=SERVICE_CODE

Response: ACCESS_NUMBER:ORDER_ID:+1234567890

GET /api/v1/status

Poll SMS/OTP for an order.

https://zealsmsotp.com/api/v1/status?api_key=YOUR_API_KEY&id=ORDER_ID

Responses: STATUS_WAIT_CODE | STATUS_OK:123456 | STATUS_CANCEL

GET /api/v1/set-status

Cancel (8) or request retry (3) while waiting for SMS.

https://zealsmsotp.com/api/v1/set-status?api_key=YOUR_API_KEY&id=ORDER_ID&status=8

Plain-text errors: BAD_KEY, BAD_API, BAD_COUNTRY, BAD_SERVICE, NO_BALANCE.

SMM API

Social boosting — base path https://zealsmsotp.com/api/v1/smm. JSON request/response.

Flow: servers → categories → services (with rates) → order

GET/POST /api/v1/smm/balance

Returns wallet balance (JSON).

https://zealsmsotp.com/api/v1/smm/balance?api_key=YOUR_API_KEY

{ "status": "success", "balance": 25.40, "currency": "₦" }

GET/POST /api/v1/smm/servers

List active SMM servers (JSON).

https://zealsmsotp.com/api/v1/smm/servers?api_key=YOUR_API_KEY

{ "status": "success", "servers": [{ "id": 1, "name": "Server A" }] }

GET/POST /api/v1/smm/categories

Categories for a server. Requires server_id from servers list.

https://zealsmsotp.com/api/v1/smm/categories?api_key=YOUR_API_KEY&server_id=1

{ "status": "success", "categories": [{ "id": 2, "name": "Instagram", "server_id": 1 }] }

GET/POST /api/v1/smm/services

Services with prices for a server + category. rate is price per 1000 units.

https://zealsmsotp.com/api/v1/smm/services?api_key=YOUR_API_KEY&server_id=1&category_id=2

{ "status": "success", "services": [
  { "id": 12, "name": "Followers", "rate": "2.5000", "min": 100, "max": 10000, "refill": false }
] }

GET/POST /api/v1/smm/order

Place an order. Uses internal service_id from the services list.

https://zealsmsotp.com/api/v1/smm/order?api_key=YOUR_API_KEY&service_id=12&link=https://example.com/post&quantity=1000

{ "status": "success", "order": { "id": 1, "price": "5.00", "status": "processing" } }

GET/POST /api/v1/smm/status

Check order status by internal order id.

https://zealsmsotp.com/api/v1/smm/status?api_key=YOUR_API_KEY&order_id=1

GET/POST /api/v1/smm/cancel

Cancel a pending/processing order and refund wallet.

https://zealsmsotp.com/api/v1/smm/cancel?api_key=YOUR_API_KEY&order_id=1

JSON errors: { "status": "error", "message": "..." }

eSIM API

eSIM catalog and purchase — base path https://zealsmsotp.com/api/v1/services/esim.

List eSIM packages

GET https://zealsmsotp.com/api/v1/services/esim/packages?api_key=YOUR_API_KEY

Optional search and per_page parameters. The response contains the customer selling price, not the provider cost.

Buy eSIM

POST https://zealsmsotp.com/api/v1/services/esim/buy

api_key=YOUR_API_KEY
package_id=123

SMS-BUS Rental API

Rental areas and monthly number rental — base path https://zealsmsotp.com/api/v1/services/rentals.

List rental areas

GET https://zealsmsotp.com/api/v1/services/rentals/areas?api_key=YOUR_API_KEY

Rent a number

POST https://zealsmsotp.com/api/v1/services/rentals/buy

api_key=YOUR_API_KEY
area_code=AREA_CODE
months=1

Months must be between 1 and 12 and must meet the provider area's minimum rental period.

Logs Marketplace API

Logs Marketplace catalog and purchases — base path https://zealsmsotp.com/api/v1/services/tlogs.

List Logs Marketplace products

GET https://zealsmsotp.com/api/v1/services/tlogs/products?api_key=YOUR_API_KEY

Purchase a provider product

POST https://zealsmsotp.com/api/v1/services/tlogs/buy

api_key=YOUR_API_KEY
product_id=123
quantity=1
coupon=OPTIONAL

Your API customer is charged your configured marketplace selling price.

VTU API

Airtime, data, Cable TV, electricity and exam PIN services — base path https://zealsmsotp.com/api/v1/services/vtu.

VTU flow: list catalog → use the returned ID → send the purchase request with your API key.

GET/api/v1/services/vtu/networks

Lists active airtime networks and data-plan availability.

https://zealsmsotp.com/api/v1/services/vtu/networks?api_key=YOUR_API_KEY

GET/api/v1/services/vtu/data-plans

Lists active data plans. Optionally filter with network=NETWORK_ID.

https://zealsmsotp.com/api/v1/services/vtu/data-plans?api_key=YOUR_API_KEY&network=1

POST/api/v1/services/vtu/buy-airtime

Buy airtime from your API wallet.

network=1
phone=08012345678
amount=500

Returns JSON with order_id, price and provider reference.

POST/api/v1/services/vtu/buy-data

Buy a data plan using its plan ID.

plan=123
phone=08012345678

GET/api/v1/services/vtu/cable-providers

Lists active Cable TV providers.

https://zealsmsotp.com/api/v1/services/vtu/cable-providers?api_key=YOUR_API_KEY

GET/api/v1/services/vtu/cable-plans

Lists active Cable TV plans. Optionally filter with provider=PROVIDER_ID.

POST/api/v1/services/vtu/verify-smartcard

Verifies a Cable TV smartcard before payment.

provider=1
smartcard=1234567890

POST/api/v1/services/vtu/buy-cable

Pay for a Cable TV plan.

plan=123
smartcard=1234567890
phone=08012345678

GET/api/v1/services/vtu/electricity-discos

Lists active electricity discos and their limits/service charges.

POST/api/v1/services/vtu/verify-meter

Verifies an electricity meter.

disco=1
meter=1234567890
meter_type=prepaid

POST/api/v1/services/vtu/buy-electricity

Buy electricity credit/token.

disco=1
meter=1234567890
meter_type=prepaid
amount=5000

GET/api/v1/services/vtu/exam-types

Lists active examination PIN products.

POST/api/v1/services/vtu/buy-exam

Purchase examination PINs.

exam=1
quantity=1

All VTU purchase endpoints charge the authenticated API user's wallet. Disabled admin VTU modules return 404; insufficient wallet returns 402.

Need Help?

Having trouble integrating? Reach out via our contact page and our team will assist you.