API

Bounces ophalen

Dit voorbeeld laat zien hoe je de bounces van één of meerdere statistieken kunt ophalen.

Parameters

Parameters
Veld	Type	Omschrijving	Verplicht / Optioneel
`statids`	string	Komma-gescheiden id's van statistieken.	Verplicht
`listid`	int	Indien je van een specifieke lijst de bounces wil ophalen. De statids parameter wordt hier genegeerd.	Optioneel
`order_by`	string	Op welke volgorde de bounces in de array gesorteerd moeten zijn (emailaddress, bouncetime).	Optioneel
`order_dir`	string	Of de sortering van laag naar hoog of andersom moet worden gedaan (ASC of DESC).	Optioneel
`count_only`	string	Of alleen het aantal moet worden teruggegeven. Default: false.	Optioneel
`bouncetype`	string	Het type bounce. Je kunt hierbij kiezen uit; hard, soft, blocked en any (elke status)	Optioneel
bouncetype.`DateBouncedSearch`		De parameter voor het zoeken op datum.	Verplicht
bouncetype.DateBouncedSearch.`filter`	string	Deze moet op 1 staan om te kunen filteren	Optioneel
bouncetype.DateBouncedSearch.`type`	string	Dit kan zijn before, after, exact(ly), between, notbetween en not.	Optioneel
bouncetype.DateBouncedSearch.`StartDate`	string	De unix timestamp van de begindatum waarop moet worden gezocht.	Optioneel
bouncetype.DateBouncedSearch.`EndDate`	string	De unix timestamp van de einddatum waarop moet worden gezocht. Deze geef je alleen op als bij type is gekozen voor between of notbetween	Optioneel
`start`	int	Geef het getal vanaf welk punt het resultaat moet worden teruggegeven. Default: 0 (eerste resultaat).	Optioneel
`perpage`	string	Het aantal bounces dat per result moet worden teruggeven. Kies 'all' voor alle bounces. Default: 10	Optioneel

Succesvolle response

Succesvolle response
Veld	Type	Omschrijving
`status`	string	De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons.
`data`	array	Indien de bounces worden gevonden wordt het object teruggegeven.

Foutmelding

Foutmelding
Veld	Type	Omschrijving
`status`	string	De waarde van het status-veld zal “FAILED” zijn.
`errormessage`	string	Een tekstuele boodschap om uit te leggen waarom het verzoek is mislukt.

Request voorbeeld

PHP request voorbeeld

Response Success

Response Failed

Request voorbeeld

<xmlrequest>
	<username>admin</username>
	<usertoken>0123456789abcdef0123456789abcdef01234567</usertoken>
	<requesttype>stats</requesttype>
	<requestmethod>GetBounces</requestmethod>
	<responsetype>xml</responsetype>
	<details>
		<statids>99</statids>
		<order_by>bouncetime</order_by>
		<order_dir>desc</order_dir>
		<count_only>false</count_only>
		<bounce_type>any</bounce_type>
		<searchinfo>
			<DateBouncedSearch>
				<filter>1</filter>
				<type>between</type>
				<StartDate>1662917256</StartDate>
				<EndDate>1726075656</EndDate>
			</DateSentSearch>
		</searchinfo>
		<start>0</start>
		<perpage>10</perpage>
	</details>
</xmlrequest>