API
Archief ophalen
Dit voorbeeld laat zien hoe je het verzonden nieuwsbrief archief kunt ophalen om deze bijvoorbeeld op uw website te publiceren.
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 | |
details.listid | int | Het ID van de mailinglijst waarvan u het nieuwsbrieven archief wilt ophalen. | Verplicht |
details.num_to_retrieve | int | Het aantal verzonden nieuwsbrieven die u wenst op te halen. | Verplicht |
Succesvolle response
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
name | int | De naam van de verzonden nieuwsbrief. |
subject | string | Het onderwerp van de verzonden nieuwsbrief. |
starttime | int | De start tijd van de verzending in UNIX tijd format. |
listid | int | De ID van de mailinglijst. |
username | string | De gebruikersnaam van de eigenaar van de mailinglijst waarnaar de nieuwsbrief verstuurd is. |
fullname | int | De volledige naam van de eigenaar van de mailinglijst waarnaar de nieuwsbrief verstuurd is. |
textbody | int | De platte tekst inhoud van de verzonden nieuwsbrief. |
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
htmlbody | int | De HTML inhoud van de verzonden nieuwsbrief. |
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>GetArchives</requestmethod>
<responsetype>xml</responsetype>
<details>
<listid>99</listid>
<num_to_retrieve>99</num_to_retrieve>
</details>
</xmlrequest>