CMFCELL kendi uygulamalarını ve farklı sistemleri kısa mesaj yetenegi ile donatmak isteyen kullanıcılar için HTTP/S - XML destegi sunmaktadır.
Bu yazıda bu servisin nasıl kullanılcagı ve desteklenen xml yapısı hakkında bilgi verilir. Bu servisin adresi http://app.cmfcell.com/httppost/requestxml.aspx dir.Genel kullanım için Kullanıcı adı:"test" Şifre:"test" olan kullanıcı mevcuttur.
XML Yöntemleri
SMS to many
Aynı mesajı birden fazla kişiye gönderir. "username-CID" ve "password" CMFCell tarafından size sağlanan kullanıcı adı,bayi kodu (CID*) ve şifrenizdir. Max 160 karekterlik mesajınızı <Mesgbody>Mesajınız</Mesgbody> tagları arasına yerleştirin. Mesajınızdaki bilinen türkçe karekterler (ş,İ,ö) bilinen karşılıkları (s,I,o) ile değiştirlir özel karekterler ise (enter[\n] ve ya tab[\t]) temizlenir. Sağlıklı bir gönderim için bu işlemleri mesajı post etmeden önce sizin yapmanızdır.
Mesajın gönderilceği telefon numralarını <Numbers> </Numbers> taglar arasına 905321234567,905421234567 şekinde virgülle ayırarak giriniz. Telefon numaraları içinde formata uymayan bir telefon numarası bulunması mesajınızın gönderilmesini engeller.
Gönderdiğiniz mesajın alıcı telefonunda kimden satırında görüntülenecek olan max 11 karekterlik originatörü <Originator>Cmfcell.com</Originator> tagları arasına yerşleştirin. Sistemde sizin adınıza kayıtlı olmayan originatörü kullanamazsınız. Originatörler Büyük/Küçük harf duyarlıdır ve yanlış yazmanız durumunda sistem mesajınızı göndermeyecektir. Originatör alanını boş bırakarak default originatör üzerinden gönderim yapılmasını sağlayabilirsiniz.
Mesajınızın alıcıya ileri bir tarihte teslim edilmesini istiyorsanız <SDate></SDate> tagları arasına mesajın iletilmesini istediğiniz tarihi "yyyaaggssdd" formatında girin. örneğin "200408142210" katarı 18 Ağustos 2004 22:10 'a karşılık gelir. İleri tarihli mesajların iptal edilme durumu yoktur ve mevcut tarihden daha geride girilen tarihlerde mesaj anında gönderilir. Mesajınız başarı ile gönderildiğinde geriye "ID:xxxxxxx" şekinde mesaj id si döner. Gönderim esnasında bir hata oluşmasında ise hata mesajı iletilir. Hata mesajlarının tam listesini bu dökümanın ilerleyen bölümlerinde bulabilirisniz.
<MainmsgBody>
<UserName>username-CID</UserName>
<PassWord>password</PassWord>
<Action>0</Action>
<Mesgbody>your message</Mesgbody>
<Numbers>905321234567,905421234567</Numbers>
<Originator></Originator>
<SDate></SDate>
</MainmsgBody>
Dönüş değeri:"ID:1368"
SMS MultiSenders
Birden fazla kişiye özel mesaj gönderilmesini sağlar. Bunun dışında "SMS To Many" yöntemi için geçerli olan herşey bu yöntem içinde geçerlidir.
<MainmsgBody>
<UserName>username-CID</UserName>
<PassWord>password</PassWord>
<Action>1</Action>
<Messages>
<Message>
<Mesgbody>your message1</Mesgbody>
<Number>905321234567</Number>
</Message>
<Message>
<Mesgbody>your message2</Mesgbody>
<Number>905421234567</Number>
</Message>
</Messages>
<Originator></Originator>
<SDate></SDate>
</MainmsgBody>
Dönüş değeri:"ID:1368"
Tarih Bazında Rapor
iki tarih arasında gönderilmiş mesajların ID lerini listeler. Tarih formatı "YYYY-AA-GG" şeklindedir.
<MainReportRoot>
<UserName>username-CID</UserName>
<PassWord>password</PassWord>
<Action>2</Action>
<FDate>2004-03-21</FDate>
<LDate>2004-04-21</LDate>
</MainReportRoot>
Dönüş değeri:
1187
1188
1189
1190
ID Bazında Rapor
ID si verilen mesajın durumunu döndür.Mesaj ID si mesaj gönderiminde dönenen "ID:xxxxxxx" satırının "ID:" den sonraki kısmıdır.Dönüş değeri "[ID] [GsmNO] [Durum]" şekindedir. Mesaj Durumu "1-Mesaj Beklemede" ,"2-Mesaj Başarı ile İletildi","3-Mesaj iletilemedi Numara kullanılmıyor yada telefonun mesaj hafızası dolu" şeklinde üç farklı konumda olabilir. Gönderdiğiniz mesajların gönderilme süresi 24 saat olup 24 içinde alıcısına ulaştırılamayan mesajların durumu "3" olarak set edilir.
<MainReportRoot>
<UserName>username-CID</UserName>
<PassWord>password</PassWord>
<Action>3</Action>
<MsgID>yourmessageID</MsgID>
</MainReportRoot>
Dönüş Değeri:
1192 905555020856 3
1192 905555047525 2
1192 905555056888 2
1192 905555061617 3
1192 905555108260 1
1192 905555155750 1
1192 905555225770 3
Originatör ve Kontör Raporu
Kullanıcıya ait kontör miktarını ve originatör listesini döndürürür.
<MainReportRoot>
<UserName>username-CID</UserName>
<PassWord>password</PassWord>
<Action>4</Action>
</MainReportRoot>
Dönüş değeri:
210
Cmfcell.com
CmfCELL
Çift taraflı sms yöntemleri
Hesabınıza tanımlanan kısa numaraya (ör:5133) veya 5320001234 gibi sanal numaraya gönderilen sms mesajlarını
xml post yötemi ile alabilirsiniz.
GetIncomingMessage
Kullanıcı hesabındaki okunmamış olan ilk mesajı döndürür. Bir sonraki mesaja geçmek için MoveNextIncomingMessage yötemimi
kullanılmalıdır.
Tüm mesajlar okunmuş ise sistem "7" nolu hata kodunu döndürür.
<incoming>
<UserName>username-CID</UserName>
<PassWord>password</PassWord>
<Action>10</Action>
</incoming>
Dönen Deger :
<message>
<id>812</id>
<from>905332669297</from>
<to>5133</to>
<date>2008-01-12 13:16:00</date>
<type>Sms</type>
<subject></subject>
<content>cift tarafli sms icin test mesajidir.</content>
</message>
MoveNextIncomingMessage
Kullanıcı hesabındaki son mesajı okundu olarak işretler. İşlem başarılı ise "OK+" döner.
<incoming>
<UserName>username-CID</UserName>
<PassWord>password</PassWord>
<Action>11</Action>
</incoming>
Dönen Değer :
OK+
Hata Kodları
Sistem tarafından üretilebilecek hata kodları ve açıklamaları aşağıdadır.
01 Hatalı Kullanıcı Adı - Parola - Company
02 Yetersiz Kredi
03 Tanımsız Action
04 Gelen XML Yok
05 XML Nodu Eksik veya Hatalı
06 Tanımsız Originator
07 MsgId Yok
08 Verilen Tarihlerde Gönderilmiş Rapor Yok
09 Tarih Alanları Boş - Hatalı
10 SMS Gönderilemedi.
11 Tanımlanamıyan Hata
12 Admin Yetkisi İle Ulaşılabilecek Alana Adminden Başkası Ulaşmaya Çalıştı.
13 Rapor istenen user yok
14 Ekesik bilgi girişi. Yeni user açılamadı.
15 Eklenmeye Çalışan User Mevcut
16 User Başarı İle Eklendi