// documentation

EK SMS API

One API key to send bulk SMS and OTP across NTC and Ncell. Routing, failover, credit billing, and delivery webhooks are handled for you.

The EK SMS API is organized around predictable, resource-oriented REST. It returns a consistent JSON envelope on every response, uses conventional HTTP status codes, and authenticates with a single API key. The base URL is:

https://api.eksms.com/v1

Base URL

In local development the backend runs at http://localhost:3001/v1. The full interactive OpenAPI/Swagger reference is available at http://localhost:3001/docs.

Quickstart

Send your first SMS in three steps:

Create an API key in the dashboard under API Keys, scoped to messages:send.
Add credits from the Billing screen. You are charged per delivered segment in NPR.
Send a message with a single POST request:

curl -X POST https://api.eksms.com/v1/messages \
  -H "X-API-Key: eksms_live_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-2048-otp" \
  -d '{
    "recipients": ["9818000000"],
    "text": "Your EK SMS code is 481920"
  }'

A successful call returns 202 with a batch id; the message is sent in the background and its status is reported over a delivery webhook. See Send a message for the full request and response contract.

The dashboard

Manage keys, top up credits, browse every message, and watch delivery in real time from the dashboard.

app.eksms.com/dashboard

Current balance

97.20 NPR

Messages sent

1,284

Delivered

1,251

RecipientMessageStatus

9818000000Your EK SMS code is 481920DELIVERED

9808000001Order #2048 is on its wayDELIVERED

9841000002Payment received - thank youSENT

Product preview · Dashboard

Next: Authentication · Send a message · Delivery & webhooks