API

Mailinglijst ophalen

Dit voorbeeld zal een overzicht van alle in MailCamp aangemaakte mailinglijsten weergeven in een XML met de gevonden data.

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
listsint

Komma gescheiden list ID's van de lijsten waarvan informatie opgehaald moet worden

Verplicht
sortinfoint

Zie de velden hieronder.

Optioneel
sortinfo.SortBystring

Op welke volgorde de nieuwsbrieven in de array gesorteerd moeten zijn (Name, CreateDate, subscribecount, unsubscribecount, fullname).

Optioneel
sortinfo.Directionstring

Of de sortering van laag naar hoog of andersom moet worden gedaan (asc of desc).

Optioneel
countonlystring

Of alleen het aantal moet worden teruggegeven. Default: false.

Optioneel
confirmedonlystring

Of alleen de bevestigde lijsten moeten worden teruggegeven. Default: true.

Optioneel
startint

Geef het getal vanaf welk punt het resultaat moet worden teruggegeven. Default: 0 (eerste resultaat).

Verplicht
perpageint

Het aantal lijsten dat per result moet worden teruggeven. Kies 'all' voor alle lijsten. Default: 10

Verplicht
statustinyint

Of alleen de actieve lijsten moeten worden teruggegeven. Default: 1.

Verplicht

Succesvolle response

Succesvolle response
VeldTypeOmschrijving
statusstring

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

status.listidint

De ID van de mailinglijst.

status.namestring

De naam van de mailinglijst.

status.createdateint

De aanmaakdatum (unix_timestamp) van de mailinglijst.

status.updatedint

De datum van de laatste wijziging (unix_timestamp) van de mailinglijst.

status.deletedint

Indien de lijst is verwijderd een datum (unix_timestamp) van het moment van verwijderen.

status.statustinyint

Status van de mailinglijst

status.subscribecountint

Het totaal aantal actieve en bevestigde contactpersonen op de mailinglijst.

status.unsubscribecountint

Het totaal aantal uitgeschreven contactpersonen op de mailinglijst.

status.owneridint

Het gebruikers ID van de eigenaar van de mailinglijst.

status.ownernamestring

De naam van de eigenaar van de mailinglijst.

status.owneremailstring

De afzendadres van de mailinglijst.

status.bounceemailstring

De bounce-adres van de mailinglijst.

status.replytoemailstring

De replyto-adres van de mailinglijst.

status.listconfirmedtinyint

Status van de mailinglijst (bevestigd of niet-bevestigd)

status.spftinyint

Of er een geldig SPF record is gevonden

status.dkimtinyint

Of er een geldig DKIM record is gevonden

status.autonewsletteridint

Het ID van de nieuwsbrief die moet worden verstuurd na het inschrijven op een mailinglijst. Default: 0

status.usernamestring

De gebruikersnaam van de eigenaar van de mailinglijst

status.fullnamestring

De volledige naam van de eigenaar van de mailinglijst

status.smtpserverstring

De SMTP instellingen van de eigenaar van de mailinglijst

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>lists</requesttype>
	<requestmethod>GetLists</requestmethod>
	<responsetype>xml</responsetype>
	<details>
		<lists />
		<countonly>false</countonly>
		<confirmedonly>true</confirmedonly>
		<sortinfo>
			<SortBy>createdate</SortBy>
			<Direction>asc</Direction>
		</sortinfo>
		<start>0</start>
		<perpage>all</perpage>
	</details>
</xmlrequest>