API Список контактов

Без труда управляйте вашими подписчиками с нашим полным Email API

Email Marketing Contacts Api

AddBulkContact()

Используйте этот метод для добавления коллекции контактов в ваш список.

  • apiKey (Требуется)

Ключ для аутентификации вашего приложения. Чтобы получить ваш ключ, кликните здесь.

  • list_id (Требуется)

ID номер списка, к которому должен быть добавлен контакт. Вы можете получить перечень ваших списков контактов, используя метод GetLists().

  • list (of shortContactItem) (Требуется)

Коллекция email-адресов, имен и фамилий контактов, которые вы добавляете. Email-адреса должны быть действительными.

При успешном завершении этот метод возвращает ответ «успех» (код 0). В противном случае будет возвращен код ошибки с описанием.

Метод проверяет существуют ли email-адреса в указанных списках контактов и не позволит вам добавить адреса-дубликаты.

<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()

Используйте этот метод, чтобы добавить контакт в список контактов.

  • apiKey (Требуется)

Ключ для аутентификации вашего приложения. Чтобы получить ваш ключ, кликните здесь.

  • list_id (Требуется)

ID номер списка, к которому должен быть добавлен контакт. Вы можете получить перечень ваших списков контактов, используя метод GetLists().

  • email (Требуется)

Email-адрес контакта, который вы будете добавлять. Email-адрес должен быть действительным.

  • firstname

Имя контакта, который вы будете добавлять. Это поле не является обязательным.

  • lastname

Фамилия контакта, который вы будете добавлять. Это поле не является обязательным.

При успешном завершении этот метод возвращает ответ «успех» (код 0). В противном случае будет возвращен код ошибки с описанием.

Метод проверяет существуют ли email-адреса в указанных списках контактов и не позволит вам добавить адреса-дубликаты.

<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()

Используйте этот метод для добавления email-адресов в черный список. Контакты, добавлены в черный список, не будут получать письма от вас. Это список для блокирования отправки.

  • apiKey (Требуется)

Ключ для аутентификации вашего приложения. Чтобы получить ваш ключ, кликните здесь.

  • email (Требуется)

При успешном завершении этот метод возвращает ответ «успех» (код 0). В противном случае будет возвращен код ошибки с описанием.

<?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()

Используйте этот метод для создания нового списка контактов.

  • apiKey (Требуется)

Ключ для аутентификации вашего приложения. Чтобы получить ваш ключ, кликните здесь кликните здесь.

  • list_name (Требуется)

Имя создаваемого списка контактов.

При успешном завершении этот метод возвращает ответ «успех» (код 0). Также в поле list_id будет указан уникальный ID недавно созданного списка. В противном случае будет возвращен код ошибки с описанием.

Метод не сработает в случае, если список контактов с указанным именем уже существует.

<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()

Используйте этот метод для удаления контакта из вашего списка контактов.

  • apiKey (Требуется)

Ключ для аутентификации вашего приложения. Чтобы получить ваш ключ, кликните здесь.

  • list_id (Требуется)

ID номер списка, к которому должен быть добавлен контакт. Вы можете получить перечень ваших списков контактов, используя метод GetLists().

  • email (Требуется)

Email-адрес контакта, который вы будете удалять. Email-адрес должен быть действительным и существовать в указанном списке контактов.

При успешном завершении этот метод возвращает ответ «успех» (код 0). В противном случае будет возвращен код ошибки с описанием.

<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()

Используйте этот метод для удаления списка контактов.

  • apiKey (Требуется)

Ключ для аутентификации вашего приложения. Чтобы получить ваш ключ, кликните здесь кликните здесь.

  • list_id (Требуется)

ID списка контактов, который нужно удалить.

При успешном завершении этот метод возвращает ответ «успех» (код 0). В противном случае будет возвращен код ошибки с описанием.

Метод не сработает, если список контактов с указанным ID не существует.

<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()

Используйте этот метод для получения всех активных контактов из указанного списка контактов.

  • apiKey (Требуется)

Ключ для аутентификации вашего приложения. Чтобы получить ваш ключ, кликните здесь.

  • list_id (Требуется)

ID номер возвращаемого списка. Вы можете получить перечень ваших списков контактов, используя метод GetLists().

При успешном завершении этот метод возвращает ответ «успех» (код 0). В противном случае будет возвращен код ошибки с описанием.

Метод не сработает, если список контактов с указанным ID не существует.

<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()

Используйте этот метод, чтобы получить все контакты из указанного списка контактов. И активные, и пассивные контакты будут возвращены.

  • apiKey (Требуется)

Ключ для аутентификации вашего приложения. Чтобы получить ваш ключ, кликните здесь.

  • list_id (Required)

ID номер возвращаемого списка. Вы можете получить перечень ваших списков контактов, используя метод GetLists().

При успешном завершении этот метод возвращает ответ «успех» (код 0). Метод также возвращает список с такими значениями как идентификатор, email-адреса, имена и фамилии контактов. Поле статуса показывает статус контактов (0 — пассивный, 1 — активный). В противном случае будет возвращен код ошибки с описанием.

<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()

Используйте этот метод, чтобы получить всю информацию о контакте.

  • apiKey (Требуется)

Ключ для аутентификации вашего приложения. Чтобы получить ваш ключ, кликните здесь.

  • list_id (Требуется)

ID номер списка, в котором находится контакт. Вы можете получить перечень ваших списков контактов, используя метод GetLists().

  • email (Требуется)

Email-адрес контакта для запроса. Email-адрес должен быть действительным.

При успешном завершении этот метод возвращает ответ «успех» (код 0). Метод также возвращает такие запрашиваемые значения как ID номер, email-адрес, имя, фамилию и статус контакта. Поле статуса показывает статус контакта (0 — пассивный, 1 — активный). В противном случае будет возвращен код ошибки с описанием.

<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()

Используйте этот метод, чтобы получить перечень всех списков контактов.

  • apiKey (Требуется)

Ключ для аутентификации вашего приложения. Чтобы получить ваш ключ, кликните здесь.

При успешном завершении, этот метод возвращает следующую информацию: list_id : уникальный ID номер списка list_name : название списка list_count : общее количество контактов в списке active : количество активных контактов в списке passive : количество пасивных контактов в списке В случае неудачного завершения этот метод возвращает код ошибки с описанием.

<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()

Используйте этот метод, чтобы получить все пассивные контакты из указанного списка контактов.

  • apiKey (Требуется)

Ключ для аутентификации вашего приложения. Чтобы получить ваш ключ, кликните здесь.

  • list_id (Требуется)

ID номер возвращаемого списка. Вы можете получить перечень ваших списков контактов, используя метод GetLists().

При успешном завершении этот метод возвращает ответ «успех» (код 0). Метод также возвращает список с такими значениями как ID номера, email-адреса, имена и фамилии контактов. Поле статуса показывает статус контактов (0 — пассивный, 1 — активный). В противном случае будет возвращен код ошибки с описанием.

<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>