Beschrijving Vraag POST statusRequest
Algemeen
De POST statusRequest laat een verzender toe om de status van verzonden berichten op te vragen. Het is niet mogelijk om in 1 en dezelfde vraag de status op te vragen van verzendingen die niet via het zelfde kanaal (EBOX, PAPER, EMAIL) zijn gebeurd. Per kanaal is er een aparte vraag nodig.
Element | Opmerkingen | Verplicht |
---|---|---|
x-correlation-id | Maakt deel uit van de header. Zie ook: Werking en overzicht uitzonderingen MAGDA RESTful services. Dit is het transactie ID, gebruikt voor logging en foutafhandeling | ja |
messagesStatusRequest | Lijst van status requests van 1 en hetzelfde verzendkanaal: EBOX of PAPER of EMAIL | ja |
messagesStatusRequest
Dit betreft een lijst van status requests van 1 en hetzelfde verzendkanaal: EBOX of PAPER of EMAIL.
Naast het verzendkanaal moeten verplicht de berichten meegegeven worden waarvoor de opvraging gebeurt, afhankelijk van het kanaal.
Element | Type | Waarde | Opmerking | Verplicht |
---|---|---|---|---|
deliveryChannel | String |
| Verzendkanaal van de berichten. | ja |
messages | Array | Zie:
| ja |
eBoxMessages
Element | Type | Waarde | Opmerking | Verplicht | |
---|---|---|---|---|---|
messageId | String | Id van het bericht | nee | ||
eboxId | |||||
eboxType | String |
| Belangrijke opmerking: 1 vraag moet steeds hetzelfde eboxType bevatten, je kan ze niet combineren in 1 en dezelfde vraag. Maximum aantal IDs dat kan worden meegegeven is 500. | ja | |
eboxIdValue | String | ja |
Voorbeeld
paperMessages
Element | Type | Waarde | Opmerking | Verplicht | |
---|---|---|---|---|---|
items | String | bericht id Belangrijke opmerking: je mag (voorlopig) slechts 1 ID meegeven in de vraag |