Başlarken
Tüm uçlar /api/v1 altındadır. Bu sitedeki Uç referansı sayfası aynı origin üzerinden /api’yi vekiller; “Dene” düğmesi bu vekile gider. Anahtarı aldıktan sonra örnek gövdeyi düzenleyip gerçek yanıtı görmek için API’yi dene sayfasını kullanın. Başka bir ortamda temel adres sunucunun yayınladığı adrestir.
Her istek x-api-key: <anahtar> başlığını taşır. Anahtar panelden açılır; süre 1, 3, 6, 9 veya 12 aydır. Süre dolunca uç 401 döner.
İlk okuma, izin list:sms ister; gönderimlerinizi listeler:
curl -s -H "x-api-key: $SMS_API_KEY" \ "$SMS_API_URL/api/v1/sms?limit=1"Yanıt sayfalıdır: items, total, page, limit, totalPages.
Gönderim oluşturan uç 202 döner, çünkü alıcı listesi hemen işlenmez; gövde gönderimin kendisidir. Gönderim POST /api/v1/sms ile açılır, durumu ve alıcıları GET /api/v1/sms/:id altından okunur:
| İş | Uç |
|---|---|
| Gönderim aç | POST /api/v1/sms |
| Kontör bakiyesi | GET /api/v1/sms/credit |
| Gönderimleri listele | GET /api/v1/sms |
| Gönderim durumu | GET /api/v1/sms/:id |
| Alıcılar, tek alıcı, CSV | GET /api/v1/sms/:id/recipients |
| Düşen gerekçeler | GET /api/v1/sms/:id/errors |
| İptal | POST /api/v1/sms/:id/cancel |
Numara kaydı ve doğrulama aranmaz. Ayrıntı Gönderim sayfasındadır.