The ecosio Messaging API and Vertex Messaging API report message progress differently:
- The ecosio Messaging API returns a
state. The available states depend on the state mode configured for the API connector in the Monitor. - The Vertex Messaging API returns one of six
statusvalues.
Status reference
The following tables detail the states and statuses returned by the APIs and whether they are final.
The Vertex Messaging API returns the following six statuses.
| Status | Final status | Meaning |
|---|---|---|
PROCESSING | No | ecosio is processing the message. |
TRANSMITTED | Yes | ecosio completed the transmission. |
ERROR | Yes | An error occurred that ecosio can't resolve. Fix the error and send a new message. |
TRANSIENT_ERROR | No | The error is temporary or under investigation. |
HANDLED | Yes | The error was handled or resolved. |
RETAINED | Yes | ecosio retained the original message after a split or merge. |
The states returned by the ecosio Messaging API depend on the state mode configured for the connector in the Monitor.
Mode 10
Mode 10 is the original mode and forms the basis for all other state modes.
| State | Final state | Meaning |
|---|---|---|
REQUEST_RECEIVED | No | ecosio received the request. |
RECEIVED | No | ecosio identified the document type, sender, and recipient. |
DELIVERED | No | The recipient can download the message. |
PICKEDUP | No | The recipient retrieved the message. |
FORWARDED | Yes | ecosio delivered the message successfully. |
PROCESSED | Yes | The recipient confirmed successful document processing through a callback. |
EXCEPTION | No | An error occurred during message processing or delivery. |
HANDLED | Yes | The error was handled or resolved. |
ARCHIVED | Yes | ecosio archived the message without further processing. |
PROCESSING | No | ecosio is processing the message. |
Mode 11
Mode 11 adds the EXCEPTION_UNDER_REVIEW and ONBOARDING states.
| State | Final state | Meaning |
|---|---|---|
REQUEST_RECEIVED | No | ecosio received the request. |
RECEIVED | No | ecosio identified the document type, sender, and recipient. |
DELIVERED | No | The recipient can download the message. |
PICKEDUP | No | The recipient retrieved the message. |
FORWARDED | Yes | ecosio delivered the message successfully. |
PROCESSED | Yes | The recipient confirmed successful document processing through a callback. |
EXCEPTION | No | An error occurred during message processing or delivery. |
HANDLED | Yes | The error was handled or resolved. |
ARCHIVED | Yes | ecosio archived the message without further processing. |
PROCESSING | No | ecosio is processing the message. |
EXCEPTION_UNDER_REVIEW | No | ecosio is investigating an error that occurred during message processing or delivery. |
ONBOARDING | Yes | The message encountered an error during onboarding, usually while the connector was being tested. |
Mode 12
Mode 12 removes the ARCHIVED, EXCEPTION_UNDER_REVIEW, and ONBOARDING states, and adds the EXCEPTION_CUSTOMER and HANDLED_CUSTOMER states.
| State | Final state | Meaning |
|---|---|---|
REQUEST_RECEIVED | No | ecosio received the request. |
RECEIVED | No | ecosio identified the document type, sender, and recipient. |
DELIVERED | No | The recipient can download the message. |
PICKEDUP | No | The recipient retrieved the message. |
FORWARDED | Yes | ecosio delivered the message successfully. |
PROCESSED | Yes | The recipient confirmed successful document processing through a callback. |
HANDLED | Yes | The error was handled or resolved. |
EXCEPTION_CUSTOMER | Yes | An error occurred that ecosio can't resolve. Fix the error and send a new message. |
HANDLED_CUSTOMER | Yes | The EXCEPTION_CUSTOMER error is resolved. |
PROCESSING | No | ecosio is processing the message. |
Mode 13
Modes 13 replaces the PICKEDUP, FORWARDED, and PROCESSED states with SENT.
| State | Final state | Meaning |
|---|---|---|
REQUEST_RECEIVED | No | ecosio received the request. |
RECEIVED | No | ecosio identified the document type, sender, and recipient. |
DELIVERED | No | The recipient can download the message. |
SENT | Yes | The recipient received the message and, where supported, confirmed successful processing. |
HANDLED | Yes | The error was handled or resolved. |
EXCEPTION_CUSTOMER | Yes | An error occurred that ecosio can't resolve. Fix the error and send a new message. |
HANDLED_CUSTOMER | Yes | The EXCEPTION_CUSTOMER error is resolved. |
PROCESSING | No | ecosio is processing the message. |
Retrieve status details
Error and exception responses include an error code and details. If the response identifies the cause, correct the error and resend the message when appropriate.
Retrieve the message log or history if the response doesn't provide enough information, a message remains in a non-final state longer than expected, or you need the detailed processing history.
To retrieve a message's log or history, use the relevant request:
| API | Request | Returned details |
|---|---|---|
| ecosio Messaging API | GET /delivery/{messageId}?includeLog=true | log array |
| Vertex Messaging API | GET /messages/{messageId}?view=details | history array |
NoteIf the message is a French e-invoice and the
messagefield containsFLOW:SUBMITTED_NOT_TRANSMITTED, ecosio has reported the invoice's regulatory data to the French tax authority but hasn't delivered the invoice to the recipient. See Identify and resolve e-invoice delivery failures in France for more information.