tantacula/getresponse

GetResponse API v3 client library.

0.0.3 2017-11-13 14:33 UTC

Requires

• php: >=5.2.0
• ext-curl: *

MIT

• Pawel Maslak
• Grzegorz Struczynski

• api
• email
• getresponse

README

GetResponse API v3 wrapper working on PHP 5.2+. Here you can find our api documentation.

##Examples

Standard authorization

$getresponse = new GetResponse('your_api_key');

--

Enterprise authorization

$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

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

Add contact

$getresponse->addContact(array(
    'name'              => 'Jon Smith',
    'email'             => '[e-mail]',
    '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

$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

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

-- List saved search

$result = $getresponse->searchContacts();

-- List new web forms

$result = $getresponse->getForms();

-- List old web forms

$result = $getresponse->getWebForms();