API
Contactpersoon ophalen
Dit voorbeeld geeft een XML terug met het totaal aantal contactpersonen van een bepaalde mailinglijst, alsmede een overzicht van alle contactpersonen in de betreffende lijst.
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.List | int | Het ID van de mailinglijst waarop de contactpersoon staat. | Verplicht |
details.List.Email | string | Het e-mailadres van de contactpersoon die u probeert te vinden | Optioneel |
details.List.Confirmed | boolean | De bevestigingsstatus van de contactpersoon die u probeert te vinden (0 of 1) | Optioneel |
details.List.Status | boolean | De status van de contactpersoon; a (active), b (bounced) of u (unsubscribed) | Verplicht |
details.List.DateSearch / DateUpdatedSearch | Filter op een specifieke datum interval gebaseerd op de inschrijfdatum. Vul de datum in als unix timestamp in het StartDate en optioneel in het EndDate veld. 5 verschillende types: | Optioneel | |
details.List.DateSearch / DateUpdatedSearch.after | string | Alle contactpersonen ingeschreven ná de opgegeven datum. | Optioneel |
details.List.DateSearch / DateUpdatedSearch.between | string | Alle contactpersonen ingeschreven tussen 2 bepaalde datums. Geef de eind datum op in het veld EndDate. | Optioneel |
details.List.DateSearch / DateUpdatedSearch.before | string | Alle contactpersonen ingeschreven vóór de opgegeven datum. | Optioneel |
details.List.DateSearch / DateUpdatedSearch.exact/exactly | string | Alle contactpersonen ingeschreven precies op de opgegeven datum. | Optioneel |
details.List.DateSearch / DateUpdatedSearch.not | string | Alle contactpersonen ingeschreven die niet zijn ingeschreven op de opgegeven datum. | Optioneel |
details.List.Newsletter | int | Het ID van een nieuwsbrief die de contactpersoon moet hebben geopend. | Optioneel |
details.List.Tags | int | Het ID van de tag van een contactpersoon. | Optioneel |
details.List.SortBy | string | Op welke volgorde de nieuwsbrieven in de array gesorteerd moeten zijn (subscribedate, emailaddress, format, status of confirmed). | Optioneel |
details.List.Direction | string | Of de sortering van laag naar hoog of andersom moet worden gedaan (Down of Up). | Optioneel |
details.List.start | int | Eerste pagina vanaf waar gezocht moet worden. | Optioneel |
details.List.perpage | string | Aantal contacten per resultaat. Standaard is 10. Waarde 'all' geeft alle records terug. | Optioneel |
Succesvolle response
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
count | int | Het totale aantal contactpersonen. |
subscriberlist | int | Een overzicht van alle e-mailadressen van de contactpersonen. |
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>subscribers</requesttype>
<requestmethod>GetSubscribers</requestmethod>
<responsetype>xml</responsetype>
<details>
<countonly>false</countonly>
<searchinfo>
<List>99</List>
<Email>@uwdomein.nl</Email>
<Confirmed>1</Confirmed>
<DateSearch>
<filter>true</filter>
<type>after</type>
<StartDate>1483228800</StartDate>
</DateSearch>
<DateUpdatedSearch>
<filter>true</filter>
<type>between</type>
<StartDate>1483228800</StartDate>
<EndDate>1559347200</EndDate>
</DateUpdatedSearch>
<Newsletter>99</Newsletter>
<Tags>99</Tags>
</searchinfo>
<sortdetails>
<SortBy>subscribedate</SortBy>
<Direction>asc</Direction>
</sortdetails>
<start>0</start>
<perpage>10</perpage>
</details>
</xmlrequest>