Checklist: - Vul onderstaande template in met de opmerkingen indachtig - Verwijder ongebruikte koppen.
Algemeen
De GET statuses 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.
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.
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 |
| ja | ||
| eboxIdValue | String | ja | |||
Voorbeeld
{
"deliveryChannel": "EBOX",
"eBoxMessages": [
{
"messageId": "bb708728-5re3-oi3f-453c-00azs26838dsd",
"eboxId": {
"eboxType": "ENTERPRISE",
"eboxIdValue": "0406798006"
}
},
{
"messageId": "aa704428-5dd3-003f-873c-19vnb6838aza",
"eboxId": {
"eboxType": "ENTERPRISE",
"eboxIdValue": "0406798006"
}
}
]
} |
paperMessages
| Element | Type | Waarde | Opmerking | Verplicht | |
|---|---|---|---|---|---|
| items | String | bericht id(s) | |||
Voorbeeld
{
"deliveryChannel": "PAPER",
"paperMessages": [
"02708728-5fe3-443f-933c-19c626838c40",
"aa704428-5dd3-003f-873c-19vnb6838aza",
"bb708728-5re3-oi3f-453c-00azs26838dsd"
]
} |
emailMessages
| Element | Type | Waarde | Opmerking | Verplicht | |
|---|---|---|---|---|---|
| items | String | bericht id(s) | |||
Voorbeeld
{
"deliveryChannel": "EMAIL",
"emailMessages": [
"02708728-5fe3-443f-933c-19c626838c40",
"aa704428-5dd3-003f-873c-19vnb6838aza",
"bb708728-5re3-oi3f-453c-00azs26838dsd"
]
} |
Validaties op vraag
| Element | Omschrijving van de validatie | Mogelijke Foutcodes |
|---|---|---|
Opmerkingen
Zijn er specifieke aandachtspunten die op het geheel van de vraag slaan die een gebruiker in overweging moet nemen.
Voorbeeld
Een voorbeeld van een request. Je kan ook de voorbeelden volledig op de Testgegvens & Voorbeelden pagina zetten. Haal dan dit onderderdeel weg.
Codetabellen Vraag
In deze paragraaf kunnen codetabellen ingevoegd worden met betrekking tot de vraag.
Element-Naam
Voeg hier eventueel een beschrijving van het element toe
Code | Omschrijving |
|---|---|
Waarde1 | Beschrijving1 |
Waarde2 | Beschrijving2 |
Element-Naam
Voeg hier eventueel een beschrijving van het element toe
Code | Omschrijving |
|---|---|
Waarde1 | Beschrijving1 |
Waarde2 | Beschrijving2 |