Skip to main content

e-Box publication - multicast

Multicast​

(Only applicable if your Document Provider supports it)

When sending the same message to multiple recipients, it is required to use the multicast in order to avoid duplicates.

Publishing​

The first operation is to create your publication using the "{POST} /ebox/{enterpriseNumber}/publications" endpoint. The contract is pretty similar to the "{POST} /ebox/messages" endpoint used for the publication towards a single recipient. as a response, you'll receive a publicationId required for the next operations.

Note that the Idempotency key concept is also applicable here.

Synchronous calls - targeting max 100 recipients​

If you target a maximum of 100 recipients, you can call the synchronous "{POST} /ebox/{enterpriseNumber}/publications/{publicationId}/addRecipients" and provide your recipients in the Json request body. This service will directly publish the message to all recipients and return the status of all attempts. It is possible to use it multiple times on the same publicationId.

Asynchronous calls - targeting a large number of recipients​

If you target a large number of recipient, you have to call the long-running task "{POST} /ebox/{enterpriseNumber}/publications/{publicationId}/multicastTasks" and provide all your recipients in a CSV file. The process will run in background and directly return you with a Header "Location" containing the follow-up link with your taskId.

You can then poll the "{GET} /ebox/{enterpriseNumber}/multicastTasks/{multicastTaskId}/messagePublicationStatuses" to retrieve the status of all publications.

For more endpoints and information, consult the Message Registry API.