API erişimi için yöntem.

Basic authorization

Bu durumda, Yetkilendirme başlığında yer alan kimlik bilgileri Base64 ile kodlanmış bir kullanıcı adı ve şifre kombinasyonu olmalıdır.

Daha resmi olarak, temel kimlik doğrulama başlığı üç adımda oluşturulabilir:
Kullanıcı adı ve parola, kolon (:) ile ayırıcı kullanıcı:parola kullanılarak birleştirilir.
Ortaya çıkan dize, Base64'ün RFC2045-MIME varyantı kullanılarak kodlanır.
Kodlanmış dize, "Temel" türünden sonra kimlik bilgileri olarak eklenir.


Örnek:
Kullanıcı adı: "test"
Şifre: "1234" Birleştirilmiş dize: "test:1234"
Base64 kodlanmış dizesi: "dGVzdDoxMjM0"
Authorization başlığı: "Basic dGVzdDoxMjM0"

Birden fazla numaraya farklı içerikli kısa mesaj gönderimi için kullanılmaktadır..


POST /sms/1/advanced HTTP/1.1
Host: api.modexi.com
Authorization: Basic dGVzdDoxMjM0
Content-Type: application/json

{
    "from": "MODEXI",
    "text": "Merhaba, destek talebiniz alinmistir.",
    "validityPeriod": 30,
    "scheduledDate": "DateTime",
    "destinations":[
        {
            "to": "905320001122"
        }
    ]
}

Alanlar ve açıklamaları

from Alfanumeric eya numeric olabilen bir gönderen kimliğini temsil eder. Alfanumeric gönderici kimliği uzunluğu 3 ila 11 karakter arasında olmalıdır (Örnek: Şirket Adı).
Numeric gönderici kimliği uzunluğu 3 ila 14 karakter arasında olmalıdır.
text Kısa mesaj içeriği.

Önemli
validityPeriod Mesaj geçerlilik süresi dakika cinsinden. Süre dolduğunda, iletinin gönderilmesine izin verilmeyecektir. 10 dakikadan kısa ve 48 saatten uzun geçerlilik süresi desteklenmez (bu durumda, otomatik olarak 48 saate ayarlanır).
scheduledDate İleri tarihli SMS gönderilmek isteniyorsa kullanılır. ISO kodlama biçiminde ve UTC formatında olması gerekmektedir.
Örnek : 2013-08-23T09:15:00
http://en.wikipedia.org/wiki/ISO_8601

Önemli Gönderim yapılan bölge Türkiye ise gönderilecek zaman UTC formatına çevirilmelidir.

Önemli Eğer ileri tarihli mesaj gönderilmek istenilmiyorsa scheduledDate boş gönderilmelidir.
destinations Kısa mesajı göndermek istediğiniz numaraları ve gerektiğinde her bir numaraya gidecek parametreleri belirttiğiniz alandır.

to Gönderim yapılacak telefon numarasını bu alana yazmanız gerekemektedir.
fields Mesaj metni içerisinde alıcıya göre değişkenlik gösteren bir alan var ise örnekte gösterildiği şekilde parametrik mesaj gönderilebilir.
Önemli Kullanım için lütfen iletişime geçiniz.
                    
{
    "errorCode" : 200,
    "errorDescription": "İşlem başarılı.",
    "result": {
        "messageCode": "397467",
        "messages": []
    }
}

Alanlar ve açıklamaları

errorCode Durum kodudur. Eğer işlem başarılı ise 200 döner. Durum Kodu Listesi
errorDescription Durum koduna bağlı olarak dönen açıklamadır. Durum Kodu Listesi
result Talebe sunucu tarafından gelen cevap içeriği varsa bu alanda sunulur.

messageCode Sisteme gönderdiğiniz mesajın mesaj numarasıdır. Rapor sorgulamanız için bu numara gerekmektedir.
messages Boş döndürülür. Özel bir durum oluşması durumunda gönderilen mesajlara ilişkin bilgiler dönebilir.

Gönderici adı listesi döner.


GET /sms/1/senders HTTP/1.1
Host: api.modexi.com
Authorization: Basic dGVzdDoxMjM0
Accept: application/json


{
    "errorCode": 200,
    "errorDescription": "İşleminiz başarılı şekilde tamamlandı.",
    "result": [
        {
            "value": "MODEXI"
        },
        {
            "value": "MODEXI VERI"
        }
    ]
}

Alanlar ve açıklamaları

errorCode Durum kodudur. Eğer işlem başarılı ise 200 döner. Durum Kodu Listesi
errorDescription Durum koduna bağlı olarak dönen açıklamadır. Durum Kodu Listesi
result Alfanumeric gönderici adlarının döndüğü alandır.

value Gönderici adı bilgisini bu alandan okuyabilirsiniz.

SubmitMulti metodu birden fazla numaraya farklı içerikli kısa mesaj gönderimi için kullanılmaktadır.

                    
POST /sms/1/reports HTTP/1.1
Host: api.modexi.com
Authorization: Basic dGVzdDoxMjM0
Content-Type: application/json

{
    "messageCode": "397467",
    "limit": 100
}
                    

Alanlar ve açıklamaları

messageCode Sisteme gönderdiğiniz mesajın mesaj numarasıdır. Rapor sorgulamanız için bu numara gerekmektedir.
limit Sorguda dönecek maks. değeri ifade eder. Varsayılan değeri 1000'dir.
                    
{
    "errorCode": 200,
    "errorDescription": "",
    "result": [
        {
            "messageId": 60757031,
            "to": "2127053535",
            "from": "Modexi",
            "text": "Mesaj  B236",
            "sentAt": "2018-02-02 09:39:39",
            "doneAt": "",
            "smsCount": 1,
            "status": {
                "code": 300,
                "name": ""
            }
        },
        {
            "messageId": 60757033,
            "to": "2165386000",
            "from": "Modexi",
            "text": "Yuce Rabbim bizlere saglik, huzur, mutluluk ve bol kazanc nasip etsin. B236",
            "sentAt": "2018-02-02 09:39:39",
            "doneAt": "",
            "smsCount": 1,
            "status": {
                "code": 300,
                "name": ""
            }
        }
    ]
}
                                    

Alanlar ve açıklamaları


errorCode Durum kodudur. Eğer işlem başarılı ise 200 döner. Durum Kodu Listesi
errorDescription Durum koduna bağlı olarak dönen açıklamadır. Durum Kodu Listesi
result Alfanumeric gönderici adlarının döndüğü alandır.

messageId Gönderilen mesajı benzersiz olarak tanımlayan kimlik.
to Mesaj alıcısı.
from Alfanumeric veya numeric olabilen gönderici kimliği.
text Gönderilen mesaj metni.
sentAt SMS gönderildiğinde söyler. Aşağıdaki biçime sahiptir.
yyyy-MM-dd'T'HH:mm:ss.
doneAt SMS'in Modexi tarafından işlenmesi tamamlandığında (yani hedefe teslim edildiğinde, hedef ağa teslim edildiğinde vb.) Bilgi verir.
smsCount Gönderilen mesaj segmentlerinin sayısı.
status
code Mesaj durum kodudur. Eğer mesaj başarılı ise 10 döner. Mesaj Durum Listesi
name Mesaj durum kodudur. Yazılı olarak mesaj durumlarını bildirir. Mesaj Durum Listesi

Kredi adetinizi öğrenmenizi sağlar.


GET /account/balance HTTP/1.1
Host: api.modexi.com
Authorization: Basic dGVzdDoxMjM0
Accept: application/json


{
    "errorCode": 200,
    "errorDescription": "İşleminiz başarılı şekilde tamamlandı.",
    "result": {
        "balance": 0,
        "currency": "TRY",
        "smsDetail": {
            "total": 53484
        }
    }
}

Alanlar ve açıklamaları

errorCode Durum kodudur. Eğer işlem başarılı ise 200 döner. Durum Kodu Listesi
errorDescription Durum koduna bağlı olarak dönen açıklamadır. Durum Kodu Listesi
balance Bakiyenizde bulunan tutar döndürülür. Doğrudan paket alımı yapıldı ise hesabınızda bakiye olmayabilir.
currency Para birimi.
smsDetail Kredi durumunuz bu alanda döner. Gönderebileceğiniz toplam mesaj sayısı Limit ve Main alanlarının toplamı kadardır.

total Kullanılabilir SMS kredisini ifade eder.

Token oluşturarak Müşteri paneline şifresiz erişim sağlayabilirsiniz.


GET /account/token HTTP/1.1
Host: api.modexi.com
Authorization: Basic dGVzdDoxMjM0
Accept: application/json


{
    "errorCode": 200,
    "errorDescription": "İşleminiz başarılı şekilde tamamlandı.",
    "result": {
        "privateKey": "20978adf4e924248a364780593771e9e"
    }
}

Alanlar ve açıklamaları

privateKey Talep ettiğiniz ip adresiniz üzerinden 3dk. içerisinde oluşan kod ile panelimize erişebilirsiniz.

Önemli Bağlantı adresi: https://portal.modexi.com/login/auth?hash=ANAHTAR