API Кампания

Наши методы управления кампанией

Email Marketing Campaign Api

CreateCampaign()

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

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

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

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

Имя создаваемой кампании

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

Строка темы новой кампании

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

ID шаблона, который будет использован в этой кампании

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

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

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

Предпочтительная дата и время доставки кампании (в американском формате ММ/ДД/ГГГГ ЧЧ:ММ:СС )

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

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

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

<?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>
    <CreateCampaign xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <name>string</name>
      <subject>string</subject>
      <template>int</template>
      <list>int</list>
      <timetosend>dateTime</timetosend>
      <mailfrom>int</mailfrom>
    </CreateCampaign>
  </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>
    <CreateCampaignResponse xmlns="http://api.directiq.com/">
      <CreateCampaignResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <campaign_id>int</campaign_id>
      </CreateCampaignResult>
    </CreateCampaignResponse>
  </soap:Body>
</soap:Envelope>

GetFromEmails()

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

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

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

При успешном завершении этот метод возвращает ответ «успех» со следующей информацией: id : уникальный ID email-адреса отправителя, используйте этот ID в методе CreateCampaign. fromEmail : email-адрес отправителя fromName: имя отправителя. При неудачном завершении будет возвращен код ошибки с описанием.

<?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>
    <GetFromEmails xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
    </GetFromEmails>
  </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>
    <GetFromEmailsResponse xmlns="http://api.directiq.com/">
      <GetFromEmailsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedEmails>
          <client_from>
            <id>int</id>
            <client_id>int</client_id>
            <fromEmail>string</fromEmail>
            <zaman>dateTime</zaman>
            <isConfirmed>boolean</isConfirmed>
            <fromName>string</fromName>
          </client_from>
          <client_from>
            <id>int</id>
            <client_id>int</client_id>
            <fromEmail>string</fromEmail>
            <zaman>dateTime</zaman>
            <isConfirmed>boolean</isConfirmed>
            <fromName>string</fromName>
          </client_from>
        </returnedEmails>
      </GetFromEmailsResult>
    </GetFromEmailsResponse>
  </soap:Body>
</soap:Envelope>