API
Inplannen
Dit voorbeeld laat zien hoe je een nieuwsbrief kunt inplannen voor verzending.
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.jobtype | string | Het type van de actie die ingepland wordt. In dit geval een verzending (send). | Verplicht |
details.jobstatus | string | De status van de verzending. Mogelijke waarden (w = waiting, p = paused, i = in progress, c = completed). In dit geval altijd 'w' gebruiken | Verplicht |
details.when | int | Unix timestamp van het moment van verzending | Verplicht |
details.lists | int | Het ID van de mailinglijst waar naartoe moet worden verzonden. | Verplicht |
responsetype | string | Het format van de response. Dit kan zijn 'xml' of 'json'. | Optioneel |
details | Zie de velden hieronder. | Verplicht | |
details.NewsletterChosen | int | Het ID van de nieuwsbrief waarnaar verstuurd moet worden. | Verplicht |
details.Lists | int | Het ID van de mailinglijst waar naartoe moet worden verzonden. | Verplicht |
SendCriteria | Zie de velden hieronder. | Verplicht | |
SendCriteria.Confirmed | boolean | De bevestigingsstatus van de contactpersonen waarnaar wordt verzonden; 'Bevestigd' of 'niet-Bevestigd' resp. 1 of 0. | Verplicht |
SendCriteria.Status | string | De status van de contactpersonen waarnaar wordt verzonden. In dit geval alleen naar de actieve contactpersonen (a) en niet naar de uitgeschreven of gebouncede contactpersonen. | Verplicht |
SendCriteria.List | int | Het ID van de mailinglijst waar naartoe moet worden verzonden. | Verplicht |
SendCriteria.TagType | string | De manier waarop er op tags gefilterd wordt. Mogelijke variabelen: AND (match alle tags), OR (match specifieke tags) en NONE (geen van deze tags) | Optioneel |
SendCriteria.Tags | array | Dit is de array van Tag ID's van alle tags waarop gefilterd moet worden. | Optioneel |
SendCriteria.SendSize | int | Het aantal contactpersonen waarnaar wordt verzonden. Dit weet je door eerst een API-call te doen waarbij het aantal subscribers wordt berekend waarnaar wordt verzonden. | Verplicht |
SendCriteria.BackStep | boolean | Deze waarde altijd op 1 laten staan. | Verplicht |
SendCriteria.Multipart | boolean | Indien de nieuwsbrief zowel een text-body als een HTML-body heeft zou Multipart op 1 moeten staan. | Verplicht |
SendCriteria.TrackOpens | boolean | Indien het aantal geopende nieuwsbrieven moet worden weergegeven in de statistieken moet deze waarde op 1 staan. | Verplicht |
SendCriteria.TrackLinks | boolean | Indien het aantal geklikte links in nieuwsbrieven moet worden weergegeven in de statistieken moet deze waarde op 1 staan. | Verplicht |
SendCriteria.EmbedImages | boolean | Afbeeldingen wil je in principe niet als bijlage meesturen in de nieuwsbrief. Deze waarde staat daarom op 0. | Verplicht |
SendCriteria.Newsletter | int | Het ID van de nieuwsbrief waarnaar verzonden gaat worden. | Verplicht |
SendCriteria.SendFromName | string | De naam van de afzender van deze verzending. | Verplicht |
SendCriteria.SendFromEmail | string | Het afzend emailadres van deze verzending. | Verplicht |
SendCriteria.ReplyToEmail | string | Het reply-to emailadres van deze verzending. | Verplicht |
SendCriteria.BounceEmail | string | Het bounce emailadres van deze verzending. Dit moet een uniek adres zijn welke alleen wordt gebruikt voor het uitlezen van de gebouncede email. | Verplicht |
SendCriteria.To_FirstName | int | Het ID van het Extra Veld waarin de Voornaam van de contactpersoon is opgeslagen. Dit is meestal 2. | Verplicht |
SendCriteria.To_Prefix | int | Het ID van het Extra Veld waarin het Tussenvoegsel van de contactpersoon is opgeslagen. Dit is meestal 3. | Verplicht |
SendCriteria.To_LastName | int | Het ID van het Extra Veld waarin de Achternaam van de contactpersoon is opgeslagen. Dit is meestal 4. | Verplicht |
SendCriteria.Charset | string | De karakterset is altijd UTF-8. | Verplicht |
SendCriteria.NotifyOwner | boolean | Stuur een bericht naar de lijsteigenaar betreft deze verzending. | Verplicht |
SendCriteria.SendStartTime | int | Unix timestamp van het moment van verzending. | Verplicht |
SendCriteria.SendStartTime | int | Unix timestamp van het moment van verzending. | Verplicht |
SendCriteria.EmailResults | int | De elementen success, failure en total moeten de waarde 0 krijgen. Tijden de verzending worden hier eventuele fouten in gelogd. | Verplicht |
SendCriteria.module_tracker_google_options_name | string | Indien de nieuwsbrief resultaten getracked moeten worden in Google Analytics kan hier de Campagne Naam worden opgegeven. | Verplicht |
SendCriteria.module_tracker_google_options_source | string | Indien de nieuwsbrief resultaten getracked moeten worden in Google Analytics kan hier de Campagne Bron worden opgegeven. | Verplicht |
fkid | int | Het ID van de nieuwsbrief waarnaar verzonden gaat worden. | Verplicht |
fktype | string | Het type van de verzending is nieuwsbrief (newsletter). | Verplicht |
ownerid | int | Het ID van de eigenaar van de mailinglijst waarnaar verzonden gaat worden. | Verplicht |
approved | int | Indien de verzending eerst door een admin moet worden goedgekeurd kan 0 worden ingesteld. Standaard is 1. | Verplicht |
Succesvolle response
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
data | int | Indien de statistieken worden gevonden wordt het object teruggegeven. |
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>jobs</requesttype>
<requestmethod>Create</requestmethod>
<responsetype>xml</responsetype>
<details>
<jobtype>send</jobtype>
<jobstatus>w</jobstatus>
<when>1420596000</when>
<lists>10</lists>
<details>
<NewsletterChosen>99</NewsletterChosen>
<Lists>10</Lists>
<SendCriteria>
<Confirmed>1</Confirmed>
<Status>a</Status>
<List>10</List>
<TagType>AND</TagType>
<Tags>
<array>9</array>
<array>99</array>
<array>999</array>
</Tags>
</SendCriteria>
<SendSize>9999</SendSize>
<BackStep>1</BackStep>
<Multipart>1</Multipart>
<TrackOpens>1</TrackOpens>
<TrackLinks>1</TrackLinks>
<EmbedImages>0</EmbedImages>
<Newsletter>99</Newsletter>
<SendFromName>MailCamp</SendFromName>
<SendFromEmail>info@mailcamp.nl</SendFromEMail>
<ReplyToEmail>reply@mailcamp.nl</ReplyToEmail>
<BounceEmail>bounce@mailcamp.nl</BounceEmail>
<To_FirstName>2</To_FirstName>
<To_Prefix>3</To_Prefix>
<To_LastName>4</To_LastName>
<Charset>UTF-8</Charset>
<NotifyOwner>1</NotifyOwner>
<SendStartTime>1420596000</SendStartTime>
<EmailResults>
<success>0</success>
<total>0</total>
<failure>0</failure>
</EmailResults>
<module_tracker_google_options_name>Nieuwsbrief naam</module_tracker_google_options_name>
<module_tracker_google_options_source>MailingList</module_tracker_google_options_source>
</details>
<fkid>99</fkid>
<fktype>newsletter</fktype>
<ownerid>99</ownerid>
<approved>1</approved>
</details>
</xmlrequest>