API
Mailinglijst ophalen
Dit voorbeeld zal een overzicht van alle in MailCamp aangemaakte mailinglijsten weergeven in een XML met de gevonden data.
Parameters
| Veld | Type | Omschrijving | Verplicht / Optioneel |
|---|---|---|---|
username | string | De gebruikersnaam wordt gebruikt om in te loggen op de MailCamp. | Verplicht |
usertoken | string | De unieke token toegewezen aan de hierboven genoemde gebruiker. | Verplicht |
requesttype | string | De naam van het betreffende API-bestand. | Verplicht |
requestmethod | string | De naam van de functie die wordt aangeroepen. | Verplicht |
responsetype | string | Het format van de response. Dit kan zijn 'xml' of 'json'. | Optioneel |
details | Zie de velden hieronder. | Verplicht | |
lists | int | Komma gescheiden list ID's van de lijsten waarvan informatie opgehaald moet worden | Verplicht |
sortinfo | int | Zie de velden hieronder. | Optioneel |
sortinfo.SortBy | string | Op welke volgorde de nieuwsbrieven in de array gesorteerd moeten zijn (Name, CreateDate, subscribecount, unsubscribecount, fullname). | Optioneel |
sortinfo.Direction | string | Of de sortering van laag naar hoog of andersom moet worden gedaan (asc of desc). | Optioneel |
countonly | string | Of alleen het aantal moet worden teruggegeven. Default: false. | Optioneel |
confirmedonly | string | Of alleen de bevestigde lijsten moeten worden teruggegeven. Default: true. | Optioneel |
start | int | Geef het getal vanaf welk punt het resultaat moet worden teruggegeven. Default: 0 (eerste resultaat). | Verplicht |
perpage | int | Het aantal lijsten dat per result moet worden teruggeven. Kies 'all' voor alle lijsten. Default: 10 | Verplicht |
status | tinyint | Of alleen de actieve lijsten moeten worden teruggegeven. Default: 1. | Verplicht |
Succesvolle response
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
status.listid | int | De ID van de mailinglijst. |
status.name | string | De naam van de mailinglijst. |
status.createdate | int | De aanmaakdatum (unix_timestamp) van de mailinglijst. |
status.updated | int | De datum van de laatste wijziging (unix_timestamp) van de mailinglijst. |
status.deleted | int | Indien de lijst is verwijderd een datum (unix_timestamp) van het moment van verwijderen. |
status.status | tinyint | Status van de mailinglijst |
status.subscribecount | int | Het totaal aantal actieve en bevestigde contactpersonen op de mailinglijst. |
status.unsubscribecount | int | Het totaal aantal uitgeschreven contactpersonen op de mailinglijst. |
status.ownerid | int | Het gebruikers ID van de eigenaar van de mailinglijst. |
status.ownername | string | De naam van de eigenaar van de mailinglijst. |
status.owneremail | string | De afzendadres van de mailinglijst. |
status.bounceemail | string | De bounce-adres van de mailinglijst. |
status.replytoemail | string | De replyto-adres van de mailinglijst. |
status.listconfirmed | tinyint | Status van de mailinglijst (bevestigd of niet-bevestigd) |
status.spf | tinyint | Of er een geldig SPF record is gevonden |
status.dkim | tinyint | Of er een geldig DKIM record is gevonden |
status.autonewsletterid | int | Het ID van de nieuwsbrief die moet worden verstuurd na het inschrijven op een mailinglijst. Default: 0 |
status.username | string | De gebruikersnaam van de eigenaar van de mailinglijst |
status.fullname | string | De volledige naam van de eigenaar van de mailinglijst |
status.smtpserver | string | De SMTP instellingen van de eigenaar van de mailinglijst |
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. |
<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>