API

Bestaat contactpersoon

Dit voorbeeld laat zien of een e-mailadres voorkomt in een specifieke mailinglijst.

Parameters

Parameters
VeldTypeOmschrijvingVerplicht / Optioneel
usernamestring

De gebruikersnaam wordt gebruikt om in te loggen op de MailCamp.

Verplicht
usertokenstring

De unieke token toegewezen aan de hierboven genoemde gebruiker.

Verplicht
requesttypestring

De naam van het betreffende API-bestand.

Verplicht
requestmethodstring

De naam van de functie die wordt aangeroepen.

Verplicht
responsetypestring

Het format van de response. Dit kan zijn 'xml' of 'json'.

Optioneel
details

Zie de velden hieronder.

Verplicht
details.emailaddressstring

Het e-mailadres van de contactpersoon waar naar wordt gezocht

Verplicht
details.listidsint

Het ID van de mailinglijst waar op wordt gezocht

Verplicht
details.subscriberidint

Het ID van de contactpersoon waar op wordt gezocht

Optioneel
details.activeonlystring

Check op actieve contactpersonen of ook op gebouncede emailadressen of uitschrijvers

Optioneel
details.not_bouncedstring

Check op contactpersonen die niet de status bounced hebben

Optioneel
details.return_listidint

Geeft het ID van de mailinglijst terug in het resultaat

Optioneel

Succesvolle response

Succesvolle response
VeldTypeOmschrijving
statusstring

De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons.

data

Indien de statistieken worden gevonden wordt het object teruggegeven.

Foutmelding

Foutmelding
VeldTypeOmschrijving
statusstring

De waarde van het status-veld zal “FAILED” zijn.

errormessagestring

Een tekstuele boodschap om uit te leggen waarom het verzoek is mislukt.

Request voorbeeld
<xmlrequest>
	<username>admin</username>
	<usertoken>0123456789abcdef0123456789abcdef01234567</usertoken>
	<requesttype>subscribers</requesttype>
	<requestmethod>IsSubscriberOnList</requestmethod>
	<responsetype>xml</responsetype>
	<details>
		<emailaddress>email@mailcamp.nl</emailaddress>
		<listids>99</listids>
		<subscriberid />
		<activeonly />
		<not_bounced />
		<return_listid />
	</details>
</xmlrequest>