library getresponse

batons0/getresponse

GetResponse API v3 client library.

Overview

GetResponse API v3 wrapper working on PHP 5.2+. Here you can find our api documentation., _(*1)

Examples

Standard authorization, _(*2)

$getresponse = new GetResponse('your_api_key');

--, _(*3)

Enterprise authorization, _(*4)

$getresponse = new GetResponse('your_api_key');
$getresponse->enterprise_domain = 'somedomain.com';

//api URL is relative to your domain UR:
$getresponse->api_url = 'https://api3.getresponse360.pl/v3'; //for PL domains
$getresponse->api_url = 'https://api3.getresponse360.com/v3'; //default

-- Search contacts, _(*5)

$result = $getresponse->getContacts(array(
    'query' => array(
        'email' => '@getresponse.com',
    ),
    'fields' => 'name,email'
));

Add contact, _(*6)

$getresponse->addContact(array(
    'name'              => 'Jon Smith',
    'email'             => 'jonsmith@testdomain.com',
    'dayOfCycle'        => 0,
    'campaign'          => array('campaignId' => 'campaign_id_obtained_by_API'),
    'ipAddress'         => '89.206.31.190',
    'customFieldValues' => array(
        array('customFieldId' => 'custom_field_id_obtained_by_API',
            'value' => array(
                'Y'
            )),
         array('customFieldId' => 'custom_field_id_obtained_by_API',
            'value' => array(
                'Y'
            ))
    )
));

-- Send message, _(*7)

$result = $getresponse->sendNewsletter(array(
                "subject" => 'Test subject',
                "fromField" => array('fromFieldId' => 'from_field_id'),
                "content" => array(
                    'html' => 'Test newsletter contetnt.'
                ),
                "sendSettings" => array(
                    "selectedContacts" => array('contact_id_obtained_by_API')
            )
    ));

-- Add custom field, _(*8)

$getresponse->setCustomField(array(
                'name' => 'custom_name',
                'type' => 'text',
                'hidden' => 'false',
    ));

-- List saved search, _(*9)

$result = $getresponse->searchContacts();

-- List new web forms, _(*10)

$result = $getresponse->getForms();

-- List old web forms, _(*11)

$result = $getresponse->getWebForms();