Kontakt Listeleri için
API

Kapsamlı email API’mizi kullanarak üyelerinizi kolayca yönetin

Email Marketing Contacts Api

AddBulkContact()

Bu metodu kullanarak listenize toplu olarak yeni alıcı ekleyebilirsiniz.

  • apiKey (Zorunlu)

Metodu kullanabilmeniz için gerekli olan API key. Almak için buraya tıklayın.

  • list_id (Zorunlu)

Yeni alıcı eklemek istediğiniz listenin ID numarası. Alıcı listelerinizin bir listesini GetLists() metoduyla alabilirsiniz.

  • list (of shortContactItem) (Zorunlu)

Eklemek istediğiniz alıcıların eposta adresi, adı ve soyadını içeren bir kolleksiyon. Geçerli eposta adresleri olmalıdır.

Başarılı sonuçlarda “success” cevabı döner (kod 0). Hata durumunda, bir hata kodu ve açıklaması döner.

Metod eklenmeye çalışılan eposta adreslerinin söz konusu listede olup olmadığını kontrol eder ve varsa ikinci kez eklenmesine izin vermez.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddContact xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <email>string</email>
      <firstname>string</firstname>
      <lastname>string</lastname>
      <list_id>int</list_id>
    </AddContact>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddContactResponse xmlns="http://api.directiq.com/">
      <AddContactResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </AddContactResult>
    </AddContactResponse>
  </soap:Body>
</soap:Envelope>

AddContact()

Bu metodu kullanarak listenize yeni alıcı ekleyebilirsiniz.

  • apiKey (Zorunlu)

Metodu kullanabilmeniz için gerekli olan API key. Almak için buraya tıklayın.

  • list_id (Zorunlu)

Yeni alıcıyı eklemek istediğiniz listenin ID numarası. Alıcı listelerinizin bir listesini GetLists() metoduyla alabilirsiniz.

  • email (Zorunlu)

Eklemek istediğiniz alıcının eposta adresi. Geçerli bir eposta adresi olmalıdır.

  • firstname

Eklemek istediğiniz alıcının adı. Tercihe bağlıdır.

  • lastname

Eklemek istediğiniz alıcının soyadı. Tercihe bağlıdır.

Başarılı sonuçlarda “success” cevabı döner (kod 0). Hata durumunda, bir hata kodu ve açıklaması döner.

Metod eklenmeye çalışılan eposta adresinin söz konusu listede olup olmadığını kontrol eder ve varsa ikinci kez eklenmesine izin vermez.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddContact xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <email>string</email>
      <firstname>string</firstname>
      <lastname>string</lastname>
      <list_id>int</list_id>
    </AddContact>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddContactResponse xmlns="http://api.directiq.com/">
      <AddContactResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </AddContactResult>
    </AddContactResponse>
  </soap:Body>
</soap:Envelope>

AddContactToSupressionList()

Bu metodu kullanarak ekleyeceğiniz email adreslerine sistem hiç bir şekilde gönderim yapmanıza izin vermeyecektir. Daha önce listenizden çıkmış olan veya geçersiz olduğunu bildiğiniz adresleri bu metodu kullanarak ekleyebilir ve DirectIQ listelerinizin temiz kalmasını garantileyebilirsiniz.

  • apiKey (Zorunlu)

Metodu kullanabilmeniz için gerekli olan API key. Almak için buraya tıklayın.

  • email (Zorunlu)

Silmek istediğiniz alıcının eposta adresi. Geçerli bir eposta adresi olmalı ve belirttiğiniz listede yer almalıdır.

Başarılı sonuçlarda “success” cevabı döner (kod 0). Hata durumunda, bir hata kodu ve açıklaması döner.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddContactToSupressionList xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <email>string</email>
    </AddContactToSupressionList>
  </soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddContactToSupressionListResponse xmlns="http://api.directiq.com/">
      <AddContactToSupressionListResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </AddContactToSupressionListResult>
    </AddContactToSupressionListResponse>
  </soap:Body>
</soap:Envelope>

CreateList()

Bu metodu kullanarak yeni bir alıcı listesi oluşturabilirsiniz.

  • apiKey (Zorunlu)

Metodu kullanabilmeniz için gerekli olan API key. Almak için buraya tıklayın.

  • list_name (Zorunlu)

Yaratılacak alıcı listesinin ismi.

Başarılı durumlarda “success” mesajıyla birlikte kod 0 döner. Ayrıca yeni yaratılmış alıcı listesinin ID’si de beraberinde döner. Hata durumunda detaylı hata mesajı ve hata kodu iletilir.

Eğer aynı isimde bir listeniz varsa metod hata dönecektir.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateList xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_name>string</list_name>
    </CreateList>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateListResponse xmlns="http://api.directiq.com/">
      <CreateListResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <list_id>int</list_id>
      </CreateListResult>
    </CreateListResponse>
  </soap:Body>
</soap:Envelope>

DeleteContact()

Bu metodu kullanarak bir listeden bir alıcıyı silebilirsiniz.

  • apiKey (Zorunlu)

Metodu kullanabilmeniz için gerekli olan API key. Almak için buraya tıklayın.

  • list_id (Zorunlu)

Silmek istediğiniz alıcının bulunduğu listenin ID numarası. Alıcı listelerinizin bir listesini GetLits() metoduyla alabilirsiniz.

  • email (Zorunlu)

Silmek istediğiniz alıcının eposta adresi. Geçerli bir eposta adresi olmalı ve belirttiğiniz listede yer almalıdır.

Başarılı durumlarda “success” mesajıyla birlikte kod 0 döner. Hata durumunda detaylı hata mesajı ve hata kodu iletilir.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteContact xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <email>string</email>
      <list_id>int</listId>
    </DeleteContact>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteContactResponse xmlns="http://api.directiq.com/">
      <DeleteContactResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </DeleteContactResult>
    </DeleteContactResponse>
  </soap:Body>
</soap:Envelope>

DeleteList()

Bu metodu kullanarak bir alıcı listesini silebilirsiniz.

  • apiKey (Zorunlu)

Metodu kullanabilmeniz için gerekli olan API key. Almak için buraya tıklayın.

  • list_id (Zorunlu)

Silinecek alıcı listesinin ID numarası.

Başarılı durumlarda “success” mesajıyla birlikte kod 0 döner. Hata durumunda detaylı hata mesajı ve hata kodu iletilir.

Eğer verdiğiniz ID numarasında bir listeniz yoksa metod hata dönecektir.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteList xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
    </DeleteList>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteListResponse xmlns="http://api.directiq.com/">
      <DeleteListResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </DeleteListResult>
    </DeleteListResponse>
  </soap:Body>
</soap:Envelope>

GetActiveContacts()

Bu metod ile bir listedeki tüm aktif alıcıları listeleyebilirsiniz.

  • apiKey (Zorunlu)

Metodu kullanabilmeniz için gerekli olan API key. Almak için buraya tıklayın.

  • list_id (Zorunlu)

Detayını almak istediğiniz alıcı listesinin ID numarası. Alıcı listelerinizin isim ve ID’leri için GetLists() metodunu kullanabilirsiniz.

Başarılı durumlarda “success” mesajıyla birlikte kod 0 döner. Metod ayrıca başarılı ise bir “list of contact” objesi döner. Bu objenin içinde ID, email, firstname ve lastname alanları yer alır. Status alanında ise alıcıların durumları yer alır. (0 pasif, 1 aktif) Hata durumunda detaylı hata mesajı ve hata kodu iletilir.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetActiveContacts xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
    </GetActiveContacts>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetActiveContactsResponse xmlns="http://api.directiq.com/">
      <GetActiveContactsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedList>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
        </returnedList>
      </GetActiveContactsResult>
    </GetActiveContactsResponse>
  </soap:Body>
</soap:Envelope>

GetAllContacts()

Bu metod ile bir listedeki tüm alıcıları listeleyebilirsiniz. Hem aktif hem pasif alıcılar döner.

  • apiKey (Zorunlu)

Metodu kullanabilmeniz için gerekli olan API key. Almak için buraya tıklayın.

  • list_id (Zorunlu)

Detayını almak istediğiniz alıcı listesinin ID numarası. Alıcı listelerinizin isim ve ID’leri için GetLists() metodunu kullanabilirsiniz.

Başarılı durumlarda “success” mesajıyla birlikte kod 0 döner. Metod ayrıca başarılı ise bir “list of contact” objesi döner. Bu objenin içinde ID, email, firstname ve lastname alanları yer alır. Status alanında ise alıcıların durumları yer alır. (0 pasif, 1 aktif) Hata durumunda detaylı hata mesajı ve hata kodu iletilir.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAllContacts xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
    </GetAllContacts>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAllContactsResponse xmlns="http://api.directiq.com/">
      <GetAllContactsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedList>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
        </returnedList>
      </GetAllContactsResult>
    </GetAllContactsResponse>
  </soap:Body>
</soap:Envelope>

GetContact()

Bu metod ile listedeki bir alıcının bilgilerini çekebilirsiniz.

  • apiKey (Zorunlu)

Metodu kullanabilmeniz için gerekli olan API key. Almak için buraya tıklayın.

  • list_id (Zorunlu)

Sorguladığınız alıcınızın yer aldığı alıcı listesinin ID numarası. Tüm alıcı listelerinizin isim ve ID’lerini GetLists() metodunu kullanarak alabilirsiniz.

  • email (Zorunlu)

Sorguladığınız alıcınızın eposta adresi. Geçerli bir eposta adres formatında olmalıdır.

Başarılı durumlarda “success” mesajıyla birlikte kod 0 döner. Metod ayrıca başarılıysa sorgulanan alıcının ID numarasını, eposta adresini, ad ve soyadını döner. Status alanında alıcının durumu yer alır: (0 ise pasif, 1 ise aktif) Hata durumunda detaylı hata mesajı ve hata kodu iletilir.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContact xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
      <email>string</email>
    </GetContact>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContactResponse xmlns="http://api.directiq.com/">
      <GetContactResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedContact>
          <user_id>int</user_id>
          <email>string</email>
          <firstname>string</firstname>
          <lastname>string</lastname>
          <status>unsignedByte</status>
          <info>string</info>
          <list_id>int</list_id>
        </returnedContact>
      </GetContactResult>
    </GetContactResponse>
  </soap:Body>
</soap:Envelope>

GetContactByID()

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContactByID xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <contactID>int</contactID>
    </GetContactByID>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContactByIDResponse xmlns="http://api.directiq.com/">
      <GetContactByIDResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedContact>
          <contactID>int</contactID>
          <email>string</email>
          <firstname>string</firstname>
          <lastname>string</lastname>
          <dateadded>dateTime</dateadded>
          <gender>string</gender>
          <city>string</city>
          <birthdate>string</birthdate>
          <extended1>string</extended1>
          <extended2>string</extended2>
          <extended3>string</extended3>
          <extended4>string</extended4>
          <extended5>string</extended5>
          <extended6>string</extended6>
          <extended7>string</extended7>
          <extended8>string</extended8>
          <extended9>string</extended9>
          <extended10>string</extended10>
          <extended11>string</extended11>
          <extended12>string</extended12>
          <extended13>string</extended13>
          <extended14>string</extended14>
          <extended15>string</extended15>
          <isActive>boolean</isActive>
          <isVisible>boolean</isVisible>
          <canBeReactivated>boolean</canBeReactivated>
        </returnedContact>
      </GetContactByIDResult>
    </GetContactByIDResponse>
  </soap:Body>
</soap:Envelope>

GetLists()

Bu metod tüm alıcı listelerinizin bir listesini döner.

  • apiKey (Zorunlu)

Metodu kullanabilmeniz için gerekli olan API key. Almak için buraya tıklayın.

On success, this method returns the following information: list_id : unique ID of the list list_name : name of the list list_count : total number of contacts in the list active : count of active contacts in the list passive : count of passive contacts in the list On failure, this method returns an error code and a description.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetLists xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
    </GetLists>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetListsResponse xmlns="http://api.directiq.com/">
      <GetListsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedList>
          <contactList>
            <list_id>int</list_id>
            <list_name>string</list_name>
            <list_lastupdate>dateTime</list_lastupdate>
            <list_count>int</list_count>
            <active>int</active>
            <passive>int</passive>
          </contactList>
          <contactList>
            <list_id>int</list_id>
            <list_name>string</list_name>
            <list_lastupdate>dateTime</list_lastupdate>
            <list_count>int</list_count>
            <active>int</active>
            <passive>int</passive>
          </contactList>
        </returnedList>
      </GetListsResult>
    </GetListsResponse>
  </soap:Body>
</soap:Envelope>

GetPassiveContacts()

Bu metod ile bir listedeki tüm pasif alıcıları listeleyebilirsiniz.

  • apiKey (Zorunlu)

Metodu kullanabilmeniz için gerekli olan API key. Almak için buraya tıklayın.

  • list_id (Zorunlu)

Detayını almak istediğiniz alıcı listesinin ID numarası. Alıcı listelerinizin isim ve ID’leri için GetLists() metodunu kullanabilirsiniz.

Başarılı durumlarda “success” mesajıyla birlikte kod 0 döner. Metod ayrıca başarılı ise bir “list of contact” objesi döner. Bu objenin içinde ID, email, firstname ve lastname alanları yer alır. Status alanında ise alıcıların durumları yer alır. (0 pasif, 1 aktif) Hata durumunda detaylı hata mesajı ve hata kodu iletilir.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPassiveContacts xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
    </GetPassiveContacts>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPassiveContactsResponse xmlns="http://api.directiq.com/">
      <GetPassiveContactsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedList>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
        </returnedList>
      </GetPassiveContactsResult>
    </GetPassiveContactsResponse>
  </soap:Body>
</soap:Envelope>