exs/campaigner-bundle

This bundle is a client ofr Campaigner's SOAP web services.

EXS/CampaignerBundle

, _(*1)

What is this bundle doing ?

This bundle provides Campaigner APIs' as Symfony services., _(*2)

See Campaigner API User Guide for the list of web services and methods., _(*3)

Installation

This bundle uses PHP's native SOAP objects., _(*4)

Make sure soap module is enabled in your PHP's installation., _(*5)

Download the bundle using composer, _(*6)

$ composer require exs/campaigner-bundle

Enable the bundle, _(*7)

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new EXS\CampaignerBundle\EXSCampaignerBundle(),
        // ...
    );
}

Configuration

Required configuration :, _(*8)

exs_campaigner:
    username: 'someusername'
    password: 'somepassword'

Complete configuration (with default values) :, _(*9)

exs_campaigner:
    username: 'someusername'
    password: 'somepassword'
    # Default values
    wsdl:
        campaign_management: 'https://ws.campaigner.com/2013/01/campaignmanagement.asmx?WSDL'
        contact_management: 'https://ws.campaigner.com/2013/01/contactmanagement.asmx?WSDL'
        content_management: 'https://ws.campaigner.com/2013/01/contentmanagement.asmx?WSDL'
        list_management: 'https://ws.campaigner.com/2013/01/listmanagement.asmx?WSDL'
        smtp_management: 'https://ws.csmtp.net/2014/06/SMTPService.asmx?WSDL'
        workflow_management: 'https://ws.campaigner.com/2013/01/workflowmanagement.asmx?WSDL'
    xsd:
        contacts_search_criteria: '@EXSCampaignerBundle/Resources/xsd/ContactsSearchCriteria2.xsd'

Web services and methods

• Campaign Management Web Service, _(*10)

  Service id : exs_campaigner.campaign_manager, _(*11)

  Methods :, _(*12)

  • CreateUpdateCampaign (Page 91)
  • DeleteCampaign (Page 98)
  • DeleteFromEmail (Page 100)
  • GetCampaignRunsSummaryReport (Page 102)
  • GetCampaignSummary (Page 110)
  • GetTrackedLinkSummaryReport (Page 117)
  • GetUnsubscribeMessages (Page 120)
  • ListCampaigns (Page 123)
  • ListFromEmails (Page 128)
  • ListTrackedLinksByCampaign (Page 131)
  • ScheduleCampaign (Page 134)
  • SendTestCampaign (Page 137)
  • SetCampaignRecipients (Page 139)
  • StopCampaign (Page 141)
  • ValidateFromEmail (Page 143)

• Contact Management Web Service, _(*13)

  Service id : exs_campaigner.contact_manager, _(*14)

  Methods :, _(*15)

  • CreateUpdateAttribute (Page 26)
  • DeleteAttribute (Page 30)
  • DeleteContacts (Page 32)
  • DownloadReport (Page 34)
  • GetContacts (Page 37)
  • GetUploadMassContactsResult (Page 45)
  • GetUploadMassContactsStatus (Page 49)
  • ImmediateUpload (Page 53)
  • InitiateDoubleOptIn (Page 63)
  • ListAttributes (Page 67)
  • ListContactFields (Page 71)
  • ListTestContacts (Page 75)
  • ResubscribeContact (Page 78)
  • RunReport (Page 82)
  • UploadMassContacts (Page 85)

• Content Management Web Service, _(*16)

  Service id : exs_campaigner.content_manager, _(*17)

  Methods :, _(*18)

  • CreateUpdateMyTemplates (Page 157)
  • DeleteMediaFiles (Page 161)
  • GetEmailTemplate (Page 163)
  • ListEmailTemplates (Page 165)
  • ListMediaFiles (Page 168)
  • ListProjects (Page 171)
  • UploadMediaFile (Page 173)

• List Management Web Service, _(*19)

  Service id : exs_campaigner.list_manager, _(*20)

  Methods :, _(*21)

  • CreateUpdateContactGroups (Page 146)
  • DeleteContactGroups (Page 150)
  • ListContactGroups (Page 152)

• SMTPService Web Service, _(*22)

  Service id : exs_campaigner.smtp_manager, _(*23)

  Methods :, _(*24)

  • DownloadReport (Page 183)
  • GetDetailSmtpStatus (Page 185)
  • GetSmtpActivityReport (Page 190)
  • GetSmtpBounceReport (Page 195)
  • GetSmtpReportGroupSummary (Page 200)
  • RunReport (Page 205)

• Workflow Management Web Service, _(*25)

  Service id : exs_campaigner.workflow_manager, _(*26)

  Methods :, _(*27)

  • ListWorkflows (Page 177)
  • TriggerWorkflow (Page 180)