MARKAM SMS SMS GÖNDERİM WEB SERVİSLERİ VERSİYON 1.4

Transkript

1 MARKAM SMS SMS GÖNDERİM WEB SERVİSLERİ VERSİYON 1.4 AĞUSTOS 2015

2 1. WEB SERVİS ADRESİ 2. WEB SERVİS METODLARI a. Mesaj Başlığı Listesi Servisi b. Rehberdeki Gruplar Servisi c. Rehberdeki Kişiler Servisi d. Anlık Sms Gönderim Servisi e. Anlık Sms Gönderim Servisi - Son Gönderim Zamanı Kısıtlı f. İleri Tarihli Sms Gönderim Servisi g. OTP (One Time Password Single Shot) SMS Gönderim Servisi h. Kara Listeye Numara Ekleme Servisi 3. WEB SERVİS SONUÇ KODLARI 4. WSDL - 1 -

3 1. WEB SERVİS WSDL ADRESİ 2. WEB SERVİS METODLARI a. GetOriginatorList Mesaj Başlığı Listesi Servisi Kullanıcının mesaj başlıklarını verir. Parametre Zorunlu Veri Tipi Format Açıklama Username Evet String MARKAMSMS sitesindeki kullanıcı adı Password Evet String MARKAMSMS sitesindeki şifre - 2 -

4 b. GetAddressBookGroupList Rehberdeki Gruplar Servisi Kullanıcının adres defterinde kayıtlı grupların listesini verir. Parametre Zorunlu Veri Tipi Format Açıklama Username Evet String MARKAMSMS sitesindeki kullanıcı adı Password Evet String MARKAMSMS sitesindeki şifre - 3 -

5 c. GetAddressBookList Rehberdeki Kişiler Servisi Kullanıcının adres defterinde kayıtlı kişilerin listesini verir. Parametre Zorunlu Veri Tipi Format Açıklama Username Evet String MARKAMSMS sitesindeki kullanıcı adı Password Evet String MARKAMSMS sitesindeki şifre address_book_groupid Evet İnt Adres defteri grup ID si Tüm kişileri almak için 0 verilmeli. Grupsuzları almak için -1 verilmeli. Belirli bir gruptaki kişilerin listesini almak için o grubun ID si verilmeli

6 d. SendInstantSMS Anlık Sms Gönderim Servisi SMS gönderimi hemen başlar. Parametre Zorunlu Veri Tipi Format Açıklama Username Evet String MARKAMSMS sitesindeki kullanıcı adı Password Evet String MARKAMSMS sitesindeki şifre Originator Evet String Mesaj başlığı Message Evet String SMS metni Receipients Evet String 905xxxxxxxxx,905xxxxx xxxx Mesajın gönderileceği telefon numaraları, virgülle ayrılmış şekilde ve her bir numara 905xxxxxxxxx formatında. Division_time Evet İnt Bölerek gönderilmek isteniyorsa her bir gönderim arasındaki süre. (Dakika Cinsinden) Bölerek gönderilmeyece kse değer olarak 0 (Sıfır) girilir. Division_Receiver_ Count Evet İnt Bölerek gönderimlerde her bir pakette gönderilecek adet Bölerek gönderilmeyece kse değer olarak 0 (Sıfır) girilir

7 e. SendInstantSMSSendEndTimeLimited - Anlık Sms Gönderim Servisi - Son Gönderim Zamanı Kısıtlı SMS gönderimi hemen başlar. Belirlediğiniz zamanda sonlanır. Parametre Zorunlu Veri Format Açıklama Tipi Username Evet string MARKAMSMS sitesindeki kullanıcı adı Password Evet string MARKAMSMS sitesindeki şifre Originator Evet string Mesaj başlığı Message Evet string SMS metni Receipients Evet string 905xxxxxxxxx,905xxxxxxx xx Mesajın gönderileceği telefon numaraları, virgülle ayrılmış şekilde ve her bir numara 905xxxxxxxxx formatında. Send_End_Time Evet string dd.mm.yyyy hh:mm Mesajın en son gönderileceği tarih saat. Division_Time Evet int Bölerek gönderilmek isteniyorsa her bir gönderim arasındaki süre. (Dakika Cinsinden) Bölerek gönderilmeyecekse değer olarak 0 (Sıfır) girilir. Division_Receiver_ Count Evet int Bölerek gönderimlerde her bir pakette gönderilecek adet Bölerek gönderilmeyecekse değer olarak 0 (Sıfır) girilir

8 f. SendFutureSMS - İleri Tarihli Sms Gönderim Servisi SMS gönderimi belirlediğiniz tarih ve saatte başlar. Belirlediğiniz zamanda sonlanır. Parametre Zorunlu Veri Format Açıklama Tipi Username Evet string MARKAMSMS sitesindeki kullanıcı adı Password Evet string MARKAMSMS sitesindeki şifre Originator Evet string Mesaj başlığı Message Evet string SMS metni Receipients Evet string 905xxxxxxxxx,905xxxxxxx xx Mesajın gönderileceği telefon numaraları, virgülle ayrılmış şekilde ve her bir numara 905xxxxxxxxx formatında. Send_Start_Time Evet string dd.mm.yyyy hh:mm Mesajın gönderilmeye başlayacağı tarih saat Send_End_Time Evet string dd.mm.yyyy hh:mm Mesajın en son gönderileceği tarih saat. Division_Time Evet int Bölerek gönderilmek isteniyorsa her bir gönderim arasındaki süre. (Dakika Cinsinden) Bölerek gönderilmeyecekse değer olarak 0 (Sıfır) girilir. Division_Receiver_ Count Evet int Bölerek gönderimlerde her bir pakette gönderilecek adet Bölerek gönderilmeyecekse değer olarak 0 (Sıfır) girilir

9 g. SendOTPSMS - OTP (One Time Password Single Shot) SMS Gönderim Servisi OTP sms gönderimi için kullanılır. Parametre Zorunlu Veri Tipi Format Açıklama Username Evet string MARKAMSMS sitesindeki kullanıcı adı Password Evet string MARKAMSMS sitesindeki şifre Originator Evet String Mesaj başlığı Message Evet String SMS metni Receipients Evet String 905xxxxxxxxx,905xxxxxxxx x Mesajın gönderileceği telefon numaraları, virgülle ayrılmış şekilde ve her bir numara 905xxxxxxxxx formatında. Send_End_Time Hayır string dd.mm.yyyy hh:mm Mesajın en son gönderileceği zaman. En geç mesajın gönderilmeye başladığı zamandan itibaren + 5 dakika olmalıdır. Boş bırakılırsa mesajın geçerlilik süresi gönderim başladığı andan itibaren 5 dakikadır. Turkish Evet boolean true veya false Türkçe içerik gönderilecekse true, gönderilmeyecekse false olmalı - 8 -

10 h. AddToBlackList Kara Listeye Numara Ekleme Servisi Kara listeye numara eklenmesini sağlar. Parametre Zorunlu Veri Tipi Format Açıklama Username Evet String MARKAMSMS sitesindeki kullanıcı adı Password Evet String MARKAMSMS sitesindeki şifre Gsm_Numbers Evet String Kara listeye eklenmesini istediğiniz numaralar, virgülle ayrılmış şekilde ve her bir numara 905xxxxxxxxx formatında

11 3. WEB SERVİS SONUÇ KODLARI: Result Code = 00 Result Code = 01 Result Code = 02 Result Code = 03 Result Code = 04 Result Code = 05 Result Description = İşlem başarılı Result Description = Hatalı kullanıcı adı / şifre Result Description = Sms gönderiminde hata oluştu Result Description = Alıcı belirtilmemiş Result Description = Mesaj metni boş Result Description = Numara belirtilmemiş

12 4. WSDL: <?xml version="1.0" encoding="utf-8"?> <wsdl:definitions xmlns:s=" xmlns:soap12=" xmlns:http=" xmlns:mime=" xmlns:tns=" xmlns:soap=" xmlns:tm=" xmlns:soapenc=" targetnamespace=" xmlns:wsdl=" <wsdl:types> <s:schema elementformdefault="qualified" targetnamespace=" <s:element name="getoriginatorlist"> <s:element minoccurs="0" maxoccurs="1" name="username" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="password" type="s:string" /> <s:element name="getoriginatorlistresponse"> <s:element minoccurs="1" maxoccurs="1" name="getoriginatorlistresult" type="tns:originatorresult" /> <s:complextype name="originatorresult"> <s:element minoccurs="0" maxoccurs="1" name="originator_list" type="tns:arrayofstring" /> <s:element minoccurs="0" maxoccurs="1" name="result_code" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="result_description" type="s:string" /> <s:complextype name="arrayofstring"> <s:element minoccurs="0" maxoccurs="unbounded" name="string" nillable="true" type="s:string" /> <s:element name="sendinstantsms"> <s:element minoccurs="0" maxoccurs="1" name="username" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="password" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="originator" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="message" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="receipients" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="division_time" type="s:int" /> <s:element minoccurs="1" maxoccurs="1" name="division_receiver_count" type="s:int" />

13 <s:element name="sendinstantsmsresponse"> <s:element minoccurs="1" maxoccurs="1" name="sendinstantsmsresult" type="tns:smsresult" /> <s:complextype name="smsresult"> <s:element minoccurs="0" maxoccurs="1" name="smsid" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="result_code" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="result_description" type="s:string" /> <s:element name="sendinstantsmssendendtimelimited"> <s:element minoccurs="0" maxoccurs="1" name="username" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="password" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="originator" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="message" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="receipients" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="send_end_time" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="division_time" type="s:int" /> <s:element minoccurs="1" maxoccurs="1" name="division_receiver_count" type="s:int" /> <s:element name="sendinstantsmssendendtimelimitedresponse"> <s:element minoccurs="1" maxoccurs="1" name="sendinstantsmssendendtimelimitedresult" type="tns:smsresult" /> <s:element name="sendfuturesms"> <s:element minoccurs="0" maxoccurs="1" name="username" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="password" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="originator" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="message" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="receipients" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="send_start_time" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="send_end_time" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="division_time" type="s:int" /> <s:element minoccurs="1" maxoccurs="1" name="division_receiver_count" type="s:int" /> <s:element name="sendfuturesmsresponse"> <s:element minoccurs="1" maxoccurs="1" name="sendfuturesmsresult" type="tns:smsresult" />

14 <s:element name="sendotpsms"> <s:element minoccurs="0" maxoccurs="1" name="username" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="password" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="originator" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="message" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="send_end_time" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="receipients" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="turkish" type="s:boolean" /> <s:element name="sendotpsmsresponse"> <s:element minoccurs="1" maxoccurs="1" name="sendotpsmsresult" type="tns:smsresult" /> <s:element name="getaddressbookgrouplist"> <s:element minoccurs="0" maxoccurs="1" name="username" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="password" type="s:string" /> <s:element name="getaddressbookgrouplistresponse"> <s:element minoccurs="1" maxoccurs="1" name="getaddressbookgrouplistresult" type="tns:addressbookgroupresult" /> <s:complextype name="addressbookgroupresult"> <s:element minoccurs="0" maxoccurs="1" name="address_book_group_list" type="tns:arrayofaddressbookgroup" /> <s:element minoccurs="0" maxoccurs="1" name="result_code" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="result_description" type="s:string" /> <s:complextype name="arrayofaddressbookgroup"> <s:element minoccurs="0" maxoccurs="unbounded" name="addressbookgroup" type="tns:addressbookgroup" /> <s:complextype name="addressbookgroup"> <s:element minoccurs="1" maxoccurs="1" name="id" type="s:int" /> <s:element minoccurs="0" maxoccurs="1" name="name" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="record_count" type="s:int" />

15 <s:element name="getaddressbooklist"> <s:element minoccurs="0" maxoccurs="1" name="username" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="password" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="address_book_groupid" type="s:int" /> <s:element name="getaddressbooklistresponse"> <s:element minoccurs="1" maxoccurs="1" name="getaddressbooklistresult" type="tns:addressbooklistresult" /> <s:complextype name="addressbooklistresult"> <s:element minoccurs="0" maxoccurs="1" name="address_book_list" type="tns:arrayofaddressbooklist" /> <s:element minoccurs="0" maxoccurs="1" name="result_code" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="result_description" type="s:string" /> <s:complextype name="arrayofaddressbooklist"> <s:element minoccurs="0" maxoccurs="unbounded" name="addressbooklist" type="tns:addressbooklist" /> <s:complextype name="addressbooklist"> <s:element minoccurs="1" maxoccurs="1" name="id" type="s:int" /> <s:element minoccurs="0" maxoccurs="1" name="name" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="surname" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="gsm_number" type="s:string" /> <s:element name="addtoblacklist"> <s:element minoccurs="0" maxoccurs="1" name="username" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="password" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="gsm_numbers" type="s:string" /> <s:element name="addtoblacklistresponse"> <s:element minoccurs="1" maxoccurs="1" name="addtoblacklistresult" type="tns:result" />

16 <s:complextype name="result"> <s:element minoccurs="0" maxoccurs="1" name="result_code" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="result_description" type="s:string" /> </s:schema> </wsdl:types> <wsdl:message name="getoriginatorlistsoapin"> <wsdl:part name="parameters" element="tns:getoriginatorlist" /> <wsdl:message name="getoriginatorlistsoapout"> <wsdl:part name="parameters" element="tns:getoriginatorlistresponse" /> <wsdl:message name="sendinstantsmssoapin"> <wsdl:part name="parameters" element="tns:sendinstantsms" /> <wsdl:message name="sendinstantsmssoapout"> <wsdl:part name="parameters" element="tns:sendinstantsmsresponse" /> <wsdl:message name="sendinstantsmssendendtimelimitedsoapin"> <wsdl:part name="parameters" element="tns:sendinstantsmssendendtimelimited" /> <wsdl:message name="sendinstantsmssendendtimelimitedsoapout"> <wsdl:part name="parameters" element="tns:sendinstantsmssendendtimelimitedresponse" /> <wsdl:message name="sendfuturesmssoapin"> <wsdl:part name="parameters" element="tns:sendfuturesms" /> <wsdl:message name="sendfuturesmssoapout"> <wsdl:part name="parameters" element="tns:sendfuturesmsresponse" /> <wsdl:message name="sendotpsmssoapin"> <wsdl:part name="parameters" element="tns:sendotpsms" /> <wsdl:message name="sendotpsmssoapout"> <wsdl:part name="parameters" element="tns:sendotpsmsresponse" /> <wsdl:message name="getaddressbookgrouplistsoapin"> <wsdl:part name="parameters" element="tns:getaddressbookgrouplist" /> <wsdl:message name="getaddressbookgrouplistsoapout"> <wsdl:part name="parameters" element="tns:getaddressbookgrouplistresponse" /> <wsdl:message name="getaddressbooklistsoapin"> <wsdl:part name="parameters" element="tns:getaddressbooklist" /> <wsdl:message name="getaddressbooklistsoapout"> <wsdl:part name="parameters" element="tns:getaddressbooklistresponse" /> <wsdl:message name="addtoblacklistsoapin"> <wsdl:part name="parameters" element="tns:addtoblacklist" /> <wsdl:message name="addtoblacklistsoapout"> <wsdl:part name="parameters" element="tns:addtoblacklistresponse" /> <wsdl:porttype name="desmsservicesoap">

17 <wsdl:operation name="getoriginatorlist"> <wsdl:documentation xmlns:wsdl=" Başlıkları</wsdl:documentation> <wsdl:input message="tns:getoriginatorlistsoapin" /> <wsdl:output message="tns:getoriginatorlistsoapout" /> <wsdl:operation name="sendinstantsms"> <wsdl:documentation xmlns:wsdl=" Gönderim Servisi - Gönderim Aynı Anda Başlar</wsdl:documentation> <wsdl:input message="tns:sendinstantsmssoapin" /> <wsdl:output message="tns:sendinstantsmssoapout" /> <wsdl:operation name="sendinstantsmssendendtimelimited"> <wsdl:documentation xmlns:wsdl=" Gönderim Servisi - Gönderim Aynı Anda Başlar, Son Gönderim Zamanı Kısıtlı</wsdl:documentation> <wsdl:input message="tns:sendinstantsmssendendtimelimitedsoapin" /> <wsdl:output message="tns:sendinstantsmssendendtimelimitedsoapout" /> <wsdl:operation name="sendfuturesms"> <wsdl:documentation xmlns:wsdl=" Tarihli SMS Gönderim Servisi</wsdl:documentation> <wsdl:input message="tns:sendfuturesmssoapin" /> <wsdl:output message="tns:sendfuturesmssoapout" /> <wsdl:operation name="sendotpsms"> <wsdl:documentation xmlns:wsdl=" SMS Gönderim Servisi - One Time Password / Single Shot Sms Gönderimi</wsdl:documentation> <wsdl:input message="tns:sendotpsmssoapin" /> <wsdl:output message="tns:sendotpsmssoapout" /> <wsdl:operation name="getaddressbookgrouplist"> <wsdl:documentation xmlns:wsdl=" Gruplar</wsdl:documentation> <wsdl:input message="tns:getaddressbookgrouplistsoapin" /> <wsdl:output message="tns:getaddressbookgrouplistsoapout" /> <wsdl:operation name="getaddressbooklist"> <wsdl:documentation xmlns:wsdl=" Kayıtlar</wsdl:documentation> <wsdl:input message="tns:getaddressbooklistsoapin" /> <wsdl:output message="tns:getaddressbooklistsoapout" /> <wsdl:operation name="addtoblacklist"> <wsdl:documentation xmlns:wsdl=" Listeye Numara Ekleme</wsdl:documentation> <wsdl:input message="tns:addtoblacklistsoapin" /> <wsdl:output message="tns:addtoblacklistsoapout" /> </wsdl:porttype> <wsdl:binding name="desmsservicesoap" type="tns:desmsservicesoap"> <soap:binding transport=" /> <wsdl:operation name="getoriginatorlist"> <soap:operation soapaction=" style="document" />

18 <wsdl:operation name="sendinstantsms"> <soap:operation soapaction=" style="document" /> <wsdl:operation name="sendinstantsmssendendtimelimited"> <soap:operation soapaction=" style="document" /> <wsdl:operation name="sendfuturesms"> <soap:operation soapaction=" style="document" /> <wsdl:operation name="sendotpsms"> <soap:operation soapaction=" style="document" /> <wsdl:operation name="getaddressbookgrouplist"> <soap:operation soapaction=" style="document" /> <wsdl:operation name="getaddressbooklist"> <soap:operation soapaction=" style="document" />

19 <wsdl:operation name="addtoblacklist"> <soap:operation soapaction=" style="document" /> </wsdl:binding> <wsdl:binding name="desmsservicesoap12" type="tns:desmsservicesoap"> <soap12:binding transport=" /> <wsdl:operation name="getoriginatorlist"> <soap12:operation soapaction=" style="document" /> <wsdl:operation name="sendinstantsms"> <soap12:operation soapaction=" style="document" /> <wsdl:operation name="sendinstantsmssendendtimelimited"> <soap12:operation soapaction=" style="document" /> <wsdl:operation name="sendfuturesms"> <soap12:operation soapaction=" style="document" /> <wsdl:operation name="sendotpsms"> <soap12:operation soapaction=" style="document" />

20 <wsdl:operation name="getaddressbookgrouplist"> <soap12:operation soapaction=" style="document" /> <wsdl:operation name="getaddressbooklist"> <soap12:operation soapaction=" style="document" /> <wsdl:operation name="addtoblacklist"> <soap12:operation soapaction=" style="document" /> </wsdl:binding> <wsdl:service name="desmsservice"> <wsdl:port name="desmsservicesoap" binding="tns:desmsservicesoap"> <soap:address location=" /> </wsdl:port> <wsdl:port name="desmsservicesoap12" binding="tns:desmsservicesoap12"> <soap12:address location=" /> </wsdl:port> </wsdl:service> </wsdl:definitions>