İstek Yapısı
API HOST: https://organikapi.com/
/vapi_version /api_key /request_name /request_response_type /response_type /
Örnek
https://organikapi.com/v2 /ce136df4c9c92d1428e828aba07d3b05 /balance /
https://organikapi.com/v2 /ce136df4c9c92d1428e828aba07d3b05 /sendsms /json /xml /
API'ye gönderdiğiniz istek yapısı yukarıdaki gibi olmalıdır. İstek yolundaki değişkenlerin değerleri aşağıdaki tabloda verilmiştir.
Değişken | Gereklilik | Varsayılan Değer | Açıklama |
api_version |
Zorunlu | N/A | Kullandığınız API'nin versiyonunu belirtir. Bu dokümantasyonun hazırlandığı son sürüm v2.0'dır. Bu yüzden bu değer 2 olmalıdır. |
api_key |
Zorunlu | N/A | API'nin size yanıt verebilmesi için gerekli API anahtarı değeridir. "API Anahtarı Oluşturma" başlığında nasıl belirleneceği anlatılmıştır. |
request_name |
Zorunlu | N/A | API'ye hangi görevi yapmasını istediğiniz belirttiğiniz değişkendir. Bu değişkenin değerine göre API farklı görevleri yapar ve yanıt verir. API'nin görevleri bu değişkenin alabileceği değerler bir sonraki tabloda anlatılmıştır. |
request_response_type |
Opsiyonel | JSON | API'ye |
response_type |
Opsiyonel | Organik API farklı format tipleriyle istek alıp yanıt verebilir. API'nin döndürdüğü yanıtın hangi formatta olmasını istediğinizi bu değişkenle belirtirsiniz. Yanıtı |
Bu bölümde URL'de yer alan
|
||
Metod | Alabileceği Değer | Açıklama |
balance | Kredi sorgulama metodudur. API'ye bu değer gönderildiğinde size sonuç olarak hesabınızdaki TL ve SMS kredi bakiyenizi döndürür. | |
headers | Kayıtlı gönderen kimliklerinizi (başlıklarınızı) sorgulama metodudur. Yanıt olarak başlık ID ve başlık isimlerini döndürür. | |
smsviaget | ||
sendsms | Toplu ve hitaplı SMS gönderme metodudur. Detaylı anlatımı SMS Gönderme başlığında verilmiştir. | |
detailedreport | Detaylı rapor alma metodudur. Detaylı anlatımı Detaylı Rapor Alma başlığında verilmiştir. | |
basicreport | Basit rapor alma metodudur. Detaylı anlatımı Basit Rapor Alma başlığında verilmiştir. | |
groups | Kayıtlı grupları sorgulama metodudur. Grup ID'leri, isimleri ve gruplardaki kayıtlı kişi sayılarını döndürür. | |
groupcontent | Belirli grup veya grupların kişi bilgilerini sorgulama metodudur. Kişilerin ID, ad, soyad, doğum tarihi gibi bilgilerini döndürür. | |
cancelscheduledtasks | İleri tarihli gönderimleri iptal etme metodudur. | |
blacklist | Kara listenizdeki numaraları listeleme metodudur. GSM numaralarını ve kara listeye eklenme tarihlerini döndürür. | |
blacklistadd | Kara listeye numara ekleme metodudur. | |
blacklistremove | Kara listeden numara çıkarma metodudur. |
|
||
Tip | Alabileceği Değer | Açıklama |
String | ||
String |
|
||
Tip | Alabileceği Değer | Açıklama |
String | Almak istediğiniz yanıt |
|
String | Almak istediğiniz yanıt |
Organik API'yi kullanarak SMS gönderimi yapabilmeniz için aboneliğinizin olması gerekmektedir. Eğer aboneliğiniz yoksa buraya tıklayarak ücretsiz aboneliğinizi hızlı bir şekilde başlatabilirsiniz.