Saltar al contenido principal
GET
Read one outbound message, whatever its code

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id
string
requerido

Outbound message id.

Respuesta

OK

attempts
integer<int64>
requerido

Queue-put attempts made so far.

codMsg
string
requerido

The SFN message code this row carries, e.g. LDL0023.

heldForAnswer
boolean
requerido

True when the câmara's answer may never come and two operators can close the message as failed (see requestOutboundMessageClose): its time ran out after a put whose outcome is unknown (SUBMITTED), or an LTR0002 or LTR0008 was DISPATCHED and its LBTR cycle ended with no R1.

id
string<uuid>
requerido

Outbound message id.

numCtrlIF
string
requerido

The control number this institution issued. The câmara echoes it on the answer, which is what correlates the two.

nuop
string
requerido

The BCMSG operation number of the frame.

status
enum<string>
requerido

Lifecycle state. REFUSED and FAILED are both terminal and are different facts: REFUSED means the câmara received the message and returned its E twin, FAILED means this rail could not deliver it and will not retry, or two operators closed a send whose outcome was unknown.

Opciones disponibles:
SUBMITTED,
DISPATCHED,
ANSWERED,
REFUSED,
FAILED
submittedAt
string<date-time>
requerido

When the message was recorded.

answeredAt
string<date-time>

When the câmara's answer was applied; omitted until it is.

closeRequest
object

The first operator's request to close this held message as failed, awaiting a second operator's approval; omitted when none awaits.

codProdt
string

The SILOC product, OT or SLC; omitted when the message's layout carries no product element.

dispatchedAt
string<date-time>

When the frame reached the send queue; omitted until it has.

lastError
string

Why the last attempt failed, or that an LBTR message waits unsent for its cycle to open, which counts no attempt; omitted when neither applies.

nextAttemptAt
string<date-time>

When the next queue put comes due; omitted once the row is terminal or answered.

parkedAnswers
object[]

The câmara answers parked unresolved for this held message; omitted when none. A message with one cannot be closed plainly: a SEMANTIC_REJECTED answer is declared by two operators as what its codMsg states (parkedAnswerId and outcome on the close request), any other can still replay.