email marketing solutions
Hiya Mail API
Get Subscribers

This example will retrieve a count of the amount of Contacts on the list in question as well as a list of all the Contacts that are located in that list and return formatted XML with the data found.
  • xmlrequest (Required)
    • username - The user name used to login to the Hiya Mail. (Required)
    • usertoken - The unique token assigned to the user account used above. (Required)
    • requesttype - The name of the API file in question. (Required)
    • requestmethod - The name of the function being called. (Required)
    • details (Required)
      • List - The ID of the Contact List that you are wishing to search (Required)
      • Email - The email address of the contact that you are attempting to locate (Required)

Successful Response
Upon submission of a valid 'get subscribers' request the XML API will return a count of the amount of Contacts on the list in question along with a list of those contact email addresses in formatted XML.

The format is as follows:
  • response
    • status - The value of the status field will be "SUCCESS" for a successful response.
    • data
      • count - A count of the amount of subscribers.
      • subscriberlist - A list of the subscribers email addresses

Unsuccessful Response
Upon submission of an erroneous response due to a missing field, or an invalid value, the Get Subscribers will fail. A status message will be returned via XML as to why.

The format is as follows:
  • response
    • status - The value of the status field will be "ERROR".
    • errormessage - A textual message explaining why the request failed.

Sample Request (XML)
The following code sample performs a check on the Contact List with ID '1' for all email addresses that contain the information '@hiyamail.com'.
  
admin 
78701d1ba2588ea1991f44299b814129658c6947 
subscribers 
GetSubscribers 
1 @hiyamail.com

Sample Request (PHP)
The following sample code is written in PHP and makes use of PHP's CURL functionality to insert the above XML into the application.
<?php 

$xml = ' 
admin 
78701d1ba2588ea1991f44299b814129658c6947 
subscribers 
GetSubscribers 
1 @hiyamail.com
'; $ch= curl_init('http://www.hiyamail.com/API/xml.php'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml); $result = @curl_exec($ch); if($result === false) { echo"Error performing request"; } else { $xml_doc= simplexml_load_string($result); echo'status is ', $xml_doc->status, '
'; if($xml_doc->status =='SUCCESS') { print_r($result); } else { echo'Error is ', $xml_doc->errormessage, '
'; } } ?>

Highly Competitive Pricing

We make a mockery of other email providers' rates. Contact us today to find out how much you can save.
Learn more

Natural Selection

Find out which of your email campaigns performs the best based on open rates and click-thru rates with Hiya Mail's split testing tool.
Learn more

Insights Beyond Opens and Clicks

Advanced reports let you adapt campaigns based on behaviour & demographics to identify new marketing.
Learn more

Optional Managed Solutions

Prefer a chauffeur-driven service? Sit back, relax, and let Hiya deliver you the best possible results.

Learn more

Talk to us today for your FREE trial

Let one of us show how you can build a richer dialogue with your customers and get Hiya Mail for 30 days FREE.
Learn more

How Hiya Can Help You

Hiya helps organizations communicate with their customers and prospects. We provide the services to transform those relationships into more profitable, timely, and measurable business outcomes.

Learn more

Careers with Hiya Group

Hiya Group provides SaaS platform solutions to some of the biggest brands, globally. If working on ground-breaking projects with an unconventional, fast-growing technology company appeals to you, then please review our open positions. Learn more

International Leading Brands



About Hiya Group

United Kingdom +44 (0)20 7047 8110    Ireland +353 (0)1 410 0779
Follow us on Twitter
Become a fan on Facebook

Hiya Mail is a member of the Direct Marketing Association.
As a member of the DMA we abide by the Direct
Marketing Code of Practice.

Copyright (c) 2014 Hiya Group. All rights reserved.