Message response
- Last UpdatedSep 04, 2025
- 1 minute read
A message response provides information about the status of a single OMF message. It can contain event responses and status responses.
|
Field |
Description |
|---|---|
|
MessageIndex |
Contains the index of the request message that produced the response. OMF messages are indexed and executed in the order they are received. For example, the first request in the message has an index of 0, the second request in the message has an index of 1, and so on. A MessageIndex value of null indicates that the events are associated with the entire request and response pair, not just a specific OMF message. For example, if the JSON syntax of the request is incorrect and no messages can be read, the resulting MessageIndex is null. |
|
Events |
Contains the event responses that occurred during the execution of the request. For details, see Event response. |
|
Status |
Contains the status responses that occurred during the execution of the request. For details, see Status response. |
The following is an example of a status response.
{
"MessageIndex": 0,
"Events": [
Event_response,
Event_response,
...
],
"Status": Status_response
}
Note: Event_response indicates a nested message with a response type of event. Status_response indicates a nested message with a response type of status.