Hujjatlar

Quickstart

Bu misollar jonli demo hosti https://sms.omadli.uz'ni ishlatadi — o'z serveringiz manzili bilan almashtiring. Har bir so'rov Authorization: Bearer <token> bilan autentifikatsiya qilinadi.

1. API kalit oling

Eng osoni: ownsms Android ilovasini o'rnating, server URL (https://sms.omadli.uz) kiriting va ro'yxatdan o'ting. Sozlamalar → Akkaunt'da API kalitni nusxa oling.

Yoki API orqali (akkaunt + qurilma yaratadi va kalitni bir marta qaytaradi):

curl -X POST https://sms.omadli.uz/api/v1/register \ -H "Content-Type: application/json" \ -d '{"device_name":"Mening telefonim"}'

Javob: { "account_id", "device_id", "device_token", "api_key": "osk_…" }. api_key'ni saqlang.

2. Telefon onlayn ekanini tekshiring

API faqat navbatga qo'yadi — ulangan Android telefon xabarni SIM orqali jo'natadi.

curl https://sms.omadli.uz/api/v1/device \ -H "Authorization: Bearer osk_SIZNING_KALIT"

Javob: { "online": true, "status": "active", "today_sent": 0, "sims": [ … ] }

3. SMS yuboring

curl -X POST https://sms.omadli.uz/api/v1/messages \ -H "Authorization: Bearer osk_SIZNING_KALIT" \ -H "Content-Type: application/json" \ -d '{"to":"+998901234567","text":"Salom ownsms!"}'

Faqat to va text majburiy. Qo'shimcha parametrlar:

Parametr	Turi	Ma'nosi
`to`	string	Qabul qiluvchi, E.164 (`+998901234567`).
`text`	string	Xabar matni.
`from`	string	Muayyan SIM raqami; berilmasa standart SIM.
`queued`	bool	`true` = telefon onlayn bo'lganda yubor. Standart: darrov.
`ttl`	int	Amal qilish muddati (soniya).
`send_at`	date-time	Keyinga rejalash.
`idempotency_key`	string	Takroriy so'rovni oldini olish.
`callback_url`	string	Shu xabar uchun webhook.

4. Statusni tekshiring

curl https://sms.omadli.uz/api/v1/messages/msg_1 \ -H "Authorization: Bearer osk_SIZNING_KALIT"

queued→ sending→ sent→ ✓✓ delivered

Status	Ma'nosi
`queued`	Qabul qilindi, telefon kutilmoqda.
`sending`	Telefonga berildi; SIM orqali yuborilmoqda.
`sent`	Operator qabul qildi — buni muvaffaqiyat deb qabul qiling.
`delivered`	Operator yetkazish hisobotini qaytardi. Bonus — ko'p tarmoqlar qaytarmaydi, kutib qolmang.
`failed`	Yuborib bo'lmadi (`error_code`'ga qarang).
`expired`	TTL o'tib ketdi.
`canceled`	`queued` holatida bekor qilindi.

Asosiy endpointlar

Metod	Yo'l	Tavsif
POST	`/api/v1/register`	Akkaunt + qurilma yaratish (token + kalit).
POST	`/api/v1/messages`	Bitta SMS yuborish.
GET	`/api/v1/messages`	Ro'yxat (kursor pagination + filtr).
GET	`/api/v1/messages/{id}`	Bitta xabar statusi.
POST	`/api/v1/campaigns`	Kampaniya (rassilka).
GET	`/api/v1/device`	Qurilma holati + `today_sent`.
GET	`/api/v1/audit`	Audit jurnali.

To'liq interaktiv ma'lumotnoma — kampaniyalar, webhook'lar, kalit doiralari, IP allowlist — Swagger UI'da (/api/v1/openapi.yaml — sxema).

Tayyormisiz?

Telefoningizni ulang, kalit oling, birinchi SMS'ingizni yuboring.

Jonli API'ni sinash Bosh sahifa