Toplu E-Mail API | Toplu E-Posta API | Toplu Mail API

Toplu E-Mail APIAna Sayfa


	API Tipi
	Fonksiyonlar


	API Adresi
	UniMsg Toplu E-Mail API Örnek Kodları

UniMsg Toplu E-Posta API Kullanım Kılavuzunu indirmek için TIKLAYINIZ!

API Tipi

UNIMSG.ORG entegrasyon API’si sadece SOAP web servisi olarak tasarlanmıştır. SOAP desteği olan programlama dilleri tarafından entegrasyonu için kolay entegrasyon araçları bulunmaktadır. SOAP desteği olmayıp internete ulaşabilen yazılım dilleri tarafından SOAP başlıkları programcı tarafından yaratılarak HTTP Post yöntemi ile entegrasyon yapılabilir.

API Adresi

SOAP destekli yazılım dilleri için wsdl dosyasına http//serveraddress/api?wsdl'dir. Eğer entegre edilen servis için özel bir adres belirtilmezse; serveraddress = stargate.unimsg.org şeklinde olur. Bundan sonraki bölümlerde entegrasyon adresi olarak stargate.unimsg.org kullanılacaktır.

SOAP desteği olmayan yazılım dilleri için oluşturulmuş olan SOAP başlıklarını içeren doğru formattaki XML ifadesinin POST edileceği adres şu şekildedir: http://stargate.unimsg.org/api

Aşağıda anlatılan fonksiyon detayları programın kabiliyet ve sınırlarını anlayabilmek için önemlidir. Aşağıda verilen açıklamalara ek olarak entegrasyon yapacak programcıya yardımcı olabilmesi açısından java ve. net dillerinde başlangıç projeleri örnek olarak verilmiştir.

Fonksiyonlar

UniMsg API’nin, Userinfo, sendmail, reportbydate ve reportbypacketid olmak üzere 4 adet fonksiyonu bulunmaktadır.

Userinfo:

Kullanıcının adı, kredisi ve e-posta gönderimi yapabileceği adres listesini geri döner. userinforeturn sınıfından bir değer döndürür.

userinfo fonksiyonunun çalışabilmesi için beraberinde verilmesi gereken değişkenler aşağıdaki gibidir:

Alan Adı	Tipi	Zorunlu	Açıklama
username	String	E	Sistemde tanımlanmış kullanıcı adı
vendorcode	String	E	Sistemde tanımlanmış alt dağıtıcı kodu
password	String	E	Sistemde tanımlanmış parola

userinforeturn aşağıdaki gibidir:

Alan Adı	Tipi	Açıklama
successes	boolean	Yapılan işlemin başarı durumunu belirten bir true, false değeri döner.
errcode	int	Yapılan işlem başarısız ise 0’dan farklı bir değer alır.
errdescription	String	Yapılan işlem başarısız ise oluşan hatanın detay metnini verir.
credit	int	Yapılan işlem başarılı ise kullanıcının kredi bilgisini verir.
fullname	String	Yapılan işlem başarılı ise kullanıcının firma adı bilgisini verir.
contactname	String	Yapılan işlem başarılı ise kullanıcının kontak kişi adı bilgisini verir.
addresspack[]	maddress	Yapılan işlem başarılı ise kullanıcının e-posta adreslerini içeren dizi

maddress sınıfı aşağıdaki gibidir:

Alan Adı	Tipi	Açıklama
mailaddress	String	E-posta adresi
sendername	String	Görünen isim

sendmail:

Mail gönderimi için kullanılan fonksiyondur. Fonksiyona gönderdiğiniz değerlere karşılık olarak sendmailreturnsınıfından bir değer geri döndürür.

sendmail fonksiyonunun çalışabilmesi için beraberinde verilmesi gereken değişkenler aşağıdaki gibidir:

Alan Adı	Tipi	Zorunlu	Açıklama
username	String	E	Sistemde tanımlanmış kullanıcı adı
vendorcode	String	E	Sistemde tanımlanmış alt dağıtıcı kodu
password	String	E	Sistemde tanımlanmış parola
description	String	E	Mail gönderimini tanımlayan açıklama alanı. Max: 200 karakter
mailsubject	String	E	Gönderilen mail için alıcı tarafından çıkacak olan konu alanı. Max: 200 karakter
mailaddress	String	E	Gönderim yapılacak olan e-posta adresi. Sistem yöneticileri tarafından tanımlanır. Birden fazla gönderici adı tanımlanabilir. Bu tanımlardan bir tanesinin adı verilmelidir.
mailtemplate	String	E	Gönderilecek olan e-postanın içerik mesajıdır. Mesaj içerisinde text veya html veriler girilebilir. E-posta tasarımı içerisinde e-posta gönderilecek kişiye özel alanlar gitmesi gerekiyorsa “innerdata” input nesnesinde verilecek olan alan adı e-posta içerisinde @@alanadı@@ şeklinde belirtilmelidir. Örnek vermek gerekirse innerdata alanında name, surname şeklinde değişkenler verildi ise gönderilecek olan e-posta içerisine; “Merhaba @@name@@ @@surname@@” yazılması durumunda e-posta gönderilecek her kişiye innerdata içerisinden bu alanlar alınarak gönderim yapılacaktır. E-posta gönderimi içerisine resim eklenmek isteniyor ve bu resim bir http sunucusunda bulunuyor ise bu resmin url'ini vermek yeterlidir. Resim yerel bilgisayarda bulunuyor ve müşterinin bir http sunucusu yok ise eklenecek resimler images[] dosya dizisine konmalıdır. İmajların isimleri e-posta içerisine @@dosyatamadı@@ şekilde verilirse bu resim adresleri uygun şekilde değiştirilerek görüntülenmesi sağlanacaktır. Örnek olarak, Max: 9000 karakter.
mailfieldname	String	E	Innerdata sınıfı içerisinde belirtilen ve e-posta gönderilecek kişilerin e-posta adreslerinin bulunduğu alanın adıdır.
innerdata	String[][]	E	Innerdata alanı. E-posta gönderimi yapılacak e-posta adresleri ve e-posta içerisinde görüntülenecek olan özel alanların bulunduğu 2 boyutlu bir dizidir. Dizi bir grid şeklinde tasarlanmıştır ve gridin ilk satırı değişken adları diğer satırları ise veriyi simgeler.
images	file[]	H	Mailtemplate bölümünde de açıklaması yapıldığı gibi müşterinin kendisine ait bir http sunucusu yok ise veya e-posta içerisine eklenecek olan resim bir http sunucusunda bulunmuyor ise müşterinin e-posta içerisine ekleyeceği resimlerdir. Her resim max. 200 Kb boyutunda olmalı ve max. 10 resim girilmelidir.
attachments	file[]	H	E-posta ekinde dosyalar gönderilmek isteniyor ise gönderilecek dosyaları içeren dizidir. Her dosya max. 200 Kb olabilir ve max. 5 dosya eklenebilir.
startdate	String	H	Gönderilmek istenen e-posta ileri tarihli olarak gönderilmek isteniyor ise doldurulması gereken tarih alanıdır. “YYYY-MM-DD HH-MM-SS” örnek olarak “2012-06-01 13:00:00”

Sendmail fonksiyonu çağırıldığında geriye dönen sendmailreturn sınıfı aşağıdaki değişkenleri içermektedir:

Alan Adı	Tipi	Açıklama
successes	boolean	Yapılan işlemin başarı durumunu belirten bir true, false değeri döner.
errcode	int	Yapılan işlem başarısız ise 0’dan farklı bir değer alır.
errdescription	String	Yapılan işlem başarısız ise oluşan hatanın detay metnini verir.
packetid	String	Yapılan işlem başarılı ise gönderilen e-postayı raporlayabilmek için geriye dönen tekil değerdir.

reportbydate:

İki tarih arasında yapılan gönderimleri paket bazında listeleyen rapordur. Fonksiyon çağırıldığında reportbydatereturn sınıfında bir değişken döndürür.
sendmail fonksiyonunun çalışabilmesi için beraberinde verilmesi gereken değişkenler aşağıdaki gibidir:

Alan Adı	Tipi	Zorunlu	Açıklama
username	String	E	Sistemde tanımlanmış kullanıcı adı
vendorcode	String	E	Sistemde tanımlanmış alt dağıtıcı kodu
password	String	E	Sistemde tanımlanmış parola
firstdate	String	E	İstenen raporun başlangıç tarihidir. “YYYY-MM-DD HH-MM-SS” örnek olarak “2012-06-01 13:00:00”
lastdate	String	E	İstenen raporun bitiş tarihidir. “YYYY-MM-DD HH-MM-SS” örnek olarak “2012-08-01 13:00:00”

Fonksiyon çağırıldığında geriye dönen reportbydatereturn sınıfı aşağıdaki gibidir:

Alan Adı	Tipi	Açıklama
successes	boolean	Yapılan işlemin başarı durumunu belirten bir true, false değeri döner.
errcode	int	Yapılan işlem başarısız ise 0’dan farklı bir değer alır.
errdescription	String	Yapılan işlem başarısız ise oluşan hatanın detay metnini verir.
packetreport[]	packetreport	Yapılan işlem başarılı ise packetreport sınıfında bir dizi içerir.

packetreport sınıfı aşağıdaki gibidir:

Alan Adı	Tipi	Açıklama
packetid	String	Pakete ait tekil sembol
mailaddress	String	Gönderim yapılan e-posta adresi
sendername	String	Gönderim yapılan e-posta adresinin karşı tarafta görüntülenen adı
senddate	String	Sisteme gönderim tarihi
startdate	String	E-postanın alıcılara gönderilmeye başladığı tarih
description	String	E-posta kampanyasının açıklaması
mailsubject	String	Gönderilen e-postalarda konu kısmında görüntülenen değer
mailcount	int	Gönderilen e-posta adresi
status	int	Gönderilen e-posta paketinin durumu: 0 Beklemede 1 Gönderim tamamlandı 9 Gönderiliyor

reportbypacketid:

Gönderilen bir e-postaya ait gönderim durumu, okunma, tıklanma ve listeden çıkma durumlarını detaylı olarak listeleyen fonksiyondur. reportbypacketidreturn sınıfında bir değer döndürür.

reportbypacketid fonksiyonunun çalışabilmesi için beraberinde verilmesi gereken değişkenler aşağıdaki gibidir:

Alan Adı	Tipi	Zorunlu	Açıklama
username	String	E	Sistemde tanımlanmış kullanıcı adı
vendorcode	String	E	Sistemde tanımlanmış alt dağıtıcı kodu
password	String	E	Sistemde tanımlanmış parola
packetid	String	E	E-posta gönderim paketini simgeleyen tekil ifade

Reportbypacketidreturn sınıfı aşağıdaki gibidir:

Alan Adı	Tipi	Açıklama
successes	boolean	Yapılan işlemin başarı durumunu belirten bir true, false değeri döner.
errcode	int	Yapılan işlem başarısız ise 0’dan farklı bir değer alır.
errdescription	String	Yapılan işlem başarısız ise oluşan hatanın detay metnini verir.
emailreport[]	emailreport	E-posta gönderimine ait gönderilen kişilerin listesi, gönderim veya hata durumları okuma durumlarını içeren raporun yer aldığı sınıftır.
readreport[]	readreport	E-posta gönderimine ait okuyan kişilerin hangi tarihlerde ve hangi IP’lerden okuduklarının listesini içeren sınıftır.
linkreport[]	linkreport	E-posta içerisinde yer alan linklerden hangi e-postalarda hangi linklere ne zaman tıkladığını içeren sınıftır.
unsubscribereport[]	unsubscribereport	E-posta gönderim listesinden çıkmak isteyen kişilerin listesini içeren sınıftır.

emailreport sınıfı aşağıdaki gibidir:

Alan Adı	Tipi	Açıklama
messageid	String	Gönderilen e-postaya ait tekil ifadedir
email	String	Gönderilen e-posta adresi
status	int	Gönderilen e-postanın durumu. 0 e-posta karşı sunucuya gönderilmeyi bekliyor 1 e-posta karşı sunucuya gönderildi 2 e-posta okundu 3 e-posta karşı sunucuya gönderilemedi
returncode	String	Eğer status 3 ise SMTP hata kodunu içerir
returnvalue	String	Eğer status 3 ise SMTP hata mesajını içerir
readcount	int	Eğer status 2 ise kaç kere okunduğunu içerir
createdate	String	E-postanın yaratıldığı tarih
senddate	String	E-postanın gönderildiği tarih
lastreaddate	String	Son okuma tarihi

readreport sınıfı aşağıdaki gibidir:

Alan Adı	Tipi	Açıklama
messageid	String	Gönderilen e-postaya ait tekil ifadedir
email	String	Gönderilen e-posta adresi
readdate	String	Okunduğu tarih
readip	String	Okunduğu IP

linkreport sınıfı aşağıdaki gibidir:

Alan Adı	Tipi	Açıklama
messageid	String	Gönderilen e-postaya ait tekil ifadedir
email	String	Gönderilen e-posta adresi
url	String	Tıklanan url
clickdate	String	Tıklama tarihi

unsubscribereport sınıfı aşağıdaki gibidir:

Alan Adı	Tipi	Açıklama
messageid	String	Gönderilen e-postaya ait tekil ifadedir
email	String	Gönderilen e-posta adresi
requestdate	String	Üyelikten ayrılma talep tarihi

UniMsg Toplu E-Mail Api Örnek Kodları

UniMSG.Net Projesi

UniMSG Java Projesi

Test Hesabı Al Projem Var!

toplu e-posta,toplu e-posta api,toplu mail,toplu email,toplu mail api,toplu e-mail api,toplu mail gönder,toplu mail gönderim apisi,toplu email gönderme programı,çözüm geliştiriciler,developer tools,wiki,çözüm geliştirici araçları