Retrieve a Message
Use this request to retrieve a message.
This request retrieves a message's body, status, or detailed metadata.
To retrieve a message, use the a GET operation and the following URL:
https://{service_url}/api/v1/messages/{message_Id}?view={view}
where:
{service_url}is the service's URI.{messageId}is the message ID you want to retrieve. This is explained in the Path parameter section of this topic.{view}controls which details are returned. This is explained in the Query parameter section of this topic.
For example:
curl --request GET \
--url 'https://e-invoicing-message.vertexcloud.com/api/v1/messages/asdjalada?view=status' \
--header 'accept: application/json'
Details
| Type | Value |
|---|---|
| Endpoint | /api/v1/messages |
| Method | GET |
| API Reference Topic | Retrieve a message |
Path parameter
The following path parameter is required:
| Field | Details | Description |
|---|---|---|
messageId | UUID | ID of the message |
Query parameter
The following query parameter is optional:
| Field | Details | Description |
|---|---|---|
view | String/Enumeration | Details of the message to be returned. Status returns the message's status. details returns all available metadata, external references, and acknowledgements for the message. If omitted, the message body is returned in Base64 format. The allowed values are Details or Status. |
Response
The fields in the response are listed in the Retrieve Message Fields Reference topic.
Example
Request
curl --request GET \
--url 'https://e-invoicing-message.vertexcloud.com/api/v1/messages/asdjalada?view=status' \
--header 'accept: application/json'
Updated about 19 hours ago
